Partilhar via


ApiOperationPropertiesDefinition interface

As propriedades das operações de api

Propriedades

annotation

A anotação da operação api.

api

A referência api.

description

A descrição da operação api.

inputsDefinition

A operação insere o esquema de definição.

isNotification

Indica se a operação da API é notificação ou não.

isWebhook

Indica se a operação da API é webhook ou não.

pageable

Indica se a operação api é paginável.

responsesDefinition

Os esquemas de definição de respostas de operação.

summary

O resumo da operação api.

trigger

O tipo de gatilho da operação de api.

triggerHint

A dica de gatilho para a operação api.

visibility

A visibilidade da operação api.

Detalhes de Propriedade

annotation

A anotação da operação api.

annotation?: ApiOperationAnnotation

Valor de Propriedade

api

A referência api.

api?: ApiReference

Valor de Propriedade

description

A descrição da operação api.

description?: string

Valor de Propriedade

string

inputsDefinition

A operação insere o esquema de definição.

inputsDefinition?: SwaggerSchema

Valor de Propriedade

isNotification

Indica se a operação da API é notificação ou não.

isNotification?: boolean

Valor de Propriedade

boolean

isWebhook

Indica se a operação da API é webhook ou não.

isWebhook?: boolean

Valor de Propriedade

boolean

pageable

Indica se a operação api é paginável.

pageable?: boolean

Valor de Propriedade

boolean

responsesDefinition

Os esquemas de definição de respostas de operação.

responsesDefinition?: {[propertyName: string]: SwaggerSchema}

Valor de Propriedade

{[propertyName: string]: SwaggerSchema}

summary

O resumo da operação api.

summary?: string

Valor de Propriedade

string

trigger

O tipo de gatilho da operação de api.

trigger?: string

Valor de Propriedade

string

triggerHint

A dica de gatilho para a operação api.

triggerHint?: string

Valor de Propriedade

string

visibility

A visibilidade da operação api.

visibility?: string

Valor de Propriedade

string