文書を横断して探す

自分が見られる全文書（一覧と同じ文書）の題名・タグ・最新版の本文から、語を含むものを探す。本文の索引が作成待ちの文書は index の件数に出る。個人トークンはどの範囲でも使える。

GET/api/search/docs

Authorization

AuthorizationBearer token · headerrequired

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

Query parameters

qstringrequired

探す語。前後の空白を除いて 1〜100 文字。全角と半角、ASCII の大文字と小文字の違いは区別しない。

min length 1 · max length 100

limitinteger

返す件数の上限。既定 50、最大 200。

min 1 · max 200 · default: 50

projectstring

案件コード。指定すると、その案件に結び付いた文書だけを返す。大文字・小文字は区別しない。

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

Responses

200

探せた。

hitsobject[]required

Show properties

Array of object

reviewIdstringrequired

titlestringrequired

fieldsstring[]required

一致した場所。

snippetstring | nullrequired

本文で一致したときだけ、一致した前後の文字。

lastActivityTsinteger | nullrequired

totalintegerrequired

上限で切る前の件数。

truncatedbooleanrequired

indexobjectrequired

見られる文書のうち、本文の索引がある・無い・古い件数。

Show properties

indexedintegerrequired

missingintegerrequired

staleintegerrequired

400

指定が正しくない（invalid_query・invalid_limit・invalid_project）。

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

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

errorstringrequired

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

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

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

latestVersionIdstring

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

503

本文の索引がまだ用意されていない（search_index_unavailable）。

errorstringrequired

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

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

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

latestVersionIdstring

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

Request

curl -X GET 'https://comment-review.fsmarketing.workers.dev/api/search/docs?q=string' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("https://comment-review.fsmarketing.workers.dev/api/search/docs?q=string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://comment-review.fsmarketing.workers.dev/api/search/docs?q=string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "hits": [
    {
      "reviewId": "review_example01",
      "title": "料金ページ",
      "fields": [
        "text"
      ],
      "snippet": "月額 980 円のプランです。",
      "lastActivityTs": 1791162968468
    }
  ],
  "total": 1,
  "truncated": false,
  "index": {
    "indexed": 12,
    "missing": 0,
    "stale": 0
  }
}

{
  "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"
}