文書を上げる

HTML のファイルを上げて、新しい文書を作る。文書の ID はサーバーが決め、応答の Location で返す。

POST/api/reviews/import-html

Authorization

AuthorizationBearer token · headerrequired

取り込み用トークン。文書を上げる、版を追加する、文書の一覧と中身を読むのに使う。

AuthorizationBearer token · headerrequired

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

Request body

requiredmultipart/form-data

htmlstring<binary>required

HTML のファイル（25 MiB まで）。

titlestring

題名。省略すると文書の ID になる。

accessModestring

link はリンクを知る人が見られる。restricted は招待した人だけ。

default: "link"

Allowed:linkrestricted

projectstring

案件コード。社外・クライアントは必須。指定すると文書の ID はサーバーが作るため、reviewId を送ると 400 invalid_request。取り込み用の共有トークンでは指定できない（403 insufficient_scope）。

matches ^[A-Z0-9][A-Z0-9-]{0,31}$

sourceLabelstring

元のファイルの名前など、出どころの表示。

tagstring[]

タグ。複数送れる。

Responses

303

作った。Location が /reviews/<reviewId> を指す。本文は無い。

400

HTML のファイルが無い（html file required）、タグの形が違う（invalid_tags）、または project と reviewId を同時に送った（invalid_request）。

errorstringrequired

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

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

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

latestVersionIdstring

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

401

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

errorstringrequired

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

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

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

latestVersionIdstring

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

403

案件が必要（project_required）、案件で編集以上の役割が無い（project_role_required）、または個人トークンの範囲が不足している（insufficient_scope）。

errorstringrequired

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

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

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

latestVersionIdstring

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

404

案件が見つからない（project_not_found）。

errorstringrequired

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

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

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

latestVersionIdstring

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

409

案件が写しに無い（project_not_in_snapshot）か、配信前の結び付けが競合した（project_conflict）。

errorstringrequired

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

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

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

latestVersionIdstring

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

413

HTML が大きすぎる（html too large）。

errorstringrequired

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

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

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

latestVersionIdstring

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

Request

curl -X POST 'https://comment-review.fsmarketing.workers.dev/api/reviews/import-html' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  --form-string 'html=string' \
  --form-string 'title=string' \
  --form-string 'accessMode=link' \
  --form-string 'project=string' \
  --form-string 'sourceLabel=string' \
  --form-string 'tag=string'

const form = new FormData();
form.append("html", "string");
form.append("title", "string");
form.append("accessMode", "link");
form.append("project", "string");
form.append("sourceLabel", "string");
form.append("tag", "string");

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

import requests

response = requests.post(
    "https://comment-review.fsmarketing.workers.dev/api/reviews/import-html",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
    files=[
        ("html", (None, "string")),
        ("title", (None, "string")),
        ("accessMode", (None, "link")),
        ("project", (None, "string")),
        ("sourceLabel", (None, "string")),
        ("tag", (None, "string")),
    ],
)

Response

作った。`Location` が `/reviews/<reviewId>` を指す。本文は無い。

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

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

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

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

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

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