Skip to main content
PATCH
Actualizar el contenido, la posición, el origen y/o la configuración de compilación al confirmar de un blueprint

Permisos

Requiere un usuario de servicio o un token de acceso personal con el permiso ManageRepoBlueprints a nivel de la organización. Para crear o actualizar blueprints de nivel de organización, se requiere el permiso ManageOrgSnapshots.

Comportamiento

Actualiza el contenido y/o la posición de un blueprint. No desencadena automáticamente una compilación.

Autorizaciones

Authorization
string
header
requerido

Credencial de usuario de servicio (prefijo: cog_)

Parámetros de ruta

blueprint_id
string
requerido
org_id
string
requerido

ID de organización (prefijo: org-)

Ejemplo:

"org-abc123def456"

Cuerpo

application/json

Actualización parcial de una plantilla a nivel de organización o de repo.

Se puede proporcionar cualquier subconjunto de campos. Los campos que no se especifiquen se dejan sin cambios. Proporcionar position, source o un ajuste de compilación por commit en una plantilla a nivel de organización devuelve 400 — solo las plantillas a nivel de repo tienen estos campos. NO activa una compilación.

build_on_default_branch_commit
boolean | null

Si se especifica, activa o desactiva la compilación del entorno con cada Push a la rama predeterminada. Solo se acepta en el blueprint raíz de un repositorio de github.com. Cada uno de estos Push añade una compilación a la cola.

contents
string | null

Si se especifica, reemplaza el cuerpo YAML del blueprint por una nueva versión.

position
integer | null

Si se especifica, actualiza la posición de ejecución de este blueprint de nivel de repo. No es necesario que las posiciones sean únicas; en caso de empate, el servidor lo resuelve de forma arbitraria al ordenarlas para la ejecución.

report_check_runs
boolean | null

Si se especifica, activa o desactiva la notificación de cada compilación por commit como una ejecución de comprobación de GitHub. Para habilitar esta opción, 'build_on_default_branch_commit' debe estar activado.

source
enum<string> | null

Si se establece, cambia el origen del blueprint del repositorio. Solo se acepta en el blueprint raíz del repositorio (los blueprints con un ámbito específico lo heredan). 'git' obtiene .devin/blueprint.yaml de la rama predeterminada (404 si el archivo no existe) y no puede combinarse con 'contents'; 'database' conserva el YAML actual (o 'contents', si se proporciona) y deja de sincronizarse con el repositorio. Es una operación sin efectos si el blueprint ya está en ese modo.

Opciones disponibles:
git,
database

Respuesta

Respuesta satisfactoria

Esquema público del recurso Blueprint.

Nota: el enum type puede ampliarse en el futuro; los clientes DEBEN manejar correctamente los valores desconocidos. El contenido YAML se obtiene por separado mediante GET /blueprints/{id}/contents.

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

Indica si cada Push a la rama predeterminada del repositorio compila el entorno. Null salvo que se trate del blueprint raíz de un repositorio.

report_check_runs
boolean | null

Indica si cada compilación de un commit se notifica como una ejecución de comprobación de GitHub asociada a ese commit. Null salvo que se trate del blueprint raíz de un repositorio.

source
enum<string> | null

Dónde se escribe el YAML: 'git' (sincronizado desde .devin/blueprint.yaml en el repositorio) o 'database' (editado mediante la API o la interfaz de usuario). Siempre es null para los blueprints de ámbito Enterprise y de organización.

Opciones disponibles:
git,
database