Aracılığıyla paylaş


ApiOperationPropertiesDefinition interface

API işlemleri özellikleri

Özellikler

annotation

Api işleminin ek açıklaması.

api

API başvurusu.

description

Api işleminin açıklaması.

inputsDefinition

İşlem, tanım şemasını girdi.

isNotification

API işleminin bildirim olup olmadığını gösterir.

isWebhook

API işleminin web kancası olup olmadığını gösterir.

pageable

API işleminin sayfalanabilir olup olmadığını gösterir.

responsesDefinition

İşlem tanım şemalarını yanıtlar.

summary

API işleminin özeti.

trigger

Api işleminin tetikleyici türü.

triggerHint

Api işlemi için tetikleyici ipucu.

visibility

API işleminin görünürlüğü.

Özellik Ayrıntıları

annotation

Api işleminin ek açıklaması.

annotation?: ApiOperationAnnotation

Özellik Değeri

api

API başvurusu.

api?: ApiReference

Özellik Değeri

description

Api işleminin açıklaması.

description?: string

Özellik Değeri

string

inputsDefinition

İşlem, tanım şemasını girdi.

inputsDefinition?: SwaggerSchema

Özellik Değeri

isNotification

API işleminin bildirim olup olmadığını gösterir.

isNotification?: boolean

Özellik Değeri

boolean

isWebhook

API işleminin web kancası olup olmadığını gösterir.

isWebhook?: boolean

Özellik Değeri

boolean

pageable

API işleminin sayfalanabilir olup olmadığını gösterir.

pageable?: boolean

Özellik Değeri

boolean

responsesDefinition

İşlem tanım şemalarını yanıtlar.

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

Özellik Değeri

{[propertyName: string]: SwaggerSchema}

summary

API işleminin özeti.

summary?: string

Özellik Değeri

string

trigger

Api işleminin tetikleyici türü.

trigger?: string

Özellik Değeri

string

triggerHint

Api işlemi için tetikleyici ipucu.

triggerHint?: string

Özellik Değeri

string

visibility

API işleminin görünürlüğü.

visibility?: string

Özellik Değeri

string