OperationContractProperties interface
Propriedades do contrato de operação
- Extends
Propriedades
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. |
url |
Modelo de URL relativa identificando o recurso de destino para esta operação. Pode incluir parâmetros. Exemplo: /customers/{cid}/orders/{oid}/?date={date} |
Propriedades herdadas
description | Descrição da operação. Pode incluir marcas de formatação HTML. |
policies | Políticas de operação |
request | Uma entidade que contém detalhes da solicitação. |
responses | Matriz de respostas de operação. |
template |
Coleção de parâmetros de modelo de URL. |
Detalhes da propriedade
displayName
Nome da Operação.
displayName: string
Valor da 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 da propriedade
string
urlTemplate
Modelo de URL relativa identificando o recurso de destino para esta operação. Pode incluir parâmetros. Exemplo: /customers/{cid}/orders/{oid}/?date={date}
urlTemplate: string
Valor da propriedade
string
Detalhes das propriedades herdadas
description
Descrição da operação. Pode incluir marcas de formatação HTML.
description?: string
Valor da propriedade
string
Herdado deOperationEntityBaseContract.description
policies
Políticas de operação
policies?: string
Valor da propriedade
string
Herdado deOperationEntityBaseContract.policies
request
Uma entidade que contém detalhes da solicitação.
request?: RequestContract
Valor da propriedade
Herdado deOperationEntityBaseContract.request
responses
Matriz de respostas de operação.
responses?: ResponseContract[]
Valor da propriedade
Herdado deOperationEntityBaseContract.responses
templateParameters
Coleção de parâmetros de modelo de URL.
templateParameters?: ParameterContract[]