コンテンツにスキップ

現行ルールリビジョンの取得

メソッド

この API は REST の方法論に従います。

HTTP メソッド

GET: プロジェクトの 現行 デザインルールリビジョンを、上限付きサマリとして読み取ります。

ここでの「現行」は生成実行時にピン留めされるものと完全に一致するため、本エンドポイントは「次のデザインはどのルールに基づいて構築されるか」に答えます。

命名規則

レスポンスは内部の wf2des-api データプレーンから 逐語でプロキシ されるため、フィールドは snake_case です。

リクエストとレスポンス

ヘッダー

リクエストヘッダー

  • Authorization
  • Accept
  • Accept-language

レスポンスヘッダー

  • Content-Type

最新ルールの取得

URI

GET /api/v1/organizations/{organization_id}/projects/{project_id}/wf2des/rules/latest

パスパラメータ

名前 型 必須 説明
organization_id integer 必須 組織 ID
project_id integer 必須 プロジェクト ID

レスポンス

レスポンスは JSON です（HTTP ステータス: 200 OK）。

{
  "design_rule_id": "0190f3a1-2c4e-7b8d-9e0f-1a2b3c4d5e6f",
  "version": 4,
  "content_hash": "8f14e45fceea167a5a36dedd4bea2543",
  "draft_source": "llm_extracted",
  "extracted_at": "2026-08-01T09:15:00Z",
  "processed_at": "2026-08-01T09:15:04Z"
}

レスポンスフィールド

名前 型 説明
design_rule_id string | null このリビジョンが属するルール系列。
version integer | null 系列内のリビジョン番号。単調増加であり、新規アップロードは常に max + 1。
content_hash string | null マージ済みルールセットのハッシュ。同一ハッシュのリビジョンは同一のルールを保持する。
draft_source string | null リビジョンの生成方法 — ボード取り込みの場合は llm_extracted。
extracted_at string | null 抽出が実行された時刻。
processed_at string | null リビジョンが作成された時刻。

これはサマリであり、ルールセットではありません。 マージ済みルールとソースボードは意図的に返しません — サイズが大きく、「どのリビジョンが現行か」に答えるために必要な呼び出し側は存在しないためです。

「現行」の決定方法

デザイナーが設定した アクティブポインタが存在すればそれが勝ちます — つまり revert が特定のリビジョンを現行としてピン留めします。ポインタが無い場合は最大の version が勝ち、同値の場合は最新の processed_at で決まります。既に存在しないリビジョンを指すポインタは、エラーではなく同じ既定動作にフォールバックします。

これはワーカー自身の解決ロジックを正確に反映しており、そのためプラグインが表示するバッジは生成が実際にピン留めする内容と一致します。

認証

認証は Amazon Cognito が発行する JSON Web Token（JWT）で行われます。加えて、呼び出し元はプロジェクトへのアクセス権を保持している必要があります。

エラーハンドリング

説明 ステータスコード ステータス名
認証情報の欠落 401 Unauthorized
権限不足 403 Forbidden
このプロジェクトにルールリビジョンが存在しない 404 Not Found
上流の読み取り失敗（wf2des-api） 500 Internal Server Error

ここでの 404 は、そのプロジェクトでルール取り込みが一度も行われていないことを意味します。まず POST …/wf2des/rules でガイドラインボードをアップロードしてください。

処理フロー

  1. パスパラメータから組織 ID とプロジェクト ID を取得する。
  2. ユーザーがプロジェクトへのアクセス権を持つことを検証する。
  3. 組織とプロジェクトにスコープした上で、内部 wf2des-api データプレーンへ読み取りをプロキシする（X-AI-Service-Token）。
  4. データプレーンはアクティブポインタを解決し、無ければ最大バージョンにフォールバックして、そのリビジョンの上限付きサマリを返す。
  5. サマリを逐語で返す。リビジョンが無い場合は 404 を返す。