🚥

新しい Pixela サポーター特典を追加しました! (Pixela v1.25.0)

投稿日
2022/7/25
Tags
Release
(2022-07-31 追記)このリリースによって追加された仕様を一部変更し、v1.25.1 としてリリースしています。詳しくはこちらをご確認ください。
 
 
今回リリースした Pixela v1.25.0 によって、以下の仕様が新たに追加されました。
 
  • 一部のAPIにおいて、25%の割合でそのAPIに対するリクエストがリジェクトされるようにしました。
    • リジェクトされたときの HTTP ステータスコードと HTTP レスポンスボディは以下の通りです。
      • HTTP ステータスコード
        • 503 Service Unavailable
      • HTTP レスポンスボディ
        • {"message":"Please retry this request. Your request for some APIs will be rejected 25% of the time because you are not a Pixela supporter. If you are interested in being a Pixela supporter, please see: https://github.com/a-know/Pixela/wiki/How-to-support-Pixela-by-Patreon-/-Use-Limited-Features","isSuccess":false,"isRejected":true}
    • 「一部のAPI」の対象となるAPIは非公開です。(2022-07-26 追記)対象となる API を公開します。以下の通りです。
      • 対象のAPI一覧
        • User
          • DELETE - /v1/users/<username>
        • User profile
          • PUT /@<username> - Update user profile
        • Graph
          • GET /v1/users/<username>/graphs - Get graph definitions
          • GET /v1/users/<username>/graphs/<graphID>/graph-def - Get a graph definition
          • PUT /v1/users/<username>/graphs/<graphID> - Update a graph
          • DELETE /v1/users/<username>/graphs/<graphID> - Delete a graph
          • GET /v1/users/<username>/graphs/<graphID>/pixels - Get graph pixels list
        • Pixel
          • POST /v1/users/<username>/graphs/<graphID> - Post a pixel
          • GET /v1/users/<username>/graphs/<graphID>/<yyyyMMdd> - Get a pixel
          • PUT /v1/users/<username>/graphs/<graphID>/<yyyyMMdd> - Update a pixel
          • DELETE /v1/users/<username>/graphs/<graphID>/<yyyyMMdd> - Delete a pixel
        • Instant recording
          • PUT /v1/users/<username>/graphs/<graphID>/increment - Increment a pixel
          • PUT /v1/users/<username>/graphs/<graphID>/decrement - Decrement a pixel
          • POST /v1/users/<username>/graphs/<graphID>/stopwatch - Measuring and recording time
        • Webhook
          • POST /v1/users/<username>/webhooks - Create a webhook
          • GET /v1/users/<username>/webhooks - Get webhooks
          • DELETE /v1/users/<username>/webhooks/<webhookHash> - Delete a webhook
    • これらの仕様は、予告なく変更される場合があります。もし変更した場合には、新しいバージョンをリリースする形でお知らせします。
 
上記の仕様は、Pixela サポーターユーザーに対する API リクエストの場合には適用されません。つまりこれは、今回追加された新しい Pixela サポーター特典です。
 
この仕様によって返されるエラーレスポンスは、リトライ可能エラーです。Pixela サポーターではない方は、上記のエラーを正しくハンドリングし適切なリトライ処理を実施してください。
(Pixela サポーターであっても、サーバーエラーやサービス障害などにより、HTTP ステータスコードが 503 のようなエラーはいつでも発生し得るものです。そのため、このようなエラーハンドリングを実施しておくに越したことはありません。)
 
今回の仕様の追加は、挑戦的かつ野心的なものであると理解しています。この仕様追加について何かご意見のある方は、ぜひ GitHub issues にて教えてください(日本国外のユーザーの方も多いため、英語での起票をお願いします)。
 
それでは、Pixela v1.25.0 をお楽しみください!