Aggrega-Schema für das Übertragungsprotokoll des Hintergrund-Daemons
Generierte Referenz. Nicht von Hand bearbeiten — aus dem veröffentlichten JSON Schema neu generieren.
Schema-ID: https://aggrega.ai/schemas/serve-wire-v1beta1.schema.json
Die Nachrichtenformen, die mit einem von aggrega serve gestarteten Compiler-Daemon im Hintergrund ausgetauscht werden. Ein Client öffnet mit dem Handshake eine Sitzung über diesen Daemon, und die Sitzung legt den Geltungsbereich der Einstellungen und des Workspace fest, über den die Unterhaltung geöffnet wurde; der Daemon ist der Prozess, der eine Anfrage beantwortet, eine Benachrichtigung sendet und das vorhält, was er gelesen hat. Das Protokoll ist JSON-RPC 2.0 über Standardeingabe und Standardausgabe, jede Nachricht durch einen Content-Length-Header gerahmt; dieses Dokument beschreibt die Nachrichtenrümpfe und weder die Rahmung noch den Transport. Ein Rumpf ist eines von vier Dingen: eine Anfrage, die der Client sendet, eine Benachrichtigung, die der Client sendet, eine Benachrichtigung, die der Daemon sendet, oder die Antwort, die der Daemon auf eine Anfrage zurückgibt. Drei Eigenschaften der Oberfläche bestimmen, wie die Formen unten geschrieben sind. Erstens lässt jede Anfrage über die Felder hinaus, die ihre eigene Methode deklariert, zwei weitere zu — workspaceRoot, das den Workspace benennt, auf den die Anfrage wirkt, und workDoneToken, den vom Aufrufer erzeugten Wert, unter dem der Fortschritt gemeldet wird —, daher erscheinen beide hier auf jedem params-Objekt einer Anfrage, einschließlich der drei Methoden, deren Gegenstand kein Workspace ist: aggrega/getSchema und aggrega/scaffoldEntity akzeptieren workspaceRoot und ignorieren es, und aggrega/initialize liest es als den Workspace, den die Sitzung deklariert. Zweitens lehnt der Daemon ein params-Objekt einer Anfrage ab, das ein Feld trägt, das die Methode nicht akzeptiert, und nennt dabei, was sie akzeptiert, daher ist hier jedes params-Objekt auf seiner obersten Ebene geschlossen; ein verschachteltes Objekt innerhalb einer Anfrage ist nicht geschlossen, weil die Prüfung nur die äußersten Feldnamen liest. Drittens wird ein Ergebnis vom Daemon zusammengesetzt und nicht von einem Aufrufer geliefert, daher sind Ergebnisobjekte auf jeder Ebene geschlossen, deren Form feststeht, und nur dort offen, wo der Wert opakes JSON ist, das der Daemon durchreicht, ohne es zu lesen. Eine Folge der Kodierung des Daemons ist in den übertragenen Nachrichten sichtbar und wird beschrieben statt verborgen: Eine Sammlung, die der Daemon nicht als optional kennzeichnet, wird als null ausgegeben, wenn sie keinen Wert zu melden hat, und als leere Sammlung, wenn der gemeldete Wert leer ist, daher sind beide Formen überall zugelassen, wo das zutrifft.
Eine der folgenden Formen
RequestClientNotificationDaemonNotificationSuccessResponseErrorResponse
Definitionen
ProtocolVersion
Die JSON-RPC-Version, die jede Nachricht trägt. Nur 2.0 wird gesprochen.
Typ: const "2.0"
Konstante: "2.0"
RequestId
Der Bezeichner des Aufrufers für eine Anfrage, der in der Antwort darauf zurückgegeben wird. Eine Nachricht ohne Bezeichner ist eine Benachrichtigung und wird nie beantwortet.
Typ: string or number
ProgressToken
Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt.
Typ: string or number
WorkspaceRootSubject
Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt.
Typ: string
WorkspaceRootAccepted
Der absolute Pfad eines Workspace. Der Gegenstand dieser Methode ist kein Workspace — sie antwortet aus dem, was das Binary selbst mitführt —, daher wird das Feld akzeptiert und nicht gelesen. Es ist zugelassen, damit ein Client es einheitlich bei jeder Anfrage senden kann, ohne wissen zu müssen, welche Methoden es heranziehen.
Typ: string
RequestMethod
Jede Methode, die eine Anfrage nennen kann. Die Menge ist geschlossen: Eine Anfrage, die etwas anderes nennt, wird mit einem Fehler „Methode nicht gefunden“ beantwortet.
Typ: string (enum)
Zulässige Werte: "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
Jede Methode, die eine Client-Benachrichtigung nennen kann. Die Menge ist geschlossen, und keine der beiden Benachrichtigungen wird beantwortet.
Typ: string (enum)
Zulässige Werte: "$/cancelRequest", "aggrega/shutdown"
DaemonNotificationMethod
Jede Methode, die eine vom Daemon gesendete Benachrichtigung nennen kann. Die Menge ist geschlossen.
Typ: string (enum)
Zulässige Werte: "$/progress", "aggrega/publishDiagnostics"
Request
Eine Anfrage, die der Client sendet und der Daemon beantwortet. Die Methode nennt, was angefragt wird; das params-Objekt trägt die eigenen Felder dieser Methode sowie die zwei, die jede Methode zulässt. Eine Anfrage, die params ganz weglässt, wird als eine gelesen, deren Felder alle fehlen.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
jsonrpc | ProtocolVersion | ja | Die JSON-RPC-Version, die jede Nachricht trägt. Nur 2.0 wird gesprochen. |
id | RequestId | ja | Der Bezeichner des Aufrufers für eine Anfrage, der in der Antwort darauf zurückgegeben wird. Eine Nachricht ohne Bezeichner ist eine Benachrichtigung und wird nie beantwortet. |
method | RequestMethod | ja | Jede Methode, die eine Anfrage nennen kann. Die Menge ist geschlossen: Eine Anfrage, die etwas anderes nennt, wird mit einem Fehler „Methode nicht gefunden“ beantwortet. |
params | object | nein |
Zusätzliche Eigenschaften sind nicht zulässig.
params je method:
method | params | Erforderlich |
|---|---|---|
"aggrega/initialize" | InitializeParams | nein |
"aggrega/validate" | ValidateParams | nein |
"aggrega/invalidate" | InvalidateParams | nein |
"aggrega/diagnostics" | DiagnosticsParams | nein |
"aggrega/irGraph" | IrGraphParams | nein |
"aggrega/build" | BuildParams | nein |
"aggrega/buildPreview" | BuildPreviewParams | nein |
"aggrega/entityDefinition" | EntityDefinitionParams | nein |
"aggrega/releaseClosure" | ReleaseClosureParams | nein |
"aggrega/resolveDependencies" | ResolveDependenciesParams | nein |
"aggrega/pin" | PinParams | nein |
"aggrega/cacheStatus" | WorkspaceAndProgressParams | nein |
"aggrega/cachePrune" | WorkspaceAndProgressParams | nein |
"aggrega/cacheEvict" | CacheEvictParams | nein |
"aggrega/cacheClear" | WorkspaceAndProgressParams | nein |
"aggrega/registryList" | WorkspaceAndProgressParams | nein |
"aggrega/search" | SearchParams | nein |
"aggrega/registryAdd" | RegistryAddParams | nein |
"aggrega/registryRemove" | RegistryRemoveParams | nein |
"aggrega/registryUpdate" | RegistryUpdateParams | nein |
"aggrega/logout" | LogoutParams | nein |
"aggrega/publishEntity" | PublishEntityParams | nein |
"aggrega/publishArtifact" | PublishArtifactParams | nein |
"aggrega/signArtifacts" | SignArtifactsParams | nein |
"aggrega/deprecateArtifact" | DeprecateArtifactParams | nein |
"aggrega/resolve" | ResolveParams | nein |
"aggrega/findReferences" | FindReferencesParams | nein |
"aggrega/findImplementations" | FindImplementationsParams | nein |
"aggrega/hover" | HoverParams | nein |
"aggrega/completion" | CompletionParams | nein |
"aggrega/catalogIndex" | CatalogIndexParams | nein |
"aggrega/attachCandidates" | AttachCandidatesParams | nein |
"aggrega/connectionCandidates" | ConnectionCandidatesParams | nein |
"aggrega/insertionPoint" | InsertionPointParams | nein |
"aggrega/attachmentContainer" | AttachmentContainerParams | nein |
"aggrega/connectionAtPosition" | ConnectionAtPositionParams | nein |
"aggrega/releaseCandidates" | WorkspaceAndProgressParams | nein |
"aggrega/activeRelease" | WorkspaceAndProgressParams | nein |
"aggrega/setActiveRelease" | SetActiveReleaseParams | nein |
"aggrega/editDocument" | EditDocumentParams | nein |
"aggrega/effectiveConfiguration" | WorkspaceAndProgressParams | nein |
"aggrega/configInit" | ConfigInitParams | nein |
"aggrega/configCapture" | ConfigCaptureParams | nein |
"aggrega/import" | ImportParams | nein |
"aggrega/scaffoldEntity" | ScaffoldEntityParams | nein |
"aggrega/lint" | LintParams | nein |
"aggrega/pluginAdd" | PluginAddParams | nein |
"aggrega/pluginRemove" | PluginRemoveParams | nein |
"aggrega/pluginSync" | PluginSyncParams | nein |
"aggrega/pluginGenCatalog" | PluginGenCatalogParams | nein |
"aggrega/explainError" | ExplainErrorParams | nein |
"aggrega/getSchema" | GetSchemaParams | nein |
"aggrega/skillsInstall" | SkillsInstallParams | nein |
"aggrega/skillsList" | WorkspaceAndProgressParams | nein |
ClientNotification
Eine Benachrichtigung, die der Client sendet. Sie trägt keinen Bezeichner und wird nie beantwortet.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
jsonrpc | ProtocolVersion | ja | Die JSON-RPC-Version, die jede Nachricht trägt. Nur 2.0 wird gesprochen. |
method | ClientNotificationMethod | ja | Jede Methode, die eine Client-Benachrichtigung nennen kann. Die Menge ist geschlossen, und keine der beiden Benachrichtigungen wird beantwortet. |
params | object | nein |
Zusätzliche Eigenschaften sind nicht zulässig.
params je method:
method | params | Erforderlich |
|---|---|---|
"$/cancelRequest" | CancelRequestParams | ja |
"aggrega/shutdown" | ShutdownParams | nein |
DaemonNotification
Eine Benachrichtigung, die der Daemon sendet. Sie trägt keinen Bezeichner und wird nie beantwortet.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
jsonrpc | ProtocolVersion | ja | Die JSON-RPC-Version, die jede Nachricht trägt. Nur 2.0 wird gesprochen. |
method | DaemonNotificationMethod | ja | Jede Methode, die eine vom Daemon gesendete Benachrichtigung nennen kann. Die Menge ist geschlossen. |
params | object | ja |
Zusätzliche Eigenschaften sind nicht zulässig.
params je method:
method | params | Erforderlich |
|---|---|---|
"$/progress" | ProgressParams | ja |
"aggrega/publishDiagnostics" | PublishDiagnosticsParams | ja |
CancelRequestParams
Fordert den Daemon auf, eine bereits laufende Anfrage aufzugeben, und nennt sie über den Bezeichner, den die Anfrage trug. Bei einer bereits abgeschlossenen oder nie gesendeten Anfrage gibt es schlicht nichts abzubrechen, und nichts wird gemeldet.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
id | RequestId | ja | Der Bezeichner des Aufrufers für eine Anfrage, der in der Antwort darauf zurückgegeben wird. Eine Nachricht ohne Bezeichner ist eine Benachrichtigung und wird nie beantwortet. |
Zusätzliche Eigenschaften sind nicht zulässig.
ShutdownParams
Fordert den Daemon auf, keine Arbeit mehr anzunehmen und das abzuschließen, was er bereits übernommen hat. Die Benachrichtigung trägt keine Felder, und die Benachrichtigung selbst wird gewöhnlich ganz ohne params-Objekt gesendet. Eine zweite gibt die noch laufende Arbeit auf, statt auf sie zu warten.
Dieses Objekt deklariert keine festen Eigenschaften und lässt keine zu.
ProgressParams
Ein Bericht über laufende Arbeit, nur für eine Anfrage gesendet, die in einer Sitzung, die erklärt hat, solche Berichte empfangen zu können, ein Fortschrittstoken erzeugt hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
token | ProgressToken | ja | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
value | ProgressBegin oder ProgressReport oder ProgressEnd | ja | Der Bericht selbst. Ein öffnender Bericht, dann beliebig viele Zeilen, dann ein schließender Bericht. |
Zusätzliche Eigenschaften sind nicht zulässig.
ProgressBegin
Öffnet einen Bericht und sagt, was begonnen hat, in den Begriffen, die die Operation selbst verwendet.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
kind | const “begin” | ja | Kennzeichnet diesen Payload als Eröffnung eines Berichts. Konstante: "begin" |
title | string | ja | Was begonnen hat. |
Zusätzliche Eigenschaften sind nicht zulässig.
ProgressReport
Eine Zeile des eigenen Berichts der Operation über sich selbst. Sie trägt keinen Anteilswert: Die Operationen, die hier berichten, arbeiten eine Menge ab, deren Größe zu Beginn der Arbeit nicht bekannt ist, daher müsste ein Anteilswert erfunden werden.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
kind | const “report” | ja | Kennzeichnet diesen Payload als eine Zeile eines offenen Berichts. Konstante: "report" |
message | string | ja | Eine Zeile der eigenen Ausgabe der Operation, ohne umgebende Leerzeichen. |
Zusätzliche Eigenschaften sind nicht zulässig.
ProgressEnd
Schließt einen Bericht. Er trägt nichts außer der Art, weil das Ergebnis in der Antwort übermittelt wird, auf die der Aufrufer bereits wartet.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
kind | const “end” | ja | Kennzeichnet diesen Payload als Abschluss eines Berichts. Konstante: "end" |
Zusätzliche Eigenschaften sind nicht zulässig.
PublishDiagnosticsParams
Die Befunde für eine Datei, vom Daemon übermittelt, wenn eine Validierung sie für ein anderes Dokument als das von der Anfrage genannte erzeugt hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
file | string | ja | Die Datei, auf die sich die Befunde beziehen. |
diagnostics | Diagnostic[] oder null | ja | Die Befunde in der Reihenfolge, in der sie erzeugt wurden. |
Zusätzliche Eigenschaften sind nicht zulässig.
SuccessResponse
Die Antwort auf eine erfolgreiche Anfrage, die den Bezeichner der Anfrage trägt, die sie beantwortet. Eine Antwort trägt keine Methode, daher wird die geltende Ergebnisform durch die Anfrage festgelegt, zu der der Bezeichner gehört, und nicht durch etwas in der Antwort selbst.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
jsonrpc | ProtocolVersion | ja | Die JSON-RPC-Version, die jede Nachricht trägt. Nur 2.0 wird gesprochen. |
id | RequestId | ja | Der Bezeichner des Aufrufers für eine Anfrage, der in der Antwort darauf zurückgegeben wird. Eine Nachricht ohne Bezeichner ist eine Benachrichtigung und wird nie beantwortet. |
result | InitializeResult oder ValidateResult oder InvalidateResult oder DiagnosticsResult oder IrGraphResult oder BuildResult oder BuildPreviewResult oder EntityDefinitionResult oder ReleaseClosureResult oder ResolveDependenciesResult oder PinResult oder CacheStatusResult oder CachePruneResult oder CacheEvictResult oder CacheClearResult oder RegistryListResult oder SearchResult oder RegistryAddResult oder RegistryRemoveResult oder RegistryUpdateResult oder LogoutResult oder PublishEntityResult oder PublishArtifactResult oder SignArtifactsResult oder DeprecateArtifactResult oder ResolveResult oder FindReferencesResult oder FindImplementationsResult oder HoverResult oder CompletionResult oder CatalogIndexResult oder AttachCandidatesResult oder ConnectionCandidatesResult oder InsertionPointResult oder AttachmentContainerResult oder ConnectionAtPositionResult oder ReleaseCandidatesResult oder ActiveReleaseResult oder EditDocumentResult oder EffectiveConfigurationResult oder ConfigInitResult oder ConfigCaptureResult oder ImportResult oder ScaffoldEntityResult oder LintResult oder PluginAddResult oder PluginRemoveResult oder PluginSyncResult oder PluginGenCatalogResult oder ExplainErrorResult oder GetSchemaResult oder SkillsInstallResult oder SkillsListResult | ja | Die Antwort, in der Form, die die angefragte Methode zurückgibt. |
Zusätzliche Eigenschaften sind nicht zulässig.
ErrorResponse
Die Antwort auf eine Anfrage, die abgelehnt wurde oder fehlgeschlagen ist, mit dem Bezeichner der Anfrage, die sie beantwortet.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
jsonrpc | ProtocolVersion | ja | Die JSON-RPC-Version, die jede Nachricht trägt. Nur 2.0 wird gesprochen. |
id | RequestId | ja | Der Bezeichner des Aufrufers für eine Anfrage, der in der Antwort darauf zurückgegeben wird. Eine Nachricht ohne Bezeichner ist eine Benachrichtigung und wird nie beantwortet. |
error | ErrorObject | ja | Was schiefgelaufen ist: ein Code, nach dem ein Client verzweigen kann, eine Meldung, die für einen Menschen zum Lesen geschrieben ist, und — wo die Bedingung eine hat — die Artefakte und die Quellposition, auf die sich die Meldung bezieht. |
Zusätzliche Eigenschaften sind nicht zulässig.
ErrorObject
Was schiefgelaufen ist: ein Code, nach dem ein Client verzweigen kann, eine Meldung, die für einen Menschen zum Lesen geschrieben ist, und — wo die Bedingung eine hat — die Artefakte und die Quellposition, auf die sich die Meldung bezieht.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
code | ErrorCode | ja | Die Bedingung, die die Antwort meldet. Die negativen Codes sind die eigene reservierte Menge des Protokolls; die vierstelligen Codes sind Bedingungen, die dieser Daemon auslöst, und jede benennt einen Zustand, auf den ein Client reagieren kann. Die Menge ist geschlossen. |
message | string | ja | Was schiefgelaufen ist, in Prosa. Es ist derselbe Wortlaut, den dieselbe Bedingung auf jeder anderen Oberfläche trägt, die sie meldet. |
data | ErrorData | nein | Die Artefakte und die Quellposition, auf die sich die Meldung bezieht, strukturiert mitgeführt, damit ein Client sie nicht aus der Prosa herauslesen muss. Jedes Feld ist optional, und eine Bedingung füllt nur, was sie zur Hand hat; kein Feld steht für ein anderes, daher erfährt ein Client aus dem Feld, das er gelesen hat, was er erhalten hat, und nicht aus dem Code daneben. |
Zusätzliche Eigenschaften sind nicht zulässig.
ErrorCode
Die Bedingung, die die Antwort meldet. Die negativen Codes sind die eigene reservierte Menge des Protokolls; die vierstelligen Codes sind Bedingungen, die dieser Daemon auslöst, und jede benennt einen Zustand, auf den ein Client reagieren kann. Die Menge ist geschlossen.
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
Zulässige Werte:
-32700— Die Nachricht konnte nicht als JSON geparst werden.-32600— Die Nachricht wurde geparst, ist aber keine wohlgeformte Anfrage.-32601— Es gibt keine Methode dieses Namens.-32602— Die params, die die Anfrage trug, sind nicht zulässig: ein Feld, das die Methode nicht akzeptiert, ein Feld des falschen Typs oder ein Wert, den die Methode ablehnt.-32603— Der Daemon ist bei der Ausführung der Arbeit gescheitert.1001— Der Daemon hält keine Lesung der Datei vor und erzeugt auch keine. Der Client stößt eine an, indem er eine Validierung anfordert, und versucht es dann erneut.1003— Das Lockfile für das Release, das die Anfrage genannt hat, fehlt, und die Operation benötigt eines.1004— Die Entität, die die Anfrage genannt hat, konnte weder aus dem Katalog noch aus dem Release aufgelöst werden, das die Anfrage genannt hat.1005— Der Daemon wird heruntergefahren und lehnt neue Arbeit ab. Der Client versucht es nicht erneut beim selben Daemon.1006— Eine Validierung der Datei läuft gerade und wurde nicht innerhalb des Zeitbudgets abgeschlossen, das die wartende Anfrage zugestanden hat. Der Client wartet und fragt erneut an, ohne in der Zwischenzeit etwas zu senden.
ErrorData
Die Artefakte und die Quellposition, auf die sich die Meldung bezieht, strukturiert mitgeführt, damit ein Client sie nicht aus der Prosa herauslesen muss. Jedes Feld ist optional, und eine Bedingung füllt nur, was sie zur Hand hat; kein Feld steht für ein anderes, daher erfährt ein Client aus dem Feld, das er gelesen hat, was er erhalten hat, und nicht aus dem Code daneben.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
file | string | nein | Das Quelldokument, das die Positionsfelder verorten — das geprüfte Dokument oder das Release, dessen Laden fehlgeschlagen ist. |
line | integer | nein | Die Zeile, auf die sich die Bedingung bezieht, ab eins gezählt. |
column | integer | nein | Die Spalte, auf die sich die Bedingung bezieht, ab eins gezählt. |
end_line | integer | nein | Die Zeile eine Position hinter dem Ende des Tokens, auf das sich die Bedingung bezieht. Fehlt, wo das Token kein ermittelbares Ende hat; in diesem Fall stellt ein Client die Position als Punkt dar. |
end_column | integer | nein | Die Spalte eine Position hinter dem Ende des Tokens, auf das sich die Bedingung bezieht. |
release | string | nein | Das Release, auf das sich die Bedingung bezieht, so geschrieben, wie die Anfrage es genannt hat, damit ein Client die Abhilfe zusammenstellen kann, ohne es neu zusammenzusetzen. |
lockfile | string | nein | Das Lockfile, um das es bei einer Lockfile-bezogenen Bedingung geht: der Pfad, nach dem gesucht wurde und der nicht gefunden wurde oder nicht gelesen werden konnte. |
unreachable | boolesch | nein | Ob die Ablehnung eine von der Anfrage genannte Registry betrifft, die nicht erreicht werden konnte: Ihr Name ließ sich nicht auflösen, eine Verbindung zu ihr wurde abgelehnt oder konnte nicht geöffnet werden, oder eine sichere Verbindung zu ihr konnte nicht hergestellt werden. Es wird aus dem Fehlschlag selbst gelesen statt aus der Meldung und nur dort gesetzt, wo der Fehlschlag zeigt, dass die Registry nie erreicht wurde. Eine abgelehnte Index-Aktualisierung, die eine Registry nennt, trägt es; eine Registry, die geantwortet hat, gleich was sie geantwortet hat, lässt es fehlen. |
code | string | nein | Der beschreibende Name der Bedingung, die die Ablehnung nennt, stabil über Versionen hinweg: derselbe Wert, den eine Diagnose, die diese Bedingung meldet, in ihrem eigenen Code trägt. Danach verzweigt ein Client, statt nach der Meldung oder nach dem numerischen Code daneben, der den Zustand der Anfrage benennt und für jede Bedingung derselbe bleibt. Genau dann vorhanden, wenn die Ablehnung eine registrierte Bedingung nennt, und fehlend, wenn sie keine nennt. |
shortCode | string | nein | Der Kurzcode der Bedingung, der Buchstabe E und vier Ziffern: die Form, die ein Leser zitiert und nachschlägt, und diejenige, mit der die Meldung einer Ablehnung beginnt, die eine Bedingung nennt. Genau dann vorhanden, wenn code vorhanden ist. |
Zusätzliche Eigenschaften sind nicht zulässig.
Diagnostic
Ein Befund zu einem Dokument: wo er liegt, wie schwerwiegend er ist, was er besagt, und der zitierbare Code, der die Bedingung benennt, die er meldet.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
line | integer | ja | Die Zeile, auf die sich der Befund bezieht, ab eins gezählt. |
column | integer | ja | Die Spalte, auf die sich der Befund bezieht, ab eins gezählt. |
severity | const “error” oder const “warning” oder const “info” | ja | Wie schwerwiegend der Befund ist. Zulässige Werte: "error" — Der Befund ist ein Fehler. Ein Plugin-Befund mit dem Schweregrad halt wird auf dieser Stufe gemeldet. "warning" — Der Befund wird gemeldet und ist kein Fehler. Ein Plugin-Befund mit dem Schweregrad warn wird auf dieser Stufe gemeldet. "info" — Der Befund ist eine Information, wie es ein Plugin-Befund mit dem Schweregrad info ist. |
message | string | ja | Was der Befund besagt, in Prosa. |
code | string | nein | Der beschreibende Name der Bedingung, stabil über Versionen hinweg und in einer Unterdrückung zitierbar. |
shortCode | string | nein | Der Kurzcode der Bedingung, die Form, mit der eine abbrechende Diagnose beginnt. |
codeDescription | CodeDescription | nein | Wo die Bedingung erklärt wird, die der Befund nennt. |
classification | string | nein | Wie der Befund zustande kam, wo die Bedingung das unterscheidet. |
suggest | string | nein | Die Schreibweise, die der Befund vorschlägt, wo die Bedingung eine nennen kann — etwa ein knapp verfehlter Bezeichner. |
keyPath | string | nein | Der Pfad durch das Dokument zu dem Schlüssel, auf den sich der Befund bezieht. |
source | string | ja | Was den Befund erzeugt hat. |
end_line | integer | nein | Die Zeile eine Position hinter dem Ende des Tokens, auf das sich der Befund bezieht, damit ein Client das ganze Token statt eines einzelnen Zeichens darstellen kann. Fehlt bei einem Token, das sich über mehrere Zeilen erstreckt. |
end_column | integer | nein | Die Spalte eine Position hinter dem Ende des Tokens, auf das sich der Befund bezieht. |
Zusätzliche Eigenschaften sind nicht zulässig.
CodeDescription
Wo die Bedingung erklärt wird, die der Befund nennt.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
href | string | ja | Die veröffentlichte Adresse, unter der die Bedingung erklärt wird. |
Zusätzliche Eigenschaften sind nicht zulässig.
Position
Eine Stelle in einem Dokument: eine Zeile und ein Zeichenoffset darin, beide ab null gezählt. Der Offset wird in den Einheiten der Kodierung gemessen, auf die sich die Sitzung beim Öffnen geeinigt hat; das ist UTF-16, sofern der Client nicht eine andere angefordert hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
line | integer | ja | Die Zeile, ab null gezählt. |
character | integer | ja | Der Offset innerhalb der Zeile, ab null gezählt, in den Einheiten der Kodierung, auf die sich die Sitzung geeinigt hat. |
Zusätzliche Eigenschaften sind nicht zulässig.
Range
Eine Spanne zwischen zwei Stellen in einem Dokument.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
start | Position | ja | Eine Stelle in einem Dokument: eine Zeile und ein Zeichenoffset darin, beide ab null gezählt. Der Offset wird in den Einheiten der Kodierung gemessen, auf die sich die Sitzung beim Öffnen geeinigt hat; das ist UTF-16, sofern der Client nicht eine andere angefordert hat. |
end | Position | ja | Eine Stelle in einem Dokument: eine Zeile und ein Zeichenoffset darin, beide ab null gezählt. Der Offset wird in den Einheiten der Kodierung gemessen, auf die sich die Sitzung beim Öffnen geeinigt hat; das ist UTF-16, sofern der Client nicht eine andere angefordert hat. |
Zusätzliche Eigenschaften sind nicht zulässig.
Location
Eine Spanne in einem benannten Dokument.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
uri | string | ja | Das Dokument, in dem die Spanne liegt, als URI adressiert. |
range | Range | ja | Eine Spanne zwischen zwei Stellen in einem Dokument. |
Zusätzliche Eigenschaften sind nicht zulässig.
WorkspaceAndProgressParams
Das params-Objekt einer Methode, die keine eigenen Felder deklariert. Es lässt dennoch die zwei Felder zu, die jede Anfrage zulässt: den Workspace, auf den sie wirkt, und ein Fortschrittstoken.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
Zusätzliche Eigenschaften sind nicht zulässig.
InitializeParams
Öffnet eine Sitzung über einem Workspace und gibt an, was der Client verarbeiten kann. Dies ist die einzige Methode, bei der workspaceRoot eine Deklaration und kein Gegenstand ist: fehlend, leer und ein Pfad sind drei verschiedene Dinge, und eine ohne Pfad geöffnete Sitzung ist eine, die der Client noch nicht auf einen Workspace ausgerichtet hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
capabilities | ClientCapabilities | nein | Was der Client verarbeiten kann. Nicht Angegebenes gilt als nicht unterstützt. Unbekannte Mitglieder werden ignoriert statt abgelehnt, sodass ein Client eine Fähigkeit angeben kann, die dieser Daemon noch nicht liest. |
workspaceRoot | string | nein | Der absolute Pfad des zu öffnenden Workspace. Fehlt er, bleibt die Sitzung ohne Workspace; ein leerer String ist ein vom Client gelieferter Pfad und nicht dasselbe, wie keinen zu senden. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
Zusätzliche Eigenschaften sind nicht zulässig.
ClientCapabilities
Was der Client verarbeiten kann. Nicht Angegebenes gilt als nicht unterstützt. Unbekannte Mitglieder werden ignoriert statt abgelehnt, sodass ein Client eine Fähigkeit angeben kann, die dieser Daemon noch nicht liest.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
general | object | nein | Fähigkeiten, die nicht an eine bestimmte Art von Antwort gebunden sind. |
window | object | nein | Fähigkeiten dazu, was der Client anzeigen kann, während Arbeit läuft. |
Zusätzliche Eigenschaften sind zulässig.
ClientCapabilities.general
Fähigkeiten, die nicht an eine bestimmte Art von Antwort gebunden sind.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
positionEncodings | string[] | nein | Die Positionskodierungen, die der Client lesen kann, die beste zuerst. |
Zusätzliche Eigenschaften sind zulässig.
ClientCapabilities.window
Fähigkeiten dazu, was der Client anzeigen kann, während Arbeit läuft.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workDoneProgress | boolesch | nein | Ob der Client Fortschrittsbenachrichtigungen empfangen kann. Eine Anfrage, die in einer Sitzung, die dies nicht deklariert hat, ein Fortschrittstoken erzeugt, wird abgelehnt. |
Zusätzliche Eigenschaften sind zulässig.
ValidateParams
Prüft den Workspace oder ein Dokument darin und antwortet mit den Befunden.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
file | string | nein | Das zu prüfende Dokument. Fehlt es, wird geprüft, was der Workspace enthält. |
content | string | nein | Der Text des Dokuments, wie der Client ihn aktuell vorhält, um einen nicht gespeicherten Puffer zu prüfen. Fehlt er, werden die Bytes auf der Festplatte gelesen. |
release | string | nein | Das Release, gegen das geprüft wird, als Pfad relativ zur Workspace-Wurzel. |
Zusätzliche Eigenschaften sind nicht zulässig.
InvalidateParams
Teilt dem Daemon mit, dass sich ein Dokument, von dem er eine Lesung vorhält, geändert hat, sodass die nächste Antwort dazu aus den neuen Bytes berechnet wird.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
file | string | nein | Das Dokument, das sich geändert hat. |
granularity | string | nein | Wie viel von dem, was der Daemon vorhält, verworfen wird: file verwirft nur das, was er für das genannte Dokument vorhält; workspace, der Standardwert und das, als was jeder andere Wert gelesen wird, verwirft zusätzlich das, was er für den gesamten Workspace vorhält. |
Zusätzliche Eigenschaften sind nicht zulässig.
DiagnosticsParams
Antwortet mit den Befunden, die der Daemon für ein Dokument bereits vorhält, ohne es erneut zu prüfen.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
file | string | nein | Das Dokument, über das berichtet wird. Der Daemon muss bereits eine Lesung davon vorhalten. |
Zusätzliche Eigenschaften sind nicht zulässig.
IrGraphParams
Antwortet mit dem aufgelösten Graphen, zu dem ein Release kompiliert wird, ohne ihn zu rendern.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
release | string | nein | Das aufzulösende Release, als Pfad relativ zur Workspace-Wurzel. Ein absoluter Pfad wird abgelehnt. |
unredacted | boolesch | nein | Ob mit den Werten, die ein Autor als sensibel deklariert hat, im Klartext geantwortet wird. Fehlend oder false, wird jeder von ihnen im Graphen zurückgehalten, und eine Markierung, die den Grund nennt, steht an seiner Stelle, so wie die Graph-Ausgabe der Befehlszeile sie zurückhält; true antwortet mit dem Graphen, wie das Release zu ihm kompiliert wird, einschließlich dieser Werte. |
Zusätzliche Eigenschaften sind nicht zulässig.
BuildParams
Kompiliert ein Release und schreibt die gerenderten Artefakte in den Workspace.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
release | string | nein | Das zu bauende Release, als Pfad relativ zur Workspace-Wurzel. Ein absoluter Pfad wird abgelehnt. |
outputParent | string | nein | Das Verzeichnis, in dem das Ausgabeverzeichnis angelegt wird, als Pfad relativ zur Workspace-Wurzel. Die Artefakte landen im Ausgabeverzeichnis darunter, so angeordnet, wie sie unter der Workspace-Wurzel liegen, wenn nichts genannt wird — dies nennt also das übergeordnete Verzeichnis des Ausgabeverzeichnisses und nie das Ausgabeverzeichnis selbst. Fehlend oder leer, wird das Ausgabeverzeichnis unter der Workspace-Wurzel geschrieben, wie es aggrega build tut, gleich von wo es ausgeführt wird. Ein absoluter Pfad oder einer, der aus dem Workspace hinausführt, wird abgelehnt. |
autoPull | boolesch | nein | Ob zuerst die Abhängigkeiten des Release aufgelöst werden. Wird dies angefordert, werden die konfigurierten Registries erreicht und das Lockfile geschrieben; ohne Anforderung erreicht der Build keine Registry. |
policyInput | string | nein | Das Verzeichnis, in das neben den Artefakten der Payload geschrieben wird, den jede Governance-Rolle einem dort angebundenen Plugin übergibt, als Pfad relativ zur Workspace-Wurzel — die Dateien, die aggrega build --policy-input schreibt, unter denselben Namen, geschrieben, ob der Build abschließt oder abbricht. Die Hinweise der Antwort sagen, wie viele geschrieben wurden, und nennen jede Rolle, für die keine Datei geschrieben wurde. Bei einer fehlschlagenden Anfrage liegen die geschriebenen Dateien auf der Festplatte, und diese Angaben sind nicht in der Antwort: Der Fehler trägt nur die Ablehnung. Fehlend, wird keine geschrieben. Ein absoluter Pfad oder einer, der aus dem Workspace hinausführt, wird abgelehnt. |
Zusätzliche Eigenschaften sind nicht zulässig.
BuildPreviewParams
Kompiliert ein Release und meldet, was das Schreiben der Artefakte erzeugt hätte, ohne eines davon zu schreiben. Es lehnt das Feld zur Abhängigkeitsauflösung ab, das der schreibende Build annimmt, weil eine Anfrage, die nichts schreibt, kein Lockfile füllen kann.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
release | string | nein | Das zu kompilierende Release, als Pfad relativ zur Workspace-Wurzel. |
autoPull | boolesch | nein | In den übertragenen Nachrichten akzeptiert und von der Methode abgelehnt: Diese Anfrage schreibt nichts, daher kann sie kein Lockfile füllen und zugleich bleiben, was sie zu sein angibt. |
policyInput | string | nein | Das Verzeichnis, in das der Payload geschrieben wird, den jede Governance-Rolle einem dort angebundenen Plugin übergibt, als Pfad relativ zur Workspace-Wurzel — die Dateien, die aggrega build --dry-run --policy-input schreibt, unter denselben Namen. Wird es gesendet, sind sie das Einzige, was diese Anfrage schreibt; das Ausgabeverzeichnis und das Lockfile bleiben unberührt. Die Hinweise der Antwort sagen, wie viele geschrieben wurden, und nennen jede Rolle, für die keine Datei geschrieben wurde. Bei einer fehlschlagenden Anfrage liegen die geschriebenen Dateien auf der Festplatte, und diese Angaben sind nicht in der Antwort: Der Fehler trägt nur die Ablehnung. Ein absoluter Pfad oder einer, der aus dem Workspace hinausführt, wird abgelehnt. |
Zusätzliche Eigenschaften sind nicht zulässig.
EntityDefinitionParams
Antwortet damit, worauf ein Entitätsname aufgelöst wird und wo das Dokument liegt, das die Entität definiert.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
name | string | nein | Die aufzulösende Entität, nach Name — oder eine Registry-Referenz, oci://<host>/<repository>:<tag> oder @<digest> anstelle von :<tag>, um die an dieser Koordinate veröffentlichte Entität zu lesen. |
release | string | nein | Das Release, in dessen Begriffen der Name aufgelöst wird, als Pfad relativ zur Workspace-Wurzel. Der Name wird dann über die Katalogverzeichnisse aufgelöst, die die Workspace-Konfiguration diesem Release zuweist, sodass ein Name, den mehrere Varianten in einem Workspace deklarieren, eine pro Release, auf die Variante aufgelöst wird, mit der dieses Release gebaut wird, und ein Name, den es nicht auflöst, mit einer Erklärung abgelehnt wird, die den Eintrag dieses Release unter workspace.releases nennt. Fehlend, wird der Name über die eigenen Katalogverzeichnisse des Workspace aufgelöst. Eine Registry-Referenz nimmt kein Release an und wird abgelehnt, wenn eines mitgegeben wird, ebenso wie ein Wert, der keine Release-Datei nennt. |
Zusätzliche Eigenschaften sind nicht zulässig.
CatalogIndexParams
Antwortet mit den Entitäten, die der Workspace enthält: jede Entität, die seine Dokumente deklarieren, und die Features, die seine Katalogverzeichnisse deklarieren.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
release | string | nein | Das Release, in dessen Begriffen die Entitäten aufgelistet werden, als Pfad relativ zur Workspace-Wurzel. Die Features sind dann diejenigen, die die Katalogverzeichnisse deklarieren, die die Workspace-Konfiguration diesem Release zuweist, und ein Dokument unter einem Katalogverzeichnis, das nur andere Releases lesen, wird ausgelassen, sodass ein Workspace, der Varianten einer Entität nebeneinander hält, eine pro Release, mit der Variante aufgelistet wird, mit der dieses Release gebaut wird. Fehlend, ist die Auflistung die eigene des Workspace. Ein Wert, der keine Release-Datei nennt, wird abgelehnt. |
Zusätzliche Eigenschaften sind nicht zulässig.
ReleaseClosureParams
Antwortet mit allem, wovon ein Release abhängt, so wie die Auflösung es erreicht hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
release | string | nein | Das zu untersuchende Release, als Pfad relativ zur Workspace-Wurzel. |
Zusätzliche Eigenschaften sind nicht zulässig.
ResolveDependenciesParams
Löst die Abhängigkeiten eines Release auf, pinnt sie im Lockfile und beschafft die externen Eingaben, die sein Rendering verbraucht. Es erreicht die konfigurierten Registries und schreibt.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
release | string | nein | Das aufzulösende Release, als Pfad relativ zur Workspace-Wurzel. |
upgrade | boolesch | nein | Ob innerhalb der deklarierten Bereiche neu aufgelöst wird, statt das zu berücksichtigen, was das Lockfile bereits pinnt. |
targets | string[] | nein | Die neu aufzulösenden Referenzen; der Rest bleibt gepinnt, wie er ist. Leer löst alles auf. |
verify | boolesch | nein | Ob das verzeichnete Lockfile mit der Auflösung verglichen wird, die diese Anfrage ohne es durchführen würde, unter Berücksichtigung der Pins, die diese Anfrage berücksichtigen würde, statt es zu schreiben. Eine Verifizierung schreibt kein Lockfile, keinen Plugin-Vertrauensdatensatz und kein entity.lock; der Inhaltscache wird gelesen und gefüllt, wie diese Auflösung ihn lesen und füllen würde. Eine Abweichung und ein fehlendes Lockfile lassen die Anfrage fehlschlagen. Es kann nicht mit upgrade, targets oder pinSources kombiniert werden, gleich welchen Wert pinSources trägt: Eine Anfrage, die eines davon daneben sendet, wird als ungültige params abgelehnt, bevor irgendetwas aufgelöst wird. |
pinSources | boolesch | nein | Ob der Pin-Schritt, den aggrega/pin ausführt, über die Recipes und FeatureRecipes ausgeführt wird, die das Release aus den Katalogverzeichnissen des Workspace baut, wobei neben jedem das entity.lock geschrieben wird, statt die Anfrage wegen eines abzulehnen, dessen Lock keinen Pin verzeichnet, den eine Eingabe benötigt. Fehlend, folgt es pin_sources_at_pull des Workspace; jeder der beiden Werte überschreibt diese Einstellung für diese Anfrage. |
Zusätzliche Eigenschaften sind nicht zulässig.
PinParams
Verzeichnet im entity.lock neben einem Recipe oder FeatureRecipe den Inhalts-Pin für jede Eingabe, die die Entität von außerhalb ihres eigenen Dokuments liest. Es wird kein Release genannt: Eine Eingabe, deren Identität die Entität vollständig ausschreibt, nennt ein einziges Artefakt für jedes Release, das die Entität verwendet, daher wird nichts, was ein Release liefert, benötigt, um sie zu pinnen. Es erreicht die Hosts, die die Quellen der Entität nennen, und schreibt neben die Entität; das Entitätsdokument selbst wird nie geschrieben.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
entity | string | nein | Das zu pinnende Entitätsdokument, als Pfad relativ zur Workspace-Wurzel. |
dryRun | boolesch | nein | Ob mit dem Lock geantwortet wird, das der Schritt schreiben würde, statt es zu schreiben. Die Eingaben werden dennoch aufgelöst, daher wird der Inhaltscache dennoch gefüllt. |
Zusätzliche Eigenschaften sind nicht zulässig.
CacheEvictParams
Gibt zwischengespeicherte Inhalte frei, bis das Verbleibende unter eine Größe passt, die die Anfrage nennt.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
maxSize | string | nein | Die Größe, auf die verkleinert wird, so geschrieben, wie ein Mensch sie schreibt — zum Beispiel 500MB. |
Zusätzliche Eigenschaften sind nicht zulässig.
SearchParams
Durchsucht, was die lokalen Indizes der konfigurierten Registries anbieten. Es liest den bereits auf der Festplatte liegenden Index und kontaktiert keine Registry.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
query | string | nein | Der Text, der mit Name und Beschreibung eines Datensatzes abgeglichen wird. |
kinds | string[] | nein | Die zu behaltenden Entitätsarten. Leer behält jede Art. |
selector | string | nein | Ein Label-Selektor, den die behaltenen Datensätze erfüllen müssen. |
capabilities | string[] | nein | Die Fähigkeiten, die ein behaltener Plugin-Datensatz deklarieren muss. |
pluginType | string | nein | Der zu behaltende Plugin-Typ. |
registry | string | nein | Der eine Registry-Host, der durchsucht wird. Fehlend, wird jeder konfigurierte Host durchsucht. |
limit | integer | nein | Die Höchstzahl an Datensätzen, mit denen geantwortet wird. |
includeRetracted | boolesch | nein | Ob Versionen behalten werden, die eine veröffentlichte Markierung als veraltet gekennzeichnet hat. |
Zusätzliche Eigenschaften sind nicht zulässig.
RegistryAddParams
Registriert eine Registry und die Vertrauensrichtlinie, die die Auflösung auf das anwendet, was sie bereitstellt. Es schreibt die maschinenweite Konfigurationsdatei, sofern die Anfrage nichts anderes verlangt, sodass jeder Workspace auf der Maschine über den Eintrag auflöst.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
host | string | nein | Der zu registrierende Registry-Host. |
name | string | nein | Ein sprechender Alias, der auf den Host aufgelöst wird. |
identities | string[] | nein | Die Signaturidentitäten, denen für das, was diese Registry bereitstellt, vertraut wird. |
keyPath | string | nein | Der Pfad eines öffentlichen Schlüssels, dem vertraut werden soll, für eine Registry, die mit einem solchen statt mit einer Keyless-Identität signiert ist. |
trustedRoot | string | nein | Der Pfad des Vertrauensankers, gegen den Signaturen verifiziert werden. |
requireSignatures | boolesch | nein | Ob ein Artefakt aus dieser Registry eine verifizierte Signatur tragen muss. Fehlend, wird nichts angegeben, und der aufgelöste Standardwert bleibt bestehen. |
advisory | boolesch | nein | Ob eine fehlgeschlagene Verifizierung gemeldet wird, statt abzubrechen. |
fetchTrust | boolesch | nein | Ob die Vertrauensrichtlinie, die die Registry ankündigt, gelesen und gepinnt wird. Fehlend, wird nichts angegeben, und der aufgelöste Standardwert bleibt bestehen. |
global | boolesch | nein | Schreibt die maschinenweite Konfigurationsdatei, was der eigene Standardwert dieser Methode ist. |
workspace | boolesch | nein | Schreibt die eigene Konfigurationsdatei dieses Workspace statt der maschinenweiten. |
Zusätzliche Eigenschaften sind nicht zulässig.
RegistryRemoveParams
Entfernt eine registrierte Registry. Es schreibt die maschinenweite Konfigurationsdatei, sofern die Anfrage nichts anderes verlangt.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
registry | string | nein | Die zu entfernende Registry, nach Host oder nach Alias. |
global | boolesch | nein | Schreibt die maschinenweite Konfigurationsdatei, was der eigene Standardwert dieser Methode ist. |
workspace | boolesch | nein | Schreibt die eigene Konfigurationsdatei dieses Workspace statt der maschinenweiten. |
Zusätzliche Eigenschaften sind nicht zulässig.
RegistryUpdateParams
Aktualisiert den lokalen Index, den eine Suche liest, und erreicht dazu die Registry. Was es schreibt, ist der Index unter dem eigenen konfigurierten Cache-Verzeichnis dieses Workspace. Eine Registry, die eine Anmeldeinformation benötigt, die keine Quelle aus der Umgebung liefert, wird unter Nennung der Anmeldeinformation abgelehnt, statt danach zu fragen.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
registry | string | nein | Die eine zu aktualisierende Registry. Fehlend, wird jeder konfigurierte Host aktualisiert. |
upgrade | boolesch | nein | Ob der Index neu aufgebaut wird, statt dem hinzuzufügen, was er bereits enthält. |
Zusätzliche Eigenschaften sind nicht zulässig.
LogoutParams
Entfernt eine gespeicherte Registry-Anmeldeinformation. Der Speicher wird von jedem Projekt auf der Maschine gemeinsam genutzt, und die Antwort sagt das.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
registry | string | nein | Die Registry, deren gespeicherte Anmeldeinformation entfernt werden soll. |
Zusätzliche Eigenschaften sind nicht zulässig.
PublishEntityParams
Veröffentlicht eine Entität in einer Registry. Was sie dort ablegt, ist das, was jeder Konsument dieser Registry auflöst, und eine veröffentlichte Version kann bei niemandem zurückgeholt werden, der sie bereits abgerufen hat. Es wird nichts interaktiv abgefragt: Die Identität wird aus dem aufgelöst, was die Anfrage geliefert hat oder was die Umgebung bereits mitführt.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
entity | string | nein | Das zu veröffentlichende Entitätsdokument, als Pfad relativ zur Workspace-Wurzel. |
registry | string | nein | Die Registry, in der veröffentlicht werden soll. Fehlt sie, wird der konfigurierte Standard verwendet. |
dryRun | boolesch | nein | Ob gemeldet werden soll, was die Veröffentlichung ablegen würde, ohne es abzulegen. |
sign | boolesch | nein | Ob das Veröffentlichte signiert werden soll. Fehlend, wird nichts angegeben, und der aufgelöste Standardwert bleibt bestehen. |
plugin | string | nein | Das Plugin-Modul, das zusammen mit einer Plugin-Entität veröffentlicht werden soll. |
fulcioUrl | string | nein | Die Zertifizierungsstelle, von der ein Signaturzertifikat bezogen werden soll. |
rekorUrl | string | nein | Das Transparency-Log, in dem die Signatur verzeichnet werden soll. |
timestampUrl | string | nein | Die Zeitstempelstelle, mit der gegengezeichnet werden soll. |
identityToken | string | nein | Das Identitätstoken, mit dem signiert werden soll, vom Aufrufer geliefert statt an einem Terminal bezogen. |
pinSources | boolesch | nein | Ob der Pin-Schritt, den aggrega/pin ausführt, auf der Entität ausgeführt werden soll, bevor sie gebündelt wird, sodass das entity.lock, das der Schritt daneben schreibt, Teil des Veröffentlichten ist. Der Schritt läuft vor jeder Ablehnung, die die Entität beurteilt, und unter dryRun meldet er das Lock, das er schreiben würde, und schreibt nichts. Fehlend, folgt es pin_sources_at_push des Workspace; jeder der beiden Werte überschreibt diese Einstellung für diese Anfrage. |
Zusätzliche Eigenschaften sind nicht zulässig.
PublishArtifactParams
Veröffentlicht eine beliebige Datei in einer Registry unter einem Namen und einem Tag, die die Anfrage ihr gibt.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
file | string | nein | Die zu veröffentlichende Datei, als Pfad relativ zur Workspace-Wurzel. |
name | string | nein | Der Repository-Name, unter dem veröffentlicht werden soll. |
tag | string | nein | Der Tag, unter dem veröffentlicht werden soll. |
mediaType | string | nein | Der Medientyp, der für die veröffentlichten Bytes verzeichnet werden soll. |
registry | string | nein | Die Registry, in der veröffentlicht werden soll. Fehlt sie, wird der konfigurierte Standard verwendet. |
dryRun | boolesch | nein | Ob gemeldet werden soll, was die Veröffentlichung ablegen würde, ohne es abzulegen. |
Zusätzliche Eigenschaften sind nicht zulässig.
SignArtifactsParams
Signiert, was bereits veröffentlicht ist. Eine Signatur kann bei niemandem zurückgeholt werden, der sie bereits abgerufen hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
references | string[] | nein | Die zu signierenden veröffentlichten Referenzen. |
fulcioUrl | string | nein | Die Zertifizierungsstelle, von der ein Signaturzertifikat bezogen werden soll. |
rekorUrl | string | nein | Das Transparency-Log, in dem die Signatur verzeichnet werden soll. |
timestampUrl | string | nein | Die Zeitstempelstelle, mit der gegengezeichnet werden soll. |
identityToken | string | nein | Das Identitätstoken, mit dem signiert werden soll, vom Aufrufer geliefert statt an einem Terminal bezogen. |
jobs | integer | nein | Wie viele Referenzen gleichzeitig signiert werden. Fehlt es, wird eine nach der anderen signiert. Jede Referenz wird dennoch genau so signiert, wie sie es allein würde — bei Keyless mit ihrem eigenen Zertifikat und ihrem eigenen Eintrag im Transparency-Log —, und die Antwort behält die Reihenfolge bei, in der die Referenzen übergeben wurden. Minimum: 1. |
Zusätzliche Eigenschaften sind nicht zulässig.
DeprecateArtifactParams
Kennzeichnet eine veröffentlichte Version als veraltet, sodass die Auflösung sie melden oder ablehnen kann. Die Markierung wird selbst veröffentlicht und signiert. Eine Anfrage sendet entweder eine Referenz mit ihrem Inhalt oder eine Batch-Datei, deren Einträge ihren eigenen tragen — nie beides, und nie Inhalt neben der Batch-Datei.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
reference | string | nein | Die zu kennzeichnende veröffentlichte Referenz. Eine Alternative zu from: Eine Anfrage, die beides trägt, wird abgelehnt. |
severity | const “warning” oder const “error” oder const “retracted” | nein | Wie deutlich die Markierung spricht — ob die Auflösung die Version meldet oder ablehnt. Erforderlich mit reference; neben from abgelehnt, dessen Batch-Datei für jede Markierung einen eigenen Wert trägt. Zulässige Werte: "warning" — Veraltet, auf der milderen der beiden beratenden Stufen: wird bei der Wahl einer Version weiterhin ausgewählt. "error" — Veraltet, auf der stärkeren der beiden beratenden Stufen: wird bei der Wahl einer Version weiterhin ausgewählt. "retracted" — Zurückgezogen: wird bei der Wahl einer Version ausgeschlossen. |
reason | string | nein | Warum die Version veraltet ist. Erforderlich mit reference; neben from abgelehnt, dessen Batch-Datei für jede Markierung einen eigenen Wert trägt. |
replacement | string | nein | Die stattdessen zu verwendende Referenz. Neben from abgelehnt, dessen Batch-Datei für jede Markierung einen eigenen Wert trägt. |
message | string | nein | Was einem Konsumenten mitgeteilt wird, der auf die Markierung trifft. Neben from abgelehnt, dessen Batch-Datei für jede Markierung einen eigenen Wert trägt. |
from | string | nein | Eine Batch-Datei mit Rückzugseinträgen, als Pfad relativ zur Workspace-Wurzel, die je Eintrag eine Markierung anhängt. Jeder Eintrag trägt seine eigene Referenz, seinen eigenen Schweregrad und seinen eigenen Grund sowie optional einen Ersatz und eine Meldung. Eine Alternative zu reference: Eine Anfrage, die beides trägt oder daneben einen Schweregrad, einen Grund, einen Ersatz oder eine Meldung trägt, wird abgelehnt. |
fulcioUrl | string | nein | Die Zertifizierungsstelle, von der ein Signaturzertifikat bezogen werden soll. |
rekorUrl | string | nein | Das Transparency-Log, in dem die Signatur verzeichnet werden soll. |
timestampUrl | string | nein | Die Zeitstempelstelle, mit der gegengezeichnet werden soll. |
identityToken | string | nein | Das Identitätstoken, mit dem signiert werden soll, vom Aufrufer geliefert statt an einem Terminal bezogen. |
Zusätzliche Eigenschaften sind nicht zulässig.
ResolveParams
Antwortet, wo das Element unter dem Cursor definiert ist.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
uri | string | nein | Das Dokument, in dem sich der Cursor befindet. |
position | Position | nein | Eine Stelle in einem Dokument: eine Zeile und ein Zeichenoffset darin, beide ab null gezählt. Der Offset wird in den Einheiten der Kodierung gemessen, auf die sich die Sitzung beim Öffnen geeinigt hat; das ist UTF-16, sofern der Client nicht eine andere angefordert hat. |
release | string | nein | Das Release, in dessen Begriffen geantwortet werden soll, als Pfad relativ zur Workspace-Wurzel. Die Definition ist dann das Dokument, zu dem sich die Referenz über die Katalogverzeichnisse auflöst, die die Workspace-Konfiguration diesem Release zuweist, in dieser Reihenfolge, sodass ein Name, den mehrere Varianten in einem Workspace deklarieren, eine pro Release, zur Variante dieses Release führt; wo diese Verzeichnisse keine solche Entität deklarieren, werden die Dokumente des Workspace durchsucht, wobei jene unter einem der Katalogverzeichnisse des Workspace ausgelassen werden, die das Release nicht liest. Fehlt es, werden zuerst die Dokumente des Workspace durchsucht und die eigenen Katalogverzeichnisse des Workspace nur dort, wo kein Dokument den Namen deklariert. Ein Wert, der keine Release-Datei nennt, wird abgelehnt. |
Zusätzliche Eigenschaften sind nicht zulässig.
FindReferencesParams
Antwortet, wo auf das Element unter dem Cursor verwiesen wird.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
uri | string | nein | Das Dokument, in dem sich der Cursor befindet. |
position | Position | nein | Eine Stelle in einem Dokument: eine Zeile und ein Zeichenoffset darin, beide ab null gezählt. Der Offset wird in den Einheiten der Kodierung gemessen, auf die sich die Sitzung beim Öffnen geeinigt hat; das ist UTF-16, sofern der Client nicht eine andere angefordert hat. |
release | string | nein | Das Release, in dessen Begriffen geantwortet werden soll, als Pfad relativ zur Workspace-Wurzel. Ein Verweis in einem Dokument unter einem der Katalogverzeichnisse des Workspace, die das Release nicht liest, wird dann nicht gemeldet, sodass Varianten, die ein Workspace nebeneinander hält, eine pro Release, nie als Verweise aufeinander gemeldet werden. Fehlt es, wird jedes Dokument des Workspace durchsucht. Ein Wert, der keine Release-Datei nennt, wird abgelehnt. |
Zusätzliche Eigenschaften sind nicht zulässig.
FindImplementationsParams
Antwortet, welche Dokumente das Element unter dem Cursor implementieren.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
uri | string | nein | Das Dokument, in dem sich der Cursor befindet. |
position | Position | nein | Eine Stelle in einem Dokument: eine Zeile und ein Zeichenoffset darin, beide ab null gezählt. Der Offset wird in den Einheiten der Kodierung gemessen, auf die sich die Sitzung beim Öffnen geeinigt hat; das ist UTF-16, sofern der Client nicht eine andere angefordert hat. |
release | string | nein | Das Release, in dessen Begriffen geantwortet werden soll, als Pfad relativ zur Workspace-Wurzel. Ein Dokument unter einem der Katalogverzeichnisse des Workspace, die das Release nicht liest, wird dann nicht gemeldet, sodass eine Variante, mit der ein anderes Release gebaut wird, nie unter denen dieses Release aufgeführt wird. Fehlt es, wird jedes Dokument des Workspace durchsucht. Ein Wert, der keine Release-Datei nennt, wird abgelehnt. |
Zusätzliche Eigenschaften sind nicht zulässig.
HoverParams
Antwortet mit dem, was über das Element unter dem Cursor angezeigt werden soll.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
uri | string | nein | Das Dokument, in dem sich der Cursor befindet. |
position | Position | nein | Eine Stelle in einem Dokument: eine Zeile und ein Zeichenoffset darin, beide ab null gezählt. Der Offset wird in den Einheiten der Kodierung gemessen, auf die sich die Sitzung beim Öffnen geeinigt hat; das ist UTF-16, sofern der Client nicht eine andere angefordert hat. |
release | string | nein | Das Release, in dessen Begriffen geantwortet werden soll, als Pfad relativ zur Workspace-Wurzel. Die angezeigte Entität ist dann diejenige, zu der sich die Referenz über die Katalogverzeichnisse auflöst, die die Workspace-Konfiguration diesem Release zuweist, in dieser Reihenfolge; wo diese Verzeichnisse keine solche Entität deklarieren, werden die Dokumente des Workspace durchsucht, wobei jene unter einem der Katalogverzeichnisse des Workspace ausgelassen werden, die das Release nicht liest. Fehlt es, werden zuerst die Dokumente des Workspace durchsucht und die eigenen Katalogverzeichnisse des Workspace nur dort, wo kein Dokument den Namen deklariert. Ein Wert, der keine Release-Datei nennt, wird abgelehnt. |
Zusätzliche Eigenschaften sind nicht zulässig.
CompletionParams
Antwortet mit dem, was an der Cursorposition geschrieben werden darf.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
uri | string | nein | Das Dokument, in dem sich der Cursor befindet. |
position | Position | nein | Eine Stelle in einem Dokument: eine Zeile und ein Zeichenoffset darin, beide ab null gezählt. Der Offset wird in den Einheiten der Kodierung gemessen, auf die sich die Sitzung beim Öffnen geeinigt hat; das ist UTF-16, sofern der Client nicht eine andere angefordert hat. |
context | CompletionContext | nein | Was die Anfrage ausgelöst hat, sofern der Client dies verfolgt. |
release | string | nein | Das Release, in dessen Begriffen geantwortet werden soll, als Pfad relativ zur Workspace-Wurzel. Die angebotenen Namen sind dann jene, die die Dokumente des Workspace deklarieren, abzüglich der Dokumente unter einem der Katalogverzeichnisse des Workspace, die das Release nicht liest, zusammen mit den Components und Features, die die Katalogverzeichnisse deklarieren, die die Workspace-Konfiguration diesem Release zuweist. Fehlt es, sind es die Dokumente des Workspace und die Components und Features, die seine eigenen Katalogverzeichnisse deklarieren. Ein Wert, der keine Release-Datei nennt, wird abgelehnt. |
Zusätzliche Eigenschaften sind nicht zulässig.
CompletionContext
Was die Anfrage ausgelöst hat, sofern der Client dies verfolgt.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
triggerKind | integer | nein | Warum die Vervollständigung angefordert wurde. |
triggerCharacter | string | nein | Das Zeichen, das sie ausgelöst hat, sofern es ein Zeichen war. |
Zusätzliche Eigenschaften sind zulässig.
AttachCandidatesParams
Antwortet, welche Features an eine Entität angebunden werden können, beurteilt anhand der Labels dieser Entität, und, für eine Verbindung, die die Komponente eines Graphknotens zieht, welche jeden Slot füllen können, den der Socket der Verbindung deklariert.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
node | string | nein | Die Entität, anhand derer die Kandidaten beurteilt werden, nach Namen, gelesen aus dem, was die Dokumente des Workspace deklarieren. |
graphNode | string | nein | Der Graphknoten, anhand dessen die Kandidaten beurteilt werden und dessen Labels die finalisierte Menge sind, mit der der Build selbst die Anwendbarkeit auswertet. Eine darüber berechnete Antwort sagt, was der Build tun wird. |
release | string | nein | Das Release, zu dessen Graph der Knoten gehört, als Pfad relativ zur Workspace-Wurzel. Die Kandidaten werden dann in den Begriffen dieses Release gezogen: die Features, die die Katalogverzeichnisse deklarieren, die die Workspace-Konfiguration diesem Release zuweist, und die Dokumente des Workspace abzüglich jener unter einem der Katalogverzeichnisse des Workspace, die das Release nicht liest, sodass ein für ein anderes Release vorgehaltenes Feature nie für einen Knoten des eigenen Graphen angeboten wird. |
labels | Map von string | nein | Labels, anhand derer direkt beurteilt wird, anstatt sie aus einer Entität oder einem Graphknoten zu lesen. |
connection | ConnectionCoordinate | nein | Eine Verbindung, die die Komponente des Knotens zieht, den graphNode nennt, und für die ebenso wie für diesen Knoten geantwortet werden soll: Die Antwort trägt dann auch slots, jeden Slot, den der Socket der Verbindung deklariert, mit den Features, die ihn füllen können, oder noSlotReason, wo kein Slot gefüllt werden kann. Sie wird nur mit graphNode und release gesendet, weil eine Verbindung nur auf einem kompilierten Graphen existiert; mit node oder labels gesendet, wird sie abgelehnt. Die Kandidaten daneben behalten ihre Bedeutung, die Features, die an den Knoten selbst angebunden werden können. Ihr Dokument wird akzeptiert und ändert diese Antwort nicht: Die Slots sind die des Sockets und die Kandidaten die der Features, dieselben, in welchem Dokument auch immer eine Anbindung geschrieben wird. |
Zusätzliche Eigenschaften sind nicht zulässig.
ConnectionCandidatesParams
Antwortet, mit welchen Entitäten ein Socket einer Entität verbunden werden kann.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
node | string | nein | Die Entität, nach deren Sockets gefragt wird. |
socket | string | nein | Der eine Socket, für den geantwortet werden soll. Fehlt er, wird für jeden Socket geantwortet, den die Entität deklariert. |
Zusätzliche Eigenschaften sind nicht zulässig.
InsertionPointParams
Antwortet, wo in einem Dokument ein neuer Eintrag unter einem benannten Container hingehört, und überlässt das Zusammensetzen und Anwenden des Eintrags dem Aufrufer, dem der Puffer gehört.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
file | string | nein | Das Dokument, zu dem geantwortet werden soll. |
container | string[] | nein | Der Pfad durch das Dokument zu dem Container, unter den der Eintrag gehört. |
Zusätzliche Eigenschaften sind nicht zulässig.
AttachmentContainerParams
Antwortet, in welches Dokument und an welche Stelle darin eine Anbindung an einem Graphknoten oder an einer Verbindung, die seine Komponente zieht, gehört.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
graphNode | string | nein | Der Graphknoten, für den die Anbindung bestimmt ist. |
release | string | nein | Das Release, zu dessen Graph der Knoten gehört, als Pfad relativ zur Workspace-Wurzel. |
connection | ConnectionCoordinate | nein | Eine Verbindung, die die Komponente des Graphknotens zieht, wenn die Anbindung für diese Verbindung statt für den Knoten bestimmt ist: Die Antwort nennt dann den eigenen features-Container der Verbindung in dem Dokument, das ihr document-Feld nennt, ein hier erforderliches Feld. Im Aggregate ist das der Eintrag der Verbindung in dem Dokument, in dem der Knoten verfasst wurde, abgelehnt für eine Verbindung, die das Release gezogen hat und für die das Aggregate keinen Eintrag enthält. Im Release ist es der Eintrag pro Kante unter dem eigenen Eintrag des Release für den Knoten, ob das Release für diese Verbindung bereits einen schreibt oder nicht, abgelehnt, wo das Release keinen Eintrag für den Knoten schreibt. Eine Verbindung, die ein Feature gezogen hat, wird in beiden Dokumenten abgelehnt, weil eine Anbindung nur an einer Verbindung geschrieben wird, die eine Komponente oder das Release zieht. |
Zusätzliche Eigenschaften sind nicht zulässig.
ConnectionAtPositionParams
Antwortet, in den Eintrag welcher Verbindung eine Position in einem Aggregate oder einem Release fällt: den Graphknoten und die Verbindung, in den Begriffen, in denen die Kandidaten- und Container-Anfragen sie entgegennehmen, oder warum dort keine Verbindung geschrieben ist. Die Einträge sind jene, in denen eine Anbindung geschrieben wird — der Eintrag, mit dem eine Komponente eine Verbindung zieht, unter dem Alias der Verbindung, in dem Dokument, in dem die Komponente verfasst wurde, und jeder Eintrag pro Kante, den das Release schreibt —, jeweils dort, wo der kompilierte Graph ihn verzeichnet, sodass nie daraus, wie ein Schlüssel heißt, abgelesen wird, ob er eine Verbindung ist.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
file | string | nein | Das Dokument, in dem sich die Position befindet: das Release oder ein Dokument, in dem der Graph des Release Komponenten als verfasst verzeichnet — sein Aggregate oder das Dokument eines Moduls, das dieses Aggregate importiert. Es wird zuerst aus dem gelesen, was die Sitzung dafür vorhält, und andernfalls von der Festplatte. |
position | Position | nein | Eine Stelle in einem Dokument: eine Zeile und ein Zeichenoffset darin, beide ab null gezählt. Der Offset wird in den Einheiten der Kodierung gemessen, auf die sich die Sitzung beim Öffnen geeinigt hat; das ist UTF-16, sofern der Client nicht eine andere angefordert hat. |
release | string | nein | Das Release, dessen kompilierter Graph die Verbindungen verzeichnet, als Pfad relativ zur Workspace-Wurzel. Es ist auch für eine Position im Aggregate erforderlich, weil ein Graphknoten und eine Verbindung nur auf einem kompilierten Graphen existieren. |
Zusätzliche Eigenschaften sind nicht zulässig.
ConnectionCoordinate
Eine Verbindung, die die Komponente eines Graphknotens zieht, adressiert über den Socket, über den sie verbunden ist, und den Alias, den sie in diesem Socket trägt, sowie das Dokument, in dem eine Anbindung an ihr geschrieben wird. Eine Verbindung trägt Anbindungen, die die Slots füllen, die ihr Socket deklariert, und sowohl das Aggregate als auch das Release kann sie schreiben.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
socket | string | ja | Der Abhängigkeits-Socket, über den die Verbindung verbunden ist. |
alias | string | ja | Der Name, den die Verbindung innerhalb ihres Sockets trägt. |
document | const “aggregate” oder const “release” | nein | Das Dokument, in dem eine Anbindung an der Verbindung geschrieben wird. Die Menge ist geschlossen, und ein Wert außerhalb davon wird abgelehnt. Zulässige Werte: "aggregate" — Das Aggregate, in dem der Entwickler eine Anbindung am Eintrag der Verbindung schreibt. "release" — Das Release, in dem der Operator eine Anbindung am Eintrag pro Kante für die Verbindung schreibt. |
Zusätzliche Eigenschaften sind zulässig.
SetActiveReleaseParams
Verzeichnet ein Release als Standard des Workspace, indem eine Markierung im Verzeichnis .aggrega geschrieben wird: Die Wahl, die aggrega/activeRelease meldet, liest diese Markierung nach dem Authoring-Release der Konfiguration. Die Markierung wird innerhalb des Workspace geschrieben und nirgendwo sonst: Wo das Verzeichnis .aggrega oder die Markierung ein Link ist, der aus dem Workspace hinausführt, ob der Ort, zu dem er führt, bereits existiert oder nicht, wird der Schreibvorgang abgelehnt, wobei der Link genannt wird, und nichts wird geschrieben. Die Antwort ist diejenige, die aggrega/activeRelease gibt, sobald die Markierung geschrieben ist, daher nennt sie ein anderes Release, wo das Authoring-Release der Konfiguration Vorrang vor der Markierung hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
release | string | nein | Das zu verzeichnende Release, als Pfad relativ zur Workspace-Wurzel. Ein absoluter Pfad und einer, der aus dem Workspace hinaufsteigt, werden abgelehnt; ebenso einer, der über einen Link aus ihm hinausführt, es sei denn, die Workspace-Konfiguration nennt dieses Release. |
Zusätzliche Eigenschaften sind nicht zulässig.
EditDocumentParams
Wendet eine einzelne begrenzte Bearbeitung auf ein Dokument an, das der Workspace enthält: einen unter einem Container hinzugefügten Eintrag oder einen gesetzten Skalar. Das zusammengesetzte Dokument wird gegen das Schema seiner Art geprüft und erreicht die Festplatte nur, wenn das gelingt, daher kann dies nichts schreiben, was das Authoring-Schema ablehnt. Eine abgelehnte Bearbeitung lässt die Datei Byte für Byte so, wie sie war.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
file | string | nein | Das zu bearbeitende Dokument. |
edit | const “add-component” oder const “attach-feature” oder const “wire-edge” oder const “set-value” | nein | Welche Bearbeitung angewendet werden soll. Zulässige Werte: "add-component" — Fügt eine Komponenteninstanz unter einem components-Container hinzu: name ist der Instanzname, value die Component, die sie anfordert. "attach-feature" — Bindet ein Feature an den Knoten an, den die Anfrage nennt: name ist der Instanzname der Anbindung, value das Feature, das sie anfordert. "wire-edge" — Verdrahtet eine Abhängigkeitsverbindung vom Knoten aus, den die Anfrage nennt, innerhalb von socket: name ist der Alias, über den die Verbindung adressiert wird, value der Knoten, auf den sie zeigt. "set-value" — Setzt einen Wert auf dem Knoten, den die Anfrage nennt: name ist der Schlüssel des Werts, value ein Skalar. |
node | string[] | nein | Der Pfad durch das Dokument zu dem Eintrag, der bearbeitet wird. |
socket | string | nein | Der Socket, um den es bei der Bearbeitung geht, für eine Bearbeitung, die einen verbindet. |
name | string | nein | Der Name, den die Bearbeitung schreibt. |
value | any | nein | Der Wert, den die Bearbeitung schreibt, in welcher Form auch immer die Bearbeitung ihn annimmt. |
dryRun | boolesch | nein | Ob mit dem zusammengesetzten Dokument geantwortet werden soll, statt es zu schreiben. |
Zusätzliche Eigenschaften sind nicht zulässig.
ConfigInitParams
Legt ein Konfigurationsdokument initial an. Standardmäßig schreibt es die maschinenweite Datei, da eine Registry und die darauf vertrauenswürdigen Identitäten maschinenweites Werkzeug sind. Es kontaktiert die genannte Registry, um die Vertrauensrichtlinie zu lesen, die sie bekannt gibt; eine Registry, die nichts bekannt gibt, wird als solche gemeldet, und das Anlegen wird fortgesetzt, auf der eingebauten Grundlinie für den offiziellen Hub und ohne Richtlinie für jede andere Registry.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
registry | string | nein | Die Registry, für die die Konfiguration angelegt werden soll. |
force | boolesch | nein | Ob ein bereits vorhandenes Konfigurationsdokument überschrieben werden soll. |
global | boolesch | nein | Schreibt die maschinenweite Konfigurationsdatei, was der eigene Standardwert dieser Methode ist. |
workspace | boolesch | nein | Schreibt die eigene Konfigurationsdatei dieses Workspace statt der maschinenweiten. |
dryRun | boolesch | nein | Ob mit dem Inhalt des Dokuments geantwortet werden soll, statt es zu schreiben, für einen Client, der sein eigenes Dokumentmodell pflegt. |
Zusätzliche Eigenschaften sind nicht zulässig.
ConfigCaptureParams
Friert die aufgelöste Konfiguration in das eigene Dokument dieses Workspace ein, sodass der Workspace in sich geschlossen ist. Es schreibt immer die Datei dieses Workspace und greift auf nichts außerhalb davon zu.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
allPlugins | boolesch | nein | Ob jedes angebundene Plugin eingefroren werden soll statt nur derjenigen, die der Workspace selbst konfiguriert hat. |
Zusätzliche Eigenschaften sind nicht zulässig.
ImportParams
Wandelt eine fremde Quellbeschreibung in Authoring-Dokumente im Entwurf um und schreibt daneben .aggrega-import.json, den Datensatz dessen, was der Import geschrieben hat — das Ziel, das ihm gegeben wurde, sofern ihm eines gegeben wurde, den Katalog-Snapshot, den er gelesen hat, sofern er einen gelesen hat, jede entworfene Datei und jeden Schlüssel eines entworfenen Aggregate oder Release in jeder Tiefe —, den eine spätere Synchronisierung liest. Eine Quelle, die er nicht vollständig umwandeln konnte, ist eine Antwort und kein Fehlschlag: Die Entwürfe, die er erzeugt hat, werden geschrieben, und die Befunde sagen, was er nicht umwandeln konnte — außer unter sync, das aus einer abgebrochenen Umwandlung nichts schreibt.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
source | string | nein | Die Datei oder das Verzeichnis, die umgewandelt werden sollen, als absoluter Pfad oder als Pfad relativ zur Workspace-Wurzel; eine Anfrage ohne diese Angabe wird abgelehnt. Datei oder Verzeichnis werden dort gelesen, wo sie liegen, innerhalb des Workspace oder nicht, und ein Verzeichnis wird in diejenigen seiner Dateien eingelesen, die die deklarierten Dateimuster des Importers auswählen. |
outputDir | string | nein | Das Verzeichnis unter dem Workspace, in das die Entwürfe geschrieben werden sollen, relativ zur Workspace-Wurzel; ein absoluter Wert oder einer, der wie geschrieben oder über einen Link aus dem Workspace hinausführt, wird abgelehnt. Fehlt es, wird unter die Workspace-Wurzel geschrieben, dorthin, wohin dieselbe Umwandlung schreibt, wenn sie an einem Terminal ohne Angabe eines Ziels ausgeführt wird. Jeder entworfene Pfad ist relativ zu dem Verzeichnis, das die Antwort als outputDir nennt, auch unter dryRun. |
format | string | nein | Das Quellformat. Fehlt es, bestimmt die Umwandlung es selbst. |
target | string | nein | Eine Provider-Fähigkeit wie compose oder helm — das Wort, an das sich spec.capability eines Recipe bindet —, für die neben den Entwürfen ein Manifest entworfen werden soll, als manifest.yaml: Jeder Komponententyp und jeder Funktionstyp, den die Entwürfe benötigen, einschließlich der Typen eines Katalog-Aggregate, das das entworfene zusammensetzt, wird auf das Recipe oder Funktionsrezept dieser Fähigkeit abgebildet, das der Katalog des Workspace dafür anbietet — das eine, das es gibt, oder unter mehreren dasjenige, das nach dem Typ benannt ist —; ein Typ ohne ein solches oder mit mehreren und keinem so benannten bleibt unabgebildet, mit einem Warnbefund, der ihn nennt; eine Abbildung, die ein Importer selbst entworfen hat, wird beibehalten, wo der Katalog sie für diesen Typ und diese Fähigkeit anbietet, und andernfalls mit einem Warnbefund verworfen; und spec.manifest des entworfenen Release wird auf das Manifest gesetzt. Eine Fähigkeit, an die sich kein Recipe im Katalog bindet, wird abgelehnt, bevor die Umwandlung läuft, und nichts wird geschrieben. Fehlt es, wird kein Manifest entworfen, außer unter sync, das für das Ziel entwirft, das der Datensatz des früheren Imports nennt; eine Synchronisierung, die ein Ziel nennt, entwirft dafür, und der Datensatz nennt es dann. |
dryRun | boolesch | nein | Ob mit dem Inhalt jeder Datei geantwortet werden soll, die die Anfrage schreiben würde, statt sie zu schreiben. Jedes andere Verhalten ist das des Schreibens, daher wird eine Anfrage, die das Schreiben ablehnen würde, auch hierbei abgelehnt; mit sync wird mit dem geantwortet, was die Synchronisierung schreiben würde, und mit jedem Teil, der abweichen würde. |
sync | boolesch | nein | Ob das, was ein früherer Import unter outputDir entworfen hat, auf den Stand der Quelle gebracht werden soll, statt den Entwurf vollständig zu schreiben. Nur was der Import geschrieben hat, ändert sich, so wie der Datensatz neben den Entwürfen es aufführt: Ein Teil, den die Quelle unverändert gelassen hat, bleibt, wie er auf der Festplatte ist, bearbeitet oder nicht; ein Teil, den die Quelle geändert, verworfen oder hinzugewonnen hat, wird neu geschrieben, entfernt — eine entworfene Datei wird vollständig gelöscht — oder hinzugefügt, wo das, was auf der Festplatte liegt, das ist, was der Import zuletzt geschrieben hat; und alles andere, ein Schlüssel, den ein Autor hinzugefügt hat — darunter die Umgebung, die ein entworfenes Release seinem Autor überlässt —, oder ein Kommentar, der nicht direkt über einem entworfenen Schlüssel steht, bleibt Byte für Byte erhalten. Eine Synchronisierung, die ändern oder entfernen würde, was ein Autor bearbeitet oder hinzugefügt hat, oder einen Teil hinzufügen würde, wo ein Autor bereits einen geschrieben hat, wird unter Nennung jedes Teils abgelehnt, ebenso eine Synchronisierung über ein Aggregate, das kein Datensatz aufführt; in beiden Fällen wird nichts geschrieben. Ohne dieses Feld wird eine Anfrage, deren Entwürfe über ein bereits in outputDir vorhandenes Aggregate geschrieben würden, abgelehnt, auch unter dryRun. |
upgrade | boolesch | nein | Ob der neueste Katalog-Snapshot, den die Standard-Registry des Workspace veröffentlicht, abgerufen und gegen ihn importiert werden soll, wobei er von da an anstelle desjenigen gehalten wird, den der Workspace hält, oder desjenigen, den der Datensatz neben den Entwürfen nennt; wo der Workspace einen Katalogordner nennt, ändert dies nichts, und offline wird es abgelehnt. |
answers | string | nein | Die Antwortdatei, aus der die Werte gelesen und in die sie geschrieben werden, die die Entwürfe leer lassen und die keine Quelle enthalten kann, relativ zum Workspace-Stammverzeichnis; ein absoluter Wert oder einer, der wie geschrieben oder über einen Link aus dem Workspace hinausführt, wird abgelehnt. Sie enthält unter dem Pfad jeder entworfenen Datei den Schlüsselpfad innerhalb dieses Dokuments und seine Antwort, und die Antworten werden in die Entwürfe geschrieben. Fehlt sie, wird die Datei gelesen, die der Datensatz neben den Entwürfen nennt, oder andernfalls import-answers.yaml neben der Quelldatei oder im Quellverzeichnis. Die Antwort für ein Secret nennt, woher das Secret stammt — einen Variablennamen, ${NAME} oder den Namen eines Kubernetes Secret —, und alles andere wird abgelehnt, ohne dass etwas geschrieben wird. Es wird nichts abgefragt: Jeder noch ausstehende Wert ist ein Eintrag in owed der Antwort und ein Warnbefund, der die entworfene Datei, den Schlüssel und das, was er ist, nennt, seine Antwort wird als answered gesendet, und wo die Entwürfe geschrieben werden, sagt der letzte Befund, wie viele ausstehen und wo. Wo die Entwürfe ein Release enthalten, nichts mehr aussteht und die Umwandlung abgeschlossen ist, werden anschließend seine Abhängigkeiten gepullt, wobei seine Lockdatei geschrieben wird, und ein fehlgeschlagener Pull schließt die Befunde mit dem Grund ab, wobei die Entwürfe geschrieben sind; offline wird nichts gepullt, und ein Befund nennt den auszuführenden Pull. Eine Antwort für einen Schlüssel, den diese Entwürfe nicht leer lassen, bleibt in der Datei erhalten und wird nicht angewendet, sodass eine einzige Antwortdatei jedem Target dient. |
answered | ImportAnswered[] | nein | Antworten für Werte, die owed der Antwort aufgeführt hat, die jeweils die entworfene Datei und die Schlüssel so nennen, wie owed sie genannt hat. Jede wird geprüft, in der Antwortdatei aufbewahrt und genau so in die Entwürfe geschrieben wie eine an einem Terminal eingegebene Antwort: Die Antwort für ein Secret nennt, woher das Secret stammt — einen Variablennamen, ${NAME} oder den Namen eines Kubernetes Secret —, und eine, die das nicht tut, wird weder aufbewahrt noch geschrieben, und ihr Wert bleibt ausstehend, mit dem Grund als seinem secretAdvice. Ein Wert, den die Antwortdatei bereits beantwortet, wird aus der Datei beantwortet; eine leere Antwort oder eine, die einen Wert nennt, den die Entwürfe nicht schulden, wird nicht angewendet. Senden Sie sie mit sync, sobald die Entwürfe geschrieben sind, da eine Anfrage, die kein sync ist, über einem bereits in outputDir vorhandenen Aggregate abgelehnt wird. Unter dryRun, das keine Antwort aufbewahrt, und unter einem sync, dessen Umwandlung abgebrochen wurde und das nichts schreibt, wird keine gesendete Antwort angewendet. |
Zusätzliche Eigenschaften sind nicht zulässig.
ScaffoldEntityParams
Entwirft ein Startdokument für eine Entitätsart, schreibt eines der ausführbaren Beispiele der Dokumentation in ein neues Verzeichnis des Workspace oder listet sie auf. Das Entwerfen leitet das Gerüst aus dem Schemasatz ab, den das Binary mitführt, daher wird nichts aus einem Workspace gelesen und nichts geschrieben — die Antwort ist Text, und wohin er geht, ist Sache des Clients. Das Schreiben eines Beispiels schreibt das neue Verzeichnis und sonst nichts, und die Beispiele werden aus dem signierten Dokumentations-Bundle gelesen, das für die Version des Binary veröffentlicht wurde, oder aus dem neuesten zuvor veröffentlichten, wo es keines gibt, verifiziert gegen die Signaturrichtlinie des Workspace, bevor es behalten oder gelesen wird: Ein Bundle, das sich nicht verifizieren lässt, wird abgelehnt, und offline wird nur eine bereits zwischengespeicherte Kopie gelesen. Eine Anfrage, die die Felder zweier Formen zusammen sendet — kind mit example oder list, list mit example, name mit example oder list, dir ohne example —, wird abgelehnt, bevor irgendetwas gelesen wird.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | string | nein | Der absolute Pfad des Workspace. Das Entwerfen liest ihn nicht. Das Schreiben oder Auflisten eines Beispiels erfordert ihn: Die Konfiguration des Workspace entscheidet, woher die Dokumentation abgerufen wird und welche Signaturen sie tragen muss, und ein Beispiel wird darin geschrieben. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
kind | string | nein | Die zu entwerfende Entitätsart, benannt durch ihr kleingeschriebenes Token, etwa component, aggregate, release, recipe oder featurerecipe — das Token, das aggrega/getSchema für sie auflistet. |
name | string | nein | Der Name, der in das entworfene Dokument geschrieben werden soll. Nur mit kind gesendet. |
example | string | nein | Das zu schreibende ausführbare Beispiel, unter dem Namen, den die Liste der Beispiele ihm gibt. Anstelle von kind gesendet. |
list | boolesch | nein | Ob mit jedem ausführbaren Beispiel geantwortet werden soll, das die Dokumentation veröffentlicht, ohne etwas zu schreiben. Ohne example und ohne kind gesendet. |
dir | string | nein | Das neue Verzeichnis, in das das Beispiel geschrieben werden soll, relativ zur Workspace-Wurzel; fehlt es, wird das Beispiel dort in ein nach ihm benanntes Verzeichnis geschrieben. Es darf noch nicht existieren oder muss leer sein: Eines, das irgendetwas enthält, wird abgelehnt und bleibt, wie es ist, und ein absoluter Wert oder einer, der wie geschrieben oder über einen Link aus dem Workspace hinausführt, wird abgelehnt, bevor irgendetwas gelesen wird. Nur mit example gesendet. |
Zusätzliche Eigenschaften sind nicht zulässig.
LintParams
Prüft die Veröffentlichungskonventionen des Katalogs für eine einzelne Entität, für alles, was der Abschluss eines Release erreicht, oder für alles unter den konfigurierten Katalogverzeichnissen. In keinem Modus wird etwas geschrieben. Wird weder eine Entität noch ein Release genannt, wird der gesamte Katalog geprüft: in einem Workspace, dessen Konfiguration keinem Release eigene Katalogverzeichnisse gibt, einmal über die Verzeichnisse des Workspace; in einem Workspace, der Releases unter workspace.releases nennt, einmal für jedes Release über die Verzeichnisse, die dieses Release liest, nie über alle zusammen.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
entity | string | nein | Das eine zu prüfende Entitätsdokument. |
release | string | nein | Das Release, dessen Abschluss geprüft werden soll, als Pfad relativ zur Workspace-Wurzel. |
prePublish | boolesch | nein | Ob jede Entität mit ihrer zuvor veröffentlichten Version verglichen werden soll, was die konfigurierten Registries erreicht. |
Zusätzliche Eigenschaften sind nicht zulässig.
PluginAddParams
Bindet ein Plugin an einen Socket an, den der Workspace konfiguriert. Es erreicht eine Registry, um die Abfrage zu einem einzigen Plugin aufzulösen und eine Version zu pinnen. Die eine Entscheidung, die ein Terminal einholen würde — die deklarierten Fähigkeiten eines Befehlserweiterungs-Plugins zu akzeptieren —, kommt hier als Feld an, sodass der Client denjenigen fragt, der ihn steuert, und diese Oberfläche nie auf eine Eingabeaufforderung wartet.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
type | string | nein | Der Socket, an den das Plugin angebunden wird. |
query | string | nein | Was zu einem einzigen Plugin aufgelöst werden soll. |
capability | string | nein | Die Fähigkeit, für die die Anbindung bestimmt ist, wo der Socket mehrere trägt. |
role | string | nein | Die Rolle, in der die Anbindung läuft, was festlegt, was sie ausgeben darf. |
global | boolesch | nein | Schreibt die maschinenweite Konfigurationsdatei. |
workspace | boolesch | nein | Schreibt die eigene Konfigurationsdatei dieses Workspace. |
acceptCapabilities | boolesch | nein | Ob der Aufrufer die Fähigkeiten akzeptiert, die ein Befehlserweiterungs-Plugin deklariert. |
dryRun | boolesch | nein | Ob mit dem Inhalt des Konfigurationsdokuments geantwortet werden soll, statt es zu schreiben. |
Zusätzliche Eigenschaften sind nicht zulässig.
PluginRemoveParams
Löst ein Plugin von einem Socket, den der Workspace konfiguriert.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
type | string | nein | Der Socket, an den das Plugin angebunden ist. |
query | string | nein | Welche Anbindung entfernt werden soll. |
global | boolesch | nein | Schreibt die maschinenweite Konfigurationsdatei. |
workspace | boolesch | nein | Schreibt die eigene Konfigurationsdatei dieses Workspace. |
Zusätzliche Eigenschaften sind nicht zulässig.
PluginSyncParams
Gleicht die maschinenverwalteten Datensätze einer Plugin-Entität mit dem Modul ab, auf das sie zeigt. Es schreibt diese Datensätze neu und übernimmt jedes andere Byte des Dokuments unverändert.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
entity | string | nein | Das abzugleichende Dokument der Plugin-Entität. |
plugin | string | nein | Das Plugin-Modul, aus dem die Datensätze gelesen werden sollen. |
Zusätzliche Eigenschaften sind nicht zulässig.
PluginGenCatalogParams
Erzeugt Plugin-Katalogdokumente aus den eigenen deklarierten Metadaten eines Plugins plus einem verfassten Overlay. Ein erneutes Erzeugen über unveränderte Eingaben ergibt Byte für Byte identische Dokumente.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
fromEmbedded | boolesch | nein | Ob die Metadaten aus den Plugins gelesen werden sollen, die das Binary bereits mitführt. |
plugin | string | nein | Das Plugin-Modul, aus dem die Metadaten gelesen werden sollen. |
outputDir | string | nein | Das Verzeichnis unter dem Workspace, in das die Dokumente geschrieben werden sollen. |
overlay | string | nein | Das verfasste Dokument, dessen Inhalt über die erzeugten Metadaten gelegt wird. |
dryRun | boolesch | nein | Ob mit dem Inhalt der Dokumente geantwortet werden soll, statt sie zu schreiben. |
Zusätzliche Eigenschaften sind nicht zulässig.
ExplainErrorParams
Schlüsselt einen Code, den ein Befund trug, auf in das, was der Compiler über diese Bedingung deklariert, und in die veröffentlichten Einträge, die die Authoring-Korrektur lehren. Es beschafft die veröffentlichte Dokumentation, wenn der Workspace keine Kopie hat; kann es sie nicht beschaffen, antwortet es dennoch mit dem, was das Binary deklariert, und sagt, warum der erläuternde Text fehlt.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
code | string | nein | Die aufzuschlüsselnde Bedingung, benannt entweder durch den Code, den ein Befund trug, oder durch ihren Kurzcode. |
Zusätzliche Eigenschaften sind nicht zulässig.
GetSchemaParams
Antwortet mit dem Schema einer Art oder — wenn keine Art genannt wird — damit, welche Arten genannt werden können. Es antwortet für das laufende Binary statt für irgendeine anderswo installierte Kopie, daher braucht es keinen Workspace und liest keinen.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootAccepted | nein | Der absolute Pfad eines Workspace. Der Gegenstand dieser Methode ist kein Workspace — sie antwortet aus dem, was das Binary selbst mitführt —, daher wird das Feld akzeptiert und nicht gelesen. Es ist zugelassen, damit ein Client es einheitlich bei jeder Anfrage senden kann, ohne wissen zu müssen, welche Methoden es heranziehen. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
kind | string | nein | Die Art, mit deren Schema geantwortet werden soll. Fehlt sie, wird stattdessen mit den Arten geantwortet, die genannt werden können. |
Zusätzliche Eigenschaften sind nicht zulässig.
SkillsInstallParams
Schreibt den im Binary eingebauten Assistenten-Skill in den Skill-Ordner jedes Assistenten, den die Anfrage nennt, oder, bei einer globalen Anfrage, die keinen nennt, jedes auf dieser Maschine gefundenen Assistenten. Ohne global schreibt es den Projektordner jedes Assistenten innerhalb des Workspace, den die Anfrage nennt, und jeder Pfad, den es dort schreiben würde, bleibt auf diesen Workspace beschränkt; mit global schreibt es den benutzerbezogenen Ordner jedes Assistenten unter dem Home-Verzeichnis. Jedes Ziel wird geprüft, bevor etwas geschrieben wird, sodass eine Ablehnung jeden Ordner so lässt, wie er war.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | ja | Der absolute Pfad des Workspace, auf den diese Anfrage wirkt. Er ist der Gegenstand der Anfrage: Der Daemon löst ihn auf, bevor die Methode läuft, und eine Anfrage, die ihn weglässt oder als etwas anderes als einen String schreibt, wird abgelehnt. |
workDoneToken | ProgressToken | nein | Ein Wert, den der Aufrufer erzeugt, damit er Fortschrittsbenachrichtigungen dem Aufruf zuordnen kann, der sie angefordert hat. Er wird in jeder Benachrichtigung unverändert zurückgegeben, sodass ein Aufrufer ihn mit dem gesendeten Wert vergleichen kann. Er wird bei jeder Anfrage akzeptiert, und eine Anfrage, die einen in einer Sitzung sendet, die keine Fortschrittsfähigkeit deklariert hat, wird abgelehnt. |
agents | string[] | nein | Die Assistenten, für die der Skill installiert werden soll, nach den Bezeichnern, die die Auflistung meldet. Eine Projektanfrage, die keinen nennt, wird abgelehnt. Eine globale Anfrage, die keinen nennt, installiert den Skill für die auf dieser Maschine gefundenen Assistenten, jeden, dessen Konfigurationsordner im Home-Verzeichnis liegt oder dessen Befehl im PATH liegt, und wird abgelehnt, ohne dass etwas geschrieben wird, wo keiner gefunden wird. Ein Bezeichner, für den kein Skill-Ordner bekannt ist, wird unter Nennung des Namens abgelehnt, und ein zweimal angegebener Bezeichner wird einmal installiert. |
global | boolesch | nein | Schreibt den benutzerbezogenen Skill-Ordner jedes Assistenten unter dem Home-Verzeichnis, den er in jedem Projekt liest, statt seines Projektordners im Workspace. |
Zusätzliche Eigenschaften sind nicht zulässig.
ServerCapabilities
Was der Daemon in dieser Sitzung tun wird, abgestimmt auf das, was der Client nach eigener Aussage verarbeiten kann.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
positionEncoding | string | ja | Die Kodierung, in der jede Position in dieser Sitzung ausgedrückt wird. |
workDoneProgress | boolesch | nein | Ob der Daemon in dieser Sitzung Fortschrittsbenachrichtigungen senden wird. Nur vorhanden, wo der Client deklariert hat, dass er sie empfangen kann. |
Zusätzliche Eigenschaften sind nicht zulässig.
ClosureEntity
Eine Entität, von der ein Release abhängt, in der Version, auf die sich die Auflösung festgelegt hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
uri | string | ja | Die Referenz, aus der sich die Entität auflöst. |
version | string | ja | Die Version, auf die man sich festgelegt hat. |
kind | string | nein | Die Entitätsart. |
source | string | nein | Woher der Lauf, der diesen Eintrag erzeugt hat, die Entität genommen hat, mit demselben Wort, das aggrega pull --detail dafür ausgibt: fetched-fresh (während dieses Laufs aus einer Registry abgerufen), cache-reuse (eine bereits im Cache liegende Kopie, ohne Abruf wiederverwendet), local (im lokalen Dateisystem gefunden, etwa in einem Katalogverzeichnis), in-binary (die Kopie im Compiler-Binary) oder external (das eigene Aggregate oder Manifest des Release, aus der Datei oder dem Eintrag gelesen, den das Release nennt, statt als eine seiner Abhängigkeiten aufgelöst; ein Aggregate, das der Lauf aus einer Registry abgerufen hat, ist stattdessen fetched-fresh). Vorhanden bei den Einträgen des Berichts einer Abhängigkeitsauflösung, wo es beschreibt, was dieser Lauf auf dieser Maschine getan hat, und fehlend in einer Auflistung der aufgelösten Abhängigkeiten eines Release, die beschreibt, wovon das Release abhängt. Das Lockfile verzeichnet keine Quelle. Weggelassen für eine Entität, deren Quelle der Lauf nicht verzeichnet hat. |
Zusätzliche Eigenschaften sind nicht zulässig.
ToolchainCorePlugin
Ein Plugin, das der Compiler selbst mitführt, und die Version davon, die verwendet wurde.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
plugin | string | ja | Die Referenz des Plugins. |
version | string | ja | Die Version, die verwendet wurde. |
Zusätzliche Eigenschaften sind nicht zulässig.
ToolchainReport
Der Compiler, der aufgelöst hat, und die Plugins, die er mitführt.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
compilerVersion | string | ja | Die Version des Compilers, der aufgelöst hat. |
corePlugins | ToolchainCorePlugin[] | nein | Die Plugins, die der Compiler mitführt, mit der jeweils verwendeten Version. |
Zusätzliche Eigenschaften sind nicht zulässig.
DependencyResolutionReport
Was eine Abhängigkeitsauflösung gepinnt und beschafft hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
lockfile | string | ja | Das Lockfile, das die Auflösung geschrieben hat, oder dasjenige, mit dem eine Verifizierung verglichen hat. |
verified | boolesch | nein | Ob die Anfrage eine Verifizierung war, die das verzeichnete Lockfile verglichen und kein Lockfile, keinen Plugin-Vertrauensdatensatz und kein entity.lock geschrieben hat. |
entities | ClosureEntity[] oder null | ja | Die Entitäten, die die Auflösung gepinnt oder eine Verifizierung verglichen hat. |
libraries | ClosureEntity[] oder null | ja | Die Bibliotheken, die die Auflösung gepinnt oder eine Verifizierung verglichen hat. |
plugins | ClosureEntity[] oder null | ja | Die Plugins, die die Auflösung gepinnt oder eine Verifizierung verglichen hat. |
sourceArtifacts | integer | ja | Wie viele Quellartefakte beschafft wurden. |
trustedPlugins | integer | ja | Wie viele der gepinnten Plugins eine verifizierte Signatur trugen. |
toolchain | ToolchainReport | nein | Der Compiler, der aufgelöst hat, und die Plugins, die er mitführt. |
externalInputs | integer | ja | Wie viele externe Eingaben, die das Rendering verbraucht, beschafft wurden. |
incompleteExternalInputs | string | nein | Welche externen Eingaben nicht beschafft werden konnten, sofern einige nicht beschafft werden konnten. |
Zusätzliche Eigenschaften sind nicht zulässig.
BuildNotice
Etwas, das der Build dem Aufrufer mitteilen möchte und das weder ein Befund über ein Dokument noch ein Fehlschlag ist.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
class | string | ja | Welche Art von Hinweis dies ist. |
text | string | ja | Was der Hinweis besagt. |
Zusätzliche Eigenschaften sind nicht zulässig.
CacheScope
Wie weit eine Cache-Antwort reicht. Zwei der Cache-Klassen werden von jedem Projekt auf der Maschine gemeinsam genutzt, daher nennt jede Cache-Antwort, welche davon sie berührt hat — eine über einem Workspace geöffnete Sitzung würde sonst so gelesen, als melde sie nur über diesen Workspace.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
machineWideClasses | string[] oder null | ja | Die von dieser Antwort berührten Cache-Klassen, die von allen Projekten auf der Maschine gemeinsam genutzt werden. |
workspaceRoot | string | ja | Der Workspace, den die Anfrage genannt hat. |
Zusätzliche Eigenschaften sind nicht zulässig.
CacheElement
Etwas, das ein Cache enthält.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
label | string | ja | Wovon der Eintrag ist. |
size | integer | ja | Wie viele Bytes er belegt. |
sizeText | string | ja | Dieselbe Größe, so geschrieben, wie ein Mensch sie liest. |
digest | string | nein | Der Inhalts-Digest, unter dem der Eintrag geschlüsselt ist, sofern er einen hat. |
note | string | nein | Alles andere, was über den Eintrag zu sagen sich lohnt. |
Zusätzliche Eigenschaften sind nicht zulässig.
CacheClass
Ein Cache, über den der Daemon meldet.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
name | string | ja | Welcher Cache dies ist. |
reach | string | ja | Ob der Cache zu diesem Workspace gehört oder maschinenweit gemeinsam genutzt wird. |
prunable | boolesch | ja | Ob das Freigeben dieses Caches etwas ist, das der Daemon tun wird. |
elements | CacheElement[] oder null | ja | Was der Cache enthält. |
Zusätzliche Eigenschaften sind nicht zulässig.
CacheProvenance
Unter welchen Identitäten ein zwischengespeichertes Artefakt beschafft wurde und wie weit es gemeinsam genutzt wird.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
identities | string[] oder null | ja | Die Identitäten, denen das Artefakt zugeordnet ist. |
sharedBy | integer | nein | Wie viele Inhaber das Artefakt gemeinsam nutzen. |
Zusätzliche Eigenschaften sind nicht zulässig.
CacheRemoval
Etwas, das eine Freigabe entfernt hat — oder, in einer Liste dessen, was sie an Ort und Stelle gelassen hat, etwas, das sie entfernt hätte.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
class | string | ja | Zu welchem Cache es gehört. |
label | string | ja | Was es ist. |
reach | string | ja | Ob dieser Cache zu diesem Workspace gehört oder maschinenweit gemeinsam genutzt wird. |
size | integer | ja | Wie viele Bytes es belegt oder vor seiner Entfernung belegt hat. |
sizeText | string | ja | Dieselbe Größe, so geschrieben, wie ein Mensch sie liest. |
Zusätzliche Eigenschaften sind nicht zulässig.
CacheShortfall
Was eine Freigabe zurückgelassen hat und was es freigeben würde, sodass ein Aufrufer, der eine kleinere Zahl liest als erwartet, den Grund erfährt, statt ihn abzuleiten.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
class | string | ja | Welcher Cache das Zurückgelassene enthält. |
count | integer | ja | Wie viele Einträge zurückgelassen wurden. |
size | integer | ja | Wie viele Bytes sie belegen. |
sizeText | string | ja | Dieselbe Größe, so geschrieben, wie ein Mensch sie liest. |
reach | string | ja | Ob dieser Cache zu diesem Workspace gehört oder maschinenweit gemeinsam genutzt wird. |
reclaimedBy | string[] oder null | ja | Was sie freigeben würde. |
Zusätzliche Eigenschaften sind nicht zulässig.
CacheCleared
Ein Cache, den eine Leerung geleert hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
class | string | ja | Welcher Cache geleert wurde. |
reach | string | ja | Ob er zu diesem Workspace gehört oder maschinenweit gemeinsam genutzt wird. |
size | integer | ja | Wie viele Bytes in ihm freigegeben wurden. |
sizeText | string | ja | Dieselbe Größe, so geschrieben, wie ein Mensch sie liest. |
heldOpenFiles | integer | ja | Wie viele Dateien die Leerung in diesem Cache zurückgelassen hat, weil ein anderer Prozess sie geöffnet hatte. Nur Windows weigert sich, eine geöffnete Datei zu entfernen, daher ist dieser Wert überall sonst null. Eine spätere Leerung entfernt sie, sobald dieser Prozess mit ihnen fertig ist. |
heldOpenBytes | integer | ja | Wie viele Bytes diese Dateien belegen. Sie werden nicht in size mitgezählt, das angibt, was die Leerung freigegeben hat. |
heldOpenBytesText | string | ja | Dieselbe Zahl, so geschrieben, wie ein Mensch sie liest. |
Zusätzliche Eigenschaften sind nicht zulässig.
ConfigWriteScope
Welches Konfigurationsdokument geschrieben wurde und wie weit es reicht. Eine Anfrage nennt einen Workspace, daher würde eine Antwort, die nichts sagt, so gelesen, als beträfe sie diesen Workspace — und für einen maschinenweiten Schreibvorgang ist diese Lesart falsch.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
configFile | string | ja | Das Dokument, das geschrieben wurde. |
machineWide | boolesch | ja | Ob dieses Dokument dasjenige ist, über das jeder Workspace auf der Maschine auflöst. |
workspaceRoot | string | ja | Der Workspace, den die Anfrage genannt hat. |
Zusätzliche Eigenschaften sind nicht zulässig.
PluginWriteScope
In welches Konfigurationsdokument eine Plugin-Änderung geschrieben wurde und wie weit sie reicht. Der eigene Standard des Befehlserweiterungs-Sockets ist das maschinenweite Dokument, daher sagt jede Antwort, welches sie geschrieben hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
configFile | string | ja | Das Dokument, das geschrieben wurde. |
machineWide | boolesch | ja | Ob dieses Dokument dasjenige ist, über das jeder Workspace auf der Maschine auflöst. |
workspaceRoot | string | ja | Der Workspace, den die Anfrage genannt hat. |
Zusätzliche Eigenschaften sind nicht zulässig.
CredentialStoreScope
Wie weit eine Änderung an einer Anmeldeinformation reicht. Der Speicher wird von jedem Projekt auf der Maschine und von jedem anderen Werkzeug, das dieselben Registries anspricht, gemeinsam genutzt, daher meldet die Antwort das, statt eine auf die Sitzung beschränkte Lesart der Schlussfolgerung zu überlassen.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
machineWide | boolesch | ja | Ob der Speicher, den die Änderung betroffen hat, maschinenweit gemeinsam genutzt wird. |
workspaceRoot | string | ja | Der Workspace, den die Anfrage genannt hat. |
Zusätzliche Eigenschaften sind nicht zulässig.
SkillFolderScope
Wie weit eine Skill-Installation reicht. Eine Anfrage nennt einen Workspace, daher würde eine Antwort, die nichts sagt, so gelesen, als beträfe sie diesen Workspace — und für die benutzerbezogenen Ordner, die ein Assistent in jedem Projekt liest, ist diese Lesart falsch.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
machineWide | boolesch | ja | Ob die geschriebenen Ordner die benutzerbezogenen unter dem Home-Verzeichnis sind, die der Assistent in jedem Projekt auf der Maschine liest. |
workspaceRoot | string | ja | Der Workspace, den die Anfrage genannt hat. |
Zusätzliche Eigenschaften sind nicht zulässig.
PublicationReach
Wie weit eine Veröffentlichung gereicht hat. Diese Antworten reichen ganz über diese Maschine hinaus — was sie anhängen, ist das, was jeder Konsument dieser Registry auflöst —, daher nennt jede jede Registry, die sie angesprochen hat, und ob der Aufruf dort etwas angehängt hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
registries | string[] | ja | Jeder Registry-Host, den der Aufruf angesprochen hat, jeder einmal genannt, in der Reihenfolge, in der der Aufruf ihn zuerst angesprochen hat. Ein Aufruf mit einer einzigen Referenz nennt einen; ein Probelauf nennt das Ziel, das er angesprochen hätte. |
beyondThisMachine | boolesch | ja | Ob der Aufruf etwas angehängt hat, das eine Registry nun anderen bereitstellt: hochgeladene Inhalte, eine Signatur, ein Veröffentlichungsdatum oder eine Deprecation-Markierung. Bei einem Probelauf false, ebenso bei einem Aufruf, der alles, was er angehängt hätte, bereits vorfand — eine erneut über eine vollständige Version ausgeführte Veröffentlichung oder ein Signier-Batch, dessen Referenzen alle bereits eine Signatur trugen, die sich verifizieren lässt. |
Zusätzliche Eigenschaften sind nicht zulässig.
WorkspaceEntityRef
Eine Entität, nach Art und Name, mit dem Dokument, das sie deklariert.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
kind | string | ja | Die Entitätsart. |
name | string | ja | Der Entitätsname. |
file | string | ja | Das Dokument, das sie deklariert, als Pfad relativ zur Workspace-Wurzel. |
Zusätzliche Eigenschaften sind nicht zulässig.
SourcedEntityRef
Eine Entität, mit dem Ort, von dem sie gelesen wurde. Ein Workspace-Dokument meldet seinen Workspace-relativen Pfad; eine aus den konfigurierten Katalogverzeichnissen aufgelöste Entität meldet einen leeren Pfad, weil der einzige Pfad, den sie hat, für einen Client nichts bedeuten würde. Die Herkunft sagt, welcher der beiden Fälle vorliegt, statt einen leeren Pfad als Feld lesen zu lassen, das niemand ausgefüllt hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
kind | string | ja | Die Entitätsart. |
name | string | ja | Der Entitätsname. |
file | string | ja | Das Dokument, das sie deklariert, als Pfad relativ zur Workspace-Wurzel, oder leer, wo sie aus den konfigurierten Katalogverzeichnissen stammt. |
origin | string | ja | Woher die Entität gelesen wurde. |
Zusätzliche Eigenschaften sind nicht zulässig.
SocketCandidacy
Ein Socket an einer Entität und das, was damit verbunden werden kann.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
socket | string | ja | Der Name des Sockets. |
declaration | string | ja | Wo der Socket deklariert ist. |
selector | string | ja | Der Label-Selektor, den ein Ziel erfüllen muss. |
required | boolesch | ja | Ob der Socket verbunden sein muss, damit der Build fortfährt. |
targets | WorkspaceEntityRef[] oder null | ja | Die Entitäten, die damit verbunden werden können. |
Zusätzliche Eigenschaften sind nicht zulässig.
SlotCandidacy
Ein Slot, den der Socket einer Verbindung deklariert, so wie die konsumierende Component ihn am Socket deklariert, und die Features, die ihn an dieser Verbindung füllen können.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
slot | string | ja | Der Name des Slots, also der Schlüssel, unter dem eine Anbindung, die ihn füllt, in den features der Verbindung geschrieben wird. |
selector | string | ja | Der Label-Selektor, den ein Feature, das den Slot füllt, mit seinen eigenen Labels erfüllen muss. Leer, wo der Slot keinen deklariert, was jedes Feature zulässt. |
required | boolesch | ja | Ob jede über den Socket verbundene Verbindung den Slot füllen muss, damit der Build fortfährt. |
inject | string[] | ja | Die Zustellmechanismen, die der Slot für das zulässt, was ihn füllt, in der Reihenfolge, in der die Component sie deklariert. Leer, wo sie keinen deklariert. |
sensitive | boolesch | ja | Ob der Slot deklariert, dass das, was ihn füllt, geheimes Material behandelt. Es kennzeichnet die Anbindung, die ihn füllt, und lehnt nichts ab. |
description | string | ja | Wofür der Slot laut der Component da ist. Leer, wo sie nichts sagt. |
candidates | SourcedEntityRef[] | ja | Jedes Feature, das den Slot an dieser Verbindung füllen kann: eines, dessen deklarierte Anwendbarkeit die Labels des Graphknotens erfüllen, woran jede Anbindung gebunden ist, die der Knoten trägt, und dessen eigene Labels den Selektor des Slots erfüllen. Ein Feature, dessen Anwendbarkeit oder dessen Labels sich nicht gegen den Selektor lesen lassen, wird nicht angeboten, weil ein Build es ablehnt, statt es zuzulassen. |
Zusätzliche Eigenschaften sind nicht zulässig.
CatalogEntity
Eine Entität, die der Workspace-Index enthält.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
kind | string | ja | Die Entitätsart. |
name | string | ja | Der Entitätsname. |
apiVersion | string | ja | Die Schemaversion, die das Dokument deklariert. |
description | string | ja | Wofür die Entität laut dem Dokument da ist. |
labels | Map von string oder null | ja | Die Labels, die das Dokument deklariert. |
file | string | ja | Das Dokument, das sie deklariert, als Pfad relativ zur Workspace-Wurzel. |
origin | string | ja | Woher die Entität gelesen wurde. |
Zusätzliche Eigenschaften sind nicht zulässig.
CompletionItem
Etwas, das an der Cursorposition geschrieben werden darf.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
label | string | ja | Der zu schreibende Text. |
kind | integer | nein | Um welche Art von Element es sich handelt, sodass ein Client ein Symbol dafür wählen kann. |
detail | string | nein | Ein kurzer Zusatz, der neben der Beschriftung angezeigt wird. |
documentation | string | nein | Was das Element ist, ausführlich. |
sortText | string | nein | Der Wert, nach dem sortiert wird, sofern er von der Beschriftung abweicht. |
Zusätzliche Eigenschaften sind nicht zulässig.
MarkupContent
Anzuzeigender Text und mit welchem Markup er ausgezeichnet ist.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
kind | string | ja | Mit welchem Markup der Text ausgezeichnet ist. |
value | string | ja | Der Text. |
Zusätzliche Eigenschaften sind nicht zulässig.
EntityKindDescriptor
Eine Art, von der ein Autor ein Dokument schreibt, die das Token, das eine Anfrage nennt, mit der Art paart, die das Dokument selbst deklariert, und angibt, welche Operationen ein Dokument dieser Art akzeptieren.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
kind | string | ja | Das kleingeschriebene Token, das eine Anfrage nennt, etwa component oder featurerecipe. |
documentKind | string | ja | Die Art, die der eigene Kopf des Dokuments deklariert. |
acceptedBy | EntityKindAcceptance | ja | Welche Operationen ein Dokument dieser Art akzeptieren, das für sich allein genannt wird — über seinen Pfad oder, zur Inspektion, über seinen Namen —, ohne dass daneben etwas anderes gesendet wird. Ein Feld ist true, wenn diese Operation ein Dokument nicht deshalb ablehnt, weil es dieser Art ist; ein Dokument, das sie akzeptiert, kann dennoch wegen dessen abgelehnt werden, was das Dokument aussagt. |
Zusätzliche Eigenschaften sind nicht zulässig.
EntityKindAcceptance
Für eine Art, die ein Autor schreibt, ob jede Operation ein Dokument dieser Art akzeptiert, das für sich allein genannt wird. Jedes Feld ist in jedem Eintrag vorhanden, daher ist false eine Aussage und keine Auslassung.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
singleEntityValidation | boolesch | ja | Ob der Einzelentitäts-Bereich von aggrega validate — der Befehl, dem der Pfad eines einzelnen Dokuments übergeben wird — ein Dokument dieser Art prüft. Eine Art, die er ablehnt, wird stattdessen vom Gesamtkatalog-Bereich oder vom Release-Bereich geprüft. |
publication | boolesch | ja | Ob aggrega/publishEntity, wenn nur das Dokument genannt wird, ein Dokument dieser Art veröffentlicht. Eine Art, deren Veröffentlichung zusätzlich eine neben dem Dokument genannte ausführbare Datei bindet — ein Plugin —, ist false, weil eine Anfrage, die nur das Dokument nennt, für sie abgelehnt wird; ein Manifest und ein Release sind false, weil keine der beiden Arten veröffentlicht wird. |
inspectionByName | boolesch | ja | Ob aggrega/entityDefinition einen Namen zu einer Entität dieser Art auflöst, wobei der Name so gesendet wird, wie er dort geschrieben wird, wo eine Entität auf eine andere verweist. |
Zusätzliche Eigenschaften sind nicht zulässig.
RegistryTrust
Die Vertrauensrichtlinie, die die Auflösung auf das anwendet, was eine Registry bereitstellt.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
signaturesRequired | boolesch | ja | Ob ein Artefakt aus dieser Registry eine verifizierte Signatur tragen muss. |
verificationSkipped | boolesch | nein | Ob die Verifizierung übersprungen wird. |
advisory | boolesch | nein | Ob eine fehlgeschlagene Verifizierung gemeldet wird, statt abzubrechen. |
anchor | string | nein | Der Vertrauensanker, gegen den Signaturen verifiziert werden. |
keylessIdentities | integer | nein | Wie vielen Signaturidentitäten für diese Registry vertraut wird. |
Zusätzliche Eigenschaften sind nicht zulässig.
Registry
Eine konfigurierte Registry. Kein Feld hier trägt Anmeldematerial, dessen Länge, dessen Form oder irgendeine Darstellung davon — das Vorhandensein ist alles, was gemeldet wird, und das macht den Wert sicher genug, um ihn in ein Issue einzufügen.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
host | string | ja | Der Registry-Host, der ihre Identität ist. |
name | string | nein | Der sprechende Alias, der auf den Host aufgelöst wird, sofern einer konfiguriert ist. |
default | boolesch | ja | Ob dies die Registry ist, die eine Operation anspricht, die keine Registry nennt. |
authState | string | ja | Ob im maschinenweiten Speicher eine Anmeldeinformation für diesen Host vorhanden ist. Es wird auch gemeldet, wenn es leer ist, sodass ein Aufrufer „keine Anmeldeinformation ist vorhanden“ von „die Auflistung hat nicht nachgesehen“ unterscheiden kann. |
trust | RegistryTrust | ja | Die Vertrauensrichtlinie, die die Auflösung auf das anwendet, was eine Registry bereitstellt. |
Zusätzliche Eigenschaften sind nicht zulässig.
TrustFetchOutcome
Was das Lesen der angekündigten Vertrauensrichtlinie einer Registry bewirkt hat. Die Ergebnisse werden auseinandergehalten, weil sie Verschiedenes bedeuten: Die angekündigte Richtlinie wurde übernommen, die Registry hat nichts angekündigt — was kein Fehlschlag ist —, an ihrer Stelle wurde die eingebaute Grundlinie gepinnt, oder es wurde kein Lesen versucht. Wo nichts angekündigt wurde, wird daneben angegeben, ob die Registry überhaupt erreicht werden konnte.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
pinned | boolesch | ja | Ob die angekündigte Richtlinie übernommen wurde. |
notAdvertised | boolesch | nein | Ob die Registry gefragt wurde und keine Richtlinie angekündigt hat, in welchem Fall die Operation auf dem fortfährt, was die Anfrage angegeben hat. Eine Registry, deren Befragung der Offline-Modus verhindert hat, wird nie so gemeldet. Eine Registry, die nicht erreicht werden konnte, wird ebenfalls so gemeldet, da von ihr keine Richtlinie zurückkam, und trägt unreachable daneben; lesen Sie unreachable, um die beiden zu unterscheiden. |
unreachable | boolesch | nein | Ob die Registry nicht erreicht werden konnte, als ihre angekündigte Richtlinie angefragt wurde: Ihr Name wurde nicht aufgelöst, eine Verbindung zu ihr wurde abgelehnt oder konnte nicht geöffnet werden, oder eine sichere Verbindung zu ihr konnte nicht hergestellt werden. Es wird aus dem Fehlschlag selbst gelesen statt aus reason, steht neben notAdvertised und wird nur gesetzt, wo der Fehlschlag zeigt, dass die Registry nie erreicht wurde; eine Registry, die geantwortet hat — ohne Richtlinie oder mit einem Fehlschlag —, lässt es fehlen. |
baseline | boolesch | nein | Ob die eingebaute Grundlinie, die nur der offizielle Hub trägt, gepinnt wurde, weil keine angekündigte Richtlinie übernommen wurde. Es steht neben notAdvertised, wo der Hub gefragt wurde und nichts angekündigt hat, und allein, wo der Offline-Modus verhindert hat, dass der Hub gefragt wurde. |
skipped | boolesch | nein | Ob kein Lesen versucht wurde, weil eine angegebene Richtlinie es überschrieben hat oder die Anfrage keines verlangt hat. |
identities | integer | nein | Wie viele Signaturidentitäten die angekündigte Richtlinie trug. |
reason | string | nein | Warum die angekündigte Richtlinie nicht übernommen wurde: was der Endpunkt der Registry getan hat, oder die Offline-Ablehnung, die verhindert hat, dass sie gefragt wurde. |
Zusätzliche Eigenschaften sind nicht zulässig.
SkippedRepo
Ein Repository, das der Index-Durchlauf übersprungen hat, und warum.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
repo | string | ja | Das Repository, das übersprungen wurde. |
reason | string | ja | Warum es übersprungen wurde. |
Zusätzliche Eigenschaften sind nicht zulässig.
DeprecationNote
Eine Deprecation-Markierung, auf die der Index-Durchlauf gestoßen ist, und was er damit getan hat. Eine Markierung, die berücksichtigt wurde, und eine, die vorhanden war und abgelehnt wurde, werden gleichrangig gemeldet, sodass das Verzeichnen vieler nicht stillschweigend geschieht, während das Ablehnen einer einzigen sich bemerkbar macht.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
repo | string | ja | Das Repository, an dem die Markierung hängt. |
version | string | ja | Die Version, die die Markierung abdeckt. |
recorded | boolesch | ja | Ob die eigene Signatur der Markierung verifiziert wurde und der Index sie daher trägt. |
severity | const “warning” oder const “error” oder const “retracted” | nein | Wie deutlich die Markierung spricht. Zulässige Werte: "warning" — Veraltet, auf der milderen der beiden beratenden Stufen: wird bei der Wahl einer Version weiterhin ausgewählt. "error" — Veraltet, auf der stärkeren der beiden beratenden Stufen: wird bei der Wahl einer Version weiterhin ausgewählt. "retracted" — Zurückgezogen: wird bei der Wahl einer Version ausgeschlossen. |
reason | string | nein | Warum die Version veraltet ist. |
Zusätzliche Eigenschaften sind nicht zulässig.
HostUpdate
Was eine Index-Aktualisierung für eine Registry getan hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
host | string | ja | Der Registry-Host, der aktualisiert wurde. |
indexed | integer | ja | Wie viele Datensätze geschrieben wurden. |
deprecationsExamined | boolesch | ja | Ob der Durchlauf überhaupt nach Deprecation-Markierungen gesucht hat. Es ist von der Anzahl getrennt, weil „diese Registry hat keine veröffentlicht“ und „dieser Lauf hatte keine Grundlage, eine zu beurteilen“ unterschiedliche Tatsachen sind. |
deprecationsRecorded | integer | ja | Wie viele Markierungen berücksichtigt wurden. |
skipped | SkippedRepo[] oder null | ja | Die Repositories, die der Durchlauf übersprungen hat. |
deprecations | DeprecationNote[] oder null | ja | Die Markierungen, auf die der Durchlauf gestoßen ist. |
readsRetried | integer | ja | Wie viele der Lesevorgänge des Durchlaufs die Registry unterwegs abgelehnt oder abgebrochen hat und die erneut angefragt wurden, wobei jeder Lesevorgang einmal gezählt wird, gleich wie viele Versuche er brauchte und ob er danach gelang oder nicht; null, wo es keinen gab. Ein Durchlauf, dessen Lesevorgänge am Ende alle gelungen sind, führt unter skipped kein Repository auf, daher sagt diese Anzahl, wie knapp er davor war, eines auszulassen. Minimum: 0. |
error | string | nein | Was für diesen Host fehlgeschlagen ist, sodass ein Durchlauf über mehrere meldet, welche davon fehlgeschlagen sind, ohne dass der Aufrufer etwas zuordnen muss. |
unreachable | boolesch | nein | Ob diese Registry nicht erreicht werden konnte: Ihr Name wurde nicht aufgelöst, eine Verbindung zu ihr wurde abgelehnt oder konnte nicht geöffnet werden, oder eine sichere Verbindung zu ihr konnte nicht hergestellt werden. Es wird aus dem Fehlschlag selbst gelesen statt aus error, wird nur neben error gesetzt und nur dort, wo der Fehlschlag zeigt, dass die Registry nie erreicht wurde; eine Registry, die geantwortet hat, was auch immer sie geantwortet hat, lässt es fehlen. |
Zusätzliche Eigenschaften sind nicht zulässig.
PublishedVersion
Eine Version, die der Index für eine Referenz enthält: der Manifest-Digest, auf den ihr Tag aufgelöst wurde, als der Index erstellt wurde; wo die Vertrauensrichtlinie, unter der der Index erstellt wurde, die eigene Signatur der Version verifiziert hat, der Signierer, als der sie verifiziert wurde; und, wo etwas es verzeichnet, wann die Version veröffentlicht wurde, mit der Quelle, die das angibt. Der Signierer fehlt bei einer Version ohne Signatur, bei einer, von deren Signaturen keine verifiziert wurde, und wo diese Richtlinie weder einen öffentlichen Schlüssel noch eine vertrauenswürdige Identität pinnt oder die Signaturverifizierung abschaltet. Keiner dieser Fälle ist eine Grundlage, um einen Signierer zu nennen, und sein Fehlen sagt nichts weiter aus. Das Veröffentlichungsdatum fehlt, wo die Veröffentlichung keines angegeben hat und keine von dieser Richtlinie verifizierte Keyless-Signatur eines verzeichnet.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
version | string | ja | Die Version, wie ihr Tag sie nennt. |
manifestDigest | string | ja | Der Digest des Manifests, auf das der Tag der Version aufgelöst wurde, als der Index erstellt wurde, und das die Version über die Bytes adressiert, die es nennt, statt über ihren Tag. |
signer | VerifiedSignature | nein | Eine Signatur, die gegen die Vertrauensrichtlinie einer Registry verifiziert wurde: wie sie verifiziert wurde, der Signierer, als der sie verifiziert wurde, und der Digest des Signatur-Bundles, das verifiziert wurde. |
publishedAt | string | nein | Wann die Version veröffentlicht wurde, als RFC-3339-Zeitstempel in UTC auf die Sekunde genau. Woher er stammt, gibt publishedAtSource an, und beide sind zusammen vorhanden oder gar nicht. |
publishedAtSource | const “transparency-log” oder const “publisher” | nein | Woher publishedAt stammt, sodass ein Zeitpunkt, den ein Transparency-Log bezeugt, nie mit einem verwechselt wird, den der Herausgeber angibt. Die Menge ist geschlossen. Zulässige Werte: "transparency-log" — Der Zeitpunkt, zu dem ein Transparency-Log die Keyless-Signatur der Version verzeichnet hat, die die Vertrauensrichtlinie, unter der der Index erstellt wurde, zusammen mit dem signierten Versprechen des Logs über diesen Zeitpunkt verifiziert hat. Für eine Version, die bei ihrer Veröffentlichung signiert wurde, ist es die Veröffentlichung; für eine, die danach signiert wurde, ist es der Zeitpunkt, zu dem diese Signatur erstellt wurde. "publisher" — Der Zeitpunkt, den die Veröffentlichung neben dem Veröffentlichten angegeben hat, von der eigenen Uhr der veröffentlichenden Maschine. Nichts bezeugt ihn. Eine Veröffentlichung gibt einen an, wo ihre Signatur keinen bezeugten Zeitpunkt trägt: eine schlüsselbasierte Signatur oder gar keine. Wo mehrere angehängt sind, wird der früheste genommen. |
Zusätzliche Eigenschaften sind nicht zulässig.
VerifiedSignature
Eine Signatur, die gegen die Vertrauensrichtlinie einer Registry verifiziert wurde: wie sie verifiziert wurde, der Signierer, als der sie verifiziert wurde, und der Digest des Signatur-Bundles, das verifiziert wurde.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
bundleDigest | string | ja | Der Digest des Signatur-Bundles, das verifiziert wurde, als sha256: gefolgt von 64 kleingeschriebenen Hexadezimalzeichen. |
identity | string | nein | Der Signierer, als der die Signatur verifiziert wurde: für eine Keyless-Signatur die Identität, für die das Signaturzertifikat ausgestellt wurde, also dessen Subject Alternative Name; für eine schlüsselbasierte Signatur keyed:sha256: gefolgt vom kleingeschriebenen hexadezimalen SHA-256 des PEM-Texts des gepinnten öffentlichen Schlüssels. |
issuer | string | nein | Der im Signaturzertifikat verzeichnete OIDC-Aussteller, für eine Keyless-Signatur. Er fehlt bei einer schlüsselbasierten Signatur. |
mode | const “keyless” oder const “keyed” | ja | Wie die Signatur verifiziert wurde. Die Menge ist geschlossen. Zulässige Werte: "keyless" — Gegen ein Signaturzertifikat, dessen Identität und Aussteller einem entsprechen, dem die Richtlinie vertraut, das sich bis zu der Vertrauenswurzel verketten lässt, die die Richtlinie pinnt, oder, wo sie keine pinnt, bis zur Public-Good-Wurzel von Sigstore, und dessen Signatur ein Transparency-Log verzeichnet. "keyed" — Gegen den öffentlichen Schlüssel, den die Richtlinie pinnt. |
Zusätzliche Eigenschaften sind nicht zulässig.
RegistrySearchRecord
Ein Datensatz, auf den eine Suche gepasst hat, so wie der lokale Index ihn enthält, dazu, welche seiner Versionen eine veröffentlichte Markierung als veraltet gekennzeichnet hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
uri | string | ja | Die Referenz, aus der sich der Datensatz auflöst. |
name | string | ja | Der Entitätsname. |
version | string | ja | Die Version, unter der der Datensatz geschlüsselt ist. |
versions | string[] | nein | Jede Version, die der Index für diese Referenz enthält. |
kind | string | nein | Die Entitätsart. |
description | string | nein | Wofür die Entität da ist. |
category | string | nein | Die Kategorie, unter der die Entität veröffentlicht ist. |
labels | Map von string | nein | Die Labels, die die Entität deklariert. |
pluginType | string | nein | Der Socket, an den sich ein Plugin-Datensatz anbindet. |
capabilities | string[] | nein | Die Fähigkeiten, die ein Plugin-Datensatz deklariert. |
manifestDigest | string | nein | Der Digest des veröffentlichten Manifests. |
listingDigest | string | nein | Der Digest der Auflistung, aus der der Datensatz gelesen wurde. |
deprecations | object[] | nein | Die Deprecation-Markierungen, die der Index für diese Referenz trägt, jede mit der Version, die sie abdeckt, und der verifizierten Markierung selbst. |
published | PublishedVersion[] | nein | Jede Version, die der Index für diese Referenz enthält, in derselben Reihenfolge wie versions, jede mit dem Manifest-Digest, auf den ihr Tag aufgelöst wurde, als der Index erstellt wurde, mit ihrem verifizierten Signierer, wo die Vertrauensrichtlinie, unter der der Index erstellt wurde, die eigene Signatur dieser Version verifiziert hat, und mit ihrem Veröffentlichungsdatum und dessen Quelle, wo etwas sie verzeichnet. Eine ohne Signierer verzeichnete Version trägt keine von dieser Richtlinie verifizierte Signatur, und mehr wird über sie nicht gesagt. Um dies zu verzeichnen, werden aus der Registry nur Manifeste, Signaturanhänge und Anhänge mit Veröffentlichungsdatum gelesen; der Inhalt keiner Entität wird abgerufen. |
retracted | string[] | nein | Die Versionen, die eine veröffentlichte Markierung als veraltet gekennzeichnet hat. |
Zusätzliche Eigenschaften sind nicht zulässig.
RegistrySearchIndex
Die Aktualität eines durchsuchten Hosts.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
host | string | ja | Der Host, dessen Index durchsucht wurde. |
lastUpdated | string | nein | Wann der Index zuletzt aktualisiert wurde. Es fehlt, statt null zu sein, wenn der Snapshot keine Zeit trägt, sodass ein Aufrufer „nicht verzeichnet“ vom Epoch-Zeitpunkt unterscheiden kann. |
Zusätzliche Eigenschaften sind nicht zulässig.
EffectiveConfigurationSetting
Eine aufgelöste Einstellung und aus welchem Dokument sie stammt.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
field | string | ja | Die Einstellung. |
value | string | ja | Der Wert, der aufgelöst wurde. |
source | string | ja | Woher der Wert stammt. |
Zusätzliche Eigenschaften sind nicht zulässig.
ImportedFile
Eine Datei, die ein Import schreibt: ein Entwurfsdokument oder der Datensatz dessen, was der Import geschrieben hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
path | string | ja | Wohin die Datei gehört, als Pfad relativ zum outputDir der Antwort. |
content | string | ja | Der Text der Datei. |
Zusätzliche Eigenschaften sind nicht zulässig.
ImportDrift
Ein Teil, den eine Synchronisierung auf den Stand der Quelle gebracht hat oder unter dryRun bringen würde.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
change | string | ja | Wie der Teil abgewichen ist: added, für einen Teil, den die Quelle hinzugewonnen hat; removed, für einen, den sie verworfen hat; oder changed, für einen, den sie geändert hat. |
file | string | ja | Die entworfene Datei, in der sich der Teil befindet, als Pfad relativ zum outputDir der Antwort. |
key | string[] | ja | Die Schlüssel, die von der obersten Ebene eines entworfenen Aggregate oder Release zum Teil führen, ein Eintrag pro Schlüssel, sodass ein Schlüssel, der einen Punkt enthält, ein Eintrag bleibt. Leer, wo der Teil die ganze Datei ist. |
Zusätzliche Eigenschaften sind nicht zulässig.
ImportOwed
Ein Wert, den die Entwürfe noch leer lassen und den keine Quelle liefern konnte und keine Antwort geliefert hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
file | string | ja | Die entworfene Datei, in der der Wert steht, als Pfad relativ zum outputDir der Antwort. |
key | string[] | ja | Die Schlüssel, die vom Anfang dieses Dokuments zum Wert führen, ein Eintrag pro Schlüssel, sodass ein Schlüssel, der einen Punkt enthält, ein einziger Eintrag bleibt. Eine als answered gesendete Antwort nennt den Wert über diese Schlüssel. |
question | string | ja | Was der Wert ist: die Beschreibung seines Schemas, andernfalls der Kommentar, den der Entwurf über seinen Schlüssel schreibt, andernfalls das, was laut seinem Schema angenommen wird. |
sensitive | boolesch | ja | Ob der Wert der eines Secret ist, dessen Antwort nennt, woher das Secret stammt, und nie das Secret selbst enthält. |
secretAdvice | string | nein | Vorhanden beim Wert eines Secret: was seine Antwort sein muss, in dem Satz, der einer Person angezeigt wird, die ihn an einem Terminal beantwortet — oder, wo die als answered dafür gesendete Antwort abgelehnt wurde, warum sie abgelehnt wurde. |
Zusätzliche Eigenschaften sind nicht zulässig.
ImportAnswered
Eine Antwort für einen Wert, den owed der Antwort aufgeführt hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
file | string | ja | Die entworfene Datei, in der der Wert steht, wie owed sie nennt. |
key | string[] | ja | Die Schlüssel, die zum Wert führen, wie owed sie nennt. |
answer | string | ja | Die Antwort. Eine leere Antwort lässt den Wert ausstehend. |
Zusätzliche Eigenschaften sind nicht zulässig.
ImportDiagnostic
Etwas, das eine Umwandlung nicht umwandeln konnte. Dies ist die nützlichste Ausgabe der Umwandlung, daher wird es vollständig gemeldet, statt auf ein Urteil reduziert zu werden.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
severity | string | ja | Wie schwerwiegend es ist. |
message | string | ja | Was nicht umgewandelt werden konnte. |
code | string | nein | Der zitierbare Name der Bedingung, sofern sie einen hat. |
Zusätzliche Eigenschaften sind nicht zulässig.
ImportDecision
Wie eine Umwandlung einen Quellknoten abgebildet hat: die Katalog-Components, die der Importer abgewogen hat, die, die er gewählt hat, warum, und wie die Wahl ausgetauscht werden kann.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
sourceNode | DecisionSourceNode | ja | Der Quellknoten, um den es bei einer Abbildungsentscheidung geht. |
candidates | ImportCandidate[] | nein | Die Katalog-Components, die der Importer für den Knoten abgewogen hat, jede mit ihrer Bewertung. Fehlt, wo er keine abgewogen hat. |
chosen | DecisionChoice | nein | Was der Importer für einen Quellknoten gewählt hat. Fehlt in einer Entscheidung, in der er keine Wahl getroffen hat. |
rationale | string | nein | Warum der Importer die Wahl getroffen hat, in seinen eigenen Worten. Fehlt, wo er keine geschrieben hat. |
swapHint | string | nein | Wie die Wahl gegen eine Alternative ausgetauscht werden kann, in den eigenen Worten des Importers. Fehlt, wo er keine geschrieben hat. |
Zusätzliche Eigenschaften sind nicht zulässig.
DecisionSourceNode
Der Quellknoten, um den es bei einer Abbildungsentscheidung geht.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
id | string | ja | Der Bezeichner des Knotens in der Quelle. |
type | string | ja | Der Typ des Knotens, wie die Quelle ihn nennt. |
paramsSummary | string | ja | Eine Zusammenfassung der Parameter des Knotens, zur Anzeige neben der Entscheidung. |
Zusätzliche Eigenschaften sind nicht zulässig.
ImportCandidate
Eine Katalog-Component, die der Importer für einen Quellknoten abgewogen hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
componentName | string | ja | Der Name der Component. |
score | number | ja | Wie gut die Component zum Knoten passt, wie der Importer es bewertet hat. |
tier | string | ja | Die Übereinstimmungsstufe, in die die Bewertung fällt. |
signals | CandidateSignals | ja | Was jedes der Signale des Importers zur Bewertung eines Kandidaten beigetragen hat. |
Zusätzliche Eigenschaften sind nicht zulässig.
CandidateSignals
Was jedes der Signale des Importers zur Bewertung eines Kandidaten beigetragen hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
table | number | ja | Der Beitrag des Zuordnungstabellen-Signals. |
category | number | ja | Der Beitrag des Kategoriesignals. |
domainLabels | number | ja | Der Beitrag des Signals der Domänen-Labels. |
shape | number | ja | Der Beitrag des Formsignals. |
name | number | ja | Der Beitrag des Namenssignals. |
Zusätzliche Eigenschaften sind nicht zulässig.
DecisionChoice
Was der Importer für einen Quellknoten gewählt hat. Fehlt in einer Entscheidung, in der er keine Wahl getroffen hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
target | string | ja | Der Name der gewählten Component: eine vorhandene Katalog-Component oder die für den Knoten entworfene. |
mode | string | ja | Wie die Wahl geschrieben wird: als Referenz auf eine vorhandene Component oder als neu entworfene. |
tier | string | ja | Die Übereinstimmungsstufe der Wahl. |
Zusätzliche Eigenschaften sind nicht zulässig.
LintFileFindings
Was eine Konventionsprüfung in einem Dokument gefunden hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
file | string | ja | Das Dokument. |
diagnostics | Diagnostic[] oder null | ja | Die Befunde darin. |
Zusätzliche Eigenschaften sind nicht zulässig.
PluginRetractionExclusion
Eine Version, die verfügbar war und nicht gewählt wurde.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
version | string | ja | Die Version, die übersprungen wurde. |
reason | string | nein | Warum es übersprungen wurde. |
Zusätzliche Eigenschaften sind nicht zulässig.
PluginRetractionProvenance
Woher das Wissen darüber stammt, was veraltet ist.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
source | string | ja | Was herangezogen wurde. |
lastUpdated | string | nein | Wann dies zuletzt aktualisiert wurde. |
Zusätzliche Eigenschaften sind nicht zulässig.
PluginRetraction
Wie eine Deprecation-Markierung bestimmt hat, welche Plugin-Version gepinnt wurde.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
reference | string | ja | Die Referenz, zu der die Versionen gehören. |
selected | string | nein | Die Version, die gepinnt wurde. |
excluded | PluginRetractionExclusion[] | nein | Die Versionen, die verfügbar waren und übersprungen wurden. |
unscreened | string | nein | Was nicht gegen eine Markierung abgeglichen werden konnte, und warum. |
provenance | PluginRetractionProvenance | nein | Woher das Wissen darüber stammt, was veraltet ist. |
Zusätzliche Eigenschaften sind nicht zulässig.
PluginGeneratedDocument
Ein Katalogdokument, das eine Generierung erzeugt hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
path | string | ja | Wohin das Dokument gehört, als Pfad relativ zur Workspace-Wurzel. |
content | string | ja | Der Text des Dokuments. |
Zusätzliche Eigenschaften sind nicht zulässig.
PluginCommandFlag
Ein Flag, das ein Plugin für einen Befehl deklariert, den es beisteuert.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
name | string | ja | Der lange Name des Flags. |
shorthand | string | nein | Der Ein-Zeichen-Alias des Flags, sofern es einen hat. |
description | string | nein | Der einzeilige Hilfetext des Flags. |
type | string | nein | Der Werttyp des Flags. |
default | string | nein | Der Wert, der verwendet wird, wenn das Flag nicht übergeben wird. |
Zusätzliche Eigenschaften sind nicht zulässig.
PluginCLICommand
Ein Befehlsverb der obersten Ebene, das ein Plugin beisteuert.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
name | string | ja | Das Befehlsverb. |
description | string | nein | Der einzeilige Hilfetext des Befehls. |
flags | PluginCommandFlag[] | nein | Die Flags des Befehls, in deklarierter Reihenfolge. |
Zusätzliche Eigenschaften sind nicht zulässig.
ConfigCapturedAttachment
Eine Anbindung, die ein Einfrieren in die eigene Konfiguration dieses Workspace geschrieben hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
uri | string | nein | Die Referenz, aus der sich die Anbindung auflöst. |
capability | string | nein | Die Fähigkeit, für die die Anbindung bestimmt ist. |
function | string | nein | Der Export, an den die Anbindung weitergeleitet wird. |
role | string | nein | Die Rolle, in der die Anbindung läuft, was festlegt, was sie ausgeben darf. |
Zusätzliche Eigenschaften sind nicht zulässig.
ConfigCapturedSocket
Ein Socket, den ein Einfrieren geschrieben hat, mit den Anbindungen, die es an ihm eingefroren hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
socket | string | ja | Der Socket. |
field | string | ja | Das Konfigurationsfeld, unter dem der Socket geschrieben wird. |
attachments | ConfigCapturedAttachment[] oder null | ja | Die Anbindungen, die an ihm eingefroren wurden. |
Zusätzliche Eigenschaften sind nicht zulässig.
ExplainErrorEntry
Ein veröffentlichter Abschnitt, der die Authoring-Korrektur für eine Bedingung lehrt.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
heading | string | ja | Die Überschrift des Abschnitts. |
body | string | ja | Der Abschnitt. |
Zusätzliche Eigenschaften sind nicht zulässig.
SignedArtifact
Ein veröffentlichtes Artefakt, das eine Signierung abgedeckt hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
reference | string | ja | Die Referenz, die signiert wurde. |
digest | string | ja | Der Digest dessen, was signiert wurde. |
Zusätzliche Eigenschaften sind nicht zulässig.
DeprecationMarked
Eine veröffentlichte Version, die eine Deprecation gekennzeichnet hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
reference | string | ja | Die Referenz, die gekennzeichnet wurde. |
severity | const “warning” oder const “error” oder const “retracted” | ja | Wie deutlich die Markierung spricht. Zulässige Werte: "warning" — Veraltet, auf der milderen der beiden beratenden Stufen: wird bei der Wahl einer Version weiterhin ausgewählt. "error" — Veraltet, auf der stärkeren der beiden beratenden Stufen: wird bei der Wahl einer Version weiterhin ausgewählt. "retracted" — Zurückgezogen: wird bei der Wahl einer Version ausgeschlossen. |
issuedOn | string | ja | Wann die Markierung ausgestellt wurde. |
digest | string | ja | Der Digest der Markierung, die veröffentlicht wurde. |
Zusätzliche Eigenschaften sind nicht zulässig.
InitializeResult
Worauf sich die Sitzung für diesen Client festgelegt hat und aus welcher Konfigurationsebene sie aufgelöst hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
capabilities | ServerCapabilities | ja | Was der Daemon in dieser Sitzung tun wird, abgestimmt auf das, was der Client nach eigener Aussage verarbeiten kann. |
workspaceRoot | string | ja | Der Workspace, über dem die Sitzung geöffnet wurde. |
configSource | string | ja | Aus welcher Konfigurationsebene die Sitzung ihre Einstellungen aufgelöst hat. |
workspaceMarker | string | nein | Die Datei, die die Workspace-Wurzel identifiziert hat, sofern es eine gab. |
version | string | ja | Die Version des Binary, das dieser Sitzung antwortet: derselbe Wert, den aggrega version für dieses Binary meldet. Sie beschreibt den laufenden Prozess, daher nennt dies, sobald die Datei, aus der der Daemon gestartet wurde, ersetzt worden ist, weiterhin die laufende Version, während eine Abfrage der Datei die Version nennt, die sie ersetzt hat. |
Zusätzliche Eigenschaften sind nicht zulässig.
ValidateResult
Was die Prüfung gefunden hat und wie viel geprüft wurde.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
diagnostics | Diagnostic[] oder null | ja | Die Befunde. Es ist null statt einer leeren Liste, wenn die Prüfung nichts gefunden hat. |
checked | string | nein | Wie viel geprüft wurde — ein Dokument oder das, was der Workspace enthält. |
Zusätzliche Eigenschaften sind nicht zulässig.
InvalidateResult
Ob der Daemon irgendetwas über das Dokument vorhielt, das zu verwerfen war.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
invalidated | boolesch | ja | Ob irgendetwas verworfen wurde. |
Zusätzliche Eigenschaften sind nicht zulässig.
DiagnosticsResult
Die Befunde, die der Daemon für das Dokument bereits vorhält.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
diagnostics | Diagnostic[] oder null | ja | Die Befunde. Es ist null statt einer leeren Liste, wenn es keine gibt. |
Zusätzliche Eigenschaften sind nicht zulässig.
IrGraphResult
Der aufgelöste Graph, zu dem ein Release kompiliert wird.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
graph | any | ja | Das Graphdokument. Die Werte, die ein Autor als sensibel deklariert hat, werden daraus zurückgehalten, sofern die Anfrage sie nicht mit unredacted angefordert hat; alles andere wird so übernommen, wie der Compiler es ausgegeben hat. Seine eigene Form ist der veröffentlichte Vertrag des Graphen und wird hier nicht wiederholt. |
Zusätzliche Eigenschaften sind nicht zulässig.
BuildResult
Was ein Build geschrieben hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
outputDirectory | string | ja | Das Verzeichnis, in das die Artefakte geschrieben wurden. |
files | string[] oder null | ja | Die Artefakte, die geschrieben wurden, als Pfade relativ zum Ausgabeverzeichnis. |
notices | BuildNotice[] | nein | Alles, was der Build dem Aufrufer mitteilen möchte und was weder ein Befund noch ein Fehlschlag ist. |
dependencyResolution | DependencyResolutionReport | nein | Was eine Abhängigkeitsauflösung gepinnt und beschafft hat. |
Zusätzliche Eigenschaften sind nicht zulässig.
BuildPreviewResult
Was ein Build geschrieben hätte. Es wurde nichts geschrieben, daher gibt es kein Ausgabeverzeichnis zu nennen.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
files | string[] oder null | ja | Die Artefakte, die das Schreiben erzeugt hätte. |
notices | BuildNotice[] | nein | Alles, was das Kompilieren dem Aufrufer mitteilen möchte und was weder ein Befund noch ein Fehlschlag ist. |
Zusätzliche Eigenschaften sind nicht zulässig.
EntityDefinitionResult
Wozu ein Entitätsname aufgelöst wird, und das Dokument, das die Entität definiert. Eine aus einer Registry-Referenz gelesene Antwort trägt published, und eine Antwort, die der Katalog über den Namen aufgelöst hat, nie.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
kind | string | ja | Die Entitätsart. |
name | string | ja | Der Entitätsname. |
version | string | ja | Die Version, die aufgelöst wurde. |
description | string | nein | Wofür die Entität laut dem Dokument da ist. |
publishScope | string | nein | Wie weit die Entität veröffentlicht ist. |
file | string | ja | Das Dokument, das sie definiert. |
authoredLength | integer | ja | Wie viele Bytes das verfasste Dokument enthält, sodass ein Client ein verfasstes Dokument von einer aufgelösten Darstellung eines solchen unterscheiden kann. |
definition | string | ja | Der Text der Definition. |
published | PublishedArtifact | nein | Was eine Registry-Referenz gelesen hat: die Koordinate, wie sie die Entität enthielt, und das Manifest, über das sie gelesen wurde. Jedes Feld ist überall vorhanden, wo dies vorhanden ist. |
Zusätzliche Eigenschaften sind nicht zulässig.
PublishedArtifact
Was eine Registry-Referenz gelesen hat: die Koordinate, wie sie die Entität enthielt, und das Manifest, über das sie gelesen wurde. Jedes Feld ist überall vorhanden, wo dies vorhanden ist.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
reference | string | ja | Die Registry-Referenz, die gelesen wurde. |
archive | boolesch | ja | Ob die Bytes der Koordinate ein Archiv waren, aus dem das Entitätsdokument entpackt wurde. False, wo die Koordinate das Entitätsdokument selbst enthielt. |
mediaType | string | ja | Der Artefakttyp, den das Manifest deklariert. |
manifestDigest | string | ja | Der Digest des Manifests, über das die Entität gelesen wurde — der Wert, der nach @ anzugeben ist, um genau dieselben Bytes erneut zu lesen. |
Zusätzliche Eigenschaften sind nicht zulässig.
ReleaseClosureResult
Alles, wovon ein Release abhängt, so wie die Auflösung es erreicht hat. Es meldet den Abschluss statt des daraus abgeleiteten Graphen: ein anderes Dokument über dasselbe Release.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
release | string | ja | Das Release, das untersucht wurde. |
aggregate | string | ja | Das Aggregate, das es bereitstellt. |
manifest | string | ja | Das Manifest, über das es auflöst. |
environment | string | ja | Die Umgebung, die es nennt. |
entities | ClosureEntity[] oder null | ja | Die Entitäten, die der Abschluss erreicht. |
libraries | ClosureEntity[] oder null | ja | Die Bibliotheken, die der Abschluss erreicht. |
plugins | ClosureEntity[] oder null | ja | Die Plugins, die der Abschluss erreicht. |
mappingDiagnostics | string[] oder null | ja | Was das Auflösen der Zuordnungen des Manifest zu sagen hatte. |
deprecations | string[] oder null | ja | Die Deprecation-Markierungen, auf die der Abschluss gestoßen ist. |
Zusätzliche Eigenschaften sind nicht zulässig.
ResolveDependenciesResult
Was eine Abhängigkeitsauflösung gepinnt und beschafft hat, dazu alles, was sie dem Aufrufer mitteilen möchte. Die eigenen Felder des Berichts werden direkt auf dieser Antwort getragen, statt unter einem ihrer Felder verschachtelt zu sein.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
lockfile | string | ja | Das Lockfile, das die Auflösung geschrieben hat, oder dasjenige, mit dem eine Verifizierung verglichen hat. |
verified | boolesch | nein | Ob die Anfrage eine Verifizierung war, die das verzeichnete Lockfile verglichen und kein Lockfile, keinen Plugin-Vertrauensdatensatz und kein entity.lock geschrieben hat. |
entities | ClosureEntity[] oder null | ja | Die Entitäten, die die Auflösung gepinnt oder eine Verifizierung verglichen hat. |
libraries | ClosureEntity[] oder null | ja | Die Bibliotheken, die die Auflösung gepinnt oder eine Verifizierung verglichen hat. |
plugins | ClosureEntity[] oder null | ja | Die Plugins, die die Auflösung gepinnt oder eine Verifizierung verglichen hat. |
sourceArtifacts | integer | ja | Wie viele Quellartefakte beschafft wurden. |
trustedPlugins | integer | ja | Wie viele der gepinnten Plugins eine verifizierte Signatur trugen. |
toolchain | ToolchainReport | nein | Der Compiler, der aufgelöst hat, und die Plugins, die er mitführt. |
externalInputs | integer | ja | Wie viele externe Eingaben, die das Rendering verbraucht, beschafft wurden. |
incompleteExternalInputs | string | nein | Welche externen Eingaben nicht beschafft werden konnten, sofern einige nicht beschafft werden konnten. |
notices | string[] | nein | Alles, was die Auflösung dem Aufrufer mitteilen möchte. |
Zusätzliche Eigenschaften sind nicht zulässig.
PinResult
Was der Pin-Schritt mit dem Lock neben einer Entität getan hat oder bei einem Probelauf tun würde. Es ist die Antwort auf aggrega/pin, und eine Veröffentlichung, die den Schritt ausgeführt hat, trägt es als ihr pin.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
entity | string | ja | Das Entitätsdokument, das der Schritt gelesen hat, als Pfad relativ zur Workspace-Wurzel. |
kind | string | ja | Die Art der Entität, wie ihr Dokument sie deklariert. |
name | string | ja | Der Name der Entität, wie ihr Dokument ihn deklariert. |
pinnable | boolesch | ja | Ob eine Entität dieser Art irgendetwas liest, wofür ein Lock einen Pin verzeichnet, was ein Recipe und ein FeatureRecipe tun. Wo es false ist, wurde nichts neben der Entität berührt, changed ist false, und lock, removed, pins und content fehlen. |
lock | string | nein | Das Lock, das der Schritt geschrieben hat oder schreiben würde, als Pfad relativ zur Workspace-Wurzel. |
changed | boolesch | ja | Ob sich das Lock geändert hat oder bei einem Probelauf ändern würde. False, wo das Lock bereits jeden Pin verzeichnete, den die Entität braucht, und Byte für Byte identisch gelassen wurde. |
removed | boolesch | nein | Ob die Änderung eine Entfernung ist: Die Entität liest nichts, wofür ein Lock einen Pin verzeichnet, daher bleibt neben ihr kein Lock zurück. |
dryRun | boolesch | nein | Ob dies meldet, was der Schritt tun würde, statt was er getan hat. |
pins | PinClassCount[] | nein | Wie viele Pins jeder Klasse das Lock nach dem Schritt enthält oder nach einem Probelauf enthalten würde. Jede Klasse, die das Lock enthalten kann, wird aufgeführt, eine Klasse ohne Pin eingeschlossen. |
content | string | nein | Das Lock, das ein Probelauf schreiben würde. Fehlt, wo das Lock so gelassen würde, wie es ist, oder entfernt würde, sowie bei jeder Antwort, die kein Probelauf ist. |
Zusätzliche Eigenschaften sind nicht zulässig.
PinClassCount
Wie viele Pins einer Klasse ein Lock enthält.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
class | string | ja | Die Klasse des Pins, in den Worten, die eine Ablehnung verwendet, die einen fehlenden nennt — etwa remote source oder imported file. |
pins | integer | ja | Wie viele Pins dieser Klasse das Lock enthält. |
Zusätzliche Eigenschaften sind nicht zulässig.
CacheStatusResult
Was die Caches enthalten, die diesen Workspace bedienen.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
classes | CacheClass[] oder null | ja | Jeder Cache und was er enthält. |
provenance | CacheProvenance[] oder null | ja | Unter welchen Identitäten die zwischengespeicherten Artefakte beschafft wurden. |
totalCount | integer | ja | Wie viele Einträge die Caches insgesamt enthalten. |
totalSize | integer | ja | Wie viele Bytes sie insgesamt belegen. |
totalSizeText | string | ja | Dieselbe Summe, so geschrieben, wie ein Mensch sie liest. |
scope | CacheScope | ja | Wie weit eine Cache-Antwort reicht. Zwei der Cache-Klassen werden von jedem Projekt auf der Maschine gemeinsam genutzt, daher nennt jede Cache-Antwort, welche davon sie berührt hat — eine über einem Workspace geöffnete Sitzung würde sonst so gelesen, als melde sie nur über diesen Workspace. |
Zusätzliche Eigenschaften sind nicht zulässig.
CachePruneResult
Was eine Freigabe entfernt hat, was sie behalten hat und was sie nicht freigeben konnte.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
removed | CacheRemoval[] oder null | ja | Was entfernt wurde. |
heldOpen | CacheRemoval[] oder null | ja | Was die Bereinigung entfernt hätte, aber an Ort und Stelle gelassen hat, weil ein anderer Prozess es geöffnet hatte. Nur Windows weigert sich, eine geöffnete Datei zu entfernen, daher ist dies überall sonst leer. Diese Einträge werden weder als entfernt noch als behalten gezählt, keines ihrer Bytes zählt als freigegeben, und eine spätere Bereinigung gibt sie frei; ein Eintrag, der ein Verzeichnis ist, kann die darin enthaltenen Dateien, die nicht geöffnet waren, bereits verloren haben. |
retainedCount | integer | ja | Wie viele Einträge behalten wurden. |
reclaimedBytes | integer | ja | Wie viele Bytes freigegeben wurden. |
reclaimedBytesText | string | ja | Dieselbe Zahl, so geschrieben, wie ein Mensch sie liest. |
unattributedCount | integer | ja | Wie viele Einträge kein Inhaber beansprucht. |
unattributedSize | integer | ja | Wie viele Bytes diese belegen. |
unattributedSizeText | string | ja | Dieselbe Zahl, so geschrieben, wie ein Mensch sie liest. |
notPruneEligible | CacheShortfall[] oder null | ja | Was zurückgelassen wurde und was es freigeben würde. |
scope | CacheScope | ja | Wie weit eine Cache-Antwort reicht. Zwei der Cache-Klassen werden von jedem Projekt auf der Maschine gemeinsam genutzt, daher nennt jede Cache-Antwort, welche davon sie berührt hat — eine über einem Workspace geöffnete Sitzung würde sonst so gelesen, als melde sie nur über diesen Workspace. |
Zusätzliche Eigenschaften sind nicht zulässig.
CacheEvictResult
Was das Freigeben bis auf eine Größe entfernt hat und was übrig bleibt.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
withinCapBefore | boolesch | ja | Ob das Vorgehaltene bereits unter die Größe passte, sodass nichts entfernt werden musste. |
removed | CacheRemoval[] oder null | ja | Was entfernt wurde. |
heldOpen | CacheRemoval[] oder null | ja | Was das Freigeben entfernt hätte, aber an Ort und Stelle gelassen hat, weil ein anderer Prozess es geöffnet hatte; es ging stattdessen zum nächstälteren Eintrag über. Nur Windows weigert sich, eine geöffnete Datei zu entfernen, daher ist dies überall sonst leer. Diese Einträge zählen weiterhin zu den verbleibenden Bytes, und ein späteres Freigeben kann sie entfernen. |
totalBefore | integer | ja | Wie viele Bytes zuvor vorgehalten wurden. |
totalBeforeText | string | ja | Dieselbe Zahl, so geschrieben, wie ein Mensch sie liest. |
reclaimedBytes | integer | ja | Wie viele Bytes freigegeben wurden. |
reclaimedBytesText | string | ja | Dieselbe Zahl, so geschrieben, wie ein Mensch sie liest. |
remainingBytes | integer | ja | Wie viele Bytes übrig bleiben. |
remainingBytesText | string | ja | Dieselbe Zahl, so geschrieben, wie ein Mensch sie liest. |
capBytes | integer | ja | Die Größe, bis auf die freigegeben wurde, in Bytes. |
capBytesText | string | ja | Dieselbe Größe, so geschrieben, wie ein Mensch sie liest. |
scope | CacheScope | ja | Wie weit eine Cache-Antwort reicht. Zwei der Cache-Klassen werden von jedem Projekt auf der Maschine gemeinsam genutzt, daher nennt jede Cache-Antwort, welche davon sie berührt hat — eine über einem Workspace geöffnete Sitzung würde sonst so gelesen, als melde sie nur über diesen Workspace. |
Zusätzliche Eigenschaften sind nicht zulässig.
CacheClearResult
Was das Leeren der Caches freigegeben hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
cleared | CacheCleared[] oder null | ja | Jeder Cache, der geleert wurde. |
reclaimedBytes | integer | ja | Wie viele Bytes freigegeben wurden. |
reclaimedBytesText | string | ja | Dieselbe Zahl, so geschrieben, wie ein Mensch sie liest. |
scope | CacheScope | ja | Wie weit eine Cache-Antwort reicht. Zwei der Cache-Klassen werden von jedem Projekt auf der Maschine gemeinsam genutzt, daher nennt jede Cache-Antwort, welche davon sie berührt hat — eine über einem Workspace geöffnete Sitzung würde sonst so gelesen, als melde sie nur über diesen Workspace. |
Zusätzliche Eigenschaften sind nicht zulässig.
RegistryListResult
Die Registries, über die dieser Workspace auflöst.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
registries | Registry[] oder null | ja | Jede konfigurierte Registry. |
credentialStateIsMachineWide | boolesch | ja | Ob das für jede Registry gemeldete Vorhandensein einer Anmeldeinformation eine maschinenweite Tatsache statt einer des Workspace ist. Es wird gemeldet, damit eine auf die Sitzung beschränkte Antwort nicht so gelesen wird, als bestreite sie die weitere Reichweite. |
Zusätzliche Eigenschaften sind nicht zulässig.
SearchResult
Was die lokalen Registry-Indizes für die Suche angeboten haben.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
records | RegistrySearchRecord[] oder null | ja | Die Datensätze, die gepasst haben. |
indexes | RegistrySearchIndex[] oder null | ja | Jeder durchsuchte Host und wann sein Index zuletzt aktualisiert wurde. |
missingIndexHosts | string[] oder null | ja | Die konfigurierten Hosts ohne lokalen Index zum Durchsuchen, sodass eine kurze Antwort erklärt wird, statt der Schlussfolgerung überlassen zu bleiben. |
stale | boolesch | ja | Ob irgendein durchsuchter Index alt genug ist, dass sich eine Aktualisierung lohnt. |
registriesConfigured | boolesch | ja | Ob überhaupt eine Registry konfiguriert ist, was „nichts hat gepasst“ von „nichts wurde durchsucht“ unterscheidet. |
Zusätzliche Eigenschaften sind nicht zulässig.
RegistryAddResult
Was das Registrieren einer Registry geschrieben hat, wo, und was es aus der Registry selbst gelesen hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
host | string | ja | Der Host, unter dem der Eintrag geschlüsselt ist, was nicht immer die Schreibweise ist, die die Anfrage verwendet hat. |
scope | ConfigWriteScope | ja | Welches Konfigurationsdokument geschrieben wurde und wie weit es reicht. Eine Anfrage nennt einen Workspace, daher würde eine Antwort, die nichts sagt, so gelesen, als beträfe sie diesen Workspace — und für einen maschinenweiten Schreibvorgang ist diese Lesart falsch. |
trust | TrustFetchOutcome | ja | Was das Lesen der angekündigten Vertrauensrichtlinie einer Registry bewirkt hat. Die Ergebnisse werden auseinandergehalten, weil sie Verschiedenes bedeuten: Die angekündigte Richtlinie wurde übernommen, die Registry hat nichts angekündigt — was kein Fehlschlag ist —, an ihrer Stelle wurde die eingebaute Grundlinie gepinnt, oder es wurde kein Lesen versucht. Wo nichts angekündigt wurde, wird daneben angegeben, ob die Registry überhaupt erreicht werden konnte. |
Zusätzliche Eigenschaften sind nicht zulässig.
RegistryRemoveResult
Was das Entfernen einer Registry geschrieben hat, und wo.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
host | string | ja | Der Host, dessen Eintrag entfernt wurde. |
scope | ConfigWriteScope | ja | Welches Konfigurationsdokument geschrieben wurde und wie weit es reicht. Eine Anfrage nennt einen Workspace, daher würde eine Antwort, die nichts sagt, so gelesen, als beträfe sie diesen Workspace — und für einen maschinenweiten Schreibvorgang ist diese Lesart falsch. |
Zusätzliche Eigenschaften sind nicht zulässig.
RegistryUpdateResult
Was das Aktualisieren der lokalen Indizes getan hat, pro Host.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
hosts | HostUpdate[] oder null | ja | Was die Aktualisierung für jeden Host getan hat. |
failed | string[] oder null | ja | Die Hosts, für die die Aktualisierung nicht abgeschlossen werden konnte. |
indexRoot | string | ja | Das Verzeichnis, unter dem die Indizes geschrieben wurden. |
registriesConfigured | boolesch | ja | Ob überhaupt eine Registry konfiguriert ist. |
reachedRegistries | boolesch | ja | Bei dieser Antwort immer true: Das Aktualisieren der Indizes greift auf die Registries selbst zu, während ihr Auflisten und das Suchen aus der Konfiguration und aus einem lokalen Index antworten. Ob eine bestimmte Registry tatsächlich erreicht wurde, wird in ihrem eigenen Eintrag in hosts durch unreachable angegeben. |
Zusätzliche Eigenschaften sind nicht zulässig.
LogoutResult
Welche gespeicherte Anmeldeinformation entfernt wurde und wie weit der Speicher reicht.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
registry | string | ja | Die Registry, deren Anmeldeinformation entfernt wurde. |
scope | CredentialStoreScope | ja | Wie weit eine Änderung an einer Anmeldeinformation reicht. Der Speicher wird von jedem Projekt auf der Maschine und von jedem anderen Werkzeug, das dieselben Registries anspricht, gemeinsam genutzt, daher meldet die Antwort das, statt eine auf die Sitzung beschränkte Lesart der Schlussfolgerung zu überlassen. |
Zusätzliche Eigenschaften sind nicht zulässig.
PublishEntityResult
Was die Veröffentlichung einer Entität abgelegt hat, und wo. Eine Veröffentlichung, die zuerst den Pin-Schritt ausgeführt hat, trägt auch, was dieser Schritt getan hat, als pin, das fehlt, wo der Schritt nicht ausgeführt wurde.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
reference | string | ja | Die Referenz, unter der die Entität veröffentlicht wurde. |
tag | string | ja | Der Tag, unter dem sie veröffentlicht wurde. |
kind | string | ja | Die Art der Entität, die veröffentlicht wurde. |
mediaType | string | ja | Der Medientyp, der für die veröffentlichten Bytes verzeichnet wurde. |
size | integer | ja | Wie viele Bytes veröffentlicht wurden. |
sizeText | string | ja | Dieselbe Größe, so geschrieben, wie ein Mensch sie liest. |
pluginSize | integer | nein | Wie viele Bytes das Plugin-Modul belegt, das zusammen mit einer Plugin-Entität veröffentlicht wurde. |
pluginSizeText | string | nein | Dieselbe Größe, so geschrieben, wie ein Mensch sie liest. |
digest | string | ja | Der Digest dessen, was veröffentlicht wurde. Bei einem Probelauf der Digest, den eine Veröffentlichung desselben Inhalts ablegen würde, allein aus dem Inhalt berechnet: derjenige, den aggrega push --dry-run ausgibt. |
signed | boolesch | ja | Ob diese Veröffentlichung eine Signatur angehängt hat: diejenige, die sie vor dem Veröffentlichen erstellt hat, oder, bei einer bereits veröffentlichten Version, eine, die der Version fehlte. |
alreadyPublished | boolesch | ja | Ob dieselben Bytes bereits vorhanden waren, sodass kein Inhalt hochgeladen wurde. Daneben wurde nur angehängt, was jener Veröffentlichung noch fehlte: ihr Veröffentlichungsdatum und, wo diese Veröffentlichung signiert, ihre Signatur; signed sagt, ob eine Signatur angehängt wurde. |
dryRun | boolesch | ja | Ob dies meldet, was die Veröffentlichung abgelegt hätte, statt was sie abgelegt hat. |
reach | PublicationReach | ja | Wie weit eine Veröffentlichung gereicht hat. Diese Antworten reichen ganz über diese Maschine hinaus — was sie anhängen, ist das, was jeder Konsument dieser Registry auflöst —, daher nennt jede jede Registry, die sie angesprochen hat, und ob der Aufruf dort etwas angehängt hat. |
pin | PinResult | nein | Was der Pin-Schritt mit dem Lock neben einer Entität getan hat oder bei einem Probelauf tun würde. Es ist die Antwort auf aggrega/pin, und eine Veröffentlichung, die den Schritt ausgeführt hat, trägt es als ihr pin. |
wholeDirectorySource | string | nein | Die lokale Quelle der Entität, wie verfasst, vorhanden, wenn sie als Template geschrieben ist. Eine solche Quelle nennt ihr Verzeichnis erst, sobald ein Release das Template ausfüllt, daher trägt die Veröffentlichung jede Datei im Verzeichnis der Entität statt nur der Dateien, die die Entität nennt. Fehlt, wo sie nur diese Dateien trägt. |
windowsUnusableEntries | string[] | nein | Die Einträge des veröffentlichten Archivs, deren Pfad einen Teil enthält, den Windows so, wie er geschrieben ist, nicht aufnehmen kann — einen Namen, den Windows für ein Gerät reserviert, etwa CON, AUX oder NUL, in beliebiger Groß- und Kleinschreibung und gleich welche Erweiterung folgt, oder einen Teil, der auf einen Punkt oder ein Leerzeichen endet —, zuerst der eigene Dateiname des Entitätsdokuments, dann die Dateien, die es trägt. Ein Workspace unter Windows weigert sich, sie zu entpacken, und kann die Version daher nicht verwenden; die Veröffentlichung wird genau so fortgesetzt oder angehalten, wie sie es ohne sie täte. Fehlt, wo es keine gibt, was eine allein als ihr Dokument veröffentlichte Entität einschließt. |
Zusätzliche Eigenschaften sind nicht zulässig.
PublishArtifactResult
Was die Veröffentlichung einer Datei abgelegt hat, und wo.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
reference | string | ja | Die Referenz, unter der die Datei veröffentlicht wurde. |
tag | string | ja | Der Tag, unter dem sie veröffentlicht wurde. |
mediaType | string | ja | Der Medientyp, der für die veröffentlichten Bytes verzeichnet wurde. |
size | integer | ja | Wie viele Bytes veröffentlicht wurden. |
sizeText | string | ja | Dieselbe Größe, so geschrieben, wie ein Mensch sie liest. |
digest | string | ja | Der Digest dessen, was veröffentlicht wurde. |
alreadyPublished | boolesch | ja | Ob dieselben Bytes bereits vorhanden waren, sodass kein Inhalt hochgeladen wurde. Ein Veröffentlichungsdatum wurde nur dort daneben angehängt, wo dem Artefakt eines fehlte. |
dryRun | boolesch | ja | Ob dies meldet, was die Veröffentlichung abgelegt hätte, statt was sie abgelegt hat. |
reach | PublicationReach | ja | Wie weit eine Veröffentlichung gereicht hat. Diese Antworten reichen ganz über diese Maschine hinaus — was sie anhängen, ist das, was jeder Konsument dieser Registry auflöst —, daher nennt jede jede Registry, die sie angesprochen hat, und ob der Aufruf dort etwas angehängt hat. |
Zusätzliche Eigenschaften sind nicht zulässig.
SignArtifactsResult
Was signiert wurde und wo die Signaturen abgelegt wurden.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
signed | SignedArtifact[] oder null | ja | Jede Referenz, die signiert wurde. |
reach | PublicationReach | ja | Wie weit eine Veröffentlichung gereicht hat. Diese Antworten reichen ganz über diese Maschine hinaus — was sie anhängen, ist das, was jeder Konsument dieser Registry auflöst —, daher nennt jede jede Registry, die sie angesprochen hat, und ob der Aufruf dort etwas angehängt hat. |
Zusätzliche Eigenschaften sind nicht zulässig.
DeprecateArtifactResult
Was als veraltet gekennzeichnet wurde und wo die Markierungen abgelegt wurden.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
marked | DeprecationMarked[] oder null | ja | Jede Version, die gekennzeichnet wurde. |
reach | PublicationReach | ja | Wie weit eine Veröffentlichung gereicht hat. Diese Antworten reichen ganz über diese Maschine hinaus — was sie anhängen, ist das, was jeder Konsument dieser Registry auflöst —, daher nennt jede jede Registry, die sie angesprochen hat, und ob der Aufruf dort etwas angehängt hat. |
Zusätzliche Eigenschaften sind nicht zulässig.
ResolveResult
Wo das Element unter dem Cursor definiert ist.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
location | null oder Location | ja | Wo es definiert ist. Es ist null, wo nichts unter dem Cursor zu einer Definition auflöst. |
Zusätzliche Eigenschaften sind nicht zulässig.
FindReferencesResult
Wo auf das Element unter dem Cursor verwiesen wird.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
locations | Location[] oder null | ja | Jede Stelle, an der darauf verwiesen wird. |
Zusätzliche Eigenschaften sind nicht zulässig.
FindImplementationsResult
Welche Dokumente das Element unter dem Cursor implementieren.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
locations | Location[] oder null | ja | Jede Stelle, an der es implementiert ist. |
Zusätzliche Eigenschaften sind nicht zulässig.
HoverResult
Was über das Element unter dem Cursor angezeigt werden soll.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
contents | null oder MarkupContent | ja | Was angezeigt werden soll. Es ist null, wo es über das, was unter dem Cursor liegt, nichts zu sagen gibt. |
Zusätzliche Eigenschaften sind nicht zulässig.
CompletionResult
Was an der Cursorposition geschrieben werden darf.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
items | CompletionItem[] oder null | ja | Jedes Element, das geschrieben werden darf. |
Zusätzliche Eigenschaften sind nicht zulässig.
CatalogIndexResult
Jede Entität, die der Workspace-Index enthält, und die Links, die aus dem Workspace hinausführen, zu Verzeichnissen und zu Dateien, und die für ihn nicht gelesen wurden.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
entities | CatalogEntity[] oder null | ja | Jede Entität. |
unreadLinkedDirs | string[] | ja | Jeder Link unter der Workspace-Wurzel, der zu einem Verzeichnis außerhalb davon führt, relativ zur Wurzel an der Stelle genannt, an der der Link selbst liegt, in der Reihenfolge, in der der Workspace durchsucht wird. Kein Verzeichnis außerhalb der Wurzel wird durchsucht, daher ist kein Dokument hinter einem dieser Links als eigenes des Workspace unter entities, und ein Client, der Entitäten auflistet, kann sagen, warum. Nicht genannt: ein Link zu einem Verzeichnis innerhalb der Wurzel, das dort durchsucht oder ausgelassen wird, wo es tatsächlich liegt; ein Link überall dort, wo ein Verzeichnis ausgelassen würde, sei es wegen seiner Lage, seines Namens oder einer .gitignore; ein Link, der nicht aufgelöst werden kann, weil er ins Nichts oder im Kreis führt; und, in einer in den Begriffen eines Release gegebenen Antwort, ein Link unter einem Katalogverzeichnis, das nur andere Releases lesen. Leer, wenn der Workspace keinen enthält. |
unreadLinkedFiles | string[] | ja | Jeder Link unter der Workspace-Wurzel, der wie eine YAML-Datei benannt ist, dessen eigener Name auf .yaml oder .yml endet, und der zu einer Datei außerhalb der Wurzel führt, relativ zur Wurzel an der Stelle genannt, an der der Link selbst liegt, in der Reihenfolge, in der der Workspace durchsucht wird. Eine solche Datei wird für den Index nicht gelesen, gleich was sie deklariert, daher ist die Entität, die sie deklariert, nicht als eigene des Workspace unter entities, und ein Client, der Entitäten auflistet, kann sagen, warum; die konfigurierten Katalogverzeichnisse sind der Weg, auf dem Entitäten außerhalb des Workspace gelesen werden. Nicht genannt: ein Link zu einer Datei, die die Workspace-Konfiguration als Release nennt, als build.authoring_release oder als Schlüssel von workspace.releases, und die eines deklariert, die gelesen und unter entities an der eigenen Stelle des Links aufgeführt wird; ein Link zu einer Datei innerhalb der Wurzel, die an der eigenen Stelle des Links gelesen wird; ein Link, den eine .gitignore auslässt, oder einer innerhalb eines Verzeichnisses, das die Suche auslässt; ein Link, der zu keiner Datei führt, sei es zu einem Verzeichnis, das unreadLinkedDirs nennt, wo es aus der Wurzel hinausführt, ins Nichts oder im Kreis; und, in einer in den Begriffen eines Release gegebenen Antwort, ein Link unter einem Katalogverzeichnis, das nur andere Releases lesen. Eine Workspace-Konfigurationsdatei, die ein Link ist, der aus dem Workspace hinausführt, seine eigene .aggrega-config.yaml oder das CI-eigene Overlay daneben, wird genannt, ob die Suche darauf gestoßen ist oder nicht, nach den Links, die die Suche genannt hat: Die Konfiguration des Workspace wird dann überhaupt nicht gelesen, diese Antwort ist der eigene Index des Workspace, ohne Konfiguration gelesen, daher wird kein Katalogverzeichnis dafür gelesen, und jede Anfrage, über die die Konfiguration entscheidet, einschließlich eines Index in den Begriffen eines Release, wird für diesen Workspace mit der Bedingung der Lesesperre abgelehnt. |
Zusätzliche Eigenschaften sind nicht zulässig.
AttachCandidatesResult
Welche Features an die Entität angebunden werden können, und die Labels, anhand derer sie beurteilt wurden; und, für eine Verbindung, die die Anfrage genannt hat, die Slots, die ihr Socket deklariert, mit den Features, die jeden davon füllen können.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
node | string | ja | Die Entität, für die die Kandidaten beurteilt wurden. |
nodeLabels | Map von string oder null | ja | Die Labels, anhand derer die Beurteilung vorgenommen wurde. |
labelSource | string | ja | Welche Label-Menge verwendet wurde, was nicht bloß kosmetisch ist: Die deklarierten Labels eines Dokuments sind das, was ein Lesen der Quelle sehen kann, während die eines Graphknotens die finalisierte Menge sind, anhand derer der Build selbst urteilt. Eine über die zweite berechnete Antwort ist eine Aussage darüber, was der Build tun wird. |
candidates | SourcedEntityRef[] oder null | ja | Jedes Feature, das angebunden werden kann. |
slots | SlotCandidacy[] | nein | Nur vorhanden, wenn die Anfrage eine Verbindung genannt hat: jeder Slot, den der Socket der Verbindung deklariert, in der Reihenfolge, in der die Component sie deklariert, mit den Features, die ihn füllen können. Leer, wenn an der Verbindung kein Slot gefüllt werden kann, und noSlotReason sagt dann, warum — was ein Client liest, statt eine leere Liste als Slots zu verstehen, zu denen kein Feature passte. |
noSlotReason | const “feature-created-connection” oder const “ad-hoc-socket” oder const “no-slot-declared” | nein | Nur vorhanden, wenn die Anfrage eine Verbindung genannt hat und an ihr kein Slot gefüllt werden kann: warum dort nichts angebunden werden kann. Fehlt überall dort, wo der Socket einen Slot deklariert. Die Menge ist geschlossen. Zulässige Werte: "feature-created-connection" — Ein Feature hat die Verbindung gezogen, und eine Anbindung wird nur an einer Verbindung geschrieben, die eine Komponente oder das Release zieht. "ad-hoc-socket" — Der Socket ist einer, den die Component nicht deklariert, daher deklariert sie keinen Slot, den eine Verbindung füllen könnte. "no-slot-declared" — Die Component deklariert den Socket und deklariert keinen Slot an ihm. |
Zusätzliche Eigenschaften sind nicht zulässig.
ConnectionCandidatesResult
Mit welchen Entitäten jeder Socket an der Entität verbunden werden kann.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
node | string | ja | Die Entität, deren Sockets dies sind. |
adHocSocketsAccepted | boolesch | ja | Ob ein Socket, den die eigene Definition der Entität nicht vorab deklariert, dennoch verfasst werden darf. |
sockets | SocketCandidacy[] oder null | ja | Jeder Socket und was damit verbunden werden kann. |
Zusätzliche Eigenschaften sind nicht zulässig.
InsertionPointResult
Wo im Dokument ein neuer Eintrag unter dem benannten Container hingehört, und was ein Client braucht, um ihn dort zu schreiben: den Punkt selbst, ob ein Zeilenumbruch den Text einleiten muss, die noch fehlenden Container-Schlüssel und die Einrückung, die jede Zeile erhält.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
file | string | ja | Das Dokument. |
container | string[] oder null | ja | Der Pfad durch das Dokument zum Container. |
positionEncoding | string | ja | Die Kodierung, in der die Positionen in dieser Antwort ausgedrückt sind. |
position | Position | ja | Eine Stelle in einem Dokument: eine Zeile und ein Zeichenoffset darin, beide ab null gezählt. Der Offset wird in den Einheiten der Kodierung gemessen, auf die sich die Sitzung beim Öffnen geeinigt hat; das ist UTF-16, sofern der Client nicht eine andere angefordert hat. |
precededByLineBreak | boolesch | ja | Ob der an der Position geschriebene Text mit einem Zeilenumbruch beginnen muss, weil die Position am Ende einer Zeile liegt, die das Dokument bereits enthält. Es ist nur dort false, wo das Dokument nichts enthält, worauf der Eintrag folgen könnte. |
missingContainerKeys | string[] oder null | ja | Die Segmente des Container-Pfads, die das Dokument noch nicht enthält, das äußerste zuerst. Jedes muss als eigener Schlüssel geschrieben werden, eine Stufe weiter eingerückt als das vorherige, bevor der Eintrag in das innerste hineingehen kann. Es ist null, wo der ganze Pfad bereits vorhanden ist. |
entryIndent | integer | ja | Die Spalte, in der die eigene erste Zeile des Eintrags beginnt, in Leerzeichen ab dem Zeilenanfang gezählt. |
indentStep | integer | ja | Um wie viel weiter jede Verschachtelungsebene eingerückt wird. |
indentStepMeasured | boolesch | ja | Ob die Schrittweite an der eigenen Verschachtelung dieses Dokuments gemessen wurde. Wo es false ist, zeigt das Dokument keine Verschachtelung, die sich messen ließe, und die Schrittweite ist ein Ersatzwert, sodass ein Client, der lieber seine eigene vorgibt, weiß, dass ihm das freisteht. |
entryShape | const “mapping” oder const “sequence” oder const “unknown” | ja | Die Form, in der der Container seine Einträge trägt, was darüber entscheidet, wie der eigene Text des Eintrags zusammengesetzt wird. Sie wird an dem Container abgelesen, den das Dokument bereits enthält, und nie daraus abgeleitet, wie der Container heißt. Die Menge ist geschlossen. Zulässige Werte: "mapping" — Der Container ist ein Block-Mapping, daher ist ein ihm angefügter Eintrag ein Schlüssel und sein Wert. "sequence" — Der Container ist eine Block-Sequenz, daher ist ein ihm angefügter Eintrag ein Bindestrich und sein Wert. "unknown" — Das Dokument enthält den Container nicht oder enthält ihn ohne Inhalt, daher ist es Sache des Clients, zu entscheiden, welche Form ein Eintrag annimmt. |
Zusätzliche Eigenschaften sind nicht zulässig.
AttachmentContainerResult
In welches Dokument und an welche Stelle darin eine Anbindung am Graphknoten oder an der Verbindung, die die Anfrage genannt hat, gehört.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
node | string | ja | Der Graphknoten, für den die Anbindung bestimmt ist. |
file | string | ja | Das Dokument, in das die Anbindung gehört. |
container | string[] oder null | ja | Der Pfad durch dieses Dokument zu der Stelle, an die sie gehört. |
Zusätzliche Eigenschaften sind nicht zulässig.
ConnectionAtPositionResult
Die Verbindung, in deren Eintrag die Position fällt, oder warum keine gemeldet wird. Genau eine Hälfte ist vorhanden: graphNode und connection zusammen oder noConnectionReason allein. Eine Position irgendwo innerhalb eines Eintrags — auf seinem Alias, seinem Ziel oder seinen Anbindungen — liegt innerhalb dieses Eintrags, des innersten, wo Einträge verschachtelt sind; eine Position auf dem eigenen Schlüssel eines Sockets, oberhalb der darunter geschriebenen Einträge, liegt in keinem.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
graphNode | string | nein | Die ID des Knotens, dessen Komponente die Verbindung zieht, so wie der kompilierte Graph ihn schlüsselt — der Wert, den die Kandidaten- und Container-Anfragen als graphNode entgegennehmen. |
connection | ConnectionCoordinate | nein | Die Verbindung, über ihren Socket und ihren Alias, wobei document das Dokument nennt, in dem die Position gelesen wurde — der Wert, den die Kandidaten- und Container-Anfragen als connection entgegennehmen. |
noConnectionReason | const “no-connection-entry” oder const “feature-created-connection” oder const “unknown-connection” | nein | Nur vorhanden, wo keine Verbindung gemeldet wird: warum. Die Menge ist geschlossen. Zulässige Werte: "no-connection-entry" — Die Position liegt auf keinem Eintrag, in dem eine Anbindung geschrieben wird: weder einer Verbindung, die eine Komponente zieht, geschrieben unter ihrem Alias, noch einem Eintrag pro Kante im Release. Eine als Liste von Zielen geschriebene Verbindung und eine, die ein Feature mit seinem eigenen Block zieht, tragen keinen solchen Eintrag. "feature-created-connection" — Die Position liegt auf dem Eintrag des Release für eine Verbindung, die ein Feature gezogen hat, und eine Anbindung wird nur an einer Verbindung geschrieben, die eine Komponente oder das Release zieht. "unknown-connection" — Die Position liegt auf einem Eintrag, den das Release für eine Verbindung schreibt, die der kompilierte Graph nicht enthält. |
Zusätzliche Eigenschaften sind nicht zulässig.
ReleaseCandidatesResult
Die Releases, die der Workspace enthält, und die Links, die aus ihm hinausführen, zu Verzeichnissen und zu Dateien, und die für sie nicht gelesen wurden.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
releases | string[] oder null | ja | Jedes Release-Dokument. |
lockfiles | Map von string | ja | Das Lockfile jedes aufgeführten Release, nach dem Release geschlüsselt, genau so, wie es aufgeführt ist. Jedes ist die Datei, die ein Pull für dieses Release schreibt und ein Build liest, sodass ein Client liest, wo sie liegt, statt es herzuleiten. Leer, wenn der Workspace kein Release enthält. |
unreadLinkedDirs | string[] | ja | Jeder Link unter der Workspace-Wurzel, der zu einem Verzeichnis außerhalb davon führt, relativ zur Wurzel an der Stelle genannt, an der der Link selbst liegt, in der Reihenfolge, in der der Workspace durchsucht wird. Kein Verzeichnis außerhalb der Wurzel wird durchsucht, daher ist ein Release, das nur über einen dieser Links erreicht wird, nicht in releases, und ein Client, der Releases anbietet, kann sagen, warum. Nicht genannt: ein Link zu einem Verzeichnis innerhalb der Wurzel, das dort durchsucht oder ausgelassen wird, wo es tatsächlich liegt; ein Link überall dort, wo ein Verzeichnis ausgelassen würde, sei es wegen seiner Lage oder seines Namens; und ein Link, der nicht aufgelöst werden kann, weil er ins Nichts oder im Kreis führt. Leer, wenn der Workspace keinen enthält. |
unreadLinkedFiles | string[] | ja | Jeder Link unter der Workspace-Wurzel, der wie eine YAML-Datei benannt ist, dessen eigener Name auf .yaml oder .yml endet, und der zu einer Datei außerhalb der Wurzel führt, relativ zur Wurzel an der Stelle genannt, an der der Link selbst liegt, in der Reihenfolge, in der der Workspace durchsucht wird. Eine solche Datei wird nicht gelesen, daher ist ein Release, das nur über einen dieser Links erreicht wird, nicht in releases, und ein Client, der Releases anbietet, kann sagen, warum. Ob eine Datei ein Release ist, ist ohne Lesen nicht bekannt, daher wird jeder solche Link genannt, gleich was die Datei enthält. Nicht genannt: ein Link zu einer Datei, die die Workspace-Konfiguration als Release nennt, als build.authoring_release oder als Schlüssel von workspace.releases, die gelesen und unter releases an der eigenen Stelle des Links aufgeführt wird; ein Link zu einer Datei innerhalb der Wurzel, die gelesen wird; ein Link innerhalb eines Verzeichnisses, das die Suche auslässt; und ein Link, der zu keiner Datei führt, sei es zu einem Verzeichnis, das unreadLinkedDirs nennt, wo es aus der Wurzel hinausführt, ins Nichts oder im Kreis. Eine Workspace-Konfigurationsdatei, die ein Link ist, der aus dem Workspace hinausführt, seine eigene .aggrega-config.yaml oder das CI-eigene Overlay daneben, wird genannt, ob die Suche darauf gestoßen ist oder nicht, nach den Links, die die Suche genannt hat: Die Konfiguration des Workspace wird dann überhaupt nicht gelesen, diese Antwort wird ohne Konfiguration gelesen, daher wird kein Release aufgeführt, das die Konfiguration über einen Link nennt, und jede Anfrage, über die die Konfiguration entscheidet, wird für diesen Workspace mit der Bedingung der Lesesperre abgelehnt. |
Zusätzliche Eigenschaften sind nicht zulässig.
ActiveReleaseResult
Mit welchem Release ein Client standardmäßig arbeiten soll. Ein Workspace, der auf kein Release zeigt, ist ein gewöhnlicher Zustand und kein Fehlschlag, daher wird er hier mit einer Darstellung gemeldet, wie die Wahl versucht wurde, statt als Fehler ausgelöst zu werden.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
release | string | ja | Das Release, auf das die Wahl gefallen ist, oder leer, wo sie auf keines gefallen ist. |
lockfile | string | nein | Das Lockfile des Release, auf das die Wahl gefallen ist: die Datei, die ein Pull dafür schreibt und ein Build liest. Fehlt, wo die Wahl auf kein Release gefallen ist. |
reason | string | nein | Warum die Wahl auf kein Release gefallen ist. |
trace | string | nein | Jeder Schritt der Wahl und was er gefunden hat, sodass ein Aufrufer sehen kann, welcher sie entschieden hätte. |
Zusätzliche Eigenschaften sind nicht zulässig.
EditDocumentResult
Was die Bearbeitung geschrieben hat, und wo. Nach einem Schreibvorgang wird die Lesung des Dokuments, die der Daemon vorhält, verworfen, sodass die nächste Antwort dazu aus den Bytes berechnet wird, die die Bearbeitung erzeugt hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
file | string | ja | Das Dokument, das bearbeitet wurde. |
edit | string | ja | Welche Bearbeitung angewendet wurde. |
container | string[] oder null | ja | Der Pfad durch das Dokument zu der Stelle, an der die Bearbeitung gelandet ist. |
createdContainers | string[] oder null | ja | Die Container, die die Bearbeitung unterwegs anlegen musste. |
written | string[] oder null | ja | Die Dokumente, die geschrieben wurden. |
content | string | ja | Das zusammengesetzte Dokument, für eine Anfrage, die verlangt hat, das Ergebnis angezeigt zu bekommen, statt es schreiben zu lassen. |
Zusätzliche Eigenschaften sind nicht zulässig.
EffectiveConfigurationResult
Die Konfiguration, die der Workspace aufgelöst hat, und aus welchem Dokument jede Einstellung stammt.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
layers | string[] oder null | ja | Die Konfigurationsdokumente, die zusammengeführt wurden, in der Reihenfolge, in der sie zusammengeführt wurden. |
settings | EffectiveConfigurationSetting[] oder null | ja | Jede aufgelöste Einstellung und woher sie stammt. |
Zusätzliche Eigenschaften sind nicht zulässig.
ConfigInitResult
Was das Anlegen einer Konfiguration geschrieben hat, wo, und was es aus der Registry gelesen hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
host | string | ja | Die Registry, für die die Konfiguration angelegt wurde. |
scope | ConfigWriteScope | ja | Welches Konfigurationsdokument geschrieben wurde und wie weit es reicht. Eine Anfrage nennt einen Workspace, daher würde eine Antwort, die nichts sagt, so gelesen, als beträfe sie diesen Workspace — und für einen maschinenweiten Schreibvorgang ist diese Lesart falsch. |
trust | TrustFetchOutcome | ja | Was das Lesen der angekündigten Vertrauensrichtlinie einer Registry bewirkt hat. Die Ergebnisse werden auseinandergehalten, weil sie Verschiedenes bedeuten: Die angekündigte Richtlinie wurde übernommen, die Registry hat nichts angekündigt — was kein Fehlschlag ist —, an ihrer Stelle wurde die eingebaute Grundlinie gepinnt, oder es wurde kein Lesen versucht. Wo nichts angekündigt wurde, wird daneben angegeben, ob die Registry überhaupt erreicht werden konnte. |
written | boolesch | ja | Ob das Dokument geschrieben wurde, statt zurückgegeben zu werden, damit der Aufrufer es ablegt. |
existed | boolesch | nein | Vorhanden und true, wenn das Dokument bereits vorhanden war, sodass der Registry-Eintrag darin zusammengeführt wurde, statt ein neues Dokument anzulegen. Nur eine Anfrage, die force sendet, fährt über ein vorhandenes Dokument hinweg fort, daher fehlt es in jeder Antwort auf eine Anfrage, die das nicht getan hat. |
content | string | nein | Der Text des Dokuments, für eine Anfrage, die verlangt hat, ihn angezeigt zu bekommen, statt ihn schreiben zu lassen. |
Zusätzliche Eigenschaften sind nicht zulässig.
ConfigCaptureResult
Was das Einfrieren der aufgelösten Konfiguration in das eigene Dokument dieses Workspace geschrieben hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
configFile | string | ja | Das Dokument, das geschrieben wurde. Es ist immer das eigene dieses Workspace, da der ganze Zweck darin besteht, einen Workspace in sich geschlossen zu machen. |
workspaceRoot | string | ja | Der Workspace, den die Anfrage genannt hat. |
captured | boolesch | ja | Ob etwas eingefroren wurde. |
sockets | ConfigCapturedSocket[] oder null | ja | Jeder Socket, der eingefroren wurde, mit seinen Anbindungen. |
catalogDirs | string[] oder null | ja | Die Katalogverzeichnisse, die eingefroren wurden. |
Zusätzliche Eigenschaften sind nicht zulässig.
ImportResult
Was die Umwandlung einer fremden Quelle erzeugt hat und was sie nicht umwandeln konnte.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
format | string | ja | Das Quellformat, das umgewandelt wurde. |
outputDir | string | ja | Das Verzeichnis, zu dem jeder Pfad in der Antwort relativ ist, und dasjenige, in das die Dateien geschrieben wurden. |
written | string[] oder null | ja | Jede Datei, die auf der Festplatte angekommen ist, in der Reihenfolge des Schreibens: die Entwürfe, dann der Datensatz dessen, was der Import geschrieben hat. Unter sync nur die Entwürfe, die die Synchronisierung geändert hat, und der Datensatz, wo er sich geändert hat. Leer unter dryRun. |
files | ImportedFile[] oder null | ja | Jede Datei, die die Anfrage schreibt, mit ihrem Text, unter dryRun und ohne: jeder Entwurf, dann der Datensatz dessen, was der Import geschrieben hat. Unter sync jeder Entwurf, den die Synchronisierung ändert, mit seinem neuen Text, dann der Datensatz, wo auch er sich ändert, sodass eine Synchronisierung, die bereits auf dem Stand ist, mit einer leeren Liste antwortet. |
drift | ImportDrift[] | ja | Jeder Teil, den eine Synchronisierung auf den Stand der Quelle gebracht hat oder unter dryRun bringen würde, in der Reihenfolge, in der der Entwurf sie nennt; eine entworfene Datei, die die Synchronisierung löscht, ist einer davon, entfernt ohne Schlüssel. Eine leere Liste für eine Anfrage, die keine Synchronisierung ist, für eine Synchronisierung, die bereits auf dem Stand ist, und für eine Synchronisierung, deren Umwandlung angehalten hat und die nichts schreibt. |
diagnostics | ImportDiagnostic[] oder null | ja | Was nicht umgewandelt werden konnte. |
decisions | ImportDecision[] | ja | Wie der Importer jeden Quellknoten abgebildet hat, in der Reihenfolge des Importers und genau so, wie er es gemeldet hat: das, was Ihnen sagt, wo die Umwandlung geraten hat. Wird bei beiden Zustellungsarten getragen und unabhängig davon, ob die Umwandlung angehalten hat, und ist eine leere Liste für einen Importer, der keine meldet. |
owed | ImportOwed[] | nein | Jeder Wert, den die Entwürfe noch leer lassen und den weder eine Quelle liefern konnte noch eine Antwort geliefert hat, in der Reihenfolge, in der die Entwürfe geschrieben werden — die Werte, die die Warnungsbefunde nennen. Jede Antwort enthält dieses Feld, als leere Liste, wo die Entwürfe nichts schuldig bleiben. |
halted | boolesch | ja | Ob die Umwandlung angehalten hat, statt mit Befunden abzuschließen. |
Zusätzliche Eigenschaften sind nicht zulässig.
ScaffoldEntityResult
Das entworfene Startdokument, die Liste der ausführbaren Beispiele oder das geschriebene Beispiel — jede Form antwortet mit ihren eigenen Feldern und lässt die anderen weg.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
kind | string | nein | Die Art der Entität, die entworfen wurde. Bei einem Entwurf vorhanden. |
skeleton | string | nein | Der Text des entworfenen Dokuments. Bei einem Entwurf vorhanden. |
examples | ScaffoldExample[] | nein | Jedes ausführbare Beispiel, das die Dokumentation veröffentlicht, jedes einmal, in Namensreihenfolge. Bei einer Auflistung vorhanden, die welche gefunden hat. |
example | string | nein | Das Beispiel, das geschrieben wurde. Bei einem Schreibvorgang vorhanden. |
dir | string | nein | Das Verzeichnis, in das das Beispiel geschrieben wurde, relativ zur Workspace-Wurzel, so wie die Anfrage es genannt hat, oder, wo sie keines genannt hat, als Name des Beispiels. Bei einem Schreibvorgang vorhanden. |
files | string[] | nein | Jede geschriebene Datei, relativ zu dir und durch Schrägstriche getrennt, in der Reihenfolge, in der die Dokumentation sie führt. Bei einem Schreibvorgang vorhanden. |
next | string[] | nein | Die Befehle, die die Seite des Beispiels für seinen Build angibt, Zeile für Zeile, wie die Seite sie schreibt, einschließlich Kommentaren: der erste Shell-Block unter ihrer Überschrift Build. Fehlt, wo die Seite keine angibt. |
version | string | nein | Die Version der Dokumentation, aus der das Beispiel gelesen wurde: die eigene des Binary, wo für es eine veröffentlicht ist, andernfalls die neueste, die vor ihm veröffentlicht wurde. Bei einem Schreibvorgang vorhanden. |
Zusätzliche Eigenschaften sind nicht zulässig.
ScaffoldExample
Ein ausführbares Beispiel, das die Dokumentation veröffentlicht.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
name | string | ja | Der Name des Beispiels, den eine Anfrage als example sendet, um es zu schreiben. |
level | string | ja | Die Stufe, die die Seite des Beispiels dafür deklariert. |
summary | string | ja | Der erste Satz der Seite des Beispiels. |
Zusätzliche Eigenschaften sind nicht zulässig.
LintResult
Was die Konventionsprüfung gefunden hat, nach Schweregrad gezählt und pro Dokument aufgeführt. Eine Prüfung des gesamten Katalogs, die einmal für jedes Release ausgeführt wurde, trägt außerdem passes; die Zählungen und files umfassen dann alle Durchläufe zusammen.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
entity | string | nein | Die eine Entität, die geprüft wurde, sofern die Anfrage eine genannt hat. |
release | string | nein | Das Release, dessen Abschluss geprüft wurde, sofern die Anfrage eines genannt hat. |
checked | integer | ja | Wie viele Dokumente geprüft wurden. Wo die Prüfung einmal für jedes Release ausgeführt wurde, die Summe über die Durchläufe: Ein Dokument, das zwei Durchläufe lesen, wird in jedem gezählt. |
findings | integer | ja | Wie viele Befunde es insgesamt gibt. |
errors | integer | ja | Wie viele davon Fehler sind. |
warnings | integer | ja | Wie viele davon Warnungen sind. |
infos | integer | ja | Wie viele davon informativ sind. |
files | LintFileFindings[] oder null | ja | Die Befunde, pro Dokument. |
halted | boolesch | ja | Ob die Prüfung angehalten hat, statt mit Befunden abzuschließen. |
passes | LintPass[] oder null | nein | Die Prüfung des gesamten Katalogs Durchlauf für Durchlauf, nur vorhanden, wo sie einmal für jedes Release ausgeführt wurde, weil der Workspace Releases unter workspace.releases nennt. Jeder Durchlauf sagt, für welche Releases seine Befunde gefunden wurden. Fehlt für einen Workspace, der keine nennt und einmal über seine eigenen Verzeichnisse geprüft wird, und für eine Prüfung einer einzelnen Entität oder des Abschlusses eines Release. |
Zusätzliche Eigenschaften sind nicht zulässig.
LintPass
Ein Durchlauf einer Konventionsprüfung des gesamten Katalogs in einem Workspace, der seinen Releases eigene Katalogverzeichnisse gibt: die Releases, für die er ausgeführt wurde, die Verzeichnisse, die er gelesen hat, und was er dort gefunden hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
releases | string[] oder null | ja | Die Releases, für die der Durchlauf ausgeführt wurde, jedes als Pfad relativ zur Workspace-Wurzel. Releases, die dieselben Katalogverzeichnisse lesen, teilen sich einen Durchlauf. |
catalogDirs | string[] oder null | ja | Die Katalogverzeichnisse, die der Durchlauf gelesen hat, in der Reihenfolge, in der sie durchsucht werden, jedes relativ zur Workspace-Wurzel, wo es innerhalb davon liegt. Leer, wo seine Releases kein Katalogverzeichnis lesen, sodass der Durchlauf nichts geprüft hat und keinen der anderen hat scheitern lassen. |
checked | integer | ja | Wie viele Dokumente der Durchlauf geprüft hat. |
findings | integer | ja | Wie viele Befunde der Durchlauf gefunden hat. |
errors | integer | ja | Wie viele davon Fehler sind. |
warnings | integer | ja | Wie viele davon Warnungen sind. |
infos | integer | ja | Wie viele davon informativ sind. |
files | LintFileFindings[] oder null | ja | Die Befunde des Durchlaufs, pro Dokument. |
Zusätzliche Eigenschaften sind nicht zulässig.
PluginAddResult
Was das Anbinden eines Plugins geschrieben hat, wo, und welche Version es gepinnt hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
type | string | ja | Der Socket, an den das Plugin angebunden wurde. |
identity | string | nein | Die Identität, zu der sich die Anbindung aufgelöst hat. |
uri | string | nein | Die Referenz, aus der sich die Anbindung auflöst. |
capability | string | nein | Die Fähigkeit, für die die Anbindung bestimmt ist. |
reference | string | nein | Die gepinnte Referenz, einschließlich Version. |
scope | PluginWriteScope | ja | In welches Konfigurationsdokument eine Plugin-Änderung geschrieben wurde und wie weit sie reicht. Der eigene Standard des Befehlserweiterungs-Sockets ist das maschinenweite Dokument, daher sagt jede Antwort, welches sie geschrieben hat. |
written | boolesch | ja | Ob das Konfigurationsdokument geschrieben wurde, statt zurückgegeben zu werden, damit der Aufrufer es ablegt. |
content | string | nein | Der Text des Konfigurationsdokuments, für eine Anfrage, die verlangt hat, ihn angezeigt zu bekommen, statt ihn schreiben zu lassen. |
retraction | PluginRetraction | nein | Wie eine Deprecation-Markierung bestimmt hat, welche Plugin-Version gepinnt wurde. |
withdrawn | boolesch | nein | Ist true, wenn die Abfrage die festgelegte Version genannt hat und eine Rücknahme, der dieser Workspace vertraut, diese Version zurückgezogen hat. Eine genannte Version wird trotzdem festgelegt, weil das Nennen die Überschreibung ist. Andernfalls nicht vorhanden, und das Fehlen bedeutet nicht, dass die Version nicht zurückgezogen ist: Wo die Rückzugsmarkierungen einer genannten Version nicht gelesen werden konnten, nennt retraction.unscreened den Grund, und ohne genannte Version wird die neueste veröffentlichte Version gewählt, und retraction meldet, zu welchem Ergebnis die Rückzugsprüfung für diese Wahl gekommen ist. |
Zusätzliche Eigenschaften sind nicht zulässig.
PluginRemoveResult
Was das Lösen eines Plugins geschrieben hat, und wo.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
type | string | ja | Der Socket, an den das Plugin angebunden wurde. |
query | string | ja | Welche Anbindung entfernt wurde. |
scope | PluginWriteScope | ja | In welches Konfigurationsdokument eine Plugin-Änderung geschrieben wurde und wie weit sie reicht. Der eigene Standard des Befehlserweiterungs-Sockets ist das maschinenweite Dokument, daher sagt jede Antwort, welches sie geschrieben hat. |
Zusätzliche Eigenschaften sind nicht zulässig.
PluginSyncResult
Was der Abgleich der maschinenverwalteten Datensätze einer Plugin-Entität mit ihrem Modul geändert hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
entity | string | ja | Das Plugin-Entitätsdokument, das abgeglichen wurde. |
hostFunctions | string[] oder null | ja | Die Host-Funktionen, die das Modul nach eigener Deklaration benötigt. |
commands | PluginCLICommand[] oder null | ja | Die Befehle, die das Modul beisteuert. |
changed | boolesch | ja | Ob sich im Dokument tatsächlich etwas bewegt hat. |
Zusätzliche Eigenschaften sind nicht zulässig.
PluginGenCatalogResult
Die Katalogdokumente, die eine Generierung erzeugt hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
documents | PluginGeneratedDocument[] | nein | Jedes generierte Dokument und sein Text. |
notices | string | nein | Alles, was die Generierung den Aufrufer wissen lassen möchte. |
dryRun | boolesch | ja | Ob die Dokumente zurückgegeben statt geschrieben wurden. |
Zusätzliche Eigenschaften sind nicht zulässig.
ExplainErrorResult
Was der Compiler über eine Bedingung deklariert, und die veröffentlichten Abschnitte, die die Authoring-Korrektur lehren.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
shortCode | string | ja | Der Kurzcode der Bedingung. |
code | string | ja | Der beschreibende Name der Bedingung. |
message | string | ja | Was die Bedingung sagt, wenn sie ausgelöst wird. |
entries | ExplainErrorEntry[] | nein | Die veröffentlichten Abschnitte, die die Korrektur lehren. |
reference | string | ja | Die veröffentlichte Adresse, unter der die Bedingung erklärt wird. |
note | string | nein | Warum die veröffentlichten Abschnitte fehlen, wo sie nicht beschafft werden konnten. Was das Binary selbst deklariert, wird trotzdem beantwortet. |
Zusätzliche Eigenschaften sind nicht zulässig.
GetSchemaResult
Das Schema einer Art oder — wo die Anfrage keine genannt hat — welche Arten genannt werden können. Die beiden Breiten laufen über eine Antwort statt über zwei Methoden, weil „was darf ich nennen“ und „von welchen davon schreibt ein Autor Dokumente“ dieselbe Frage in zwei Breiten sind und zwei Antworten in Übereinstimmung gehalten werden müssten.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
kind | string | nein | Die Art, für die das Schema gilt. |
schema | any | nein | Das Schema selbst, so durchgereicht, wie das Binary es vorhält. |
kinds | string[] | nein | Jedes Token, auf das dieses Binary antwortet. |
entityKinds | EntityKindDescriptor[] | nein | Die engere Menge, von der ein Autor ein Dokument schreibt, wobei jede Art das Token, das eine Anfrage nennt, mit der Art paart, die der eigene Header des Dokuments deklariert. |
Zusätzliche Eigenschaften sind nicht zulässig.
SkillsInstallResult
Was die Installation des Assistenten-Skills geschrieben hat, und wo.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
skill | string | ja | Der Skill, der geschrieben wurde. |
installed | SkillsInstalledFolder[] | ja | Jeder geschriebene Skill-Ordner, in der Reihenfolge, in der die Anfrage die Assistenten genannt hat. Assistenten, die einen gemeinsamen Ordner lesen, teilen sich einen Eintrag, weil der Skill dort einmal geschrieben wird. |
scope | SkillFolderScope | ja | Wie weit eine Skill-Installation reicht. Eine Anfrage nennt einen Workspace, daher würde eine Antwort, die nichts sagt, so gelesen, als beträfe sie diesen Workspace — und für die benutzerbezogenen Ordner, die ein Assistent in jedem Projekt liest, ist diese Lesart falsch. |
Zusätzliche Eigenschaften sind nicht zulässig.
SkillsInstalledFolder
Ein Skill-Ordner, den eine Installation geschrieben hat.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
agents | string[] | ja | Die Bezeichner der genannten Assistenten, die diesen Ordner lesen, in der Reihenfolge, in der die Anfrage sie genannt hat. |
folder | string | ja | Der Ordner des Skills, als absoluter Pfad. |
replaced | boolesch | ja | Ob eine Kopie mit der Kommentarzeile, die jede geschriebene Kopie des Skills trägt — eine, die eine frühere Installation geschrieben hat, oder eine aus dem veröffentlichten Skills-Repository —, vorhanden war und ersetzt wurde. Eine dortige Datei ohne diese Zeile wird abgelehnt statt ersetzt. |
Zusätzliche Eigenschaften sind nicht zulässig.
SkillsListResult
Die Skills, die das Binary mitbringt, und jeder Assistent, für den eine Installation sie schreiben kann. Nichts wird geschrieben und nichts wird erreicht.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
skills | SkillsListedSkill[] | ja | Jeder Skill, den das Binary mitbringt, in einer festen Reihenfolge. |
agents | SkillsListedAgent[] | ja | Jeder Assistent, für den eine Installation einen Skill-Ordner kennt, nach Bezeichner geordnet. |
Zusätzliche Eigenschaften sind nicht zulässig.
SkillsListedSkill
Ein Skill, den das Binary mitbringt.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
name | string | ja | Der Name des Skills, der auch der Name des Ordners ist, den eine Installation schreibt. |
description | string | ja | Wann ein Assistent den Skill verwendet, wie der Skill selbst es deklariert. |
Zusätzliche Eigenschaften sind nicht zulässig.
SkillsListedAgent
Ein Assistent, für den eine Installation einen Skill schreiben kann, mit den beiden Ordnern, aus denen er Skills liest.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
id | string | ja | Der Bezeichner, mit dem eine Anfrage den Assistenten nennt. |
name | string | ja | Der eigene Name des Assistenten. |
projectFolder | string | ja | Der Ordner, relativ zur Wurzel eines Projekts und durch Schrägstriche getrennt, aus dem der Assistent die Skills eines Projekts liest. Eine Projektinstallation schreibt den Ordner des Skills darin, in dem Workspace, den die Anfrage nennt. |
userFolder | string | ja | Der Ordner, relativ zum Home-Verzeichnis und durch Schrägstriche getrennt, aus dem der Assistent die eigenen Skills des Benutzers in jedem Projekt liest. Eine Installation mit global schreibt den Ordner des Skills darin. |
Zusätzliche Eigenschaften sind nicht zulässig.