مشاركة عبر


ApiOperationPropertiesDefinition interface

خصائص عمليات واجهة برمجة التطبيقات

الخصائص

annotation

التعليق التوضيحي لعملية api.

api

مرجع واجهة برمجة التطبيقات.

description

وصف عملية واجهة برمجة التطبيقات.

inputsDefinition

مخطط تعريف إدخالات العملية.

isNotification

يشير إلى ما إذا كانت عملية واجهة برمجة التطبيقات إعلام أم لا.

isWebhook

يشير إلى ما إذا كانت عملية API إخطار على الويب أم لا.

pageable

يشير إلى ما إذا كانت عملية واجهة برمجة التطبيقات قابلة للصفحة.

responsesDefinition

مخططات تعريف استجابات العملية.

summary

ملخص عملية واجهة برمجة التطبيقات.

trigger

نوع المشغل لعملية واجهة برمجة التطبيقات.

triggerHint

تلميح المشغل لعملية واجهة برمجة التطبيقات.

visibility

رؤية عملية واجهة برمجة التطبيقات.

تفاصيل الخاصية

annotation

التعليق التوضيحي لعملية api.

annotation?: ApiOperationAnnotation

قيمة الخاصية

api

مرجع واجهة برمجة التطبيقات.

api?: ApiReference

قيمة الخاصية

description

وصف عملية واجهة برمجة التطبيقات.

description?: string

قيمة الخاصية

string

inputsDefinition

مخطط تعريف إدخالات العملية.

inputsDefinition?: SwaggerSchema

قيمة الخاصية

isNotification

يشير إلى ما إذا كانت عملية واجهة برمجة التطبيقات إعلام أم لا.

isNotification?: boolean

قيمة الخاصية

boolean

isWebhook

يشير إلى ما إذا كانت عملية API إخطار على الويب أم لا.

isWebhook?: boolean

قيمة الخاصية

boolean

pageable

يشير إلى ما إذا كانت عملية واجهة برمجة التطبيقات قابلة للصفحة.

pageable?: boolean

قيمة الخاصية

boolean

responsesDefinition

مخططات تعريف استجابات العملية.

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

قيمة الخاصية

{[propertyName: string]: SwaggerSchema}

summary

ملخص عملية واجهة برمجة التطبيقات.

summary?: string

قيمة الخاصية

string

trigger

نوع المشغل لعملية واجهة برمجة التطبيقات.

trigger?: string

قيمة الخاصية

string

triggerHint

تلميح المشغل لعملية واجهة برمجة التطبيقات.

triggerHint?: string

قيمة الخاصية

string

visibility

رؤية عملية واجهة برمجة التطبيقات.

visibility?: string

قيمة الخاصية

string