However, it is expected from the documentation to cover a successful operation response and any known errors. As an extension to the Schema Object, its root Declares the value of the header that the server will use if none is provided.
(Note: "default" has no meaning for required headers.) See https://org/html/draft-fge-json-schema-validation-00#section-6.2.
Swagger™ is a project used to describe and document RESTful APIs.
The Swagger specification defines a set of files required to describe such an API.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.
The Swagger specification is licensed under The Apache License, Version 2.0.
The order of the tags can be used to reflect on their order by the parsing tools.
Not all tags that are used by the Operation Object must be declared.
The mime type definitions should be in compliance with RFC 6838.
Some examples of possible mime type definitions: text/plain; charset=utf-8 application/json application/vnd.github json application/vnd.github.v3 json application/vnd.github.v3json application/vnd.github.v3json application/vnd.github.v3json application/vnd.github.v3json application/vnd.github.v3application/vnd.github.v3.patch The HTTP Status Codes are used to indicate the status of the executed operation.
The id MUST be unique among all operations described in the API.