Vai al contenuto principale
PATCH
/
v3beta1
/
organizations
/
{org_id}
/
snapshot-setup
/
blueprints
/
{blueprint_id}
Aggiornare il contenuto e/o la posizione di un blueprint
curl --request PATCH \
  --url https://api.devin.ai/v3beta1/organizations/{org_id}/snapshot-setup/blueprints/{blueprint_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contents": "<string>",
  "position": 123
}
'
import requests

url = "https://api.devin.ai/v3beta1/organizations/{org_id}/snapshot-setup/blueprints/{blueprint_id}"

payload = {
"contents": "<string>",
"position": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({contents: '<string>', position: 123})
};

fetch('https://api.devin.ai/v3beta1/organizations/{org_id}/snapshot-setup/blueprints/{blueprint_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.devin.ai/v3beta1/organizations/{org_id}/snapshot-setup/blueprints/{blueprint_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'contents' => '<string>',
'position' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.devin.ai/v3beta1/organizations/{org_id}/snapshot-setup/blueprints/{blueprint_id}"

payload := strings.NewReader("{\n \"contents\": \"<string>\",\n \"position\": 123\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://api.devin.ai/v3beta1/organizations/{org_id}/snapshot-setup/blueprints/{blueprint_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contents\": \"<string>\",\n \"position\": 123\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.devin.ai/v3beta1/organizations/{org_id}/snapshot-setup/blueprints/{blueprint_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contents\": \"<string>\",\n \"position\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "blueprint_id": "<string>",
  "created_at": 123,
  "repo_name": "<string>",
  "updated_at": 123
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Autorizzazioni

Richiede un utente di servizio con l’autorizzazione ManageRepoBlueprints a livello di organizzazione. Per creare o aggiornare blueprint a livello org è necessaria l’autorizzazione ManageOrgSnapshots.

Comportamento

Aggiorna il contenuto e/o la posizione di un blueprint. Non avvia automaticamente una build.

Autorizzazioni

Authorization
string
header
obbligatorio

Credenziale dell'utente del servizio (prefisso: cog_)

Parametri del percorso

blueprint_id
string
obbligatorio
org_id
string
obbligatorio

ID dell'organizzazione (prefisso: org-)

Esempio:

"org-abc123def456"

Corpo

application/json

Aggiornamento parziale per un blueprint a livello org o repo.

È possibile fornire qualsiasi sottoinsieme di campi. I campi non impostati restano invariati. Se si fornisce position per un blueprint a livello org, viene restituito 400: solo i blueprint a livello repo hanno una posizione. NON attiva una build.

contents
string | null

Se impostato, sostituisce il corpo YAML del blueprint con una nuova versione.

position
integer | null

Se impostato, aggiorna la posizione di esecuzione di questo blueprint di livello repo. Le posizioni non devono essere necessariamente univoche; in caso di parità, il server le risolve arbitrariamente durante l'ordinamento per l'esecuzione.

Risposta

Risposta riuscita

Forma pubblica della risorsa Blueprint.

Note: l'enum type potrebbe estendersi in futuro; i client DEVONO gestire correttamente i valori sconosciuti. Il contenuto YAML viene recuperato separatamente tramite GET /blueprints/{id}/contents.

blueprint_id
string
obbligatorio
created_at
integer
obbligatorio
repo_name
string | null
obbligatorio
type
enum<string>
obbligatorio
Opzioni disponibili:
enterprise,
org,
repo
updated_at
integer
obbligatorio