フィードバック
このサーバーを通じてProAnimaStudioに送信される、スクリーンショットとログ付きのレポート。
このグループの操作と、それぞれのアクセスルール、再試行ルール、パラメーター、レスポンスです。すべてのリクエストにはキーを付けます:Authorization: Bearer <key>(「認証」を参照)。
操作
ProAnimaStudioへのフィードバックの送信
POST /api/v1/feedback
アクセス: 有効なキーまたはセッション · 再試行: 自動的に再試行しない
このサーバーを経由して、ProAnimaStudioハブへメッセージを転送し、ハブのidとともに202を返します。message(最大20,000文字)、lang(ruまたはen)、serverLog(trueにするとこのサーバーのログとシステムの概要を添付。管理者のみ)を送り、必要に応じて、返信用のemail、screen、Base64のscreenshots(PNG、JPEG、WebP、GIF。最大6枚、各8MiB)、コンソールのclientLogを送ります。合計の上限は15MiBです。再試行は行われないため、2回目の呼び出しは2通目のメッセージになります。運用者が無効にしている場合は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が添付する2つのテキストを返します。このサーバーのログの最近のレコードと、アドレス、名前、シークレットを含まないシステムの概要(バージョン、オペレーティングシステム、アップデートとミラーの状態)です。送信する前に管理者に見せてください。
レスポンス 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"