本文へ移動
Bounty Developer

PATCH/api/bounty/wishes/{id}

「バウンティ」の分類の、対象のうち、送った項目だけを直す API。ログインした本人として呼ぶ。

要約

バウンティの編集・並べ替え・分類の変更(classification = null で自動分類へ戻す)

呼び方と印

ログイン

URL に付ける値(パラメータ)

経路の中の波かっこの部分と、URL の ? の後ろに付ける値。「必須」の印があるものは省けない。

  • idpath必須string(uuid)

送るもの(本文)application/json

送る本文の欄。「必須」の印がある欄は省けない。

  • text任意string
    長さ 1–240
  • sort任意integer
    0–10
  • classification任意object | null
  • purpose必須enum(5) | null
    • "funding"
    • "team"
    • "collab"
    • "learn"
    • "deal"
  • targets必須array<enum(7)>
    件数 ≤3
  • tags必須array<string>
    件数 ≤6

返るもの(応答)200 · application/json

成功したときに返る形。入れ子の欄は、その行を押すと開く・閉じる。「任意」の印がある欄は返らないことがある。

  • wishesarray<object>
    • idstring
    • textstring
    • sortinteger
    • capturedinteger
    • createdAtstring
    • classificationobject
      • purposestring | null
      • targetsarray<string>
      • tagsarray<string>
      • source"auto" | "user"
  • maxinteger
  • maxLeninteger

失敗したとき(エラー)

失敗したときの状態コードと、その意味。本文の error の値で、プログラムが失敗の種類を見分けられる。

  • 400入力の誤り(error = invalid_input など)
  • 401未ログイン(unauthorized)/ Bearer が無効(invalid_token。WWW-Authenticate 付き)
  • 403権限が無い

呼び出しの見本

そのまま試せる呼び出しの例。curl と fetch をタブで切り替える。ID やトークンは自分の値に置き換える。

curl -X PATCH "https://bounty.spikes.4s.link/api/bounty/wishes/{id}" \
  -H "Authorization: Bearer $BEARER_AUTH" \
  -H "Content-Type: application/json" \
  -d '{}'
PATCH /api/bounty/wishes/{id} | Bounty Developer