TypeSpec library providing OpenAPI concepts
npm install @typespec/openapiSpecify 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;Attach 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;Specify 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[];Specify OpenAPI additional information.
The service title and version are already specified using @service.
@TypeSpec.OpenAPI.info(additionalInfo: valueof TypeSpec.OpenAPI.AdditionalInfo)Namespace
| Name | Type | Description |
|---|---|---|
| additionalInfo | valueof AdditionalInfo |
Additional information |
Specify 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;Specify OpenAPI additional information.
@TypeSpec.OpenAPI.tagMetadata(name: valueof string, tagMetadata: valueof TypeSpec.OpenAPI.TagMetadata)Namespace
| Name | Type | Description |
|---|---|---|
| name | valueof string |
tag name |
| tagMetadata | valueof TagMetadata |
Additional information |
@service
@tagMetadata(
"Tag Name",
#{
description: "Tag description",
externalDocs: #{ url: "https://example.com", description: "More info.", `x-custom`: "string" },
`x-custom`: "string",
}
)
namespace PetStore {
}