Skip to main content
PATCH
Atualizar o conteúdo, a posição, a origem e/ou as configurações de build de commit de um blueprint

Permissões

É necessário um usuário de serviço ou um token de acesso pessoal com a permissão ManageRepoBlueprints no nível da organização. Para criar ou atualizar blueprints em nível da organização, é necessária a permissão ManageOrgSnapshots.

Comportamento

Atualiza o conteúdo e/ou a posição de um blueprint. Não aciona automaticamente uma build.

Autorizações

Authorization
string
header
obrigatório

Credencial de usuário de serviço (prefixo: cog_)

Parâmetros de caminho

blueprint_id
string
obrigatório
org_id
string
obrigatório

ID da organização (prefixo: org-)

Exemplo:

"org-abc123def456"

Corpo

application/json

Atualização parcial de um Blueprint em nível da organização ou de nível de repo.

Qualquer subconjunto de campos pode ser fornecido. Os campos não definidos permanecem inalterados. Fornecer position, source ou uma configuração de build de commit em um Blueprint em nível da organização retorna 400 — apenas Blueprints de nível de repo têm esses campos. NÃO aciona um build.

build_on_default_branch_commit
boolean | null

Se definido, ativa ou desativa o build do ambiente a cada push para a branch padrão. Aceito apenas no blueprint raiz de um repositório do github.com. Cada push desse tipo coloca um build na fila.

contents
string | null

Se definido, substitui o corpo YAML do blueprint por uma nova versão.

position
integer | null

Se definido, atualiza a posição de execução deste blueprint de nível de repo. As posições não precisam ser exclusivas; em caso de empate, o servidor desempata arbitrariamente ao ordenar para execução.

report_check_runs
boolean | null

Se definido, ativa ou desativa o envio do resultado de cada build de commit como uma execução de verificação do GitHub. Para ativar essa opção, 'build_on_default_branch_commit' deve estar ativado.

source
enum<string> | null

Se definido, altera a origem do blueprint do repositório. Aceito apenas no blueprint raiz do repositório (blueprints com escopo definido herdam esse valor). 'git' obtém .devin/blueprint.yaml da branch padrão (404 se o arquivo não existir) e não pode ser combinado com 'contents'; 'database' mantém o YAML atual (ou 'contents', se fornecido) e interrompe a sincronização com o repositório. Não faz alterações se o blueprint já estiver nesse modo.

Opções disponíveis:
git,
database

Resposta

Resposta Bem-Sucedida

Formato do recurso público Blueprint.

Note: o enum type poderá ser expandido no futuro; os clientes DEVEM lidar corretamente com valores desconhecidos. O conteúdo YAML é obtido separadamente via GET /blueprints/{id}/contents.

blueprint_id
string
obrigatório
created_at
integer
obrigatório
repo_name
string | null
obrigatório
type
enum<string>
obrigatório
Opções disponíveis:
enterprise,
org,
repo
updated_at
integer
obrigatório
build_on_default_branch_commit
boolean | null

Indica se cada push para a branch padrão do repositório gera um build do ambiente. Null, a menos que este seja o blueprint raiz de um repositório.

report_check_runs
boolean | null

Indica se cada build de commit é registrado como uma execução de verificação do GitHub no commit. Null, a menos que este seja o blueprint raiz de um repositório.

source
enum<string> | null

Onde o YAML é criado: 'git' (sincronizado a partir de .devin/blueprint.yaml no repositório) ou 'database' (editado pela API/UI). Sempre null para blueprints em nível Enterprise ou da organização.

Opções disponíveis:
git,
database