Konfiguracja i branding
Na tej stronie
Prywatne dane uwierzytelniające należy przechowywać w konfiguracji backendu, a w konfiguracji frontendu wyłącznie wartości publiczne.
Korzystanie z narzędzi
- Najpierw należy wywołać odpowiednie narzędzie do odczytu lub sprawdzania statusu.
- Sprawdzić cel operacji i wymagane argumenty.
- Wykonać jedną zamierzoną czynność. Jeśli wymaga ona wyraźnego potwierdzenia przez człowieka, uzyskać je przed jej wykonaniem.
- Następnie sprawdzić status lub ponownie odczytać zasób, którego dotyczyła operacja.
Poniższe dane wejściowe opisują publiczny kontrakt. Wiążąca jest aktualna lista narzędzi udostępniana przez podłączony serwer. Niektóre narzędzia wymagają określonego hosta, celu, trybu wnioskowania lub planu. Identyfikatory to wartości zwrócone przez wcześniej wywołane narzędzia; nie należy ich wymyślać.
project_settings
Ustawienia projektu.
Należy odczytać zwrócony zasób i uwzględnić jego aktualne wartości przy planowaniu następnej czynności.
| Argument | Wymagany | Typ lub dopuszczalne wartości |
|---|
| projectId | Nie | ciąg znaków |
| scope | Nie | ephemeral, production |
Operacja: tylko odczyt.
Dostępne konfiguracje: stdio, projekt w chmurze, wnioskowanie w chmurze; stdio, projekt w chmurze, delegowane wnioskowanie; stdio, projekt lokalny, wnioskowanie w chmurze; stdio, projekt lokalny, delegowane wnioskowanie; hostowany HTTP.
Kontrakty narzędzi w formacie do odczytu maszynowego zawierają zagnieżdżone schematy argumentów.
update_project_settings
Zmienia ustawienia projektu.
Należy odczytać zwrócony zasób i uwzględnić jego aktualne wartości przy planowaniu następnej czynności.
| Argument | Wymagany | Typ lub dopuszczalne wartości |
|---|
| projectId | Nie | ciąg znaków |
| copyright | Nie | ciąg znaków |
| organizationName | Nie | ciąg znaków |
| termsUrl | Nie | ciąg znaków |
| privacyUrl | Nie | ciąg znaków |
| googleTag | Nie | ciąg znaków |
| useOrganizationDefaults | Nie | wartość logiczna |
| scope | Nie | ephemeral, production |
Operacja: może zmienić stan lub rozpocząć pracę.
Dostępne konfiguracje: stdio, projekt w chmurze, wnioskowanie w chmurze; stdio, projekt w chmurze, delegowane wnioskowanie; stdio, projekt lokalny, wnioskowanie w chmurze; stdio, projekt lokalny, delegowane wnioskowanie; hostowany HTTP.
Kontrakty narzędzi w formacie do odczytu maszynowego zawierają zagnieżdżone schematy argumentów.
set_platform_credit
Ukrywa lub wyświetla oznaczenie platformy.
Możliwość korzystania z white-label zależy od uprawnień przyznanych w planie. Należy zachować wymagane informacje prawne i oznaczenia podmiotów trzecich.
| Argument | Wymagany | Typ lub dopuszczalne wartości |
|---|
| projectId | Nie | ciąg znaków |
| hidden | Tak | wartość logiczna |
| scope | Nie | ephemeral, production |
Operacja: może zmienić stan lub rozpocząć pracę.
Dostępne konfiguracje: stdio, projekt w chmurze, wnioskowanie w chmurze; stdio, projekt w chmurze, delegowane wnioskowanie; stdio, projekt lokalny, wnioskowanie w chmurze; stdio, projekt lokalny, delegowane wnioskowanie; hostowany HTTP.
Kontrakty narzędzi w formacie do odczytu maszynowego zawierają zagnieżdżone schematy argumentów.
project_configuration
Zmienne konfiguracyjne projektu.
Należy odczytać zwrócony zasób i uwzględnić jego aktualne wartości przy planowaniu następnej czynności.
| Argument | Wymagany | Typ lub dopuszczalne wartości |
|---|
| projectId | Nie | ciąg znaków |
| scope | Nie | ephemeral, production |
Operacja: tylko odczyt.
Dostępne konfiguracje: stdio, projekt w chmurze, wnioskowanie w chmurze; stdio, projekt w chmurze, delegowane wnioskowanie; stdio, projekt lokalny, wnioskowanie w chmurze; stdio, projekt lokalny, delegowane wnioskowanie; hostowany HTTP.
Kontrakty narzędzi w formacie do odczytu maszynowego zawierają zagnieżdżone schematy argumentów.
update_project_configuration
Ustawia zmienne konfiguracyjne.
Prywatne dane uwierzytelniające należy przechowywać w zmiennych konfiguracyjnych backendu. Wartości zmiennych frontendu mogą być dostępne dla odwiedzających; nigdy nie należy umieszczać w nich kluczy prywatnych.
| Argument | Wymagany | Typ lub dopuszczalne wartości |
|---|
| projectId | Nie | ciąg znaków |
| backend | Nie | obiekt |
| frontend | Nie | obiekt |
| scope | Nie | ephemeral, production |
Operacja: może zmienić stan lub rozpocząć pracę.
Dostępne konfiguracje: stdio, projekt w chmurze, wnioskowanie w chmurze; stdio, projekt w chmurze, delegowane wnioskowanie; stdio, projekt lokalny, wnioskowanie w chmurze; stdio, projekt lokalny, delegowane wnioskowanie; hostowany HTTP.
Kontrakty narzędzi w formacie do odczytu maszynowego zawierają zagnieżdżone schematy argumentów.
recollect_configuration
Wyszukuje zmienne zadeklarowane w kodzie źródłowym.
Po zmianach w kodzie źródłowym odświeża listę znanych zmiennych zadeklarowanych w kodzie. Przed zastosowaniem konfiguracji należy sprawdzić wartości.
| Argument | Wymagany | Typ lub dopuszczalne wartości |
|---|
| projectId | Nie | ciąg znaków |
Operacja: może zmienić stan lub rozpocząć pracę.
Dostępne konfiguracje: stdio, projekt w chmurze, wnioskowanie w chmurze; stdio, projekt w chmurze, delegowane wnioskowanie; stdio, projekt lokalny, wnioskowanie w chmurze; stdio, projekt lokalny, delegowane wnioskowanie; hostowany HTTP.
Kontrakty narzędzi w formacie do odczytu maszynowego zawierają zagnieżdżone schematy argumentów.
organization_branding
Domyślne ustawienia brandingu organizacji.
Należy odczytać zwrócony zasób i uwzględnić jego aktualne wartości przy planowaniu następnej czynności.
Argumenty: brak ({}).
Operacja: tylko odczyt.
Dostępne konfiguracje: stdio, projekt w chmurze, wnioskowanie w chmurze; stdio, projekt w chmurze, delegowane wnioskowanie; stdio, projekt lokalny, wnioskowanie w chmurze; stdio, projekt lokalny, delegowane wnioskowanie; hostowany HTTP.
Kontrakty narzędzi w formacie do odczytu maszynowego zawierają zagnieżdżone schematy argumentów.
update_organization_branding
Zmienia domyślne ustawienia brandingu organizacji.
Należy odczytać zwrócony zasób i uwzględnić jego aktualne wartości przy planowaniu następnej czynności.
| Argument | Wymagany | Typ lub dopuszczalne wartości |
|---|
| organizationName | Nie | ciąg znaków |
| copyright | Nie | ciąg znaków |
Operacja: może zmienić stan lub rozpocząć pracę.
Dostępne konfiguracje: stdio, projekt w chmurze, wnioskowanie w chmurze; stdio, projekt w chmurze, delegowane wnioskowanie; stdio, projekt lokalny, wnioskowanie w chmurze; stdio, projekt lokalny, delegowane wnioskowanie; hostowany HTTP.
Kontrakty narzędzi w formacie do odczytu maszynowego zawierają zagnieżdżone schematy argumentów.
backfill_project_branding
Uzupełnia puste ustawienia projektu wartościami domyślnymi.
Uzupełnia puste ustawienia brandingu projektu domyślnymi wartościami organizacji. Następnie należy sprawdzić wartości w projekcie.
Argumenty: brak ({}).
Operacja: może zmienić stan lub rozpocząć pracę.
Dostępne konfiguracje: stdio, projekt w chmurze, wnioskowanie w chmurze; stdio, projekt w chmurze, delegowane wnioskowanie; stdio, projekt lokalny, wnioskowanie w chmurze; stdio, projekt lokalny, delegowane wnioskowanie; hostowany HTTP.
Kontrakty narzędzi w formacie do odczytu maszynowego zawierają zagnieżdżone schematy argumentów.