Data types

TypeSpec.OpenAPI

AdditionalInfo

Additional information for the OpenAPI document.

model TypeSpec.OpenAPI.AdditionalInfo

Properties

Name	Type	Description
title?	string	The title of the API. Overrides the @service title.
summary?	string	A short summary of the API. Overrides the @summary provided on the service namespace.
version?	string	The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version).
termsOfService?	url	A URL to the Terms of Service for the API. MUST be in the format of a URL.
contact?	Contact	The contact information for the exposed API.
license?	License	The license information for the exposed API.
	unknown	Additional properties

Contact

Contact information for the exposed API.

model TypeSpec.OpenAPI.Contact

Properties

Name	Type	Description
name?	string	The identifying name of the contact person/organization.
url?	url	The URL pointing to the contact information. MUST be in the format of a URL.
email?	string	The email address of the contact person/organization. MUST be in the format of an email address.
	unknown	Additional properties

ExternalDocs

External Docs information.

model TypeSpec.OpenAPI.ExternalDocs

Properties

Name	Type	Description
url	string	Documentation url
description?	string	Optional description
	unknown	Additional properties

License

License information for the exposed API.

model TypeSpec.OpenAPI.License

Properties

Name	Type	Description
name	string	The license name used for the API.
url?	url	A URL to the license used for the API. MUST be in the format of a URL.
	unknown	Additional properties

TagMetadata

Metadata to a single tag that is used by operations.

model TypeSpec.OpenAPI.TagMetadata

Properties

Name	Type	Description
description?	string	A description of the tag.
externalDocs?	ExternalDocs	External documentation information for the tag.
parent?	string	The name of a tag that this tag is nested under. Only supported in OpenAPI 3.2. For 3.0 and 3.1, this will be converted to x-parent.
summary?	string	A short summary of the tag, used for display purposes. Only supported natively in OpenAPI 3.2. For 3.0 and 3.1, this will be emitted as x-oai-summary.
kind?	string	A machine-readable string to categorize what sort of tag it is. Any string value can be used. Only supported natively in OpenAPI 3.2. For 3.0 and 3.1, this will be emitted as x-oai-kind.
	unknown	Additional properties

TagMetadataWithName

Metadata for a tag that includes the name of the tag. Used with the array form of @tagMetadata.

model TypeSpec.OpenAPI.TagMetadataWithName

Properties

Name	Type	Description
name	string	The name of the tag.
description?	string	A description of the tag.
externalDocs?	ExternalDocs	External documentation information for the tag.
parent?	string	The name of a tag that this tag is nested under. Only supported in OpenAPI 3.2. For 3.0 and 3.1, this will be converted to x-parent.
summary?	string	A short summary of the tag, used for display purposes. Only supported natively in OpenAPI 3.2. For 3.0 and 3.1, this will be emitted as x-oai-summary.
kind?	string	A machine-readable string to categorize what sort of tag it is. Any string value can be used. Only supported natively in OpenAPI 3.2. For 3.0 and 3.1, this will be emitted as x-oai-kind.
	unknown	Additional properties