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

examples keyword is marked as disallowed for Open API 3.1.0 #714

Open
sameerhussain opened this issue Jan 20, 2025 · 1 comment · May be fixed by #718
Open

examples keyword is marked as disallowed for Open API 3.1.0 #714

sameerhussain opened this issue Jan 20, 2025 · 1 comment · May be fixed by #718
Assignees

Comments

@sameerhussain
Copy link

sameerhussain commented Jan 20, 2025

  Message :   Found disallowed keyword: examples
  Rule    :   ibm-schema-keywords
  Path    :   paths./extract.post.responses.200.content.application/json.schema.examples
  Line    :   63

examples is keyword is allocated for list of examples. example is not allowed anymore in Open API 3.1.9. And, it is not updated here : https://github.com/IBM/openapi-validator/blob/main/docs/ibm-cloud-rules.md#ibm-schema-keywords

@dpopp07
Copy link
Member

dpopp07 commented Jan 23, 2025

Good catch - I will add "examples" to the allowlist (however, I'll keep "example" for compatibility since it's allowed but deprecated in some versions of 3.1.x).

@dpopp07 dpopp07 self-assigned this Jan 24, 2025
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 a pull request may close this issue.

2 participants