Skip to content
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

OpenAPI media type #117

Open
cportele opened this issue Apr 6, 2018 · 5 comments
Open

OpenAPI media type #117

cportele opened this issue Apr 6, 2018 · 5 comments
Assignees
Labels
OGC API: Common Issue related to general resources or requirements (see #190) progress: waiting for feedback/input

Comments

@cportele
Copy link
Member

cportele commented Apr 6, 2018

Previously it was planned by OAI to register application/openapi+json (which we use in the current draft), but OAI seems to have changed its mind. See the latest entries in OAI/OpenAPI-Specification#110 which suggest:

  • application/vnd.oai.openapi (YAML variant)
  • application/vnd.oai.openapi+json (JSON only variant)

As these media types are not registered with IANA yet, I think we should keep the current media type for now, but update it once it has been registered with IANA.

@cportele cportele added the Part 1: Core Issue related to Part 1 - Core label Apr 6, 2018
@cportele cportele self-assigned this Apr 6, 2018
@cmheazel
Copy link
Contributor

cmheazel commented Jul 3, 2018

Ref: [https://github.com/OAI/OpenAPI-Specification/issues/110](OpenAPI Issue 110)

The MIME Types for OpenAPI have been finalized.
application/vnd.oai.openapi (YAML variant)
application/vnd.oai.openapi+json (JSON only variant)

With an optional version:
application/vnd.oai.openapi;version=3.0

@cportele
Copy link
Member Author

cportele commented Jul 3, 2018

The media types have been agreed by the OAI TSC, but are not yet in the media type register of IANA. However, since they are in the vnd branch, it should not take long. I will create a pull request once the media types are in the IANA register.

@cportele cportele added this to the Part 1, Second Draft Release milestone Aug 8, 2018
@cmheazel
Copy link
Contributor

It would be helpful if we included the media types that the TSC did agree to. The risk is that since they have not been registered, the TSC could change their minds.

@cportele cportele added the OGC API: Common Issue related to general resources or requirements (see #190) label Mar 5, 2019
@cportele cportele removed the Part 1: Core Issue related to Part 1 - Core label Jun 25, 2019
@cportele cportele removed this from the Part 1, Second Draft Release milestone Jun 25, 2019
@cportele
Copy link
Member Author

It is unclear when or if OAI will register the media types. For now we will use latest ones agreed by the TSC and add a note about their status.

@cportele
Copy link
Member Author

@cportele cportele moved this to Waiting for Input in Features Part 1: Core Jun 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
OGC API: Common Issue related to general resources or requirements (see #190) progress: waiting for feedback/input
Projects
Status: Waiting for Input
Development

No branches or pull requests

2 participants