Skip to main content
PUT
リポジトリをインデックス化する

権限

サービスユーザーまたはパーソナルアクセストークンが必要です。権限チェックの方法は、組織でリポジトリアクセスをどのように管理しているかによって異なります。
  • 組織レベルの権限: 呼び出し元には、組織レベルの IndexOrgRepositories 権限が必要です。
  • リポジトリ単位の詳細な権限付与: IndexOrgRepositories はチェックされません。呼び出し元には、組織レベルの Read 権限に加えて、対象リポジトリに対する repo.use_read と repo.index の両方の権限付与が必要です。これらがない場合、リクエストは 403 で拒否されます。

挙動

このエンドポイントはべき等です。つまり、同じリポジトリに対して複数回呼び出しても、重複するインデックス作成ジョブは作成されません。指定したリポジトリに対するインデックス作成を有効化し、インデックス作成ジョブをトリガーします。 必要に応じて、リクエストボディでbranch_namesを指定すると、特定のブランチをインデックス作成できます。省略した場合は、デフォルトブランチが利用されます。

承認

Authorization
string
header
必須

サービスユーザーの認証情報(接頭辞: cog_)

パスパラメータ

repository_path
string
必須
org_id
string
必須

組織ID(プレフィックス:org-)

例:

"org-abc123def456"

ボディ

application/json
branch_names
string[]

レスポンス

成功レスポンス

branches
string[]
必須
indexing_enabled
boolean
必須
repository_path
string
必須
indexing_status
RepoIndexingStatusResponse · object | null