Przejdź do nawigacji

Zaktualizuj gałąź agenta

Zaktualizuj właściwości gałęzi agenta, takie jak nazwa, opis, status archiwizacji, poziom ochrony i automatyczny rebase na main

Parametry ścieżki

agent_idstringWymagany
ID agenta. Jest zwracane przy tworzeniu agenta.
branch_idstringWymagany

Unikalny identyfikator gałęzi.

Nagłówki

xi-api-keystringOpcjonalny

Żądanie

This endpoint expects an object.
namestringOpcjonalny1-140 characters

Nowa nazwa gałęzi. Musi być unikalna w obrębie agenta.

descriptionstringOpcjonalny<=4096 characters

Nowy opis gałęzi. Przekaż pusty ciąg, aby go usunąć.

is_archivedbooleanOpcjonalny

Czy gałąź powinna zostać zarchiwizowana

protection_statusenumOpcjonalnyDomyślnie writer_perms_required

Poziom ochrony gałęzi

Dozwolone wartości:
auto_rebasebooleanOpcjonalny

Gdy ma wartość true, automatycznie wykonuje rebase tej gałęzi na main po każdej nowej wersji main. Nie można włączyć w głównej gałęzi.

Odpowiedź

Pomyślna odpowiedź

idstring
namestring
agent_idstring
descriptionstring
created_atinteger
last_committed_atinteger
is_archivedboolean
protection_statusenumOpcjonalnyDomyślnie writer_perms_required
Dozwolone wartości:
auto_rebasebooleanOpcjonalnyDomyślnie false
access_infoobjectOpcjonalny

Informacje o dostępie do gałęzi

current_live_percentagedoubleOpcjonalnyDomyślnie 0

Procent ruchu aktywnego na gałęzi

parent_branchobjectOpcjonalny

Gałąź nadrzędna gałęzi

most_recent_versionslist of objectsOpcjonalny

Najnowsze wersje w gałęzi

Błędy

422
Branches Update Request Unprocessable Entity Error