Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Define formal media type (MIME type) for Swagger Object

See original GitHub issue

A media type of application/swagger+json has been suggested on the mailing list before. I would recommend formally declaring this as part of the spec.

RAML defines its media type as application/raml+yaml

API Blueprint defines its base media type as application/vnd.apiblueprint.ast plus similar ones for other serializations

Issue Analytics

State:
Created 9 years ago
Comments:88 (55 by maintainers)

Top GitHub Comments

15reactions

darrelmillercommented, Jul 30, 2020

Considering these:

  application/openapi
  application/openapi+json

Optional version parameters:

  application/openapi;version=3.1

Version number should only include major and minor. Do not include patch.

Please provide thumbs up on this suggestion?

4reactions

darrelmillercommented, Feb 9, 2018

Following TSC conversation, here is our latest proposal,

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

Optional version parameter:

 application/vnd.oai.openapi;version=2.0

Top Results From Across the Web

MIME Types - Swagger

Global MIME types can be defined on the root level of an API specification and are inherited by all API operations. Here the...

OpenAPI Specification - Version 3.0.3 - Swagger

The OpenAPI Specification defines a standard interface to RESTful APIs which allows ... The media type definitions SHOULD be in compliance with RFC6838....

OpenAPI Specification - Version 2.0 - Swagger

Version 2.0 specification defines a set of files required to describe an API. These files can then be used by the Swagger-UI project...

Describing Request Body - Swagger

The body parameter is defined in the operation's parameters section and ... The data type is usually an object, but can also be...

Swagger RESTful API Documentation Specification

A list of MIME types this operation can produce. This is overrides the global produces definition at the root of the API Declaration....