Skip to content

api(openapi): テナント単体取得 / 状態切替 / プラットフォームメトリクスを追加 + POST /tenants の security 変更 #161

Description

@win2cot

背景

2026-05-16 SaaS Admin スコープ整理ブレストの確定方針(A1 参照)を OpenAPI に反映する。新規 3 エンドポイント追加と既存 1 エンドポイントの security 変更が必要。

やること

api/openapi.yaml を改訂し v1.4.0 とする。

既存エンドポイントの変更

  • POST /api/tenants: security オーバーライドで tenantHeader 不要を明示(現状は SaaS Admin 専用設計 → 認証済みなら誰でも呼べる方式に変更)。レスポンスに初代 TENANT_ADMIN の user_tenants 概要を含める
  • GET /api/tenants / PUT /api/tenants/{id}: SaaS Admin 専用 security スキーム(APP_ADMIN ロール必要)を明示
  • POST /api/tenants 409 description を「テナント名一意制約違反」シナリオ用に追記

新規エンドポイント

  • GET /api/tenants/{id} テナント単体取得
    • SaaS Admin は任意のテナント取得可
    • 一般ユーザーは自分が所属するテナントのみ取得可、それ以外は 404
  • PATCH /api/tenants/{id}/status 状態切替
    • SaaS Admin 専用、リクエスト body: { "status": "ACTIVE" | "SUSPENDED" }
  • GET /api/platform/metrics 全体メトリクス
    • SaaS Admin 専用、レスポンス: テナント総数 / アクティブ・停止内訳 / 総ユーザー数 / 総タスク数 / 直近 24h 新規テナント数

スキーマ追加

  • Tenant(id / name / status / createdAt)
  • TenantStatusUpdateRequest(status)
  • PlatformMetrics(集計フィールド一式)

401 / 403 / 404 網羅

新規エンドポイント全てに OpenAPI v1.3.1 で確立した認可応答パターン(401/403/404)を網羅する。基本設計書 §6.2.3 と整合させる。

参照

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/openapiOpenAPI 仕様(api/openapi.yaml)変更priority/p1High。現スプリント内で完了必須

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions