Skip to main content
PATCH
Mettre à jour le contenu, la position, la source et/ou les paramètres de build sur commit d’un blueprint

Autorisations

Requiert un utilisateur de service ou un jeton d’accès personnel disposant de l’autorisation ManageRepoBlueprints au niveau de l’organisation. La création ou la mise à jour de blueprints au niveau de l’organisation requiert l’autorisation ManageOrgSnapshots.

Comportement

Met à jour le contenu ou la position d’un blueprint, ou les deux. Ne déclenche pas automatiquement de build.

Autorisations

Authorization
string
header
requis

Identifiant de compte de service (préfixe : cog_)

Paramètres de chemin

blueprint_id
string
requis
org_id
string
requis

Identifiant d’organisation (préfixe : org-)

Exemple:

"org-abc123def456"

Corps

application/json

Mise à jour partielle d'un blueprint de niveau organisation ou dépôt.

N'importe quel sous-ensemble de champs peut être fourni. Les champs non renseignés restent inchangés. Fournir position, source ou un paramètre de build sur commit pour un blueprint de niveau organisation renvoie 400 — seuls les blueprints de niveau dépôt possèdent ces champs. Ne déclenche PAS de build.

build_on_default_branch_commit
boolean | null

Si ce champ est renseigné, active ou désactive le build de l’environnement à chaque push vers la branche par défaut. Accepté uniquement pour le plan de configuration racine d’un repo github.com. Chaque push de ce type met un build en file d’attente.

contents
string | null

S'il est renseigné, remplace le corps YAML du blueprint par une nouvelle version.

position
integer | null

S'il est renseigné, met à jour la position d'exécution de ce blueprint de niveau dépôt. Les positions n'ont pas besoin d'être uniques ; en cas d'égalité, le serveur les départage arbitrairement lors du tri pour l'exécution.

report_check_runs
boolean | null

Si ce champ est renseigné, active ou désactive la publication de chaque build de commit sous forme d’exécution de vérification GitHub. Pour l’activer, 'build_on_default_branch_commit' doit être activé.

source
enum<string> | null

Si ce champ est renseigné, change la source du blueprint du repo. Accepté uniquement pour le blueprint racine du repo (les blueprints à périmètre restreint en héritent). 'git' récupère .devin/blueprint.yaml depuis la branche par défaut (404 si le fichier est absent) et ne peut pas être combiné avec 'contents' ; 'database' conserve le YAML actuel (ou 'contents', si fourni) et arrête la synchronisation depuis le repo. Sans effet si le blueprint est déjà dans ce mode.

Options disponibles:
git,
database

Réponse

Réponse réussie

Schéma public de la ressource Blueprint.

Remarque : l’énumération type pourra être étendue à l’avenir ; les clients DOIVENT gérer correctement les valeurs inconnues. Le contenu YAML est récupéré séparément via GET /blueprints/{id}/contents.

blueprint_id
string
requis
created_at
integer
requis
repo_name
string | null
requis
type
enum<string>
requis
Options disponibles:
enterprise,
org,
repo
updated_at
integer
requis
build_on_default_branch_commit
boolean | null

Indique si chaque push vers la branche par défaut du repo déclenche un build de l’environnement. Valeur null sauf s’il s’agit du plan de configuration racine d’un repo.

report_check_runs
boolean | null

Indique si chaque build de commit est signalé sur le commit sous la forme d’une exécution de vérification GitHub. Valeur null sauf s’il s’agit du plan de configuration racine d’un repo.

source
enum<string> | null

Emplacement où le YAML est rédigé : 'git' (synchronisé depuis .devin/blueprint.yaml dans le repo) ou 'database' (modifié via l’API ou l’interface utilisateur). Toujours null pour les blueprints au niveau Enterprise ou organisation.

Options disponibles:
git,
database