تمثيل منظَّم لبيان دالة على النحو المحدّد في مواصفات OpenAPI 3.0. يتضمّن هذا البيان اسم الدالة والمَعلمات. يمثّل FunctionDeclaration هذا مجموعة من الرموز التي يمكن أن يستخدمها النموذج وينفّذها العميل كأداة.
Signature:
export declare interface FunctionDeclaration
أماكن إقامة
| الموقع | النوع | الوصف |
|---|---|---|
| description | السلسلة | هذه السمة اختيارية. وصف الدالة والغرض منها. يستخدمه النموذج لتحديد كيفية استدعاء الدالة وما إذا كان سيتم استدعاءها أم لا. |
| name | السلسلة | اسم الدالة المطلوب استدعاءها. يجب أن يبدأ بحرف أو شرطة سفلية. يجب أن يكون النص a-z أو A-Z أو 0-9 أو يحتوي على شرطات سفلية وشرطات، ولا يزيد طولها عن 64 حرفًا. |
| المَعلمات | FunctionDeclarationSchema | هذه السمة اختيارية. تصف المعلَمات الخاصة بهذه الدالة بتنسيق JSON Schema Object. يعكس كائن المعلَمة Open API 3.03. أسماء المَعلمات حسّاسة لحالة الأحرف. بالنسبة إلى الدالة التي لا تحتوي على معلَمات، يمكن ترك هذا الإعداد بدون ضبط. |
FunctionDeclaration.description
هذه السمة اختيارية. وصف الدالة والغرض منها. يستخدمه النموذج لتحديد كيفية استدعاء الدالة وما إذا كان سيتم استدعاءها أم لا.
Signature:
description?: string;
FunctionDeclaration.name
اسم الدالة المطلوب استدعاءها. يجب أن يبدأ بحرف أو شرطة سفلية. يجب أن يكون النص a-z أو A-Z أو 0-9 أو يحتوي على شرطات سفلية وشرطات، ولا يزيد طولها عن 64 حرفًا.
Signature:
name: string;
FunctionDeclaration.parameters
هذه السمة اختيارية. تصف المعلَمات الخاصة بهذه الدالة بتنسيق JSON Schema Object. يعكس كائن المعلَمة Open API 3.03. أسماء المَعلمات حسّاسة لحالة الأحرف. بالنسبة إلى الدالة التي لا تحتوي على معلَمات، يمكن ترك هذا الإعداد بدون ضبط.
Signature:
parameters?: FunctionDeclarationSchema;