Interface: ContentObject

Describes an object of multiple content types. For example:

{
  'application/json': {
    schema: {...schemaObjectSpec}
  },
  'application/text': {
    schema: {...schemaObjectSpec}
  }
}

Interface: DiscriminatorObject

Describes a discriminator object, used in SchemaObject

Properties
Name Type Description
mapping

Describes a discriminator object, used in SchemaObject
propertyName string

Describes a discriminator object, used in SchemaObject

Interface: EncodingObject

Describes an encoding object, used in ParameterObject

Interface: EncodingPropertyObject

Describes an encoding object, used in SchemaObject

Properties
Name Type Description
allowReserved

Describes an encoding object, used in SchemaObject
contentType

Describes an encoding object, used in SchemaObject
explode

Describes an encoding object, used in SchemaObject
headers

Describes an encoding object, used in SchemaObject
style

Describes an encoding object, used in SchemaObject

Interface: ExampleObject

Describes an example object, used in ParameterObject

Properties
Name Type Description
description

Describes an example object, used in ParameterObject
externalValue

Describes an example object, used in ParameterObject
summary

Describes an example object, used in ParameterObject
value ExtensionValue

Describes an example object, used in ParameterObject

Interface: ExternalDocumentationObject

Describes an external document object, used in SchemaObject

Properties
Name Type Description
description

Describes an external document object, used in SchemaObject
url string

Describes an external document object, used in SchemaObject

Interface: HeaderObject

Describes a header object, used in EncodingPropertyObject

Interface: HeadersObject

Lists the headers that can be sent as part of a response.

Interface: ISpecificationExtension

Allow key(string) value extension specifications. These value extensions cannot be used as constraints, but can be filtered for retrieval.

Interface: MapObject

Maps names to a given type of values

Interface: MediaTypeObject

Each Media Type Object provides schema and examples for the media type identified by its key. Specification: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#media-type-object

Properties
Name Type Description
encoding EncodingObject

Each Media Type Object provides schema and examples for the media type identified by its key. Specification: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#media-type-object
example

Each Media Type Object provides schema and examples for the media type identified by its key. Specification: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#media-type-object
examples

Each Media Type Object provides schema and examples for the media type identified by its key. Specification: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#media-type-object
schema

Each Media Type Object provides schema and examples for the media type identified by its key. Specification: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#media-type-object

Interface: OAS3SchemaObject

Part of OpenAPI Schema Object, The following properties are taken from the JSON Schema definition but their definitions were adjusted to the OpenAPI Specification.

Properties
Name Type Description
additionalProperties

Part of OpenAPI Schema Object, The following properties are taken from the JSON Schema definition but their definitions were adjusted to the OpenAPI Specification.
allOf

Part of OpenAPI Schema Object, The following properties are taken from the JSON Schema definition but their definitions were adjusted to the OpenAPI Specification.
anyOf

Part of OpenAPI Schema Object, The following properties are taken from the JSON Schema definition but their definitions were adjusted to the OpenAPI Specification.
default ExtensionValue

Part of OpenAPI Schema Object, The following properties are taken from the JSON Schema definition but their definitions were adjusted to the OpenAPI Specification.
deprecated

Part of OpenAPI Schema Object, The following properties are taken from the JSON Schema definition but their definitions were adjusted to the OpenAPI Specification.
description

Part of OpenAPI Schema Object, The following properties are taken from the JSON Schema definition but their definitions were adjusted to the OpenAPI Specification.
discriminator DiscriminatorObject

Part of OpenAPI Schema Object, The following properties are taken from the JSON Schema definition but their definitions were adjusted to the OpenAPI Specification.
example ExtensionValue

Part of OpenAPI Schema Object, The following properties are taken from the JSON Schema definition but their definitions were adjusted to the OpenAPI Specification.
examples

Part of OpenAPI Schema Object, The following properties are taken from the JSON Schema definition but their definitions were adjusted to the OpenAPI Specification.
externalDocs ExternalDocumentationObject

Part of OpenAPI Schema Object, The following properties are taken from the JSON Schema definition but their definitions were adjusted to the OpenAPI Specification.
format

Part of OpenAPI Schema Object, The following properties are taken from the JSON Schema definition but their definitions were adjusted to the OpenAPI Specification.
items

Part of OpenAPI Schema Object, The following properties are taken from the JSON Schema definition but their definitions were adjusted to the OpenAPI Specification.
not

Part of OpenAPI Schema Object, The following properties are taken from the JSON Schema definition but their definitions were adjusted to the OpenAPI Specification.
nullable

Part of OpenAPI Schema Object, The following properties are taken from the JSON Schema definition but their definitions were adjusted to the OpenAPI Specification.
oneOf

Part of OpenAPI Schema Object, The following properties are taken from the JSON Schema definition but their definitions were adjusted to the OpenAPI Specification.
properties

Part of OpenAPI Schema Object, The following properties are taken from the JSON Schema definition but their definitions were adjusted to the OpenAPI Specification.
readOnly

Part of OpenAPI Schema Object, The following properties are taken from the JSON Schema definition but their definitions were adjusted to the OpenAPI Specification.
type

