diff options
Diffstat (limited to 'website/src/content/docs/ja/socket-api.mdx')
| -rw-r--r-- | website/src/content/docs/ja/socket-api.mdx | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/website/src/content/docs/ja/socket-api.mdx b/website/src/content/docs/ja/socket-api.mdx index dca7136d..a5ebc5f5 100644 --- a/website/src/content/docs/ja/socket-api.mdx +++ b/website/src/content/docs/ja/socket-api.mdx @@ -17,6 +17,18 @@ Herdr は、実行中のセッションを調査・制御する必要がある これらの層は同じ制御面を共有します。 +## スキーマ + +インストール済み CLI は、その Herdr バイナリに同梱されたソケットプロトコルスキーマを表示できます: + +```bash +herdr api schema +herdr api schema --json +herdr api schema --output herdr-api.schema.json +``` + +通常の `herdr api schema` は短い概要を表示します。`--json` はツール向けの完全な JSON Schema を表示し、`--output PATH` はそのドキュメントをファイルに書き込みます。スキーマには、生のリクエスト、成功レスポンス、エラーレスポンス、発行イベント、購読イベントが含まれます。 + ## 制御できるもの ソケット API では次のことができます: |