From 240f6b9de637c584a289b56973cbc1ca2e086d62 Mon Sep 17 00:00:00 2001 From: Roberto Polli Date: Wed, 5 Mar 2025 11:30:51 +0100 Subject: [PATCH 1/4] Fix: #119. Mention interoperability considerations in registration. --- draft-ietf-httpapi-rest-api-mediatypes.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/draft-ietf-httpapi-rest-api-mediatypes.md b/draft-ietf-httpapi-rest-api-mediatypes.md index 6b9bd5a..8d54ebb 100644 --- a/draft-ietf-httpapi-rest-api-mediatypes.md +++ b/draft-ietf-httpapi-rest-api-mediatypes.md @@ -320,6 +320,9 @@ Q: Why this document? This has some security implications too (eg. wrt on identifying parsers or treat downloads) +Q: Do we support OpenAPI 2.0 / Swagger? +: No, this document is about OpenAPI 3.0 and above. + # Change Log {: numbered="false" removeinrfc="true"} From a75bbd54907264cb3d06fbaf8749a0fb1c79879f Mon Sep 17 00:00:00 2001 From: Roberto Polli Date: Wed, 5 Mar 2025 12:49:22 +0100 Subject: [PATCH 2/4] Fix: #110. Don't need new parameter. --- draft-ietf-httpapi-rest-api-mediatypes.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/draft-ietf-httpapi-rest-api-mediatypes.md b/draft-ietf-httpapi-rest-api-mediatypes.md index 8d54ebb..e1038e9 100644 --- a/draft-ietf-httpapi-rest-api-mediatypes.md +++ b/draft-ietf-httpapi-rest-api-mediatypes.md @@ -251,6 +251,20 @@ Interoperability requirements for media type registrations are discussed in Section 4.6 of {{!MEDIATYPE=RFC6838}} and in the Interoperability Considerations of the "+yaml" Structured Syntax Suffix. +## Media type of referenced resources + +An OpenAPI Description can reference external resources +that are not OpenAPI Documents (e.g., JSON Schema documents). +Clients should be aware that +even if they request a specific media type for those resources +(e.g., `Accept: application/openapi+yaml; version=3.1`), +the server might only be able to provide a more generic media type. + +For example, a server that publishes a JSON Schema file, +which can be referenced by both OpenAPI and JSON Schema documents, +might choose to use the more generic `application/yaml` media type +instead of managing multiple specific media types for the same resource. + # Security Considerations {#sec} Security requirements for media type From 76c382074ded49ffa93c2e005cc03cd8f9f59411 Mon Sep 17 00:00:00 2001 From: Roberto Polli Date: Tue, 18 Mar 2025 10:06:19 +0100 Subject: [PATCH 3/4] Remove OAS 2.0 considerations. --- draft-ietf-httpapi-rest-api-mediatypes.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/draft-ietf-httpapi-rest-api-mediatypes.md b/draft-ietf-httpapi-rest-api-mediatypes.md index e1038e9..7fe96a0 100644 --- a/draft-ietf-httpapi-rest-api-mediatypes.md +++ b/draft-ietf-httpapi-rest-api-mediatypes.md @@ -334,9 +334,6 @@ Q: Why this document? This has some security implications too (eg. wrt on identifying parsers or treat downloads) -Q: Do we support OpenAPI 2.0 / Swagger? -: No, this document is about OpenAPI 3.0 and above. - # Change Log {: numbered="false" removeinrfc="true"} From 23e1da7f54f64257a24abc512556b6b7e074a9aa Mon Sep 17 00:00:00 2001 From: Roberto Polli Date: Tue, 18 Mar 2025 11:00:30 +0100 Subject: [PATCH 4/4] Non-entry documents --- draft-ietf-httpapi-rest-api-mediatypes.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/draft-ietf-httpapi-rest-api-mediatypes.md b/draft-ietf-httpapi-rest-api-mediatypes.md index 7fe96a0..5ac06d9 100644 --- a/draft-ietf-httpapi-rest-api-mediatypes.md +++ b/draft-ietf-httpapi-rest-api-mediatypes.md @@ -265,6 +265,13 @@ which can be referenced by both OpenAPI and JSON Schema documents, might choose to use the more generic `application/yaml` media type instead of managing multiple specific media types for the same resource. +## Resources not containing an OpenAPI Object + +A server can publish an OpenAPI resource that +does not contain an "OpenAPI Object". +In this case, the `version` parameter is useful to identify +the specification version. + # Security Considerations {#sec} Security requirements for media type