फ़ीडबैक
स्क्रीनशॉट और लॉग वाली रिपोर्ट, जो इस सर्वर के ज़रिए ProAnimaStudio को भेजी जाती हैं।
इस समूह के ऑपरेशन, उनके एक्सेस नियम, पुनः प्रयास नियम, पैरामीटर और जवाबों के साथ। हर अनुरोध में एक कुंजी होती है: Authorization: Bearer <कुंजी> (“प्रमाणीकरण” देखें)।
ऑपरेशन
ProAnimaStudio को फ़ीडबैक भेजें
POST /api/v1/feedback
एक्सेस: कोई भी मान्य कुंजी या सत्र · पुनः प्रयास: अपने-आप न दोहराएँ
इस सर्वर के माध्यम से ProAnimaStudio हब को संदेश अग्रेषित करता है और हब की id के साथ 202 लौटाता है। message (20 000 वर्णों तक), lang (ru या en), serverLog (true होने पर इस सर्वर का लॉग और सिस्टम सारांश संलग्न होता है, केवल व्यवस्थापकों के लिए) भेजें, और वैकल्पिक रूप से उत्तर के लिए email, screen, base64 में अधिकतम 6 screenshots (PNG, JPEG, WebP या GIF, प्रत्येक 8 MiB) तथा कंसोल का clientLog; कुल सीमा 15 MiB है। कुछ भी दोबारा नहीं आज़माया जाता, इसलिए दूसरा कॉल दूसरा संदेश है। ऑपरेटर द्वारा बंद किए जाने पर 503 feedback_disabled, हब के उत्तर न देने पर 503 hub_unreachable, और इस सर्वर द्वारा बहुत अधिक भेजे जाने पर 429 feedback_attempts।
अनुरोध बॉडी (application/json)
| फ़ील्ड | प्रकार | आवश्यक | नियम |
|---|---|---|---|
message | string | हाँ | 1–20000 वर्ण |
email | string | नहीं | अधिकतम 254 वर्ण; null हो सकता है |
lang | string | हाँ | इनमें से एक: ru, en |
screen | string | नहीं | अधिकतम 11 वर्ण; null हो सकता है |
screenshots | object का ऐरे | हाँ | अधिकतम 6 आइटम |
screenshots[].name | string | हाँ | 1–120 वर्ण |
screenshots[].type | string | हाँ | इनमें से एक: image/png, image/jpeg, image/webp, image/gif |
screenshots[].data | string (byte) | हाँ | — |
clientLog | string | नहीं | अधिकतम 2097152 वर्ण; null हो सकता है |
serverLog | boolean | हाँ | — |
प्रतिक्रिया 202
| फ़ील्ड | प्रकार | आवश्यक | नियम |
|---|---|---|---|
id | string | हाँ | — |
प्रतिक्रियाएँ: 202, 400, 401, 403, 404, 405, 409, 413, 415, 422, 503, 507
उदाहरण
curl -X POST "$ARKVORY_URL/api/v1/feedback" \
-H "Authorization: Bearer $ARKVORY_TOKEN" \
-H "Content-Type: application/json" \
-d '{"message":"<message>","lang":"ru","screenshots":[],"serverLog":false}'फ़ीडबैक अटैचमेंट का पूर्वावलोकन करें
GET HEAD /api/v1/feedback/attachments
एक्सेस: व्यवस्थापक · पुनः प्रयास: दोहराना सुरक्षित है (पढ़ना)
वे दो पाठ लौटाता है जो serverLog true होने पर sendFeedback संलग्न करता है: इस सर्वर के लॉग के हाल के रिकॉर्ड और एक सिस्टम सारांश (संस्करण, ऑपरेटिंग सिस्टम, अपडेट और मिरर की स्थितियाँ), बिना पतों, नामों या गोपनीय मानों के। भेजने से पहले उन्हें व्यवस्थापक को दिखाएँ।
प्रतिक्रिया 200
| फ़ील्ड | प्रकार | आवश्यक | नियम |
|---|---|---|---|
serverLog | string | हाँ | — |
system | string | हाँ | — |
प्रतिक्रियाएँ: 200, 400, 401, 403, 404, 409, 422, 503, 507
उदाहरण
curl -X GET "$ARKVORY_URL/api/v1/feedback/attachments" \
-H "Authorization: Bearer $ARKVORY_TOKEN"