OperationUpdateContract interface
Detalhes do Contrato de Atualização da Operação de API.
Propriedades
description | Descrição da operação. Pode incluir etiquetas de formatação HTML. |
display |
Nome da Operação. |
method | Um Método de Operação HTTP Válido. Métodos Http típicos, como GET, PUT, POST, mas não limitados apenas por eles. |
policies | Políticas de Operação |
request | Uma entidade que contém os detalhes do pedido. |
responses | Matriz de Respostas da operação. |
template |
Coleção de parâmetros de modelo de URL. |
url |
Modelo de URL relativo que identifica o recurso de destino para esta operação. Pode incluir parâmetros. Exemplo: /customers/{cid}/orders/{oid}/?date={date} |
Detalhes de Propriedade
description
Descrição da operação. Pode incluir etiquetas de formatação HTML.
description?: string
Valor de Propriedade
string
displayName
Nome da Operação.
displayName?: string
Valor de Propriedade
string
method
Um Método de Operação HTTP Válido. Métodos Http típicos, como GET, PUT, POST, mas não limitados apenas por eles.
method?: string
Valor de Propriedade
string
policies
Políticas de Operação
policies?: string
Valor de Propriedade
string
request
Uma entidade que contém os detalhes do pedido.
request?: RequestContract
Valor de Propriedade
responses
Matriz de Respostas da operação.
responses?: ResponseContract[]
Valor de Propriedade
templateParameters
Coleção de parâmetros de modelo de URL.
templateParameters?: ParameterContract[]
Valor de Propriedade
urlTemplate
Modelo de URL relativo que identifica o recurso de destino para esta operação. Pode incluir parâmetros. Exemplo: /customers/{cid}/orders/{oid}/?date={date}
urlTemplate?: string
Valor de Propriedade
string