文書を削除する

文書を削除する。オーナーだけが削除できる。削除済みの文書に送り直すと、idempotent: true を付けて同じ結果を返す。

DELETE/api/reviews/{reviewId}

Authorization

AuthorizationBearer token · headerrequired

管理用トークン。題名・タグ・アーカイブ・共有先を変える、文書を削除するのに使う。

AuthorizationBearer token · headerrequired

本人用の個人トークン。発行時に選んだ範囲の操作を、本人の名義で行う。読み取りと本人のトークン操作は、範囲を問わず使える。

Path parameters

reviewIdstringrequired

文書の ID。文書の URL /reviews/<reviewId> の末尾と同じ。

Responses

200

削除した。

okboolean

reviewIdstring

idempotentboolean

401

トークンが無いか、この文書を読む権限が無い。

errorstringrequired

エラーの種類を表す短いコード。対処を分けるときはこの値を見る。

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

409 comments revision conflict のとき、文書の今の commentsRevision。

latestVersionIdstring

409 stale_target_version のとき、文書の最新版の ID。

403

このトークンでは使えない操作か、対象に対する権限が無い。使えるトークンは各操作の Authorization の欄を見る。

errorstringrequired

エラーの種類を表す短いコード。対処を分けるときはこの値を見る。

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

409 comments revision conflict のとき、文書の今の commentsRevision。

latestVersionIdstring

409 stale_target_version のとき、文書の最新版の ID。

404

文書・run・コメントのいずれかが無い。

errorstringrequired

エラーの種類を表す短いコード。対処を分けるときはこの値を見る。

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

409 comments revision conflict のとき、文書の今の commentsRevision。

latestVersionIdstring

409 stale_target_version のとき、文書の最新版の ID。

503

削除の確認が一時的にできない。少し待って送り直す。

errorstringrequired

エラーの種類を表す短いコード。対処を分けるときはこの値を見る。

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

409 comments revision conflict のとき、文書の今の commentsRevision。

latestVersionIdstring

409 stale_target_version のとき、文書の最新版の ID。

Request

curl -X DELETE 'https://comment-review.fsmarketing.workers.dev/api/reviews/review_example01' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("https://comment-review.fsmarketing.workers.dev/api/reviews/review_example01", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.delete(
    "https://comment-review.fsmarketing.workers.dev/api/reviews/review_example01",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "ok": true,
  "reviewId": "review_example01"
}

{
  "error": "string",
  "status": 0,
  "currentRevision": 0,
  "latestVersionId": "string"
}

{
  "error": "string",
  "status": 0,
  "currentRevision": 0,
  "latestVersionId": "string"
}

{
  "error": "review not found",
  "status": 404
}

{
  "error": "string",
  "status": 0,
  "currentRevision": 0,
  "latestVersionId": "string"
}