open_api_v3 library

Classes

ApiKeySecuritySchemeV3
API key security scheme representing an API key authentication scheme.
AuthorizationCodeOAuthFlowV3
Authorization code OAuth flow representing the authorization code OAuth2 flow.
ClientCredentialsOAuthFlowV3
Client credentials OAuth flow representing the client credentials OAuth2 flow.
ComponentsObjectV3
Components object to hold reusable components for the OpenAPI document.
DiscriminatorObjectV3
Discriminator object to aid in serialization, deserialization, and validation.
DocumentV3
OpenAPI document representing the root document of the OpenAPI specification.
EncodingObjectV3
Encoding object representing encoding information for a media type.
ExampleObjectV3
Example object representing an example in a media type or parameter.
ExternalDocumentationObjectV3
External documentation object representing additional external documentation.
HeaderObjectV3
Header object representing a header in a response.
HttpSecuritySchemeV3
HTTP security scheme representing an HTTP authentication scheme.
ImplicitOAuthFlowV3
Implicit OAuth flow representing the implicit OAuth2 flow.
LinkObjectV3
Link object representing a link in a response.
MediaTypeObjectV3
Media type object representing a media type in a request or response.
OAuth2SecuritySchemeV3
OAuth2 security scheme representing an OAuth2 authentication scheme.
OAuthFlowObjectV3
OAuth flow object representing an OAuth2 flow.
OpenIdSecuritySchemeV3
OpenID Connect security scheme representing an OpenID Connect authentication scheme.
OperationObjectV3
Operation object representing an operation in a path.
ParameterBaseObjectV3
Media type object representing a media type in a content object.
ParameterObjectV3
Parameter object representing a parameter in an operation.
PasswordOAuthFlowV3
Password OAuth flow representing the password OAuth2 flow.
PathItemObjectV3
Path item object representing a path in the OpenAPI document.
RequestBodyV3
Request body object representing a request body in an operation.
ResponseObjectV3
Response object representing a response in an operation.
ResponsesV3<T>
Responses object representing the responses of an operation.
SchemaObjectV3<E extends Object>
Schema object representing a schema in the OpenAPI specification.
SecurityRequirementsV3
Security requirements object representing security requirements for an operation.
SecuritySchemeObjectV3
Security scheme object representing a security scheme in the OpenAPI document.
ServerObjectV3
Server object representing a server.
ServerVariableObjectV3
Server variable object representing a server variable for server URL template substitution.
TagObjectV3
Tag object representing a tag in the OpenAPI document.
XMLObjectV3
XML object to represent XML metadata for a schema.