Swagger API 2.0
Swagger API 2.0
| Type | object |
|---|---|
| File match |
swagger.json
|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/swagger-api-2-0/latest.json |
| Source | https://spec.openapis.org/oas/2.0/schema/2017-08-27 |
Validate with Lintel
npx @lintel/lintel checkProperties
The Swagger version of this document.
General information about the API.
6 nested properties
A unique and precise title of the API.
A semantic version number of the API.
A longer description of the API. Should be different from the title. GitHub Flavored Markdown is allowed.
The terms of service for the API.
Contact information for the owners of the API.
3 nested properties
The identifying name of the contact person/organization.
The URL pointing to the contact information.
The email address of the contact person/organization.
2 nested properties
The name of the license type. It's encouraged to use an OSI compatible license.
The URL pointing to the license.
Relative paths to the individual endpoints. They must be relative to the 'basePath'.
The host (name or ip) of the API. Example: 'swagger.io'
The base path to the API. Example: '/api'.
One or more JSON objects describing the schemas being consumed and produced by the API.
One or more JSON representations for parameters
One or more JSON representations for responses
information about external documentation
2 nested properties
Definitions
General information about the API.
A unique and precise title of the API.
A semantic version number of the API.
A longer description of the API. Should be different from the title. GitHub Flavored Markdown is allowed.
The terms of service for the API.
Contact information for the owners of the API.
3 nested properties
The identifying name of the contact person/organization.
The URL pointing to the contact information.
The email address of the contact person/organization.
2 nested properties
The name of the license type. It's encouraged to use an OSI compatible license.
The URL pointing to the license.
Contact information for the owners of the API.
The identifying name of the contact person/organization.
The URL pointing to the contact information.
The email address of the contact person/organization.
The name of the license type. It's encouraged to use an OSI compatible license.
The URL pointing to the license.
Relative paths to the individual endpoints. They must be relative to the 'basePath'.
One or more JSON objects describing the schemas being consumed and produced by the API.
One or more JSON representations for parameters
One or more JSON representations for responses
information about external documentation
The MIME type of the HTTP message.
Response objects names can either be any valid HTTP status code or 'default'.
A brief summary of the operation.
A longer description of the operation, GitHub Flavored Markdown is allowed.
information about external documentation
2 nested properties
A unique identifier of the operation.
The parameters needed to send a valid API call.
12 nested properties
Response objects names can either be any valid HTTP status code or 'default'.
A brief summary of the operation.
A longer description of the operation, GitHub Flavored Markdown is allowed.
information about external documentation
2 nested properties
A unique identifier of the operation.
The parameters needed to send a valid API call.
12 nested properties
Response objects names can either be any valid HTTP status code or 'default'.
A brief summary of the operation.
A longer description of the operation, GitHub Flavored Markdown is allowed.
information about external documentation
2 nested properties
A unique identifier of the operation.
The parameters needed to send a valid API call.
12 nested properties
Response objects names can either be any valid HTTP status code or 'default'.
A brief summary of the operation.
A longer description of the operation, GitHub Flavored Markdown is allowed.
information about external documentation
2 nested properties
A unique identifier of the operation.
The parameters needed to send a valid API call.
12 nested properties
Response objects names can either be any valid HTTP status code or 'default'.
A brief summary of the operation.
A longer description of the operation, GitHub Flavored Markdown is allowed.
information about external documentation
2 nested properties
A unique identifier of the operation.
The parameters needed to send a valid API call.
12 nested properties
Response objects names can either be any valid HTTP status code or 'default'.
A brief summary of the operation.
A longer description of the operation, GitHub Flavored Markdown is allowed.
information about external documentation
2 nested properties
A unique identifier of the operation.
The parameters needed to send a valid API call.
12 nested properties
Response objects names can either be any valid HTTP status code or 'default'.
A brief summary of the operation.
A longer description of the operation, GitHub Flavored Markdown is allowed.
information about external documentation
2 nested properties
A unique identifier of the operation.
The parameters needed to send a valid API call.
12 nested properties
Response objects names can either be any valid HTTP status code or 'default'.
A brief summary of the operation.
A longer description of the operation, GitHub Flavored Markdown is allowed.
information about external documentation
2 nested properties
A unique identifier of the operation.
The parameters needed to send a valid API call.
The parameters needed to send a valid API call.
Response objects names can either be any valid HTTP status code or 'default'.
17 nested properties
17 nested properties
Any property starting with x- is valid.
The name of the parameter.
Determines the location of the parameter.
A deterministic version of a JSON Schema object.
30 nested properties
{}{}5 nested properties
information about external documentation
2 nested properties
A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed.
Determines whether or not this parameter is required or optional.
Determines whether or not this parameter is required or optional.
Determines the location of the parameter.
A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed.
The name of the parameter.
17 nested properties
17 nested properties
Determines whether or not this parameter is required or optional.
Determines the location of the parameter.
A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed.
The name of the parameter.
allows sending a parameter by name only or with an empty value.
17 nested properties
17 nested properties
Determines whether or not this parameter is required or optional.
Determines the location of the parameter.
A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed.
The name of the parameter.
allows sending a parameter by name only or with an empty value.
17 nested properties
17 nested properties
Determines whether or not this parameter is required or optional.
Determines the location of the parameter.
A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed.
The name of the parameter.
17 nested properties
17 nested properties
A deterministic version of a JSON Schema object.
{}{}5 nested properties
information about external documentation
2 nested properties
A deterministic version of a JSON Schema object.
information about external documentation
2 nested properties
17 nested properties
17 nested properties
information about external documentation
2 nested properties
The parameters needed to send a valid API call.
The transfer protocol of the API.