Skip to content

Correct schema $comment for OAD content definition #5289

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

Open
notEthan wants to merge 1 commit into
base: v3.2-dev
Choose a base branch
from
+5 −1
Open

Correct schema $comment for OAD content definition #5289

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion src/schemas/validation/schema.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -566,7 +566,11 @@ $defs:
$ref: '#/$defs/request-body'

content:
$comment: https://spec.openapis.org/oas/v3.2#fixed-fields-10
$comment: |
Parameter Object: https://spec.openapis.org/oas/v3.2#fixed-fields-9
Request Body Object: https://spec.openapis.org/oas/v3.2#fixed-fields-10
Response Object: https://spec.openapis.org/oas/v3.2#fixed-fields-14
Header Object: https://spec.openapis.org/oas/v3.2#fixed-fields-17
Comment on lines +569 to +573
Copy link
Copy Markdown
Contributor

@ralfhandl ralfhandl Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not link to the corresponding "Xxx Object" sections instead of the "Fixed Fields" subsections? Those are "close enough", especially for Parameter/Header Object where content is way down in the "Fixed Fields for use with content" subsection.

type: object
additionalProperties:
$ref: '#/$defs/media-type-or-reference'
Expand Down
Loading