Admin API：型の定義のダウンロード

スペースのコンテンツタイプから作った OpenAPI、TypeScript の型、GraphQL のスキーマ、スキーマのファイルを取得する操作です。共通の決まり（認証、エラーの形、日時）は Admin API のリファレンスにあります。

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

操作	メソッドとパス
GraphQL のスキーマ（SDL）をダウンロードする	`GET /admin/api/spaces/{slug}/schema/graphql`
スキーマのファイル（`*.hako.json`）をダウンロードする	`GET /admin/api/spaces/{slug}/schema/hako.json`
公開 API の OpenAPI（コンテンツタイプごとの型つき）をダウンロードする	`GET /admin/api/spaces/{slug}/schema/openapi.json`
エントリーの TypeScript の型をダウンロードする	`GET /admin/api/spaces/{slug}/schema/types.ts`

GraphQL のスキーマ（SDL）をダウンロードする

GET /admin/api/spaces/{slug}/schema/graphql

パラメーター：

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

返る値：

状態	本文
`200`	ファイル（`text/plain`）

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

例：

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

そのままスキーマの反映に送れる。

GET /admin/api/spaces/{slug}/schema/hako.json

パラメーター：

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

返る値：

状態	本文
`200`	オブジェクト（`application/json`）

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

例：

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

管理画面からのダウンロード。

GET /admin/api/spaces/{slug}/schema/openapi.json

パラメーター：

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

返る値：

状態	本文
`200`	オブジェクト（`application/json`）

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

例：

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

GET /admin/api/spaces/{slug}/schema/types.ts

パラメーター：

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

返る値：

状態	本文
`200`	ファイル（`application/typescript`）

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

例：

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