Skip to main content
PATCH
ブループリントの内容、位置、ソース、コミット-build 設定のいずれか、または複数を更新する

権限

組織レベルで ManageRepoBlueprints 権限を持つサービスユーザーまたはパーソナルアクセストークンが必要です。組織ティアのブループリントを作成または更新するには、ManageOrgSnapshots 権限が必要です。

動作

ブループリントの内容や位置を更新します。ビルドは自動ではトリガーされません。

承認

Authorization
string
header
必須

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

パスパラメータ

blueprint_id
string
必須
org_id
string
必須

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

例:

"org-abc123def456"

ボディ

application/json

org ティアまたはリポジトリレベルのブループリントの部分更新。

フィールドは任意の一部を指定できます。指定されていないフィールドはそのまま保持されます。 org ティアのブループリントで position、source またはコミット-build 設定を 指定すると 400 を返します。これらを持てるのはリポジトリレベルのブループリントのみです。 build はトリガーされません。

build_on_default_branch_commit
boolean | null

設定すると、デフォルトブランチへのプッシュごとに環境を build するかどうかを切り替えます。github.com リポジトリのルートブループリントでのみ指定できます。該当するプッシュのたびに build がキューに追加されます。

contents
string | null

設定されている場合、ブループリントの YAML 本文を新しいバージョンに置き換えます。

position
integer | null

設定されている場合、この repo ティアのブループリントの実行順を更新します。位置は一意である必要はありません。実行順に並べ替える際、同順位のものは server が任意に決定します。

report_check_runs
boolean | null

設定すると、各コミットの build を GitHub チェック run として報告するかどうかを切り替えます。有効にするには 'build_on_default_branch_commit' がオンになっている必要があります。

source
enum<string> | null

指定すると、リポジトリのブループリントのソースを切り替えます。リポジトリのルートブループリントでのみ指定できます(スコープ付きブループリントはこの設定を継承します)。'git' はデフォルトブランチから .devin/blueprint.yaml を取得し(存在しない場合は 404)、'contents' とは併用できません。'database' は現在の YAML('contents' が指定されている場合はその内容)を保持し、リポジトリからの同期を停止します。ブループリントがすでにそのモードの場合は no-op です。

利用可能なオプション:
git,
database

レスポンス

成功レスポンス

公開 Blueprint リソースの形式。

注: type 列挙型には今後値が追加される可能性があります。クライアントは未知の値を必ず適切に処理する必要があります。YAML内容は GET /blueprints/{id}/contents で別途取得します。

blueprint_id
string
必須
created_at
integer
必須
repo_name
string | null
必須
type
enum<string>
必須
利用可能なオプション:
enterprise,
org,
repo
updated_at
integer
必須
build_on_default_branch_commit
boolean | null

リポジトリのデフォルトブランチにプッシュされるたびに環境を build するかどうか。リポジトリのルートブループリントでない場合は Null。

report_check_runs
boolean | null

各コミットの build を、そのコミットの GitHub チェック run として報告するかどうか。リポジトリのルートブループリントでない場合は Null。

source
enum<string> | null

YAML の作成場所: 'git'(リポジトリ内の .devin/blueprint.yaml から同期)または 'database'(API/UI で編集)。Enterprise レベルおよび組織レベルのブループリントでは常に null です。

利用可能なオプション:
git,
database