PackageTrack

npm · #3910

@redocly/openapi-core

2.48.0Redocly/redocly-cli

See https://github.com/Redocly/redocly-cli

Release timeline

728 releases since 2020
202120222023202420252026

Releases

  1. 1.0.0-beta.8215 Feb 2022pre-release
    Release notes

    Fixes

    • Removed support for using OpenAPI CLI behind a proxy server.

    Open source →
  2. 1.0.0-beta.8110 Feb 2022pre-release
    Release notes

    Features

    • Added support for using OpenAPI CLI behind a proxy server.

    Fixes

    • Fixed an issue with the lint command not reporting errors when securityDefinitions.basic contains the unsupported additionalProperty in OAS2.
    • Fixed an issue with the no-invalid-media-type-examples built-in rule that didn't work on examples containing a $ref.
    • Fixed an issue with the lint command incorrectly reporting boolean schemas for array items as invalid.
    • Fixed an issue with isPathParameter failing because of an incorrect brace.

    Open source →
  3. 1.0.0-beta.8024 Jan 2022pre-release
    Release notes

    Fixes

    • Fixed an issue with date-time conversion in YAML files.
    • Fixed an issue with the oauth2-redirect.html file being absent when served by preview-docs command.

    Open source →
  4. 1.0.0-beta.7911 Jan 2022pre-release
    Release notes

    Fixes

    • Fixed the remove-x-internal decorator to remove references to removed x-internal components.
    • Fixed the remove-unused-components decorator that strips remotely referenced components.

    Open source →
  5. 1.0.0-beta.786 Jan 2022pre-release
    Release notes

    Features

    • Added the remove-x-internal built-in decorator.
    • Added the --remove-unused-components option to the bundle command.

    Open source →
  6. 1.0.0-beta.776 Jan 2022pre-release
    Release notes

    Fixes

    • Fixed an issue with backslashes in $refs to paths with the split command in a Windows environment.

    Open source →
  7. 1.0.0-beta.7628 Dec 2021pre-release
    Release notes

    Features

    • Exported mapTypeToComponent function.

    Open source →
  8. 1.0.0-beta.7524 Dec 2021pre-release
    Release notes

    Features

    • Added the --host option to the preview-docs CLI command.

    Fixes

    • Fixed an issue with continuous deployment to Docker Hub.

    Open source →
  9. 1.0.0-beta.7422 Dec 2021pre-release
    Release notes

    Fixes

    • Fixed an issue with const not handled correctly by the lint command.

    Open source →
  10. 1.0.0-beta.7314 Dec 2021pre-release
    Release notes

    Fixes

    • Resolved another backward compatibility issue with older versions of portal.

    Open source →
  11. 1.0.0-beta.7214 Dec 2021pre-release
    Release notes

    Fixes

    • Fixed another backward compatibility issue with regions: save old config key to support old portal versions.

    Open source →
  12. 1.0.0-beta.7114 Dec 2021pre-release
    Release notes

    Fixes

    • Fixed a backward compatibility issue with REDOCLY_DOMAIN in the EU region introduced in the previous release.

    Open source →
  13. 1.0.0-beta.7014 Dec 2021pre-release
    Release notes

    Features

    Fixes

    • Fixed an issue with the built-in paths-kebab-case rule that disallowed paths with trailing slashes.
    • Fixed a validation issue with the example property when the schema is an array.

    Open source →
  14. 1.0.0-beta.6916 Nov 2021pre-release
    Release notes

    Features

    • Implemented new --extends and --metafile options for the bundle command.

    Open source →
  15. 1.0.0-beta.6815 Nov 2021pre-release
    Release notes

    Fixes

    • Fixed an issue with hot reloading when running a preview of reference docs with openapi preview-docs.
    • Fixed an issue with page refresh when pagination is set to item or section.
    • Fixed an issue with inlining external schema when components' names match.
    • Fixed an issue with fetching hosted schema on Windows when bundling OpenAPI descriptions.
    • Fixed an issue for no-server-trailing-slash when server url is a root.

    Open source →
  16. 1.0.0-beta.672 Nov 2021pre-release
    Release notes

    Features


    Open source →
  17. 1.0.0-beta.661 Nov 2021pre-release
    Release notes

    Features

    Fixes

    • Fixed an issue with OAS 3.1 meta keywords reported as not expected.
    • Fixed an issue with incorrect codeframe for info-license-url rule.
    • Fixed an issue with discriminator mapping not supported in no-invalid-media-type-examples.
    • Fixed an issue with ignore file generated in windows not working on other systems, and in Redocly Workflows.

    Open source →
  18. 1.0.0-beta.6527 Oct 2021pre-release
    Release notes

    Features

    • Added three built-in decorators - info-description-override, tag-description-override, operation-description-override - that let you modify your API descriptions during the bundling process. Use these decorators in the lint section of your redocly.yaml file to point OpenAPI CLI to Markdown files with custom content. That custom content replaces any existing content in the info.description field, and in tags.description and operation.description fields for specified tag names and operation IDs.

    The following examples show how to add the decorators to the redocly.yaml file:

    lint:
      decorators:
        info-description-override:
          filePath: ./my-custom-description.md
    
    lint:
      decorators:
        tag-description-override:
          tagNames:
            pet: ./my-custom-description.md
    
    lint:
      decorators:
        operation-description-override:
          operationIds:
            updatePet: ./my-custom-description.md
    

    Fixes

    • Fixed the the bundle command to return a non-zero code when it detects an error when used with the --lint option.

    Open source →
  19. 1.0.0-beta.6420 Oct 2021pre-release
    Release notes

    Fixes

    • Fixed an issue with the --format option not working with the bundle command.

    • Fixed a validation issue with the non-string openapi value in API descriptions. The lint command now warns if the value is not string instead of crashing.


    Open source →
  20. 1.0.0-beta.6312 Oct 2021pre-release
    Release notes

    Features

    • Upgraded the js-yaml package from v.3 to v.4 with YAML 1.2 support. This resolves issues with parsing timestamps and example strings with leading zeros in YAML.

    Open source →
  21. 1.0.0-beta.6230 Sept 2021pre-release
    Release notes

    Fixes

    • Resolved an issue with the --max-problems option that was not working with the bundle command.

    Open source →
  22. 1.0.0-beta.6121 Sept 2021pre-release
    Release notes

    Features

    • Improved validation of values for the following fields in the Schema Object: multipleOf, maxLength, minLength, maxItems, minItems, maxProperties, minProperties.

    Open source →
  23. 1.0.0-beta.6020 Sept 2021pre-release
    Release notes

    Fixes

    • Fixed an issue with the join command crashing when trying to resolve $ref.

    Open source →
  24. 1.0.0-beta.5915 Sept 2021pre-release
    Release notes

    Fixes

    • Resolved an issue with the preview-docs command not working when running openapi-cli in a Docker container.

    • Improved the security of local documentation previews by removing query parameters from the request URL.


    Open source →
  25. 1.0.0-beta.582 Sept 2021pre-release
    Release notes

    Fixes

    • Internal improvements to configuration types.

    Open source →
  26. 1.0.0-beta.571 Sept 2021pre-release
    Release notes

    Fixes

    • Simplified the login check query to improve performance.

    Open source →
  27. 1.0.0-beta.561 Sept 2021pre-release
    Release notes

    Features

    • Added a function for linting the redocly.yaml configuration file.

    • Published the OpenAPI CLI quickstart guide as part of our Google Season of Docs 2021 project.


    Open source →
  28. 1.0.0-beta.5520 Aug 2021pre-release
    Release notes

    Features


    Open source →
  29. 1.0.0-beta.5419 Jul 2021pre-release
    Release notes
    • Internal changes.

    Open source →
  30. 1.0.0-beta.532 Jul 2021pre-release
    Release notes

    Fixes

    • Resolved an issue with transitive $ref resolution in the JSON schema validator.

    • If the JSON schema validator crashes, OpenAPI CLI reports the problem in the output instead of crashing itself.


    Open source →
  31. 1.0.0-beta.521 Jul 2021pre-release
    Release notes

    Fixes

    • The operation-operationId rule no longer triggers a warning when one or more operations in the callbacks object don't have operationId defined.

    Open source →
  32. 1.0.0-beta.5130 Jun 2021pre-release
    Release notes

    Features

    • Our official OpenAPI CLI documentation is now open-source! 🥳 You can find the source of all pages published on our website in the docs folder of the openapi-cli repository. We invite you to help us improve the documentation and make it more usable for everyone. Please make sure to always follow our Code of conduct in all your contributions.

    • Implemented support for OpenAPI 3.1 in typeExtension plugins.

    Fixes

    • Resolved a crash caused when processing properties with the null value.

    • Resolved a "Maximum call stack size exceeded" issue in the JSON schema validator caused by recursive oneOf.


    Open source →
  33. 1.0.0-beta.509 Jun 2021pre-release
    Release notes

    Fixes

    • Implemented improvements to the openapi-cli package to reduce the size of the browser bundle.

    Open source →
  34. 1.0.0-beta.491 Jun 2021pre-release
    Release notes

    Fixes

    • Removed unused keywords in OpenAPI 3.1.

    • Resolved an issue with the openapi bundle command failing because of the missing js-yaml dependency.


    Open source →
  35. 1.0.0-beta.4825 May 2021pre-release
    Release notes

    Fixes

    • Resolved an issue with the plugin ID being prefixed to all rules, preprocessors and decorators multiple times (for example, when using the preview-docs command and changing configuration files).

    Open source →
  36. 1.0.0-beta.4721 May 2021pre-release
    Release notes

    Features

    • The bundle command now supports an optional --lint parameter.

    Fixes

    • Improved the error messages for kebab-case and implemented detection of snake_case usage in paths.

    • The join command does not overwrite an existing x-displayName of a tag with the tag's name property.


    Open source →
  37. 1.0.0-beta.4617 May 2021pre-release
    Release notes

    Features

    • Implemented support for OpenAPI 3.1. You can now lint, validate, and bundle your OAS 3.1 descriptions with OpenAPI CLI.

    Open source →
  38. 1.0.0-beta.4511 May 2021pre-release
    Release notes

    Fixes

    • Resolved a validation issue for enum items with the nullable property. Validation errors are no longer reported when nullable: true for enum items that contain a null value.

    Open source →
  39. 1.0.0-beta.4412 Apr 2021pre-release
    Release notes

    Fixes

    • The browser field in package.json is now set to simplify using openapi-core in browser-based builds.

    Open source →
  40. 1.0.0-beta.439 Apr 2021pre-release
    Release notes

    Fixes

    • The root API description document is now parsed in all cases, even if it doesn't report the correct MIME type or doesn't use any of the supported file extensions.

    Open source →
  41. 1.0.0-beta.426 Apr 2021pre-release
    Release notes

    Fixes

    • Improved openapi-core so that it can be used within our other projects including Redoc, Reference docs, and Developer portal.

    Open source →
  42. 1.0.0-beta.412 Apr 2021pre-release
    Release notes

    Fixes

    • Resolved an issue with the --dereferenced CLI option not functioning properly.

    Open source →
  43. 1.0.0-beta.4031 Mar 2021pre-release
    Release notes

    Fixes

    • Resolved an issue where transitive $refs that span multiple files would crash the validation in some cases.

    Open source →
  44. 1.0.0-beta.3926 Mar 2021pre-release
    Release notes

    Fixes

    • Resolved a hot-reloading issue with the preview-docs command. It now automatically reloads the docs in the browser when you make live changes to an OpenAPI description.

    Open source →
  45. 1.0.0-beta.3820 Mar 2021pre-release
    Release notes

    Fixes

    • Exported a helper function from openapi-core and implemented defaults for some functions to improve integration with the Developer portal.

    Open source →
  46. 1.0.0-beta.3716 Mar 2021pre-release
    Release notes

    Fixes

    • Implemented error handling for failed file uploads when using the push command. The command now displays success/failure messages in the output.

    Open source →
  47. 1.0.0-beta.3615 Mar 2021pre-release
    Release notes

    Features

    • Source type was changed from FILE to CICD to support integration with the new CI/CD source in Workflows.

    Open source →
  48. 1.0.0-beta.3512 Mar 2021pre-release
    Release notes

    Features

    • OpenAPI CLI now has tab completion for global installations. Run openapi completion for instructions to set it up in your environment.

    Open source →
  49. 1.0.0-beta.3410 Mar 2021pre-release
    Release notes

    Features

    • OpenAPI CLI now has an official Docker image! You can get it from Docker Hub.

    Open source →
  50. 1.0.0-beta.3310 Mar 2021pre-release
    Release notes

    Features

    • You can now use the --verbose parameter with the login command to show a detailed error trace (if any). Detailed error output is not displayed by default for this command.

    Open source →
  51. 1.0.0-beta.3225 Feb 2021pre-release
    Release notes

    Features

    • The "access token" has been renamed to "API key" in the output of relevant OpenAPI CLI commands (login, push) to make it clearer what information the users must provide.

    • For improved security, the API key is now hidden (masked) when the user provides it in the terminal, and it's not logged in the user's history.


    Open source →
  52. 1.0.0-beta.3125 Jan 2021pre-release
    Release notes

    Features

    • The bundle method is now able to accept Document directly in openapi-core.

    Open source →
  53. 1.0.0-beta.3025 Jan 2021pre-release
    Release notes

    Features

    • OpenAPI CLI now automatically resolves all $refs by default, even in places where they are not allowed by the specification ("incorrect $refs"). This functionality can be disabled for examples by setting doNotResolveExamples to true in redocly.yaml.

    Open source →
  54. 1.0.0-beta.2913 Jan 2021pre-release
    Release notes

    Fixes

    • Fixed an issue with incorrect base directory when resolving transitive $refs.

    Open source →
  55. 1.0.0-beta.289 Jan 2021pre-release
    Release notes

    Fixes

    • Resolved an issue with nested filepaths that caused the push command to upload files to the wrong path when used on Windows systems.

    Open source →
  56. 1.0.0-beta.276 Jan 2021pre-release
    Release notes

    Features

    • A new command called push is now supported by OpenAPI CLI. With this command, you can upload your API descriptions and associated files, and set up your own CI pipeline for updating API descriptions without granting Redocly Workflows access to your repositories.

    Fixes

    • Resolved an issue that prevented using the . (dot) symbol in version names with the push command.

    Open source →
  57. 1.0.0-beta.266 Jan 2021pre-release

    Nothing published for this version

  58. 1.0.0-beta.2527 Nov 2020pre-release
    Release notes

    Fixes

    • Resolved an issue with assert-node-version using the wrong path.

    • OpenAPI CLI bundles the API description before gathering stats.


    Open source →
  59. 1.0.0-beta.2427 Nov 2020pre-release

    Nothing published for this version

  60. 1.0.0-beta.2324 Nov 2020pre-release
    Release notes

    Fixes

    • Resolved issues with tag logic and tag display names for the join command.

    • Refactored CLI command handlers.


    Open source →