# Functions
AllSchema creates a schema with allOf.
AnySchema creates a schema with anyOf.
APIKeyAuth creates an api key auth security scheme.
ArrayProperty creates an array property.
BasicAuth creates a basic auth security scheme.
BearerAuth creates a bearer auth security scheme.
BinaryProperty creates a string property any sequence of octets.
BooleanProperty creates a boolean property.
ByteProperty creates a string property base64 encoded characters.
CookieParam creates a path parameter, this is always required.
DateProperty creates a date property.
DateTimeProperty creates a date time property.
Float32Property creates a float32/float property.
Float64Property creates a float64/double property.
FloatFmtProperty creates a property for the named float format.
FormDataRequestBody creates a request body.
FormDataResponse creates a request body.
HeaderParam creates a header parameter, this is always required by default.
Int16Property creates an int16 property.
Int32Property creates an int32 property.
Int64Property creates an int64 property.
Int8Property creates an int8 property.
IntFmtProperty creates a property for the named int format.
JSONRequestBody creates a request body.
JSONResponse creates a request body.
MapProperty creates a map property.
NewAny Create an any.
NewComponents create a new new components.
NewRequestBody creates a request body.
NewResponse creates a response.
NewServers Will list all possible server options based on all servers.
NotSchema creates a schema with not.
OAuth2AuthorizationCode creates an application flow oauth2 security scheme.
OAuth2ClientCredentials creates an access token flow oauth2 security scheme.
OAuth2Implicit creates an implicit flow oauth2 security scheme.
OAuth2Password creates a password flow oauth2 security scheme.
OctetStreamRequestBody creates a request body.
OctetStreamResponse creates a request body.
OneSchema creates a schema with oneOf.
PasswordProperty creates a string property A hint to UIs to obscure input.
PathParam creates a path parameter, this is always required.
QueryParam creates a query parameter.
StrFmtProperty creates a property for the named string format.
StringProperty creates a string property.
TextPlainRequestBody creates a request body.
TextPlainResponse creates a request body.
URLEncodedRequestBody creates a request body.
URLEncodedResponse creates a request body.
XMLRequestBody creates a request body.
XMLResponse creates a request body.
# Constants
CallbackKind designating *Callback.
ExampleKind designating *Example.
HeaderKind designating *Header.
Used to pass a specific cookie value to the API.
Custom headers that are expected as part of the request.
Used together with Path Templating, where the parameter value is actually part of the operation's URL.
Parameters that are appended to the URL.
InvalidKind designating invalid scheme.
LinkKind designating *Link.
Media type definitions are spread across several resources.
Media type definitions are spread across several resources.
Media type definitions are spread across several resources.
Media type definitions are spread across several resources.
Media type definitions are spread across several resources.
Media type definitions are spread across several resources.
ParameterKind designating *Parameter.
PathItemKind designating *Path.
ReferenceKind designating *Refable.
RequestBodyKind designating *RequestBody.
ResponseKind designating *Response.
SchemaKind designating *Schema.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SecuritySchemeKind designating *SecurityScheme.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
AnyOrExpressions It's the Union type of any and expressions.
Callback It's the Union type of callback and Refable.
Components Holds a set of reusable objects for different aspects of the OAS.
Contact information for the exposed API.
Discriminator When request bodies or response payloads may be one of a number of different schemas, a discriminator object can be used to aid in serialization, deserialization, and validation.
Encoding A single encoding definition applied to a single schema property.
No description provided by the author
ExternalDocumentation Allows referencing an external resource for extended documentation.
Header The Header Object follows the structure of the Parameter Object with the following changes: 1.
Info The object provides metadata about the API.
License information for the exposed API.
Link The Link object represents a possible design-time link for a response.
MediaType Each Media Type Object provides schema and examples for the media type identified by its key.
OAuthFlow Configuration details for a supported OAuth Flow.
OAuthFlows Allows configuration of the supported OAuth Flows.
OpenAPI This is the root document 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.
Refable A simple object to allow referencing other components in the specification, internally and externally.
RequestBody Describes a single request body.
Response Describes a single response from an API Operation, including design-time, static links to operations based on the response.
Schema The Schema Object allows the definition of input and output data types.
SecurityScheme an API key (either as a header or as a query parameter), OAuth2's common flows (implicit, password, application and access code) as defined in RFC6749, and OpenID Connect Discovery.
Server An object representing a Server.
ServerVariable 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 A metadata object that allows for more fine-tuned XML model definitions.
# Interfaces
Entiter is forcing given struct to admit its purpose.
# Type aliases
Any is a raw encoded JSON value.
Entity reflets kind of component.
Expressions Runtime expressions allow defining values based on information that will only be available within the HTTP message in an actual API call.
Primitive data types in the OAS are based on the types supported by the JSON Schema Specification Wright Draft 00.
Paths Holds the relative paths to the individual endpoints and their operations.
SecurityRequirement Lists the required security schemes to execute this operation.