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: unknown)(intrinsic) unknown
| Name | Type | Description |
|---|---|---|
| key | valueof scalar string |
Extension key. Must start with x- |
| value | (intrinsic) 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)(intrinsic) unknown
| Name | Type | Description |
|---|---|---|
| url | valueof scalar string |
Url to the docs |
| description | valueof scalar 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: TypeSpec.OpenAPI.AdditionalInfo)Namespace
| Name | Type | Description |
|---|---|---|
| additionalInfo | model TypeSpec.OpenAPI.AdditionalInfo |
Additional information |
Specify the OpenAPI operationId property for this operation.
@TypeSpec.OpenAPI.operationId(operationId: valueof string)Operation
| Name | Type | Description |
|---|---|---|
| operationId | valueof scalar string |
Operation id value. |
@operationId("download")
op read(): string;