redocly-cli
redocly-cli copied to clipboard
Redocly
⚒️ Redocly CLI makes OpenAPI easy. Lint/validate to any standard, generate beautiful docs, and more.
**Describe the bug** Lint incorrectly trigger an error of type "parameter-description" when a parameter doesn't include a description when a schema is used. Since the schema does contain a description,...
**Describe the bug** When using the `bundle` command, the schemas in components.schemas reference themselves, instead of being dereferenced. Example from output: ```yaml components: schemas: User: $ref: '#/components/schemas/User' Country: $ref: '#/components/schemas/Country'...
From my experience it's a very common mistake to add siblings to `$refs`, especially when someone wants to change the description, title or example of a referenced element. A rule...
**Describe the bug** Before [this commit](https://github.com/Redocly/openapi-cli/commit/b53e9e4acbd694ac4b0aa4c8f09fc4c5b6f95901), the join command wasn't bundling documents. By changing this behaviour, running a join now always execute the decorators/preprocessor. For us, it's a regression because...
Discovered in: https://github.com/Redocly/openapi-cli/issues/645 When a string field uses YAML string blocks the string may end with a line break (for example, `|` vs `|-`). In the case of assertions, the...
**Describe the bug:** After executing the `openapi split` command on a Windows machine, the reference files are created with the backslashes. **To Reproduce:** On a Windows machine run `openapi split`...
**Describe the solution you'd like** Replace minimatch module with zero-dep picomatch: https://www.npmjs.com/package/picomatch **Additional context** Less dependencies is always good.
**Describe the bug** As the [openapi documentation](https://oai.github.io/Documentation/specification-docs.html) says: there is two modes for multiline strings in yaml: - Literal mode - Line breaks in the source YAML file are preserved...
**Describe the bug** `bundle` command squash referenced markdown file to one string. I'm not sure is that a bug or a feature absence 😅 **To Reproduce** Given this OpenAPI file:...
**Is your feature request related to a problem? Please describe.** We need our continuous integration to upload the openapi yaml to the Redocly API registry, but we always get time...
