Megosztás:


ApiOperationPropertiesDefinition interface

Az API-műveletek tulajdonságai

Tulajdonságok

annotation

Az API-művelet megjegyzése.

api

Az API-referencia.

description

Az API-művelet leírása.

inputsDefinition

A művelet bemeneti definíciós sémája.

isNotification

Azt jelzi, hogy az API-művelet értesítés-e vagy sem.

isWebhook

Azt jelzi, hogy az API-művelet webhook-e vagy sem.

pageable

Azt jelzi, hogy az API-művelet lapozható-e.

responsesDefinition

A műveleti válaszok definíciós sémái.

summary

Az API-művelet összegzése.

trigger

Az API-művelet eseményindító típusa.

triggerHint

Az API-művelet eseményindító tippje.

visibility

Az API-művelet láthatósága.

Tulajdonság adatai

annotation

Az API-művelet megjegyzése.

annotation?: ApiOperationAnnotation

Tulajdonság értéke

api

Az API-referencia.

api?: ApiReference

Tulajdonság értéke

description

Az API-művelet leírása.

description?: string

Tulajdonság értéke

string

inputsDefinition

A művelet bemeneti definíciós sémája.

inputsDefinition?: SwaggerSchema

Tulajdonság értéke

isNotification

Azt jelzi, hogy az API-művelet értesítés-e vagy sem.

isNotification?: boolean

Tulajdonság értéke

boolean

isWebhook

Azt jelzi, hogy az API-művelet webhook-e vagy sem.

isWebhook?: boolean

Tulajdonság értéke

boolean

pageable

Azt jelzi, hogy az API-művelet lapozható-e.

pageable?: boolean

Tulajdonság értéke

boolean

responsesDefinition

A műveleti válaszok definíciós sémái.

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

Tulajdonság értéke

{[propertyName: string]: SwaggerSchema}

summary

Az API-művelet összegzése.

summary?: string

Tulajdonság értéke

string

trigger

Az API-művelet eseményindító típusa.

trigger?: string

Tulajdonság értéke

string

triggerHint

Az API-művelet eseményindító tippje.

triggerHint?: string

Tulajdonság értéke

string

visibility

Az API-művelet láthatósága.

visibility?: string

Tulajdonság értéke

string