Module options

Module options 

Source

Modules§

header_parameter
Nested message and enum types in HeaderParameter.
json_schema
Nested message and enum types in JSONSchema.
security_requirement
Nested message and enum types in SecurityRequirement.
security_scheme
Nested message and enum types in SecurityScheme.

Structs§

Contact
Contact is a representation of OpenAPI v2 specification’s Contact object.
ExternalDocumentation
ExternalDocumentation is a representation of OpenAPI v2 specification’s ExternalDocumentation object.
Header
Header is a representation of OpenAPI v2 specification’s Header object.
HeaderParameter
HeaderParameter a HTTP header parameter. See: https://swagger.io/specification/v2/#parameter-object
Info
Info is a representation of OpenAPI v2 specification’s Info object.
JsonSchema
JSONSchema represents properties from JSON Schema taken, and as used, in the OpenAPI v2 spec.
License
License is a representation of OpenAPI v2 specification’s License object.
Operation
Operation is a representation of OpenAPI v2 specification’s Operation object.
Parameters
Parameters is a representation of OpenAPI v2 specification’s parameters object. Note: This technically breaks compatibility with the OpenAPI 2 definition structure as we only allow header parameters to be set here since we do not want users specifying custom non-header parameters beyond those inferred from the Protobuf schema. See: https://swagger.io/specification/v2/#parameter-object
Response
Response is a representation of OpenAPI v2 specification’s Response object.
Schema
Schema is a representation of OpenAPI v2 specification’s Schema object.
Scopes
Scopes is a representation of OpenAPI v2 specification’s Scopes object.
SecurityDefinitions
SecurityDefinitions is a representation of OpenAPI v2 specification’s Security Definitions object.
SecurityRequirement
SecurityRequirement is a representation of OpenAPI v2 specification’s Security Requirement object.
SecurityScheme
SecurityScheme is a representation of OpenAPI v2 specification’s Security Scheme object.
Swagger
Swagger is a representation of OpenAPI v2 specification’s Swagger object.
Tag
Tag is a representation of OpenAPI v2 specification’s Tag object.

Enums§

Scheme
Scheme describes the schemes supported by the OpenAPI Swagger and Operation objects.