मुख्य कंटेंट तक स्किप करें

उपलब्ध कराए गए ऑपरेशन

स्पेसिफिकेशन का हर ऑपरेशन सार्वजनिक नहीं होना चाहिए। प्रशासनिक एंडपॉइंट, आंतरिक टूल और अधूरे ऑपरेशन अक्सर दस्तावेज़ में रखने होते हैं, लेकिन प्रकाशित दस्तावेज़ और MCP में नहीं दिखाने होते। उपलब्धता का कॉन्फ़िगरेशन मूल दस्तावेज़ बदले बिना यह चुनाव स्पष्ट करता है।

यह कैसे काम करता है​

उपलब्धता का कॉन्फ़िगरेशन स्पेसिफिकेशन से अलग सहेजा जाता है। हर प्रविष्टि एक ऑपरेशन का संदर्भ और उसकी चालू या बंद स्थिति रखती है:

  • मौजूद होने पर ऑपरेशन के operationId को प्राथमिकता दी जाती है;
  • सत्यापन और ऑपरेशन ID के बिना वाले स्पेसिफिकेशन के लिए method तथा path भी सहेजे जाते हैं।

मूल दस्तावेज़ नहीं बदलता। स्पेसिफिकेशन और चालू ऑपरेशन के चयन को मिलाकर दस्तावेज़ तथा MCP तैयार होते हैं। किसी ऑपरेशन को बंद करने से वह प्रकाशित इंटरफ़ेस से हट जाता है, आपकी फ़ाइल से नहीं।

ऑपरेशन चुनने का कार्यक्षेत्र​

यह इंटरफ़ेस बड़े स्पेसिफिकेशन सँभालने के लिए भी बनाया गया है:

  • खोज — मेथड, पाथ, सारांश या टैग से फ़िल्टर करें;
  • टैग के अनुसार समूह — मुख्य टैग के आधार पर समूह बनते हैं; बिना टैग वाले ऑपरेशन अलग समूह में आते हैं;
  • अलग-अलग चालू या बंद करें — एक ऑपरेशन की स्थिति बदलें;
  • पूरे समूह पर कार्रवाई — टैग समूह के सभी ऑपरेशन एक साथ चालू या बंद करें;
  • फ़िल्टर किए गए सभी परिणाम चुनें — मुख्य चेकबॉक्स वर्तमान खोज से मेल खाने वाले ऑपरेशन पर लागू होता है।

हर ऑपरेशन एक ही पंक्ति में दिखता है, इसलिए कई टैग होने पर भी उसकी स्थिति स्पष्ट रहती है।

शुरुआत का एक व्यावहारिक तरीका​

सभी ऑपरेशन चालू करके शुरू कर सकते हैं, फिर जिन्हें सार्वजनिक नहीं करना है उन्हें बंद कर दें:

  • आंतरिक और प्रशासनिक एंडपॉइंट, जैसे उपयोगकर्ता प्रबंधन या आंतरिक स्वास्थ्य जाँच;
  • वे ऑपरेशन जिनका डिज़ाइन अभी चल रहा है;
  • केवल स्थानीय डीबगिंग के लिए बनाए गए एंडपॉइंट।

चयन दस्तावेज़ से अलग है, इसलिए API बदलने पर स्पेसिफिकेशन संपादित किए बिना चयन बदल सकते हैं।

प्रकाशन से इसका संबंध​

यह चयन तय करता है कि कौन-से ऑपरेशन दिखेंगे। दूसरे नियंत्रण तय करते हैं कि दस्तावेज़ तक पहुँचना संभव है या नहीं:

  • दस्तावेज़ की स्थिति ACTIVE होनी चाहिए;
  • दस्तावेज़ और MCP की अलग चालू/बंद सेटिंग होती है;
  • दस्तावेज़ के लिए देखने का पासवर्ड या MCP के लिए ऐक्सेस कुंजी आवश्यक हो सकती है।

सभी शर्तों के लिए ऐक्सेस नियंत्रण देखें।

प्लान की सीमाएँ​

हर प्लान उपलब्ध कराए जा सकने वाले ऑपरेशन की संख्या सीमित करता है:

  • Free — अधिकतम 10;
  • Pro — अधिकतम 1,000;
  • Team — अधिकतम 10,000।

संबंधित: ऐक्सेस नियंत्रण, दस्तावेज़ और संस्करण।