Add support for OpenAPI custom extensions about oasdiff HOT 4 CLOSED

Hi @petkostas,
Thanks for submitting this issue.
Before adding another configuration flag to support your request, I'd like to suggest using the Operation Tag instead of Specification Extensions to document your APIs.
What do you think?

from oasdiff.

Hi @reuvenharrison thanks for the suggestion, we do use the operation tags, but there are also some tools that add custom specification extensions.
Obviously, the exclude filter could take into consideration tags, the suggestion for the extension was mostly based on the fact that some other OSS tools make use of it.
In our case, the operation tag would be also a perfect candidate!

from oasdiff.

I have two follow up questions:

1. Can you provide an example of an OSS tool that uses extensions? I'd like to make sure that I understand this.
2. What happens if an API has an 'x-beta' extension in one of the specs only? For example:

Spec 1:

info:
  title: Tufin
  version: 1.0.0
openapi: 3.0.3
paths:
  /api/test:
    x-beta: true 
    get:
      responses:
        200:
          description: OK

Spec 2:

info:
  title: Tufin
  version: 1.0.0
openapi: 3.0.3
paths:
  /api/test:
    get:
      responses:
        200:
          description: OK

what should be the results of:
oasdiff -base spec1 -revision spec2
and:
oasdiff -base spec2 -revision spec1

from oasdiff.

@reuvenharrison examples of using extensions:

• https://redocly.com/docs/cli/guides/hide-apis/
• Stoplight also uses an x-private extension

We are not currently using an extension to mark APIs as beta (and as you mentioned we can easily also use a tag for it), to help you understand more, we use oasdiff in our repository pipelines. every MR checks for changes against the master repo reference.
For the moment as we can't support tags or extensions, we have to manually specify which APIs are stable and additionally the ones under development. In case there is a change of the APIs under development oasdiff needs to be completely bypassed by using a commit-specific title.
I hope this makes it a bit more clear.
In your example, oasdiff would completely ignore the specific path when comparing it.

from oasdiff.