Skip to main content

Interface: ISwagger

protoc_gen_openapiv2.options.ISwagger

Properties of a Swagger.

Implemented by​

Properties​

basePath​

• Optional basePath: null | string

The base path on which the API is served, which is relative to the host. If it is not included, the API is served directly under the host. The value MUST start with a leading slash (/). The basePath does not support path templating. Note that using base_path does not change the endpoint paths that are generated in the resulting OpenAPI file. If you wish to use base_path with relatively generated OpenAPI paths, the base_path prefix must be manually removed from your google.api.http paths and your code changed to serve the API from the base_path.

consumes​

• Optional consumes: null | string[]

A list of MIME types the APIs can consume. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.

extensions​

• Optional extensions: null | { [k: string]: IValue; }

Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification. See: https://swagger.io/docs/specification/2-0/swagger-extensions/

externalDocs​

• Optional externalDocs: null | IExternalDocumentation

Additional external documentation.

host​

• Optional host: null | string

The host (name or ip) serving the API. This MUST be the host only and does not include the scheme nor sub-paths. It MAY include a port. If the host is not included, the host serving the documentation is to be used (including the port). The host does not support path templating.

info​

• Optional info: null | IInfo

Provides metadata about the API. The metadata can be used by the clients if needed.

produces​

• Optional produces: null | string[]

A list of MIME types the APIs can produce. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.

responses​

• Optional responses: null | { [k: string]: IResponse; }

An object to hold responses that can be used across operations. This property does not define global responses for all operations.

schemes​

• Optional schemes: null | Scheme[]

The transfer protocol of the API. Values MUST be from the list: "http", "https", "ws", "wss". If the schemes is not included, the default scheme to be used is the one used to access the OpenAPI definition itself.

security​

• Optional security: null | ISecurityRequirement[]

A declaration of which security schemes are applied for the API as a whole. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). Individual operations can override this definition.

securityDefinitions​

• Optional securityDefinitions: null | ISecurityDefinitions

Security scheme definitions that can be used across the specification.

swagger​

• Optional swagger: null | string

Specifies the OpenAPI Specification version being used. It can be used by the OpenAPI UI and other clients to interpret the API listing. The value MUST be "2.0".

tags​

• Optional tags: null | ITag[]

A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.