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