Compartilhar via


ApiOperationPropertiesDefinition interface

As propriedades de operações de api

Propriedades

annotation

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

api

A referência de api.

description

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

inputsDefinition

O esquema de definição de entradas de operação.

isNotification

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

isWebhook

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

pageable

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

responsesDefinition

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

summary

O resumo da operação de api.

trigger

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

triggerHint

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

visibility

A visibilidade da operação de api.

Detalhes da propriedade

annotation

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

annotation?: ApiOperationAnnotation

Valor da propriedade

api

A referência de api.

api?: ApiReference

Valor da propriedade

description

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

description?: string

Valor da propriedade

string

inputsDefinition

O esquema de definição de entradas de operação.

inputsDefinition?: SwaggerSchema

Valor da propriedade

isNotification

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

isNotification?: boolean

Valor da propriedade

boolean

isWebhook

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

isWebhook?: boolean

Valor da propriedade

boolean

pageable

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

pageable?: boolean

Valor da propriedade

boolean

responsesDefinition

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

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

Valor da propriedade

{[propertyName: string]: SwaggerSchema}

summary

O resumo da operação de api.

summary?: string

Valor da propriedade

string

trigger

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

trigger?: string

Valor da propriedade

string

triggerHint

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

triggerHint?: string

Valor da propriedade

string

visibility

A visibilidade da operação de api.

visibility?: string

Valor da propriedade

string