ApiOperationPropertiesDefinition interface
Die Api-Operationen-Eigenschaften
Eigenschaften
| annotation | Die Anmerkung des API-Vorgangs. |
| api | Die API-Referenz. |
| description | Die Beschreibung des API-Vorgangs. |
| inputs |
Das Definitionsschema für Vorgangseingaben. |
| is |
Gibt an, ob der API-Vorgang eine Benachrichtigung ist oder nicht. |
| is |
Gibt an, ob der API-Vorgang Webhook ist oder nicht. |
| pageable | Gibt an, ob der API-Vorgang seitenfähig ist. |
| responses |
Die Definitionsschemas der Vorgangsantworten. |
| summary | Die Zusammenfassung des API-Vorgangs. |
| trigger | Der Triggertyp des API-Vorgangs. |
| trigger |
Der Triggerhinweis für den API-Vorgang. |
| visibility | Die Sichtbarkeit des API-Vorgangs. |
Details zur Eigenschaft
annotation
Die Anmerkung des API-Vorgangs.
annotation?: ApiOperationAnnotation
Eigenschaftswert
api
description
Die Beschreibung des API-Vorgangs.
description?: string
Eigenschaftswert
string
inputsDefinition
Das Definitionsschema für Vorgangseingaben.
inputsDefinition?: SwaggerSchema
Eigenschaftswert
isNotification
Gibt an, ob der API-Vorgang eine Benachrichtigung ist oder nicht.
isNotification?: boolean
Eigenschaftswert
boolean
isWebhook
Gibt an, ob der API-Vorgang Webhook ist oder nicht.
isWebhook?: boolean
Eigenschaftswert
boolean
pageable
Gibt an, ob der API-Vorgang seitenfähig ist.
pageable?: boolean
Eigenschaftswert
boolean
responsesDefinition
Die Definitionsschemas der Vorgangsantworten.
responsesDefinition?: {[propertyName: string]: SwaggerSchema}
Eigenschaftswert
{[propertyName: string]: SwaggerSchema}
summary
Die Zusammenfassung des API-Vorgangs.
summary?: string
Eigenschaftswert
string
trigger
Der Triggertyp des API-Vorgangs.
trigger?: string
Eigenschaftswert
string
triggerHint
Der Triggerhinweis für den API-Vorgang.
triggerHint?: string
Eigenschaftswert
string
visibility
Die Sichtbarkeit des API-Vorgangs.
visibility?: string
Eigenschaftswert
string