First pass at a media types registry. #4517
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This attempts to explain the basics of what is going on in terms of "modeling" (what you do with a Schema Object and in-memory data structures) and "mapping" (how you translate that model into something that fits a particular media type that can be serialized onto, or parsed off of, the wire). This includes some sequential / streaming formats that will be added for 3.2, as well as a selection of media types directly addressed in the OAS text. We could add more, for example `image/*` that is more-or-less identical to `application/octet-stream`, but this gives the general idea. I omitted YAML since AFAIK it is rarely used in actual API payloads, and such use is not directly mentioned in the OAS.
handrews
added
media and encoding
3 tasks
duncanbeevers
approved these changes
Mar 29, 2025
|
|
||
| # Media Type Registry | ||
|
|
||
| This registry defines how to use the Schema Object, Media Type Object, and in some cases other Objects to model media types other than `application/json` or media types using a `+json` suffix. |
Co-authored-by: Duncan Beevers <[email protected]>
|
@duncanbeevers examples, schemas, representative payloads, etc. all belong on the learn site. All of the registries are bare-bones references, and this one is in line with that pattern. Contributions to the Learn site are encouraged :-) |
|
@duncanbeevers I do think that if/when we have that content on the Learn site, we should link to it directly from here (and similarly for other registries). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This attempts to explain the basics of what is going on in terms of "modeling" (what you do with a Schema Object and in-memory data structures) and "mapping" (how you translate that model into something that fits a particular media type that can be serialized onto, or parsed off of, the wire).
This includes some sequential / streaming formats that will be added for 3.2, as well as a selection of media types directly addressed in the OAS text. We could add more, for example
image/*that is more-or-less identical toapplication/octet-stream, but this gives the general idea.I omitted YAML since AFAIK it is rarely used in actual API payloads, and such use is not directly mentioned in the OAS.