thim81/openapi-format
Format an OpenAPI document by ordering, formatting and filtering fields.
30 Releases
Latest: yesterday
v1.33.4Latest
📋 What's Changed
- feat: add `yamlCompat` option for YAML 1.1 for older OpenAPI tools (https://github.com/thim81/openapi-format/pull/227)
- Full Changelog: https://github.com/thim81/openapi-format/compare/v1.33.3...v1.33.4
v1.33.3
📋 What's Changed
- fix(sort): make path comparator consistent for trailing-slash paths by @kistlers in https://github.com/thim81/openapi-format/pull/229
✨ New Contributors
- @kistlers made their first contribution in https://github.com/thim81/openapi-format/pull/229
- Full Changelog: https://github.com/thim81/openapi-format/compare/v1.33.2...v1.33.3
v1.33.2
📋 What's Changed
- #223 feat(config): ship JSON Schema for the configuration file by @arseniy-gl in https://github.com/thim81/openapi-format/pull/224
✨ New Contributors
- @arseniy-gl made their first contribution in https://github.com/thim81/openapi-format/pull/224
- Full Changelog: https://github.com/thim81/openapi-format/compare/v1.33.1...v1.33.2
v1.33.1
📋 What's Changed
- Filter: Keep discriminator in referenced schemas by @thim81 in https://github.com/thim81/openapi-format/pull/219
- Casing: Transform discriminator propertyName according to properties casing by @aabounegm in https://github.com/thim81/openapi-format/pull/217
- test: Casing transform discriminator propertyName by @thim81 in https://github.com/thim81/openapi-format/pull/220
✨ New Contributors
- @aabounegm made their first contribution in https://github.com/thim81/openapi-format/pull/217
- Full Changelog: https://github.com/thim81/openapi-format/compare/v1.33.0...v1.33.1
v1.33.0
📋 What's Changed
- feat: Align overlay copy action with Overlay 1.1 https://github.com/thim81/openapi-format/pull/214
- feat: Keep quote preference https://github.com/thim81/openapi-format/pull/215
- Full Changelog: https://github.com/thim81/openapi-format/compare/v1.32.1...v1.33.0
v1.32.1
📋 What's Changed
- fix: Handle emptied unusedComponents (#210)
- Full Changelog: https://github.com/thim81/openapi-format/compare/v1.32.0...v1.32.1
v1.32.0
📋 What's Changed
- CLI: Fix YAML output to preserve x-version number formatting by @thim81 in https://github.com/thim81/openapi-format/pull/208
- Casing - Configure characters to keep by @thim81 in https://github.com/thim81/openapi-format/pull/209
- Full Changelog: https://github.com/thim81/openapi-format/compare/v1.31.0...v1.32.0
v1.31.0
📋 What's Changed
- > [!IMPORTANT]
- > Important Change: Since version 1.31.0, `openapi-format` uses the `yaml` library by [eemeli](https://github.com/eemeli/yaml) instead of `@stoplight/yaml`.
- > This improves comment preservation and fixes issues with unnecessary quoting and string formatting.
- > As a result, generated YAML output may differ slightly (e.g. quoting and formatting), which can lead to diffs in existing files.
- refactor: replace stoplight/yaml with yaml (eemeli) by @guilhas07 in https://github.com/thim81/openapi-format/pull/206
✨ New Contributors
- @guilhas07 made their first contribution in https://github.com/thim81/openapi-format/pull/205
- Full Changelog: https://github.com/thim81/openapi-format/compare/v1.30.1...v1.31.0
v1.30.1
📋 What's Changed
- CLI: Fix normalize YAML block scalar newlines by @thim81 in https://github.com/thim81/openapi-format/pull/203
- Full Changelog: https://github.com/thim81/openapi-format/compare/v1.30.0...v1.30.1
v1.30.0
📋 What's Changed
- feat: OpenAPI Overlay 1.1.0 by @thim81 in https://github.com/thim81/openapi-format/pull/200
- feat: improve CLI playground URL handling by @thim81 in https://github.com/thim81/openapi-format/pull/201
- Full Changelog: https://github.com/thim81/openapi-format/compare/v1.29.5...v1.30.0
v1.29.5
📋 What's Changed
- Add missing types for inverseFlags/inverseFlagValues by @segevfiner in https://github.com/thim81/openapi-format/pull/195
- Types: Update Typescript typings by @thim81 in https://github.com/thim81/openapi-format/pull/197
- Filter: preserve inverse flag filtering with stripFlags by @thim81 in https://github.com/thim81/openapi-format/pull/198
- Filter: combine inverseTags and inverseFlag by @thim81 in https://github.com/thim81/openapi-format/pull/199
✨ New Contributors
- @segevfiner made their first contribution in https://github.com/thim81/openapi-format/pull/195
- Full Changelog: https://github.com/thim81/openapi-format/compare/v1.29.4...v1.29.5
v1.29.4
📋 What's Changed
- refactor: Switch to jsonpathly library
- Full Changelog: https://github.com/thim81/openapi-format/compare/v1.29.3...v1.29.4
v1.29.3
📋 What's Changed
- Fix some optional config file boolean options not being honored @jdechicchis in https://github.com/thim81/openapi-format/pull/188
- test: overlay-multiline-description by @thim81 in https://github.com/thim81/openapi-format/pull/189
- chore: Tag docker with version
- test: overlay-multiline-description
✨ New Contributors
- @jdechicchis made their first contribution in https://github.com/thim81/openapi-format/pull/188
- Full Changelog: https://github.com/thim81/openapi-format/compare/v1.29.2...v1.29.3
v1.29.2
📋 What's Changed
- Remove commander by @thim81 in https://github.com/thim81/openapi-format/pull/185
- Module: Handle default sort sets by @thim81 in https://github.com/thim81/openapi-format/pull/186
- Full Changelog: https://github.com/thim81/openapi-format/compare/v1.29.1...v1.29.2
v1.29.1
📋 What's Changed
- Overlays): fix copy `update` object to avoid applying to references by @johncowen in https://github.com/thim81/openapi-format/pull/183
✨ New Contributors
- @johncowen made their first contribution in https://github.com/thim81/openapi-format/pull/183
- Full Changelog: https://github.com/thim81/openapi-format/compare/v1.29.0...v1.29.1
v1.29.0
📋 What's Changed
- CLI: convert to OpenAPI 3.2 by @thim81 in https://github.com/thim81/openapi-format/pull/181
- Sort & Filter OpenAPI 3.2 by @thim81 in https://github.com/thim81/openapi-format/pull/182
- Full Changelog: https://github.com/thim81/openapi-format/compare/v1.28.0...v1.29.0
v1.28.0
📋 What's Changed
- fix: incorrect relative path generation in $ref during OpenAPI document splitting by @SaranshChaudhary in https://github.com/thim81/openapi-format/pull/175
- Improvement: Added safe checks for invalid YAML by @thim81 in https://github.com/thim81/openapi-format/pull/177
- Overlay - Support "extends" for referencing OpenAPI documents by @thim81 in https://github.com/thim81/openapi-format/pull/178
✨ New Contributors
- @SaranshChaudhary made their first contribution in https://github.com/thim81/openapi-format/pull/175
- Full Changelog: https://github.com/thim81/openapi-format/compare/v1.27.3...v1.28.0
v1.27.3
📋 What's Changed
- Convert: convert nullable for anyOf oneOf to 3.1 (#172) by @sam-super in https://github.com/thim81/openapi-format/pull/173
- Convert: convert 0 correctly for exclusiveMinimum and exclusiveMaximum (#174) by @sam-super in https://github.com/thim81/openapi-format/pull/173
✨ New Contributors
- @sam-super made their first contribution in https://github.com/thim81/openapi-format/pull/173
- Full Changelog: https://github.com/thim81/openapi-format/compare/v1.27.2...v1.27.3
v1.27.2
📋 What's Changed
- Sorting: fix encodeLargeNumbers to respect comma values by @thim81 in https://github.com/thim81/openapi-format/pull/171
- Full Changelog: https://github.com/thim81/openapi-format/compare/v1.27.1...v1.27.2
v1.27.1
📋 What's Changed
- Sorting: ignore casing when sorting component properties by @thim81 in https://github.com/thim81/openapi-format/pull/168
- Full Changelog: https://github.com/thim81/openapi-format/compare/v1.27.0...v1.27.1
v1.27.0
📋 What's Changed
- Sorting: Sort component properties by name by @thim81 in https://github.com/thim81/openapi-format/pull/164
- fix: Prevent sorting of required array properties by @thim81 in https://github.com/thim81/openapi-format/pull/167
- Full Changelog: https://github.com/thim81/openapi-format/compare/v1.26.0...v1.27.0
v1.26.0
📋 What's Changed
- improvement: Inverse filters keeps components by @thim81 in https://github.com/thim81/openapi-format/pull/161
- > [!NOTE]
- Full Changelog: https://github.com/thim81/openapi-format/compare/v1.25.4...v1.26.0
v1.25.4
📋 What's Changed
- Filter: Reworked unused component logic by @thim81 in https://github.com/thim81/openapi-format/pull/159
- Full Changelog: https://github.com/thim81/openapi-format/compare/v1.25.3...v1.25.4
v1.25.3
📋 What's Changed
- Filtering: Improved the unused components removal by @thim81 in https://github.com/thim81/openapi-format/pull/158
- Full Changelog: https://github.com/thim81/openapi-format/compare/v1.25.2...v1.25.3
v1.25.2
📋 What's Changed
- Overlay: Prevent distorted properties by @thim81 in https://github.com/thim81/openapi-format/pull/156
- Full Changelog: https://github.com/thim81/openapi-format/compare/v1.25.1...v1.25.2
v1.25.1
📋 What's Changed
- fix: Prevent distorted properties by @thim81 in https://github.com/thim81/openapi-format/pull/155
- Full Changelog: https://github.com/thim81/openapi-format/compare/v1.25.0...v1.25.1
v1.25.0
📋 What's Changed
- Apply OpenAPI overlay actions by @thim81 in https://github.com/thim81/openapi-format/pull/150
- Full Changelog: https://github.com/thim81/openapi-format/compare/v1.24.2...v1.25.0
v1.24.2
📋 What's Changed
- fix: scalar $ref: >- by @thim81 in https://github.com/thim81/openapi-format/pull/146
- Full Changelog: https://github.com/thim81/openapi-format/compare/v1.24.1...v1.24.2
v1.24.1
📋 What's Changed
- fix: replace 'node:path' with 'path' to resolve Webpack build error by @thim81 in https://github.com/thim81/openapi-format/pull/145
- Full Changelog: https://github.com/thim81/openapi-format/compare/v1.24.0...v1.24.1
v1.24.0
📋 What's Changed
- CLI - Split OpenAPI in a multi-file structure
- CLI - Bundle local and remote file references
- Add type definitions for openapi-format
- Full Changelog: https://github.com/thim81/openapi-format/compare/v1.23.2...v1.24.0
