Api-blueprint: समूह के अंदर एक से अधिक अनुभाग सेट करना

@ स्पार्क-एफटीडब्ल्यू दुर्भाग्य से पहला शीर्षक Authentication केवल Print संसाधन समूह के विवरण से जुड़ा है। विवरण सीधे संसाधन शीर्षक के नीचे दिखाया गया है और फिर सभी संसाधन नीचे सूचीबद्ध हैं।

मैं अलग-अलग संसाधन समूहों को इस प्रकार समूहित करने के लिए इसे थोड़ा सा पुन: सक्रिय करने का सुझाव दूंगा:

• प्रमाणीकरण समूह
  
  
  
  • उपयोगकर्ता संसाधन संग्रह
  
  
  • सभी उपयोगकर्ताओं की सूची बनाएं
  
  
  • नया उपयोगकर्ता खाता पंजीकृत करें
  
  
• प्रिंट समूह
  
  
  
  • ...
  
  

जैसा कि आप संलग्न छवि में देख सकते हैं, मेरे पास पहले से ही एक समूह है - यह "प्रिंट समूह" है और "प्रमाणीकरण" और "प्रिंट दस्तावेज़" "प्रिंट समूह" के बच्चे हैं, इसलिए आपका समाधान मेरे लिए काम नहीं करता है। क्या आपके पास एक और विचार है?

धन्यवाद

@ स्पार्क- एफटीडब्ल्यू @kylef का क्या मतलब है सही है। संसाधन समूह ( Group Print ) के अंदर आपके पास यादृच्छिक मार्कडाउन विवरण नहीं हो सकता है एक बार जब आप पहले से ही एक संसाधन ( User Collection ) का वर्णन कर चुके होते हैं।

आप ऐसा कुछ कर सकते हैं। (जो कि @kylef ने प्रस्तावित किया है)।

# Group Authentication

## Authentication
Resource related to user auth

## User collection [/users]

### List all users [GET]
+ Response 200 (application/json)

            {}

### Register new user account [POST]
+ Request (application/json)

            {}

+ Response 201

            {}

# Group Print

## Print docs
Resource related to prints

## Print collection [/print]

### List all users [GET]
+ Response 200 (application/json)

            {}

### Register new user account [POST]
+ Request (application/json)

            {}

+ Response 201

            {}

संपादित करें : एक छोटी सी त्रुटि को ठीक करने के बाद टिप्पणी को अपडेट किया।

यह मेरी मदद नहीं करता है, क्योंकि मुझे प्रत्येक अनुभाग के अंदर कई अनुभागों की आवश्यकता है जैसे:

• प्रिंट अनुभाग

-- प्रामाणिक समूह

--- उपयोगकर्ता संग्रह

--- प्रामाणिक संग्रह

-- डॉक्स समूह

--- प्रिंट डॉक्स संग्रह

--- दस्तावेज़ संग्रह सहेजें

• ड्राइव अनुभाग

-- प्रामाणिक समूह

--- उपयोगकर्ता संग्रह

--- प्रामाणिक संग्रह

-- डॉक्स समूह

--- प्रिंट डॉक्स संग्रह

--- दस्तावेज़ संग्रह सहेजें

...

धन्यवाद

कोई विचार?

@ स्पार्क-एफटीडब्ल्यू मैंने नीचे दिए गए कोड में कुछ !comments जोड़े हैं। TL;DR आपका शीर्षक ## प्रमाणीकरण समूह विवरण का हिस्सा है, संसाधन विवरण का हिस्सा नहीं है। एक बार जब आप किसी समूह में पहले समापन बिंदु को परिभाषित कर लेते हैं, तो आपने समूह-विवरण को समाप्त कर दिया है और संसाधन समापन बिंदुओं के साथ शुरुआत कर दी है।

FORMAT: 1A
HOST: https://sample

# sampleapi
Sample API

! group definition starts here with name, and description following
# Group Print
Lorem Ipsum Lorem Ipsum Lorem Ipsum Lorem Ipsum Lorem Ipsum Lorem Ipsum Lorem Ipsum Lorem Ipsum Lorem Ipsum Lorem Ipsum Lorem Ipsum Lorem Ipsum Lorem Ipsum Lorem Ipsum Lorem Ipsum 

