package
TypeSpec library providing OpenAPI concepts
npm install @typespec/openapiGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
Estimated unpacked size across 1 packages.
96.9 kB
Includes dependencies.
Latest published Nov 11, 2026
next
latest
microsoft1es
npmjs@microsoft.com
TypeSpec library providing OpenAPI concepts
npm install @typespec/openapi@defaultResponseSpecify that this model is to be treated as the OpenAPI default response.
This differs from the compiler built-in @error decorator as this does not necessarily represent an error.
@TypeSpec.OpenAPI.defaultResponseModel
None
@defaultResponse
model PetStoreResponse is object;
op listPets(): Pet[] | PetStoreResponse;@extensionAttach some custom data to the OpenAPI element generated from this type.
@TypeSpec.OpenAPI.extension(key: valueof string, value: valueof unknown)unknown
| Name | Type | Description |
|---|---|---|
| key | valueof string | Extension key. |
| value | valueof unknown | Extension value. |
@extension("x-custom", "My value")
@extension("x-pageable", #{ nextLink: "x-next-link" })
op read(): string;@externalDocsSpecify the OpenAPI externalDocs property for this type.
@TypeSpec.OpenAPI.externalDocs(url: valueof string, description?: valueof string)unknown
| Name | Type | Description |
|---|---|---|
| url | valueof string | Url to the docs |
| description | valueof string | Description of the docs |
@externalDocs(
"https://example.com/detailed.md",
"Detailed information on how to use this operation"
)
op listPets(): Pet[];@infoSpecify OpenAPI additional information.
The service title is already specified using @service.
@TypeSpec.OpenAPI.info(additionalInfo: valueof TypeSpec.OpenAPI.AdditionalInfo)Namespace
| Name | Type | Description |
|---|---|---|
| additionalInfo | valueof AdditionalInfo | Additional information |
@operationIdSpecify the OpenAPI operationId property for this operation.
@TypeSpec.OpenAPI.operationId(operationId: valueof string)Operation
| Name | Type | Description |
|---|---|---|
| operationId | valueof string | Operation id value. |
@operationId("download")
op read(): string;@tagMetadataSpecify OpenAPI tag metadata. Can be used in two forms:
@TypeSpec.OpenAPI.tagMetadata(name: valueof string | TypeSpec.OpenAPI.TagMetadataWithName[], tagMetadata?: valueof TypeSpec.OpenAPI.TagMetadata)Namespace
| Name | Type | Description |
|---|---|---|
| name | valueof string | TypeSpec.OpenAPI.TagMetadataWithName[] | Tag name (inline form) or array of tags with metadata (array form). |
| tagMetadata | valueof TagMetadata | Additional information for the tag. Only used in inline form. |
@service
@tagMetadata(
"Tag Name",
#{
description: "Tag description",
externalDocs: #{ url: "https://example.com", description: "More info.", `x-custom`: "string" },
`x-custom`: "string",
}
)
@tagMetadata("Child Tag", #{ description: "Child tag description", parent: "Tag Name" })
namespace PetStore {
}@service
@tagMetadata(#[
#{ name: "First Tag", description: "First tag description" },
#{ name: "Second Tag", description: "Second tag description" }
])
namespace PetStore {
}