OpenAPI 3.0 की खास बातों के मुताबिक, फ़ंक्शन की जानकारी का स्ट्रक्चर्ड ब्यौरा. इस एलान में फ़ंक्शन के नाम और पैरामीटर की जानकारी भी दी गई है. यह FunctionDeclaration, कोड के ब्लॉक को दिखाता है. इसका इस्तेमाल मॉडल, टूल के तौर पर करता है और क्लाइंट इसे एक्ज़ीक्यूट करता है.
हस्ताक्षर:
export declare interface FunctionDeclaration
प्रॉपर्टी
| प्रॉपर्टी | टाइप | ब्यौरा |
|---|---|---|
| ब्यौरा | स्ट्रिंग | ज़रूरी नहीं. फ़ंक्शन का ब्यौरा और मकसद. मॉडल इसका इस्तेमाल यह तय करने के लिए करता है कि फ़ंक्शन को कैसे कॉल करना है और क्या करना है. |
| name | स्ट्रिंग | कॉल करने के लिए फ़ंक्शन का नाम. किसी अक्षर या अंडरस्कोर से शुरू होना चाहिए. a-z, A-Z, 0-9 होने चाहिए या इसमें अंडरस्कोर और डैश होने चाहिए और उनकी लंबाई ज़्यादा से ज़्यादा 64 होनी चाहिए. |
| पैरामीटर | Functiondeclaration स्कीमा | ज़रूरी नहीं. JSON स्कीमा ऑब्जेक्ट फ़ॉर्मैट में इस फ़ंक्शन के पैरामीटर के बारे में बताता है. यह Open API 3.03 पैरामीटर ऑब्जेक्ट दिखाता है. पैरामीटर के नाम केस-सेंसिटिव (बड़े और छोटे अक्षरों में अंतर) होते हैं. बिना पैरामीटर वाले फ़ंक्शन के लिए, इसे सेट नहीं किया जा सकता. |
फ़ंक्शन डिसक्लारेशन.ब्यौरा
ज़रूरी नहीं. फ़ंक्शन का ब्यौरा और मकसद. मॉडल इसका इस्तेमाल यह तय करने के लिए करता है कि फ़ंक्शन को कैसे कॉल करना है और क्या करना है.
हस्ताक्षर:
description?: string;
फ़ंक्शन डेक्लेरेशन का नाम
कॉल करने के लिए फ़ंक्शन का नाम. किसी अक्षर या अंडरस्कोर से शुरू होना चाहिए. a-z, A-Z, 0-9 होने चाहिए या इसमें अंडरस्कोर और डैश होने चाहिए और उनकी लंबाई ज़्यादा से ज़्यादा 64 होनी चाहिए.
हस्ताक्षर:
name: string;
फ़ंक्शन डिक्लेरेशन पैरामीटर
ज़रूरी नहीं. JSON स्कीमा ऑब्जेक्ट फ़ॉर्मैट में इस फ़ंक्शन के पैरामीटर के बारे में बताता है. यह Open API 3.03 पैरामीटर ऑब्जेक्ट दिखाता है. पैरामीटर के नाम केस-सेंसिटिव (बड़े और छोटे अक्षरों में अंतर) होते हैं. बिना पैरामीटर वाले फ़ंक्शन के लिए, इसे सेट नहीं किया जा सकता.
हस्ताक्षर:
parameters?: FunctionDeclarationSchema;