ApiOperationPropertiesDefinition interface
Proprietà delle operazioni api
Proprietà
| annotation | Annotazione dell'operazione api. |
| api | Informazioni di riferimento sull'API. |
| description | Descrizione dell'operazione api. |
| inputs |
Schema di definizione dell'operazione di input. |
| is |
Indica se l'operazione API è notifica o meno. |
| is |
Indica se l'operazione API è o meno webhook. |
| pageable | Indica se l'operazione api è visualizzabile in pagine. |
| responses |
Schemi di definizione delle risposte dell'operazione. |
| summary | Riepilogo dell'operazione api. |
| trigger | Tipo di trigger dell'operazione api. |
| trigger |
Hint del trigger per l'operazione api. |
| visibility | Visibilità dell'operazione api. |
Dettagli proprietà
annotation
Annotazione dell'operazione api.
annotation?: ApiOperationAnnotation
Valore della proprietà
api
description
Descrizione dell'operazione api.
description?: string
Valore della proprietà
string
inputsDefinition
Schema di definizione dell'operazione di input.
inputsDefinition?: SwaggerSchema
Valore della proprietà
isNotification
Indica se l'operazione API è notifica o meno.
isNotification?: boolean
Valore della proprietà
boolean
isWebhook
Indica se l'operazione API è o meno webhook.
isWebhook?: boolean
Valore della proprietà
boolean
pageable
Indica se l'operazione api è visualizzabile in pagine.
pageable?: boolean
Valore della proprietà
boolean
responsesDefinition
Schemi di definizione delle risposte dell'operazione.
responsesDefinition?: {[propertyName: string]: SwaggerSchema}
Valore della proprietà
{[propertyName: string]: SwaggerSchema}
summary
Riepilogo dell'operazione api.
summary?: string
Valore della proprietà
string
trigger
Tipo di trigger dell'operazione api.
trigger?: string
Valore della proprietà
string
triggerHint
Hint del trigger per l'operazione api.
triggerHint?: string
Valore della proprietà
string
visibility
Visibilità dell'operazione api.
visibility?: string
Valore della proprietà
string