Compartir a través de


OperationUpdateContract interface

Detalles del contrato de actualización de operaciones de API.

Propiedades

description

Descripción de la operación. Puede incluir etiquetas de formato HTML.

displayName

Nombre de la operación.

method

Un método de operación HTTP válido. Métodos HTTP típicos, como GET, PUT, POST, pero no limitados solo por ellos.

policies

Directivas de operación

request

Entidad que contiene los detalles de la solicitud.

responses

Matriz de respuestas de operación.

templateParameters

Colección de parámetros de plantilla de dirección URL.

urlTemplate

Plantilla de dirección URL relativa que identifica el recurso de destino para esta operación. Puede incluir parámetros. Ejemplo: /customers/{cid}/orders/{oid}/?date={date}

Detalles de las propiedades

description

Descripción de la operación. Puede incluir etiquetas de formato HTML.

description?: string

Valor de propiedad

string

displayName

Nombre de la operación.

displayName?: string

Valor de propiedad

string

method

Un método de operación HTTP válido. Métodos HTTP típicos, como GET, PUT, POST, pero no limitados solo por ellos.

method?: string

Valor de propiedad

string

policies

Directivas de operación

policies?: string

Valor de propiedad

string

request

Entidad que contiene los detalles de la solicitud.

request?: RequestContract

Valor de propiedad

responses

Matriz de respuestas de operación.

responses?: ResponseContract[]

Valor de propiedad

templateParameters

Colección de parámetros de plantilla de dirección URL.

templateParameters?: ParameterContract[]

Valor de propiedad

urlTemplate

Plantilla de dirección URL relativa que identifica el recurso de destino para esta operación. Puede incluir parámetros. Ejemplo: /customers/{cid}/orders/{oid}/?date={date}

urlTemplate?: string

Valor de propiedad

string