Skip to content

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

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.

Sign up for GitHub

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

Jump to bottom
Closed
sameerhussain opened this issue Jan 20, 2025 · 3 comments · May be fixed by #718
Closed

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

sameerhussain opened this issue Jan 20, 2025 · 3 comments · May be fixed by #718

Comments

@sameerhussain
Copy link

sameerhussain commented Jan 20, 2025 •
edited
Loading 

  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 •
edited
Loading

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 mentioned this issue Jan 24, 2025
Draft
@dpopp07 dpopp07 self-assigned this Jan 24, 2025
@dpopp07 dpopp07 removed their assignment Mar 6, 2025
@dpopp07
Copy link
Member

dpopp07 commented Mar 6, 2025

@sameerhussain will you point me to where you see this behavior for OpenAPI 3.1.9? It seems that the latest is 3.1.1.

@dpopp07
Copy link
Member

dpopp07 commented Apr 16, 2025

Closing for lack of activity

@dpopp07 dpopp07 closed this as completed Apr 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix(ibm-schema-keywords): include 'examples' in allowlist IBM/openapi-validator
2 participants
@sameerhussain @dpopp07