-
Notifications
You must be signed in to change notification settings - Fork 9.1k
Align terminology with RFC7231. See #2476 #2477
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
Conversation
This PR distinguish between Content-Encoding HTTP header field, which is an ordered list of content-codings and Content-Transfer-Encoding which is a multipart header (see https://tools.ietf.org/html/rfc7578#section-4.5).
I am only endorsing the replacement of I wouldn't mention I don't know what a "content-coding" is or why that would be a more desirable term. And I wouldn't say "eventual content-[en]coding" because they're just different things. The only reason an order is mentioned is that the part that JSON Schema describes is done when serializing the media type, and the |
That's ok.
In HTTP, the
This means that when you use the http lexicon you don't actually have a "content-encoding" but either:
Aligning with the HTTP lexicon makes it easier not confusing the HTTP layer with the applicative one, especially when the wording choice is constrained. My 2¢, R. |
@ioggstream thanks for the content-coding explanation, somehow that had never registered despite how many times I've read the RFC! I definitely agree that using HTTP terminology with HTTP headers/concepts is ideal. For the rest of this, I will still leave it to the TSC as I'm not as involved with either JSON Schema or OAS as I was a year ago. paging @webron @philsturgeon @Relequestual (and do feel free to tag me again if there's something you need my help on). |
that's normal: I'm reading daily HTTP spec since 2018 and I'm still learning ;) |
hi @webron, should I move the PR to v3.1.1 ? |
Please do, thanks! |
This PR
See: #2476
Note
I have not been able to find a definition of
multipart metadata
in any RFC so I refer to Content-Transfer-Encoding because not all of its uses are deprecated: see https://tools.ietf.org/html/rfc7578#section-4.5).As I'm not sure of this point feel free to correct me.
cc: @handrews (PS thanks for your hard work and sorry for the late review)