## Authentication <--- part of description above
Resource related to user auth <--- part of description above

! First endpoint definition starts here, group description ends here.
## User collection [/users]
### List all users [GET]
+ Response 200 (application/json)
        [...]

### Register new user account [POST]
+ Request (application/json)
            { ... }
+ Response 201
    + Headers
            Location: https://sample

## Print docs <-- this is not another endpoint / resource definition, but a description instead...
Resource related to prints <-- this is not another endpoint / resource definition, but a description instead...

! another resource endpoint is defined below, that is ok.
## Print collection [/print]
### List all users [GET]
+ Response 200 (application/json)
    [...]

ठीक है, तो मैं अपनी इच्छित संरचना कैसे प्राप्त कर सकता हूं?

@ स्पार्क-एफटीडब्ल्यू यदि आप वृक्ष-संरचना पर जोर देते हैं तो आपके पास वह शीर्षक नहीं हो सकता जो आप चाहते हैं। आप अभी भी एकाधिक-समूहों का उपयोग इस प्रकार कर सकते हैं:

Group Print Authentication
  - User Collection
    - List all
    - Register new...
Group Print Docs
Group Drive Authentication
Group Drive Docs
...

मुझे खेद है, लेकिन मुझे और समूहों का उपयोग करने के लिए कोई अन्य समाधान नहीं दिख रहा है। लेकिन आप इससे लाभान्वित होंगे - क्योंकि एपिअरी में प्रलेखन में नेविगेशन इन समूहों का उपयोग करता है। तो यह एक जीत-जीत समाधान है।

कृपया मेरा अनुरोध फिर से देखें:

-प्रिंट अनुभाग

-- प्रामाणिक समूह

--- उपयोगकर्ता संग्रह

--- प्रामाणिक संग्रह

-- डॉक्स समूह

--- प्रिंट डॉक्स संग्रह

--- दस्तावेज़ संग्रह सहेजें

ड्राइव अनुभाग

-- प्रामाणिक समूह

--- उपयोगकर्ता संग्रह

--- प्रामाणिक संग्रह

-- डॉक्स समूह

--- प्रिंट डॉक्स संग्रह

--- दस्तावेज़ संग्रह सहेजें

प्रिंट को छोड़कर, मुझे ड्राइव उत्पाद की भी आवश्यकता है। यह कुछ और है (इसलिए मुझे एक और पदानुक्रम स्तर की आवश्यकता है)

वैसे, मार्कडाउन इसका समर्थन करता है, केवल एपीरी को इसे पार्स करने में समस्या है ...

@ स्पार्क-एफटीडब्ल्यू ऐसा नहीं है कि एपीरी में कोई समस्या है - यह है कि संसाधन समापन बिंदुओं के बीच विवरण की अनुमति नहीं है - यदि आप एपियरी संपादक में चेतावनियों/मुद्दों को देखते हैं, तो आपको वहां एक चेतावनी दिखाई देगी। विनिर्देश के अनुसार https://github.com/apiaryio/api-blueprint/blob/master/API%20Blueprint%20Specification.md#def -section-struct - एक Group अनुभाग में ये भाग होते हैं: समूह का नाम , समूह विवरण, समूह संसाधन। बीच में एक और विवरण के रूप में कुछ भी नहीं।

अगर मार्कडाउन बनाम एपीआई ब्लूप्रिंट की तुलना करते हैं - तो आप इसके बजाय एक रैखिक, गैर-पेड़ संरचना के साथ समाप्त हो जाएंगे।

@ स्पार्क-एफटीडब्ल्यू कृपया ध्यान दें कि कीवर्ड Group का उपयोग नए Section शुरुआत को दर्शाने के लिए किया जाता है।
एपीआई ब्लूप्रिंट तीसरे स्तर के नेस्टिंग का बिल्कुल भी समर्थन नहीं करता है - कृपया ऊपर टिप्पणी में लिंक की गई विनिर्देश फ़ाइल देखें।

तो मेरी समस्या का कोई समाधान नहीं?