Konfiguracja i branding
Na tej stronie
Prywatne dane uwierzytelniające przechowuj w konfiguracji backendu, a w konfiguracji frontendu umieszczaj wyłącznie wartości publiczne.
Korzystanie z narzędzi
- Najpierw wywołaj odpowiednie narzędzie do odczytu lub sprawdzania stanu.
- Sprawdź cel operacji i wymagane argumenty.
- Wykonaj jedną zamierzoną operację. Jeśli wymaga ona wyraźnego potwierdzenia przez człowieka, najpierw je uzyskaj.
- Następnie sprawdź stan lub ponownie odczytaj zasób, którego dotyczyła operacja.
Poniższe dane wejściowe opisują publiczny kontrakt. Wiążąca jest aktualna lista narzędzi podłączonego serwera. Niektóre narzędzia wymagają określonego hosta, lokalizacji projektu, trybu wnioskowania lub planu. Identyfikatory to wartości zwrócone przez wcześniej wywołane narzędzia; nie wymyślaj ich.
project_settings
Ustawienia projektu.
Odczytaj zwrócony zasób i zaplanuj następną czynność na podstawie jego aktualnych wartoś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
Zmień ustawienia projektu.
Odczytaj zwrócony zasób i zaplanuj następną czynność na podstawie jego aktualnych wartoś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
Ukryj lub pokaż oznaczenie platformy.
Możliwość korzystania z white-label zależy od uprawnień przyznanych w planie. Zachowaj wymagane informacje prawne i informacje o podmiotach 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.
Odczytaj zwrócony zasób i zaplanuj następną czynność na podstawie jego aktualnych wartoś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
Ustaw zmienne konfiguracyjne.
Prywatne dane uwierzytelniające umieszczaj w zmiennych konfiguracyjnych backendu. Wartości zmiennych frontendu mogą trafić do odwiedzających; nigdy nie umieszczaj 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
Znajdź zmienne zadeklarowane w kodzie źródłowym.
Po zmianach w kodzie źródłowym odświeża listę znanych zadeklarowanych zmiennych. Przed zastosowaniem konfiguracji sprawdź 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.
Odczytaj zwrócony zasób i zaplanuj następną czynność na podstawie jego aktualnych wartoś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
Zmień domyślne ustawienia brandingu organizacji.
Odczytaj zwrócony zasób i zaplanuj następną czynność na podstawie jego aktualnych wartoś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łnij puste ustawienia projektu wartościami domyślnymi.
Uzupełnia puste ustawienia brandingu projektu domyślnymi wartościami organizacji. Następnie sprawdź istniejące 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.