v3 library
Classes
- APICallback
- A map of possible out-of band callbacks related to the parent operation.
- APIComponents
- Holds a set of reusable objects for different aspects of the OAS.
- APIContact
- Contact information for the exposed API.
- APIDocument
- This is the root document object of the OpenAPI document.
- APIEncoding
- A single encoding definition applied to a single schema property.
- APIHeader
- APIHeader follows the structure of the APIParameter with the following changes:
- APIInfo
- The object provides metadata about the API.
- APILicense
- License information for the exposed API.
- APIMediaType
- Each APIMediaType provides schema and examples for the media type identified by its key.
- APIObject
- APIOperation
- Describes a single API operation on a path.
- APIParameter
- Describes a single operation parameter.
- APIParameterLocationCodec
- APIPath
- Describes the operations available on a single path.
- APIRequestBody
- Describes a single request body.
- APIResponse
- Describes a single response from an API Operation, including design-time, static links to operations based on the response.
- APISchemaObject
- Represents a schema object in the OpenAPI specification.
- APISecurityRequirement
- Lists the required security schemes to execute an operation.
- APISecurityScheme
- Defines a security scheme that can be used by the operations.
- APISecuritySchemeOAuth2Flow
- Allows configuration of the supported OAuth Flows.
- APISecuritySchemeTypeCodec
- APIServerDescription
- An object representing a Server.
- APIServerVariable
- An object representing a Server Variable for server URL template substitution.
- APITag
- Adds metadata to a single tag that is used by the APIOperation.
- APITypeCodec
- Coding
- A base class for encodable and decodable objects.
- KeyedArchive
- A container for a dynamic data object that can be decoded into Coding objects.
- ListArchive
- A list of values in a KeyedArchive.
Enums
- APIParameterLocation
- There are four possible parameter locations specified by the in field.
- APISchemaAdditionalPropertyPolicy
- APISecuritySchemeType
- APIType