Sdílet prostřednictvím


ApiOperationPropertiesDefinition interface

Vlastnosti operací rozhraní API

Vlastnosti

annotation

Poznámka operace rozhraní API.

api

Referenční informace k rozhraní API.

description

Popis operace rozhraní API.

inputsDefinition

Schéma definice vstupů operací.

isNotification

Určuje, jestli je operace rozhraní API oznámením nebo ne.

isWebhook

Určuje, jestli je operace rozhraní API webhook, nebo ne.

pageable

Určuje, jestli je operace rozhraní API stránkovatelná.

responsesDefinition

Schémata definice odpovědí operace.

summary

Souhrn operace rozhraní API.

trigger

Typ triggeru operace rozhraní API.

triggerHint

Tip triggeru pro operaci rozhraní API.

visibility

Viditelnost operace rozhraní API.

Podrobnosti vlastnosti

annotation

Poznámka operace rozhraní API.

annotation?: ApiOperationAnnotation

Hodnota vlastnosti

api

Referenční informace k rozhraní API.

api?: ApiReference

Hodnota vlastnosti

description

Popis operace rozhraní API.

description?: string

Hodnota vlastnosti

string

inputsDefinition

Schéma definice vstupů operací.

inputsDefinition?: SwaggerSchema

Hodnota vlastnosti

isNotification

Určuje, jestli je operace rozhraní API oznámením nebo ne.

isNotification?: boolean

Hodnota vlastnosti

boolean

isWebhook

Určuje, jestli je operace rozhraní API webhook, nebo ne.

isWebhook?: boolean

Hodnota vlastnosti

boolean

pageable

Určuje, jestli je operace rozhraní API stránkovatelná.

pageable?: boolean

Hodnota vlastnosti

boolean

responsesDefinition

Schémata definice odpovědí operace.

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

Hodnota vlastnosti

{[propertyName: string]: SwaggerSchema}

summary

Souhrn operace rozhraní API.

summary?: string

Hodnota vlastnosti

string

trigger

Typ triggeru operace rozhraní API.

trigger?: string

Hodnota vlastnosti

string

triggerHint

Tip triggeru pro operaci rozhraní API.

triggerHint?: string

Hodnota vlastnosti

string

visibility

Viditelnost operace rozhraní API.

visibility?: string

Hodnota vlastnosti

string