認証
すべてのリクエストにはAuthorizationヘッダーにFactory APIキーが必要です:
ベースURL
エンドポイント
Readiness Reportsの一覧取得
組織の準備状況レポートを取得します。クエリパラメータ
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
repoId | string | No | リポジトリIDでレポートをフィルタ |
limit | integer | No | 返すレポートの最大数(正の値である必要があります) |
startAfter | string | No | ページネーションカーソル用のレポートID |
レスポンス
リクエスト例
Readiness Reportスキーマ
Reportオブジェクト
| フィールド | 型 | 説明 |
|---|---|---|
reportId | string | レポートの一意識別子(UUID) |
createdAt | number | レポートが作成されたUnixタイムスタンプ(ミリ秒) |
repoUrl | string | 評価されたリポジトリURL |
apps | object | アプリケーションパスから説明オブジェクトへのマップ |
report | object | 基準IDから評価結果へのマップ |
commitHash | string? | 評価時のGitコミットハッシュ |
branch | string? | 評価時のGitブランチ名 |
hasLocalChanges | boolean? | コミットされていない変更が存在したかどうか |
hasNonRemoteCommits | boolean? | プッシュされていないコミットが存在したかどうか |
modelUsed | object? | 評価に使用されたモデル設定 |
droidVersion | string? | レポートを生成したCLIバージョン |
App Descriptionオブジェクト
| フィールド | 型 | 説明 |
|---|---|---|
description | string | アプリケーションの機能に関する簡潔な説明 |
Criterion Evaluationオブジェクト
| フィールド | 型 | 説明 |
|---|---|---|
numerator | number | 基準を満たしたサブアプリケーションの数(0からdenominatorまで) |
denominator | number | 基準が評価されたサブアプリケーションの数(最低1) |
rationale | string | 評価結果の説明 |
Model Usedオブジェクト
| フィールド | 型 | 説明 |
|---|---|---|
id | string | モデル識別子 |
reasoningEffort | string | 推論労力レベル(low、medium、high、off) |
ページネーション
大きな結果セットに対しては、カーソルベースのページネーションを使用してください:- 希望する
limitで初回リクエストを実行 - レスポンスの最後のアイテムの
reportIdを取得 - そのIDを次のリクエストで
startAfterとして渡す
使用例
CI/CD統合
各評価後にレポートを取得することで、時系列での準備状況スコアを追跡:カスタムダッシュボード
すべてのレポートを取得し、集約メトリクスを計算することで内部ダッシュボードを構築:自動アラート
準備状況スコアが閾値を下回った際のアラートを設定:エラーレスポンス
| ステータス | 説明 |
|---|---|
400 | 無効なリクエストパラメータ |
401 | APIキーが欠如または無効 |
500 | 内部サーバーエラー |
