SchemaContract interface
Detalhes do Contrato de Esquema de API.
- Extends
Propriedades
components | Definições de tipos. Usado apenas para esquemas swagger/OpenAPI v2/v3, caso contrário, nulo. |
content |
Deve ser um tipo de mídia válido usado em um cabeçalho Tipo de Conteúdo, conforme definido no RFC 2616. Tipo de mídia do documento de esquema (por exemplo, application/json, application/xml).
|
definitions | Definições de tipos. Usado apenas para esquemas swagger/OpenAPI v1, caso contrário, nulo. |
value | Json escapou da cadeia de caracteres definindo o documento que representa o Esquema. Usado para esquemas diferentes de Swagger/OpenAPI. |
Propriedades herdadas
id | ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor. |
name | O nome do recurso OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor. |
type | Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor. |
Detalhes da propriedade
components
Definições de tipos. Usado apenas para esquemas swagger/OpenAPI v2/v3, caso contrário, nulo.
components?: Record<string, unknown>
Valor da propriedade
Record<string, unknown>
contentType
Deve ser um tipo de mídia válido usado em um cabeçalho Tipo de Conteúdo, conforme definido no RFC 2616. Tipo de mídia do documento de esquema (por exemplo, application/json, application/xml).
-
Swagger
Uso de esquema application/vnd.ms-azure-apim.swagger.definitions+json
WSDL
-
Use oOpenApi
- application/vnd.ms-azure-apim.xsd+xml
esquema Use o uso application/vnd.oai.openapi.components+json
- WADL Schema
application/vnd.ms-azure-apim.wadl.grammars+xml
do esquema .
contentType?: string
Valor da propriedade
string
definitions
Definições de tipos. Usado apenas para esquemas swagger/OpenAPI v1, caso contrário, nulo.
definitions?: Record<string, unknown>
Valor da propriedade
Record<string, unknown>
value
Json escapou da cadeia de caracteres definindo o documento que representa o Esquema. Usado para esquemas diferentes de Swagger/OpenAPI.
value?: string
Valor da propriedade
string
Detalhes das propriedades herdadas
id
ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
id?: string
Valor da propriedade
string
Herdado deProxyResource.id
name
O nome do recurso OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
name?: string
Valor da propriedade
string
Herdado deProxyResource.name
type
Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
type?: string
Valor da propriedade
string
Herdado deProxyResource.type