8000 v3.2: Add support for application/linkset[+json] by handrews · Pull Request #4740 · OAI/OpenAPI-Specification · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

v3.2: Add support for application/linkset[+json] #4740

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

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

Conversation

handrews
Copy link
Member

Fixes:

These media types solve our long-standing problems with modeling HTTP Link headers. We do not need to define anything beyond noting how to use them media types in a Media Type Ojbect. RFC9264 already defines the mapping between the JSON data model, the standalone HTTP-like format, and the actual HTTP Link header syntax. This fits well with our 3.2 theme of data modeling improvements.

When someone hands us a standardized solution for our problem, we should improve the standards ecosystem by adopting it :-) Note that this is much more powerful and flexible than the hack I used as an example elsewhere, which required a mind-boggling combination of anyOf, contains, and pattern and can't do much beyond checking for the link relations that way. Its also fragile due to the need to manage quoting and whitespace concerns, and the possibility of something elsewhere in a header matching a link relation type string. RFC9264 has none of these problems.

  • schema changes are included in this pull request
  • schema changes are needed for this pull request but not done yet
  • no schema changes are needed for this pull request

These media types solve our long-standing problems with modeling
HTTP Link headers.  We do not need to define anything beyond
noting how to use them media types in a Media Type Ojbect.
@handrews handrews added this to the v3.2.0 milestone Jun 18, 2025
@handrews handrews requested review from a team as code owners June 18, 2025 23:17
@handrews handrews added media and encoding Issues regarding media type support and how to encode data (outside of query/path params) headers labels Jun 18, 2025
@handrews handrews requested a review from dret June 19, 2025 22:28
@dret
Copy link
Contributor
dret commented Jun 20, 2025

I am always glad to see standards being useful and being adopted. And of course even more so when I played a role in creating these standards. But, @handrews, is there anything I need to actually review here other than being happy to see this happening?

@@ -2451,6 +2451,67 @@ Using `content` with a `text/plain` media type is RECOMMENDED for headers where
| ---- | :----: | ---- |
| <a name="header-content"></a>content | Map[`string`, [Media Type Object](#media-type-object)] | A map containing the representations for the header. The key is the media type and the value describes it. The map MUST only contain one entry. |

##### Modeling Link Headers

[[!RFC9264]] defines the `application/linkset` and `application/linkset+json` media types.
Copy link
Contributor

Choose a reason for hiding this comment

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

I am assuming this pulls in the reference info automatically? If not, it probably needs to be added somewhere in the references section.

Copy link
Member Author

Choose a reason for hiding this comment

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

@dret yes, the [[!]] adds it to the normative references. Which I think is correct as we do that with the main multipart RFCs? Although I see I added the RFCs for application/json-seq and +json-seq to informative using [[?]]... so maybe I don't have the best grasp on which goes where.

Sorry, something went wrong.

@handrews
Copy link
Member Author

@dret

But, @handrews, is there anything I need to actually review here other than being happy to see this happening?

I'm mostly just checking to make sure I didn't egregiously misunderstand or misuse the RFC :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
headers media and encoding Issues regarding media type support and how to encode data (outside of query/path params)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
0