Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature request: Support external metadata #494

Open
bdoughan-snow opened this issue Feb 21, 2024 · 1 comment
Open

Feature request: Support external metadata #494

bdoughan-snow opened this issue Feb 21, 2024 · 1 comment

Comments

@bdoughan-snow
Copy link

Is your feature request related to a problem? Please describe.
I am looking for a way to externalize the oasdiff metadata. Currently you can leverage the x-stability-level extension within an OpenAPI document, but care must be take to ensure any metadata added to the OpenAPI document is not released to the public.

Describe the solution you'd like
I am looking for something equivalent to what is offered by the Spectral linter. In the example below this metadata is saying that for the GET operation in the /api/pet-store/v1/pets endpoint turn off the paths-summary-get rule.

extends: 
  - ./rest-ruleset.yamloverrides:
  - files: 
      - "**#/paths/~1api~1pet-store~1v1~1pets/get"
    rules:
      paths-summary-get: off

Describe alternatives you've considered
Currently we are considering using the inline extensions with a Spectral linter rule to flag when this extension is present within an OpenAPI document.

Additional context
We would like this functionality to work with oasdiff-action.

@reuvenharrison
Copy link
Collaborator

Hi @bdoughan-snow,
I finally got around to this.
The plan is:

  1. Implement an oasdiff configuration file which allow you to read all options from a single file rather than today's combination of cmd-line flags and various files
  2. Extend the conf file to support this requirement

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants