Schemat protokołu komunikacyjnego demona działającego w tle Aggrega
Dokumentacja wygenerowana automatycznie. Nie należy jej edytować ręcznie — należy ją wygenerować ponownie z opublikowanego JSON Schema.
Identyfikator schematu: https://aggrega.ai/schemas/serve-wire-v1beta1.schema.json
Kształty komunikatów wymienianych z demonem kompilatora działającym w tle, uruchamianym poleceniem aggrega serve. Klient otwiera sesję z tym demonem za pomocą uzgadniania (handshake), a to sesja wyznacza zakres ustawień i przestrzeni roboczej, dla których otwarto komunikację; demon jest procesem, który odpowiada na żądanie, wysyła powiadomienie i przechowuje to, co odczytał. Protokół to JSON-RPC 2.0 przez standardowe wejście i wyjście, przy czym każdy komunikat jest opatrzony nagłówkiem Content-Length; ten dokument opisuje treść komunikatów, a nie ich ramkowanie ani transport. Treść komunikatu jest jedną z czterech rzeczy: żądaniem wysyłanym przez klienta, powiadomieniem wysyłanym przez klienta, powiadomieniem wysyłanym przez demona albo odpowiedzią zwracaną przez demona na żądanie. Trzy właściwości tego interfejsu decydują o tym, jak zapisano poniższe kształty. Po pierwsze, każde żądanie dopuszcza dwa pola poza tymi, które deklaruje jego własna metoda — workspaceRoot, wskazujące przestrzeń roboczą, na której działa żądanie, oraz workDoneToken, wartość utworzoną przez wywołującego, pod którą raportowany jest postęp — dlatego oba pojawiają się tu w każdym obiekcie parametrów żądania, także w trzech metodach, których przedmiotem nie jest przestrzeń robocza: aggrega/getSchema i aggrega/scaffoldEntity przyjmują workspaceRoot, ale je ignorują, a aggrega/initialize odczytuje je jako przestrzeń roboczą deklarowaną przez sesję. Po drugie, demon odrzuca obiekt parametrów żądania zawierający pole, którego metoda nie przyjmuje, podając, co przyjmuje, dlatego każdy obiekt parametrów jest tu zamknięty na najwyższym poziomie; obiekt zagnieżdżony w żądaniu nie jest zamknięty, ponieważ sprawdzenie odczytuje tylko nazwy pól najwyższego poziomu. Po trzecie, wynik jest tworzony przez demona, a nie dostarczany przez wywołującego, dlatego obiekty wyników są zamknięte na każdym poziomie o ustalonym kształcie i otwarte tylko tam, gdzie wartość jest nieprzezroczystym JSON-em, który demon przekazuje bez odczytywania. Jedna z konsekwencji sposobu kodowania przez demona jest widoczna w komunikacji i została opisana, a nie ukryta: kolekcja, której demon nie oznacza jako opcjonalnej, jest emitowana jako null, gdy nie ma wartości do zgłoszenia, oraz jako pusta kolekcja, gdy zgłaszana wartość jest pusta, dlatego tam, gdzie ma to zastosowanie, dopuszczone są obie formy.
Jeden z następujących kształtów
RequestClientNotificationDaemonNotificationSuccessResponseErrorResponse
Definicje
ProtocolVersion
Wersja JSON-RPC, którą niesie każdy komunikat. Obsługiwana jest tylko wersja 2.0.
Typ: const "2.0"
Stała: "2.0"
RequestId
Identyfikator żądania nadany przez wywołującego, powtarzany w odpowiedzi na to żądanie. Komunikat bez identyfikatora jest powiadomieniem i nigdy nie otrzymuje odpowiedzi.
Typ: string or number
ProgressToken
Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone.
Typ: string or number
WorkspaceRootSubject
Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone.
Typ: string
WorkspaceRootAccepted
Ścieżka bezwzględna obszaru roboczego. Przedmiotem tej metody nie jest obszar roboczy — odpowiada ona na podstawie tego, co zawiera sam plik binarny — więc pole jest akceptowane, ale nieodczytywane. Jest dopuszczone, ponieważ klient może wysyłać je jednolicie w każdym żądaniu, bez potrzeby wiedzy, które metody z niego korzystają.
Typ: string
RequestMethod
Każda metoda, którą może wskazać żądanie. Zbiór jest zamknięty: na żądanie wskazujące cokolwiek innego odpowiada się błędem method-not-found (nie znaleziono metody).
Typ: string (enum)
Dozwolone wartości: "aggrega/activeRelease", "aggrega/attachCandidates", "aggrega/attachmentContainer", "aggrega/build", "aggrega/buildPreview", "aggrega/cacheClear", "aggrega/cacheEvict", "aggrega/cachePrune", "aggrega/cacheStatus", "aggrega/catalogIndex", "aggrega/completion", "aggrega/configCapture", "aggrega/configInit", "aggrega/connectionAtPosition", "aggrega/connectionCandidates", "aggrega/deprecateArtifact", "aggrega/diagnostics", "aggrega/editDocument", "aggrega/effectiveConfiguration", "aggrega/entityDefinition", "aggrega/explainError", "aggrega/findImplementations", "aggrega/findReferences", "aggrega/getSchema", "aggrega/hover", "aggrega/import", "aggrega/initialize", "aggrega/insertionPoint", "aggrega/invalidate", "aggrega/irGraph", "aggrega/lint", "aggrega/logout", "aggrega/pin", "aggrega/pluginAdd", "aggrega/pluginGenCatalog", "aggrega/pluginRemove", "aggrega/pluginSync", "aggrega/publishArtifact", "aggrega/publishEntity", "aggrega/registryAdd", "aggrega/registryList", "aggrega/registryRemove", "aggrega/registryUpdate", "aggrega/releaseCandidates", "aggrega/releaseClosure", "aggrega/resolve", "aggrega/resolveDependencies", "aggrega/scaffoldEntity", "aggrega/search", "aggrega/setActiveRelease", "aggrega/signArtifacts", "aggrega/skillsInstall", "aggrega/skillsList", "aggrega/validate"
ClientNotificationMethod
Każda metoda, którą może wskazać powiadomienie klienta. Zbiór jest zamknięty i żadne z powiadomień nie otrzymuje odpowiedzi.
Typ: string (enum)
Dozwolone wartości: "$/cancelRequest", "aggrega/shutdown"
DaemonNotificationMethod
Każda metoda, którą może wskazać powiadomienie wysyłane przez demona. Zbiór jest zamknięty.
Typ: string (enum)
Dozwolone wartości: "$/progress", "aggrega/publishDiagnostics"
Request
Żądanie wysyłane przez klienta, na które odpowiada demon. Metoda określa, o co się prosi; obiekt params zawiera własne pola tej metody oraz dwa pola dopuszczane przez każdą metodę. Żądanie całkowicie pomijające params jest traktowane jak żądanie, w którym brakuje wszystkich pól.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
jsonrpc | ProtocolVersion | tak | Wersja JSON-RPC, którą niesie każdy komunikat. Obsługiwana jest tylko wersja 2.0. |
id | RequestId | tak | Identyfikator żądania nadany przez wywołującego, powtarzany w odpowiedzi na to żądanie. Komunikat bez identyfikatora jest powiadomieniem i nigdy nie otrzymuje odpowiedzi. |
method | RequestMethod | tak | Każda metoda, którą może wskazać żądanie. Zbiór jest zamknięty: na żądanie wskazujące cokolwiek innego odpowiada się błędem method-not-found (nie znaleziono metody). |
params | object | nie |
Dodatkowe właściwości są niedozwolone.
params dla każdej wartości method:
method | params | Wymagana |
|---|---|---|
"aggrega/initialize" | InitializeParams | nie |
"aggrega/validate" | ValidateParams | nie |
"aggrega/invalidate" | InvalidateParams | nie |
"aggrega/diagnostics" | DiagnosticsParams | nie |
"aggrega/irGraph" | IrGraphParams | nie |
"aggrega/build" | BuildParams | nie |
"aggrega/buildPreview" | BuildPreviewParams | nie |
"aggrega/entityDefinition" | EntityDefinitionParams | nie |
"aggrega/releaseClosure" | ReleaseClosureParams | nie |
"aggrega/resolveDependencies" | ResolveDependenciesParams | nie |
"aggrega/pin" | PinParams | nie |
"aggrega/cacheStatus" | WorkspaceAndProgressParams | nie |
"aggrega/cachePrune" | WorkspaceAndProgressParams | nie |
"aggrega/cacheEvict" | CacheEvictParams | nie |
"aggrega/cacheClear" | WorkspaceAndProgressParams | nie |
"aggrega/registryList" | WorkspaceAndProgressParams | nie |
"aggrega/search" | SearchParams | nie |
"aggrega/registryAdd" | RegistryAddParams | nie |
"aggrega/registryRemove" | RegistryRemoveParams | nie |
"aggrega/registryUpdate" | RegistryUpdateParams | nie |
"aggrega/logout" | LogoutParams | nie |
"aggrega/publishEntity" | PublishEntityParams | nie |
"aggrega/publishArtifact" | PublishArtifactParams | nie |
"aggrega/signArtifacts" | SignArtifactsParams | nie |
"aggrega/deprecateArtifact" | DeprecateArtifactParams | nie |
"aggrega/resolve" | ResolveParams | nie |
"aggrega/findReferences" | FindReferencesParams | nie |
"aggrega/findImplementations" | FindImplementationsParams | nie |
"aggrega/hover" | HoverParams | nie |
"aggrega/completion" | CompletionParams | nie |
"aggrega/catalogIndex" | CatalogIndexParams | nie |
"aggrega/attachCandidates" | AttachCandidatesParams | nie |
"aggrega/connectionCandidates" | ConnectionCandidatesParams | nie |
"aggrega/insertionPoint" | InsertionPointParams | nie |
"aggrega/attachmentContainer" | AttachmentContainerParams | nie |
"aggrega/connectionAtPosition" | ConnectionAtPositionParams | nie |
"aggrega/releaseCandidates" | WorkspaceAndProgressParams | nie |
"aggrega/activeRelease" | WorkspaceAndProgressParams | nie |
"aggrega/setActiveRelease" | SetActiveReleaseParams | nie |
"aggrega/editDocument" | EditDocumentParams | nie |
"aggrega/effectiveConfiguration" | WorkspaceAndProgressParams | nie |
"aggrega/configInit" | ConfigInitParams | nie |
"aggrega/configCapture" | ConfigCaptureParams | nie |
"aggrega/import" | ImportParams | nie |
"aggrega/scaffoldEntity" | ScaffoldEntityParams | nie |
"aggrega/lint" | LintParams | nie |
"aggrega/pluginAdd" | PluginAddParams | nie |
"aggrega/pluginRemove" | PluginRemoveParams | nie |
"aggrega/pluginSync" | PluginSyncParams | nie |
"aggrega/pluginGenCatalog" | PluginGenCatalogParams | nie |
"aggrega/explainError" | ExplainErrorParams | nie |
"aggrega/getSchema" | GetSchemaParams | nie |
"aggrega/skillsInstall" | SkillsInstallParams | nie |
"aggrega/skillsList" | WorkspaceAndProgressParams | nie |
ClientNotification
Powiadomienie wysyłane przez klienta. Nie zawiera identyfikatora i nigdy nie otrzymuje odpowiedzi.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
jsonrpc | ProtocolVersion | tak | Wersja JSON-RPC, którą niesie każdy komunikat. Obsługiwana jest tylko wersja 2.0. |
method | ClientNotificationMethod | tak | Każda metoda, którą może wskazać powiadomienie klienta. Zbiór jest zamknięty i żadne z powiadomień nie otrzymuje odpowiedzi. |
params | object | nie |
Dodatkowe właściwości są niedozwolone.
params dla każdej wartości method:
method | params | Wymagana |
|---|---|---|
"$/cancelRequest" | CancelRequestParams | tak |
"aggrega/shutdown" | ShutdownParams | nie |
DaemonNotification
Powiadomienie wysyłane przez demona. Nie zawiera identyfikatora i nigdy nie otrzymuje odpowiedzi.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
jsonrpc | ProtocolVersion | tak | Wersja JSON-RPC, którą niesie każdy komunikat. Obsługiwana jest tylko wersja 2.0. |
method | DaemonNotificationMethod | tak | Każda metoda, którą może wskazać powiadomienie wysyłane przez demona. Zbiór jest zamknięty. |
params | object | tak |
Dodatkowe właściwości są niedozwolone.
params dla każdej wartości method:
method | params | Wymagana |
|---|---|---|
"$/progress" | ProgressParams | tak |
"aggrega/publishDiagnostics" | PublishDiagnosticsParams | tak |
CancelRequestParams
Prosi demona o porzucenie żądania będącego już w toku, wskazując je identyfikatorem, który to żądanie zawierało. Żądanie już zakończone lub nigdy niewysłane po prostu nie ma czego anulować, bez komunikatu.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
id | RequestId | tak | Identyfikator żądania nadany przez wywołującego, powtarzany w odpowiedzi na to żądanie. Komunikat bez identyfikatora jest powiadomieniem i nigdy nie otrzymuje odpowiedzi. |
Dodatkowe właściwości są niedozwolone.
ShutdownParams
Prosi demona, aby przestał przyjmować pracę i dokończył to, co już przyjął. Powiadomienie nie zawiera pól i zwykle jest wysyłane w ogóle bez obiektu params. Drugie takie powiadomienie porzuca pracę wciąż w toku, zamiast na nią czekać.
Ten obiekt nie deklaruje stałych właściwości i nie dopuszcza żadnych.
ProgressParams
Jeden raport o postępie pracy, wysyłany tylko dla żądania, które utworzyło token postępu w sesji deklarującej, że może je odbierać.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
token | ProgressToken | tak | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
value | ProgressBegin lub ProgressReport lub ProgressEnd | tak | Sam raport. Jeden raport otwierający, następnie dowolna liczba wierszy, a potem jeden raport zamykający. |
Dodatkowe właściwości są niedozwolone.
ProgressBegin
Otwiera raport, podając, co się rozpoczęło, w kategoriach używanych przez samą operację.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
kind | const “begin” | tak | Oznacza ten ładunek jako otwarcie raportu. Stała: "begin" |
title | string | tak | Co się rozpoczęło. |
Dodatkowe właściwości są niedozwolone.
ProgressReport
Jeden wiersz relacji operacji o sobie samej. Nie zawiera ułamka: operacje raportujące tutaj przetwarzają zbiór, którego rozmiar nie jest znany w chwili rozpoczęcia pracy, więc ułamek trzeba by wymyślić.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
kind | const “report” | tak | Oznacza ten ładunek jako jeden wiersz otwartego raportu. Stała: "report" |
message | string | tak | Jeden wiersz własnego wyjścia operacji, z usuniętymi otaczającymi białymi znakami. |
Dodatkowe właściwości są niedozwolone.
ProgressEnd
Zamyka raport. Nie zawiera niczego poza rodzajem, ponieważ wynik przekazywany jest w odpowiedzi, na którą wywołujący już czeka.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
kind | const “end” | tak | Oznacza ten ładunek jako zamknięcie raportu. Stała: "end" |
Dodatkowe właściwości są niedozwolone.
PublishDiagnosticsParams
Ustalenia dotyczące jednego pliku, wypychane przez demona, gdy walidacja wygenerowała je dla dokumentu innego niż wskazany w żądaniu.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
file | string | tak | Plik, którego dotyczą ustalenia. |
diagnostics | Diagnostic[] lub null | tak | Ustalenia, w kolejności, w jakiej zostały wygenerowane. |
Dodatkowe właściwości są niedozwolone.
SuccessResponse
Odpowiedź na żądanie zakończone powodzeniem, zawierająca identyfikator żądania, na które odpowiada. Odpowiedź nie zawiera metody, więc to, który kształt wyniku obowiązuje, wynika z żądania, do którego należy identyfikator, a nie z czegokolwiek w samej odpowiedzi.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
jsonrpc | ProtocolVersion | tak | Wersja JSON-RPC, którą niesie każdy komunikat. Obsługiwana jest tylko wersja 2.0. |
id | RequestId | tak | Identyfikator żądania nadany przez wywołującego, powtarzany w odpowiedzi na to żądanie. Komunikat bez identyfikatora jest powiadomieniem i nigdy nie otrzymuje odpowiedzi. |
result | InitializeResult lub ValidateResult lub InvalidateResult lub DiagnosticsResult lub IrGraphResult lub BuildResult lub BuildPreviewResult lub EntityDefinitionResult lub ReleaseClosureResult lub ResolveDependenciesResult lub PinResult lub CacheStatusResult lub CachePruneResult lub CacheEvictResult lub CacheClearResult lub RegistryListResult lub SearchResult lub RegistryAddResult lub RegistryRemoveResult lub RegistryUpdateResult lub LogoutResult lub PublishEntityResult lub PublishArtifactResult lub SignArtifactsResult lub DeprecateArtifactResult lub ResolveResult lub FindReferencesResult lub FindImplementationsResult lub HoverResult lub CompletionResult lub CatalogIndexResult lub AttachCandidatesResult lub ConnectionCandidatesResult lub InsertionPointResult lub AttachmentContainerResult lub ConnectionAtPositionResult lub ReleaseCandidatesResult lub ActiveReleaseResult lub EditDocumentResult lub EffectiveConfigurationResult lub ConfigInitResult lub ConfigCaptureResult lub ImportResult lub ScaffoldEntityResult lub LintResult lub PluginAddResult lub PluginRemoveResult lub PluginSyncResult lub PluginGenCatalogResult lub ExplainErrorResult lub GetSchemaResult lub SkillsInstallResult lub SkillsListResult | tak | Odpowiedź, w kształcie zwracanym przez metodę, o którą poproszono. |
Dodatkowe właściwości są niedozwolone.
ErrorResponse
Odpowiedź na żądanie, które zostało odrzucone lub zakończyło się niepowodzeniem, zawierająca identyfikator żądania, na które odpowiada.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
jsonrpc | ProtocolVersion | tak | Wersja JSON-RPC, którą niesie każdy komunikat. Obsługiwana jest tylko wersja 2.0. |
id | RequestId | tak | Identyfikator żądania nadany przez wywołującego, powtarzany w odpowiedzi na to żądanie. Komunikat bez identyfikatora jest powiadomieniem i nigdy nie otrzymuje odpowiedzi. |
error | ErrorObject | tak | Co poszło nie tak: kod, na podstawie którego klient może rozgałęzić działanie, komunikat przeznaczony do czytania przez człowieka oraz — jeśli warunek je ma — artefakty i pozycja w źródle, do których odnosi się komunikat. |
Dodatkowe właściwości są niedozwolone.
ErrorObject
Co poszło nie tak: kod, na podstawie którego klient może rozgałęzić działanie, komunikat przeznaczony do czytania przez człowieka oraz — jeśli warunek je ma — artefakty i pozycja w źródle, do których odnosi się komunikat.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
code | ErrorCode | tak | Warunek zgłaszany przez odpowiedź. Kody ujemne to zarezerwowany zbiór samego protokołu; kody czterocyfrowe to warunki zgłaszane przez ten demon, z których każdy nazywa stan, na który klient może zareagować. Zbiór jest zamknięty. |
message | string | tak | Co poszło nie tak, opisane prozą. Jest to to samo sformułowanie, które ten sam warunek ma w każdym innym miejscu, które go zgłasza. |
data | ErrorData | nie | Artefakty i pozycja w źródle, do których odnosi się komunikat, przekazywane w sposób ustrukturyzowany, aby klient nie musiał wydobywać ich z prozy. Każde pole jest opcjonalne, a warunek wypełnia tylko to, czym dysponuje; żadne pole nie zastępuje innego, więc klient dowiaduje się, co otrzymał, z odczytanego pola, a nie z kodu obok niego. |
Dodatkowe właściwości są niedozwolone.
ErrorCode
Warunek zgłaszany przez odpowiedź. Kody ujemne to zarezerwowany zbiór samego protokołu; kody czterocyfrowe to warunki zgłaszane przez ten demon, z których każdy nazywa stan, na który klient może zareagować. Zbiór jest zamknięty.
Typ: const -32700 or const -32600 or const -32601 or const -32602 or const -32603 or const 1001 or const 1003 or const 1004 or const 1005 or const 1006
Dozwolone wartości:
-32700— Komunikatu nie udało się przetworzyć jako JSON.-32600— Komunikat został przetworzony, ale nie jest poprawnie zbudowanym żądaniem.-32601— Nie istnieje metoda o tej nazwie.-32602— Parametry przekazane w żądaniu są niedopuszczalne: pole, którego metoda nie przyjmuje, pole niewłaściwego typu lub wartość, którą metoda odrzuca.-32603— Demon zakończył się niepowodzeniem podczas wykonywania pracy.1001— Demon nie przechowuje odczytu pliku i żadnego nie tworzy. Klient inicjuje go, prosząc o walidację, a następnie ponawia próbę.1003— Brak pliku blokady dla encji Release wskazanej w żądaniu, a operacja go wymaga.1004— Encji wskazanej w żądaniu nie udało się rozwiązać ani z katalogu, ani z encji Release wskazanej w żądaniu.1005— Demon jest zamykany i odrzuca nową pracę. Klient nie ponawia próby względem tego samego demona.1006— Walidacja pliku jest właśnie wykonywana i nie zakończyła się w czasie, na jaki pozwalało oczekujące żądanie. Klient czeka i pyta ponownie, w międzyczasie niczego nie wysyłając.
ErrorData
Artefakty i pozycja w źródle, do których odnosi się komunikat, przekazywane w sposób ustrukturyzowany, aby klient nie musiał wydobywać ich z prozy. Każde pole jest opcjonalne, a warunek wypełnia tylko to, czym dysponuje; żadne pole nie zastępuje innego, więc klient dowiaduje się, co otrzymał, z odczytanego pola, a nie z kodu obok niego.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
file | string | nie | Dokument źródłowy, w którym pola pozycji wskazują miejsce — sprawdzany dokument lub encja Release, której wczytanie się nie powiodło. |
line | integer | nie | Wiersz, do którego odnosi się warunek, liczony od jedynki. |
column | integer | nie | Kolumna, do której odnosi się warunek, liczona od jedynki. |
end_line | integer | nie | Wiersz o jeden za końcem tokenu, do którego odnosi się warunek. Nieobecny, gdy nie da się ustalić końca tokenu; wtedy klient wyświetla pozycję jako punkt. |
end_column | integer | nie | Kolumna o jeden za końcem tokenu, do którego odnosi się warunek. |
release | string | nie | Encja Release, do której odnosi się warunek, zapisana tak, jak nazwało ją żądanie, aby klient mógł zbudować środek zaradczy bez jej ponownego składania. |
lockfile | string | nie | Plik blokady, którego dotyczy warunek związany z plikiem blokady: ścieżka, której szukano i nie znaleziono lub której nie dało się odczytać. |
unreachable | logiczna | nie | Czy odmowa dotyczy nazwanego w żądaniu rejestru, z którym nie udało się połączyć: jego nazwy nie udało się rozwiązać, połączenie z nim zostało odrzucone lub nie dało się go otworzyć albo nie udało się nawiązać z nim bezpiecznego połączenia. Wartość jest odczytywana z samego niepowodzenia, a nie z komunikatu, i jest ustawiana tylko wtedy, gdy niepowodzenie wskazuje, że rejestru nigdy nie osiągnięto. Ma ją odrzucone odświeżenie indeksu nazywające jeden rejestr; rejestr, który odpowiedział, niezależnie od treści odpowiedzi, pozostawia ją nieobecną. |
code | string | nie | Opisowa nazwa warunku wskazanego przez odmowę, stała między wydaniami: ta sama wartość, którą diagnostyka zgłaszająca ten warunek ma we własnym kodzie. To na jej podstawie klient rozgałęzia działanie, a nie na podstawie komunikatu ani kodu liczbowego obok, który nazywa stan żądania i pozostaje taki sam dla każdego warunku. Obecna dokładnie wtedy, gdy odmowa wskazuje zarejestrowany warunek, i nieobecna, gdy nie wskazuje żadnego. |
shortCode | string | nie | Krótki kod warunku, litera E i cztery cyfry: forma, którą czytelnik cytuje i wyszukuje, i ta, która otwiera komunikat odmowy wskazującej warunek. Obecny dokładnie wtedy, gdy obecne jest code. |
Dodatkowe właściwości są niedozwolone.
Diagnostic
Jedno ustalenie dotyczące jednego dokumentu: gdzie się znajduje, jak jest poważne, co mówi oraz cytowalny kod nazywający zgłaszany warunek.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
line | integer | tak | Wiersz, którego dotyczy ustalenie, liczony od jedynki. |
column | integer | tak | Kolumna, której dotyczy ustalenie, liczona od jedynki. |
severity | const “error” lub const “warning” lub const “info” | tak | Jak poważne jest ustalenie. Dozwolone wartości: "error" — Ustalenie jest błędem. Ustalenie wtyczki o poziomie halt jest zgłaszane na tym poziomie. "warning" — Ustalenie jest zgłaszane i nie jest błędem. Ustalenie wtyczki o poziomie warn jest zgłaszane na tym poziomie. "info" — Ustalenie ma charakter informacyjny, tak jak ustalenie wtyczki o poziomie info. |
message | string | tak | Co mówi ustalenie, opisane prozą. |
code | string | nie | Opisowa nazwa warunku, stała między wydaniami i możliwa do zacytowania w wyciszeniu. |
shortCode | string | nie | Krótki kod warunku, forma otwierająca diagnostykę przerywającą działanie. |
codeDescription | CodeDescription | nie | Gdzie wyjaśniono warunek wskazany przez ustalenie. |
classification | string | nie | W jaki sposób doszło do ustalenia, jeśli warunek to rozróżnia. |
suggest | string | nie | Pisownia proponowana przez ustalenie, jeśli warunek potrafi ją wskazać — na przykład przy niemal trafionym identyfikatorze. |
keyPath | string | nie | Ścieżka w dokumencie do klucza, którego dotyczy ustalenie. |
source | string | tak | Co wygenerowało ustalenie. |
end_line | integer | nie | Wiersz o jeden za końcem tokenu, którego dotyczy ustalenie, aby klient mógł wyświetlić cały token, a nie pojedynczy znak. Nieobecny dla tokenu rozciągającego się na kilka wierszy. |
end_column | integer | nie | Kolumna o jeden za końcem tokenu, którego dotyczy ustalenie. |
Dodatkowe właściwości są niedozwolone.
CodeDescription
Gdzie wyjaśniono warunek wskazany przez ustalenie.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
href | string | tak | Opublikowany adres, pod którym wyjaśniono warunek. |
Dodatkowe właściwości są niedozwolone.
Position
Miejsce w dokumencie: wiersz i przesunięcie znakowe w nim, oba liczone od zera. Przesunięcie jest mierzone w jednostkach kodowania ustalonego przy otwieraniu sesji, czyli UTF-16, chyba że klient poprosił o inne.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
line | integer | tak | Wiersz, liczony od zera. |
character | integer | tak | Przesunięcie w wierszu, liczone od zera, w jednostkach kodowania ustalonego dla sesji. |
Dodatkowe właściwości są niedozwolone.
Range
Zakres między dwoma miejscami w dokumencie.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
start | Position | tak | Miejsce w dokumencie: wiersz i przesunięcie znakowe w nim, oba liczone od zera. Przesunięcie jest mierzone w jednostkach kodowania ustalonego przy otwieraniu sesji, czyli UTF-16, chyba że klient poprosił o inne. |
end | Position | tak | Miejsce w dokumencie: wiersz i przesunięcie znakowe w nim, oba liczone od zera. Przesunięcie jest mierzone w jednostkach kodowania ustalonego przy otwieraniu sesji, czyli UTF-16, chyba że klient poprosił o inne. |
Dodatkowe właściwości są niedozwolone.
Location
Zakres w nazwanym dokumencie.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
uri | string | tak | Dokument, w którym znajduje się zakres, wskazany jako URI. |
range | Range | tak | Zakres między dwoma miejscami w dokumencie. |
Dodatkowe właściwości są niedozwolone.
WorkspaceAndProgressParams
Obiekt params metody, która nie deklaruje własnych pól. Nadal dopuszcza dwa pola dopuszczane przez każde żądanie: obszar roboczy, na którym działa, oraz token postępu.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
Dodatkowe właściwości są niedozwolone.
InitializeParams
Otwiera sesję nad obszarem roboczym i określa, co klient potrafi obsłużyć. To jedyna metoda, w której workspaceRoot jest deklaracją, a nie podmiotem: brak wartości, pusty ciąg i ścieżka to trzy różne rzeczy, a sesja otwarta bez ścieżki to sesja, której klient nie wskazał jeszcze obszaru roboczego.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
capabilities | ClientCapabilities | nie | Co klient potrafi obsłużyć. To, czego nie określono, jest traktowane jako nieobsługiwane. Nieznane elementy są ignorowane, a nie odrzucane, więc klient może określić możliwość, której ten demon jeszcze nie odczytuje. |
workspaceRoot | string | nie | Ścieżka bezwzględna obszaru roboczego do otwarcia. Brak wartości pozostawia sesję bez obszaru roboczego; pusty ciąg to ścieżka podana przez klienta i nie jest równoznaczny z niewysłaniem żadnej. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
Dodatkowe właściwości są niedozwolone.
ClientCapabilities
Co klient potrafi obsłużyć. To, czego nie określono, jest traktowane jako nieobsługiwane. Nieznane elementy są ignorowane, a nie odrzucane, więc klient może określić możliwość, której ten demon jeszcze nie odczytuje.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
general | object | nie | Możliwości niezwiązane z jednym rodzajem odpowiedzi. |
window | object | nie | Możliwości dotyczące tego, co klient potrafi wyświetlać w trakcie trwania pracy. |
Dodatkowe właściwości są dozwolone.
ClientCapabilities.general
Możliwości niezwiązane z jednym rodzajem odpowiedzi.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
positionEncodings | string[] | nie | Kodowania pozycji, które klient potrafi odczytać, od najlepszego. |
Dodatkowe właściwości są dozwolone.
ClientCapabilities.window
Możliwości dotyczące tego, co klient potrafi wyświetlać w trakcie trwania pracy.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workDoneProgress | logiczna | nie | Czy klient może odbierać powiadomienia o postępie. Żądanie, które tworzy token postępu w sesji, która tego nie zadeklarowała, jest odrzucane. |
Dodatkowe właściwości są dozwolone.
ValidateParams
Sprawdza obszar roboczy lub jeden dokument w nim i odpowiada wynikami.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
file | string | nie | Dokument do sprawdzenia. Przy braku wartości sprawdzana jest zawartość obszaru roboczego. |
content | string | nie | Tekst dokumentu w postaci, w jakiej klient obecnie go przechowuje, do sprawdzenia niezapisanego bufora. Przy braku wartości odczytywane są bajty z dysku. |
release | string | nie | Release, względem którego odbywa się sprawdzanie, jako ścieżka względna wobec katalogu głównego obszaru roboczego. |
Dodatkowe właściwości są niedozwolone.
InvalidateParams
Informuje demona, że dokument, którego odczyt przechowuje, uległ zmianie, więc następna odpowiedź na jego temat zostanie obliczona z nowych bajtów.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
file | string | nie | Dokument, który uległ zmianie. |
granularity | string | nie | Jak dużą część tego, co przechowuje demon, należy odrzucić: file odrzuca tylko to, co przechowuje dla wskazanego dokumentu; workspace, wartość domyślna i ta, jako którą odczytywana jest każda inna wartość, odrzuca także to, co przechowuje dla całej przestrzeni roboczej. |
Dodatkowe właściwości są niedozwolone.
DiagnosticsParams
Odpowiada wynikami, które demon już przechowuje dla dokumentu, bez ponownego sprawdzania go.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
file | string | nie | Dokument, którego dotyczy raport. Demon musi już przechowywać jego odczyt. |
Dodatkowe właściwości są niedozwolone.
IrGraphParams
Odpowiada rozwiązanym grafem, do którego kompiluje się encja Release, bez jego renderowania.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
release | string | nie | Release do rozwiązania, jako ścieżka względna wobec katalogu głównego obszaru roboczego. Ścieżka bezwzględna jest odrzucana. |
unredacted | logiczna | nie | Czy odpowiedzieć wartościami, które autor zadeklarował jako wrażliwe, w postaci jawnej. Przy braku wartości lub false każda z nich jest wstrzymywana w grafie, a w jej miejscu pojawia się znacznik podający przyczynę, tak jak wstrzymuje je wyjście grafu w wierszu poleceń; true daje w odpowiedzi graf w postaci, do której kompiluje się encja Release, łącznie z tymi wartościami. |
Dodatkowe właściwości są niedozwolone.
BuildParams
Kompiluje encję Release i zapisuje wyrenderowane artefakty w obszarze roboczym.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
release | string | nie | Release do zbudowania, jako ścieżka względna wobec katalogu głównego obszaru roboczego. Ścieżka bezwzględna jest odrzucana. |
outputParent | string | nie | Katalog, wewnątrz którego tworzony jest katalog wyjściowy, jako ścieżka względna wobec katalogu głównego obszaru roboczego. Artefakty trafiają do katalogu wyjściowego pod nim, rozmieszczone tak jak pod katalogiem głównym obszaru roboczego, gdy nic nie podano — wskazuje to więc katalog nadrzędny katalogu wyjściowego, a nigdy sam katalog wyjściowy. Brak wartości lub pusta wartość zapisuje katalog wyjściowy pod katalogiem głównym obszaru roboczego, tak jak robi to aggrega build niezależnie od miejsca uruchomienia. Ścieżka bezwzględna lub wychodząca poza obszar roboczy jest odrzucana. |
autoPull | logiczna | nie | Czy najpierw rozwiązać zależności encji Release. Zażądanie tego powoduje sięgnięcie do skonfigurowanych rejestrów i zapisanie pliku blokady; bez tego budowanie nie sięga do żadnego rejestru. |
policyInput | string | nie | Katalog, w którym obok artefaktów zapisywany jest ładunek przekazywany przez każdą rolę zarządzania dołączonej tam wtyczce, podany jako ścieżka względem katalogu głównego przestrzeni roboczej — pliki zapisywane przez aggrega build --policy-input, pod tymi samymi nazwami, zapisywane niezależnie od tego, czy kompilacja się zakończy, czy zatrzyma. Powiadomienia odpowiedzi podają, ile plików zapisano, i wskazują każdą rolę, dla której nie zapisano pliku. Gdy żądanie kończy się niepowodzeniem, zapisane pliki pozostają na dysku, a to zestawienie nie trafia do odpowiedzi: błąd zawiera wyłącznie odmowę. Brak wartości oznacza, że nic nie jest zapisywane. Ścieżka bezwzględna lub wychodząca poza przestrzeń roboczą jest odrzucana. |
Dodatkowe właściwości są niedozwolone.
BuildPreviewParams
Kompiluje encję Release i raportuje, co dałoby zapisanie artefaktów, nie zapisując żadnego z nich. Odrzuca pole rozwiązywania zależności, które przyjmuje budowanie zapisujące, ponieważ żądanie, które niczego nie zapisuje, nie może wypełnić pliku blokady.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
release | string | nie | Encja Release do skompilowania, jako ścieżka względna wobec katalogu głównego obszaru roboczego. |
autoPull | logiczna | nie | Przyjmowane w protokole i odrzucane przez metodę: to żądanie niczego nie zapisuje, więc nie może wypełnić pliku blokady i pozostać tym, za co się podaje. |
policyInput | string | nie | Katalog, w którym zapisywany jest ładunek przekazywany przez każdą rolę zarządzania dołączonej tam wtyczce, podany jako ścieżka względem katalogu głównego przestrzeni roboczej — pliki zapisywane przez aggrega build --dry-run --policy-input, pod tymi samymi nazwami. Jeśli wartość zostanie podana, są one jedyną rzeczą, jaką zapisuje to żądanie; katalog wyjściowy i plik blokady pozostają nietknięte. Powiadomienia odpowiedzi podają, ile plików zapisano, i wskazują każdą rolę, dla której nie zapisano pliku. Gdy żądanie kończy się niepowodzeniem, zapisane pliki pozostają na dysku, a to zestawienie nie trafia do odpowiedzi: błąd zawiera wyłącznie odmowę. Ścieżka bezwzględna lub wychodząca poza przestrzeń roboczą jest odrzucana. |
Dodatkowe właściwości są niedozwolone.
EntityDefinitionParams
Odpowiada informacją, na co rozwiązuje się jedna nazwa encji i gdzie znajduje się definiujący ją dokument.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
name | string | nie | Encja do rozwiązania, według nazwy — lub odwołanie do rejestru, oci://<host>/<repository>:<tag> albo @<digest> zamiast :<tag>, aby odczytać encję opublikowaną pod tą współrzędną. |
release | string | nie | Encja Release, w kontekście której rozwiązywana jest nazwa, jako ścieżka względna wobec katalogu głównego obszaru roboczego. Nazwa jest wtedy rozwiązywana przez katalogi katalogu encji, które konfiguracja obszaru roboczego przypisuje tej encji Release, więc nazwa deklarowana przez kilka wariantów w jednym obszarze roboczym, po jednym na każdą encję Release, rozwiązuje się na wariant, z którym buduje ta encja Release, a nazwa, której nie rozwiązuje, jest odrzucana z wyjaśnieniem wskazującym wpis tej encji Release w workspace.releases. Gdy brak wartości, nazwa jest rozwiązywana w obrębie własnych katalogów katalogu encji obszaru roboczego. Odwołanie do rejestru nie przyjmuje encji Release i jest z nią odrzucane, podobnie jak wartość, która nie wskazuje żadnego pliku Release. |
Dodatkowe właściwości są niedozwolone.
CatalogIndexParams
Odpowiada listą encji, które zawiera obszar roboczy: każdej encji deklarowanej przez jego dokumenty oraz encji Features deklarowanych przez jego katalogi katalogu encji.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
release | string | nie | Encja Release, w kontekście której wymieniane są encje, jako ścieżka względna wobec katalogu głównego obszaru roboczego. Encje Features są wtedy tymi, które deklarują katalogi katalogu encji przypisane tej encji Release przez konfigurację obszaru roboczego, a dokument w katalogu czytanym tylko przez inne encje Releases jest pomijany, więc obszar roboczy przechowujący obok siebie warianty jednej encji, po jednym na każdą encję Release, jest wymieniany z wariantem, z którym buduje ta encja Release. Gdy brak wartości, lista dotyczy samego obszaru roboczego. Wartość, która nie wskazuje żadnego pliku Release, jest odrzucana. |
Dodatkowe właściwości są niedozwolone.
ReleaseClosureParams
Odpowiada wszystkim, od czego zależy encja Release, w takim zakresie, w jakim dotarło do tego rozwiązywanie.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
release | string | nie | Encja Release do zbadania, jako ścieżka względna wobec katalogu głównego obszaru roboczego. |
Dodatkowe właściwości są niedozwolone.
ResolveDependenciesParams
Rozwiązuje zależności encji Release, przypinając je w pliku blokady i pobierając zewnętrzne dane wejściowe, które zużywa jej renderowanie. Łączy się ze skonfigurowanymi rejestrami i zapisuje.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
release | string | nie | Encja Release do rozwiązania, jako ścieżka względna wobec katalogu głównego obszaru roboczego. |
upgrade | logiczna | nie | Czy rozwiązać ponownie w obrębie zadeklarowanych zakresów zamiast respektować to, co plik blokady już przypina. |
targets | string[] | nie | Odwołania do ponownego rozwiązania; pozostałe zostają przypięte bez zmian. Pusta lista rozwiązuje wszystko. |
verify | logiczna | nie | Czy porównać zapisany plik blokady z rozwiązaniem, które to żądanie wykonałoby bez niego, respektując przypięcia, które to żądanie by respektowało, zamiast go zapisywać. Weryfikacja nie zapisuje pliku blokady, rekordu zaufania wtyczek ani entity.lock; pamięć podręczna treści jest odczytywana i wypełniana tak, jak odczytywałoby i wypełniało ją to rozwiązanie. Rozbieżność oraz brak pliku blokady kończą żądanie niepowodzeniem. Nie można tego łączyć z upgrade, targets ani pinSources, niezależnie od wartości pinSources: żądanie wysyłające którekolwiek z nich obok tej opcji jest odrzucane jako mające nieprawidłowe parametry, zanim cokolwiek zostanie rozwiązane. |
pinSources | logiczna | nie | Czy wykonać krok przypinania, który wykonuje aggrega/pin, na encjach Recipes i FeatureRecipes budowanych przez encję Release z katalogów katalogu encji obszaru roboczego, zapisując entity.lock obok każdej z nich, zamiast odrzucać żądanie z powodu encji, której blokada nie zawiera przypięcia potrzebnego danym wejściowym. Gdy brak wartości, obowiązuje ustawienie pin_sources_at_pull obszaru roboczego; każda z wartości nadpisuje to ustawienie dla tego żądania. |
Dodatkowe właściwości są niedozwolone.
PinParams
Zapisuje w pliku entity.lock obok encji Recipe lub FeatureRecipe przypięcie treści dla każdego wejścia, które encja odczytuje spoza własnego dokumentu. Nie wskazuje się żadnej encji Release: wejście, którego tożsamość encja zapisuje w pełni, wskazuje jeden artefakt dla każdej encji Release używającej tej encji, więc do jego przypięcia nie jest potrzebne nic, co dostarcza Release. Żądanie łączy się z hostami wskazanymi przez źródła encji i zapisuje obok encji; sam dokument encji nigdy nie jest zapisywany.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
entity | string | nie | Dokument encji do przypięcia, jako ścieżka względna wobec katalogu głównego obszaru roboczego. |
dryRun | logiczna | nie | Czy odpowiedzieć blokadą, którą zapisałby ten krok, zamiast ją zapisywać. Wejścia są nadal rozwiązywane, więc pamięć podręczna treści nadal się zapełnia. |
Dodatkowe właściwości są niedozwolone.
CacheEvictParams
Odzyskuje miejsce zajęte przez treść w pamięci podręcznej, dopóki pozostała treść nie zmieści się w rozmiarze wskazanym w żądaniu.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
maxSize | string | nie | Rozmiar, do którego należy zmniejszyć pamięć podręczną, zapisany tak, jak zapisuje go człowiek — na przykład 500MB. |
Dodatkowe właściwości są niedozwolone.
SearchParams
Przeszukuje to, co oferują lokalne indeksy skonfigurowanych rejestrów. Odczytuje indeks znajdujący się już na dysku i nie łączy się z żadnym rejestrem.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
query | string | nie | Tekst dopasowywany do nazwy i opisu rekordu. |
kinds | string[] | nie | Rodzaje encji do zachowania. Pusta lista zachowuje wszystkie rodzaje. |
selector | string | nie | Selektor etykiet, który muszą spełniać zachowane rekordy. |
capabilities | string[] | nie | Możliwości, które musi deklarować zachowany rekord pluginu. |
pluginType | string | nie | Typ pluginu do zachowania. |
registry | string | nie | Jedyny host rejestru do przeszukania. Brak wartości oznacza przeszukanie każdego skonfigurowanego hosta. |
limit | integer | nie | Maksymalna liczba rekordów w odpowiedzi. |
includeRetracted | logiczna | nie | Czy zachować wersje oznaczone jako przestarzałe przez opublikowany znacznik. |
Dodatkowe właściwości są niedozwolone.
RegistryAddParams
Rejestruje rejestr oraz politykę zaufania, którą rozwiązywanie stosuje do tego, co rejestr udostępnia. Zapisuje plik konfiguracji obowiązujący na całej maszynie, chyba że żądanie wskazuje inaczej, więc każdy obszar roboczy na maszynie rozwiązuje zależności przez ten wpis.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
host | string | nie | Host rejestru do zarejestrowania. |
name | string | nie | Przyjazny alias wskazujący na host. |
identities | string[] | nie | Tożsamości podpisujące uznawane za zaufane dla tego, co udostępnia ten rejestr. |
keyPath | string | nie | Ścieżka klucza publicznego uznawanego za zaufany, dla rejestru podpisywanego takim kluczem zamiast tożsamością bezkluczową. |
trustedRoot | string | nie | Ścieżka kotwicy zaufania, względem której weryfikowane są podpisy. |
requireSignatures | logiczna | nie | Czy artefakt z tego rejestru musi mieć zweryfikowany podpis. Brak wartości niczego nie określa i pozostawia rozwiązaną wartość domyślną. |
advisory | logiczna | nie | Czy nieudana weryfikacja jest zgłaszana zamiast przerywać działanie. |
fetchTrust | logiczna | nie | Czy odczytać politykę zaufania ogłaszaną przez rejestr i ją przypiąć. Brak wartości niczego nie określa i pozostawia rozwiązaną wartość domyślną. |
global | logiczna | nie | Zapisz plik konfiguracji obowiązujący na całej maszynie, co jest domyślnym zachowaniem tej metody. |
workspace | logiczna | nie | Zapisz własny plik konfiguracji tego obszaru roboczego zamiast pliku obowiązującego na całej maszynie. |
Dodatkowe właściwości są niedozwolone.
RegistryRemoveParams
Usuwa zarejestrowany rejestr. Zapisuje plik konfiguracji obowiązujący na całej maszynie, chyba że żądanie wskazuje inaczej.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
registry | string | nie | Rejestr do usunięcia, wskazany przez host lub alias. |
global | logiczna | nie | Zapisz plik konfiguracji obowiązujący na całej maszynie, co jest domyślnym zachowaniem tej metody. |
workspace | logiczna | nie | Zapisz własny plik konfiguracji tego obszaru roboczego zamiast pliku obowiązującego na całej maszynie. |
Dodatkowe właściwości są niedozwolone.
RegistryUpdateParams
Odświeża lokalny indeks odczytywany przez wyszukiwanie, łącząc się w tym celu z rejestrem. Zapisywany jest indeks w katalogu pamięci podręcznej skonfigurowanym dla tego obszaru roboczego. Rejestr wymagający poświadczenia, którego nie zapewnia żadne źródło w otoczeniu, jest odrzucany ze wskazaniem tego poświadczenia, zamiast monitować o nie.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
registry | string | nie | Jedyny rejestr do odświeżenia. Brak wartości oznacza odświeżenie każdego skonfigurowanego hosta. |
upgrade | logiczna | nie | Czy przebudować indeks zamiast uzupełniać to, co już zawiera. |
Dodatkowe właściwości są niedozwolone.
LogoutParams
Usuwa zapisane poświadczenie rejestru. Magazyn jest współdzielony przez wszystkie projekty na maszynie i odpowiedź o tym informuje.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
registry | string | nie | Rejestr, którego zapisane poświadczenie ma zostać usunięte. |
Dodatkowe właściwości są niedozwolone.
PublishEntityParams
Publikuje encję w rejestrze. To, co zostanie opublikowane, rozwiązuje każdy konsument tego rejestru, a opublikowanej wersji nie można wycofać od nikogo, kto już ją pobrał. Nic nie jest pobierane interaktywnie: tożsamość jest ustalana na podstawie tego, co dostarczyło żądanie, lub tego, co już zawiera środowisko.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
entity | string | nie | Dokument encji do opublikowania, jako ścieżka względna wobec katalogu głównego obszaru roboczego. |
registry | string | nie | Rejestr docelowy publikacji. Brak oznacza użycie skonfigurowanego rejestru domyślnego. |
dryRun | logiczna | nie | Czy zgłosić, co publikacja by umieściła, bez umieszczania tego. |
sign | logiczna | nie | Czy podpisać to, co jest publikowane. Brak niczego nie określa i pozostawia ustaloną wartość domyślną. |
plugin | string | nie | Moduł wtyczki publikowany razem z encją Plugin. |
fulcioUrl | string | nie | Urząd certyfikacji, od którego należy uzyskać certyfikat podpisujący. |
rekorUrl | string | nie | Dziennik przejrzystości, w którym należy zarejestrować podpis. |
timestampUrl | string | nie | Urząd znacznika czasu, którym należy kontrasygnować podpis. |
identityToken | string | nie | Token tożsamości używany do podpisu, dostarczony przez wywołującego zamiast uzyskiwany w terminalu. |
pinSources | logiczna | nie | Czy przed spakowaniem encji uruchomić na niej krok przypinania wykonywany przez aggrega/pin, tak aby plik entity.lock zapisany przez ten krok obok encji wchodził w skład publikacji. Krok jest wykonywany przed każdą odmową oceniającą encję, a w trybie dryRun zgłasza blokadę, którą by zapisał, i niczego nie zapisuje. Brak oznacza zastosowanie ustawienia pin_sources_at_push obszaru roboczego; każda z wartości nadpisuje to ustawienie dla tego żądania. |
Dodatkowe właściwości są niedozwolone.
PublishArtifactParams
Publikuje dowolny plik w rejestrze pod nazwą i tagiem podanymi w żądaniu.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
file | string | nie | Plik do opublikowania, jako ścieżka względna wobec katalogu głównego obszaru roboczego. |
name | string | nie | Nazwa repozytorium, pod którą odbywa się publikacja. |
tag | string | nie | Tag, pod którym odbywa się publikacja. |
mediaType | string | nie | Typ nośnika zapisywany dla opublikowanych bajtów. |
registry | string | nie | Rejestr docelowy publikacji. Brak oznacza użycie skonfigurowanego rejestru domyślnego. |
dryRun | logiczna | nie | Czy zgłosić, co publikacja by umieściła, bez umieszczania tego. |
Dodatkowe właściwości są niedozwolone.
SignArtifactsParams
Podpisuje to, co już zostało opublikowane. Podpisu nie można wycofać od nikogo, kto już go pobrał.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
references | string[] | nie | Opublikowane odwołania do podpisania. |
fulcioUrl | string | nie | Urząd certyfikacji, od którego należy uzyskać certyfikat podpisujący. |
rekorUrl | string | nie | Dziennik przejrzystości, w którym należy zarejestrować podpis. |
timestampUrl | string | nie | Urząd znacznika czasu, którym należy kontrasygnować podpis. |
identityToken | string | nie | Token tożsamości używany do podpisu, dostarczony przez wywołującego zamiast uzyskiwany w terminalu. |
jobs | integer | nie | Ile odwołań jest podpisywanych jednocześnie. Brak wartości oznacza podpisywanie jednego po drugim. Każde odwołanie jest nadal podpisywane dokładnie tak, jak byłoby podpisane osobno — w trybie bezkluczowym z własnym certyfikatem i własnym wpisem w dzienniku przejrzystości — a odpowiedź zachowuje kolejność, w jakiej podano odwołania. Minimum: 1. |
Dodatkowe właściwości są niedozwolone.
DeprecateArtifactParams
Oznacza opublikowaną wersję jako przestarzałą, aby rozwiązywanie mogło ją zgłosić lub odrzucić. Sam znacznik jest również publikowany i podpisywany. Żądanie przesyła albo jedno odwołanie wraz z jego treścią, albo plik wsadowy, którego wpisy zawierają własną — nigdy oba naraz i nigdy treści obok pliku wsadowego.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
reference | string | nie | Opublikowane odwołanie do oznaczenia. Alternatywa dla from: żądanie zawierające oba jest odrzucane. |
severity | const “warning” lub const “error” lub const “retracted” | nie | Jak mocno działa znacznik — czy rozwiązywanie zgłasza wersję, czy ją odrzuca. Wymagane z reference; odrzucane obok from, którego plik wsadowy zawiera własną wartość dla każdego znacznika. Dozwolone wartości: "warning" — Wycofana, na łagodniejszym z dwóch poziomów doradczych: nadal wybierana przy wyborze wersji. "error" — Wycofana, na silniejszym z dwóch poziomów doradczych: nadal wybierana przy wyborze wersji. "retracted" — Wycofana z użycia: wykluczana przy wyborze wersji. |
reason | string | nie | Powód, dla którego wersja jest przestarzała. Wymagane z reference; odrzucane obok from, którego plik wsadowy zawiera własną wartość dla każdego znacznika. |
replacement | string | nie | Odwołanie, którego należy użyć zamiast niej. Odrzucane obok from, którego plik wsadowy zawiera własną wartość dla każdego znacznika. |
message | string | nie | Komunikat przekazywany konsumentowi, który napotka znacznik. Odrzucane obok from, którego plik wsadowy zawiera własną wartość dla każdego znacznika. |
from | string | nie | Plik wsadowy z wpisami wycofania, jako ścieżka względna wobec katalogu głównego obszaru roboczego, dołączający jeden znacznik na wpis. Każdy wpis zawiera własne odwołanie, poziom ważności i powód oraz opcjonalnie zamiennik i komunikat. Alternatywa dla reference: żądanie zawierające oba albo zawierające obok niego poziom ważności, powód, zamiennik lub komunikat jest odrzucane. |
fulcioUrl | string | nie | Urząd certyfikacji, od którego należy uzyskać certyfikat podpisujący. |
rekorUrl | string | nie | Dziennik przejrzystości, w którym należy zarejestrować podpis. |
timestampUrl | string | nie | Urząd znacznika czasu, którym należy kontrasygnować podpis. |
identityToken | string | nie | Token tożsamości używany do podpisu, dostarczony przez wywołującego zamiast uzyskiwany w terminalu. |
Dodatkowe właściwości są niedozwolone.
ResolveParams
Odpowiada, gdzie zdefiniowany jest element pod kursorem.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
uri | string | nie | Dokument, w którym znajduje się kursor. |
position | Position | nie | Miejsce w dokumencie: wiersz i przesunięcie znakowe w nim, oba liczone od zera. Przesunięcie jest mierzone w jednostkach kodowania ustalonego przy otwieraniu sesji, czyli UTF-16, chyba że klient poprosił o inne. |
release | string | nie | Encja Release, w kategoriach której należy udzielić odpowiedzi, jako ścieżka względna wobec katalogu głównego obszaru roboczego. Definicją jest wtedy dokument, do którego odwołanie rozwiązuje się poprzez katalogi katalogowe, które konfiguracja obszaru roboczego przypisuje tej encji Release, w tej kolejności, więc nazwa deklarowana przez kilka wariantów w jednym obszarze roboczym, po jednym na każdą encję Release, prowadzi do wariantu tej encji Release; gdy te katalogi nie deklarują takiej encji, przeszukiwane są dokumenty obszaru roboczego z pominięciem tych, które leżą w którymś z katalogów katalogowych obszaru roboczego nieodczytywanych przez tę encję Release. W razie braku wartości najpierw przeszukiwane są dokumenty obszaru roboczego, a własne katalogi katalogowe obszaru roboczego tylko wtedy, gdy żaden dokument nie deklaruje tej nazwy. Wartość, która nie wskazuje żadnego pliku Release, jest odrzucana. |
Dodatkowe właściwości są niedozwolone.
FindReferencesParams
Odpowiada, gdzie występują odwołania do elementu pod kursorem.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
uri | string | nie | Dokument, w którym znajduje się kursor. |
position | Position | nie | Miejsce w dokumencie: wiersz i przesunięcie znakowe w nim, oba liczone od zera. Przesunięcie jest mierzone w jednostkach kodowania ustalonego przy otwieraniu sesji, czyli UTF-16, chyba że klient poprosił o inne. |
release | string | nie | Encja Release, w kategoriach której należy udzielić odpowiedzi, jako ścieżka względna wobec katalogu głównego obszaru roboczego. Odwołanie z dokumentu leżącego w którymś z katalogów katalogowych obszaru roboczego nieodczytywanych przez tę encję Release nie jest wtedy zgłaszane, więc warianty utrzymywane obok siebie w obszarze roboczym, po jednym na każdą encję Release, nigdy nie są zgłaszane jako wzajemne odwołania. W razie braku wartości przeszukiwany jest każdy dokument obszaru roboczego. Wartość, która nie wskazuje żadnego pliku Release, jest odrzucana. |
Dodatkowe właściwości są niedozwolone.
FindImplementationsParams
Odpowiada, które dokumenty implementują element pod kursorem.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
uri | string | nie | Dokument, w którym znajduje się kursor. |
position | Position | nie | Miejsce w dokumencie: wiersz i przesunięcie znakowe w nim, oba liczone od zera. Przesunięcie jest mierzone w jednostkach kodowania ustalonego przy otwieraniu sesji, czyli UTF-16, chyba że klient poprosił o inne. |
release | string | nie | Encja Release, w kategoriach której należy udzielić odpowiedzi, jako ścieżka względna wobec katalogu głównego obszaru roboczego. Dokument leżący w którymś z katalogów katalogowych obszaru roboczego nieodczytywanych przez tę encję Release nie jest wtedy zgłaszany, więc wariant, z którym buduje inna encja Release, nigdy nie trafia na listę wariantów tej encji Release. W razie braku wartości przeszukiwany jest każdy dokument obszaru roboczego. Wartość, która nie wskazuje żadnego pliku Release, jest odrzucana. |
Dodatkowe właściwości są niedozwolone.
HoverParams
Odpowiada informacjami do wyświetlenia o elemencie pod kursorem.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
uri | string | nie | Dokument, w którym znajduje się kursor. |
position | Position | nie | Miejsce w dokumencie: wiersz i przesunięcie znakowe w nim, oba liczone od zera. Przesunięcie jest mierzone w jednostkach kodowania ustalonego przy otwieraniu sesji, czyli UTF-16, chyba że klient poprosił o inne. |
release | string | nie | Encja Release, w kategoriach której należy udzielić odpowiedzi, jako ścieżka względna wobec katalogu głównego obszaru roboczego. Wyświetlana jest wtedy encja, do której odwołanie rozwiązuje się poprzez katalogi katalogowe, które konfiguracja obszaru roboczego przypisuje tej encji Release, w tej kolejności; gdy te katalogi nie deklarują takiej encji, przeszukiwane są dokumenty obszaru roboczego z pominięciem tych, które leżą w którymś z katalogów katalogowych obszaru roboczego nieodczytywanych przez tę encję Release. W razie braku wartości najpierw przeszukiwane są dokumenty obszaru roboczego, a własne katalogi katalogowe obszaru roboczego tylko wtedy, gdy żaden dokument nie deklaruje tej nazwy. Wartość, która nie wskazuje żadnego pliku Release, jest odrzucana. |
Dodatkowe właściwości są niedozwolone.
CompletionParams
Odpowiada, co można wpisać w miejscu kursora.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
uri | string | nie | Dokument, w którym znajduje się kursor. |
position | Position | nie | Miejsce w dokumencie: wiersz i przesunięcie znakowe w nim, oba liczone od zera. Przesunięcie jest mierzone w jednostkach kodowania ustalonego przy otwieraniu sesji, czyli UTF-16, chyba że klient poprosił o inne. |
context | CompletionContext | nie | Przyczyna żądania, o ile klient ją śledzi. |
release | string | nie | Encja Release, w kategoriach której należy udzielić odpowiedzi, jako ścieżka względna wobec katalogu głównego obszaru roboczego. Proponowane nazwy to wtedy nazwy deklarowane przez dokumenty obszaru roboczego, z pominięciem dokumentów leżących w którymś z katalogów katalogowych obszaru roboczego nieodczytywanych przez tę encję Release, wraz z encjami Components i Features deklarowanymi przez katalogi katalogowe, które konfiguracja obszaru roboczego przypisuje tej encji Release. W razie braku wartości są to dokumenty obszaru roboczego oraz encje Components i Features deklarowane przez jego własne katalogi katalogowe. Wartość, która nie wskazuje żadnego pliku Release, jest odrzucana. |
Dodatkowe właściwości są niedozwolone.
CompletionContext
Przyczyna żądania, o ile klient ją śledzi.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
triggerKind | integer | nie | Powód, dla którego zażądano uzupełniania. |
triggerCharacter | string | nie | Znak, który je wywołał, o ile wywołał je znak. |
Dodatkowe właściwości są dozwolone.
AttachCandidatesParams
Odpowiada, które encje Features można dołączyć do encji, oceniając je względem etykiet tej encji, a dla jednego połączenia rysowanego przez komponent węzła grafu — które z nich mogą wypełnić każdy slot deklarowany przez gniazdo tego połączenia.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
node | string | nie | Encja, względem której oceniani są kandydaci, podana z nazwy i odczytana z tego, co deklarują dokumenty obszaru roboczego. |
graphNode | string | nie | Węzeł grafu, względem którego oceniani są kandydaci; jego etykiety to ostateczny zbiór, na podstawie którego sama kompilacja ocenia stosowalność. Odpowiedź obliczona na tej podstawie mówi, co zrobi kompilacja. |
release | string | nie | Encja Release, do której grafu należy węzeł, jako ścieżka względna wobec katalogu głównego obszaru roboczego. Kandydaci są wtedy dobierani w kategoriach tej encji Release: encje Features deklarowane przez katalogi katalogowe, które konfiguracja obszaru roboczego przypisuje tej encji Release, oraz dokumenty obszaru roboczego z pominięciem tych, które leżą w jednym z katalogów katalogowych obszaru roboczego nieczytanych przez tę encję Release, dzięki czemu encja Feature przeznaczona dla innej encji Release nigdy nie jest proponowana dla węzła grafu tej encji. |
labels | mapa string | nie | Etykiety, względem których należy oceniać bezpośrednio, zamiast odczytywać je z encji lub węzła grafu. |
connection | ConnectionCoordinate | nie | Jedno połączenie rysowane przez komponent węzła wskazanego przez graphNode, dla którego należy udzielić odpowiedzi oprócz samego węzła: odpowiedź zawiera wtedy także slots, czyli każdy slot deklarowany przez gniazdo połączenia wraz z encjami Features, które mogą go wypełnić, albo noSlotReason, gdy żadnego slotu nie można wypełnić. Jest wysyłane tylko razem z graphNode i release, ponieważ połączenie istnieje wyłącznie w skompilowanym grafie; wysłane z node lub labels jest odrzucane. Kandydaci obok niego zachowują swoje znaczenie: są to encje Features, które można dołączyć do samego węzła. Jego dokument jest akceptowany i nie zmienia tej odpowiedzi: sloty należą do gniazda, a kandydaci wynikają z encji Features, niezależnie od tego, w którym dokumencie zapisano dołączenie. |
Dodatkowe właściwości są niedozwolone.
ConnectionCandidatesParams
Odpowiada, z którymi encjami można połączyć gniazdo danej encji.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
node | string | nie | Encja, o której gniazda pytamy. |
socket | string | nie | Jedno gniazdo, dla którego należy udzielić odpowiedzi. Gdy brak, odpowiedź obejmuje każde gniazdo deklarowane przez encję. |
Dodatkowe właściwości są niedozwolone.
InsertionPointParams
Odpowiada, w którym miejscu dokumentu należy umieścić nowy wpis pod wskazanym kontenerem, pozostawiając złożenie i zastosowanie wpisu wywołującemu, który jest właścicielem bufora.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
file | string | nie | Dokument, którego dotyczy odpowiedź. |
container | string[] | nie | Ścieżka w dokumencie do kontenera, pod którym należy umieścić wpis. |
Dodatkowe właściwości są niedozwolone.
AttachmentContainerParams
Odpowiada, w którym dokumencie i w którym jego miejscu należy umieścić dołączenie do węzła grafu lub do jednego z połączeń rysowanych przez jego komponent.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
graphNode | string | nie | Węzeł grafu, którego dotyczy dołączenie. |
release | string | nie | Encja Release, do której grafu należy węzeł, jako ścieżka względna wobec katalogu głównego obszaru roboczego. |
connection | ConnectionCoordinate | nie | Jedno połączenie rysowane przez komponent węzła grafu, gdy dołączenie dotyczy tego połączenia, a nie węzła: odpowiedź wskazuje wtedy własny kontener features połączenia w dokumencie wskazanym przez jego pole document, które jest tu wymagane. W encji Aggregate jest to wpis połączenia w dokumencie, w którym utworzono węzeł; jest odrzucany dla połączenia narysowanego przez encję Release, dla którego encja Aggregate nie ma wpisu. W encji Release jest to wpis dla krawędzi pod własnym wpisem encji Release dla węzła, niezależnie od tego, czy encja Release zapisuje już wpis dla tego połączenia; jest odrzucany, gdy encja Release nie zapisuje wpisu dla węzła. Połączenie narysowane przez encję Feature jest odrzucane w obu dokumentach, ponieważ dołączenie zapisuje się tylko na połączeniu rysowanym przez komponent lub encję Release. |
Dodatkowe właściwości są niedozwolone.
ConnectionAtPositionParams
Odpowiada, wewnątrz wpisu którego połączenia znajduje się pozycja w encji Aggregate lub Release: podaje węzeł grafu i połączenie w takiej postaci, w jakiej przyjmują je żądania kandydatów i kontenerów, albo powód, dla którego nie zapisano tam żadnego połączenia. Chodzi o wpisy, w których zapisuje się dołączenia — wpis, którym komponent rysuje połączenie, pod aliasem połączenia, w dokumencie, w którym utworzono komponent, oraz każdy wpis dla krawędzi zapisany przez encję Release — każdy w miejscu, które rejestruje skompilowany graf, więc to, czy klucz jest połączeniem, nigdy nie jest wnioskowane z jego nazwy.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
file | string | nie | Dokument, w którym znajduje się pozycja: encja Release albo dokument, w którym według grafu tej encji Release utworzono komponenty — jej encja Aggregate lub dokument modułu importowanego przez tę encję Aggregate. Jest odczytywany najpierw z tego, co sesja dla niego przechowuje, a w przeciwnym razie z dysku. |
position | Position | nie | Miejsce w dokumencie: wiersz i przesunięcie znakowe w nim, oba liczone od zera. Przesunięcie jest mierzone w jednostkach kodowania ustalonego przy otwieraniu sesji, czyli UTF-16, chyba że klient poprosił o inne. |
release | string | nie | Encja Release, której skompilowany graf rejestruje połączenia, jako ścieżka względna wobec katalogu głównego obszaru roboczego. Jest wymagana także dla pozycji w encji Aggregate, ponieważ węzeł grafu i połączenie istnieją wyłącznie w skompilowanym grafie. |
Dodatkowe właściwości są niedozwolone.
ConnectionCoordinate
Jedno połączenie rysowane przez komponent węzła grafu, adresowane przez gniazdo, przez które jest podłączone, i alias, który nosi w tym gnieździe, oraz dokument, w którym zapisuje się dołączenie do niego. Połączenie niesie dołączenia wypełniające sloty deklarowane przez jego gniazdo, a zapisać je może Aggregate lub Release.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
socket | string | tak | Gniazdo zależności, przez które podłączone jest połączenie. |
alias | string | tak | Nazwa, którą połączenie nosi w swoim gnieździe. |
document | const “aggregate” lub const “release” | nie | Dokument, w którym zapisuje się dołączenie do połączenia. Zbiór jest zamknięty, a wartość spoza niego zostaje odrzucona. Dozwolone wartości: "aggregate" — Encja Aggregate, w której programista zapisuje dołączenie we wpisie połączenia. "release" — Encja Release, w której operator zapisuje dołączenie we wpisie dla krawędzi tego połączenia. |
Dodatkowe właściwości są dozwolone.
SetActiveReleaseParams
Zapisuje encję Release jako domyślną dla obszaru roboczego, tworząc znacznik w katalogu .aggrega: wybór zgłaszany przez aggrega/activeRelease odczytuje ten znacznik po autorskiej encji Release z konfiguracji. Znacznik jest zapisywany wyłącznie wewnątrz obszaru roboczego: jeśli katalog .aggrega lub znacznik jest dowiązaniem prowadzącym poza obszar roboczy, niezależnie od tego, czy miejsce docelowe już istnieje, zapis zostaje odrzucony ze wskazaniem dowiązania i nic nie jest zapisywane. Odpowiedź jest taka, jaką daje aggrega/activeRelease po zapisaniu znacznika, więc wskazuje inną encję Release, gdy autorska encja Release z konfiguracji ma pierwszeństwo przed znacznikiem.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
release | string | nie | Release do zapisania, jako ścieżka względna wobec katalogu głównego obszaru roboczego. Ścieżka bezwzględna oraz ścieżka wychodząca poza obszar roboczy są odrzucane; podobnie ścieżka prowadząca poza niego przez dowiązanie, chyba że konfiguracja obszaru roboczego wskazuje tę encję Release. |
Dodatkowe właściwości są niedozwolone.
EditDocumentParams
Stosuje jedną ograniczoną edycję do dokumentu obszaru roboczego: dodanie jednego wpisu w jednym kontenerze lub ustawienie jednej wartości skalarnej. Złożony dokument jest sprawdzany względem schematu jego rodzaju i trafia na dysk tylko wtedy, gdy sprawdzenie się powiedzie, więc nie można w ten sposób zapisać tego, co odrzuca schemat autorski. Odrzucona edycja pozostawia plik bajt w bajt bez zmian.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
file | string | nie | Dokument do edycji. |
edit | const “add-component” lub const “attach-feature” lub const “wire-edge” lub const “set-value” | nie | Którą edycję zastosować. Dozwolone wartości: "add-component" — Dodaje instancję komponentu w kontenerze components: name to nazwa instancji, value to żądana przez nią encja Component. "attach-feature" — Dołącza encję Feature do węzła wskazanego w żądaniu: name to nazwa instancji dołączenia, value to żądana przez nie encja Feature. "wire-edge" — Tworzy połączenie zależności od węzła wskazanego w żądaniu, wewnątrz socket: name to alias, pod którym adresowane jest połączenie, value to węzeł, na który wskazuje. "set-value" — Ustawia jedną wartość na węźle wskazanym w żądaniu: name to klucz wartości, value to skalar. |
node | string[] | nie | Ścieżka w dokumencie do edytowanego wpisu. |
socket | string | nie | Gniazdo, którego dotyczy edycja, w przypadku edycji podłączającej gniazdo. |
name | string | nie | Nazwa zapisywana przez edycję. |
value | any | nie | Wartość zapisywana przez edycję, w kształcie wymaganym przez daną edycję. |
dryRun | logiczna | nie | Czy odpowiedzieć złożonym dokumentem zamiast go zapisywać. |
Dodatkowe właściwości są niedozwolone.
ConfigInitParams
Tworzy początkowy dokument konfiguracji. Domyślnie zapisuje plik ogólnosystemowy, ponieważ rejestr i tożsamości, którym w nim się ufa, są narzędziami ogólnosystemowymi. Łączy się ze wskazanym rejestrem, aby odczytać ogłaszaną przez niego politykę zaufania; rejestr, który niczego nie ogłasza, jest zgłaszany jako taki, a tworzenie konfiguracji przebiega dalej — na wbudowanej polityce bazowej dla oficjalnego huba i bez polityki dla każdego innego rejestru.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
registry | string | nie | Rejestr, dla którego tworzona jest konfiguracja. |
force | logiczna | nie | Czy nadpisać istniejący już dokument konfiguracji. |
global | logiczna | nie | Zapisz plik konfiguracji obowiązujący na całej maszynie, co jest domyślnym zachowaniem tej metody. |
workspace | logiczna | nie | Zapisz własny plik konfiguracji tego obszaru roboczego zamiast pliku obowiązującego na całej maszynie. |
dryRun | logiczna | nie | Czy odpowiedzieć treścią dokumentu zamiast go zapisywać, na potrzeby klienta utrzymującego własny model dokumentu. |
Dodatkowe właściwości są niedozwolone.
ConfigCaptureParams
Utrwala rozwiązaną konfigurację we własnym dokumencie obszaru roboczego, dzięki czemu obszar roboczy jest samowystarczalny. Zawsze zapisuje plik tego obszaru roboczego i nie sięga poza niego.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
allPlugins | logiczna | nie | Czy utrwalić każdy dołączony plugin, a nie tylko te skonfigurowane przez sam obszar roboczy. |
Dodatkowe właściwości są niedozwolone.
ImportParams
Przekształca obcy opis źródłowy w robocze dokumenty autorskie i zapisuje obok nich .aggrega-import.json, czyli zapis tego, co import zapisał — podany cel, o ile go podano, odczytaną migawkę katalogu, o ile ją odczytano, każdy wygenerowany plik oraz każdy klucz wygenerowanej encji Aggregate lub Release na każdym poziomie zagnieżdżenia — który odczytuje późniejsza synchronizacja. Źródło, którego nie udało się w pełni przekształcić, daje odpowiedź, a nie błąd: wygenerowane wersje robocze zostają zapisane, a wyniki wskazują, czego nie udało się przekształcić — z wyjątkiem trybu sync, który nie zapisuje niczego z przekształcenia, które zostało przerwane.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
source | string | nie | Plik lub katalog do przekształcenia, jako ścieżka bezwzględna lub względna wobec katalogu głównego obszaru roboczego; żądanie bez niej jest odrzucane. Jest odczytywany tam, gdzie się znajduje, w obszarze roboczym lub poza nim, a z katalogu odczytywane są te jego pliki, które wybierają zadeklarowane wzorce plików importera. |
outputDir | string | nie | Katalog w obszarze roboczym, do którego mają trafić wersje robocze, względny wobec katalogu głównego obszaru roboczego; wartość bezwzględna lub prowadząca poza obszar roboczy, wprost lub przez dowiązanie, jest odrzucana. Brak wartości oznacza zapis pod katalogiem głównym obszaru roboczego, tam gdzie zapisuje to samo przekształcenie uruchomione w terminalu bez wskazania miejsca docelowego. Każda wygenerowana ścieżka jest względna wobec katalogu, który odpowiedź podaje jako outputDir, również w trybie dryRun. |
format | string | nie | Format źródła. Brak wartości pozwala przekształceniu go ustalić. |
target | string | nie | Możliwość dostawcy, taka jak compose lub helm — słowo, z którym wiąże się spec.capability encji Recipe — dla której obok wersji roboczych zostanie wygenerowana encja Manifest jako manifest.yaml: każdy typ komponentu i typ funkcji, których potrzebują wersje robocze, łącznie z typami katalogowej encji Aggregate, którą komponuje wygenerowana encja, zostaje przypisany do encji Recipe lub receptury funkcji o tej możliwości, jaką katalog obszaru roboczego dla niego oferuje — jedynej, jaka istnieje, albo spośród kilku tej nazwanej od typu; typ bez żadnej albo z kilkoma, z których żadna nie jest tak nazwana, pozostaje nieprzypisany z wynikiem ostrzegawczym, który go wskazuje; przypisanie, które importer wygenerował sam, zostaje zachowane tam, gdzie katalog oferuje je dla tego typu i tej możliwości, a w przeciwnym razie odrzucone z wynikiem ostrzegawczym; a spec.manifest wygenerowanej encji Release zostaje ustawione na tę encję Manifest. Możliwość, z którą nie wiąże się żadna encja Recipe w katalogu, jest odrzucana przed uruchomieniem przekształcenia i nic nie zostaje zapisane. Brak wartości oznacza, że żadna encja Manifest nie jest generowana, z wyjątkiem trybu sync, który generuje ją dla celu wskazanego w zapisie wcześniejszego importu; synchronizacja wskazująca cel generuje ją dla niego, a zapis wskazuje go odtąd. |
dryRun | logiczna | nie | Czy odpowiedzieć treścią każdego pliku, który żądanie by zapisało, zamiast go zapisywać. Pozostałe zachowanie jest takie jak przy zapisie, więc żądanie, które zapis by odrzucił, jest odrzucane również w tym trybie; w połączeniu z sync odpowiedź zawiera to, co synchronizacja by zapisała, oraz każdą część, która by się rozjechała. |
sync | logiczna | nie | Czy zaktualizować względem źródła to, co wcześniejszy import wygenerował pod outputDir, zamiast zapisywać wersję roboczą w całości. Zmienia się tylko to, co zapisał import, zgodnie z listą w zapisie obok wersji roboczych: część, której źródło nie zmieniło, pozostaje taka, jaka jest na dysku, edytowana lub nie; część, którą źródło zmieniło, usunęło lub dodało, jest zapisywana od nowa, usuwana — wygenerowany plik jest usuwany w całości — lub dodawana, o ile na dysku znajduje się to, co import ostatnio zapisał; a wszystko inne, klucz dodany przez autora — w tym środowisko, które wygenerowana encja Release zostawia autorowi — lub komentarz niezapisany bezpośrednio nad wygenerowanym kluczem, pozostaje bajt po bajcie bez zmian. Synchronizacja, która zmieniłaby lub usunęła to, co autor edytował lub dodał, albo dodała część tam, gdzie autor już jakąś zapisał, jest odrzucana ze wskazaniem każdej części; tak samo synchronizacja dotycząca encji Aggregate, której nie wymienia żaden zapis; w obu przypadkach nic nie zostaje zapisane. Bez tej opcji żądanie, którego wersje robocze nadpisałyby encję Aggregate już obecną w outputDir, jest odrzucane, również w trybie dryRun. |
upgrade | logiczna | nie | Czy pobrać najnowszą migawkę katalogu publikowaną przez domyślny rejestr obszaru roboczego i importować względem niej, przechowując ją odtąd zamiast tej, którą przechowuje obszar roboczy, lub tej, którą wskazuje zapis obok wersji roboczych; nie zmienia niczego, gdy obszar roboczy wskazuje folder katalogu, i jest odrzucane w trybie offline. |
answers | string | nie | Plik odpowiedzi, z którego odczytywane i do którego zapisywane są wartości pozostawiane przez wersje robocze puste, których żadne źródło nie może zawierać, podany względem katalogu głównego obszaru roboczego; wartość bezwzględna lub taka, która prowadzi poza obszar roboczy wprost lub przez dowiązanie, jest odrzucana. Zawiera on, pod ścieżką każdego wygenerowanego pliku, ścieżkę klucza w tym dokumencie i odpowiedź dla niego, a odpowiedzi są zapisywane w wersjach roboczych. Brak wartości oznacza odczyt pliku wskazanego w zapisie obok wersji roboczych, a w przeciwnym razie import-answers.yaml obok pliku źródłowego lub w katalogu źródłowym. Odpowiedź dla sekretu wskazuje, skąd pochodzi sekret — nazwę zmiennej, ${NAME} lub nazwę obiektu Kubernetes Secret — a wszystko inne jest odrzucane i nic nie zostaje zapisane. O nic nie jest pytane: każda wciąż brakująca wartość jest wpisem w owed odpowiedzi oraz wynikiem ostrzegawczym wskazującym wygenerowany plik, klucz i to, czym on jest, jej odpowiedź jest wysyłana jako answered, a tam, gdzie wersje robocze zostają zapisane, ostatni wynik podaje, ilu wartości brakuje i gdzie. Gdy wersje robocze obejmują encję Release, nie brakuje w nich żadnej wartości, a przekształcenie się zakończyło, pobierane są następnie jej zależności i zapisywany jest jej plik blokady, a nieudane pobranie zamyka wyniki z podaniem przyczyny, przy czym wersje robocze pozostają zapisane; w trybie offline nic nie jest pobierane, a wynik wskazuje pobranie do uruchomienia. Odpowiedź dla klucza, którego te wersje robocze nie pozostawiają pustego, zostaje zachowana w pliku i nie jest stosowana, więc jeden plik odpowiedzi służy każdemu celowi. |
answered | ImportAnswered[] | nie | Odpowiedzi dla wartości wymienionych w owed odpowiedzi, z których każda wskazuje wygenerowany plik i klucze tak, jak wskazało je owed. Każda jest oceniana, zachowywana w pliku odpowiedzi i zapisywana w wersjach roboczych dokładnie tak jak odpowiedź wpisana w terminalu: odpowiedź dla sekretu wskazuje, skąd pochodzi sekret — nazwę zmiennej, ${NAME} lub nazwę obiektu Kubernetes Secret — a taka, która tego nie robi, nie jest ani zachowywana, ani zapisywana, a jej wartość pozostaje brakująca z powodem jako jej secretAdvice. Wartość, na którą plik odpowiedzi już odpowiada, otrzymuje odpowiedź z pliku; pusta odpowiedź lub taka, która wskazuje wartość, której wersjom roboczym nie brakuje, nie jest stosowana. Należy ją wysłać z sync po zapisaniu wersji roboczych, ponieważ żądanie, które nie jest sync, jest odrzucane wobec encji Aggregate już obecnej w outputDir. W trybie dryRun, który nie zachowuje żadnej odpowiedzi, oraz w przypadku sync, którego przekształcenie się zatrzymało i który niczego nie zapisuje, żadna wysłana odpowiedź nie jest stosowana. |
Dodatkowe właściwości są niedozwolone.
ScaffoldEntityParams
Tworzy szkic dokumentu startowego dla rodzaju encji albo zapisuje jeden z przykładów gotowych do uruchomienia z dokumentacji w nowym katalogu przestrzeni roboczej, albo je wymienia. Tworzenie szkicu wyprowadza szkielet z zestawu schematów zawartego w pliku binarnym, więc nic nie jest odczytywane z przestrzeni roboczej i nic nie jest zapisywane — odpowiedź to tekst, a o tym, gdzie trafi, decyduje klient. Zapisanie przykładu zapisuje nowy katalog i nic poza nim, a przykłady są odczytywane z podpisanego pakietu dokumentacji opublikowanego dla wersji pliku binarnego lub, jeśli takiego nie ma, z najnowszego opublikowanego przed nią, który jest weryfikowany względem polityki podpisów przestrzeni roboczej, zanim zostanie zachowany lub odczytany: pakiet, który nie przechodzi weryfikacji, jest odrzucany, a w trybie offline odczytywana jest tylko kopia już zapisana w pamięci podręcznej. Żądanie wysyłające razem pola dwóch form — kind z example lub list, list z example, name z example lub list, dir bez example — jest odrzucane, zanim cokolwiek zostanie odczytane.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | string | nie | Ścieżka bezwzględna przestrzeni roboczej. Tworzenie szkicu jej nie odczytuje. Zapisanie lub wylistowanie przykładu jej wymaga: konfiguracja przestrzeni roboczej decyduje, skąd pobierana jest dokumentacja i jakie podpisy musi zawierać, a przykład jest zapisywany wewnątrz niej. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
kind | string | nie | Rodzaj encji do wygenerowania, podany za pomocą tokenu zapisanego małymi literami, np. component, aggregate, release, recipe lub featurerecipe — tokenu, który aggrega/getSchema podaje dla niego. |
name | string | nie | Nazwa do wpisania w wygenerowanym dokumencie. Wysyłana tylko razem z kind. |
example | string | nie | Przykład gotowy do uruchomienia, który należy zapisać, wskazany nazwą nadaną mu na liście przykładów. Wysyłany zamiast kind. |
list | logiczna | nie | Czy odpowiedzieć wszystkimi przykładami gotowymi do uruchomienia, które publikuje dokumentacja, niczego nie zapisując. Wysyłane bez example i bez kind. |
dir | string | nie | Nowy katalog, w którym należy zapisać przykład, względny wobec katalogu głównego przestrzeni roboczej; przy braku wartości przykład jest zapisywany tam w katalogu nazwanym od przykładu. Katalog nie może jeszcze istnieć albo musi być pusty: katalog zawierający cokolwiek jest odrzucany i pozostawiany bez zmian, a wartość bezwzględna lub taka, która prowadzi poza przestrzeń roboczą w zapisanej postaci albo przez dowiązanie, jest odrzucana, zanim cokolwiek zostanie odczytane. Wysyłany tylko razem z example. |
Dodatkowe właściwości są niedozwolone.
LintParams
Sprawdza konwencje publikowania katalogu dla jednej encji, dla wszystkiego, do czego sięga domknięcie encji Release, lub dla wszystkiego w skonfigurowanych katalogach. W żadnym trybie nic nie jest zapisywane. Niewskazanie ani encji, ani encji Release oznacza sprawdzenie całego katalogu: w obszarze roboczym, którego konfiguracja nie nadaje żadnej encji Release własnych katalogów, jednokrotnie dla katalogów obszaru roboczego; w obszarze roboczym, który wymienia encje Releases w workspace.releases, raz dla każdej encji Release w katalogach, które ta encja Release odczytuje, nigdy dla wszystkich naraz.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
entity | string | nie | Jedyny dokument encji do sprawdzenia. |
release | string | nie | Encja Release, której domknięcie należy sprawdzić, jako ścieżka względna wobec katalogu głównego obszaru roboczego. |
prePublish | logiczna | nie | Czy porównać każdą encję z jej poprzednio opublikowaną wersją, co wymaga połączenia ze skonfigurowanymi rejestrami. |
Dodatkowe właściwości są niedozwolone.
PluginAddParams
Dołącza plugin do gniazda skonfigurowanego w obszarze roboczym. Łączy się z rejestrem, aby rozwiązać zapytanie do jednego pluginu i przypiąć wersję. Jedyna decyzja, którą uzyskałby terminal — akceptacja zadeklarowanych możliwości pluginu rozszerzającego polecenia — przychodzi tu jako pole, więc klient pyta tego, kto nim steruje, a ten interfejs nigdy nie czeka na monit.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
type | string | nie | Gniazdo, do którego plugin jest dołączany. |
query | string | nie | To, co ma zostać rozwiązane do jednego pluginu. |
capability | string | nie | Możliwość, której dotyczy dołączenie, gdy gniazdo ma ich kilka. |
role | string | nie | Rola, w której działa dołączenie; określa ona, co może ono emitować. |
global | logiczna | nie | Zapisuje plik konfiguracji obowiązujący dla całej maszyny. |
workspace | logiczna | nie | Zapisuje własny plik konfiguracji tego obszaru roboczego. |
acceptCapabilities | logiczna | nie | Czy wywołujący akceptuje możliwości deklarowane przez plugin rozszerzający polecenia. |
dryRun | logiczna | nie | Czy odpowiedzieć treścią dokumentu konfiguracji zamiast go zapisywać. |
Dodatkowe właściwości są niedozwolone.
PluginRemoveParams
Odłącza plugin od gniazda skonfigurowanego w obszarze roboczym.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
type | string | nie | Gniazdo, do którego plugin jest dołączony. |
query | string | nie | Które dołączenie usunąć. |
global | logiczna | nie | Zapisuje plik konfiguracji obowiązujący dla całej maszyny. |
workspace | logiczna | nie | Zapisuje własny plik konfiguracji tego obszaru roboczego. |
Dodatkowe właściwości są niedozwolone.
PluginSyncParams
Uzgadnia rekordy zarządzane maszynowo encji Plugin z modułem, na który wskazuje. Przepisuje te rekordy, a każdy inny bajt dokumentu przenosi bez zmian.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
entity | string | nie | Dokument encji Plugin do uzgodnienia. |
plugin | string | nie | Moduł pluginu, z którego mają zostać odczytane rekordy. |
Dodatkowe właściwości są niedozwolone.
PluginGenCatalogParams
Generuje dokumenty katalogu encji Plugin z metadanych zadeklarowanych przez sam plugin oraz z napisanej przez autora nakładki. Ponowne generowanie z niezmienionych danych wejściowych daje dokumenty identyczne co do bajtu.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
fromEmbedded | logiczna | nie | Czy odczytać metadane z pluginów, które plik binarny już zawiera. |
plugin | string | nie | Moduł pluginu, z którego mają zostać odczytane metadane. |
outputDir | string | nie | Katalog w obszarze roboczym, do którego mają zostać zapisane dokumenty. |
overlay | string | nie | Dokument napisany przez autora, którego treść jest scalana z wygenerowanymi metadanymi. |
dryRun | logiczna | nie | Czy odpowiedzieć treścią dokumentów zamiast je zapisywać. |
Dodatkowe właściwości są niedozwolone.
ExplainErrorParams
Rozwija kod, który niósł wynik kontroli, w to, co kompilator deklaruje o danym stanie, oraz w opublikowane wpisy objaśniające, jak poprawić tworzony dokument. Pobiera opublikowaną dokumentację, gdy obszar roboczy nie ma jej kopii; jeśli nie może jej pobrać, nadal odpowiada tym, co deklaruje plik binarny, i podaje, dlaczego brakuje opisu.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
code | string | nie | Stan do rozwinięcia, wskazany kodem, który niósł wynik kontroli, albo jego krótkim kodem. |
Dodatkowe właściwości są niedozwolone.
GetSchemaParams
Odpowiada schematem rodzaju lub — gdy nie wskazano rodzaju — listą rodzajów, które można wskazać. Odpowiada dla uruchomionego pliku binarnego, a nie dla kopii zainstalowanej gdzie indziej, więc nie potrzebuje obszaru roboczego i żadnego nie odczytuje.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootAccepted | nie | Ścieżka bezwzględna obszaru roboczego. Przedmiotem tej metody nie jest obszar roboczy — odpowiada ona na podstawie tego, co zawiera sam plik binarny — więc pole jest akceptowane, ale nieodczytywane. Jest dopuszczone, ponieważ klient może wysyłać je jednolicie w każdym żądaniu, bez potrzeby wiedzy, które metody z niego korzystają. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
kind | string | nie | Rodzaj, którego schematem należy odpowiedzieć. Brak oznacza odpowiedź listą rodzajów, które można wskazać. |
Dodatkowe właściwości są niedozwolone.
SkillsInstallParams
Zapisuje wbudowaną w plik binarny umiejętność asystenta do folderu umiejętności każdego asystenta wskazanego w żądaniu lub, w przypadku żądania global niewskazującego żadnego, każdego asystenta znalezionego na tej maszynie. Bez global zapisuje do folderu projektu każdego asystenta wewnątrz przestrzeni roboczej wskazanej w żądaniu, a każda ścieżka, którą by tam zapisał, jest ograniczona do tej przestrzeni roboczej; z global zapisuje do folderu każdego asystenta przypisanego do użytkownika w katalogu domowym. Każdy cel jest sprawdzany, zanim cokolwiek zostanie zapisane, więc odmowa pozostawia wszystkie foldery w niezmienionym stanie.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | tak | Ścieżka bezwzględna obszaru roboczego, na którym działa to żądanie. Jest przedmiotem żądania: demon rozwiązuje ją przed uruchomieniem metody, a żądanie, które ją pomija lub zapisuje inaczej niż jako ciąg znaków, zostaje odrzucone. |
workDoneToken | ProgressToken | nie | Wartość tworzona przez wywołującego, aby mógł dopasować powiadomienia o postępie do wywołania, które o nie poprosiło. Jest odsyłana bez zmian w każdym powiadomieniu, więc wywołujący może porównać ją z wysłaną wartością. Jest akceptowana w każdym żądaniu, a żądanie, które wysyła ją w sesji niedeklarującej obsługi postępu, zostaje odrzucone. |
agents | string[] | nie | Asystenci, dla których należy zainstalować umiejętność, wskazani identyfikatorami, które podaje lista. Żądanie projektowe niewskazujące żadnego jest odrzucane. Żądanie global niewskazujące żadnego instaluje umiejętność dla asystentów znalezionych na tej maszynie — każdego, którego folder konfiguracji znajduje się w katalogu domowym lub którego polecenie jest w PATH — a jeśli nie zostanie znaleziony żaden, jest odrzucane i nic nie zostaje zapisane. Identyfikator, dla którego nie jest znany folder umiejętności, jest odrzucany z podaniem jego nazwy, a identyfikator podany dwukrotnie jest instalowany raz. |
global | logiczna | nie | Zapisz do folderu umiejętności każdego asystenta przypisanego do użytkownika w katalogu domowym, który asystent odczytuje w każdym projekcie, zamiast do jego folderu projektu w przestrzeni roboczej. |
Dodatkowe właściwości są niedozwolone.
ServerCapabilities
Co demon będzie robić w tej sesji, ustalone względem tego, co klient zadeklarował, że obsługuje.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
positionEncoding | string | tak | Kodowanie, w którym wyrażana jest każda pozycja w tej sesji. |
workDoneProgress | logiczna | nie | Czy demon będzie wysyłać powiadomienia o postępie w tej sesji. Występuje tylko wtedy, gdy klient zadeklarował, że może je odbierać. |
Dodatkowe właściwości są niedozwolone.
ClosureEntity
Jedna encja, od której zależy encja Release, w wersji ustalonej podczas rozwiązywania.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
uri | string | tak | Odwołanie, z którego rozwiązywana jest encja. |
version | string | tak | Wersja, która została ustalona. |
kind | string | nie | Rodzaj encji. |
source | string | nie | Skąd przebieg, który utworzył ten wpis, pobrał encję, tym samym słowem, które wypisuje dla niej aggrega pull --detail: fetched-fresh (pobrana z rejestru podczas tego przebiegu), cache-reuse (kopia już obecna w pamięci podręcznej, użyta ponownie bez pobierania), local (znaleziona w lokalnym systemie plików, np. w katalogu katalogu encji), in-binary (kopia wbudowana w plik binarny kompilatora) lub external (własna encja Aggregate lub Manifest encji Release, odczytana z pliku lub wpisu wskazanego przez encję Release, a nie rozwiązana jako jedna z jej zależności; encja Aggregate pobrana przez przebieg z rejestru ma zamiast tego wartość fetched-fresh). Występuje we wpisach raportu z rozwiązywania zależności, gdzie opisuje, co ten przebieg zrobił na tej maszynie, i nie występuje na liście rozwiązanych zależności encji Release, która opisuje, od czego zależy encja Release. Plik blokady nie zapisuje źródła. Pomijane dla encji, której źródła przebieg nie zapisał. |
Dodatkowe właściwości są niedozwolone.
ToolchainCorePlugin
Jedna wtyczka wbudowana w sam kompilator i jej wersja, która została użyta.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
plugin | string | tak | Odwołanie do wtyczki. |
version | string | tak | Wersja, która została użyta. |
Dodatkowe właściwości są niedozwolone.
ToolchainReport
Kompilator, który dokonał rozwiązania, i wtyczki, które zawiera.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
compilerVersion | string | tak | Wersja kompilatora, który dokonał rozwiązania. |
corePlugins | ToolchainCorePlugin[] | nie | Wtyczki zawarte w kompilatorze, wraz z użytą wersją każdej z nich. |
Dodatkowe właściwości są niedozwolone.
DependencyResolutionReport
Co rozwiązywanie zależności przypięło i pozyskało.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
lockfile | string | tak | Plik blokady zapisany przez rozwiązywanie lub plik, z którym porównywała weryfikacja. |
verified | logiczna | nie | Czy żądanie było weryfikacją, która porównała zapisany plik blokady i nie zapisała pliku blokady, rekordu zaufania wtyczek ani entity.lock. |
entities | ClosureEntity[] lub null | tak | Encje przypięte przez rozwiązywanie lub porównane przez weryfikację. |
libraries | ClosureEntity[] lub null | tak | Biblioteki przypięte przez rozwiązywanie lub porównane przez weryfikację. |
plugins | ClosureEntity[] lub null | tak | Wtyczki przypięte przez rozwiązywanie lub porównane przez weryfikację. |
sourceArtifacts | integer | tak | Liczba pozyskanych artefaktów źródłowych. |
trustedPlugins | integer | tak | Liczba przypiętych wtyczek ze zweryfikowanym podpisem. |
toolchain | ToolchainReport | nie | Kompilator, który dokonał rozwiązania, i wtyczki, które zawiera. |
externalInputs | integer | tak | Liczba pozyskanych zewnętrznych danych wejściowych, z których korzysta renderowanie. |
incompleteExternalInputs | string | nie | Których zewnętrznych danych wejściowych nie udało się pozyskać, jeśli takie są. |
Dodatkowe właściwości są niedozwolone.
BuildNotice
Jedna informacja, którą kompilacja przekazuje wywołującemu, niebędąca ani ustaleniem dotyczącym dokumentu, ani błędem.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
class | string | tak | Rodzaj komunikatu. |
text | string | tak | Treść komunikatu. |
Dodatkowe właściwości są niedozwolone.
CacheScope
Zasięg odpowiedzi dotyczącej pamięci podręcznej. Dwie klasy pamięci podręcznej są współdzielone przez wszystkie projekty na maszynie, dlatego każda taka odpowiedź podaje, których klas dotyczyła — w przeciwnym razie sesję otwartą dla jednego obszaru roboczego można by odczytać jako raportującą wyłącznie o tym obszarze.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
machineWideClasses | string[] lub null | tak | Klasy pamięci podręcznej, których dotyczyła ta odpowiedź, współdzielone przez wszystkie projekty na maszynie. |
workspaceRoot | string | tak | Obszar roboczy wskazany w żądaniu. |
Dodatkowe właściwości są niedozwolone.
CacheElement
Jeden element przechowywany w pamięci podręcznej.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
label | string | tak | Czego dotyczy wpis. |
size | integer | tak | Liczba zajmowanych bajtów. |
sizeText | string | tak | Ten sam rozmiar zapisany w formie czytelnej dla człowieka. |
digest | string | nie | Skrót zawartości, pod którym wpis jest indeksowany, jeśli go ma. |
note | string | nie | Wszelkie inne istotne informacje o wpisie. |
Dodatkowe właściwości są niedozwolone.
CacheClass
Jedna pamięć podręczna, o której raportuje demon.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
name | string | tak | Która to pamięć podręczna. |
reach | string | tak | Czy pamięć podręczna należy do tego obszaru roboczego, czy jest współdzielona w obrębie maszyny. |
prunable | logiczna | tak | Czy demon odzyska miejsce zajmowane przez tę pamięć podręczną. |
elements | CacheElement[] lub null | tak | Zawartość pamięci podręcznej. |
Dodatkowe właściwości są niedozwolone.
CacheProvenance
W ramach których tożsamości pozyskano artefakt z pamięci podręcznej i jak szeroko jest on współdzielony.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
identities | string[] lub null | tak | Tożsamości, którym przypisano artefakt. |
sharedBy | integer | nie | Liczba posiadaczy współdzielących artefakt. |
Dodatkowe właściwości są niedozwolone.
CacheRemoval
Jeden element usunięty podczas odzyskiwania miejsca — lub, na liście elementów pozostawionych, jeden element, który zostałby usunięty.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
class | string | tak | Do której pamięci podręcznej należy. |
label | string | tak | Czym jest. |
reach | string | tak | Czy ta pamięć podręczna należy do tego obszaru roboczego, czy jest współdzielona w obrębie maszyny. |
size | integer | tak | Liczba bajtów zajmowanych obecnie lub przed usunięciem. |
sizeText | string | tak | Ten sam rozmiar zapisany w formie czytelnej dla człowieka. |
Dodatkowe właściwości są niedozwolone.
CacheShortfall
Co pozostało po odzyskiwaniu miejsca i co pozwoliłoby to odzyskać, dzięki czemu wywołujący, który odczyta mniejszą wartość niż oczekiwana, dowie się dlaczego, zamiast się tego domyślać.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
class | string | tak | Która pamięć podręczna przechowuje to, co pozostało. |
count | integer | tak | Liczba pozostawionych wpisów. |
size | integer | tak | Liczba zajmowanych przez nie bajtów. |
sizeText | string | tak | Ten sam rozmiar zapisany w formie czytelnej dla człowieka. |
reach | string | tak | Czy ta pamięć podręczna należy do tego obszaru roboczego, czy jest współdzielona w obrębie maszyny. |
reclaimedBy | string[] lub null | tak | Co pozwoliłoby je odzyskać. |
Dodatkowe właściwości są niedozwolone.
CacheCleared
Jedna pamięć podręczna opróżniona podczas czyszczenia.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
class | string | tak | Która pamięć podręczna została opróżniona. |
reach | string | tak | Czy należy do tego obszaru roboczego, czy jest współdzielona w obrębie maszyny. |
size | integer | tak | Liczba bajtów z niej odzyskanych. |
sizeText | string | tak | Ten sam rozmiar zapisany w formie czytelnej dla człowieka. |
heldOpenFiles | integer | tak | Liczba plików pozostawionych w tej pamięci podręcznej, ponieważ inny proces miał je otwarte. Tylko system Windows odmawia usunięcia otwartego pliku, więc wszędzie indziej wartość ta wynosi zero. Kolejne czyszczenie usunie je, gdy ten proces przestanie ich używać. |
heldOpenBytes | integer | tak | Liczba bajtów zajmowanych przez te pliki. Nie są one wliczane do rozmiaru, który oznacza miejsce odzyskane przez czyszczenie. |
heldOpenBytesText | string | tak | Ta sama wartość zapisana w formie czytelnej dla człowieka. |
Dodatkowe właściwości są niedozwolone.
ConfigWriteScope
Który dokument konfiguracyjny został zapisany i jaki ma zasięg. Żądanie wskazuje jeden obszar roboczy, więc odpowiedź, która nic by o tym nie mówiła, zostałaby odczytana jako dotycząca tego obszaru — a w przypadku zapisu obejmującego całą maszynę taki odczyt jest błędny.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
configFile | string | tak | Dokument, który został zapisany. |
machineWide | logiczna | tak | Czy jest to dokument, przez który rozwiązywane są wszystkie obszary robocze na maszynie. |
workspaceRoot | string | tak | Obszar roboczy wskazany w żądaniu. |
Dodatkowe właściwości są niedozwolone.
PluginWriteScope
Do którego dokumentu konfiguracyjnego zapisano zmianę wtyczki i jaki ma on zasięg. Domyślnym dokumentem gniazda rozszerzeń poleceń jest dokument obejmujący całą maszynę, dlatego każda odpowiedź podaje, który dokument zapisała.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
configFile | string | tak | Dokument, który został zapisany. |
machineWide | logiczna | tak | Czy jest to dokument, przez który rozwiązywane są wszystkie obszary robocze na maszynie. |
workspaceRoot | string | tak | Obszar roboczy wskazany w żądaniu. |
Dodatkowe właściwości są niedozwolone.
CredentialStoreScope
Zasięg zmiany poświadczeń. Magazyn jest współdzielony przez wszystkie projekty na maszynie i przez wszystkie inne narzędzia korzystające z tych samych rejestrów, dlatego odpowiedź to zgłasza, zamiast pozostawiać domysłom, że zmiana dotyczy tylko sesji.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
machineWide | logiczna | tak | Czy magazyn, którego dotyczyła zmiana, jest współdzielony w obrębie maszyny. |
workspaceRoot | string | tak | Obszar roboczy wskazany w żądaniu. |
Dodatkowe właściwości są niedozwolone.
SkillFolderScope
Jak daleko sięga instalacja umiejętności. Żądanie wskazuje jedną przestrzeń roboczą, więc odpowiedź, która nic by nie mówiła, zostałaby odczytana jako dotycząca tej przestrzeni roboczej — a w przypadku folderów przypisanych do użytkownika, które asystent odczytuje w każdym projekcie, takie odczytanie jest błędne.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
machineWide | logiczna | tak | Czy zapisane foldery są folderami przypisanymi do użytkownika w katalogu domowym, które asystent odczytuje w każdym projekcie na maszynie. |
workspaceRoot | string | tak | Obszar roboczy wskazany w żądaniu. |
Dodatkowe właściwości są niedozwolone.
PublicationReach
Zasięg publikacji. Te odpowiedzi sięgają całkowicie poza tę maszynę — to, co dołączają, jest tym, co rozwiązuje każdy konsument danego rejestru — dlatego każda wymienia każdy rejestr, do którego się zwróciła, oraz to, czy wywołanie cokolwiek tam dołączyło.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
registries | string[] | tak | Każdy host rejestru, do którego zwróciło się wywołanie, każdy wymieniony raz, w kolejności, w jakiej wywołanie po raz pierwszy się do niego zwróciło. Wywołanie z jedną referencją wymienia jeden; przebieg próbny wymienia miejsce docelowe, do którego by się zwrócił. |
beyondThisMachine | logiczna | tak | Czy wywołanie dołączyło coś, co rejestr udostępnia teraz innym: przesłaną treść, podpis, datę publikacji lub znacznik wycofania. Fałsz w przebiegu próbnym oraz w wywołaniu, które zastało już na miejscu wszystko, co by dołączyło — w ponownej publikacji kompletnej wersji lub w partii podpisywania, w której każda referencja miała już weryfikowalny podpis. |
Dodatkowe właściwości są niedozwolone.
WorkspaceEntityRef
Jedna encja, według rodzaju i nazwy, wraz z dokumentem, który ją deklaruje.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
kind | string | tak | Rodzaj encji. |
name | string | tak | Nazwa encji. |
file | string | tak | Dokument, który ją deklaruje, jako ścieżka względem katalogu głównego obszaru roboczego. |
Dodatkowe właściwości są niedozwolone.
SourcedEntityRef
Jedna encja wraz z miejscem, z którego została odczytana. Dokument obszaru roboczego podaje swoją ścieżkę względną wobec obszaru roboczego; encja rozwiązana ze skonfigurowanych katalogów katalogu encji podaje pustą ścieżkę, ponieważ jedyna ścieżka, jaką ma, nic by klientowi nie mówiła. Pochodzenie wskazuje, który z tych dwóch przypadków zachodzi, zamiast pozostawiać pustą ścieżkę do odczytania jako pole, którego nikt nie wypełnił.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
kind | string | tak | Rodzaj encji. |
name | string | tak | Nazwa encji. |
file | string | tak | Dokument, który ją deklaruje, jako ścieżka względem katalogu głównego obszaru roboczego, lub pusta, gdy encja pochodzi ze skonfigurowanych katalogów katalogu encji. |
origin | string | tak | Miejsce, z którego odczytano encję. |
Dodatkowe właściwości są niedozwolone.
SocketCandidacy
Jedno gniazdo encji oraz to, co można do niego podłączyć.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
socket | string | tak | Nazwa gniazda. |
declaration | string | tak | Miejsce deklaracji gniazda. |
selector | string | tak | Selektor etykiet, który musi spełniać cel. |
required | logiczna | tak | Czy gniazdo musi być podłączone, aby kompilacja mogła być kontynuowana. |
targets | WorkspaceEntityRef[] lub null | tak | Encje, które można do niego podłączyć. |
Dodatkowe właściwości są niedozwolone.
SlotCandidacy
Jeden slot deklarowany przez gniazdo połączenia, tak jak deklaruje go w gnieździe konsumująca encja Component, oraz Features, które mogą go wypełnić w tym połączeniu.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
slot | string | tak | Nazwa slotu, czyli klucz, pod którym w features połączenia zapisuje się wypełniające go dołączenie. |
selector | string | tak | Selektor etykiet, który encja Feature wypełniająca slot musi spełniać własnymi etykietami. Pusty, gdy slot go nie deklaruje, co dopuszcza dowolną encję Feature. |
required | logiczna | tak | Czy każde połączenie podłączone przez gniazdo musi wypełnić slot, aby kompilacja mogła być kontynuowana. |
inject | string[] | tak | Mechanizmy dostarczania, na które slot zezwala dla tego, co go wypełnia, w kolejności deklaracji w encji Component. Puste, gdy żadnych nie deklaruje. |
sensitive | logiczna | tak | Czy slot deklaruje, że to, co go wypełnia, obsługuje materiał poufny. Oznacza to wypełniające go dołączenie i niczego nie odrzuca. |
description | string | tak | Do czego według encji Component służy slot. Puste, gdy nic o tym nie mówi. |
candidates | SourcedEntityRef[] | tak | Każda encja Feature, która może wypełnić slot w tym połączeniu: taka, której zadeklarowaną stosowalność spełniają etykiety węzła grafu, z czym rozliczane jest każde dołączenie węzła, i której własne etykiety spełniają selektor slotu. Encja Feature, której stosowalności lub etykiet nie da się odczytać względem selektora, nie jest proponowana, ponieważ kompilacja raczej ją odrzuci, niż dopuści. |
Dodatkowe właściwości są niedozwolone.
CatalogEntity
Jedna encja przechowywana w indeksie obszaru roboczego.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
kind | string | tak | Rodzaj encji. |
name | string | tak | Nazwa encji. |
apiVersion | string | tak | Wersja schematu deklarowana przez dokument. |
description | string | tak | Do czego według dokumentu służy encja. |
labels | map of string lub null | tak | Etykiety deklarowane przez dokument. |
file | string | tak | Dokument, który ją deklaruje, jako ścieżka względem katalogu głównego obszaru roboczego. |
origin | string | tak | Miejsce, z którego odczytano encję. |
Dodatkowe właściwości są niedozwolone.
CompletionItem
Jedna rzecz, którą można wpisać w miejscu kursora.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
label | string | tak | Tekst do wpisania. |
kind | integer | nie | Jakiego rodzaju jest to rzecz, aby klient mógł dobrać dla niej ikonę. |
detail | string | nie | Krótki opis pomocniczy wyświetlany obok etykiety. |
documentation | string | nie | Czym jest ta rzecz, w pełnym opisie. |
sortText | string | nie | Wartość używana do sortowania, jeśli różni się od etykiety. |
Dodatkowe właściwości są niedozwolone.
MarkupContent
Tekst do wyświetlenia oraz sposób jego oznaczenia.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
kind | string | tak | Sposób oznaczenia tekstu. |
value | string | tak | Tekst. |
Dodatkowe właściwości są niedozwolone.
EntityKindDescriptor
Jeden rodzaj, w którym autor pisze dokument, łączący token podawany w żądaniu z rodzajem deklarowanym przez sam dokument i wskazujący, które operacje przyjmują dokument tego rodzaju.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
kind | string | tak | Token zapisany małymi literami, podawany w żądaniu, np. component lub featurerecipe. |
documentKind | string | tak | Rodzaj deklarowany w nagłówku samego dokumentu. |
acceptedBy | EntityKindAcceptance | tak | Które operacje przyjmują dokument tego rodzaju wskazany samodzielnie — przez ścieżkę albo, w przypadku inspekcji, przez nazwę — bez niczego wysłanego obok. Element ma wartość prawda, gdy dana operacja nie odrzuca dokumentu z powodu jego rodzaju; przyjęty dokument może nadal zostać odrzucony z powodu swojej treści. |
Dodatkowe właściwości są niedozwolone.
EntityKindAcceptance
Dla jednego rodzaju pisanego przez autora: czy każda operacja przyjmuje dokument tego rodzaju wskazany samodzielnie. Każdy element występuje w każdym wpisie, więc fałsz jest stwierdzeniem, a nie pominięciem.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
singleEntityValidation | logiczna | tak | Czy zakres pojedynczej encji polecenia aggrega validate — polecenia, któremu podano ścieżkę jednego dokumentu — sprawdza dokument tego rodzaju. Rodzaj, który odrzuca, jest zamiast tego sprawdzany przez zakres całego katalogu lub zakres encji Release. |
publication | logiczna | tak | Czy aggrega/publishEntity wskazujące sam dokument publikuje dokument tego rodzaju. Rodzaj, którego publikacja wiąże też plik wykonywalny wskazany obok dokumentu — Plugin — ma wartość fałsz, ponieważ żądanie wskazujące sam dokument jest dla niego odrzucane; Manifest i Release mają wartość fałsz, ponieważ żaden z tych rodzajów nie jest publikowany. |
inspectionByName | logiczna | tak | Czy aggrega/entityDefinition rozwiązuje nazwę na encję tego rodzaju, przy czym nazwa jest wysyłana tak, jak zapisuje się ją tam, gdzie jedna encja odwołuje się do drugiej. |
Dodatkowe właściwości są niedozwolone.
RegistryTrust
Polityka zaufania, którą rozwiązywanie stosuje do tego, co udostępnia rejestr.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
signaturesRequired | logiczna | tak | Czy artefakt z tego rejestru musi mieć zweryfikowany podpis. |
verificationSkipped | logiczna | nie | Czy weryfikacja jest pomijana. |
advisory | logiczna | nie | Czy nieudana weryfikacja jest zgłaszana zamiast przerywać działanie. |
anchor | string | nie | Kotwica zaufania, względem której weryfikowane są podpisy. |
keylessIdentities | integer | nie | Ile tożsamości podpisujących jest zaufanych dla tego rejestru. |
Dodatkowe właściwości są niedozwolone.
Registry
Jeden skonfigurowany rejestr. Żadne pole nie zawiera materiału uwierzytelniającego, jego długości, kształtu ani żadnej jego reprezentacji — zgłaszana jest wyłącznie obecność, dzięki czemu wartość można bezpiecznie wkleić do zgłoszenia.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
host | string | tak | Host rejestru, który stanowi jego tożsamość. |
name | string | nie | Przyjazny alias rozwiązywany na hosta, jeśli jest skonfigurowany. |
default | logiczna | tak | Czy jest to rejestr, do którego zwraca się operacja bez wskazanego rejestru. |
authState | string | tak | Czy dane uwierzytelniające dla tego hosta są obecne w magazynie ogólnomaszynowym. Pole jest zgłaszane nawet wtedy, gdy jest puste, aby wywołujący mógł odróżnić „brak danych uwierzytelniających” od „listowanie tego nie sprawdzało”. |
trust | RegistryTrust | tak | Polityka zaufania, którą rozwiązywanie stosuje do tego, co udostępnia rejestr. |
Dodatkowe właściwości są niedozwolone.
TrustFetchOutcome
Wynik odczytu polityki zaufania ogłaszanej przez rejestr. Wyniki są rozdzielone, ponieważ oznaczają różne rzeczy: ogłoszona polityka została przyjęta, rejestr niczego nie ogłosił — co nie jest błędem — w jej miejsce przypięto wbudowaną bazę albo nie podjęto próby odczytu. Tam, gdzie niczego nie ogłoszono, obok podaje się, czy rejestr był w ogóle osiągalny.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
pinned | logiczna | tak | Czy ogłoszona polityka została przyjęta. |
notAdvertised | logiczna | nie | Czy rejestr został zapytany i nie ogłosił żadnej polityki; w takim przypadku operacja przebiega na podstawie tego, co podano w żądaniu. Rejestr, którego zapytanie uniemożliwił tryb offline, nigdy nie jest zgłaszany w ten sposób. Rejestr, z którym nie udało się połączyć, również jest zgłaszany w ten sposób, ponieważ nie zwrócił żadnej polityki, i ma obok ustawione unreachable; aby odróżnić te dwa przypadki, należy odczytać unreachable. |
unreachable | logiczna | nie | Czy z rejestrem nie udało się połączyć przy pobieraniu ogłaszanej przez niego polityki: jego nazwa nie została rozwiązana, połączenie z nim zostało odrzucone lub nie dało się go otworzyć albo nie udało się nawiązać z nim bezpiecznego połączenia. Wartość jest odczytywana z samego błędu, a nie z reason, występuje obok notAdvertised i jest ustawiana tylko tam, gdzie błąd wskazuje, że rejestr nigdy nie został osiągnięty; rejestr, który odpowiedział — bez polityki lub błędem — pozostawia ją nieobecną. |
baseline | logiczna | nie | Czy przypięto wbudowaną bazę, ponieważ nie przyjęto żadnej ogłoszonej polityki; bazę tę ma tylko oficjalny hub. Występuje obok notAdvertised, gdy hub został zapytany i niczego nie ogłosił, a samodzielnie, gdy tryb offline uniemożliwił zapytanie huba. |
skipped | logiczna | nie | Czy nie podjęto próby odczytu, ponieważ podana polityka go zastąpiła lub żądanie go nie wymagało. |
identities | integer | nie | Liczba tożsamości podpisujących zawartych w ogłoszonej polityce. |
reason | string | nie | Dlaczego ogłoszona polityka nie została przyjęta: co zrobił punkt końcowy rejestru albo jaka odmowa trybu offline uniemożliwiła zapytanie. |
Dodatkowe właściwości są niedozwolone.
SkippedRepo
Jedno repozytorium pominięte podczas przechodzenia indeksu, wraz z przyczyną.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
repo | string | tak | Pominięte repozytorium. |
reason | string | tak | Przyczyna pominięcia. |
Dodatkowe właściwości są niedozwolone.
DeprecationNote
Jeden znacznik wycofania napotkany podczas przechodzenia indeksu i to, co z nim zrobiono. Znacznik uwzględniony i znacznik obecny, lecz odrzucony, są zgłaszane na równych zasadach, aby zarejestrowanie wielu nie przechodziło bez echa, podczas gdy odrzucenie jednego jest wyraźnie sygnalizowane.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
repo | string | tak | Repozytorium, w którym znajduje się znacznik. |
version | string | tak | Wersja objęta znacznikiem. |
recorded | logiczna | tak | Czy własny podpis znacznika został zweryfikowany, a w związku z tym indeks go zawiera. |
severity | const “warning” lub const “error” lub const “retracted” | nie | Jak mocno działa znacznik. Dozwolone wartości: "warning" — Wycofana, na łagodniejszym z dwóch poziomów doradczych: nadal wybierana przy wyborze wersji. "error" — Wycofana, na silniejszym z dwóch poziomów doradczych: nadal wybierana przy wyborze wersji. "retracted" — Wycofana z użycia: wykluczana przy wyborze wersji. |
reason | string | nie | Powód, dla którego wersja jest przestarzała. |
Dodatkowe właściwości są niedozwolone.
HostUpdate
Co odświeżenie indeksu zrobiło dla jednego rejestru.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
host | string | tak | Odświeżony host rejestru. |
indexed | integer | tak | Liczba zapisanych rekordów. |
deprecationsExamined | logiczna | tak | Czy podczas przechodzenia w ogóle szukano znaczników wycofania. Jest to oddzielone od licznika, ponieważ „ten rejestr żadnego nie opublikował” i „to uruchomienie nie miało podstaw, by jakiś ocenić” to różne fakty. |
deprecationsRecorded | integer | tak | Liczba uwzględnionych znaczników. |
skipped | SkippedRepo[] lub null | tak | Repozytoria pominięte podczas przechodzenia. |
deprecations | DeprecationNote[] lub null | tak | Znaczniki napotkane podczas przechodzenia. |
readsRetried | integer | tak | Ile odczytów przejścia rejestr odrzucił lub po drodze zerwał, tak że poproszono o nie ponownie, przy czym każdy odczyt liczony jest raz, niezależnie od liczby prób i od tego, czy potem się powiódł; zero, jeśli nie było żadnego. Przejście, którego wszystkie odczyty ostatecznie się powiodły, nie wymienia żadnego repozytorium w skipped, więc to właśnie ta liczba mówi, jak blisko było pominięcia któregoś z nich. Minimum: 0. |
error | string | nie | Co nie powiodło się dla tego hosta, aby przejście przez kilka hostów wskazywało, które z nich zawiodły, bez konieczności korelowania czegokolwiek przez wywołującego. |
unreachable | logiczna | nie | Czy z tym rejestrem nie udało się połączyć: jego nazwa nie została rozwiązana, połączenie z nim zostało odrzucone lub nie dało się go otworzyć albo nie udało się nawiązać z nim bezpiecznego połączenia. Wartość jest odczytywana z samego błędu, a nie z error, jest ustawiana tylko obok error i tylko tam, gdzie błąd wskazuje, że rejestr nigdy nie został osiągnięty; rejestr, który odpowiedział, cokolwiek odpowiedział, pozostawia ją nieobecną. |
Dodatkowe właściwości są niedozwolone.
PublishedVersion
Jedna wersja przechowywana w indeksie dla odwołania: skrót manifestu, na który wskazywał jej tag w chwili budowania indeksu; tam, gdzie polityka zaufania, w ramach której zbudowano indeks, zweryfikowała własny podpis wersji — podpisujący, jako który ją zweryfikowano; oraz, tam, gdzie coś to rejestruje — kiedy wersja została opublikowana, wraz ze źródłem tej informacji. Podpisującego brak dla wersji bez podpisu, dla wersji, której żaden podpis nie został zweryfikowany, oraz tam, gdzie ta polityka nie przypina ani klucza publicznego, ani zaufanej tożsamości lub wyłącza weryfikację podpisów. Żaden z tych przypadków nie daje podstaw do wskazania podpisującego, a jego brak nie oznacza nic więcej. Daty publikacji brak tam, gdzie publikacja jej nie podała i żaden podpis bezkluczowy zweryfikowany przez tę politykę jej nie rejestruje.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
version | string | tak | Wersja, tak jak nazywa ją jej tag. |
manifestDigest | string | tak | Skrót manifestu, na który wskazywał tag wersji w chwili budowania indeksu; adresuje on wersję przez bajty, które wskazuje, a nie przez jej tag. |
signer | VerifiedSignature | nie | Podpis zweryfikowany względem polityki zaufania rejestru: sposób weryfikacji, podpisujący, jako który go zweryfikowano, oraz skrót zweryfikowanego pakietu podpisu. |
publishedAt | string | nie | Kiedy wersja została opublikowana, jako znacznik czasu RFC 3339 w UTC z dokładnością do sekundy. Źródło podaje publishedAtSource; oba pola występują razem albo wcale. |
publishedAtSource | const “transparency-log” lub const “publisher” | nie | Skąd pochodzi publishedAt, aby czasu poświadczonego przez dziennik przejrzystości nigdy nie pomylić z czasem podanym przez wydawcę. Zbiór jest zamknięty. Dozwolone wartości: "transparency-log" — Czas, w którym dziennik przejrzystości zarejestrował bezkluczowy podpis wersji, zweryfikowany przez politykę zaufania, według której zbudowano indeks, wraz z podpisaną obietnicą dziennika dotyczącą tego czasu. Dla wersji podpisanej przy publikacji jest to czas publikacji; dla podpisanej później — czas złożenia tego podpisu. "publisher" — Czas podany przez publikację obok tego, co opublikowała, według zegara maszyny publikującej. Nic go nie poświadcza. Publikacja podaje go, gdy jej podpis nie zawiera poświadczonego czasu: przy podpisie kluczem lub braku podpisu. Gdy dołączono kilka, brany jest najwcześniejszy. |
Dodatkowe właściwości są niedozwolone.
VerifiedSignature
Podpis zweryfikowany względem polityki zaufania rejestru: sposób weryfikacji, podpisujący, jako który go zweryfikowano, oraz skrót zweryfikowanego pakietu podpisu.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
bundleDigest | string | tak | Skrót zweryfikowanego pakietu podpisu, jako sha256:, po którym następują 64 małe znaki szesnastkowe. |
identity | string | nie | Podpisujący, jako który zweryfikowano podpis: dla podpisu bezkluczowego — tożsamość, dla której wystawiono certyfikat podpisujący, czyli jego alternatywna nazwa podmiotu; dla podpisu kluczowego — keyed:sha256:, po którym następuje zapisany małymi znakami szesnastkowy SHA-256 tekstu PEM przypiętego klucza publicznego. |
issuer | string | nie | Wystawca OIDC zapisany w certyfikacie podpisującym, dla podpisu bezkluczowego. Dla podpisu kluczowego jest nieobecny. |
mode | const “keyless” lub const “keyed” | tak | Jak podpis został zweryfikowany. Zbiór jest zamknięty. Dozwolone wartości: "keyless" — Względem certyfikatu podpisującego, którego tożsamość i wystawca odpowiadają tym, którym ufa polityka, który łączy się w łańcuch z korzeniem zaufania przypiętym przez politykę lub, gdy polityka żadnego nie przypina, z publicznym korzeniem Sigstore, i którego podpis rejestruje dziennik przejrzystości. "keyed" — Względem klucza publicznego przypiętego przez politykę. |
Dodatkowe właściwości są niedozwolone.
RegistrySearchRecord
Jeden rekord dopasowany przez wyszukiwanie, tak jak przechowuje go lokalny indeks, wraz z informacją, które z jego wersji opublikowany znacznik oznaczył jako wycofane.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
uri | string | tak | Odwołanie, z którego rozwiązywany jest rekord. |
name | string | tak | Nazwa encji. |
version | string | tak | Wersja, pod którą rekord jest kluczowany. |
versions | string[] | nie | Każda wersja przechowywana w indeksie dla tego odwołania. |
kind | string | nie | Rodzaj encji. |
description | string | nie | Do czego służy encja. |
category | string | nie | Kategoria, w której encja jest opublikowana. |
labels | mapa string | nie | Etykiety deklarowane przez encję. |
pluginType | string | nie | Gniazdo, do którego dołącza się rekord pluginu. |
capabilities | string[] | nie | Możliwości deklarowane przez rekord pluginu. |
manifestDigest | string | nie | Skrót opublikowanego manifestu. |
listingDigest | string | nie | Skrót listingu, z którego odczytano rekord. |
deprecations | object[] | nie | Znaczniki wycofania przechowywane w indeksie dla tego odwołania, każdy z wersją, którą obejmuje, oraz samym zweryfikowanym znacznikiem. |
published | PublishedVersion[] | nie | Każda wersja przechowywana w indeksie dla tego odwołania, w tej samej kolejności co versions, każda ze skrótem manifestu, na który wskazywał jej tag w chwili budowania indeksu, z jej zweryfikowanym podpisującym tam, gdzie polityka zaufania, w ramach której zbudowano indeks, zweryfikowała własny podpis tej wersji, oraz z datą publikacji i jej źródłem tam, gdzie coś je rejestruje. Wersja zapisana bez podpisującego nie ma podpisu zweryfikowanego przez tę politykę i nic więcej się o niej nie mówi. Aby to zarejestrować, z rejestru odczytywane są wyłącznie manifesty, załączniki podpisów i załączniki dat publikacji; zawartość żadnej encji nie jest pobierana. |
retracted | string[] | nie | Wersje, które opublikowany znacznik oznaczył jako wycofane. |
Dodatkowe właściwości są niedozwolone.
RegistrySearchIndex
Aktualność jednego przeszukanego hosta.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
host | string | tak | Host, którego indeks przeszukano. |
lastUpdated | string | nie | Kiedy indeks był ostatnio odświeżany. Gdy migawka nie zawiera czasu, pole jest nieobecne, a nie zerowe, dzięki czemu wywołujący może odróżnić „nie zarejestrowano” od początku epoki. |
Dodatkowe właściwości są niedozwolone.
EffectiveConfigurationSetting
Jedno rozstrzygnięte ustawienie i dokument, z którego pochodzi.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
field | string | tak | Ustawienie. |
value | string | tak | Rozstrzygnięta wartość. |
source | string | tak | Skąd pochodzi wartość. |
Dodatkowe właściwości są niedozwolone.
ImportedFile
Jeden plik zapisywany przez import: szkic dokumentu albo zapis tego, co import zapisał.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
path | string | tak | Miejsce pliku jako ścieżka względna wobec outputDir odpowiedzi. |
content | string | tak | Tekst pliku. |
Dodatkowe właściwości są niedozwolone.
ImportDrift
Jedna część, którą synchronizacja uzgodniła ze źródłem albo uzgodniłaby w trybie dryRun.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
change | string | tak | Jak część się rozjechała: added dla części, którą źródło zyskało; removed dla części, którą usunęło; changed dla części, którą zmieniło. |
file | string | tak | Szkicowany plik zawierający część, jako ścieżka względna wobec outputDir odpowiedzi. |
key | string[] | tak | Klucze prowadzące do części od wierzchołka szkicowanej encji Aggregate lub Release, po jednym wpisie na klucz, dzięki czemu klucz zawierający kropkę pozostaje jednym wpisem. Puste, gdy częścią jest cały plik. |
Dodatkowe właściwości są niedozwolone.
ImportOwed
Wartość, którą wersje robocze wciąż pozostawiają pustą, której żadne źródło nie mogło dostarczyć i której nie dostarczyła żadna odpowiedź.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
file | string | tak | Wygenerowany plik, w którym znajduje się wartość, jako ścieżka względem outputDir odpowiedzi. |
key | string[] | tak | Klucze prowadzące do wartości od początku tego dokumentu, jeden wpis na klucz, więc klucz zawierający kropkę pozostaje jednym wpisem. Odpowiedź wysłana jako answered wskazuje wartość za pomocą tych kluczy. |
question | string | tak | Czym jest wartość: opis jej schematu, w przeciwnym razie komentarz, który szkic zapisuje nad jej kluczem, a w przeciwnym razie to, co według jej schematu przyjmuje. |
sensitive | logiczna | tak | Czy wartość należy do sekretu, którego odpowiedź wskazuje, skąd pochodzi sekret, i nigdy nie zawiera samego sekretu. |
secretAdvice | string | nie | Obecne przy wartości sekretu: jaka musi być jej odpowiedź, w zdaniu pokazywanym osobie odpowiadającej na nią w terminalu — albo, gdy odpowiedź wysłana dla niej jako answered została odrzucona, dlaczego została odrzucona. |
Dodatkowe właściwości są niedozwolone.
ImportAnswered
Jedna odpowiedź dla wartości wymienionej w owed odpowiedzi.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
file | string | tak | Wygenerowany plik, w którym znajduje się wartość, tak jak wskazuje go owed. |
key | string[] | tak | Klucze prowadzące do wartości, tak jak wskazuje je owed. |
answer | string | tak | Odpowiedź. Pusta odpowiedź pozostawia wartość jako brakującą. |
Dodatkowe właściwości są niedozwolone.
ImportDiagnostic
Jedna rzecz, której konwersja nie zdołała przekonwertować. To najużyteczniejszy wynik konwersji, dlatego jest raportowany w całości, a nie sprowadzany do werdyktu.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
severity | string | tak | Jak poważna jest sprawa. |
message | string | tak | Czego nie udało się przekonwertować. |
code | string | nie | Nazwa warunku nadająca się do cytowania, jeśli ją ma. |
Dodatkowe właściwości są niedozwolone.
ImportDecision
Jak konwersja odwzorowała jeden węzeł źródłowy: Components z katalogu rozważone przez importer, wybrany spośród nich, powód wyboru i sposób jego zamiany.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
sourceNode | DecisionSourceNode | tak | Węzeł źródłowy, którego dotyczy decyzja odwzorowania. |
candidates | ImportCandidate[] | nie | Components z katalogu rozważone przez importer dla węzła, każdy z oceną. Nieobecne, gdy nie rozważył żadnego. |
chosen | DecisionChoice | nie | Co importer wybrał dla węzła źródłowego. Nieobecne w decyzji, w której nie dokonał wyboru. |
rationale | string | nie | Dlaczego importer dokonał wyboru, jego własnymi słowami. Nieobecne, gdy nic nie zapisał. |
swapHint | string | nie | Jak zamienić wybór na alternatywę, słowami importera. Nieobecne, gdy nic nie zapisał. |
Dodatkowe właściwości są niedozwolone.
DecisionSourceNode
Węzeł źródłowy, którego dotyczy decyzja odwzorowania.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
id | string | tak | Identyfikator węzła w źródle. |
type | string | tak | Typ węzła w nazewnictwie źródła. |
paramsSummary | string | tak | Podsumowanie parametrów węzła do wyświetlenia obok decyzji. |
Dodatkowe właściwości są niedozwolone.
ImportCandidate
Jedna encja Component z katalogu rozważona przez importer dla węzła źródłowego.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
componentName | string | tak | Nazwa encji Component. |
score | liczba | tak | Jak dobrze encja Component pasuje do węzła według oceny importera. |
tier | string | tak | Poziom dopasowania, w który wpada ocena. |
signals | CandidateSignals | tak | Wkład każdego z sygnałów importera w ocenę kandydata. |
Dodatkowe właściwości są niedozwolone.
CandidateSignals
Wkład każdego z sygnałów importera w ocenę kandydata.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
table | liczba | tak | Wkład sygnału tabeli odwzorowań. |
category | liczba | tak | Wkład sygnału kategorii. |
domainLabels | liczba | tak | Wkład sygnału etykiet domeny. |
shape | liczba | tak | Wkład sygnału kształtu. |
name | liczba | tak | Wkład sygnału nazwy. |
Dodatkowe właściwości są niedozwolone.
DecisionChoice
Co importer wybrał dla węzła źródłowego. Nieobecne w decyzji, w której nie dokonał wyboru.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
target | string | tak | Nazwa wybranej encji Component: istniejącej w katalogu albo naszkicowanej dla węzła. |
mode | string | tak | Jak zapisano wybór: jako odwołanie do istniejącej encji Component albo jako nowo naszkicowaną encję. |
tier | string | tak | Poziom dopasowania wyboru. |
Dodatkowe właściwości są niedozwolone.
LintFileFindings
Co sprawdzenie konwencji znalazło w jednym dokumencie.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
file | string | tak | Dokument. |
diagnostics | Diagnostic[] lub null | tak | Znaleziska w nim. |
Dodatkowe właściwości są niedozwolone.
PluginRetractionExclusion
Jedna wersja, która była dostępna i nie została wybrana.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
version | string | tak | Pominięta wersja. |
reason | string | nie | Przyczyna pominięcia. |
Dodatkowe właściwości są niedozwolone.
PluginRetractionProvenance
Skąd pochodzi wiedza o tym, co jest wycofane.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
source | string | tak | Co sprawdzono. |
lastUpdated | string | nie | Kiedy ostatnio to odświeżono. |
Dodatkowe właściwości są niedozwolone.
PluginRetraction
Jak znacznik wycofania wpłynął na to, która wersja wtyczki została przypięta.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
reference | string | tak | Odwołanie, do którego należą wersje. |
selected | string | nie | Przypięta wersja. |
excluded | PluginRetractionExclusion[] | nie | Wersje, które były dostępne i zostały pominięte. |
unscreened | string | nie | Czego nie udało się sprawdzić pod kątem znacznika i dlaczego. |
provenance | PluginRetractionProvenance | nie | Skąd pochodzi wiedza o tym, co jest wycofane. |
Dodatkowe właściwości są niedozwolone.
PluginGeneratedDocument
Jeden dokument katalogu wytworzony przez generowanie.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
path | string | tak | Miejsce dokumentu jako ścieżka względna wobec katalogu głównego obszaru roboczego. |
content | string | tak | Tekst dokumentu. |
Dodatkowe właściwości są niedozwolone.
PluginCommandFlag
Jedna flaga deklarowana przez wtyczkę w dostarczanym przez nią poleceniu.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
name | string | tak | Długa nazwa flagi. |
shorthand | string | nie | Jednoznakowy alias flagi, jeśli go ma. |
description | string | nie | Jednowierszowy tekst pomocy flagi. |
type | string | nie | Typ wartości flagi. |
default | string | nie | Wartość używana, gdy flaga nie zostanie podana. |
Dodatkowe właściwości są niedozwolone.
PluginCLICommand
Jeden czasownik polecenia najwyższego poziomu dostarczany przez wtyczkę.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
name | string | tak | Czasownik polecenia. |
description | string | nie | Jednowierszowy tekst pomocy polecenia. |
flags | PluginCommandFlag[] | nie | Flagi polecenia w kolejności deklaracji. |
Dodatkowe właściwości są niedozwolone.
ConfigCapturedAttachment
Jedno dołączenie zapisane przez zamrożenie we własnej konfiguracji tego obszaru roboczego.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
uri | string | nie | Odwołanie, z którego rozstrzyga się dołączenie. |
capability | string | nie | Funkcjonalność, której dotyczy dołączenie. |
function | string | nie | Eksport, do którego kierowane jest dołączenie. |
role | string | nie | Rola, w której działa dołączenie; określa ona, co może ono emitować. |
Dodatkowe właściwości są niedozwolone.
ConfigCapturedSocket
Jedno gniazdo zapisane przez zamrożenie wraz z zamrożonymi w nim dołączeniami.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
socket | string | tak | Gniazdo. |
field | string | tak | Pole konfiguracji, pod którym zapisano gniazdo. |
attachments | ConfigCapturedAttachment[] lub null | tak | Dołączenia zamrożone w gnieździe. |
Dodatkowe właściwości są niedozwolone.
ExplainErrorEntry
Jeden opublikowany fragment objaśniający poprawkę autorską dla danego warunku.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
heading | string | tak | Nagłówek fragmentu. |
body | string | tak | Fragment. |
Dodatkowe właściwości są niedozwolone.
SignedArtifact
Jeden opublikowany artefakt objęty podpisaniem.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
reference | string | tak | Podpisane odwołanie. |
digest | string | tak | Skrót tego, co podpisano. |
Dodatkowe właściwości są niedozwolone.
DeprecationMarked
Jedna opublikowana wersja oznaczona przez wycofanie.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
reference | string | tak | Oznaczone odwołanie. |
severity | const “warning” lub const “error” lub const “retracted” | tak | Jak mocno działa znacznik. Dozwolone wartości: "warning" — Wycofana, na łagodniejszym z dwóch poziomów doradczych: nadal wybierana przy wyborze wersji. "error" — Wycofana, na silniejszym z dwóch poziomów doradczych: nadal wybierana przy wyborze wersji. "retracted" — Wycofana z użycia: wykluczana przy wyborze wersji. |
issuedOn | string | tak | Kiedy wydano znacznik. |
digest | string | tak | Skrót opublikowanego znacznika. |
Dodatkowe właściwości są niedozwolone.
InitializeResult
Co sesja ustaliła dla tego klienta i z której warstwy konfiguracji to rozwiązała.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
capabilities | ServerCapabilities | tak | Co demon będzie robić w tej sesji, ustalone względem tego, co klient zadeklarował, że obsługuje. |
workspaceRoot | string | tak | Obszar roboczy, nad którym otwarto sesję. |
configSource | string | tak | Warstwa konfiguracji, z której sesja rozwiązała swoje ustawienia. |
workspaceMarker | string | nie | Plik, który zidentyfikował katalog główny obszaru roboczego, jeśli taki był. |
version | string | tak | Wersja pliku binarnego obsługującego tę sesję: ta sama wartość, którą aggrega version zgłasza dla tego pliku binarnego. Opisuje działający proces, więc po zastąpieniu pliku, z którego uruchomiono demona, nadal wskazuje działającą wersję, podczas gdy odpytanie pliku wskazuje wersję, która go zastąpiła. |
Dodatkowe właściwości są niedozwolone.
ValidateResult
Co wykazało sprawdzenie i jak dużo sprawdzono.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
diagnostics | Diagnostic[] lub null | tak | Wyniki. Gdy sprawdzenie niczego nie wykazało, jest to null, a nie pusta lista. |
checked | string | nie | Jak dużo sprawdzono — jeden dokument albo zawartość obszaru roboczego. |
Dodatkowe właściwości są niedozwolone.
InvalidateResult
Czy demon przechowywał cokolwiek o dokumencie, co należało porzucić.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
invalidated | logiczna | tak | Czy cokolwiek porzucono. |
Dodatkowe właściwości są niedozwolone.
DiagnosticsResult
Wyniki, które demon już przechowuje dla dokumentu.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
diagnostics | Diagnostic[] lub null | tak | Wyniki. Gdy ich nie ma, jest to null, a nie pusta lista. |
Dodatkowe właściwości są niedozwolone.
IrGraphResult
Rozwiązany graf, do którego kompiluje się encja Release.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
graph | any | tak | Dokument grafu. Wartości, które autor zadeklarował jako wrażliwe, są z niego usuwane, chyba że żądanie poprosiło o nie przez unredacted; wszystko inne jest przekazywane tak, jak wyemitował to kompilator. Jego własny kształt to opublikowany kontrakt grafu i nie jest tu powtarzany. |
Dodatkowe właściwości są niedozwolone.
BuildResult
Co zapisała kompilacja.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
outputDirectory | string | tak | Katalog, do którego zapisano artefakty. |
files | string[] lub null | tak | Zapisane artefakty jako ścieżki względem katalogu wyjściowego. |
notices | BuildNotice[] | nie | Wszystko, o czym kompilacja chce poinformować wywołującego, a co nie jest ani wynikiem, ani błędem. |
dependencyResolution | DependencyResolutionReport | nie | Co rozwiązywanie zależności przypięło i pozyskało. |
Dodatkowe właściwości są niedozwolone.
BuildPreviewResult
Co zapisałaby kompilacja. Niczego nie zapisano, więc nie ma katalogu wyjściowego do wskazania.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
files | string[] lub null | tak | Artefakty, które powstałyby przy zapisie. |
notices | BuildNotice[] | nie | Wszystko, o czym kompilacja chce poinformować wywołującego, a co nie jest ani wynikiem, ani błędem. |
Dodatkowe właściwości są niedozwolone.
EntityDefinitionResult
Do czego rozwiązuje się nazwa encji i dokument, który ją definiuje. Odpowiedź odczytana z referencji rejestru zawiera published, a odpowiedź rozwiązana przez katalog po nazwie nigdy go nie zawiera.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
kind | string | tak | Rodzaj encji. |
name | string | tak | Nazwa encji. |
version | string | tak | Rozwiązana wersja. |
description | string | nie | Do czego według dokumentu służy encja. |
publishScope | string | nie | Jak szeroko encja jest opublikowana. |
file | string | tak | Dokument, który ją definiuje. |
authoredLength | integer | tak | Ile bajtów zawiera dokument autorski, aby klient mógł odróżnić dokument autorski od jego rozwiązanej postaci. |
definition | string | tak | Tekst definicji. |
published | PublishedArtifact | nie | Co odczytała referencja rejestru: współrzędna, sposób, w jaki przechowywała encję, i manifest, przez który ją odczytano. Wszędzie tam, gdzie ten obiekt występuje, obecne jest każde pole. |
Dodatkowe właściwości są niedozwolone.
PublishedArtifact
Co odczytała referencja rejestru: współrzędna, sposób, w jaki przechowywała encję, i manifest, przez który ją odczytano. Wszędzie tam, gdzie ten obiekt występuje, obecne jest każde pole.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
reference | string | tak | Odczytana referencja rejestru. |
archive | logiczna | tak | Czy bajty współrzędnej były archiwum, z którego rozpakowano dokument encji. False, gdy współrzędna zawierała sam dokument encji. |
mediaType | string | tak | Typ artefaktu deklarowany przez manifest. |
manifestDigest | string | tak | Skrót manifestu, przez który odczytano encję — wartość, którą należy podać po @, aby ponownie odczytać dokładnie te same bajty. |
Dodatkowe właściwości są niedozwolone.
ReleaseClosureResult
Wszystko, od czego zależy encja Release, w zakresie osiągniętym przez rozwiązywanie. Zgłasza domknięcie, a nie wyprowadzony z niego graf: to inny dokument o tej samej encji Release.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
release | string | tak | Sprawdzana encja Release. |
aggregate | string | tak | Encja Aggregate, którą wdraża. |
manifest | string | tak | Encja Manifest, przez którą jest rozwiązywana. |
environment | string | tak | Środowisko, które wskazuje. |
entities | ClosureEntity[] lub null | tak | Encje osiągane przez domknięcie. |
libraries | ClosureEntity[] lub null | tak | Biblioteki osiągane przez domknięcie. |
plugins | ClosureEntity[] lub null | tak | Wtyczki osiągane przez domknięcie. |
mappingDiagnostics | string[] lub null | tak | Co zgłosiło rozwiązywanie mapowań encji Manifest. |
deprecations | string[] lub null | tak | Znaczniki wycofania napotkane przez domknięcie. |
Dodatkowe właściwości są niedozwolone.
ResolveDependenciesResult
Co rozwiązywanie zależności przypięło i pozyskało, a także wszystko, o czym chce poinformować wywołującego. Pola raportu są umieszczone bezpośrednio w tej odpowiedzi, a nie zagnieżdżone w jednym z jej elementów.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
lockfile | string | tak | Plik blokady zapisany przez rozwiązywanie lub plik, z którym porównywała weryfikacja. |
verified | logiczna | nie | Czy żądanie było weryfikacją, która porównała zapisany plik blokady i nie zapisała pliku blokady, rekordu zaufania wtyczek ani entity.lock. |
entities | ClosureEntity[] lub null | tak | Encje przypięte przez rozwiązywanie lub porównane przez weryfikację. |
libraries | ClosureEntity[] lub null | tak | Biblioteki przypięte przez rozwiązywanie lub porównane przez weryfikację. |
plugins | ClosureEntity[] lub null | tak | Wtyczki przypięte przez rozwiązywanie lub porównane przez weryfikację. |
sourceArtifacts | integer | tak | Liczba pozyskanych artefaktów źródłowych. |
trustedPlugins | integer | tak | Liczba przypiętych wtyczek ze zweryfikowanym podpisem. |
toolchain | ToolchainReport | nie | Kompilator, który dokonał rozwiązania, i wtyczki, które zawiera. |
externalInputs | integer | tak | Liczba pozyskanych zewnętrznych danych wejściowych, z których korzysta renderowanie. |
incompleteExternalInputs | string | nie | Których zewnętrznych danych wejściowych nie udało się pozyskać, jeśli takie są. |
notices | string[] | nie | Wszystko, o czym rozwiązywanie chce poinformować wywołującego. |
Dodatkowe właściwości są niedozwolone.
PinResult
Co krok przypinania zrobił z blokadą obok encji lub zrobiłby w przebiegu próbnym. Jest to odpowiedź na aggrega/pin, a publikacja, która wykonała ten krok, zawiera ją jako pin.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
entity | string | tak | Dokument encji odczytany przez krok, jako ścieżka względem katalogu głównego obszaru roboczego. |
kind | string | tak | Rodzaj encji, tak jak deklaruje go jej dokument. |
name | string | tak | Nazwa encji, tak jak deklaruje ją jej dokument. |
pinnable | logiczna | tak | Czy encja tego rodzaju odczytuje cokolwiek, dla czego blokada zapisuje przypięcie, co robią encje Recipe i FeatureRecipe. Gdy jest to false, niczego obok encji nie zmieniono, changed ma wartość false, a lock, removed, pins i content są nieobecne. |
lock | string | nie | Blokada, którą krok zapisał lub zapisałby, jako ścieżka względem katalogu głównego obszaru roboczego. |
changed | logiczna | tak | Czy blokada się zmieniła lub zmieniłaby się w przebiegu próbnym. False, gdy blokada już zawierała każde przypięcie potrzebne encji i pozostała identyczna co do bajtu. |
removed | logiczna | nie | Czy zmiana jest usunięciem: encja nie odczytuje niczego, dla czego blokada zapisuje przypięcie, więc obok niej nie pozostaje żadna blokada. |
dryRun | logiczna | nie | Czy zgłaszane jest to, co krok by zrobił, a nie to, co zrobił. |
pins | PinClassCount[] | nie | Ile przypięć każdej klasy zawiera blokada po kroku lub zawierałaby po przebiegu próbnym. Wymieniona jest każda klasa, którą blokada może zawierać, łącznie z klasą bez przypięć. |
content | string | nie | Blokada, którą zapisałby przebieg próbny. Nieobecna, gdy blokada pozostałaby bez zmian lub zostałaby usunięta, oraz w każdej odpowiedzi, która nie dotyczy przebiegu próbnego. |
Dodatkowe właściwości są niedozwolone.
PinClassCount
Ile przypięć jednej klasy zawiera blokada.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
class | string | tak | Klasa przypięcia, słowami, których używa odmowa wskazująca brakujące przypięcie — na przykład remote source lub imported file. |
pins | integer | tak | Ile przypięć tej klasy zawiera blokada. |
Dodatkowe właściwości są niedozwolone.
CacheStatusResult
Co zawierają pamięci podręczne obsługujące ten obszar roboczy.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
classes | CacheClass[] lub null | tak | Każda pamięć podręczna i jej zawartość. |
provenance | CacheProvenance[] lub null | tak | Pod jakimi tożsamościami pozyskano artefakty z pamięci podręcznej. |
totalCount | integer | tak | Łączna liczba wpisów w pamięciach podręcznych. |
totalSize | integer | tak | Łączna liczba zajmowanych przez nie bajtów. |
totalSizeText | string | tak | Ta sama suma zapisana w formie czytelnej dla człowieka. |
scope | CacheScope | tak | Zasięg odpowiedzi dotyczącej pamięci podręcznej. Dwie klasy pamięci podręcznej są współdzielone przez wszystkie projekty na maszynie, dlatego każda taka odpowiedź podaje, których klas dotyczyła — w przeciwnym razie sesję otwartą dla jednego obszaru roboczego można by odczytać jako raportującą wyłącznie o tym obszarze. |
Dodatkowe właściwości są niedozwolone.
CachePruneResult
Co odzyskiwanie miejsca usunęło, co zachowało i czego nie mogło odzyskać.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
removed | CacheRemoval[] lub null | tak | Co zostało usunięte. |
heldOpen | CacheRemoval[] lub null | tak | Co czyszczenie usunęłoby, ale pozostawiło na miejscu, ponieważ inny proces miał to otwarte. Tylko Windows odmawia usunięcia otwartego pliku, więc w pozostałych systemach ta lista jest pusta. Te wpisy nie są liczone ani jako usunięte, ani jako zachowane, żaden z ich bajtów nie jest liczony jako odzyskany, a późniejsze czyszczenie je odzyska; wpis będący katalogiem mógł już utracić pliki, które nie były otwarte. |
retainedCount | integer | tak | Liczba zachowanych wpisów. |
reclaimedBytes | integer | tak | Liczba odzyskanych bajtów. |
reclaimedBytesText | string | tak | Ta sama wartość zapisana w formie czytelnej dla człowieka. |
unattributedCount | integer | tak | Liczba wpisów, do których nie rości sobie prawa żaden posiadacz. |
unattributedSize | integer | tak | Liczba bajtów, które zajmują. |
unattributedSizeText | string | tak | Ta sama wartość zapisana w formie czytelnej dla człowieka. |
notPruneEligible | CacheShortfall[] lub null | tak | Co pozostało i co pozwoliłoby to odzyskać. |
scope | CacheScope | tak | Zasięg odpowiedzi dotyczącej pamięci podręcznej. Dwie klasy pamięci podręcznej są współdzielone przez wszystkie projekty na maszynie, dlatego każda taka odpowiedź podaje, których klas dotyczyła — w przeciwnym razie sesję otwartą dla jednego obszaru roboczego można by odczytać jako raportującą wyłącznie o tym obszarze. |
Dodatkowe właściwości są niedozwolone.
CacheEvictResult
Co usunęło odzyskiwanie miejsca do zadanego rozmiaru i co pozostało.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
withinCapBefore | logiczna | tak | Czy przechowywana zawartość mieściła się już w zadanym rozmiarze, tak że nic nie trzeba było usuwać. |
removed | CacheRemoval[] lub null | tak | Co zostało usunięte. |
heldOpen | CacheRemoval[] lub null | tak | Co odzyskiwanie usunęłoby, ale pozostawiło na miejscu, ponieważ inny proces miał to otwarte; zamiast tego przeszło do kolejnego najstarszego wpisu. Tylko Windows odmawia usunięcia otwartego pliku, więc w pozostałych systemach ta lista jest pusta. Te wpisy nadal wliczają się do pozostałych bajtów, a późniejsze odzyskiwanie może je usunąć. |
totalBefore | integer | tak | Liczba bajtów przechowywanych wcześniej. |
totalBeforeText | string | tak | Ta sama wartość zapisana w formie czytelnej dla człowieka. |
reclaimedBytes | integer | tak | Liczba odzyskanych bajtów. |
reclaimedBytesText | string | tak | Ta sama wartość zapisana w formie czytelnej dla człowieka. |
remainingBytes | integer | tak | Liczba pozostałych bajtów. |
remainingBytesText | string | tak | Ta sama wartość zapisana w formie czytelnej dla człowieka. |
capBytes | integer | tak | Rozmiar w bajtach, do którego odzyskiwano miejsce. |
capBytesText | string | tak | Ten sam rozmiar zapisany w formie czytelnej dla człowieka. |
scope | CacheScope | tak | Zasięg odpowiedzi dotyczącej pamięci podręcznej. Dwie klasy pamięci podręcznej są współdzielone przez wszystkie projekty na maszynie, dlatego każda taka odpowiedź podaje, których klas dotyczyła — w przeciwnym razie sesję otwartą dla jednego obszaru roboczego można by odczytać jako raportującą wyłącznie o tym obszarze. |
Dodatkowe właściwości są niedozwolone.
CacheClearResult
Ile miejsca odzyskało opróżnienie pamięci podręcznych.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
cleared | CacheCleared[] lub null | tak | Każda opróżniona pamięć podręczna. |
reclaimedBytes | integer | tak | Liczba odzyskanych bajtów. |
reclaimedBytesText | string | tak | Ta sama wartość zapisana w formie czytelnej dla człowieka. |
scope | CacheScope | tak | Zasięg odpowiedzi dotyczącej pamięci podręcznej. Dwie klasy pamięci podręcznej są współdzielone przez wszystkie projekty na maszynie, dlatego każda taka odpowiedź podaje, których klas dotyczyła — w przeciwnym razie sesję otwartą dla jednego obszaru roboczego można by odczytać jako raportującą wyłącznie o tym obszarze. |
Dodatkowe właściwości są niedozwolone.
RegistryListResult
Rejestry, przez które ten obszar roboczy rozwiązuje zależności.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
registries | Registry[] lub null | tak | Każdy skonfigurowany rejestr. |
credentialStateIsMachineWide | logiczna | tak | Czy obecność poświadczeń zgłaszana dla każdego rejestru jest faktem dotyczącym całej maszyny, a nie obszaru roboczego. Jest zgłaszana, aby odpowiedzi w zakresie sesji nie odczytano jako zaprzeczenia szerszego zasięgu. |
Dodatkowe właściwości są niedozwolone.
SearchResult
Co lokalne indeksy rejestrów zwróciły dla wyszukiwania.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
records | RegistrySearchRecord[] lub null | tak | Pasujące rekordy. |
indexes | RegistrySearchIndex[] lub null | tak | Każdy przeszukany host i czas ostatniego odświeżenia jego indeksu. |
missingIndexHosts | string[] lub null | tak | Skonfigurowane hosty bez lokalnego indeksu do przeszukania, aby krótka odpowiedź była wyjaśniona, a nie pozostawiona do domysłu. |
stale | logiczna | tak | Czy którykolwiek przeszukany indeks jest na tyle stary, że warto go odświeżyć. |
registriesConfigured | logiczna | tak | Czy w ogóle skonfigurowano jakikolwiek rejestr, co odróżnia „nic nie pasowało” od „nic nie przeszukano”. |
Dodatkowe właściwości są niedozwolone.
RegistryAddResult
Co zapisała rejestracja rejestru, gdzie, i co odczytała z samego rejestru.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
host | string | tak | Host, pod którego kluczem zapisano wpis; nie zawsze jest to pisownia użyta w żądaniu. |
scope | ConfigWriteScope | tak | Który dokument konfiguracyjny został zapisany i jaki ma zasięg. Żądanie wskazuje jeden obszar roboczy, więc odpowiedź, która nic by o tym nie mówiła, zostałaby odczytana jako dotycząca tego obszaru — a w przypadku zapisu obejmującego całą maszynę taki odczyt jest błędny. |
trust | TrustFetchOutcome | tak | Wynik odczytu polityki zaufania ogłaszanej przez rejestr. Wyniki są rozdzielone, ponieważ oznaczają różne rzeczy: ogłoszona polityka została przyjęta, rejestr niczego nie ogłosił — co nie jest błędem — w jej miejsce przypięto wbudowaną bazę albo nie podjęto próby odczytu. Tam, gdzie niczego nie ogłoszono, obok podaje się, czy rejestr był w ogóle osiągalny. |
Dodatkowe właściwości są niedozwolone.
RegistryRemoveResult
Co zapisało usunięcie rejestru i gdzie.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
host | string | tak | Host, którego wpis usunięto. |
scope | ConfigWriteScope | tak | Który dokument konfiguracyjny został zapisany i jaki ma zasięg. Żądanie wskazuje jeden obszar roboczy, więc odpowiedź, która nic by o tym nie mówiła, zostałaby odczytana jako dotycząca tego obszaru — a w przypadku zapisu obejmującego całą maszynę taki odczyt jest błędny. |
Dodatkowe właściwości są niedozwolone.
RegistryUpdateResult
Co odświeżenie lokalnych indeksów zrobiło dla poszczególnych hostów.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
hosts | HostUpdate[] lub null | tak | Co odświeżenie zrobiło dla każdego hosta. |
failed | string[] lub null | tak | Hosty, dla których nie udało się dokończyć odświeżenia. |
indexRoot | string | tak | Katalog, w którym zapisano indeksy. |
registriesConfigured | logiczna | tak | Czy w ogóle skonfigurowano jakikolwiek rejestr. |
reachedRegistries | logiczna | tak | W tej odpowiedzi zawsze true: odświeżenie indeksów łączy się z samymi rejestrami, podczas gdy ich wyświetlanie i wyszukiwanie odpowiadają na podstawie konfiguracji i lokalnego indeksu. Czy dany rejestr faktycznie osiągnięto, podaje jego własny wpis w hosts, przez unreachable. |
Dodatkowe właściwości są niedozwolone.
LogoutResult
Które zapisane poświadczenie usunięto i jak daleko sięga magazyn.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
registry | string | tak | Rejestr, którego poświadczenie usunięto. |
scope | CredentialStoreScope | tak | Zasięg zmiany poświadczeń. Magazyn jest współdzielony przez wszystkie projekty na maszynie i przez wszystkie inne narzędzia korzystające z tych samych rejestrów, dlatego odpowiedź to zgłasza, zamiast pozostawiać domysłom, że zmiana dotyczy tylko sesji. |
Dodatkowe właściwości są niedozwolone.
PublishEntityResult
Co i gdzie trafiło w wyniku publikacji encji. Publikacja, która najpierw wykonała krok przypinania, zawiera też to, co ten krok zrobił, jako pin; pole to jest nieobecne, gdy krok nie został wykonany.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
reference | string | tak | Referencja, pod którą opublikowano encję. |
tag | string | tak | Tag, pod którym ją opublikowano. |
kind | string | tak | Rodzaj opublikowanej encji. |
mediaType | string | tak | Typ nośnika zapisany dla opublikowanych bajtów. |
size | integer | tak | Liczba opublikowanych bajtów. |
sizeText | string | tak | Ten sam rozmiar zapisany w formie czytelnej dla człowieka. |
pluginSize | integer | nie | Liczba bajtów zajmowanych przez moduł pluginu opublikowany wraz z encją Plugin. |
pluginSizeText | string | nie | Ten sam rozmiar zapisany w formie czytelnej dla człowieka. |
digest | string | tak | Skrót (digest) tego, co opublikowano. Przy przebiegu próbnym: skrót, który dałaby publikacja tej samej treści, obliczony wyłącznie z treści — ten, który wypisuje aggrega push --dry-run. |
signed | logiczna | tak | Czy ta publikacja dołączyła podpis: ten, który złożyła przed publikacją, albo — w przypadku wersji już opublikowanej — podpis, którego ta wersja nie miała. |
alreadyPublished | logiczna | tak | Czy te same bajty już istniały, więc nie przesłano żadnej treści. Dołączono obok tylko to, czego tej publikacji jeszcze brakowało: datę publikacji oraz, jeśli ta publikacja podpisuje, podpis; signed określa, czy podpis został dołączony. |
dryRun | logiczna | tak | Czy wynik opisuje to, co dałaby publikacja, a nie to, co faktycznie zrobiła. |
reach | PublicationReach | tak | Zasięg publikacji. Te odpowiedzi sięgają całkowicie poza tę maszynę — to, co dołączają, jest tym, co rozwiązuje każdy konsument danego rejestru — dlatego każda wymienia każdy rejestr, do którego się zwróciła, oraz to, czy wywołanie cokolwiek tam dołączyło. |
pin | PinResult | nie | Co krok przypinania zrobił z blokadą obok encji lub zrobiłby w przebiegu próbnym. Jest to odpowiedź na aggrega/pin, a publikacja, która wykonała ten krok, zawiera ją jako pin. |
wholeDirectorySource | string | nie | Lokalne źródło encji w postaci, w jakiej je napisano; obecne, gdy jest zapisane jako szablon. Takie źródło wskazuje swój katalog dopiero wtedy, gdy encja Release wypełni szablon, dlatego publikacja zawiera wszystkie pliki z katalogu encji, a nie tylko pliki przez nią wskazane. Nieobecne, gdy publikacja zawiera tylko te pliki. |
windowsUnusableEntries | string[] | nie | Wpisy opublikowanego archiwum, których ścieżka zawiera element, którego Windows nie może przechowywać w zapisanej postaci — nazwę zarezerwowaną przez Windows dla urządzenia, taką jak CON, AUX lub NUL, w dowolnej wielkości liter i z dowolnym rozszerzeniem, albo element kończący się kropką lub spacją — najpierw nazwa pliku samego dokumentu encji, potem pliki, które zawiera. Obszar roboczy w systemie Windows odmawia ich rozpakowania, więc nie może użyć tej wersji; publikacja przebiega lub zatrzymuje się dokładnie tak, jak bez nich. Nieobecne, gdy takich wpisów nie ma, co obejmuje encję opublikowaną jako sam dokument. |
Dodatkowe właściwości są niedozwolone.
PublishArtifactResult
Co i gdzie trafiło w wyniku publikacji pliku.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
reference | string | tak | Referencja, pod którą opublikowano plik. |
tag | string | tak | Tag, pod którym ją opublikowano. |
mediaType | string | tak | Typ nośnika zapisany dla opublikowanych bajtów. |
size | integer | tak | Liczba opublikowanych bajtów. |
sizeText | string | tak | Ten sam rozmiar zapisany w formie czytelnej dla człowieka. |
digest | string | tak | Skrót (digest) tego, co opublikowano. |
alreadyPublished | logiczna | tak | Czy te same bajty już istniały, więc nie przesłano żadnej treści. Datę publikacji dołączono obok tylko wtedy, gdy artefakt jej nie miał. |
dryRun | logiczna | tak | Czy wynik opisuje to, co dałaby publikacja, a nie to, co faktycznie zrobiła. |
reach | PublicationReach | tak | Zasięg publikacji. Te odpowiedzi sięgają całkowicie poza tę maszynę — to, co dołączają, jest tym, co rozwiązuje każdy konsument danego rejestru — dlatego każda wymienia każdy rejestr, do którego się zwróciła, oraz to, czy wywołanie cokolwiek tam dołączyło. |
Dodatkowe właściwości są niedozwolone.
SignArtifactsResult
Co podpisano i gdzie trafiły podpisy.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
signed | SignedArtifact[] lub null | tak | Każda podpisana referencja. |
reach | PublicationReach | tak | Zasięg publikacji. Te odpowiedzi sięgają całkowicie poza tę maszynę — to, co dołączają, jest tym, co rozwiązuje każdy konsument danego rejestru — dlatego każda wymienia każdy rejestr, do którego się zwróciła, oraz to, czy wywołanie cokolwiek tam dołączyło. |
Dodatkowe właściwości są niedozwolone.
DeprecateArtifactResult
Co oznaczono jako przestarzałe i gdzie trafiły znaczniki.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
marked | DeprecationMarked[] lub null | tak | Każda oznaczona wersja. |
reach | PublicationReach | tak | Zasięg publikacji. Te odpowiedzi sięgają całkowicie poza tę maszynę — to, co dołączają, jest tym, co rozwiązuje każdy konsument danego rejestru — dlatego każda wymienia każdy rejestr, do którego się zwróciła, oraz to, czy wywołanie cokolwiek tam dołączyło. |
Dodatkowe właściwości są niedozwolone.
ResolveResult
Gdzie zdefiniowano element pod kursorem.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
location | null lub Location | tak | Miejsce definicji. Ma wartość null, gdy nic pod kursorem nie prowadzi do definicji. |
Dodatkowe właściwości są niedozwolone.
FindReferencesResult
Gdzie występują odwołania do elementu pod kursorem.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
locations | Location[] lub null | tak | Każde miejsce odwołania. |
Dodatkowe właściwości są niedozwolone.
FindImplementationsResult
Które dokumenty implementują element pod kursorem.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
locations | Location[] lub null | tak | Każde miejsce implementacji. |
Dodatkowe właściwości są niedozwolone.
HoverResult
Co wyświetlić o elemencie pod kursorem.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
contents | null lub MarkupContent | tak | Co wyświetlić. Ma wartość null, gdy o tym, co jest pod kursorem, nie ma nic do powiedzenia. |
Dodatkowe właściwości są niedozwolone.
CompletionResult
Co można wpisać w miejscu kursora.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
items | CompletionItem[] lub null | tak | Każdy element, który można wpisać. |
Dodatkowe właściwości są niedozwolone.
CatalogIndexResult
Każda encja, którą zawiera indeks obszaru roboczego, oraz dowiązania prowadzące poza obszar roboczy, do katalogów i do plików, które nie zostały na jego potrzeby odczytane.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
entities | CatalogEntity[] lub null | tak | Każda encja. |
unreadLinkedDirs | string[] | tak | Każde dowiązanie pod katalogiem głównym obszaru roboczego, które prowadzi do katalogu poza nim, podane względem katalogu głównego tam, gdzie samo dowiązanie się znajduje, w kolejności przeszukiwania obszaru roboczego. Żaden katalog poza katalogiem głównym nie jest przeszukiwany, więc żaden dokument za jednym z tych dowiązań nie znajduje się wśród entities jako własny dokument obszaru roboczego, a klient wyświetlający encje może wyjaśnić dlaczego. Nie są podawane: dowiązanie do katalogu wewnątrz katalogu głównego, który jest przeszukiwany lub pomijany tam, gdzie faktycznie się znajduje; dowiązanie w każdym miejscu, w którym katalog zostałby pominięty, czy to ze względu na położenie, nazwę, czy plik .gitignore; dowiązanie, którego nie da się rozwiązać, bo prowadzi donikąd lub tworzy pętlę; oraz, w odpowiedzi udzielonej w kategoriach encji Release, dowiązanie pod katalogiem katalogu, który odczytują tylko inne Releases. Puste, gdy obszar roboczy nie zawiera żadnego. |
unreadLinkedFiles | string[] | tak | Każde dowiązanie pod katalogiem głównym obszaru roboczego, które ma nazwę jak plik YAML, czyli jego własna nazwa kończy się na .yaml lub .yml, i prowadzi do pliku poza katalogiem głównym, podane względem katalogu głównego tam, gdzie samo dowiązanie się znajduje, w kolejności przeszukiwania obszaru roboczego. Taki plik nie jest odczytywany na potrzeby indeksu, niezależnie od tego, co deklaruje, więc deklarowana w nim encja nie znajduje się wśród entities jako własna encja obszaru roboczego, a klient wyświetlający encje może wyjaśnić dlaczego; encje spoza obszaru roboczego są odczytywane przez skonfigurowane katalogi katalogu. Nie są podawane: dowiązanie do pliku, który konfiguracja obszaru roboczego wskazuje jako encję Release, jako build.authoring_release lub jako klucz workspace.releases, i który ją deklaruje — jest on odczytywany i wymieniany w entities w miejscu samego dowiązania; dowiązanie do pliku wewnątrz katalogu głównego, który jest odczytywany w miejscu samego dowiązania; dowiązanie pomijane przez plik .gitignore lub znajdujące się w katalogu pomijanym przy przeszukiwaniu; dowiązanie, które nie prowadzi do żadnego pliku, czy to do katalogu, który unreadLinkedDirs podaje, gdy prowadzi poza katalog główny, czy donikąd, czy w pętlę; oraz, w odpowiedzi udzielonej w kategoriach encji Release, dowiązanie pod katalogiem katalogu, który odczytują tylko inne Releases. Plik konfiguracji obszaru roboczego będący dowiązaniem prowadzącym poza obszar roboczy, czyli jego własny .aggrega-config.yaml lub nakładka zarządzana przez CI obok niego, jest podawany niezależnie od tego, czy przeszukiwanie go napotkało, po dowiązaniach podanych przez przeszukiwanie: konfiguracja obszaru roboczego nie jest wtedy w ogóle odczytywana, ta odpowiedź jest własnym indeksem obszaru roboczego odczytanym bez żadnej konfiguracji, więc żaden katalog katalogu nie jest dla niej odczytywany, a każde żądanie, o którym decyduje konfiguracja, w tym indeks w kategoriach encji Release, jest dla tego obszaru roboczego odrzucane z warunkiem blokady odczytu. Puste, gdy obszar roboczy nie zawiera żadnego. |
Dodatkowe właściwości są niedozwolone.
AttachCandidatesResult
Które Features można dołączyć do encji i względem jakich etykiet je oceniono; a w przypadku połączenia wskazanego w żądaniu — sloty deklarowane przez jego gniazdo wraz z Features, które mogą wypełnić każdy z nich.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
node | string | tak | Encja, dla której oceniono kandydatów. |
nodeLabels | map of string lub null | tak | Etykiety, względem których dokonano oceny. |
labelSource | string | tak | Który zestaw etykiet został użyty, co nie jest kwestią kosmetyczną: zadeklarowane etykiety dokumentu to to, co widać przy odczycie źródła, natomiast etykiety węzła grafu to sfinalizowany zestaw, względem którego ocenia sama kompilacja. Odpowiedź obliczona na podstawie tego drugiego jest stwierdzeniem o tym, co zrobi kompilacja. |
candidates | SourcedEntityRef[] lub null | tak | Każdy Feature, który można dołączyć. |
slots | SlotCandidacy[] | nie | Obecne tylko wtedy, gdy żądanie wskazało połączenie: każdy slot deklarowany przez gniazdo połączenia, w kolejności, w jakiej deklaruje je Component, wraz z Features, które mogą go wypełnić. Puste, gdy na połączeniu nie można wypełnić żadnego slotu, a noSlotReason podaje wtedy przyczynę — klient odczytuje ją, zamiast traktować pustą listę jako sloty, do których nie pasował żaden Feature. |
noSlotReason | const “feature-created-connection” lub const “ad-hoc-socket” lub const “no-slot-declared” | nie | Obecne tylko wtedy, gdy żądanie wskazało połączenie i nie można na nim wypełnić żadnego slotu: dlaczego nic nie może zostać tam dołączone. Nieobecne wszędzie tam, gdzie gniazdo deklaruje slot. Zbiór jest zamknięty. Dozwolone wartości: "feature-created-connection" — Połączenie utworzyła encja Feature, a dołączenie zapisuje się tylko na połączeniu tworzonym przez komponent lub encję Release. "ad-hoc-socket" — Gniazdo nie jest zadeklarowane przez encję Component, więc nie deklaruje slotu, który połączenie mogłoby wypełnić. "no-slot-declared" — Encja Component deklaruje gniazdo, ale nie deklaruje na nim żadnego slotu. |
Dodatkowe właściwości są niedozwolone.
ConnectionCandidatesResult
Z którymi encjami można połączyć każde gniazdo encji.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
node | string | tak | Encja, do której należą te gniazda. |
adHocSocketsAccepted | logiczna | tak | Czy nadal można utworzyć gniazdo, którego własna definicja encji nie deklaruje z góry. |
sockets | SocketCandidacy[] lub null | tak | Każde gniazdo i to, co można do niego podłączyć. |
Dodatkowe właściwości są niedozwolone.
InsertionPointResult
Gdzie w dokumencie należy umieścić nowy wpis pod wskazanym kontenerem i czego klient potrzebuje, aby go tam zapisać: sam punkt, czy tekst musi zaczynać się od podziału wiersza, brakujące jeszcze klucze kontenera oraz wcięcie każdego wiersza.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
file | string | tak | Dokument. |
container | string[] lub null | tak | Ścieżka przez dokument do kontenera. |
positionEncoding | string | tak | Kodowanie, w którym wyrażone są pozycje w tej odpowiedzi. |
position | Position | tak | Miejsce w dokumencie: wiersz i przesunięcie znakowe w nim, oba liczone od zera. Przesunięcie jest mierzone w jednostkach kodowania ustalonego przy otwieraniu sesji, czyli UTF-16, chyba że klient poprosił o inne. |
precededByLineBreak | logiczna | tak | Czy tekst zapisany na tej pozycji musi zaczynać się od podziału wiersza, ponieważ pozycja znajduje się na końcu wiersza, który dokument już zawiera. Wartość false występuje tylko wtedy, gdy dokument nie zawiera niczego, po czym miałby nastąpić wpis. |
missingContainerKeys | string[] lub null | tak | Segmenty ścieżki kontenera, których dokument jeszcze nie zawiera, od najbardziej zewnętrznego. Każdy należy zapisać jako osobny klucz, z wcięciem o jeden krok większym niż poprzedni, zanim wpis będzie mógł trafić do najbardziej wewnętrznego. Wartość null oznacza, że cała ścieżka już istnieje. |
entryIndent | integer | tak | Kolumna, od której zaczyna się pierwszy wiersz samego wpisu, liczona w spacjach od początku wiersza. |
indentStep | integer | tak | O ile większe jest wcięcie każdego poziomu zagnieżdżenia. |
indentStepMeasured | logiczna | tak | Czy krok został zmierzony na podstawie własnego zagnieżdżenia tego dokumentu. Gdy wartość to false, dokument nie wykazuje zagnieżdżenia, które można zmierzyć, a krok jest wartością zastępczą, więc klient, który wolałby narzucić własny, wie, że może to zrobić. |
entryShape | const “mapping” lub const “sequence” lub const “unknown” | tak | Kształt, w jakim kontener przechowuje swoje wpisy, który decyduje o tym, jak komponowany jest tekst samego wpisu. Jest odczytywany z kontenera, który dokument już zawiera, i nigdy nie jest wnioskowany z nazwy kontenera. Zbiór jest zamknięty. Dozwolone wartości: "mapping" — Kontener jest blokowym mapowaniem, więc dołączany do niego wpis to klucz i jego wartość. "sequence" — Kontener jest blokową sekwencją, więc dołączany do niego wpis to myślnik i jego wartość. "unknown" — Dokument nie zawiera kontenera lub zawiera go pustego, więc o kształcie wpisu decyduje klient. |
Dodatkowe właściwości są niedozwolone.
AttachmentContainerResult
Do którego dokumentu i w którym jego miejscu należy dołączenie na węźle grafu lub na połączeniu wskazanym w żądaniu.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
node | string | tak | Węzeł grafu, którego dotyczy dołączenie. |
file | string | tak | Dokument, do którego należy dołączenie. |
container | string[] lub null | tak | Ścieżka przez ten dokument do miejsca, w którym należy ono umieścić. |
Dodatkowe właściwości są niedozwolone.
ConnectionAtPositionResult
Połączenie, w którego wpisie znajduje się pozycja, lub przyczyna, dla której żadne nie jest zgłaszane. Obecna jest dokładnie jedna połowa: graphNode i connection razem albo samo noConnectionReason. Pozycja w dowolnym miejscu wpisu — na jego aliasie, celu lub dołączeniach — znajduje się w tym wpisie, a przy zagnieżdżonych wpisach w najbardziej wewnętrznym; pozycja na własnym kluczu gniazda, powyżej zapisanych pod nim wpisów, nie znajduje się w żadnym.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
graphNode | string | nie | Identyfikator węzła, którego komponent rysuje połączenie, w postaci klucza skompilowanego grafu — wartość, którą żądania kandydatów i kontenerów przyjmują jako graphNode. |
connection | ConnectionCoordinate | nie | Połączenie, określone przez gniazdo i alias, z polem document wskazującym dokument, w którym odczytano pozycję — wartość, którą żądania kandydatów i kontenerów przyjmują jako connection. |
noConnectionReason | const “no-connection-entry” lub const “feature-created-connection” lub const “unknown-connection” | nie | Obecne tylko wtedy, gdy nie zgłoszono połączenia: dlaczego. Zbiór jest zamknięty. Dozwolone wartości: "no-connection-entry" — Pozycja nie znajduje się na żadnym wpisie, w którym zapisuje się dołączenie: ani na połączeniu tworzonym przez komponent i zapisanym pod jego aliasem, ani na wpisie dla krawędzi w encji Release. Połączenie zapisane jako lista celów oraz połączenie tworzone przez własny blok encji Feature nie mają takiego wpisu. "feature-created-connection" — Pozycja znajduje się na wpisie encji Release dla połączenia utworzonego przez encję Feature, a dołączenie zapisuje się tylko na połączeniu tworzonym przez komponent lub encję Release. "unknown-connection" — Pozycja znajduje się na wpisie, który encja Release zapisuje dla połączenia nieobecnego w skompilowanym grafie. |
Dodatkowe właściwości są niedozwolone.
ReleaseCandidatesResult
Encje Releases, które zawiera obszar roboczy, oraz prowadzące poza niego dowiązania do katalogów i plików, które nie zostały dla nich odczytane.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
releases | string[] lub null | tak | Każdy dokument Release. |
lockfiles | mapa string | tak | Plik blokady każdej wymienionej encji Release, z kluczem będącym encją Release dokładnie w takiej postaci, w jakiej została wymieniona. Każdy z nich to plik, który pull zapisuje dla danej encji Release, a build odczytuje, dzięki czemu klient odczytuje jego położenie, zamiast je ustalać. Pusta, gdy obszar roboczy nie zawiera żadnej encji Release. |
unreadLinkedDirs | string[] | tak | Każde dowiązanie w katalogu głównym obszaru roboczego, które prowadzi do katalogu poza nim, podane względem katalogu głównego w miejscu, w którym znajduje się samo dowiązanie, w kolejności przeszukiwania obszaru roboczego. Żaden katalog poza katalogiem głównym nie jest przeszukiwany, więc encja Release osiągalna tylko przez jedno z tych dowiązań nie występuje w releases, a klient oferujący encje Releases może wyjaśnić dlaczego. Nie są wymieniane: dowiązanie do katalogu wewnątrz katalogu głównego, który jest przeszukiwany lub pomijany tam, gdzie faktycznie się znajduje; dowiązanie w każdym miejscu, w którym katalog zostałby pominięty, czy to ze względu na położenie, czy na nazwę; oraz dowiązanie, którego nie można rozwiązać, ponieważ nigdzie nie prowadzi lub tworzy pętlę. Pusta, gdy obszar roboczy nie zawiera żadnego. |
unreadLinkedFiles | string[] | tak | Każde dowiązanie w katalogu głównym obszaru roboczego nazwane jak plik YAML, czyli o własnej nazwie kończącej się na .yaml lub .yml, które prowadzi do pliku poza katalogiem głównym, podane względem katalogu głównego w miejscu, w którym znajduje się samo dowiązanie, w kolejności przeszukiwania obszaru roboczego. Taki plik nie jest odczytywany, więc encja Release osiągalna tylko przez jedno z tych dowiązań nie występuje w releases, a klient oferujący encje Releases może wyjaśnić dlaczego. Bez odczytania pliku nie wiadomo, czy jest on encją Release, więc każde takie dowiązanie jest wymieniane niezależnie od zawartości pliku. Nie są wymieniane: dowiązanie do pliku, który konfiguracja obszaru roboczego wskazuje jako Release, jako build.authoring_release lub jako klucz workspace.releases, który jest odczytywany i wymieniany w releases w miejscu samego dowiązania; dowiązanie do pliku wewnątrz katalogu głównego, który jest odczytywany; dowiązanie wewnątrz katalogu pomijanego przez przeszukiwanie; oraz dowiązanie, które nie prowadzi do żadnego pliku, czy to do katalogu, który unreadLinkedDirs wymienia, gdy prowadzi poza katalog główny, czy donikąd, czy w pętlę. Plik konfiguracji obszaru roboczego będący dowiązaniem prowadzącym poza obszar roboczy, jego własny .aggrega-config.yaml lub nakładka należąca do CI obok niego, jest wymieniany niezależnie od tego, czy przeszukiwanie go napotkało, po dowiązaniach wymienionych przez przeszukiwanie: konfiguracja obszaru roboczego nie jest wtedy w ogóle odczytywana, ta odpowiedź jest odczytywana bez żadnej konfiguracji, więc nie jest wymieniana żadna encja Release wskazana przez konfigurację poprzez dowiązanie, a każde żądanie zależne od konfiguracji jest dla tego obszaru roboczego odrzucane z warunkiem blokady odczytu. Pusta, gdy obszar roboczy nie zawiera żadnego. |
Dodatkowe właściwości są niedozwolone.
ActiveReleaseResult
Encja Release, na której klient powinien domyślnie działać. Obszar roboczy niewskazujący żadnej encji Release to zwykły stan, a nie błąd, dlatego jest zgłaszany tutaj wraz z opisem przebiegu próby wyboru, zamiast być zgłaszany jako błąd.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
release | string | tak | Wybrana encja Release lub wartość pusta, gdy żadnej nie wybrano. |
lockfile | string | nie | Plik blokady wybranej encji Release: plik, który pull dla niej zapisuje, a build odczytuje. Nieobecna, gdy nie wybrano żadnej encji Release. |
reason | string | nie | Powód, dla którego nie wybrano żadnej encji Release. |
trace | string | nie | Każdy krok wyboru i jego wynik, dzięki czemu wywołujący widzi, który z nich rozstrzygnąłby wybór. |
Dodatkowe właściwości są niedozwolone.
EditDocumentResult
Co zapisała edycja i gdzie. Po zapisie odczyt dokumentu przez demona jest odrzucany, więc następna odpowiedź na jego temat jest obliczana z bajtów wytworzonych przez edycję.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
file | string | tak | Edytowany dokument. |
edit | string | tak | Zastosowana edycja. |
container | string[] lub null | tak | Ścieżka w dokumencie do miejsca, w którym trafiła edycja. |
createdContainers | string[] lub null | tak | Kontenery, które edycja musiała utworzyć po drodze. |
written | string[] lub null | tak | Zapisane dokumenty. |
content | string | tak | Złożony dokument, w przypadku żądania o pokazanie wyniku zamiast jego zapisania. |
Dodatkowe właściwości są niedozwolone.
EffectiveConfigurationResult
Konfiguracja rozwiązana przez obszar roboczy oraz dokument, z którego pochodzi każde ustawienie.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
layers | string[] lub null | tak | Scalone dokumenty konfiguracji, w kolejności scalania. |
settings | EffectiveConfigurationSetting[] lub null | tak | Każde rozwiązane ustawienie i jego pochodzenie. |
Dodatkowe właściwości są niedozwolone.
ConfigInitResult
Co zapisało zainicjowanie konfiguracji, gdzie i co odczytało z rejestru.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
host | string | tak | Rejestr, dla którego zainicjowano konfigurację. |
scope | ConfigWriteScope | tak | Który dokument konfiguracyjny został zapisany i jaki ma zasięg. Żądanie wskazuje jeden obszar roboczy, więc odpowiedź, która nic by o tym nie mówiła, zostałaby odczytana jako dotycząca tego obszaru — a w przypadku zapisu obejmującego całą maszynę taki odczyt jest błędny. |
trust | TrustFetchOutcome | tak | Wynik odczytu polityki zaufania ogłaszanej przez rejestr. Wyniki są rozdzielone, ponieważ oznaczają różne rzeczy: ogłoszona polityka została przyjęta, rejestr niczego nie ogłosił — co nie jest błędem — w jej miejsce przypięto wbudowaną bazę albo nie podjęto próby odczytu. Tam, gdzie niczego nie ogłoszono, obok podaje się, czy rejestr był w ogóle osiągalny. |
written | logiczna | tak | Czy dokument został zapisany, czy zwrócony wywołującemu do umieszczenia. |
existed | logiczna | nie | Obecna i równa true, gdy dokument już istniał, więc wpis rejestru został w nim scalony zamiast tworzenia nowego dokumentu. Tylko żądanie wysyłające force nadpisuje istniejący dokument, więc właściwość ta nie występuje w żadnej odpowiedzi na żądanie bez niego. |
content | string | nie | Tekst dokumentu, w przypadku żądania o jego pokazanie zamiast zapisania. |
Dodatkowe właściwości są niedozwolone.
ConfigCaptureResult
Co zamrożenie rozwiązanej konfiguracji zapisało we własnym dokumencie tego obszaru roboczego.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
configFile | string | tak | Zapisany dokument. Jest to zawsze własny dokument tego obszaru roboczego, ponieważ całym celem jest uczynienie jednego obszaru roboczego samowystarczalnym. |
workspaceRoot | string | tak | Obszar roboczy wskazany w żądaniu. |
captured | logiczna | tak | Czy cokolwiek zostało zamrożone. |
sockets | ConfigCapturedSocket[] lub null | tak | Każde zamrożone gniazdo wraz z jego dołączeniami. |
catalogDirs | string[] lub null | tak | Zamrożone katalogi katalogu. |
Dodatkowe właściwości są niedozwolone.
ImportResult
Co wytworzyła konwersja obcego źródła i czego nie udało się przekonwertować.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
format | string | tak | Przekonwertowany format źródłowy. |
outputDir | string | tak | Katalog, względem którego podana jest każda ścieżka w odpowiedzi, i do którego zapisano pliki. |
written | string[] lub null | tak | Każdy plik zapisany na dysku, w kolejności zapisu: szkice, a następnie zapis tego, co zapisał import. Przy sync tylko szkice zmienione przez synchronizację oraz zapis, jeśli się zmienił. Pusta przy dryRun. |
files | ImportedFile[] lub null | tak | Każdy plik zapisywany przez żądanie, wraz z tekstem, z dryRun i bez niego: każdy szkic, a następnie zapis tego, co zapisał import. Przy sync każdy szkic zmieniany przez synchronizację, z nowym tekstem, a następnie zapis, jeśli on także się zmienia, więc zgodna synchronizacja zwraca pustą listę. |
drift | ImportDrift[] | tak | Każda część, którą synchronizacja uzgodniła ze źródłem lub uzgodniłaby przy dryRun, w kolejności, w jakiej wymienia je szkic; usuwany przez synchronizację plik szkicu jest jedną z nich, usuniętą bez kluczy. Pusta lista dla żądania niebędącego synchronizacją, dla zgodnej synchronizacji oraz dla synchronizacji, której konwersja została przerwana i która niczego nie zapisuje. |
diagnostics | ImportDiagnostic[] lub null | tak | Czego nie udało się przekonwertować. |
decisions | ImportDecision[] | tak | Jak importer zmapował każdy węzeł źródłowy, w kolejności importera i dokładnie tak, jak to zgłosił: to pokazuje, gdzie konwersja zgadywała. Przekazywana przy obu sposobach dostarczenia i niezależnie od tego, czy konwersja została przerwana; pusta lista dla importera, który niczego nie zgłasza. |
owed | ImportOwed[] | nie | Każda wartość, którą szkice nadal pozostawiają pustą, a której nie mogło dostarczyć żadne źródło ani nie dostarczyła żadna odpowiedź, w kolejności zapisywania szkiców — wartości wskazywane przez ustalenia o randze ostrzeżenia. Każda odpowiedź zawiera to pole, jako pustą listę tam, gdzie szkicom niczego nie brakuje. |
halted | logiczna | tak | Czy konwersja została przerwana, zamiast zakończyć się z wynikami. |
Dodatkowe właściwości są niedozwolone.
ScaffoldEntityResult
Szkic dokumentu startowego, lista przykładów gotowych do uruchomienia lub zapisany przykład — każda forma odpowiada własnymi polami, a pozostałe pomija.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
kind | string | nie | Rodzaj encji, dla którego przygotowano szkic. Obecny przy szkicu. |
skeleton | string | nie | Tekst szkicu dokumentu. Obecny przy szkicu. |
examples | ScaffoldExample[] | nie | Wszystkie przykłady gotowe do uruchomienia publikowane przez dokumentację, każdy raz, w kolejności nazw. Obecne przy wylistowaniu, które cokolwiek znalazło. |
example | string | nie | Przykład, który został zapisany. Obecny przy zapisie. |
dir | string | nie | Katalog, w którym zapisano przykład, względny wobec katalogu głównego przestrzeni roboczej, w postaci wskazanej przez żądanie lub, jeśli żadnej nie wskazało, jako nazwa przykładu. Obecny przy zapisie. |
files | string[] | nie | Każdy zapisany plik, względny wobec dir i z ukośnikami jako separatorami, w kolejności, w jakiej zawiera je dokumentacja. Obecne przy zapisie. |
next | string[] | nie | Polecenia, które strona przykładu podaje do jego zbudowania, wiersz po wierszu, tak jak zapisuje je strona, łącznie z komentarzami: pierwszy blok powłoki pod jej nagłówkiem Build. Nieobecne, jeśli strona żadnych nie podaje. |
version | string | nie | Wersja dokumentacji, z której odczytano przykład: własna wersja pliku binarnego, jeśli opublikowano dla niego dokumentację, w przeciwnym razie najnowsza opublikowana przed nią. Obecna przy zapisie. |
Dodatkowe właściwości są niedozwolone.
ScaffoldExample
Jeden przykład gotowy do uruchomienia publikowany przez dokumentację.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
name | string | tak | Nazwa przykładu, którą żądanie wysyła jako example, aby go zapisać. |
level | string | tak | Poziom, który strona przykładu dla niego deklaruje. |
summary | string | tak | Pierwsze zdanie strony przykładu. |
Dodatkowe właściwości są niedozwolone.
LintResult
Co wykazało sprawdzenie konwencji, z liczbami według ważności i listą dla każdego dokumentu. Sprawdzenie całego katalogu uruchomione osobno dla każdej encji Release zawiera także passes; liczby i files obejmują wtedy wszystkie przebiegi łącznie.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
entity | string | nie | Jedyna sprawdzona encja, jeśli żądanie ją wskazało. |
release | string | nie | Encja Release, której domknięcie sprawdzono, jeśli żądanie ją wskazało. |
checked | integer | tak | Liczba sprawdzonych dokumentów. Jeśli sprawdzenie uruchomiono osobno dla każdej encji Release, jest to suma po przebiegach: dokument odczytany przez dwa przebiegi jest liczony w każdym z nich. |
findings | integer | tak | Łączna liczba ustaleń. |
errors | integer | tak | Ile z nich to błędy. |
warnings | integer | tak | Ile z nich to ostrzeżenia. |
infos | integer | tak | Ile z nich ma charakter informacyjny. |
files | LintFileFindings[] lub null | tak | Ustalenia dla każdego dokumentu. |
halted | logiczna | tak | Czy sprawdzenie zostało przerwane, zamiast zakończyć się z ustaleniami. |
passes | LintPass[] lub null | nie | Sprawdzenie całego katalogu z podziałem na przebiegi, obecne tylko wtedy, gdy uruchomiono je osobno dla każdej encji Release, ponieważ obszar roboczy wskazuje encje Releases w workspace.releases. Każdy przebieg podaje, dla których encji Releases znaleziono jego ustalenia. Nieobecne dla obszaru roboczego, który żadnych nie wskazuje i jest sprawdzany raz w obrębie własnych katalogów, oraz dla sprawdzenia jednej encji lub domknięcia encji Release. |
Dodatkowe właściwości są niedozwolone.
LintPass
Jeden przebieg sprawdzenia konwencji całego katalogu w obszarze roboczym, który przypisuje swoim encjom Releases własne katalogi: encje Releases, dla których go uruchomiono, odczytane katalogi i to, co w nich znaleziono.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
releases | string[] lub null | tak | Encje Releases, dla których uruchomiono przebieg, każda jako ścieżka względem katalogu głównego obszaru roboczego. Encje Releases odczytujące te same katalogi współdzielą jeden przebieg. |
catalogDirs | string[] lub null | tak | Katalogi odczytane przez przebieg, w kolejności przeszukiwania, każdy względem katalogu głównego obszaru roboczego, jeśli się w nim znajduje. Puste, gdy jego encje Releases nie odczytują żadnego katalogu, więc przebieg niczego nie sprawdził i nie spowodował niepowodzenia żadnego z pozostałych. |
checked | integer | tak | Liczba dokumentów sprawdzonych przez przebieg. |
findings | integer | tak | Liczba ustaleń znalezionych przez przebieg. |
errors | integer | tak | Ile z nich to błędy. |
warnings | integer | tak | Ile z nich to ostrzeżenia. |
infos | integer | tak | Ile z nich ma charakter informacyjny. |
files | LintFileFindings[] lub null | tak | Ustalenia przebiegu dla każdego dokumentu. |
Dodatkowe właściwości są niedozwolone.
PluginAddResult
Co zapisało dołączenie wtyczki, gdzie i którą wersję przypięło.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
type | string | tak | Gniazdo, do którego dołączono wtyczkę. |
identity | string | nie | Tożsamość, na którą rozwiązano dołączenie. |
uri | string | nie | Odwołanie, z którego rozstrzyga się dołączenie. |
capability | string | nie | Funkcjonalność, której dotyczy dołączenie. |
reference | string | nie | Przypięta referencja wraz z wersją. |
scope | PluginWriteScope | tak | Do którego dokumentu konfiguracyjnego zapisano zmianę wtyczki i jaki ma on zasięg. Domyślnym dokumentem gniazda rozszerzeń poleceń jest dokument obejmujący całą maszynę, dlatego każda odpowiedź podaje, który dokument zapisała. |
written | logiczna | tak | Czy dokument konfiguracji został zapisany, czy zwrócony wywołującemu do umieszczenia. |
content | string | nie | Tekst dokumentu konfiguracji, dla żądania, które prosiło o jego pokazanie zamiast zapisu. |
retraction | PluginRetraction | nie | Jak znacznik wycofania wpłynął na to, która wersja wtyczki została przypięta. |
withdrawn | logiczna | nie | Ma wartość true, gdy zapytanie wskazało przypiętą wersję, a deklaracja wycofania, której ufa ten obszar roboczy, wycofała tę wersję. Wskazana wersja jest przypinana mimo to, ponieważ jej wskazanie jest nadpisaniem. W przeciwnym razie nieobecne, a brak nie oznacza, że wersja nie została wycofana: jeśli nie udało się odczytać znaczników wycofania wskazanej wersji, retraction.unscreened podaje przyczynę, a gdy nie wskazano wersji, wybierana jest najnowsza opublikowana wersja, a retraction podaje, do jakiego wniosku doszło sprawdzenie wycofania w odniesieniu do tego wyboru. |
Dodatkowe właściwości są niedozwolone.
PluginRemoveResult
Co zapisało odłączenie wtyczki i gdzie.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
type | string | tak | Gniazdo, do którego dołączono wtyczkę. |
query | string | tak | Które dołączenie usunięto. |
scope | PluginWriteScope | tak | Do którego dokumentu konfiguracyjnego zapisano zmianę wtyczki i jaki ma on zasięg. Domyślnym dokumentem gniazda rozszerzeń poleceń jest dokument obejmujący całą maszynę, dlatego każda odpowiedź podaje, który dokument zapisała. |
Dodatkowe właściwości są niedozwolone.
PluginSyncResult
Co zmieniło uzgodnienie zarządzanych maszynowo rekordów encji Plugin z jej modułem.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
entity | string | tak | Uzgodniony dokument encji Plugin. |
hostFunctions | string[] lub null | tak | Funkcje hosta, których moduł deklaruje, że potrzebuje. |
commands | PluginCLICommand[] lub null | tak | Polecenia dostarczane przez moduł. |
changed | logiczna | tak | Czy cokolwiek w dokumencie faktycznie się zmieniło. |
Dodatkowe właściwości są niedozwolone.
PluginGenCatalogResult
Dokumenty katalogu utworzone przez generowanie.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
documents | PluginGeneratedDocument[] | nie | Każdy wygenerowany dokument i jego tekst. |
notices | string | nie | Wszystko, o czym generowanie chce poinformować wywołującego. |
dryRun | logiczna | tak | Czy dokumenty zostały zwrócone zamiast zapisane. |
Dodatkowe właściwości są niedozwolone.
ExplainErrorResult
Co kompilator deklaruje o danym stanie oraz opublikowane fragmenty uczące, jak to poprawić w tworzonych dokumentach.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
shortCode | string | tak | Krótki kod stanu. |
code | string | tak | Opisowa nazwa stanu. |
message | string | tak | Komunikat stanu w chwili jego zgłoszenia. |
entries | ExplainErrorEntry[] | nie | Opublikowane fragmenty uczące poprawki. |
reference | string | tak | Opublikowany adres, pod którym wyjaśniono warunek. |
note | string | nie | Dlaczego brakuje opublikowanych fragmentów, jeśli nie udało się ich pobrać. To, co deklaruje sam plik binarny, jest nadal zwracane. |
Dodatkowe właściwości są niedozwolone.
GetSchemaResult
Schemat rodzaju lub — jeśli żądanie żadnego nie wskazało — rodzaje, które można wskazać. Oba zakresy są przekazywane w jednej odpowiedzi, a nie w dwóch metodach, ponieważ „co mogę wskazać” i „dla których z nich autor pisze dokumenty” to to samo pytanie w dwóch zakresach, a dwie odpowiedzi trzeba by utrzymywać w zgodności.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
kind | string | nie | Rodzaj, którego dotyczy schemat. |
schema | any | nie | Sam schemat, przekazany w postaci, w jakiej przechowuje go plik binarny. |
kinds | string[] | nie | Każdy token, na który odpowiada ten plik binarny. |
entityKinds | EntityKindDescriptor[] | nie | Węższy zbiór rodzajów, dla których autor pisze dokumenty; każdy łączy token wskazywany w żądaniu z rodzajem deklarowanym w nagłówku samego dokumentu. |
Dodatkowe właściwości są niedozwolone.
SkillsInstallResult
Co zapisała instalacja umiejętności asystenta i gdzie.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
skill | string | tak | Umiejętność, która została zapisana. |
installed | SkillsInstalledFolder[] | tak | Każdy zapisany folder umiejętności, w kolejności, w jakiej żądanie wskazało asystentów. Asystenci odczytujący jeden wspólny folder współdzielą jeden wpis, ponieważ umiejętność jest tam zapisywana raz. |
scope | SkillFolderScope | tak | Jak daleko sięga instalacja umiejętności. Żądanie wskazuje jedną przestrzeń roboczą, więc odpowiedź, która nic by nie mówiła, zostałaby odczytana jako dotycząca tej przestrzeni roboczej — a w przypadku folderów przypisanych do użytkownika, które asystent odczytuje w każdym projekcie, takie odczytanie jest błędne. |
Dodatkowe właściwości są niedozwolone.
SkillsInstalledFolder
Jeden folder umiejętności zapisany przez instalację.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
agents | string[] | tak | Identyfikatory wskazanych asystentów, którzy odczytują ten folder, w kolejności, w jakiej wskazało ich żądanie. |
folder | string | tak | Folder umiejętności jako ścieżka bezwzględna. |
replaced | logiczna | tak | Czy znajdowała się tam kopia zawierająca wiersz komentarza, który ma każda zapisana kopia umiejętności — zapisana przez wcześniejszą instalację lub pobrana z opublikowanego repozytorium umiejętności — i czy została zastąpiona. Plik bez tego wiersza jest odrzucany, a nie zastępowany. |
Dodatkowe właściwości są niedozwolone.
SkillsListResult
Umiejętności dostarczane z plikiem binarnym i każdy asystent, dla którego instalacja może je zapisać. Nic nie jest zapisywane i z niczym nie następuje połączenie.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
skills | SkillsListedSkill[] | tak | Każda umiejętność dostarczana z plikiem binarnym, w ustalonej kolejności. |
agents | SkillsListedAgent[] | tak | Każdy asystent, dla którego instalacja zna folder umiejętności, uporządkowany według identyfikatora. |
Dodatkowe właściwości są niedozwolone.
SkillsListedSkill
Jedna umiejętność dostarczana z plikiem binarnym.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
name | string | tak | Nazwa umiejętności, będąca również nazwą folderu, który zapisuje instalacja. |
description | string | tak | Kiedy asystent używa umiejętności, zgodnie z deklaracją samej umiejętności. |
Dodatkowe właściwości są niedozwolone.
SkillsListedAgent
Jeden asystent, dla którego instalacja może zapisać umiejętność, wraz z dwoma folderami, z których odczytuje umiejętności.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
id | string | tak | Identyfikator, którym żądanie wskazuje asystenta. |
name | string | tak | Własna nazwa asystenta. |
projectFolder | string | tak | Folder, względny wobec katalogu głównego projektu i rozdzielany ukośnikami, z którego asystent odczytuje umiejętności projektu. Instalacja w projekcie zapisuje w nim folder umiejętności, w przestrzeni roboczej wskazanej w żądaniu. |
userFolder | string | tak | Folder, względny wobec katalogu domowego i rozdzielany ukośnikami, z którego asystent w każdym projekcie odczytuje własne umiejętności użytkownika. Instalacja z global zapisuje w nim folder umiejętności. |
Dodatkowe właściwości są niedozwolone.