Part of OpenAPI Schema Object, The following properties are taken from the JSON Schema definition but their definitions were adjusted to the OpenAPI Specification.
writeOnly

Part of OpenAPI Schema Object, The following properties are taken from the JSON Schema definition but their definitions were adjusted to the OpenAPI Specification.
xml XMLObject

Part of OpenAPI Schema Object, The following properties are taken from the JSON Schema definition but their definitions were adjusted to the OpenAPI Specification.

Interface: ParameterObject

Describes a single operation parameter. A unique parameter is defined by a combination of a name and location. Specification https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameter-object

Properties
Name Type Description
allowEmptyValue

Describes a single operation parameter. A unique parameter is defined by a combination of a name and location. Specification https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameter-object
allowReserved

Describes a single operation parameter. A unique parameter is defined by a combination of a name and location. Specification https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameter-object
content ContentObject

Describes a single operation parameter. A unique parameter is defined by a combination of a name and location. Specification https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameter-object
deprecated

Describes a single operation parameter. A unique parameter is defined by a combination of a name and location. Specification https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameter-object
description

Describes a single operation parameter. A unique parameter is defined by a combination of a name and location. Specification https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameter-object
example ExtensionValue

Describes a single operation parameter. A unique parameter is defined by a combination of a name and location. Specification https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameter-object
examples

Describes a single operation parameter. A unique parameter is defined by a combination of a name and location. Specification https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameter-object
explode

Describes a single operation parameter. A unique parameter is defined by a combination of a name and location. Specification https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameter-object
in ParameterLocation

Describes a single operation parameter. A unique parameter is defined by a combination of a name and location. Specification https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameter-object
name string

Describes a single operation parameter. A unique parameter is defined by a combination of a name and location. Specification https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameter-object
required

Describes a single operation parameter. A unique parameter is defined by a combination of a name and location. Specification https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameter-object
schema

Describes a single operation parameter. A unique parameter is defined by a combination of a name and location. Specification https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameter-object
style ParameterStyle

Describes a single operation parameter. A unique parameter is defined by a combination of a name and location. Specification https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameter-object

Interface: ParametersDefinitionsObject

An object to hold parameters to be reused across operations. Parameter definitions can be referenced to the ones defined here.

This does not define global operation parameters.

Interface: PathsObject

Holds the relative paths to the individual endpoints. The path is appended to the basePath in order to construct the full URL. The Paths may be empty, due to ACL constraints. Specification: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#paths-object

Interface: ReferenceObject

Properties
Name Type Description
$ref string

Interface: RequestBodyObject

Describes a single request body. Specification: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#request-body-object

Properties
Name Type Description
content ContentObject

Describes a single request body. Specification: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#request-body-object
description

Describes a single request body. Specification: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#request-body-object
required

Describes a single request body. Specification: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#request-body-object

Interface: ResponsesDefinitionsObject

An object to hold responses to be reused across operations. Response definitions can be referenced to the ones defined here.

This does not define global operation responses.

Interface: ResponsesObject

A container for the expected responses of an operation. The container maps a HTTP response code to the expected response. It is not expected from the documentation to necessarily cover all possible HTTP response codes, since they may not be known in advance. However, it is expected from the documentation to cover a successful operation response and any known errors. The default can be used as the default response object for all HTTP codes that are not covered individually by the specification. The ResponsesObject MUST contain at least one response code, and it SHOULD be the response for a successful operation call. Specification: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#responsesObject

Properties
Name Type Description
default

The documentation of responses other than the ones declared for specific HTTP response codes. It can be used to cover undeclared responses. Reference Object can be used to link to a response that is defined at the Swagger Object's responses section.

Interface: SchemaObject

The Schema Object allows the definition of input and output data types. the properties consist of two parts:

  • taken directly from the JSON Schema, is described by interface JSONType
  • taken from the JSON Schema, but definitions were adjusted to the OpenAPI Specification, is described by interface OAS3SchemaObject

Interface: SchemasObject

Schemas Object in components

Interface: ScopesObject

Lists the available scopes for an OAuth2 security scheme.

Interface: SecurityDefinitionsObject

A declaration of the security schemes available to be used in the specification. This does not enforce the security schemes on the operations and only serves to provide the relevant details for each scheme.

Interface: XMLObject

Describes an XML object, used in SchemaObject

Properties
Name Type Description
attribute

Describes an XML object, used in SchemaObject
name

Describes an XML object, used in SchemaObject
namespace

Describes an XML object, used in SchemaObject
prefix

Describes an XML object, used in SchemaObject
wrapped

Describes an XML object, used in SchemaObject

Type alias: ExtensionValue = any

Type alias: OpenApiSpec = OpenAPIObject

Function: createEmptyApiSpec

createEmptyApiSpec() : OpenApiSpec

Create an empty OpenApiSpec object that's still a valid openapi document.

Function: isReferenceObject

isReferenceObject(obj: ExtensionValue) : boolean

Arguments
Name Type Description
obj ExtensionValue

Function: isSchemaObject

isSchemaObject(schema: undefined) : boolean

Type guard for OpenAPI 3.0.0 schema object

Arguments
Name Type Description
schema

An OpenAPI 3.0.0 schema object