openapi-format/CHANGELOG.md

Format an OpenAPI document by ordering, formatting and filtering fields.

## unreleased

## [1.25.2] - 2025-04-02

- Overlay: Prevent distorted properties (#154)

## [1.25.1] - 2025-03-29

- Sort: Prevent distorted properties (#154)

## [1.25.0] - 2025-01-01

- CLI - Added option to apply OpenAPI overlay actions

## [1.24.2] - 2024-10-07

- fix: scalar $ref: >-

## [1.24.1] - 2024-10-04

- fix: replace 'node:path' with 'path' to resolve Webpack build error

## [1.24.0] - 2024-09-27

- CLI - Bundle local and remote file references
- CLI - Split OpenAPI in a multi-file structure 
- Add type definitions for openapi-format

## [1.23.2] - 2024-09-16

- Filter - handle inverseFlagValues removal of nested array values

## [1.23.1] - 2024-09-14

- Filter - handle flagValues removal of nested array values (#139)
- CLI - Fix to prevent that Sort settings get overwritten (#137)

## [1.23.0] - 2024-09-10

- Generate - Added option to generate operationId using template structures (#66)
- CLI - Added option to bundle all options in --configFile
- CLI - Added option to bundle all options in .openapiformatrc
- CLI - Keep YAML comments (#44)(#60)

## [1.22.5] - 2024-09-06

- Filter - Improved unused components handling

## [1.22.4] - 2024-09-04

- Filter - Extend methods/inverseMethods filtering with "head", "options", "trace" (#128)
- Bumped dependencies: Neotraverse, Jest

## [1.22.3] - 2024-08-19

- Filter - Fix to only remove unused components, keep properties with same key (#126)

## [1.22.2] - 2024-08-16

- Filter - Only remove path methods, keeping similarly named properties
- Filter - Prevent removal of empty objects in oneOf, allOf items

## [1.22.1] - 2024-08-04

- Convert - Check node is not null in traverse (#123)

## [1.22.0] - 2024-08-04

- Sort - Added option to sort paths alphabetically or by tag (#119)

## [1.21.2] - 2024-08-02

- Sort - Bugfix for requestBody.example distortion (#120)

## [1.21.1] - 2024-07-21

- Replaced Traverse with Neotraverse
- Casing - Improvements to handle special characters

## [1.21.0] - 2024-07-10

- Filter - added requestContent and inverseRequestContent filters 
- Bumped dependencies

## [1.20.0] - 2024-06-16

- Improved the logic to remove "unused" component items

## [1.19.0] - 2024-06-11

- CLI - option to open in online playground
- Added OpenAPI analyze method 

## [1.18.0] - 2024-06-06

- Bumped minimum NodeJS version to 18.x
- Refactor to handle null and undefined values in filterSet properties

## [1.17.2] - 2024-06-05

- Allow setting defaults via options
- Added support for uppercased filter methods
- Added parseString, detectFormat, isJson, isYaml functions

## [1.17.1] - 2024-05-18

- Bugfix to keep quotes for $ref values (#108)

## [1.17.0] - 2024-04-14

- Filter - Added inverse filtering for flags for operations, components, tags, x-tagGroups
- Filter - Added inverse filtering for flagValues for operations, components, tags, x-tagGroups

## [1.16.1] - 2024-03-06

- Bugfix to support http & https remote files

## [1.16.0] - 2024-01-16

- Filter - Flags for $ref items (#103)
- Casing - Extended changeCase function with customKeepChars parameter

## [1.15.4] - 2024-01-07

- Added support for local or remote files for any config file
- Refactored the file handling
- Added additional tests

## [1.15.3] - 2024-01-05

- Bumped dependencies traverse and node-version of the GitHub actions

## [1.15.2] - 2023-11-09

- Bugfix to only remove OpenAPI path items without operations (#96)

## [1.15.1] - 2023-11-02

- Sort - Prevent error if name doesn't exist (#94)

## [1.15.0] - 2023-11-01

- Sort - Sort inline parameters by alphabet (#82)

## [1.14.2] - 2023-10-29

- Bugfix for components.example distortion (#91)

## [1.14.1] - 2023-09-18

- Casing - Added support for casing of the required properties (#77)

## [1.14.0] - 2023-04-11

- Extended the CLI to support remote OpenAPI documents
- Label Dockerfile (#75)

## [1.13.1] - 2023-02-25

- Prevent removal of empty objects in default examples (#72)
- Update defaultSort.json, requestBody according to the spec (#69)
- Bumped dependencies @stoplight/yaml, traverse
- Build openapi-format as a Docker image

## [1.13.0] - 2022-11-12

- Extended openapi-format to support ordering, formatting and filtering for OpenAPI 3.1 documents
- Added the CLI option to convert an OpenAPI 3.0 document to an OpenAPI version 3.1

## [1.12.1] - 2022-08-25

- Filter - Bugfix for a combination of flags & flagValues

## [1.12.0] - 2022-08-25

- Filter - FlagValues within tags (#63)

## [1.11.0] - 2022-08-07

- Added support for parameters in Cookies (#61)

## [1.10.3] - 2022-06-21

- Bugfix for handling null values with inverse filtering (#56)

## [1.10.2] - 2022-06-07

- Bugfix for unwanted removal of free-form objects in component schemas (#57)

## [1.10.1] - 2022-05-03

- Bugfix for unwanted conversion of numbers in x-tags (#52)
- Bugfix for components.examples.properties distortion (#54)
- Bumped minimist version to v1.2.6

## [1.10.0] - 2022-03-17

- Bugfix for unwanted conversion of numbers in strings (#47)
- Filter - added responseContent and inverseResponseContent filters (#48)

## [1.9.2] - 2022-02-10

- Improved the matching of large numbers in YAML/JSON to prevent unwanted conversions

## [1.9.1] - 2022-02-09

- Bumped dependencies
- Handle large numbers more safely in YAML/JSON (#41 / #42)

## [1.9.0] - 2022-01-25

- Filter - Handle components with period (.) in their name/key (#37)
- Filter - Inverse operation IDs
- Updated CLI output
- Improved sort components logic
- Async/Await implementation
- Code formatting
- Extended CLI tests

## [1.8.1] - 2022-01-05

- Integrated "case-anything" package
- Enabled additional casing options (Ada_Case, Train-Case, ...)
- Set "@" and "$" as special characters during case formatting
- Migrated tests from Mocha to Jest

## [1.8.0] - 2021-12-27

- new feature - Formatting - Change casing of OpenAPI elements
    - Support common casing (camelCase, PascalCase, kebap-case, snake_case, ...)
    - Format the casing of fields & model names/keys for: properties, operationId, query params, path variables,
      headers, components

For more details on this new feature: https://github.com/thim81/openapi-format#openapi-formatting-configuration-options

## [1.7.2] - 2021-12-17

- Filtering - Fix handling of `inverseTags` for operations without tags (#25)

## [1.7.1] - 2021-12-03

- Reverted openapi-format success output because of minor offset

## [1.7.0] - 2021-12-03

- Filtering - Inverse filtering for operationIds via `inverseOperationIds`
- Filtering - Inverse filtering for tags via `inverseTags`
- Filtering - Inverse filtering for methods via `inverseMethods`
- Keep empty security object (#23)
- Improved openapi-format success output

## [1.6.3] - 2021-10-12

- Added the option to replace words/characters in description, summary, URL fields with new value

## [1.6.2] - 2021-10-08

- Fix for unsafe Object.keys variables

## [1.6.1] - 2021-10-08

- Fix for issue with the markdown comments strip filtering when non-strings descriptions

## [1.6.0] - 2021-10-08

- Added option to remove all "unused" component items through recursion
- Improved the openapi-format terminal log output and how verbose is handled
- Filtering will remove lines with markdown comments (syntax [comment]: <>) from the description fields.
- Fix/Hack to handle x-tagGroups filtering on flagValues

## [1.5.0] - 2021-10-05

- Added option to remove "unused" component items.

## [1.4.1] - 2021-10-05

- Implemented the missing functionality for removal of OpenAPI.x-tagGroups matching flags

## [1.4.0] - 2021-10-02

- Added option to strip flags based on the value of the flags from OpenAPI
- Added NPM badges

## [1.3.0] - 2021-09-03

- Added option to strip flags from OpenAPI
- Handled the unwanted sorting of components > examples > value properties
- Bumped dependencies @stoplight/yaml, mocha

## [1.2.5] - 2021-07-22

- Enhancement that will remove also openapi.tags when filtering on tags

## [1.2.4] - 2021-06-14

Released on 14 June 2021

- Dependency bumped by dependabot for security reasons

## [1.2.3] - 2021-05-23

- Reduced package size by setting files in packages.json and excluding the tests

## [1.2.2] - 2021-05-19

- Bug fix for sort file error when a custom sort file was defined

## [1.2.1] - 2021-05-19

- Bug fix #4 for sort file error - no such file or directory "defaultSort.json"

## [1.2.0] - 2021-05-15

- Added Filter OpenAPI files based on an operation definition, with matching logic and wildcard support

## [1.1.0] - 2021-04-11

- Added the option to sort the items of the components (schemas, parameters, ...) by alphabet
- Aligned YAML parsing style with Stoplight Studio style
- Added a reference to the asyncapi-format package
- Minor text corrections Bumped the minor version to 1.1.0 because of the changes of the changes in the YAML output
  because of the switch the @stoplight/yaml package

## [1.0.5] - 2021-03-22

- Bug fix #3 - "properties" in the examples section gets incorrectly handled

## [1.0.4] - 2021-03-18

- Bug fix #2 - Handle fields named "properties" in the properties object properly

## [1.0.3] - 2021-03-17

- Updated the documentation & links to the specification

## [1.0.2] - 2021-03-16

### Added

- Filter - Added support to filter out OpenAPI.tags matching the flags
- Filter - Added support for clean-up of path items without operations
- Bug fix - openapi-format not taken into account the customSort file

## [1.0.1] - 2021-03-16

- Improved handling of file references from within node_modules
- Handled an undefined exception

## [1.0.0] - 2021-03-15

Initial commit with features

- Order OpenAPI fields in a default order
- Order OpenAPI fields in a custom order
- Filter OpenAPI files based on methods
- Filter OpenAPI files based on flags
- Filter OpenAPI files based on tags
- Filter OpenAPI files based on operationID's
- Rename the OpenAPI title
- Support OpenAPI documents in JSON format
- Support OpenAPI documents in YAML format
- Format via CLI
- Format via config files
- Use via as Module
- Support for OpenAPI 3.0