Plots2: एपीआई लिखने के लिए टोकन सिस्टम का दस्तावेज़ीकरण

अरे @jywarren क्या मैं इस पर काम कर सकता हूं?

ज़रूर, धन्यवाद!

उस समय इस सुविधा का दस्तावेजीकरण नहीं करने के लिए क्षमा करें क्योंकि मैं समय पर कार्यों को पूरा करने की जल्दबाजी में था। इस पर काम करने के लिए स्वेच्छा से धन्यवाद, @namangupta01! एक बार जब आप दस्तावेज़ीकरण समाप्त कर लेंगे तो मुझे इसकी समीक्षा करना अच्छा लगेगा।

बिल्कुल भी परेशानी नहीं है! टीम वर्क!

@ryzokuken धन्यवाद! :)

@jywarren @ryzokuken तो मैं इस मुद्दे पर काम कर रहा था, मैं सोच रहा था कि क्या मुझे केवल टोकन यानी https://github.com/publiclab/plots2/pull/1513/files के माध्यम से टिप्पणियों के बारे में दस्तावेज करना है?

@ namangupta01 सही! यह वह पीआर है जहां मैंने टोकन के माध्यम से टिप्पणी करने के लिए वास्तव में कोड लिखा था।

हेलो सब लोग! क्या मैं इसमें भी मदद कर सकता हूं? यह अभी तक कैसा चल रहा है? मैं एपीआई के साथ और अधिक परिचित करने के लिए टोकन दस्तावेज लिखना शुरू करने के बारे में सोच रहा था।

@stefannibrasil मुझे लगता है कि इसे अभी के लिए छोड़ दिया गया है, इसलिए आप आगे बढ़ने और इस पर काम करने के लिए स्वतंत्र महसूस कर सकते हैं। अगर आपको कोई समस्या आती है तो हमें बताएं।

धन्यवाद, @ryzokuken मैं इस सप्ताह टोकन सुविधा के दस्तावेजीकरण पर काम शुरू करने जा रहा हूं। मैं कुछ उदाहरण देखने जा रहा हूं और निश्चित रूप से मैं आपको कुछ भी बताऊंगा। सहायता के लिए धन्यवाद!

@ सुखबीर-सिंह क्या आप इस पर भी काम करना चाहते हैं? हम अपने काम की तुलना बाद में कर सकते हैं।

हाँ! ज़रूर :मुस्कुराओ :
@stefannibrasil आप

हाय @jywarren और @ryzokuken! यहां उपलब्ध कराए गए दस्तावेज़ों को और पढ़ने के बाद, मेरे पास पूछने के लिए कुछ प्रश्न हैं:

• app/api/src/ फ़ोल्डर में फ़ाइलें वे दस्तावेज़ हैं जिनका उपयोग स्वैगर इंटरफ़ेस उत्पन्न करने के लिए करता है, है ना?

• टोकन प्रमाणीकरण के लिए दस्तावेज़ तैयार करने के लिए, क्या मुझे ऊपर बताए गए फ़ोल्डर में एक नई फ़ाइल बनाने की ज़रूरत है, जिसमें दिखाया गया है कि कमेंट कंट्रोलर कैसे काम करता है?

मैं अब तक यही समझता हूं। अगर आप उस पर थोड़ी और जानकारी दे सकें तो मैं आभारी रहूंगा। धन्यवाद!

@stefannibrasil समय और प्रयास बचाने के लिए, मैंने "टिप्पणी पर टोकन" कार्रवाई को मौजूदा स्वैगर एपीआई युक्ति का एक हिस्सा बनाने से परहेज किया था, और रेल कोडबेस में एक स्टैंडअलोन फ़ंक्शन बनाया था ( CommentController , आप दाएं) और उसके लिए एक मार्ग बनाया।

मुझे नहीं लगता कि स्वैगर आपको बाहरी कार्यों का दस्तावेजीकरण करने की अनुमति देता है, लेकिन मैं गलत हो सकता हूं।
इसलिए, मेरा मानना ​​​​है कि आपको मार्कडाउन प्रारूप में केवल doc/api.md में अपने आप से कुछ दस्तावेज जोड़ना चाहिए, यह बताते हुए कि फ़ंक्शन कैसे काम करता है और हम उपयोगकर्ताओं से इस समापन बिंदु का उपयोग करके अपनी टिप्पणियों को जोड़ने की अपेक्षा करते हैं।

मुझे उम्मीद है कि इससे यह स्पष्ट हो गया है, इसमें से किसी पर स्पष्टीकरण मांगने के लिए स्वतंत्र महसूस करें।

यह समझ में आता है, धन्यवाद! डॉक्स और एपीआई डॉक्स लिखने के तरीके को देखने के बाद, मैंने इस पीआर में कुछ बदलाव जोड़े। मुझे यकीन नहीं है कि आप जिस प्रकार के दस्तावेज मांग रहे थे वह है।

मैंने विवरण में अपने प्रश्न जोड़े हैं, क्या आप कृपया एक नज़र डालें और देखें कि क्या आप मेरी मदद कर सकते हैं?

मुझे टोकन के बारे में अधिक दस्तावेज नहीं मिला, आप मुझे बता सकते हैं कि और कहां देखना है, इससे मदद मिलेगी! :)

@ सुखबीर-सिंह क्षमा करें, मैं गड़गड़ाहट पर नहीं हूं, लेकिन यदि आप चाहें, तो आप पीआर में भी योगदान कर सकते हैं, यह बहुत अच्छा होगा।

@stefannibrasil आप इस वीडियो को डेमो के लिए देख सकते हैं कि टिप्पणी एपीआई पर अनुरोध करने के लिए पोस्टमैन का उपयोग कैसे करें। गुब्बारा:

बढ़िया, क्या यह पूरा हो गया है, या क्या हम इसके बारे में कुछ और बता सकते हैं? अगर यह हो गया है तो इसे बंद करने के लिए स्वतंत्र महसूस करें! सबको शुक्रीया!!!

वास्तव में शायद हम कुछ जोड़ जोड़ सकते हैं - जैसे, क्या हम POST https://publiclab.org/comment/create/token/id.:format से POST https://publiclab.org/comment/create/token/id.json तक परिशोधित कर सकते हैं ताकि आप इस तरह के प्रारूप को निर्दिष्ट कर सकें। और शायद हमें उस स्रोत से लिंक करना चाहिए जहां टोकन एपीआई कोड स्रोत में है?

https://github.com/publiclab/plots2/blob/master/app/controllers/comment_controller.rb#L48 -L73

@jywarren +1, यह सही लगता है।

ज़रा सुनिए सभी! ये अच्छे अंक हैं, धन्यवाद! पीआर पहले ही मर्ज कर दिया गया था, मैं इसे जोड़ूंगा और फिर एक और बनाऊंगा =)

इसके अलावा, धन्यवाद @ सुखबीर-सिंह यहां सभी मदद के लिए धन्यवाद!

कोई दिक्कत नहीं है...!! मदद करने के लिए खुश। मैं जीथब, जिटर और आईआरसी पर बहुत सक्रिय हूं, अगर आपको किसी भी मामले में मदद की ज़रूरत है तो आप मुझे वहां पिंग कर सकते हैं। :स्माइली: