Fix: #103. Split OAS and JSON Schema. #104
Conversation
|
I'll take a look. Also paging @awwright. Also could an admin of the HTTP API IETF mailing list check the approval queue for emails from me? None of my replies have been going through. |
|
* Also could an admin of the HTTP API IETF mailing list check the approval queue for emails from me? None of my replies have been going through.
There was one pending message from Nov 4 which got lost/ignored/misplaces during IETF week. Were the others? Ping me off-line.
|
|
As a reminder, we (the JSON Schema team) have decided not to pursue media type registration until we get the next release of JSON Schema out. There's a lot of changes happening around how the spec will be maintained and evolved and we want to work that out before we continue this process. It's ok to keep the split out JSON Schema registration around for future use, but work should be considered on-hold for that document. |
| OpenAPI Specification [OAS] version 3 and above | ||
| is a consolidated standard for describing | ||
| HTTP APIs using the JSON {{!JSON=RFC8259}} and YAML [YAML] data format. | ||
|
|
||
| YAML media type registration is addressed in {{!YAML-MEDIATYPES=I-D.ietf-httpapi-yaml-mediatypes}}, | ||
| which provides interoperability and security considerations. | ||
|
|
||
| OpenAPI media type registration is addressed in {{!OAS-MEDIATYPES=I-D.ietf-httpapi-rest-api-mediatypes}}, | ||
| which provides interoperability and security considerations. | ||
|
|
||
| To increase interoperability when processing API specifications | ||
| and leverage content negotiation mechanisms when exchanging | ||
| OpenAPI Specification resources |
There was a problem hiding this comment.
This belongs in the OpenAPI registration, not the JSON Schema registration. I wouldn't worry about rewriting it for the purposes of this PR, but I suggest removing it and leaving it for later to add a proper introduction for JSON Schema.
There was a problem hiding this comment.
Ok, we'll fix it in a future PR.
| author: | ||
| - | ||
| ins: R. Polli | ||
| name: Roberto Polli | ||
| org: Digital Transformation Department, Italian Government | ||
| email: [email protected] | ||
| country: Italy |
There was a problem hiding this comment.
The JSON Schema section of the original document was contributed by me and is now it's own document. I think that should earn me an author credit.
There was a problem hiding this comment.
I'm happy to add you as a co-editor!
Could you write an email to the httpapi and the chairs about that?
There was a problem hiding this comment.
I am supportive of adding Jason as an author.
| @@ -79,15 +77,10 @@ OpenAPI Specification [OAS] version 3 and above | |||
| is a consolidated standard for describing | |||
| HTTP APIs using the JSON {{!JSON=RFC8259}} and YAML [YAML] data format. | |||
|
|
|||
| YAML media type registration is addressed in {{!YAML-MEDIATYPES=I-D.ietf-httpapi-yaml-mediatypes}}, | |||
| which provides interoperability and security considerations. | |||
|
|
|||
| To increase interoperability when processing API specifications | |||
There was a problem hiding this comment.
| To increase interoperability when processing API specifications | |
| To increase interoperability when processing API descriptions |
| @@ -228,13 +221,13 @@ Fragment identifier considerations: | |||
|
|
|||
There was a problem hiding this comment.
I believe we are going to need to be explicit here about support for fragment identifiers being either JSON pointers or component schema names.
There was a problem hiding this comment.
If this can be deferred to another PR, I propose to merge this and release the split documents.
There was a problem hiding this comment.
Yes, it will be easier to review changes once the split PR is merged.
Co-authored-by: Darrel <[email protected]>
This PR