Skip to content

Latest commit

 

History

History
372 lines (231 loc) · 7.76 KB

CHANGELOG.md

File metadata and controls

372 lines (231 loc) · 7.76 KB
Raw

@solace-labs/ep-async-api-importer

0.61.0

Minor Changes

  • ecd84e821: Bug Fix: creating files with fwd slashes

0.60.0

Minor Changes

  • 4c27ff0a5: Change repo url

0.59.0

Minor Changes

  • 75ecc73d7: Open API clients to 2.0.27 and removes all references to deprecated APIs

Patch Changes

0.58.4

Patch Changes

0.58.3

Patch Changes

0.58.2

Patch Changes

0.58.1

Patch Changes

0.58.0

Minor Changes

  • ec880478: added state name + state Id handling on import

    Note: this version contains breaking changes

    configuration

    • replaced: CLI_IMPORT_ASSETS_TARGET_LIFECYLE_STATE
    • with: CLI_IMPORT_DEFAULT_STATE_NAME
      • options: ['draft', 'released', 'deprecated', 'retired'], default='released'

    async api ep extensions for stateId

    • x-ep-state-name: options: ['draft', 'released', 'deprecated', 'retired']
    • x-ep-state-id: options: ['1', '2', '3', '4']
    • state name is evaluated first, if not present, state id is evaluated
    • if neither state name nor state id are present, defaults to env var: CLI_IMPORT_DEFAULT_STATE_NAME

Patch Changes

0.57.0

Minor Changes

  • 2c356b01: new features

    • new env var: CLI_IMPORT_DEFAULT_SHARED_FLAG
      • options: [true, false], default=true

Patch Changes

0.56.1

Patch Changes

0.56.0

Minor Changes

  • 75f8b29b: enforcement of application domain permissions

    • new environment varible: CLI_ASSETS_APPLICATION_DOMAIN_ENFORCEMENT_POLICY

      • strict: no first versions allowed
      • lax: first versins allowed, but no new versions allowed after
      • off: no checks
      • note: must be used with CLI_TEST_SETUP_DOMAINS_FOR_APIS=true

    • refactor of importer to allow export/import of applications only without the need to have an event api in the middle

    • config validations

      • at least one output selected, either event api or application

Patch Changes

0.55.0

Minor Changes

  • b97f4e2b: Modify payload format to JSON with correct tabbing

0.54.0

Minor Changes

  • 074640fa: multi-domain support for each asset

    New Features

    • importer uses the ep extension: x-ep-application-domain-name for each object
      • enums, events, schemas
      • if omitted, defaults back to x-ep-assets-application-domain-name

    Changes

    • change default for CLI_TEST_SETUP_DOMAINS_FOR_APIS to true

    Known Issues

    • enum version description is not exported by EP as extension

      • using a version description would result in an attempt to create a new version
      • workaround: do not use a description
      • the importer will omit the description for an enum version

    • schema version description is not exported by EP as extension

      • using a version description would result in an attempt to create a new version
      • workaround: do not use a description
      • the importer will omit the description for an schema version

Patch Changes

0.53.0

Minor Changes

  • d5cb94fd: Added support for additional ep extensions

    • see CHANGELOG.md for ep-asyncapi.

    Added new CLI environment variable:

    export CLI_IMPORT_CREATE_API_EVENT_API=true/false

    if set to true, the importer will create the Event API. if set to false, the import will not create the Event API.

    Use in conjunction with:

    export CLI_IMPORT_CREATE_API_APPLICATION=true/false

Patch Changes

0.52.7

Patch Changes

0.52.6

Patch Changes

0.52.5

Patch Changes

0.52.4

Patch Changes

0.52.3

Patch Changes

0.52.2

Patch Changes

0.52.1

Patch Changes

0.52.0

Minor Changes

  • 42b4280: enhanced logging of call parameters

    New Features:

    • logging
      • log of version, command line options, environment, and resulting config at startup
      • level=info
    • environment variable: CLI_VALIDATE_API_BEST_PRACTICES
      • flag to run 'best practices' validation on APIs
      • options: true/false
      • default: true

    Enhancements:

    • error handling
      • added details (name, message, stack) of caught errors to log & output

Patch Changes

0.51.0

Minor Changes

  • d4065b0: added brokerType & channelDelimiter options

    New Features:

    • brokerType

      • environment variable: CLI_IMPORT_BROKER_TYPE
        • overrides all in spec broker type settings
        • options: solace, kafka
        • default=solace
      • uses in spec / override brokerType for importing assets

    • channelDelimiter

      • environment variable: CLI_IMPORT_CHANNEL_DELIMITER
        • overrides all in spec broker type settings
        • options: '/','.','-','_'
        • default='/'
        • uses in spec / override channelDelimiter for importing assets

Patch Changes

0.50.7

Patch Changes

  • 931c065: update ep-openapi-node package version number

    Documentation:

    • added examples for using file & http references in async api specs

  • Updated dependencies [de6afdf]

0.50.6

Patch Changes

0.50.5

Patch Changes

0.50.4

Patch Changes

0.50.2

Patch Changes

0.50.1

Patch Changes

  • 8b9f729: migrated package into repo

    New Features:

    • environment variable: CLI_LOGGER_LOG_SUMMARY_TO_CONSOLE, default=true
      • setting to false disables logging of progress/summary to the console. useful when running in CI/CD pipeline.

  • Updated dependencies [8b9f729]