Admin API：スキーマの反映

スキーマのファイルを、今のスペースに反映する操作です。共通の決まり（認証、エラーの形、日時）は Admin API のリファレンス にあります。

例の <ホスト名> はあなたの環境のホスト名、<アクセストークン> は hako_pat_ で始まるアクセストークンに置き換えます。<slug> などのほかの山かっこの値は、各操作のパラメーターの表にあるものに置き換えます。

操作	メソッドとパス
スキーマの反映の一覧	GET /admin/api/spaces/{slug}/schema-applies
スキーマのファイルを送り、差分を出す	POST /admin/api/spaces/{slug}/schema-applies
スキーマの反映を 1 件取得する	GET /admin/api/spaces/{slug}/schema-applies/{id}
スキーマの反映の記録を消す	DELETE /admin/api/spaces/{slug}/schema-applies/{id}
差分に同意して、スキーマの反映を始める	POST /admin/api/spaces/{slug}/schema-applies/{id}/apply

スキーマの反映の一覧

スキーマの反映（新しい順に 20 件）

GET /admin/api/spaces/{slug}/schema-applies

• ログイン：要る（セッションかアクセストークン）

パラメーター：

名前	場所	型	必須	決まり	説明
slug	パス	文字列	○		スペースのスラッグ

返る値：

状態	本文
200	TransferList（application/json）

うまくいかなかったときは、4xx か 5xx と、message を持つ JSON が返ります。状態ごとの意味は エラーの一覧 にあります。

例：

curl "https://<ホスト名>.hakocms.net/admin/api/spaces/<slug>/schema-applies" \
  -H "Authorization: Bearer <アクセストークン>"

スキーマのファイルを送り、差分を出す

スキーマのファイル（*.hako.json）を受け取り、差分を出すジョブを積む。

POST /admin/api/spaces/{slug}/schema-applies

• ログイン：要る（セッションかアクセストークン）

パラメーター：

名前	場所	型	必須	決まり	説明
slug	パス	文字列	○		スペースのスラッグ

リクエストの本文（application/json）：

オブジェクト。

返る値：

状態	本文
202	TransferView（application/json）

うまくいかなかったときは、4xx か 5xx と、message を持つ JSON が返ります。状態ごとの意味は エラーの一覧 にあります。

例：

curl -X POST "https://<ホスト名>.hakocms.net/admin/api/spaces/<slug>/schema-applies" \
  -H "Authorization: Bearer <アクセストークン>" \
  -H "Content-Type: application/json" \
  -d '{}'

スキーマの反映を 1 件取得する

GET /admin/api/spaces/{slug}/schema-applies/{id}

• ログイン：要る（セッションかアクセストークン）

パラメーター：

名前	場所	型	必須	決まり	説明
slug	パス	文字列	○		スペースのスラッグ
id	パス	文字列	○		ID

返る値：

状態	本文
200	TransferView（application/json）

うまくいかなかったときは、4xx か 5xx と、message を持つ JSON が返ります。状態ごとの意味は エラーの一覧 にあります。

例：

curl "https://<ホスト名>.hakocms.net/admin/api/spaces/<slug>/schema-applies/<id>" \
  -H "Authorization: Bearer <アクセストークン>"

スキーマの反映の記録を消す

反映の記録を消す。待っているか動いているものは消せない（409）

DELETE /admin/api/spaces/{slug}/schema-applies/{id}

• ログイン：要る（セッションかアクセストークン）

パラメーター：

名前	場所	型	必須	決まり	説明
slug	パス	文字列	○		スペースのスラッグ
id	パス	文字列	○		ID

返る値：

状態	本文
204	なし

うまくいかなかったときは、4xx か 5xx と、message を持つ JSON が返ります。状態ごとの意味は エラーの一覧 にあります。

例：

curl -X DELETE "https://<ホスト名>.hakocms.net/admin/api/spaces/<slug>/schema-applies/<id>" \
  -H "Authorization: Bearer <アクセストークン>"

差分に同意して、スキーマの反映を始める

差分に同意して反映を始める。同意で足りなければ 409（理由を 1 行に 1 つ）

POST /admin/api/spaces/{slug}/schema-applies/{id}/apply

• ログイン：要る（セッションかアクセストークン）

パラメーター：

名前	場所	型	必須	決まり	説明
slug	パス	文字列	○		スペースのスラッグ
id	パス	文字列	○		ID

リクエストの本文（application/json）：

名前	型	必須	決まり	説明
confirm	真偽値			今のエントリーが違反する変更も反映する。省くと false
prune	真偽値			消える（delete の）コンテンツタイプを、エントリーごと消す。省くと false

返る値：

状態	本文
202	TransferView（application/json）

うまくいかなかったときは、4xx か 5xx と、message を持つ JSON が返ります。状態ごとの意味は エラーの一覧 にあります。

例：

curl -X POST "https://<ホスト名>.hakocms.net/admin/api/spaces/<slug>/schema-applies/<id>/apply" \
  -H "Authorization: Bearer <アクセストークン>" \
  -H "Content-Type: application/json" \
  -d '{}'