Skip to content

v3.2: media-type description was not in 3.2.0, so cannot be added until 3.3 #5594

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

Merged
lornajane merged 1 commit into from
Nov 12, 2026
+0 −7
Merged

v3.2: media-type description was not in 3.2.0, so cannot be added until 3.3 #5594

Show file tree
Hide file tree
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
1 change: 0 additions & 1 deletion src/oas.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1267,7 +1267,6 @@ See [Working With Examples](#working-with-examples) for further guidance regardi

| Field Name | Type | Description |
| ---- | :----: | ---- |
| <a name="media-type-description"></a>description | `string` | An optional description for the media type. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. |
| <a name="media-type-schema"></a>schema | [Schema Object](#schema-object) | A schema describing the complete content of the request, response, parameter, or header. |
| <a name="media-type-item-schema"></a>itemSchema | [Schema Object](#schema-object) | A schema describing each item within a [sequential media type](#sequential-media-types). |
| <a name="media-type-example"></a>example | Any | Example of the media type; see [Working With Examples](#working-with-examples). |
Expand Down
2 changes: 0 additions & 2 deletions src/schemas/validation/schema.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -582,8 +582,6 @@ $defs:
$comment: https://spec.openapis.org/oas/v3.2#media-type-object
type: object
properties:
description:
type: string
schema:
$dynamicRef: '#meta'
itemSchema:
Expand Down
4 changes: 0 additions & 4 deletions tests/schema/pass/media-type-examples.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,6 @@ components:
Pet: {}
mediaTypes:
StreamingPets:
description: |
Streaming sequence of JSON pet representations,
suitable for use with any of the streaming JSON
media types.
itemSchema:
$ref: '#/components/schemas/Pet'
paths:
Expand Down
Loading