Data types

TypeSpec.OpenAPI

Additional information for the OpenAPI document.

model TypeSpec.OpenAPI.AdditionalInfo

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.

Contact information for the exposed API.

model TypeSpec.OpenAPI.Contact

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.

External Docs information.

model TypeSpec.OpenAPI.ExternalDocs

License information for the exposed API.

model TypeSpec.OpenAPI.License

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.

Metadata to a single tag that is used by operations.

model TypeSpec.OpenAPI.TagMetadata

Name	Type	Description
description?	`string`	A description of the API.
externalDocs?	`ExternalDocs`	An external Docs information of the API.
	`unknown`	Additional properties