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

fix(ibm-schema-keywords): include 'examples' in allowlist #718

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

dpopp07
Copy link
Member

@dpopp07 dpopp07 commented Jan 24, 2025

The OpenAPI 3.1 specification states:

The example property has been deprecated in favor of the JSON Schema examples
keyword. Use of example is discouraged, and later versions of this
specification may remove it.

We had previously excluded the use of 'examples' but as the specification is moving away from 'example' completely, we need to support it to allow proper authorship of OpenAPI 3.1.x documents.

This PR is currently in draft mode until internal support for examples is delivered.

Resolves #714

The OpenAPI 3.1 specification states:

> The example property has been deprecated in favor of the JSON Schema examples
> keyword. Use of example is discouraged, and later versions of this
> specification may remove it.

We had previously excluded the use of 'examples' but as the specification is
moving away from 'example' completely, we need to support it to allow proper
authorship of OpenAPI 3.1.x documents.

Signed-off-by: Dustin Popp <[email protected]>
@dpopp07 dpopp07 marked this pull request as draft January 24, 2025 17:47
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

Successfully merging this pull request may close these issues.

examples keyword is marked as disallowed for Open API 3.1.0
1 participant