# README
protoc-gen-openapi
go install github.com/a27kash/protoc-gen-openapi
protoc --openapi_out=. --openapi_opt=paths=source_relative example/example.proto
# Structs
Components holds a set of reusable objects for different aspects of the OAS.
Contact information for the exposed API.
Discriminator is a specific object in a schema which is used to inform the consumer of the document of an alternative schema based on the value associated with it.
Encoding is a single encoding definition applied to a single schema property.
Example ...
ExternalDocumentation allows referencing an external resource for extended documentation.
Info provides metadata about the API.
License information for the exposed API.
Link object represents a possible design-time link for a response.
MediaType Object provides schema and examples for the media type identified by its key.
OpenAPI is the root object of the OpenAPI document.
Operation describes a single API operation on a path.
Parameter describes a single operation parameter.
PathItem describes the operations available on a single path.
Paths holds the relative paths to the individual endpoints and their operations.
Reference is a simple object to allow referencing other components in the OpenAPI document, internally and externally.
Response describes a single response from an API Operation, including design-time, static links to operations based on the response.
Responses is a container for the expected responses of an operation.
Schema allows the definition of input and output data types.
SecurityRequirement lists the required security schemes to execute this operation.
Server is an object representing a Server.
ServerVariable is an object representing a Server Variable for server URL template substitution.
Tag adds metadata to a single tag that is used by the Operation Object.
XML is a metadata object that allows for more fine-tuned XML model definitions.
# Interfaces
CallbackOrReference ...
ExampleOrReference ...
HeaderOrReference ...
LinkOrReference ...
ParameterOrReference ...
PathItemOrReference ...
RequestBodyOrReference ...
ResponseOrReference ...
# Type aliases
Header follows the structure of the Parameter Object.