Schéma du protocole de communication du daemon en arrière-plan d’Aggrega
Référence générée. Ne pas modifier à la main — régénérer à partir du JSON Schema publié.
Identifiant du schéma : https://aggrega.ai/schemas/serve-wire-v1beta1.schema.json
Les formes des messages échangés avec un daemon de compilateur en arrière-plan démarré par aggrega serve. Un client ouvre une session sur ce daemon avec le handshake, et la session est ce qui délimite les réglages et l’espace de travail sur lesquels la conversation a été ouverte ; le daemon est le processus qui répond à une requête, envoie une notification et conserve ce qu’il a lu. Le protocole est JSON-RPC 2.0 sur l’entrée et la sortie standard, chaque message étant délimité par un en-tête Content-Length ; ce document décrit les corps des messages et ni la délimitation ni le transport. Un corps est l’une de quatre choses : une requête que le client envoie, une notification que le client envoie, une notification que le daemon envoie, ou la réponse que le daemon renvoie pour une requête. Trois propriétés de la surface déterminent la façon dont les formes ci-dessous sont écrites. Premièrement, chaque requête admet deux champs en plus de ceux que déclare sa propre méthode — workspaceRoot, qui nomme l’espace de travail sur lequel agit la requête, et workDoneToken, la valeur générée par l’appelant sous laquelle la progression est signalée — de sorte que les deux figurent ici sur chaque objet params de requête, y compris les trois méthodes dont le sujet n’est pas un espace de travail : aggrega/getSchema et aggrega/scaffoldEntity acceptent workspaceRoot et l’ignorent, et aggrega/initialize le lit comme l’espace de travail que déclare la session. Deuxièmement, le daemon refuse un objet params de requête portant un champ que la méthode n’accepte pas, en nommant ce qu’elle accepte, de sorte que chaque objet params est ici fermé à son niveau supérieur ; un objet imbriqué dans une requête n’est pas fermé, car la vérification ne lit que les noms de champs les plus externes. Troisièmement, un résultat est composé par le daemon plutôt que fourni par un appelant, de sorte que les objets de résultat sont fermés à chaque niveau dont la forme est fixe, et ouverts seulement là où la valeur est du JSON opaque que le daemon transmet sans le lire. Une conséquence de l’encodage du daemon est visible dans les messages transmis et est décrite plutôt que masquée : une collection que le daemon ne marque pas comme facultative est émise sous la forme null lorsqu’elle n’a aucune valeur à signaler et sous la forme d’une collection vide lorsque la valeur qu’elle signale est vide, de sorte que les deux formes sont admises partout où cela s’applique.
L’une des formes suivantes
RequestClientNotificationDaemonNotificationSuccessResponseErrorResponse
Définitions
ProtocolVersion
La version de JSON-RPC que porte chaque message. Seule la 2.0 est parlée.
Type : const "2.0"
Constante : "2.0"
RequestId
L’identifiant de l’appelant pour une requête, renvoyé à l’identique sur la réponse qui y répond. Un message ne portant aucun identifiant est une notification et ne reçoit jamais de réponse.
Type : string or number
ProgressToken
Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée.
Type : string or number
WorkspaceRootSubject
Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée.
Type : string
WorkspaceRootAccepted
Le chemin absolu d’un espace de travail. Le sujet de cette méthode n’est pas un espace de travail — elle répond à partir de ce que le binaire lui-même contient — de sorte que le champ est accepté et non lu. Il est admis afin qu’un client puisse l’envoyer uniformément sur chaque requête sans avoir à savoir quelles méthodes le consultent.
Type : string
RequestMethod
Chaque méthode qu’une requête peut nommer. L’ensemble est fermé : une requête nommant autre chose reçoit en réponse une erreur de méthode introuvable.
Type : string (enum)
Valeurs autorisées : "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
Chaque méthode qu’une notification du client peut nommer. L’ensemble est fermé, et aucune des deux notifications ne reçoit de réponse.
Type : string (enum)
Valeurs autorisées : "$/cancelRequest", "aggrega/shutdown"
DaemonNotificationMethod
Chaque méthode qu’une notification envoyée par le daemon peut nommer. L’ensemble est fermé.
Type : string (enum)
Valeurs autorisées : "$/progress", "aggrega/publishDiagnostics"
Request
Une requête que le client envoie et à laquelle le daemon répond. La méthode nomme ce qui est demandé ; l’objet params porte les champs propres à cette méthode plus les deux que toute méthode admet. Une requête qui omet entièrement params est lue comme une requête dont tous les champs sont absents.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
jsonrpc | ProtocolVersion | oui | La version de JSON-RPC que porte chaque message. Seule la 2.0 est parlée. |
id | RequestId | oui | L’identifiant de l’appelant pour une requête, renvoyé à l’identique sur la réponse qui y répond. Un message ne portant aucun identifiant est une notification et ne reçoit jamais de réponse. |
method | RequestMethod | oui | Chaque méthode qu’une requête peut nommer. L’ensemble est fermé : une requête nommant autre chose reçoit en réponse une erreur de méthode introuvable. |
params | object | non |
Les propriétés supplémentaires ne sont pas autorisées.
params pour chaque method :
method | params | Obligatoire |
|---|---|---|
"aggrega/initialize" | InitializeParams | non |
"aggrega/validate" | ValidateParams | non |
"aggrega/invalidate" | InvalidateParams | non |
"aggrega/diagnostics" | DiagnosticsParams | non |
"aggrega/irGraph" | IrGraphParams | non |
"aggrega/build" | BuildParams | non |
"aggrega/buildPreview" | BuildPreviewParams | non |
"aggrega/entityDefinition" | EntityDefinitionParams | non |
"aggrega/releaseClosure" | ReleaseClosureParams | non |
"aggrega/resolveDependencies" | ResolveDependenciesParams | non |
"aggrega/pin" | PinParams | non |
"aggrega/cacheStatus" | WorkspaceAndProgressParams | non |
"aggrega/cachePrune" | WorkspaceAndProgressParams | non |
"aggrega/cacheEvict" | CacheEvictParams | non |
"aggrega/cacheClear" | WorkspaceAndProgressParams | non |
"aggrega/registryList" | WorkspaceAndProgressParams | non |
"aggrega/search" | SearchParams | non |
"aggrega/registryAdd" | RegistryAddParams | non |
"aggrega/registryRemove" | RegistryRemoveParams | non |
"aggrega/registryUpdate" | RegistryUpdateParams | non |
"aggrega/logout" | LogoutParams | non |
"aggrega/publishEntity" | PublishEntityParams | non |
"aggrega/publishArtifact" | PublishArtifactParams | non |
"aggrega/signArtifacts" | SignArtifactsParams | non |
"aggrega/deprecateArtifact" | DeprecateArtifactParams | non |
"aggrega/resolve" | ResolveParams | non |
"aggrega/findReferences" | FindReferencesParams | non |
"aggrega/findImplementations" | FindImplementationsParams | non |
"aggrega/hover" | HoverParams | non |
"aggrega/completion" | CompletionParams | non |
"aggrega/catalogIndex" | CatalogIndexParams | non |
"aggrega/attachCandidates" | AttachCandidatesParams | non |
"aggrega/connectionCandidates" | ConnectionCandidatesParams | non |
"aggrega/insertionPoint" | InsertionPointParams | non |
"aggrega/attachmentContainer" | AttachmentContainerParams | non |
"aggrega/connectionAtPosition" | ConnectionAtPositionParams | non |
"aggrega/releaseCandidates" | WorkspaceAndProgressParams | non |
"aggrega/activeRelease" | WorkspaceAndProgressParams | non |
"aggrega/setActiveRelease" | SetActiveReleaseParams | non |
"aggrega/editDocument" | EditDocumentParams | non |
"aggrega/effectiveConfiguration" | WorkspaceAndProgressParams | non |
"aggrega/configInit" | ConfigInitParams | non |
"aggrega/configCapture" | ConfigCaptureParams | non |
"aggrega/import" | ImportParams | non |
"aggrega/scaffoldEntity" | ScaffoldEntityParams | non |
"aggrega/lint" | LintParams | non |
"aggrega/pluginAdd" | PluginAddParams | non |
"aggrega/pluginRemove" | PluginRemoveParams | non |
"aggrega/pluginSync" | PluginSyncParams | non |
"aggrega/pluginGenCatalog" | PluginGenCatalogParams | non |
"aggrega/explainError" | ExplainErrorParams | non |
"aggrega/getSchema" | GetSchemaParams | non |
"aggrega/skillsInstall" | SkillsInstallParams | non |
"aggrega/skillsList" | WorkspaceAndProgressParams | non |
ClientNotification
Une notification que le client envoie. Elle ne porte aucun identifiant et ne reçoit jamais de réponse.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
jsonrpc | ProtocolVersion | oui | La version de JSON-RPC que porte chaque message. Seule la 2.0 est parlée. |
method | ClientNotificationMethod | oui | Chaque méthode qu’une notification du client peut nommer. L’ensemble est fermé, et aucune des deux notifications ne reçoit de réponse. |
params | object | non |
Les propriétés supplémentaires ne sont pas autorisées.
params pour chaque method :
method | params | Obligatoire |
|---|---|---|
"$/cancelRequest" | CancelRequestParams | oui |
"aggrega/shutdown" | ShutdownParams | non |
DaemonNotification
Une notification que le daemon envoie. Elle ne porte aucun identifiant et ne reçoit jamais de réponse.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
jsonrpc | ProtocolVersion | oui | La version de JSON-RPC que porte chaque message. Seule la 2.0 est parlée. |
method | DaemonNotificationMethod | oui | Chaque méthode qu’une notification envoyée par le daemon peut nommer. L’ensemble est fermé. |
params | object | oui |
Les propriétés supplémentaires ne sont pas autorisées.
params pour chaque method :
method | params | Obligatoire |
|---|---|---|
"$/progress" | ProgressParams | oui |
"aggrega/publishDiagnostics" | PublishDiagnosticsParams | oui |
CancelRequestParams
Demande au daemon d’abandonner une requête déjà en cours, en la nommant par l’identifiant que portait la requête. Pour une requête déjà terminée, ou jamais envoyée, il n’y a simplement rien à annuler, et rien n’est signalé.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
id | RequestId | oui | L’identifiant de l’appelant pour une requête, renvoyé à l’identique sur la réponse qui y répond. Un message ne portant aucun identifiant est une notification et ne reçoit jamais de réponse. |
Les propriétés supplémentaires ne sont pas autorisées.
ShutdownParams
Demande au daemon de cesser d’accepter du travail et de terminer ce qu’il a déjà pris en charge. La notification ne porte aucun champ, et la notification elle-même est généralement envoyée sans aucun objet params. Une seconde notification abandonne le travail encore en cours au lieu de l’attendre.
Cet objet ne déclare aucune propriété fixe et n’en autorise aucune.
ProgressParams
Un rapport de travail en cours, envoyé uniquement pour une requête qui a généré un jeton de progression dans une session ayant déclaré pouvoir les recevoir.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
token | ProgressToken | oui | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
value | ProgressBegin ou ProgressReport ou ProgressEnd | oui | Le rapport lui-même. Un rapport d’ouverture, puis un nombre quelconque de lignes, puis un rapport de clôture. |
Les propriétés supplémentaires ne sont pas autorisées.
ProgressBegin
Ouvre un rapport, en indiquant ce qui a commencé dans les termes qu’utilise l’opération elle-même.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
kind | const “begin” | oui | Marque ce payload comme l’ouverture d’un rapport. Constante : "begin" |
title | string | oui | Ce qui a commencé. |
Les propriétés supplémentaires ne sont pas autorisées.
ProgressReport
Une ligne du compte rendu que l’opération fait d’elle-même. Elle ne porte aucune fraction : les opérations qui rendent compte ici parcourent un ensemble dont la taille n’est pas connue au début du travail, de sorte qu’une fraction devrait être inventée.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
kind | const “report” | oui | Marque ce payload comme une ligne d’un rapport ouvert. Constante : "report" |
message | string | oui | Une ligne de la sortie propre de l’opération, sans les espaces blancs qui l’entourent. |
Les propriétés supplémentaires ne sont pas autorisées.
ProgressEnd
Clôt un rapport. Il ne porte rien d’autre que le type, car l’issue voyage dans la réponse que l’appelant attend déjà.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
kind | const “end” | oui | Marque ce payload comme la clôture d’un rapport. Constante : "end" |
Les propriétés supplémentaires ne sont pas autorisées.
PublishDiagnosticsParams
Les constats concernant un fichier, envoyés par le daemon lorsqu’une validation les a produits pour un document autre que celui que nommait la requête.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
file | string | oui | Le fichier que concernent les constats. |
diagnostics | Diagnostic[] ou null | oui | Les constats, dans l’ordre où ils ont été produits. |
Les propriétés supplémentaires ne sont pas autorisées.
SuccessResponse
La réponse à une requête qui a abouti, portant l’identifiant de la requête à laquelle elle répond. Une réponse ne porte aucune méthode, de sorte que la forme de résultat applicable est fixée par la requête à laquelle appartient l’identifiant plutôt que par quoi que ce soit dans la réponse elle-même.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
jsonrpc | ProtocolVersion | oui | La version de JSON-RPC que porte chaque message. Seule la 2.0 est parlée. |
id | RequestId | oui | L’identifiant de l’appelant pour une requête, renvoyé à l’identique sur la réponse qui y répond. Un message ne portant aucun identifiant est une notification et ne reçoit jamais de réponse. |
result | InitializeResult ou ValidateResult ou InvalidateResult ou DiagnosticsResult ou IrGraphResult ou BuildResult ou BuildPreviewResult ou EntityDefinitionResult ou ReleaseClosureResult ou ResolveDependenciesResult ou PinResult ou CacheStatusResult ou CachePruneResult ou CacheEvictResult ou CacheClearResult ou RegistryListResult ou SearchResult ou RegistryAddResult ou RegistryRemoveResult ou RegistryUpdateResult ou LogoutResult ou PublishEntityResult ou PublishArtifactResult ou SignArtifactsResult ou DeprecateArtifactResult ou ResolveResult ou FindReferencesResult ou FindImplementationsResult ou HoverResult ou CompletionResult ou CatalogIndexResult ou AttachCandidatesResult ou ConnectionCandidatesResult ou InsertionPointResult ou AttachmentContainerResult ou ConnectionAtPositionResult ou ReleaseCandidatesResult ou ActiveReleaseResult ou EditDocumentResult ou EffectiveConfigurationResult ou ConfigInitResult ou ConfigCaptureResult ou ImportResult ou ScaffoldEntityResult ou LintResult ou PluginAddResult ou PluginRemoveResult ou PluginSyncResult ou PluginGenCatalogResult ou ExplainErrorResult ou GetSchemaResult ou SkillsInstallResult ou SkillsListResult | oui | La réponse, sous la forme que renvoie la méthode demandée. |
Les propriétés supplémentaires ne sont pas autorisées.
ErrorResponse
La réponse à une requête qui a été refusée ou a échoué, portant l’identifiant de la requête à laquelle elle répond.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
jsonrpc | ProtocolVersion | oui | La version de JSON-RPC que porte chaque message. Seule la 2.0 est parlée. |
id | RequestId | oui | L’identifiant de l’appelant pour une requête, renvoyé à l’identique sur la réponse qui y répond. Un message ne portant aucun identifiant est une notification et ne reçoit jamais de réponse. |
error | ErrorObject | oui | Ce qui s’est mal passé : un code sur lequel un client peut aiguiller son traitement, un message écrit pour être lu par une personne et — lorsque la condition en a une — les artefacts et la position dans la source auxquels le message se réfère. |
Les propriétés supplémentaires ne sont pas autorisées.
ErrorObject
Ce qui s’est mal passé : un code sur lequel un client peut aiguiller son traitement, un message écrit pour être lu par une personne et — lorsque la condition en a une — les artefacts et la position dans la source auxquels le message se réfère.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
code | ErrorCode | oui | La condition que signale la réponse. Les codes négatifs sont l’ensemble réservé propre au protocole ; les codes à quatre chiffres sont des conditions que lève ce daemon, chacune nommant un état sur lequel un client peut agir. L’ensemble est fermé. |
message | string | oui | Ce qui s’est mal passé, en prose. C’est la même formulation que porte la même condition sur toute autre surface qui la signale. |
data | ErrorData | non | Les artefacts et la position dans la source auxquels le message se réfère, portés de façon structurée afin qu’un client n’ait pas à les extraire de la prose. Chaque champ est facultatif et une condition ne renseigne que ce dont elle dispose ; aucun champ ne tient lieu d’un autre, de sorte qu’un client apprend ce qu’il a reçu à partir du champ qu’il a lu plutôt que du code qui l’accompagne. |
Les propriétés supplémentaires ne sont pas autorisées.
ErrorCode
La condition que signale la réponse. Les codes négatifs sont l’ensemble réservé propre au protocole ; les codes à quatre chiffres sont des conditions que lève ce daemon, chacune nommant un état sur lequel un client peut agir. L’ensemble est fermé.
Type : 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
Valeurs autorisées :
-32700— Le message n’a pas pu être analysé comme du JSON.-32600— Le message a été analysé mais n’est pas une requête bien formée.-32601— Aucune méthode de ce nom n’existe.-32602— Les params que portait la requête ne sont pas admissibles : un champ que la méthode n’accepte pas, un champ du mauvais type ou une valeur que la méthode refuse.-32603— Le daemon a échoué pendant l’exécution du travail.1001— Le daemon ne détient aucune lecture du fichier et n’en produit aucune. Le client en amorce une en demandant une validation, puis réessaie.1003— Le fichier de verrouillage de la Release que nommait la requête est absent, et l’opération en a besoin.1004— L’entité que nommait la requête n’a pu être résolue ni depuis le catalogue ni depuis la Release que nommait la requête.1005— Le daemon est en cours d’arrêt et refuse tout nouveau travail. Le client ne réessaie pas auprès du même daemon.1006— Une validation du fichier est en cours et ne s’est pas terminée dans le délai que la requête en attente accordait. Le client attend et redemande, sans rien envoyer entre-temps.
ErrorData
Les artefacts et la position dans la source auxquels le message se réfère, portés de façon structurée afin qu’un client n’ait pas à les extraire de la prose. Chaque champ est facultatif et une condition ne renseigne que ce dont elle dispose ; aucun champ ne tient lieu d’un autre, de sorte qu’un client apprend ce qu’il a reçu à partir du champ qu’il a lu plutôt que du code qui l’accompagne.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
file | string | non | Le document source que localisent les champs de position — le document en cours de vérification, ou la Release dont le chargement a échoué. |
line | integer | non | La ligne à laquelle se réfère la condition, comptée à partir de un. |
column | integer | non | La colonne à laquelle se réfère la condition, comptée à partir de un. |
end_line | integer | non | La ligne située une position après la fin du jeton auquel se réfère la condition. Absent là où le jeton n’a pas de fin récupérable, auquel cas un client affiche la position comme un point. |
end_column | integer | non | La colonne située une position après la fin du jeton auquel se réfère la condition. |
release | string | non | La Release à laquelle se réfère la condition, écrite de la façon dont la requête l’a nommée, afin qu’un client puisse composer le remède sans avoir à la réassembler. |
lockfile | string | non | Le fichier de verrouillage que concerne une condition portant sur le fichier de verrouillage : le chemin qui a été cherché et n’a pas été trouvé, ou n’a pas pu être lu. |
unreachable | booléen | non | Indique si le refus porte sur un registre nommé par la requête qui n’a pas pu être atteint : son nom ne s’est pas résolu, une connexion vers lui a été refusée ou n’a pas pu être ouverte, ou une connexion sécurisée vers lui n’a pas pu être établie. Il est lu à partir de l’échec lui-même plutôt que du message, et il n’est défini que là où l’échec montre que le registre n’a jamais été atteint. Un rafraîchissement d’index refusé qui nomme un registre le porte ; un registre qui a répondu, quoi qu’il ait répondu, le laisse absent. |
code | string | non | Le nom descriptif de la condition que nomme le refus, stable d’une version à l’autre : la même valeur que porte dans son propre code un diagnostic signalant cette condition. C’est sur lui qu’un client aiguille son traitement, plutôt que sur le message ou sur le code numérique qui l’accompagne, lequel nomme l’état de la requête et reste ce qu’il est pour chaque condition. Présent exactement lorsque le refus nomme une condition enregistrée, et absent lorsqu’il n’en nomme aucune. |
shortCode | string | non | Le code court de la condition, la lettre E suivie de quatre chiffres : la forme qu’un lecteur cite et recherche, et celle qui ouvre le message d’un refus nommant une condition. Présent exactement lorsque code l’est. |
Les propriétés supplémentaires ne sont pas autorisées.
Diagnostic
Un constat sur un document : où il se trouve, quelle est sa gravité, ce qu’il dit, et le code citable qui nomme la condition qu’il signale.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
line | integer | oui | La ligne que concerne le constat, comptée à partir de un. |
column | integer | oui | La colonne que concerne le constat, comptée à partir de un. |
severity | const “error” ou const “warning” ou const “info” | oui | La gravité du constat. Valeurs autorisées : "error" — Le constat est une erreur. Un constat de plugin de sévérité halt est signalé à ce niveau. "warning" — Le constat est signalé et n’est pas une erreur. Un constat de plugin de sévérité warn est signalé à ce niveau. "info" — Le constat est une information, comme l’est un constat de plugin de sévérité info. |
message | string | oui | Ce que dit le constat, en prose. |
code | string | non | Le nom descriptif de la condition, stable d’une version à l’autre et citable dans une suppression. |
shortCode | string | non | Le code court de la condition, la forme qui ouvre un diagnostic bloquant. |
codeDescription | CodeDescription | non | L’endroit où est expliquée la condition que nomme le constat. |
classification | string | non | La façon dont le constat a été obtenu, là où la condition fait cette distinction. |
suggest | string | non | L’orthographe que propose le constat, là où la condition peut en nommer une — un identifiant presque correct, par exemple. |
keyPath | string | non | Le chemin à travers le document jusqu’à la clé que concerne le constat. |
source | string | oui | Ce qui a produit le constat. |
end_line | integer | non | La ligne située une position après la fin du jeton que concerne le constat, afin qu’un client puisse afficher le jeton entier plutôt qu’un seul caractère. Absent pour un jeton qui s’étend sur plusieurs lignes. |
end_column | integer | non | La colonne située une position après la fin du jeton que concerne le constat. |
Les propriétés supplémentaires ne sont pas autorisées.
CodeDescription
L’endroit où est expliquée la condition que nomme le constat.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
href | string | oui | L’adresse publiée à laquelle la condition est expliquée. |
Les propriétés supplémentaires ne sont pas autorisées.
Position
Un endroit dans un document : une ligne et un décalage de caractère dans celle-ci, tous deux comptés à partir de zéro. Le décalage est mesuré dans les unités de l’encodage dont la session a convenu à son ouverture, qui est UTF-16 sauf si le client en a demandé un autre.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
line | integer | oui | La ligne, comptée à partir de zéro. |
character | integer | oui | Le décalage dans la ligne, compté à partir de zéro, dans les unités de l’encodage dont la session a convenu. |
Les propriétés supplémentaires ne sont pas autorisées.
Range
Une étendue entre deux endroits d’un document.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
start | Position | oui | Un endroit dans un document : une ligne et un décalage de caractère dans celle-ci, tous deux comptés à partir de zéro. Le décalage est mesuré dans les unités de l’encodage dont la session a convenu à son ouverture, qui est UTF-16 sauf si le client en a demandé un autre. |
end | Position | oui | Un endroit dans un document : une ligne et un décalage de caractère dans celle-ci, tous deux comptés à partir de zéro. Le décalage est mesuré dans les unités de l’encodage dont la session a convenu à son ouverture, qui est UTF-16 sauf si le client en a demandé un autre. |
Les propriétés supplémentaires ne sont pas autorisées.
Location
Une étendue dans un document nommé.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
uri | string | oui | Le document dans lequel se trouve l’étendue, adressé sous forme d’URI. |
range | Range | oui | Une étendue entre deux endroits d’un document. |
Les propriétés supplémentaires ne sont pas autorisées.
WorkspaceAndProgressParams
L’objet params d’une méthode qui ne déclare aucun champ propre. Il admet tout de même les deux champs que toute requête admet : l’espace de travail sur lequel elle agit, et un jeton de progression.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
Les propriétés supplémentaires ne sont pas autorisées.
InitializeParams
Ouvre une session sur un espace de travail et indique ce que le client sait traiter. C’est la seule méthode pour laquelle workspaceRoot est une déclaration plutôt qu’un sujet : absent, vide et un chemin sont trois choses différentes, et une session ouverte sans chemin est une session que le client n’a pas encore dirigée vers un espace de travail.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
capabilities | ClientCapabilities | non | Ce que le client sait traiter. Ce qui n’est pas indiqué est considéré comme non pris en charge. Les membres inconnus sont ignorés plutôt que refusés, de sorte qu’un client peut indiquer une capacité que ce daemon ne lit pas encore. |
workspaceRoot | string | non | Le chemin absolu de l’espace de travail à ouvrir. S’il est absent, la session reste sans espace de travail ; une chaîne vide est un chemin fourni par le client et n’équivaut pas à n’en envoyer aucun. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
Les propriétés supplémentaires ne sont pas autorisées.
ClientCapabilities
Ce que le client sait traiter. Ce qui n’est pas indiqué est considéré comme non pris en charge. Les membres inconnus sont ignorés plutôt que refusés, de sorte qu’un client peut indiquer une capacité que ce daemon ne lit pas encore.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
general | object | non | Capacités qui ne sont pas liées à un seul type de réponse. |
window | object | non | Capacités relatives à ce que le client peut afficher pendant qu’un travail est en cours. |
Les propriétés supplémentaires sont autorisées.
ClientCapabilities.general
Capacités qui ne sont pas liées à un seul type de réponse.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
positionEncodings | string[] | non | Les encodages de position que le client sait lire, le meilleur en premier. |
Les propriétés supplémentaires sont autorisées.
ClientCapabilities.window
Capacités relatives à ce que le client peut afficher pendant qu’un travail est en cours.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workDoneProgress | booléen | non | Indique si le client peut recevoir des notifications de progression. Une requête qui génère un jeton de progression dans une session qui ne l’a pas déclaré est refusée. |
Les propriétés supplémentaires sont autorisées.
ValidateParams
Vérifie l’espace de travail, ou un document qu’il contient, et répond avec les constats.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
file | string | non | Le document à vérifier. S’il est absent, ce que contient l’espace de travail est vérifié. |
content | string | non | Le texte du document tel que le client le détient actuellement, pour vérifier un tampon qui n’a pas été enregistré. S’il est absent, les octets sur disque sont lus. |
release | string | non | La Release par rapport à laquelle vérifier, sous forme de chemin relatif à la racine de l’espace de travail. |
Les propriétés supplémentaires ne sont pas autorisées.
InvalidateParams
Indique au daemon qu’un document dont il détient une lecture a changé, de sorte que la prochaine réponse le concernant soit calculée à partir des nouveaux octets.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
file | string | non | Le document qui a changé. |
granularity | string | non | La part de ce que détient le daemon à abandonner : file abandonne uniquement ce qu’il détient pour le document nommé ; workspace, la valeur par défaut et la façon dont toute autre valeur est lue, abandonne en plus ce qu’il détient pour l’ensemble de l’espace de travail. |
Les propriétés supplémentaires ne sont pas autorisées.
DiagnosticsParams
Répond avec les constats que le daemon détient déjà pour un document, sans le vérifier à nouveau.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
file | string | non | Le document sur lequel rendre compte. Le daemon doit déjà en détenir une lecture. |
Les propriétés supplémentaires ne sont pas autorisées.
IrGraphParams
Répond avec le graphe résolu vers lequel une Release se compile, sans en effectuer le rendu.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
release | string | non | La Release à résoudre, sous forme de chemin relatif à la racine de l’espace de travail. Un chemin absolu est refusé. |
unredacted | booléen | non | Indique s’il faut répondre en clair avec les valeurs qu’un auteur a déclarées sensibles. Absent ou false, chacune d’elles est retenue hors du graphe et un marqueur indiquant pourquoi figure à sa place, comme la sortie du graphe de la ligne de commande les retient ; true répond avec le graphe tel que la Release se compile vers lui, ces valeurs comprises. |
Les propriétés supplémentaires ne sont pas autorisées.
BuildParams
Compile une Release et écrit les artefacts rendus dans l’espace de travail.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
release | string | non | La Release à construire, sous forme de chemin relatif à la racine de l’espace de travail. Un chemin absolu est refusé. |
outputParent | string | non | Le répertoire dans lequel le répertoire de sortie est créé, sous forme de chemin relatif à la racine de l’espace de travail. Les artefacts arrivent dans le répertoire de sortie situé en dessous, disposés comme ils le sont sous la racine de l’espace de travail lorsque rien n’est nommé — ce champ nomme donc le parent du répertoire de sortie et jamais le répertoire de sortie lui-même. Absent, ou vide, le répertoire de sortie est écrit sous la racine de l’espace de travail, comme le fait aggrega build quel que soit l’endroit d’où il est exécuté. Un chemin absolu, ou un chemin qui remonte hors de l’espace de travail, est refusé. |
autoPull | booléen | non | Indique s’il faut d’abord résoudre les dépendances de la Release. Le demander atteint les registres configurés et écrit le fichier de verrouillage ; sans demande, la construction n’atteint aucun registre. |
policyInput | string | non | Le répertoire dans lequel écrire, à côté des artefacts, le payload que chaque rôle de gouvernance remet à un plugin rattaché à cet endroit, sous forme de chemin relatif à la racine de l’espace de travail — les fichiers qu’écrit aggrega build --policy-input, sous les mêmes noms, écrits que la construction se termine ou s’arrête. Les avis de la réponse indiquent combien ont été écrits et nomment chaque rôle pour lequel aucun fichier n’a été écrit. Sur une requête qui échoue, les fichiers écrits sont sur le disque et ce bilan ne figure pas dans la réponse : l’erreur ne porte que le refus. Absent, aucun n’est écrit. Un chemin absolu, ou un chemin qui remonte hors de l’espace de travail, est refusé. |
Les propriétés supplémentaires ne sont pas autorisées.
BuildPreviewParams
Compile une Release et indique ce qu’aurait produit l’écriture des artefacts, sans en écrire aucun. Elle décline le champ de résolution des dépendances qu’accepte la construction qui écrit, car une requête qui n’écrit rien ne peut pas remplir un fichier de verrouillage.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
release | string | non | La Release à compiler, sous forme de chemin relatif à la racine de l’espace de travail. |
autoPull | booléen | non | Accepté dans les messages transmis et refusé par la méthode : cette requête n’écrit rien, elle ne peut donc pas remplir un fichier de verrouillage et rester ce qu’elle dit être. |
policyInput | string | non | Le répertoire dans lequel écrire le payload que chaque rôle de gouvernance remet à un plugin rattaché à cet endroit, sous forme de chemin relatif à la racine de l’espace de travail — les fichiers qu’écrit aggrega build --dry-run --policy-input, sous les mêmes noms. Lorsqu’il est envoyé, ils sont la seule chose qu’écrit cette requête ; le répertoire de sortie et le fichier de verrouillage restent intacts. Les avis de la réponse indiquent combien ont été écrits et nomment chaque rôle pour lequel aucun fichier n’a été écrit. Sur une requête qui échoue, les fichiers écrits sont sur le disque et ce bilan ne figure pas dans la réponse : l’erreur ne porte que le refus. Un chemin absolu, ou un chemin qui remonte hors de l’espace de travail, est refusé. |
Les propriétés supplémentaires ne sont pas autorisées.
EntityDefinitionParams
Répond avec ce vers quoi se résout un nom d’entité et l’endroit où se trouve le document qui la définit.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
name | string | non | L’entité à résoudre, par son nom — ou une référence de registre, oci://<host>/<repository>:<tag> ou @<digest> à la place de :<tag>, pour lire l’entité publiée à cette coordonnée. |
release | string | non | La Release dans les termes de laquelle résoudre le nom, sous forme de chemin relatif à la racine de l’espace de travail. Le nom est alors résolu au moyen des répertoires de catalogue que la configuration de l’espace de travail attribue à cette Release, de sorte qu’un nom que plusieurs variantes déclarent dans un même espace de travail, une par Release, se résout vers la variante avec laquelle cette Release est construite, et qu’un nom qu’elle ne résout pas est refusé avec une explication nommant l’entrée de cette Release sous workspace.releases. Absent, le nom est résolu sur les propres répertoires de catalogue de l’espace de travail. Une référence de registre n’accepte aucune Release et est refusée si elle en porte une, de même qu’une valeur qui ne nomme aucun fichier de Release. |
Les propriétés supplémentaires ne sont pas autorisées.
CatalogIndexParams
Répond avec les entités que contient l’espace de travail : chaque entité que déclarent ses documents, et les Features que déclarent ses répertoires de catalogue.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
release | string | non | La Release dans les termes de laquelle lister les entités, sous forme de chemin relatif à la racine de l’espace de travail. Les Features sont alors celles que déclarent les répertoires de catalogue que la configuration de l’espace de travail attribue à cette Release, et un document situé sous un répertoire de catalogue que seules d’autres Releases lisent est écarté, de sorte qu’un espace de travail qui conserve côte à côte des variantes d’une même entité, une par Release, est listé avec la variante avec laquelle cette Release est construite. Absent, la liste est celle propre à l’espace de travail. Une valeur qui ne nomme aucun fichier de Release est refusée. |
Les propriétés supplémentaires ne sont pas autorisées.
ReleaseClosureParams
Répond avec tout ce dont dépend une Release, tel que la résolution l’a atteint.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
release | string | non | La Release à inspecter, sous forme de chemin relatif à la racine de l’espace de travail. |
Les propriétés supplémentaires ne sont pas autorisées.
ResolveDependenciesParams
Résout les dépendances d’une Release, en les épinglant dans le fichier de verrouillage et en acquérant les entrées externes que consomme son rendu. Elle atteint les registres configurés et elle écrit.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
release | string | non | La Release à résoudre, sous forme de chemin relatif à la racine de l’espace de travail. |
upgrade | booléen | non | Indique s’il faut résoudre à nouveau dans les plages déclarées plutôt que de respecter ce que le fichier de verrouillage épingle déjà. |
targets | string[] | non | Les références à résoudre à nouveau, le reste restant épinglé tel quel. Vide, tout est résolu. |
verify | booléen | non | Indique s’il faut comparer le fichier de verrouillage enregistré à la résolution que cette requête effectuerait sans lui, en respectant les épinglages que cette requête respecterait, au lieu de l’écrire. Une vérification n’écrit ni fichier de verrouillage, ni enregistrement de confiance des plugins, ni entity.lock ; le cache de contenu est lu et rempli comme cette résolution le lirait et le remplirait. Une dérive, ainsi qu’un fichier de verrouillage manquant, font échouer la requête. Il ne peut pas être combiné avec upgrade, targets ou pinSources, quelle que soit la valeur que porte pinSources : une requête qui envoie l’un d’eux à côté de lui est refusée comme params invalides avant que quoi que ce soit ne soit résolu. |
pinSources | booléen | non | Indique s’il faut exécuter l’étape d’épinglage qu’exécute aggrega/pin sur les Recipes et les FeatureRecipes que la Release construit à partir des répertoires de catalogue de l’espace de travail, en écrivant l’entity.lock à côté de chacune, plutôt que de refuser la requête à cause de l’une d’elles dont le verrou n’enregistre pas un épinglage dont une entrée a besoin. Absent, suit le pin_sources_at_pull de l’espace de travail ; l’une ou l’autre valeur remplace ce réglage pour cette requête. |
Les propriétés supplémentaires ne sont pas autorisées.
PinParams
Enregistre, dans l’entity.lock situé à côté d’une Recipe ou d’une FeatureRecipe, l’épinglage de contenu de chaque entrée que l’entité lit hors de son propre document. Aucune Release n’est nommée : une entrée dont l’entité écrit l’identité en entier nomme un seul artefact pour chaque Release qui utilise l’entité, de sorte que rien de ce que fournit une Release n’est nécessaire pour l’épingler. Elle atteint les hôtes que nomment les sources de l’entité et elle écrit à côté de l’entité ; le document de l’entité lui-même n’est jamais écrit.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
entity | string | non | Le document d’entité à épingler, sous forme de chemin relatif à la racine de l’espace de travail. |
dryRun | booléen | non | Indique s’il faut répondre avec le verrou que l’étape écrirait plutôt que de l’écrire. Les entrées sont tout de même résolues, de sorte que le cache de contenu se remplit tout de même. |
Les propriétés supplémentaires ne sont pas autorisées.
CacheEvictParams
Récupère de l’espace sur le contenu en cache jusqu’à ce que ce qui reste tienne sous une taille que nomme la requête.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
maxSize | string | non | La taille à laquelle ramener l’espace occupé, écrite comme une personne l’écrit — par exemple 500MB. |
Les propriétés supplémentaires ne sont pas autorisées.
SearchParams
Recherche ce qu’offrent les index locaux des registres configurés. Elle lit l’index déjà présent sur le disque et ne contacte aucun registre.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
query | string | non | Le texte à comparer au nom et à la description d’un enregistrement. |
kinds | string[] | non | Les types d’entités à conserver. Vide, tous les types sont conservés. |
selector | string | non | Un sélecteur d’étiquettes que les enregistrements conservés doivent satisfaire. |
capabilities | string[] | non | Les capacités qu’un enregistrement de plugin conservé doit déclarer. |
pluginType | string | non | Le type de plugin à conserver. |
registry | string | non | L’unique hôte de registre dans lequel rechercher. Absent, chaque hôte configuré est parcouru. |
limit | integer | non | Le nombre maximal d’enregistrements dans la réponse. |
includeRetracted | booléen | non | Indique s’il faut conserver les versions qu’un marqueur publié a dépréciées. |
Les propriétés supplémentaires ne sont pas autorisées.
RegistryAddParams
Enregistre un registre et la politique de confiance que la résolution applique à ce qu’il sert. Elle écrit le fichier de configuration de toute la machine sauf si la requête demande autre chose, de sorte que chaque espace de travail de la machine résout au moyen de l’entrée.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
host | string | non | L’hôte de registre à enregistrer. |
name | string | non | Un alias convivial qui se résout vers l’hôte. |
identities | string[] | non | Les identités de signature considérées comme fiables pour ce que sert ce registre. |
keyPath | string | non | Le chemin d’une clé publique à considérer comme fiable, pour un registre signé avec une clé plutôt qu’avec une identité keyless. |
trustedRoot | string | non | Le chemin de l’ancre de confiance par rapport à laquelle vérifier les signatures. |
requireSignatures | booléen | non | Indique si un artefact provenant de ce registre doit porter une signature vérifiée. Absent, rien n’est indiqué et la valeur par défaut résolue reste en place. |
advisory | booléen | non | Indique si une vérification qui échoue est signalée plutôt que d’arrêter l’exécution. |
fetchTrust | booléen | non | Indique s’il faut lire la politique de confiance qu’annonce le registre et l’épingler. Absent, rien n’est indiqué et la valeur par défaut résolue reste en place. |
global | booléen | non | Écrit le fichier de configuration de toute la machine, qui est la valeur par défaut propre à cette méthode. |
workspace | booléen | non | Écrit le fichier de configuration propre à cet espace de travail au lieu de celui de toute la machine. |
Les propriétés supplémentaires ne sont pas autorisées.
RegistryRemoveParams
Supprime un registre enregistré. Elle écrit le fichier de configuration de toute la machine sauf si la requête demande autre chose.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
registry | string | non | Le registre à supprimer, par hôte ou par alias. |
global | booléen | non | Écrit le fichier de configuration de toute la machine, qui est la valeur par défaut propre à cette méthode. |
workspace | booléen | non | Écrit le fichier de configuration propre à cet espace de travail au lieu de celui de toute la machine. |
Les propriétés supplémentaires ne sont pas autorisées.
RegistryUpdateParams
Rafraîchit l’index local que lit une recherche, en atteignant le registre pour ce faire. Ce qu’elle écrit est l’index situé sous le répertoire de cache configuré propre à cet espace de travail. Un registre qui nécessite un identifiant de connexion qu’aucune source de l’environnement ne fournit est refusé avec cet identifiant nommé, plutôt que de le demander de façon interactive.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
registry | string | non | L’unique registre à rafraîchir. Absent, chaque hôte configuré est rafraîchi. |
upgrade | booléen | non | Indique s’il faut reconstruire l’index plutôt que d’ajouter à ce qu’il contient déjà. |
Les propriétés supplémentaires ne sont pas autorisées.
LogoutParams
Supprime un identifiant de connexion de registre stocké. Le magasin est partagé par tous les projets de la machine, et la réponse le signale.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
registry | string | non | Le registre dont supprimer l’identifiant de connexion stocké. |
Les propriétés supplémentaires ne sont pas autorisées.
PublishEntityParams
Publie une entité dans un registre. Ce qu’elle y dépose est ce que résout chaque consommateur de ce registre, et une version publiée ne peut pas être rappelée auprès de quiconque l’a déjà récupérée. Rien n’est demandé de façon interactive : l’identité est résolue à partir de ce que la requête a fourni ou de ce que l’environnement porte déjà.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
entity | string | non | Le document d’entité à publier, sous la forme d’un chemin relatif à la racine de l’espace de travail. |
registry | string | non | Le registre dans lequel publier. En son absence, le registre par défaut configuré est utilisé. |
dryRun | booléen | non | Indique s’il faut signaler ce que la publication déposerait sans le déposer. |
sign | booléen | non | Indique s’il faut signer ce qui est publié. Absent, rien n’est indiqué et la valeur par défaut résolue reste en place. |
plugin | string | non | Le module de plugin à publier avec une entité Plugin. |
fulcioUrl | string | non | L’autorité de certification auprès de laquelle obtenir un certificat de signature. |
rekorUrl | string | non | Le journal de transparence dans lequel enregistrer la signature. |
timestampUrl | string | non | L’autorité d’horodatage avec laquelle contresigner. |
identityToken | string | non | Le jeton d’identité avec lequel signer, fourni par l’appelant plutôt qu’obtenu dans un terminal. |
pinSources | booléen | non | Indique s’il faut exécuter sur l’entité, avant qu’elle soit empaquetée, l’étape d’épinglage qu’exécute aggrega/pin, de sorte que le entity.lock que l’étape écrit à côté d’elle fasse partie de ce qui est publié. L’étape s’exécute avant tout refus qui juge l’entité, et sous dryRun elle signale le verrou qu’elle écrirait et n’écrit rien. En son absence, le pin_sources_at_push de l’espace de travail s’applique ; l’une ou l’autre valeur remplace ce réglage pour cette requête. |
Les propriétés supplémentaires ne sont pas autorisées.
PublishArtifactParams
Publie un fichier arbitraire dans un registre sous un nom et un tag que la requête lui donne.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
file | string | non | Le fichier à publier, sous la forme d’un chemin relatif à la racine de l’espace de travail. |
name | string | non | Le nom de dépôt sous lequel publier. |
tag | string | non | Le tag sous lequel publier. |
mediaType | string | non | Le type de média à enregistrer pour les octets publiés. |
registry | string | non | Le registre dans lequel publier. En son absence, le registre par défaut configuré est utilisé. |
dryRun | booléen | non | Indique s’il faut signaler ce que la publication déposerait sans le déposer. |
Les propriétés supplémentaires ne sont pas autorisées.
SignArtifactsParams
Signe ce qui est déjà publié. Une signature ne peut pas être rappelée auprès de quiconque l’a déjà récupérée.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
references | string[] | non | Les références publiées à signer. |
fulcioUrl | string | non | L’autorité de certification auprès de laquelle obtenir un certificat de signature. |
rekorUrl | string | non | Le journal de transparence dans lequel enregistrer la signature. |
timestampUrl | string | non | L’autorité d’horodatage avec laquelle contresigner. |
identityToken | string | non | Le jeton d’identité avec lequel signer, fourni par l’appelant plutôt qu’obtenu dans un terminal. |
jobs | integer | non | Le nombre de références signées à la fois. En son absence, elles sont signées l’une après l’autre. Chaque référence est néanmoins signée exactement comme elle le serait seule — en mode keyless, avec son propre certificat et sa propre entrée dans le journal de transparence — et la réponse conserve l’ordre dans lequel les références ont été données. Minimum : 1. |
Les propriétés supplémentaires ne sont pas autorisées.
DeprecateArtifactParams
Marque une version publiée comme dépréciée, afin que la résolution puisse la signaler ou la refuser. Le marqueur est lui-même publié et signé. Une requête envoie soit une référence avec son contenu, soit un fichier de lot dont les entrées portent le leur — jamais les deux, et jamais de contenu à côté du fichier de lot.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
reference | string | non | La référence publiée à marquer. Une alternative à from : une requête portant les deux est refusée. |
severity | const “warning” ou const “error” ou const “retracted” | non | La force avec laquelle le marqueur s’exprime — si la résolution signale la version ou la refuse. Requis avec reference ; refusé à côté de from, dont le fichier de lot porte celui propre à chaque marqueur. Valeurs autorisées : "warning" — Dépréciée, au plus modéré des deux niveaux consultatifs : toujours sélectionnée lorsqu’une version est choisie. "error" — Dépréciée, au plus fort des deux niveaux consultatifs : toujours sélectionnée lorsqu’une version est choisie. "retracted" — Retirée : exclue lorsqu’une version est choisie. |
reason | string | non | La raison pour laquelle la version est dépréciée. Requis avec reference ; refusé à côté de from, dont le fichier de lot porte celle propre à chaque marqueur. |
replacement | string | non | La référence à utiliser à la place. Refusé à côté de from, dont le fichier de lot porte celle propre à chaque marqueur. |
message | string | non | Ce qui est dit à un consommateur qui rencontre le marqueur. Refusé à côté de from, dont le fichier de lot porte celui propre à chaque marqueur. |
from | string | non | Un fichier de lot d’entrées de retrait, sous la forme d’un chemin relatif à la racine de l’espace de travail, attachant un marqueur par entrée. Chaque entrée porte sa propre référence, sa propre sévérité et sa propre raison, et éventuellement un remplacement et un message. Une alternative à reference : une requête portant les deux, ou portant à côté une sévérité, une raison, un remplacement ou un message, est refusée. |
fulcioUrl | string | non | L’autorité de certification auprès de laquelle obtenir un certificat de signature. |
rekorUrl | string | non | Le journal de transparence dans lequel enregistrer la signature. |
timestampUrl | string | non | L’autorité d’horodatage avec laquelle contresigner. |
identityToken | string | non | Le jeton d’identité avec lequel signer, fourni par l’appelant plutôt qu’obtenu dans un terminal. |
Les propriétés supplémentaires ne sont pas autorisées.
ResolveParams
Répond en indiquant où est défini l’élément sous le curseur.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
uri | string | non | Le document dans lequel se trouve le curseur. |
position | Position | non | Un endroit dans un document : une ligne et un décalage de caractère dans celle-ci, tous deux comptés à partir de zéro. Le décalage est mesuré dans les unités de l’encodage dont la session a convenu à son ouverture, qui est UTF-16 sauf si le client en a demandé un autre. |
release | string | non | La Release dans les termes de laquelle répondre, sous la forme d’un chemin relatif à la racine de l’espace de travail. La définition est alors le document vers lequel la référence se résout à travers les répertoires de catalogue que la configuration de l’espace de travail attribue à cette Release, dans cet ordre, de sorte qu’un nom que plusieurs variantes d’un même espace de travail déclarent, une par Release, renvoie à la variante de cette Release ; lorsque ces répertoires ne déclarent aucune entité de ce type, les documents de l’espace de travail sont parcourus, en laissant de côté ceux situés sous l’un des répertoires de catalogue de l’espace de travail que la Release ne lit pas. En son absence, les documents de l’espace de travail sont parcourus en premier, et les répertoires de catalogue propres à l’espace de travail seulement lorsqu’aucun document ne déclare le nom. Une valeur qui ne nomme aucun fichier de Release est refusée. |
Les propriétés supplémentaires ne sont pas autorisées.
FindReferencesParams
Répond en indiquant où il est fait référence à l’élément sous le curseur.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
uri | string | non | Le document dans lequel se trouve le curseur. |
position | Position | non | Un endroit dans un document : une ligne et un décalage de caractère dans celle-ci, tous deux comptés à partir de zéro. Le décalage est mesuré dans les unités de l’encodage dont la session a convenu à son ouverture, qui est UTF-16 sauf si le client en a demandé un autre. |
release | string | non | La Release dans les termes de laquelle répondre, sous la forme d’un chemin relatif à la racine de l’espace de travail. Une référence faite dans un document situé sous l’un des répertoires de catalogue de l’espace de travail que la Release ne lit pas n’est alors pas signalée, de sorte que des variantes qu’un espace de travail conserve côte à côte, une par Release, ne sont jamais signalées comme références les unes des autres. En son absence, chaque document de l’espace de travail est parcouru. Une valeur qui ne nomme aucun fichier de Release est refusée. |
Les propriétés supplémentaires ne sont pas autorisées.
FindImplementationsParams
Répond en indiquant quels documents implémentent l’élément sous le curseur.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
uri | string | non | Le document dans lequel se trouve le curseur. |
position | Position | non | Un endroit dans un document : une ligne et un décalage de caractère dans celle-ci, tous deux comptés à partir de zéro. Le décalage est mesuré dans les unités de l’encodage dont la session a convenu à son ouverture, qui est UTF-16 sauf si le client en a demandé un autre. |
release | string | non | La Release dans les termes de laquelle répondre, sous la forme d’un chemin relatif à la racine de l’espace de travail. Un document situé sous l’un des répertoires de catalogue de l’espace de travail que la Release ne lit pas n’est alors pas signalé, de sorte qu’une variante avec laquelle une autre Release est construite n’est jamais listée parmi celles de cette Release. En son absence, chaque document de l’espace de travail est parcouru. Une valeur qui ne nomme aucun fichier de Release est refusée. |
Les propriétés supplémentaires ne sont pas autorisées.
HoverParams
Répond avec ce qu’il faut afficher à propos de l’élément sous le curseur.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
uri | string | non | Le document dans lequel se trouve le curseur. |
position | Position | non | Un endroit dans un document : une ligne et un décalage de caractère dans celle-ci, tous deux comptés à partir de zéro. Le décalage est mesuré dans les unités de l’encodage dont la session a convenu à son ouverture, qui est UTF-16 sauf si le client en a demandé un autre. |
release | string | non | La Release dans les termes de laquelle répondre, sous la forme d’un chemin relatif à la racine de l’espace de travail. L’entité affichée est alors celle vers laquelle la référence se résout à travers les répertoires de catalogue que la configuration de l’espace de travail attribue à cette Release, dans cet ordre ; lorsque ces répertoires ne déclarent aucune entité de ce type, les documents de l’espace de travail sont parcourus, en laissant de côté ceux situés sous l’un des répertoires de catalogue de l’espace de travail que la Release ne lit pas. En son absence, les documents de l’espace de travail sont parcourus en premier, et les répertoires de catalogue propres à l’espace de travail seulement lorsqu’aucun document ne déclare le nom. Une valeur qui ne nomme aucun fichier de Release est refusée. |
Les propriétés supplémentaires ne sont pas autorisées.
CompletionParams
Répond avec ce qui peut être écrit à l’emplacement du curseur.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
uri | string | non | Le document dans lequel se trouve le curseur. |
position | Position | non | Un endroit dans un document : une ligne et un décalage de caractère dans celle-ci, tous deux comptés à partir de zéro. Le décalage est mesuré dans les unités de l’encodage dont la session a convenu à son ouverture, qui est UTF-16 sauf si le client en a demandé un autre. |
context | CompletionContext | non | Ce qui a déclenché la requête, lorsque le client le suit. |
release | string | non | La Release dans les termes de laquelle répondre, sous la forme d’un chemin relatif à la racine de l’espace de travail. Les noms proposés sont alors ceux que déclarent les documents de l’espace de travail, moins les documents situés sous l’un des répertoires de catalogue de l’espace de travail que la Release ne lit pas, ainsi que les Components et les Features que déclarent les répertoires de catalogue attribués à cette Release par la configuration de l’espace de travail. En son absence, ce sont les documents de l’espace de travail et les Components et les Features que déclarent ses propres répertoires de catalogue. Une valeur qui ne nomme aucun fichier de Release est refusée. |
Les propriétés supplémentaires ne sont pas autorisées.
CompletionContext
Ce qui a déclenché la requête, lorsque le client le suit.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
triggerKind | integer | non | Pourquoi la complétion a été demandée. |
triggerCharacter | string | non | Le caractère qui l’a déclenchée, lorsque c’est un caractère qui l’a fait. |
Les propriétés supplémentaires sont autorisées.
AttachCandidatesParams
Répond en indiquant quelles Features peuvent être rattachées à une entité, jugées d’après les étiquettes de cette entité, et, pour une connexion que trace le composant d’un nœud du graphe, lesquelles peuvent remplir chaque slot que déclare le socket de la connexion.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
node | string | non | L’entité d’après laquelle juger les candidats, par nom, lue dans ce que déclarent les documents de l’espace de travail. |
graphNode | string | non | Le nœud du graphe d’après lequel juger les candidats, dont les étiquettes sont l’ensemble finalisé avec lequel le build lui-même évalue l’applicabilité. Une réponse calculée sur cette base dit ce que fera le build. |
release | string | non | La Release au graphe de laquelle appartient le nœud, sous la forme d’un chemin relatif à la racine de l’espace de travail. Les candidats sont alors tirés dans les termes de cette Release : les Features que déclarent les répertoires de catalogue attribués à cette Release par la configuration de l’espace de travail, et les documents de l’espace de travail moins ceux situés sous l’un des répertoires de catalogue de l’espace de travail que la Release ne lit pas, de sorte qu’une Feature conservée pour une autre Release n’est jamais proposée pour un nœud du graphe de celle-ci. |
labels | map de string | non | Étiquettes d’après lesquelles juger directement, au lieu de les lire dans une entité ou un nœud du graphe. |
connection | ConnectionCoordinate | non | Une connexion que trace le composant du nœud que nomme graphNode, pour laquelle répondre en plus de ce nœud : la réponse porte alors aussi slots, chaque slot que déclare le socket de la connexion avec les Features qui peuvent le remplir, ou noSlotReason lorsqu’aucun slot ne peut être rempli. Elle n’est envoyée qu’avec graphNode et release, car une connexion n’existe que sur un graphe compilé ; envoyée avec node ou labels, elle est refusée. Les candidats à côté d’elle gardent leur sens, les Features qui peuvent se rattacher au nœud lui-même. Son document est accepté et ne change pas cette réponse : les slots sont ceux du socket et les candidats ceux des Features, les mêmes quel que soit le document dans lequel un rattachement est écrit. |
Les propriétés supplémentaires ne sont pas autorisées.
ConnectionCandidatesParams
Répond en indiquant à quelles entités un socket d’une entité peut être relié.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
node | string | non | L’entité dont les sockets font l’objet de la question. |
socket | string | non | Le socket unique pour lequel répondre. En son absence, la réponse porte sur chaque socket que déclare l’entité. |
Les propriétés supplémentaires ne sont pas autorisées.
InsertionPointParams
Répond en indiquant où, dans un document, se place une nouvelle entrée sous un conteneur nommé, en laissant la composition et l’application de l’entrée à l’appelant qui possède le tampon.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
file | string | non | Le document sur lequel répondre. |
container | string[] | non | Le chemin à travers le document jusqu’au conteneur sous lequel se place l’entrée. |
Les propriétés supplémentaires ne sont pas autorisées.
AttachmentContainerParams
Répond en indiquant dans quel document, et à quel endroit de celui-ci, se place un rattachement sur un nœud du graphe, ou sur une connexion que trace son composant.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
graphNode | string | non | Le nœud du graphe auquel le rattachement est destiné. |
release | string | non | La Release au graphe de laquelle appartient le nœud, sous la forme d’un chemin relatif à la racine de l’espace de travail. |
connection | ConnectionCoordinate | non | Une connexion que trace le composant du nœud du graphe, lorsque le rattachement concerne cette connexion plutôt que le nœud : la réponse nomme alors le conteneur features propre à la connexion dans le document que nomme son champ document, un champ requis ici. Dans l’Aggregate, il s’agit de l’entrée de la connexion dans le document dans lequel le nœud a été écrit, refusée pour une connexion que la Release a tracée, pour laquelle l’Aggregate ne contient aucune entrée. Dans la Release, il s’agit de l’entrée par arête sous l’entrée propre de la Release pour le nœud, que la Release en écrive déjà une pour cette connexion ou non, refusée lorsque la Release n’écrit aucune entrée pour le nœud. Une connexion qu’une Feature a tracée est refusée dans l’un et l’autre document, car un rattachement n’est écrit que sur une connexion que trace un composant ou la Release. |
Les propriétés supplémentaires ne sont pas autorisées.
ConnectionAtPositionParams
Répond en indiquant dans l’entrée de quelle connexion tombe une position dans un Aggregate ou une Release : le nœud du graphe et la connexion, dans les termes sous lesquels les requêtes de candidature et de conteneur les prennent, ou pourquoi aucune connexion n’y est écrite. Les entrées sont celles dans lesquelles un rattachement est écrit — l’entrée avec laquelle un composant trace une connexion, sous l’alias de la connexion, dans le document dans lequel le composant a été écrit, et chaque entrée par arête qu’écrit la Release — chacune là où le graphe compilé l’enregistre, de sorte que le fait qu’une clé soit une connexion n’est jamais déduit de son nom.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
file | string | non | Le document dans lequel se trouve la position : la Release, ou un document dans lequel le graphe de la Release enregistre des composants comme écrits — son Aggregate, ou le document d’un module qu’importe cet Aggregate. Il est lu d’abord dans ce que la session conserve pour lui, et sinon depuis le disque. |
position | Position | non | Un endroit dans un document : une ligne et un décalage de caractère dans celle-ci, tous deux comptés à partir de zéro. Le décalage est mesuré dans les unités de l’encodage dont la session a convenu à son ouverture, qui est UTF-16 sauf si le client en a demandé un autre. |
release | string | non | La Release dont le graphe compilé enregistre les connexions, sous la forme d’un chemin relatif à la racine de l’espace de travail. Elle est requise aussi pour une position dans l’Aggregate, car un nœud du graphe et une connexion n’existent que sur un graphe compilé. |
Les propriétés supplémentaires ne sont pas autorisées.
ConnectionCoordinate
Une connexion que trace le composant d’un nœud du graphe, adressée par le socket à travers lequel elle est reliée et l’alias qu’elle porte dans ce socket, et le document dans lequel un rattachement sur elle est écrit. Une connexion porte des rattachements qui remplissent les slots que déclare son socket, et l’Aggregate comme la Release peuvent les écrire.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
socket | string | oui | Le socket de dépendance à travers lequel la connexion est reliée. |
alias | string | oui | Le nom que porte la connexion au sein de son socket. |
document | const “aggregate” ou const “release” | non | Le document dans lequel un rattachement sur la connexion est écrit. L’ensemble est fermé, et une valeur extérieure à celui-ci est refusée. Valeurs autorisées : "aggregate" — L’Aggregate, où le développeur écrit un rattachement sur l’entrée de la connexion. "release" — La Release, où l’opérateur écrit un rattachement sur l’entrée par arête de la connexion. |
Les propriétés supplémentaires sont autorisées.
SetActiveReleaseParams
Enregistre une Release comme valeur par défaut de l’espace de travail en écrivant un marqueur dans le répertoire .aggrega : le choix que signale aggrega/activeRelease lit ce marqueur après la Release d’authoring de la configuration. Le marqueur est écrit à l’intérieur de l’espace de travail et nulle part ailleurs : lorsque le répertoire .aggrega ou le marqueur est un lien menant hors de l’espace de travail, que l’endroit auquel il mène existe déjà ou non, l’écriture est refusée en nommant le lien et rien n’est écrit. La réponse est celle que donne aggrega/activeRelease une fois le marqueur écrit, de sorte qu’elle nomme une Release différente lorsque la Release d’authoring de la configuration prime sur le marqueur.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
release | string | non | La Release à enregistrer, sous la forme d’un chemin relatif à la racine de l’espace de travail. Un chemin absolu, et un chemin qui remonte hors de l’espace de travail, sont refusés ; de même pour un chemin qui en sort par un lien, sauf si la configuration de l’espace de travail nomme cette Release. |
Les propriétés supplémentaires ne sont pas autorisées.
EditDocumentParams
Applique une seule modification délimitée à un document que contient l’espace de travail : une entrée ajoutée sous un conteneur, ou un scalaire défini. Le document composé est vérifié par rapport au schéma de son type et n’atteint le disque que si cette vérification réussit, de sorte que cette méthode ne peut pas écrire ce que refuse le schéma d’authoring. Une modification refusée laisse le fichier identique octet pour octet à ce qu’il était.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
file | string | non | Le document à modifier. |
edit | const “add-component” ou const “attach-feature” ou const “wire-edge” ou const “set-value” | non | Quelle modification appliquer. Valeurs autorisées : "add-component" — Ajoute une instance de composant sous un conteneur components : name est le nom de l’instance, value le Component qu’elle demande. "attach-feature" — Rattache une Feature au nœud que nomme la requête : name est le nom d’instance du rattachement, value la Feature qu’il demande. "wire-edge" — Relie une connexion de dépendance depuis le nœud que nomme la requête, à l’intérieur de socket : name est l’alias par lequel la connexion est adressée, value le nœud vers lequel elle pointe. "set-value" — Définit une valeur sur le nœud que nomme la requête : name est la clé de la valeur, value un scalaire. |
node | string[] | non | Le chemin à travers le document jusqu’à l’entrée en cours de modification. |
socket | string | non | Le socket que concerne la modification, pour une modification qui en relie un. |
name | string | non | Le nom qu’écrit la modification. |
value | any | non | La valeur qu’écrit la modification, sous la forme que prend la modification, quelle qu’elle soit. |
dryRun | booléen | non | Indique s’il faut répondre avec le document composé plutôt que de l’écrire. |
Les propriétés supplémentaires ne sont pas autorisées.
ConfigInitParams
Initialise un document de configuration. Il écrit par défaut le fichier de toute la machine, car un registre et les identités de confiance sur celui-ci relèvent d’un outillage à l’échelle de la machine. Il contacte le registre nommé pour lire la politique de confiance qu’il annonce ; un registre qui n’annonce rien est signalé comme tel et l’initialisation se poursuit, sur la base de référence intégrée pour le hub officiel et sans aucune politique pour tout autre registre.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
registry | string | non | Le registre pour lequel initialiser la configuration. |
force | booléen | non | Indique s’il faut écraser un document de configuration qui existe déjà. |
global | booléen | non | Écrit le fichier de configuration de toute la machine, qui est la valeur par défaut propre à cette méthode. |
workspace | booléen | non | Écrit le fichier de configuration propre à cet espace de travail au lieu de celui de toute la machine. |
dryRun | booléen | non | Indique s’il faut répondre avec le contenu du document plutôt que de l’écrire, pour un client qui gère son propre modèle de document. |
Les propriétés supplémentaires ne sont pas autorisées.
ConfigCaptureParams
Fige la configuration résolue dans le document propre de cet espace de travail, de sorte que l’espace de travail soit autonome. Il écrit toujours le fichier de cet espace de travail et n’atteint rien en dehors de celui-ci.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
allPlugins | booléen | non | Indique s’il faut figer chaque plugin rattaché plutôt que seulement ceux que l’espace de travail a lui-même configurés. |
Les propriétés supplémentaires ne sont pas autorisées.
ImportParams
Convertit une description de source étrangère en documents d’authoring à l’état de brouillon, et écrit à côté d’eux .aggrega-import.json, l’enregistrement de ce que l’import a écrit — la cible qui lui a été donnée, lorsqu’une cible lui a été donnée, l’instantané du catalogue qu’il a lu, lorsqu’il en a lu un, chaque fichier rédigé et chaque clé d’un Aggregate ou d’une Release rédigés, à toute profondeur — que lit une synchronisation ultérieure. Une source qu’il n’a pas pu convertir entièrement est une réponse plutôt qu’un échec : les brouillons qu’il a produits sont écrits et les constats disent ce qu’il n’a pas pu convertir — sauf sous sync, qui n’écrit rien à partir d’une conversion qui s’est arrêtée.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
source | string | non | Le fichier ou le répertoire à convertir, sous la forme d’un chemin absolu ou relatif à la racine de l’espace de travail ; une requête qui n’en a pas est refusée. Il est lu là où il se trouve, à l’intérieur de l’espace de travail ou non, et un répertoire est lu en ceux de ses fichiers que sélectionnent les motifs de fichiers déclarés par l’importateur. |
outputDir | string | non | Le répertoire sous l’espace de travail dans lequel écrire les brouillons, relatif à la racine de l’espace de travail ; une valeur absolue, ou une valeur qui sort de l’espace de travail telle qu’elle est écrite ou par un lien, est refusée. En son absence, l’écriture se fait sous la racine de l’espace de travail, là où écrit la même conversion exécutée dans un terminal sans nommer de destination. Chaque chemin rédigé est relatif au répertoire que la réponse nomme comme outputDir, sous dryRun également. |
format | string | non | Le format de la source. En son absence, la conversion le détermine. |
target | string | non | Une capacité du fournisseur, telle que compose ou helm — le mot auquel se lie le spec.capability d’une Recipe — pour laquelle rédiger un Manifest à côté des brouillons, sous la forme de manifest.yaml : chaque type de composant et chaque type de fonctionnalité dont les brouillons ont besoin, y compris les types d’un Aggregate du catalogue que compose celui rédigé, est associé à la Recipe ou à la recette de fonctionnalité de cette capacité que propose pour lui le catalogue de l’espace de travail — celle qui existe, ou parmi plusieurs celle qui porte le nom du type —, un type qui n’en a aucune, ou qui en a plusieurs dont aucune ne porte ce nom, reste non associé avec un constat d’avertissement qui le nomme, une association qu’un importateur a rédigée lui-même est conservée là où le catalogue la propose pour ce type et cette capacité, et abandonnée sinon avec un constat d’avertissement, et le spec.manifest de la Release rédigée est défini sur le Manifest. Une capacité à laquelle aucune Recipe du catalogue ne se lie est refusée avant l’exécution de la conversion, et rien n’est écrit. En son absence, aucun Manifest n’est rédigé, sauf sous sync, qui rédige pour la cible que nomme l’enregistrement de l’import précédent ; une synchronisation qui nomme une cible rédige pour celle-ci, et l’enregistrement la nomme alors. |
dryRun | booléen | non | Indique s’il faut répondre avec le contenu de chaque fichier que la requête écrirait plutôt que de l’écrire. Tout autre comportement est celui de l’écriture, de sorte qu’une requête que l’écriture refuserait est refusée dans ce cas également ; avec sync, la réponse porte ce que la synchronisation écrirait et chaque partie qui dériverait. |
sync | booléen | non | Indique s’il faut mettre à jour par rapport à la source ce qu’un import précédent a rédigé sous outputDir, plutôt que d’écrire le brouillon en entier. Seul ce que l’import a écrit change, tel que l’enregistrement situé à côté des brouillons le liste : une partie que la source a laissée telle quelle reste comme elle est sur le disque, modifiée ou non ; une partie que la source a modifiée, abandonnée ou gagnée est réécrite, supprimée — un fichier rédigé effacé en entier — ou ajoutée, là où ce qui se trouve sur le disque est ce que l’import a écrit en dernier ; et tout le reste, une clé qu’un auteur a ajoutée — dont l’environnement qu’une Release rédigée laisse à son auteur — ou un commentaire qui n’est pas écrit directement au-dessus d’une clé rédigée, reste identique octet pour octet. Une synchronisation qui modifierait ou supprimerait ce qu’un auteur a modifié ou ajouté, ou qui ajouterait une partie là où un auteur en a déjà écrit une, est refusée en nommant chaque partie, de même qu’une synchronisation sur un Aggregate qu’aucun enregistrement ne liste ; rien n’est écrit dans un cas comme dans l’autre. Sans ce champ, une requête dont les brouillons seraient écrits par-dessus un Aggregate déjà présent dans outputDir est refusée, sous dryRun également. |
upgrade | booléen | non | Indique s’il faut récupérer l’instantané du catalogue le plus récent que publie le registre par défaut de l’espace de travail et importer par rapport à lui, en le conservant dès lors à la place de celui que contient l’espace de travail ou de celui que nomme l’enregistrement placé à côté des brouillons ; cela ne change rien lorsque l’espace de travail nomme un dossier de catalogue, et c’est refusé hors ligne. |
answers | string | non | Le fichier de réponses à partir duquel sont lues, et dans lequel sont écrites, les valeurs que les brouillons laissent vides et qu’aucune source ne peut contenir, relatif à la racine de l’espace de travail ; une valeur absolue, ou une valeur qui sort de l’espace de travail telle qu’écrite ou par un lien, est refusée. Il contient, sous le chemin de chaque fichier rédigé, le chemin de la clé dans ce document et sa réponse, et les réponses sont écrites dans les brouillons. En son absence, le fichier lu est celui que nomme l’enregistrement à côté des brouillons, ou à défaut import-answers.yaml à côté du fichier source ou dans le répertoire source. La réponse d’un secret nomme la provenance du secret — un nom de variable, ${NAME}, ou le nom d’un Kubernetes Secret — et toute autre chose est refusée sans que rien ne soit écrit. Rien n’est demandé : chaque valeur encore due est une entrée de owed de la réponse et un constat d’avertissement qui nomme le fichier rédigé, la clé et ce qu’elle est, sa réponse est envoyée comme answered, et là où les brouillons sont écrits, le dernier constat indique combien de valeurs sont dues et où. Lorsque les brouillons comprennent une Release, ne doivent plus rien et que la conversion est terminée, ses dépendances sont alors récupérées, ce qui écrit son fichier de verrouillage, et un pull qui échoue clôt les constats en indiquant pourquoi, les brouillons étant écrits ; hors ligne, rien n’est récupéré et un constat nomme le pull à exécuter. Une réponse pour une clé que ces brouillons ne laissent pas vide est conservée dans le fichier et non appliquée, de sorte qu’un seul fichier de réponses sert pour toutes les cibles. |
answered | ImportAnswered[] | non | Réponses pour des valeurs que owed de la réponse a listées, chacune nommant le fichier rédigé et les clés telles que owed les a nommées. Chacune est évaluée, conservée dans le fichier de réponses et écrite dans les brouillons exactement comme l’est une réponse saisie dans un terminal : la réponse d’un secret nomme la provenance du secret — un nom de variable, ${NAME}, ou le nom d’un Kubernetes Secret — et une réponse qui ne le fait pas n’est ni conservée ni écrite, sa valeur restant due avec la raison comme secretAdvice. Une valeur à laquelle le fichier de réponses répond déjà reçoit sa réponse du fichier ; une réponse vide, ou une réponse nommant une valeur que les brouillons ne doivent pas, n’est pas appliquée. Envoyez-la avec sync une fois les brouillons écrits, car une requête qui n’est pas un sync est refusée sur un Aggregate déjà présent dans outputDir. Sous dryRun, qui ne conserve aucune réponse, et sous un sync dont la conversion s’est arrêtée, qui n’écrit rien, aucune réponse envoyée n’est appliquée. |
Les propriétés supplémentaires ne sont pas autorisées.
ScaffoldEntityParams
Rédige un document de départ pour un type d’entité, ou écrit l’un des exemples exécutables de la documentation dans un nouveau répertoire de l’espace de travail, ou les liste. La rédaction dérive le squelette de l’ensemble de schémas que porte le binaire, de sorte que rien n’est lu dans un espace de travail et rien n’est écrit — la réponse est du texte, et sa destination relève du client. L’écriture d’un exemple écrit le nouveau répertoire et rien d’autre, et les exemples sont lus dans le bundle de documentation signé publié pour la version du binaire, ou dans le plus récent publié avant celle-ci lorsqu’il n’y en a pas, vérifié par rapport à la politique de signature de l’espace de travail avant d’être conservé ou lu : un bundle qui ne passe pas la vérification est refusé, et hors ligne seule une copie déjà en cache est lue. Une requête qui envoie ensemble les champs de deux formes — kind avec example ou list, list avec example, name avec example ou list, dir sans example — est refusée avant que quoi que ce soit ne soit lu.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | string | non | Le chemin absolu de l’espace de travail. La rédaction ne le lit pas. L’écriture ou le listage d’un exemple l’exige : la configuration de l’espace de travail décide d’où la documentation est récupérée et quelles signatures elle doit porter, et un exemple est écrit à l’intérieur de celui-ci. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
kind | string | non | Le type d’entité à rédiger, désigné par son jeton en minuscules, tel que component, aggregate, release, recipe ou featurerecipe — le jeton que aggrega/getSchema liste pour lui. |
name | string | non | Le nom à écrire dans le document rédigé. Envoyé uniquement avec kind. |
example | string | non | L’exemple exécutable à écrire, sous le nom que lui donne la liste des exemples. Envoyé à la place de kind. |
list | booléen | non | Indique s’il faut répondre avec chaque exemple exécutable que publie la documentation, sans rien écrire. Envoyé sans example et sans kind. |
dir | string | non | Le nouveau répertoire dans lequel écrire l’exemple, relatif à la racine de l’espace de travail ; en son absence, l’exemple est écrit là dans un répertoire nommé d’après lui. Il ne doit pas encore exister ou doit être vide : un répertoire contenant quoi que ce soit est refusé et laissé tel quel, et une valeur absolue, ou une valeur qui sort de l’espace de travail telle qu’elle est écrite ou par un lien, est refusée avant que quoi que ce soit ne soit lu. Envoyé uniquement avec example. |
Les propriétés supplémentaires ne sont pas autorisées.
LintParams
Vérifie les conventions de publication du catalogue sur une seule entité, sur tout ce qu’atteint la fermeture d’une Release, ou sur tout ce qui se trouve sous les répertoires de catalogue configurés. Rien n’est écrit, quel que soit le mode. Ne nommer ni une entité ni une Release vérifie tout le catalogue : dans un espace de travail dont la configuration ne donne à aucune Release de répertoires de catalogue propres, une fois sur les répertoires de l’espace de travail ; dans un espace de travail qui nomme des Releases sous workspace.releases, une fois pour chaque Release sur les répertoires que lit cette Release, jamais sur tous ensemble.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
entity | string | non | L’unique document d’entité à vérifier. |
release | string | non | La Release dont vérifier la fermeture, sous la forme d’un chemin relatif à la racine de l’espace de travail. |
prePublish | booléen | non | Indique s’il faut comparer chaque entité à sa version publiée précédemment, ce qui atteint les registres configurés. |
Les propriétés supplémentaires ne sont pas autorisées.
PluginAddParams
Rattache un plugin à un socket que configure l’espace de travail. Elle atteint un registre pour résoudre la recherche en un seul plugin et pour épingler une version. L’unique décision qu’obtiendrait un terminal — accepter les capacités déclarées d’un plugin d’extension de commandes — arrive ici sous forme de champ, de sorte que le client interroge celui qui le pilote et que cette surface n’attend jamais une invite.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
type | string | non | Le socket auquel le plugin se rattache. |
query | string | non | Ce qu’il faut résoudre en un seul plugin. |
capability | string | non | La capacité à laquelle est destiné le rattachement, lorsque le socket en porte plusieurs. |
role | string | non | Le rôle dans lequel s’exécute le rattachement, qui fixe ce qu’il peut émettre. |
global | booléen | non | Écrit le fichier de configuration de toute la machine. |
workspace | booléen | non | Écrit le fichier de configuration propre à cet espace de travail. |
acceptCapabilities | booléen | non | Indique si l’appelant accepte les capacités que déclare un plugin d’extension de commandes. |
dryRun | booléen | non | Indique s’il faut répondre avec le contenu du document de configuration plutôt que de l’écrire. |
Les propriétés supplémentaires ne sont pas autorisées.
PluginRemoveParams
Détache un plugin d’un socket que configure l’espace de travail.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
type | string | non | Le socket auquel le plugin est rattaché. |
query | string | non | Quel rattachement supprimer. |
global | booléen | non | Écrit le fichier de configuration de toute la machine. |
workspace | booléen | non | Écrit le fichier de configuration propre à cet espace de travail. |
Les propriétés supplémentaires ne sont pas autorisées.
PluginSyncParams
Aligne les enregistrements gérés par la machine d’une entité Plugin sur le module vers lequel elle pointe. Elle réécrit ces enregistrements et reporte inchangé chaque autre octet du document.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
entity | string | non | Le document de l’entité Plugin à aligner. |
plugin | string | non | Le module de plugin dans lequel lire les enregistrements. |
Les propriétés supplémentaires ne sont pas autorisées.
PluginGenCatalogParams
Génère des documents de catalogue Plugin à partir des métadonnées déclarées par le plugin lui-même, plus un overlay rédigé par l’auteur. Régénérer sur des entrées inchangées produit des documents identiques octet pour octet.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
fromEmbedded | booléen | non | Indique s’il faut lire les métadonnées dans les plugins que le binaire porte déjà. |
plugin | string | non | Le module de plugin dans lequel lire les métadonnées. |
outputDir | string | non | Le répertoire sous l’espace de travail dans lequel écrire les documents. |
overlay | string | non | Le document rédigé par l’auteur dont le contenu est fusionné par-dessus les métadonnées générées. |
dryRun | booléen | non | Indique s’il faut répondre avec le contenu des documents plutôt que de les écrire. |
Les propriétés supplémentaires ne sont pas autorisées.
ExplainErrorParams
Développe un code que portait un constat pour donner ce que le compilateur déclare à propos de cette condition et les entrées publiées qui enseignent la correction d’authoring. Elle acquiert la documentation publiée lorsque l’espace de travail n’en a pas de copie ; si elle ne peut pas l’acquérir, elle répond tout de même avec ce que déclare le binaire, et dit pourquoi le texte explicatif manque.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
code | string | non | La condition à développer, désignée soit par le code que portait un constat, soit par son code court. |
Les propriétés supplémentaires ne sont pas autorisées.
GetSchemaParams
Répond avec le schéma d’un type, ou — lorsqu’aucun type n’est nommé — avec les types qui peuvent être nommés. Elle répond pour le binaire en cours d’exécution plutôt que pour une copie installée ailleurs, de sorte qu’elle n’a besoin d’aucun espace de travail et n’en lit aucun.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootAccepted | non | Le chemin absolu d’un espace de travail. Le sujet de cette méthode n’est pas un espace de travail — elle répond à partir de ce que le binaire lui-même contient — de sorte que le champ est accepté et non lu. Il est admis afin qu’un client puisse l’envoyer uniformément sur chaque requête sans avoir à savoir quelles méthodes le consultent. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
kind | string | non | Le type dont renvoyer le schéma. En son absence, la réponse porte à la place sur les types qui peuvent être nommés. |
Les propriétés supplémentaires ne sont pas autorisées.
SkillsInstallParams
Écrit la skill d’assistant intégrée au binaire dans le dossier de skills de chaque assistant que nomme la requête ou, pour une requête globale qui n’en nomme aucun, de chaque assistant trouvé sur cette machine. Sans global, elle écrit le dossier de projet de chaque assistant à l’intérieur de l’espace de travail que nomme la requête, et chaque chemin qu’elle y écrirait est cantonné à cet espace de travail ; avec global, elle écrit le dossier par utilisateur de chaque assistant sous le répertoire personnel. Chaque cible est vérifiée avant que quoi que ce soit ne soit écrit, de sorte qu’un refus laisse chaque dossier tel qu’il était.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | oui | Le chemin absolu de l’espace de travail sur lequel agit cette requête. C’est le sujet de la requête : le daemon le résout avant l’exécution de la méthode, et une requête qui l’omet ou l’écrit autrement que comme une chaîne est refusée. |
workDoneToken | ProgressToken | non | Une valeur que l’appelant génère afin de pouvoir associer les notifications de progression à l’appel qui les a demandées. Elle est renvoyée inchangée sur chaque notification, de sorte qu’un appelant peut la comparer à la valeur qu’il a envoyée. Elle est acceptée sur chaque requête, et une requête qui en envoie une dans une session n’ayant déclaré aucune capacité de progression est refusée. |
agents | string[] | non | Les assistants pour lesquels installer la skill, par les identifiants que rapporte le listage. Une requête de projet qui n’en nomme aucun est refusée. Une requête globale qui n’en nomme aucun installe la skill pour les assistants trouvés sur cette machine, chacun de ceux dont le dossier de configuration se trouve dans le répertoire personnel ou dont la commande se trouve dans le PATH, et elle est refusée sans rien écrire lorsqu’aucun n’est trouvé. Un identifiant pour lequel aucun dossier de skills n’est connu est refusé, nommément, et un identifiant donné deux fois est installé une seule fois. |
global | booléen | non | Écrit le dossier de skills par utilisateur de chaque assistant sous le répertoire personnel, qu’il lit dans chaque projet, au lieu de son dossier de projet dans l’espace de travail. |
Les propriétés supplémentaires ne sont pas autorisées.
ServerCapabilities
Ce que le daemon fera dans cette session, convenu par rapport à ce que le client a dit pouvoir prendre en charge.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
positionEncoding | string | oui | L’encodage dans lequel chaque position de cette session est exprimée. |
workDoneProgress | booléen | non | Indique si le daemon enverra des notifications de progression dans cette session. Présent uniquement lorsque le client a déclaré pouvoir les recevoir. |
Les propriétés supplémentaires ne sont pas autorisées.
ClosureEntity
Une entité dont dépend une Release, à la version que la résolution a arrêtée.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
uri | string | oui | La référence à partir de laquelle l’entité se résout. |
version | string | oui | La version qui a été arrêtée. |
kind | string | non | Le type d’entité. |
source | string | non | D’où l’exécution qui a produit cette entrée a pris l’entité, avec le même mot que aggrega pull --detail affiche pour elle : fetched-fresh (récupérée d’un registre pendant cette exécution), cache-reuse (une copie déjà dans le cache, réutilisée sans récupération), local (trouvée sur le système de fichiers local, comme un répertoire de catalogue), in-binary (la copie à l’intérieur du binaire du compilateur) ou external (l’Aggregate ou le Manifest propre à la Release, lu depuis le fichier ou l’entrée que nomme la Release plutôt que résolu comme l’une de ses dépendances ; un Aggregate que l’exécution a récupéré d’un registre est fetched-fresh à la place). Présent sur les entrées du rapport d’une résolution de dépendances, où il décrit ce que cette exécution a fait sur cette machine, et absent d’un listage des dépendances résolues d’une Release, qui décrit ce dont la Release dépend. Le fichier de verrouillage n’enregistre aucune source. Omis pour une entité dont l’exécution n’a pas enregistré la source. |
Les propriétés supplémentaires ne sont pas autorisées.
ToolchainCorePlugin
Un plugin que le compilateur porte lui-même, et la version de celui-ci qui a été utilisée.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
plugin | string | oui | La référence du plugin. |
version | string | oui | La version qui a été utilisée. |
Les propriétés supplémentaires ne sont pas autorisées.
ToolchainReport
Le compilateur qui a effectué la résolution, et les plugins qu’il porte.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
compilerVersion | string | oui | La version du compilateur qui a effectué la résolution. |
corePlugins | ToolchainCorePlugin[] | non | Les plugins que porte le compilateur, avec la version de chacun qui a été utilisée. |
Les propriétés supplémentaires ne sont pas autorisées.
DependencyResolutionReport
Ce qu’une résolution de dépendances a épinglé et acquis.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
lockfile | string | oui | Le fichier de verrouillage que la résolution a écrit, ou celui auquel une vérification a comparé. |
verified | booléen | non | Indique si la requête était une vérification, qui a comparé le fichier de verrouillage enregistré et n’a écrit ni fichier de verrouillage, ni enregistrement de confiance des plugins, ni entity.lock. |
entities | ClosureEntity[] ou null | oui | Les entités que la résolution a épinglées, ou qu’une vérification a comparées. |
libraries | ClosureEntity[] ou null | oui | Les bibliothèques que la résolution a épinglées, ou qu’une vérification a comparées. |
plugins | ClosureEntity[] ou null | oui | Les plugins que la résolution a épinglés, ou qu’une vérification a comparés. |
sourceArtifacts | integer | oui | Le nombre d’artefacts sources acquis. |
trustedPlugins | integer | oui | Le nombre de plugins épinglés qui portaient une signature vérifiée. |
toolchain | ToolchainReport | non | Le compilateur qui a effectué la résolution, et les plugins qu’il porte. |
externalInputs | integer | oui | Le nombre d’entrées externes consommées par le rendu qui ont été acquises. |
incompleteExternalInputs | string | non | Les entrées externes qui n’ont pas pu être acquises, lorsque certaines n’ont pas pu l’être. |
Les propriétés supplémentaires ne sont pas autorisées.
BuildNotice
Une chose que le build veut faire savoir à l’appelant, qui n’est ni un constat sur un document ni un échec.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
class | string | oui | Le genre d’avis dont il s’agit. |
text | string | oui | Ce que dit l’avis. |
Les propriétés supplémentaires ne sont pas autorisées.
CacheScope
Jusqu’où porte une réponse sur le cache. Deux des classes de cache sont partagées par tous les projets de la machine, de sorte que chaque réponse sur le cache nomme celles qu’elle a touchées — sinon, une session ouverte sur un espace de travail serait lue comme ne rendant compte que de cet espace de travail.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
machineWideClasses | string[] ou null | oui | Les classes de cache touchées par cette réponse qui sont partagées entre tous les projets de la machine. |
workspaceRoot | string | oui | L’espace de travail que la requête a nommé. |
Les propriétés supplémentaires ne sont pas autorisées.
CacheElement
Une chose que contient un cache.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
label | string | oui | Ce sur quoi porte l’entrée. |
size | integer | oui | Le nombre d’octets qu’elle occupe. |
sizeText | string | oui | La même taille écrite de la manière dont une personne la lit. |
digest | string | non | Le digest de contenu sous lequel l’entrée est indexée, lorsqu’elle en a un. |
note | string | non | Tout ce qui mérite encore d’être dit sur l’entrée. |
Les propriétés supplémentaires ne sont pas autorisées.
CacheClass
Un cache dont le daemon rend compte.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
name | string | oui | De quel cache il s’agit. |
reach | string | oui | Indique si le cache appartient à cet espace de travail ou est partagé sur la machine. |
prunable | booléen | oui | Indique si récupérer l’espace de ce cache est quelque chose que fera le daemon. |
elements | CacheElement[] ou null | oui | Ce que contient le cache. |
Les propriétés supplémentaires ne sont pas autorisées.
CacheProvenance
Sous quelles identités un artefact en cache a été acquis, et à quel point il est partagé.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
identities | string[] ou null | oui | Les identités auxquelles l’artefact est attribué. |
sharedBy | integer | non | Le nombre de détenteurs qui partagent l’artefact. |
Les propriétés supplémentaires ne sont pas autorisées.
CacheRemoval
Une chose qu’une récupération d’espace a supprimée — ou, dans une liste de ce qu’elle a laissé en place, une chose qu’elle aurait supprimée.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
class | string | oui | Le cache auquel elle appartient. |
label | string | oui | Ce que c’est. |
reach | string | oui | Indique si ce cache appartient à cet espace de travail ou est partagé sur la machine. |
size | integer | oui | Le nombre d’octets qu’elle occupe, ou occupait avant d’être supprimée. |
sizeText | string | oui | La même taille écrite de la manière dont une personne la lit. |
Les propriétés supplémentaires ne sont pas autorisées.
CacheShortfall
Ce qu’une récupération d’espace a laissé derrière elle, et ce qui le récupérerait, de sorte qu’un appelant qui lit un chiffre plus petit que prévu en apprend la raison plutôt que de la déduire.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
class | string | oui | Le cache qui contient ce qui a été laissé. |
count | integer | oui | Le nombre d’entrées laissées. |
size | integer | oui | Le nombre d’octets qu’elles occupent. |
sizeText | string | oui | La même taille écrite de la manière dont une personne la lit. |
reach | string | oui | Indique si ce cache appartient à cet espace de travail ou est partagé sur la machine. |
reclaimedBy | string[] ou null | oui | Ce qui les récupérerait. |
Les propriétés supplémentaires ne sont pas autorisées.
CacheCleared
Un cache qu’un nettoyage a vidé.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
class | string | oui | Quel cache a été vidé. |
reach | string | oui | Indique s’il appartient à cet espace de travail ou s’il est partagé sur la machine. |
size | integer | oui | Combien d’octets y ont été récupérés. |
sizeText | string | oui | La même taille écrite de la manière dont une personne la lit. |
heldOpenFiles | integer | oui | Combien de fichiers le nettoyage a laissés dans ce cache parce qu’un autre processus les avait ouverts. Seul Windows refuse de supprimer un fichier ouvert, de sorte que partout ailleurs cette valeur vaut zéro. Un nettoyage ultérieur les supprime une fois que ce processus en a terminé avec eux. |
heldOpenBytes | integer | oui | Combien d’octets occupent ces fichiers. Ils ne sont pas comptés dans size, qui est ce que le nettoyage a récupéré. |
heldOpenBytesText | string | oui | Le même chiffre écrit de la manière dont une personne le lit. |
Les propriétés supplémentaires ne sont pas autorisées.
ConfigWriteScope
Quel document de configuration a été écrit et jusqu’où il porte. Une requête nomme un espace de travail, de sorte qu’une réponse qui ne dirait rien serait lue comme portant sur cet espace de travail — et pour une écriture à l’échelle de toute la machine, cette lecture est fausse.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
configFile | string | oui | Le document qui a été écrit. |
machineWide | booléen | oui | Indique si ce document est celui au moyen duquel résout chaque espace de travail de la machine. |
workspaceRoot | string | oui | L’espace de travail que la requête a nommé. |
Les propriétés supplémentaires ne sont pas autorisées.
PluginWriteScope
Dans quel document de configuration une modification de plugin a été écrite et jusqu’où elle porte. La valeur par défaut propre au socket d’extension de commandes est le document de toute la machine, de sorte que chaque réponse indique lequel elle a écrit.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
configFile | string | oui | Le document qui a été écrit. |
machineWide | booléen | oui | Indique si ce document est celui au moyen duquel résout chaque espace de travail de la machine. |
workspaceRoot | string | oui | L’espace de travail que la requête a nommé. |
Les propriétés supplémentaires ne sont pas autorisées.
CredentialStoreScope
Jusqu’où porte une modification d’identifiant de connexion. Le magasin est partagé par chaque projet de la machine et par tout autre outil qui s’adresse aux mêmes registres, de sorte que la réponse le signale plutôt que de laisser déduire une lecture limitée à la session.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
machineWide | booléen | oui | Indique si le magasin que la modification a touché est partagé sur la machine. |
workspaceRoot | string | oui | L’espace de travail que la requête a nommé. |
Les propriétés supplémentaires ne sont pas autorisées.
SkillFolderScope
Jusqu’où porte une installation de skill. Une requête nomme un espace de travail, de sorte qu’une réponse qui ne dirait rien serait lue comme portant sur cet espace de travail — et pour les dossiers par utilisateur, qu’un assistant lit dans chaque projet, cette lecture est fausse.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
machineWide | booléen | oui | Indique si les dossiers écrits sont ceux par utilisateur sous le répertoire personnel, que l’assistant lit dans chaque projet de la machine. |
workspaceRoot | string | oui | L’espace de travail que la requête a nommé. |
Les propriétés supplémentaires ne sont pas autorisées.
PublicationReach
Jusqu’où une publication a porté. Ces réponses portent entièrement au-delà de cette machine — ce qu’elles attachent est ce que résout chaque consommateur de ce registre — de sorte que chacune nomme chaque registre auquel elle s’est adressée et indique si l’appel y a attaché quoi que ce soit.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
registries | string[] | oui | Chaque hôte de registre auquel l’appel s’est adressé, chacun nommé une seule fois, dans l’ordre dans lequel l’appel s’y est adressé pour la première fois. Un appel portant sur une seule référence en nomme un ; une exécution à blanc nomme la destination à laquelle elle se serait adressée. |
beyondThisMachine | booléen | oui | Indique si l’appel a attaché quoi que ce soit qu’un registre sert désormais à d’autres : du contenu téléversé, une signature, une date de publication ou un marqueur de dépréciation. Vaut false lors d’une exécution à blanc, et lors d’un appel qui a trouvé déjà présent tout ce qu’il aurait attaché — une publication exécutée à nouveau sur une version complète, ou un lot de signature dont chaque référence portait déjà une signature qui se vérifie. |
Les propriétés supplémentaires ne sont pas autorisées.
WorkspaceEntityRef
Une entité, par type et par nom, avec le document qui la déclare.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
kind | string | oui | Le type d’entité. |
name | string | oui | Le nom de l’entité. |
file | string | oui | Le document qui la déclare, sous la forme d’un chemin relatif à la racine de l’espace de travail. |
Les propriétés supplémentaires ne sont pas autorisées.
SourcedEntityRef
Une entité, avec l’endroit d’où elle a été lue. Un document de l’espace de travail signale son chemin relatif à l’espace de travail ; une entité résolue depuis les répertoires de catalogue configurés signale un chemin vide, car le seul chemin qu’elle possède ne signifierait rien pour un client. L’origine indique lequel des deux cas s’applique, plutôt que de laisser un chemin vide être lu comme un champ que personne n’a rempli.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
kind | string | oui | Le type d’entité. |
name | string | oui | Le nom de l’entité. |
file | string | oui | Le document qui la déclare, sous la forme d’un chemin relatif à la racine de l’espace de travail, ou vide lorsqu’elle provient des répertoires de catalogue configurés. |
origin | string | oui | L’endroit d’où l’entité a été lue. |
Les propriétés supplémentaires ne sont pas autorisées.
SocketCandidacy
Un socket sur une entité, et ce qui peut y être relié.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
socket | string | oui | Le nom du socket. |
declaration | string | oui | L’endroit où le socket est déclaré. |
selector | string | oui | Le sélecteur d’étiquettes qu’une cible doit satisfaire. |
required | booléen | oui | Indique si le socket doit être relié pour que le build se poursuive. |
targets | WorkspaceEntityRef[] ou null | oui | Les entités qui peuvent y être reliées. |
Les propriétés supplémentaires ne sont pas autorisées.
SlotCandidacy
Un slot que déclare le socket d’une connexion, tel que le Component consommateur le déclare sur le socket, et les Features qui peuvent le remplir sur cette connexion.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
slot | string | oui | Le nom du slot, qui est la clé sous laquelle un rattachement qui le remplit est écrit dans les features de la connexion. |
selector | string | oui | Le sélecteur d’étiquettes qu’une Feature qui remplit le slot doit satisfaire avec ses propres étiquettes. Vide lorsque le slot n’en déclare aucun, ce qui admet n’importe quelle Feature. |
required | booléen | oui | Indique si chaque connexion reliée à travers le socket doit remplir le slot pour que le build se poursuive. |
inject | string[] | oui | Les mécanismes de livraison que le slot autorise pour ce qui le remplit, dans l’ordre dans lequel le Component les déclare. Vide lorsqu’il n’en déclare aucun. |
sensitive | booléen | oui | Indique si le slot déclare que ce qui le remplit manipule du matériel secret. Il marque le rattachement qui le remplit et ne refuse rien. |
description | string | oui | Ce à quoi sert le slot selon le Component. Vide lorsqu’il ne dit rien. |
candidates | SourcedEntityRef[] | oui | Chaque Feature qui peut remplir le slot sur cette connexion : celle dont les étiquettes du nœud du graphe satisfont l’applicabilité déclarée, exigence à laquelle est tenu chaque rattachement que porte le nœud, et dont les propres étiquettes satisfont le sélecteur du slot. Une Feature dont l’applicabilité ou les étiquettes ne peuvent pas être lues par rapport au sélecteur n’est pas proposée, car un build la refuse plutôt que de l’admettre. |
Les propriétés supplémentaires ne sont pas autorisées.
CatalogEntity
Une entité que contient l’index de l’espace de travail.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
kind | string | oui | Le type d’entité. |
name | string | oui | Le nom de l’entité. |
apiVersion | string | oui | La version de schéma que déclare le document. |
description | string | oui | Ce à quoi sert l’entité selon le document. |
labels | map de string ou null | oui | Les étiquettes que déclare le document. |
file | string | oui | Le document qui la déclare, sous la forme d’un chemin relatif à la racine de l’espace de travail. |
origin | string | oui | L’endroit d’où l’entité a été lue. |
Les propriétés supplémentaires ne sont pas autorisées.
CompletionItem
Un élément qui peut être écrit à la position du curseur.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
label | string | oui | Le texte à écrire. |
kind | integer | non | Le genre d’élément dont il s’agit, afin qu’un client puisse lui choisir une icône. |
detail | string | non | Un court qualificatif affiché à côté du libellé. |
documentation | string | non | Ce qu’est l’élément, en détail. |
sortText | string | non | La valeur selon laquelle trier, lorsqu’elle diffère du libellé. |
Les propriétés supplémentaires ne sont pas autorisées.
MarkupContent
Du texte à afficher, et la façon dont il est balisé.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
kind | string | oui | La façon dont le texte est balisé. |
value | string | oui | Le texte. |
Les propriétés supplémentaires ne sont pas autorisées.
EntityKindDescriptor
Un type dont un auteur écrit un document, qui associe le jeton que nomme une requête au type que déclare le document lui-même, et qui indique quelles opérations acceptent un document de ce type.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
kind | string | oui | Le jeton en minuscules que nomme une requête, comme component ou featurerecipe. |
documentKind | string | oui | Le type que déclare l’en-tête propre du document. |
acceptedBy | EntityKindAcceptance | oui | Quelles opérations acceptent un document de ce type nommé seul — par son chemin, ou par son nom pour une inspection — sans rien d’autre envoyé à côté. Un champ vaut true lorsque cette opération ne refuse pas un document du fait qu’il est de ce type ; un document qu’elle accepte peut tout de même être refusé pour ce que dit le document. |
Les propriétés supplémentaires ne sont pas autorisées.
EntityKindAcceptance
Pour un type qu’écrit un auteur, indique si chaque opération accepte un document de ce type nommé seul. Chaque champ est présent dans chaque entrée, de sorte que false est une affirmation plutôt qu’une omission.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
singleEntityValidation | booléen | oui | Indique si la portée à entité unique de aggrega validate — la commande à laquelle on donne le chemin d’un seul document — vérifie un document de ce type. Un type qu’elle refuse est vérifié à la place par la portée du catalogue entier ou par la portée de la Release. |
publication | booléen | oui | Indique si aggrega/publishEntity, nommant le document seul, publie un document de ce type. Un type dont la publication lie aussi un exécutable nommé à côté du document — un Plugin — vaut false, car une requête nommant le document seul est refusée pour lui ; un Manifest et une Release valent false car aucun de ces types n’est publié. |
inspectionByName | booléen | oui | Indique si aggrega/entityDefinition résout un nom vers une entité de ce type, le nom étant envoyé tel qu’il est écrit là où une entité en référence une autre. |
Les propriétés supplémentaires ne sont pas autorisées.
RegistryTrust
La politique de confiance que la résolution applique à ce que sert un registre.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
signaturesRequired | booléen | oui | Indique si un artefact provenant de ce registre doit porter une signature vérifiée. |
verificationSkipped | booléen | non | Indique si la vérification est ignorée. |
advisory | booléen | non | Indique si une vérification qui échoue est signalée plutôt que d’arrêter l’exécution. |
anchor | string | non | L’ancre de confiance par rapport à laquelle les signatures sont vérifiées. |
keylessIdentities | integer | non | Combien d’identités de signature sont considérées comme fiables pour ce registre. |
Les propriétés supplémentaires ne sont pas autorisées.
Registry
Un registre configuré. Aucun champ ici ne porte de matériel d’identification, sa longueur, sa forme ni aucune représentation de celui-ci — la présence est tout ce qui est signalé, ce qui permet de coller la valeur sans risque dans un ticket.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
host | string | oui | L’hôte du registre, qui constitue son identité. |
name | string | non | L’alias convivial qui se résout vers l’hôte, lorsqu’il en est configuré un. |
default | booléen | oui | Indique si c’est le registre auquel s’adresse une opération qui ne nomme aucun registre. |
authState | string | oui | Indique si un identifiant de connexion pour cet hôte est présent dans le magasin de toute la machine. Il est signalé même lorsqu’il est vide, de sorte qu’un appelant peut distinguer « aucun identifiant de connexion n’est présent » de « la liste n’a pas regardé ». |
trust | RegistryTrust | oui | La politique de confiance que la résolution applique à ce que sert un registre. |
Les propriétés supplémentaires ne sont pas autorisées.
TrustFetchOutcome
Ce qu’a donné la lecture de la politique de confiance annoncée par un registre. Les résultats sont tenus séparés parce qu’ils signifient des choses différentes : la politique annoncée a été adoptée, le registre n’a rien annoncé — ce qui n’est pas un échec —, la base de référence intégrée a été épinglée à sa place, ou aucune lecture n’a été tentée. Lorsque rien n’a été annoncé, il est indiqué à côté si le registre a pu être atteint ou non.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
pinned | booléen | oui | Indique si la politique annoncée a été adoptée. |
notAdvertised | booléen | non | Indique si le registre a été interrogé et n’a annoncé aucune politique, auquel cas l’opération se poursuit sur ce qu’a indiqué la requête. Un registre que le mode hors ligne a empêché d’interroger n’est jamais signalé ainsi. Un registre qui n’a pas pu être atteint est lui aussi signalé ainsi, puisqu’aucune politique n’en est revenue, et porte unreachable à côté ; lisez unreachable pour distinguer les deux. |
unreachable | booléen | non | Indique si le registre n’a pas pu être atteint lorsque sa politique annoncée a été demandée : son nom ne s’est pas résolu, une connexion vers lui a été refusée ou n’a pas pu être ouverte, ou une connexion sécurisée vers lui n’a pas pu être établie. Il est lu dans l’échec lui-même plutôt que dans reason, il figure à côté de notAdvertised, et il n’est défini que lorsque l’échec montre que le registre n’a jamais été atteint ; un registre qui a répondu — sans politique, ou par un échec — le laisse absent. |
baseline | booléen | non | Indique si la base de référence intégrée, que seul le hub officiel porte, a été épinglée parce qu’aucune politique annoncée n’a été adoptée. Il figure à côté de notAdvertised lorsque le hub a été interrogé et n’a rien annoncé, et seul lorsque le mode hors ligne a empêché d’interroger le hub. |
skipped | booléen | non | Indique si aucune lecture n’a été tentée, parce qu’une politique indiquée l’a remplacée ou que la requête n’en demandait aucune. |
identities | integer | non | Combien d’identités de signature portait la politique annoncée. |
reason | string | non | Pourquoi la politique annoncée n’a pas été adoptée : ce qu’a fait le point de terminaison du registre, ou le refus hors ligne qui a empêché de l’interroger. |
Les propriétés supplémentaires ne sont pas autorisées.
SkippedRepo
Un dépôt que le parcours de l’index a ignoré, et pourquoi.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
repo | string | oui | Le dépôt qui a été ignoré. |
reason | string | oui | Pourquoi il a été ignoré. |
Les propriétés supplémentaires ne sont pas autorisées.
DeprecationNote
Un marqueur de dépréciation que le parcours de l’index a rencontré, et ce qu’il en a fait. Un marqueur qui a été respecté et un marqueur présent qui a été écarté sont signalés sur un pied d’égalité, de sorte qu’en enregistrer beaucoup ne passe pas sous silence tandis qu’en écarter un se fait remarquer.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
repo | string | oui | Le dépôt sur lequel se trouve le marqueur. |
version | string | oui | La version que couvre le marqueur. |
recorded | booléen | oui | Indique si la signature propre du marqueur a été vérifiée, et si l’index le porte donc. |
severity | const “warning” ou const “error” ou const “retracted” | non | La force avec laquelle le marqueur s’exprime. Valeurs autorisées : "warning" — Dépréciée, au plus modéré des deux niveaux consultatifs : toujours sélectionnée lorsqu’une version est choisie. "error" — Dépréciée, au plus fort des deux niveaux consultatifs : toujours sélectionnée lorsqu’une version est choisie. "retracted" — Retirée : exclue lorsqu’une version est choisie. |
reason | string | non | La raison pour laquelle la version est dépréciée. |
Les propriétés supplémentaires ne sont pas autorisées.
HostUpdate
Ce qu’un rafraîchissement de l’index a fait pour un registre.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
host | string | oui | L’hôte de registre qui a été rafraîchi. |
indexed | integer | oui | Combien d’enregistrements ont été écrits. |
deprecationsExamined | booléen | oui | Indique si le parcours a même cherché des marqueurs de dépréciation. Il est distinct du décompte parce que « ce registre n’en a publié aucun » et « cette exécution n’avait aucune base pour en juger un » sont des faits différents. |
deprecationsRecorded | integer | oui | Combien de marqueurs ont été respectés. |
skipped | SkippedRepo[] ou null | oui | Les dépôts que le parcours a ignorés. |
deprecations | DeprecationNote[] ou null | oui | Les marqueurs que le parcours a rencontrés. |
readsRetried | integer | oui | Combien des lectures du parcours le registre a refusées ou abandonnées en cours de route et ont été redemandées, chaque lecture comptée une seule fois quel que soit le nombre de tentatives qu’elle a nécessité et qu’elle ait ensuite réussi ou non ; zéro lorsqu’il n’y en a eu aucune. Un parcours dont les lectures ont toutes fini par réussir ne liste aucun dépôt sous skipped, de sorte que c’est ce décompte qui dit à quel point il a été près d’en laisser un de côté. Minimum : 0. |
error | string | non | Ce qui a échoué pour cet hôte, de sorte qu’un parcours sur plusieurs hôtes signale lesquels ont échoué sans que l’appelant ait à corréler quoi que ce soit. |
unreachable | booléen | non | Indique si ce registre n’a pas pu être atteint : son nom ne s’est pas résolu, une connexion vers lui a été refusée ou n’a pas pu être ouverte, ou une connexion sécurisée vers lui n’a pas pu être établie. Il est lu dans l’échec lui-même plutôt que dans error, il n’est défini qu’à côté de error, et seulement lorsque l’échec montre que le registre n’a jamais été atteint ; un registre qui a répondu, quoi qu’il ait répondu, le laisse absent. |
Les propriétés supplémentaires ne sont pas autorisées.
PublishedVersion
Une version que l’index contient pour une référence : le digest du manifeste vers lequel son tag se résolvait lorsque l’index a été construit ; lorsque la politique de confiance sous laquelle l’index a été construit a vérifié la signature propre de la version, le signataire établi par cette vérification ; et, lorsque quelque chose l’enregistre, le moment où la version a été publiée, avec la source qui l’indique. Le signataire est absent pour une version sans signature, pour une version dont aucune des signatures n’a été vérifiée, et lorsque cette politique n’épingle ni une clé publique ni une identité de confiance ou désactive la vérification des signatures. Aucun de ces cas ne fournit de base pour nommer un signataire, et son absence ne dit rien de plus. La date de publication est absente lorsque la publication n’en a indiqué aucune et qu’aucune signature keyless vérifiée par cette politique n’en enregistre une.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
version | string | oui | La version, telle que la nomme son tag. |
manifestDigest | string | oui | Le digest du manifeste vers lequel le tag de la version se résolvait lorsque l’index a été construit, qui désigne la version par les octets qu’il nomme plutôt que par son tag. |
signer | VerifiedSignature | non | Une signature vérifiée par rapport à la politique de confiance d’un registre : la façon dont elle a été vérifiée, le signataire établi par la vérification, et le digest du bundle de signature qui a été vérifié. |
publishedAt | string | non | Le moment où la version a été publiée, sous la forme d’un horodatage RFC 3339 en UTC à la seconde près. Sa provenance est publishedAtSource, et les deux sont présents ensemble ou pas du tout. |
publishedAtSource | const “transparency-log” ou const “publisher” | non | La provenance de publishedAt, afin qu’un moment qu’atteste un journal de transparence ne soit jamais confondu avec un moment qu’indique l’éditeur. L’ensemble est fermé. Valeurs autorisées : "transparency-log" — Le moment où un journal de transparence a enregistré la signature keyless de la version, que la politique de confiance sous laquelle l’index a été construit a vérifiée avec la promesse signée du journal quant à ce moment. Pour une version signée au moment de sa publication, c’est la publication ; pour une version signée ensuite, c’est le moment où cette signature a été faite. "publisher" — Le moment que la publication a indiqué à côté de ce qu’elle a publié, d’après l’horloge propre de la machine qui publie. Rien ne l’atteste. Une publication en indique un lorsque sa signature ne porte aucun moment attesté : une signature à clé, ou aucune signature. Lorsque plusieurs sont attachés, le plus ancien est retenu. |
Les propriétés supplémentaires ne sont pas autorisées.
VerifiedSignature
Une signature vérifiée par rapport à la politique de confiance d’un registre : la façon dont elle a été vérifiée, le signataire établi par la vérification, et le digest du bundle de signature qui a été vérifié.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
bundleDigest | string | oui | Le digest du bundle de signature qui a été vérifié, sous la forme de sha256: suivi de 64 caractères hexadécimaux en minuscules. |
identity | string | non | Le signataire établi par la vérification de la signature : pour une signature keyless, l’identité pour laquelle le certificat de signature a été émis, c’est-à-dire son subject alternative name ; pour une signature à clé, keyed:sha256: suivi du SHA-256 en hexadécimal minuscule du texte PEM de la clé publique épinglée. |
issuer | string | non | L’émetteur OIDC enregistré dans le certificat de signature, pour une signature keyless. Il est absent pour une signature à clé. |
mode | const “keyless” ou const “keyed” | oui | La façon dont la signature a été vérifiée. L’ensemble est fermé. Valeurs autorisées : "keyless" — Par rapport à un certificat de signature dont l’identité et l’émetteur correspondent à ceux auxquels la politique fait confiance, qui remonte par sa chaîne jusqu’à la racine de confiance qu’épingle la politique ou, lorsqu’elle n’en épingle aucune, jusqu’à la racine public-good de Sigstore, et dont un journal de transparence enregistre la signature. "keyed" — Par rapport à la clé publique qu’épingle la politique. |
Les propriétés supplémentaires ne sont pas autorisées.
RegistrySearchRecord
Un enregistrement auquel une recherche a correspondu, tel que l’index local le contient, ainsi que celles de ses versions qu’un marqueur publié a dépréciées.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
uri | string | oui | La référence à partir de laquelle l’enregistrement se résout. |
name | string | oui | Le nom de l’entité. |
version | string | oui | La version sous laquelle l’enregistrement est indexé. |
versions | string[] | non | Chaque version que l’index contient pour cette référence. |
kind | string | non | Le type d’entité. |
description | string | non | Ce à quoi sert l’entité. |
category | string | non | La catégorie sous laquelle l’entité est publiée. |
labels | map de string | non | Les étiquettes que déclare l’entité. |
pluginType | string | non | Le socket auquel se rattache un enregistrement de plugin. |
capabilities | string[] | non | Les capacités que déclare un enregistrement de plugin. |
manifestDigest | string | non | Le digest du manifeste publié. |
listingDigest | string | non | Le digest de la liste dans laquelle l’enregistrement a été lu. |
deprecations | object[] | non | Les marqueurs de dépréciation que l’index porte pour cette référence, chacun avec la version qu’il couvre et le marqueur vérifié lui-même. |
published | PublishedVersion[] | non | Chaque version que l’index contient pour cette référence, dans le même ordre que versions, chacune avec le digest du manifeste vers lequel son tag se résolvait lorsque l’index a été construit, avec son signataire vérifié lorsque la politique de confiance sous laquelle l’index a été construit a vérifié la signature propre de cette version, et avec sa date de publication et la source de cette date lorsque quelque chose les enregistre. Une version enregistrée sans signataire ne porte aucune signature vérifiée par cette politique, et rien de plus n’en est dit. Pour enregistrer cela, seuls des manifestes, des attachements de signature et des attachements de date de publication sont lus depuis le registre ; le contenu d’aucune entité n’est récupéré. |
retracted | string[] | non | Les versions qu’un marqueur publié a dépréciées. |
Les propriétés supplémentaires ne sont pas autorisées.
RegistrySearchIndex
La fraîcheur d’un hôte interrogé.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
host | string | oui | L’hôte dont l’index a été interrogé. |
lastUpdated | string | non | Le moment où l’index a été rafraîchi pour la dernière fois. Il est absent plutôt que nul lorsque l’instantané ne porte aucune heure, de sorte qu’un appelant peut distinguer « non enregistré » de l’epoch. |
Les propriétés supplémentaires ne sont pas autorisées.
EffectiveConfigurationSetting
Un réglage résolu, et le document dont il provient.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
field | string | oui | Le réglage. |
value | string | oui | La valeur qui a été résolue. |
source | string | oui | La provenance de la valeur. |
Les propriétés supplémentaires ne sont pas autorisées.
ImportedFile
Un fichier qu’écrit un import : un document à l’état de brouillon, ou l’enregistrement de ce que l’import a écrit.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
path | string | oui | L’emplacement du fichier, sous la forme d’un chemin relatif au outputDir de la réponse. |
content | string | oui | Le texte du fichier. |
Les propriétés supplémentaires ne sont pas autorisées.
ImportDrift
Une partie qu’une synchronisation a mise à jour par rapport à la source, ou mettrait à jour sous dryRun.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
change | string | oui | La façon dont la partie a dérivé : added, pour une partie que la source a gagnée ; removed, pour une partie qu’elle a abandonnée ; ou changed, pour une partie qu’elle a modifiée. |
file | string | oui | Le fichier rédigé dans lequel se trouve la partie, sous la forme d’un chemin relatif au outputDir de la réponse. |
key | string[] | oui | Les clés qui mènent à la partie depuis le sommet d’un Aggregate ou d’une Release rédigés, une entrée par clé, de sorte qu’une clé contenant un point reste une seule entrée. Vide lorsque la partie est le fichier entier. |
Les propriétés supplémentaires ne sont pas autorisées.
ImportOwed
Une valeur que les brouillons laissent encore vide, qu’aucune source n’a pu fournir et qu’aucune réponse n’a fournie.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
file | string | oui | Le fichier rédigé dans lequel se trouve la valeur, sous forme de chemin relatif à l’outputDir de la réponse. |
key | string[] | oui | Les clés menant à la valeur depuis le haut de ce document, une entrée par clé, de sorte qu’une clé contenant un point reste une seule entrée. Une réponse envoyée comme answered nomme la valeur par ces clés. |
question | string | oui | Ce qu’est la valeur : la description de son schéma, sinon le commentaire que le brouillon écrit au-dessus de sa clé, sinon ce que son schéma dit qu’elle accepte. |
sensitive | booléen | oui | Si la valeur est celle d’un secret, dont la réponse nomme la provenance du secret et ne contient jamais le secret lui-même. |
secretAdvice | string | non | Présent sur la valeur d’un secret : ce que doit être sa réponse, dans la phrase présentée à une personne qui y répond dans un terminal — ou, lorsque la réponse envoyée pour elle comme answered a été refusée, pourquoi elle a été refusée. |
Les propriétés supplémentaires ne sont pas autorisées.
ImportAnswered
Une réponse pour une valeur que owed de la réponse a listée.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
file | string | oui | Le fichier rédigé dans lequel se trouve la valeur, tel que owed le nomme. |
key | string[] | oui | Les clés menant à la valeur, telles que owed les nomme. |
answer | string | oui | La réponse. Une réponse vide laisse la valeur due. |
Les propriétés supplémentaires ne sont pas autorisées.
ImportDiagnostic
Une chose qu’une conversion n’a pas pu convertir. Ce sont les sorties les plus utiles de la conversion, de sorte qu’elles sont signalées en entier plutôt que réduites à un verdict.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
severity | string | oui | Sa gravité. |
message | string | oui | Ce qui n’a pas pu être converti. |
code | string | non | Le nom citable de la condition, lorsqu’elle en a un. |
Les propriétés supplémentaires ne sont pas autorisées.
ImportDecision
La façon dont une conversion a associé un nœud source : les Components du catalogue que l’importateur a évalués, celui qu’il a choisi, pourquoi, et comment remplacer ce choix.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
sourceNode | DecisionSourceNode | oui | Le nœud source sur lequel porte une décision d’association. |
candidates | ImportCandidate[] | non | Les Components du catalogue que l’importateur a évalués pour le nœud, chacun avec son score. Absent lorsqu’il n’en a évalué aucun. |
chosen | DecisionChoice | non | Ce que l’importateur a choisi pour un nœud source. Absent d’une décision dans laquelle il n’a fait aucun choix. |
rationale | string | non | Pourquoi l’importateur a fait ce choix, dans ses propres mots. Absent lorsqu’il n’en a écrit aucun. |
swapHint | string | non | Comment remplacer le choix par une alternative, dans les propres mots de l’importateur. Absent lorsqu’il n’en a écrit aucun. |
Les propriétés supplémentaires ne sont pas autorisées.
DecisionSourceNode
Le nœud source sur lequel porte une décision d’association.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
id | string | oui | L’identifiant du nœud dans la source. |
type | string | oui | Le type du nœud, tel que le nomme la source. |
paramsSummary | string | oui | Un résumé des paramètres du nœud, à afficher à côté de la décision. |
Les propriétés supplémentaires ne sont pas autorisées.
ImportCandidate
Un Component du catalogue que l’importateur a évalué pour un nœud source.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
componentName | string | oui | Le nom du Component. |
score | number | oui | Dans quelle mesure le Component correspond au nœud, selon le score de l’importateur. |
tier | string | oui | Le niveau de correspondance dans lequel tombe le score. |
signals | CandidateSignals | oui | Ce que chacun des signaux de l’importateur a apporté au score d’un candidat. |
Les propriétés supplémentaires ne sont pas autorisées.
CandidateSignals
Ce que chacun des signaux de l’importateur a apporté au score d’un candidat.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
table | number | oui | L’apport du signal de la table de correspondance. |
category | number | oui | L’apport du signal de catégorie. |
domainLabels | number | oui | L’apport du signal des étiquettes de domaine. |
shape | number | oui | L’apport du signal de forme. |
name | number | oui | L’apport du signal de nom. |
Les propriétés supplémentaires ne sont pas autorisées.
DecisionChoice
Ce que l’importateur a choisi pour un nœud source. Absent d’une décision dans laquelle il n’a fait aucun choix.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
target | string | oui | Le nom du Component choisi : un Component existant du catalogue, ou celui rédigé pour le nœud. |
mode | string | oui | La façon dont le choix est écrit : comme une référence à un Component existant, ou sous une forme nouvellement rédigée. |
tier | string | oui | Le niveau de correspondance du choix. |
Les propriétés supplémentaires ne sont pas autorisées.
LintFileFindings
Ce qu’une vérification des conventions a trouvé dans un document.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
file | string | oui | Le document. |
diagnostics | Diagnostic[] ou null | oui | Les constats qu’il contient. |
Les propriétés supplémentaires ne sont pas autorisées.
PluginRetractionExclusion
Une version qui était disponible et n’a pas été choisie.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
version | string | oui | La version qui a été ignorée. |
reason | string | non | Pourquoi il a été ignoré. |
Les propriétés supplémentaires ne sont pas autorisées.
PluginRetractionProvenance
La provenance de la connaissance de ce qui est déprécié.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
source | string | oui | Ce qui a été consulté. |
lastUpdated | string | non | Le moment où cela a été rafraîchi pour la dernière fois. |
Les propriétés supplémentaires ne sont pas autorisées.
PluginRetraction
La façon dont un marqueur de dépréciation a déterminé quelle version du plugin a été épinglée.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
reference | string | oui | La référence à laquelle appartiennent les versions. |
selected | string | non | La version qui a été épinglée. |
excluded | PluginRetractionExclusion[] | non | Les versions qui étaient disponibles et ont été ignorées. |
unscreened | string | non | Ce qui n’a pas pu être contrôlé par rapport à un marqueur, et pourquoi. |
provenance | PluginRetractionProvenance | non | La provenance de la connaissance de ce qui est déprécié. |
Les propriétés supplémentaires ne sont pas autorisées.
PluginGeneratedDocument
Un document de catalogue qu’une génération a produit.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
path | string | oui | L’emplacement du document, sous la forme d’un chemin relatif à la racine de l’espace de travail. |
content | string | oui | Le texte du document. |
Les propriétés supplémentaires ne sont pas autorisées.
PluginCommandFlag
Un flag qu’un plugin déclare sur une commande qu’il fournit.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
name | string | oui | Le nom long du flag. |
shorthand | string | non | L’alias d’un seul caractère du flag, lorsqu’il en a un. |
description | string | non | Le texte d’aide d’une ligne du flag. |
type | string | non | Le type de valeur du flag. |
default | string | non | La valeur utilisée lorsque le flag n’est pas passé. |
Les propriétés supplémentaires ne sont pas autorisées.
PluginCLICommand
Un verbe de commande de premier niveau qu’un plugin fournit.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
name | string | oui | Le verbe de la commande. |
description | string | non | Le texte d’aide d’une ligne de la commande. |
flags | PluginCommandFlag[] | non | Les flags de la commande, dans l’ordre déclaré. |
Les propriétés supplémentaires ne sont pas autorisées.
ConfigCapturedAttachment
Un rattachement qu’un figement a écrit dans la configuration propre à cet espace de travail.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
uri | string | non | La référence à partir de laquelle le rattachement se résout. |
capability | string | non | La capacité à laquelle est destiné le rattachement. |
function | string | non | L’export vers lequel le rattachement est acheminé. |
role | string | non | Le rôle dans lequel s’exécute le rattachement, qui fixe ce qu’il peut émettre. |
Les propriétés supplémentaires ne sont pas autorisées.
ConfigCapturedSocket
Un socket qu’un figement a écrit, avec les rattachements qu’il y a figés.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
socket | string | oui | Le socket. |
field | string | oui | Le champ de configuration sous lequel le socket est écrit. |
attachments | ConfigCapturedAttachment[] ou null | oui | Les rattachements qui y ont été figés. |
Les propriétés supplémentaires ne sont pas autorisées.
ExplainErrorEntry
Un passage publié qui enseigne la correction d’authoring pour une condition.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
heading | string | oui | Le titre du passage. |
body | string | oui | Le passage. |
Les propriétés supplémentaires ne sont pas autorisées.
SignedArtifact
Un artefact publié qu’une signature a couvert.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
reference | string | oui | La référence qui a été signée. |
digest | string | oui | Le digest de ce qui a été signé. |
Les propriétés supplémentaires ne sont pas autorisées.
DeprecationMarked
Une version publiée qu’une dépréciation a marquée.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
reference | string | oui | La référence qui a été marquée. |
severity | const “warning” ou const “error” ou const “retracted” | oui | La force avec laquelle le marqueur s’exprime. Valeurs autorisées : "warning" — Dépréciée, au plus modéré des deux niveaux consultatifs : toujours sélectionnée lorsqu’une version est choisie. "error" — Dépréciée, au plus fort des deux niveaux consultatifs : toujours sélectionnée lorsqu’une version est choisie. "retracted" — Retirée : exclue lorsqu’une version est choisie. |
issuedOn | string | oui | Le moment où le marqueur a été émis. |
digest | string | oui | Le digest du marqueur qui a été publié. |
Les propriétés supplémentaires ne sont pas autorisées.
InitializeResult
Ce que la session a arrêté pour ce client, et la couche de configuration à partir de laquelle elle a résolu.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
capabilities | ServerCapabilities | oui | Ce que le daemon fera dans cette session, convenu par rapport à ce que le client a dit pouvoir prendre en charge. |
workspaceRoot | string | oui | L’espace de travail sur lequel la session s’est ouverte. |
configSource | string | oui | La couche de configuration à partir de laquelle la session a résolu ses réglages. |
workspaceMarker | string | non | Le fichier qui a identifié la racine de l’espace de travail, lorsqu’il y en a eu un. |
version | string | oui | La version du binaire qui répond à cette session : la même valeur que celle que aggrega version rapporte pour ce binaire. Elle décrit le processus en cours d’exécution, de sorte qu’une fois que le fichier à partir duquel le daemon a été démarré a été remplacé, ceci nomme toujours la version en cours d’exécution, tandis qu’interroger le fichier nomme la version qui l’a remplacé. |
Les propriétés supplémentaires ne sont pas autorisées.
ValidateResult
Ce que la vérification a trouvé, et ce qui a été vérifié.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
diagnostics | Diagnostic[] ou null | oui | Les constats. Il vaut null plutôt qu’une liste vide lorsque la vérification n’a rien trouvé. |
checked | string | non | Ce qui a été vérifié — un document, ou ce que contient l’espace de travail. |
Les propriétés supplémentaires ne sont pas autorisées.
InvalidateResult
Indique si le daemon conservait quoi que ce soit au sujet du document à abandonner.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
invalidated | booléen | oui | Indique si quoi que ce soit a été abandonné. |
Les propriétés supplémentaires ne sont pas autorisées.
DiagnosticsResult
Les constats que le daemon conserve déjà pour le document.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
diagnostics | Diagnostic[] ou null | oui | Les constats. Il vaut null plutôt qu’une liste vide lorsqu’il n’y en a aucun. |
Les propriétés supplémentaires ne sont pas autorisées.
IrGraphResult
Le graphe résolu vers lequel une Release se compile.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
graph | any | oui | Le document du graphe. Les valeurs qu’un auteur a déclarées sensibles en sont retenues à moins que la requête ne les ait demandées avec unredacted ; tout le reste est transmis tel que le compilateur l’a émis. Sa propre forme est le contrat publié du graphe et n’est pas répétée ici. |
Les propriétés supplémentaires ne sont pas autorisées.
BuildResult
Ce qu’un build a écrit.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
outputDirectory | string | oui | Le répertoire dans lequel les artefacts ont été écrits. |
files | string[] ou null | oui | Les artefacts qui ont été écrits, sous la forme de chemins relatifs au répertoire de sortie. |
notices | BuildNotice[] | non | Tout ce que le build veut faire savoir à l’appelant et qui n’est ni un constat ni un échec. |
dependencyResolution | DependencyResolutionReport | non | Ce qu’une résolution de dépendances a épinglé et acquis. |
Les propriétés supplémentaires ne sont pas autorisées.
BuildPreviewResult
Ce qu’un build aurait écrit. Rien n’a été écrit, il n’y a donc aucun répertoire de sortie à nommer.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
files | string[] ou null | oui | Les artefacts que l’écriture aurait produits. |
notices | BuildNotice[] | non | Tout ce que la compilation veut faire savoir à l’appelant et qui n’est ni un constat ni un échec. |
Les propriétés supplémentaires ne sont pas autorisées.
EntityDefinitionResult
Ce vers quoi se résout un nom d’entité, et le document qui la définit. Une réponse lue depuis une référence de registre porte published, et une réponse que le catalogue a résolue par nom ne le porte jamais.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
kind | string | oui | Le type d’entité. |
name | string | oui | Le nom de l’entité. |
version | string | oui | La version qui a été résolue. |
description | string | non | Ce à quoi sert l’entité selon le document. |
publishScope | string | non | L’étendue de la publication de l’entité. |
file | string | oui | Le document qui la définit. |
authoredLength | integer | oui | Le nombre d’octets que contient le document rédigé par l’auteur, afin qu’un client puisse distinguer un document rédigé par l’auteur d’un rendu résolu de celui-ci. |
definition | string | oui | Le texte de la définition. |
published | PublishedArtifact | non | Ce qu’une référence de registre a lu : la coordonnée, la façon dont elle contenait l’entité, et le manifeste à travers lequel elle a été lue. Chaque champ est présent partout où ceci l’est. |
Les propriétés supplémentaires ne sont pas autorisées.
PublishedArtifact
Ce qu’une référence de registre a lu : la coordonnée, la façon dont elle contenait l’entité, et le manifeste à travers lequel elle a été lue. Chaque champ est présent partout où ceci l’est.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
reference | string | oui | La référence de registre qui a été lue. |
archive | booléen | oui | Indique si les octets de la coordonnée étaient une archive dont le document d’entité a été extrait. False lorsque la coordonnée contenait le document d’entité lui-même. |
mediaType | string | oui | Le type d’artefact que déclare le manifeste. |
manifestDigest | string | oui | Le digest du manifeste à travers lequel l’entité a été lue — la valeur à nommer après @ pour relire exactement les mêmes octets. |
Les propriétés supplémentaires ne sont pas autorisées.
ReleaseClosureResult
Tout ce dont dépend une Release, tel que la résolution l’a atteint. Il rend compte de la fermeture plutôt que du graphe qui en est dérivé : un document différent sur la même Release.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
release | string | oui | La Release qui a été inspectée. |
aggregate | string | oui | L’Aggregate qu’elle déploie. |
manifest | string | oui | Le Manifest à travers lequel elle se résout. |
environment | string | oui | L’environnement qu’elle nomme. |
entities | ClosureEntity[] ou null | oui | Les entités qu’atteint la fermeture. |
libraries | ClosureEntity[] ou null | oui | Les bibliothèques qu’atteint la fermeture. |
plugins | ClosureEntity[] ou null | oui | Les plugins qu’atteint la fermeture. |
mappingDiagnostics | string[] ou null | oui | Ce que la résolution des correspondances du Manifest avait à dire. |
deprecations | string[] ou null | oui | Les marqueurs de dépréciation que la fermeture a rencontrés. |
Les propriétés supplémentaires ne sont pas autorisées.
ResolveDependenciesResult
Ce qu’une résolution de dépendances a épinglé et acquis, ainsi que tout ce qu’elle veut faire savoir à l’appelant. Les champs propres du rapport sont portés directement sur cette réponse plutôt qu’imbriqués sous l’un de ses champs.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
lockfile | string | oui | Le fichier de verrouillage que la résolution a écrit, ou celui auquel une vérification a comparé. |
verified | booléen | non | Indique si la requête était une vérification, qui a comparé le fichier de verrouillage enregistré et n’a écrit ni fichier de verrouillage, ni enregistrement de confiance des plugins, ni entity.lock. |
entities | ClosureEntity[] ou null | oui | Les entités que la résolution a épinglées, ou qu’une vérification a comparées. |
libraries | ClosureEntity[] ou null | oui | Les bibliothèques que la résolution a épinglées, ou qu’une vérification a comparées. |
plugins | ClosureEntity[] ou null | oui | Les plugins que la résolution a épinglés, ou qu’une vérification a comparés. |
sourceArtifacts | integer | oui | Le nombre d’artefacts sources acquis. |
trustedPlugins | integer | oui | Le nombre de plugins épinglés qui portaient une signature vérifiée. |
toolchain | ToolchainReport | non | Le compilateur qui a effectué la résolution, et les plugins qu’il porte. |
externalInputs | integer | oui | Le nombre d’entrées externes consommées par le rendu qui ont été acquises. |
incompleteExternalInputs | string | non | Les entrées externes qui n’ont pas pu être acquises, lorsque certaines n’ont pas pu l’être. |
notices | string[] | non | Tout ce que la résolution veut faire savoir à l’appelant. |
Les propriétés supplémentaires ne sont pas autorisées.
PinResult
Ce que l’étape d’épinglage a fait au verrou situé à côté d’une entité, ou ferait lors d’une exécution à blanc. C’est la réponse à aggrega/pin, et une publication qui a exécuté l’étape la porte comme son pin.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
entity | string | oui | Le document d’entité que l’étape a lu, sous la forme d’un chemin relatif à la racine de l’espace de travail. |
kind | string | oui | Le type de l’entité, tel que le déclare son document. |
name | string | oui | Le nom de l’entité, tel que le déclare son document. |
pinnable | booléen | oui | Indique si une entité de ce type lit quoi que ce soit pour lequel un verrou enregistre un épinglage, ce que font une Recipe et une FeatureRecipe. Lorsqu’il vaut false, rien à côté de l’entité n’a été touché, changed vaut false, et lock, removed, pins et content sont absents. |
lock | string | non | Le verrou que l’étape a écrit, ou écrirait, sous la forme d’un chemin relatif à la racine de l’espace de travail. |
changed | booléen | oui | Indique si le verrou a changé, ou changerait lors d’une exécution à blanc. False lorsque le verrou enregistrait déjà chaque épinglage dont l’entité a besoin et a été laissé identique octet pour octet. |
removed | booléen | non | Indique si le changement est une suppression : l’entité ne lit rien pour lequel un verrou enregistre un épinglage, de sorte qu’aucun verrou n’est laissé à côté d’elle. |
dryRun | booléen | non | Indique si ceci rend compte de ce que l’étape ferait plutôt que de ce qu’elle a fait. |
pins | PinClassCount[] | non | Le nombre d’épinglages de chaque classe que contient le verrou après l’étape, ou contiendrait après une exécution à blanc. Chaque classe que le verrou peut contenir est listée, y compris une classe sans épinglage. |
content | string | non | Le verrou qu’une exécution à blanc écrirait. Absent lorsque le verrou serait laissé tel quel ou supprimé, et dans toute réponse qui n’est pas une exécution à blanc. |
Les propriétés supplémentaires ne sont pas autorisées.
PinClassCount
Le nombre d’épinglages d’une classe que contient un verrou.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
class | string | oui | La classe de l’épinglage, dans les mots qu’emploie un refus qui en nomme un manquant — remote source ou imported file, par exemple. |
pins | integer | oui | Le nombre d’épinglages de cette classe que contient le verrou. |
Les propriétés supplémentaires ne sont pas autorisées.
CacheStatusResult
Ce que contiennent les caches qui servent cet espace de travail.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
classes | CacheClass[] ou null | oui | Chaque cache et ce qu’il contient. |
provenance | CacheProvenance[] ou null | oui | Sous quelles identités les artefacts en cache ont été acquis. |
totalCount | integer | oui | Le nombre total d’entrées que contiennent les caches. |
totalSize | integer | oui | Le nombre total d’octets qu’ils occupent. |
totalSizeText | string | oui | Le même total écrit de la manière dont une personne le lit. |
scope | CacheScope | oui | Jusqu’où porte une réponse sur le cache. Deux des classes de cache sont partagées par tous les projets de la machine, de sorte que chaque réponse sur le cache nomme celles qu’elle a touchées — sinon, une session ouverte sur un espace de travail serait lue comme ne rendant compte que de cet espace de travail. |
Les propriétés supplémentaires ne sont pas autorisées.
CachePruneResult
Ce qu’une récupération d’espace a supprimé, ce qu’elle a conservé et ce qu’elle n’a pas pu récupérer.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
removed | CacheRemoval[] ou null | oui | Ce qui a été supprimé. |
heldOpen | CacheRemoval[] ou null | oui | Ce que l’élagage aurait supprimé mais a laissé en place parce qu’un autre processus l’avait ouvert. Seul Windows refuse de supprimer un fichier ouvert, de sorte que partout ailleurs ceci est vide. Ces entrées ne sont comptées ni comme supprimées ni comme conservées, aucun de leurs octets ne compte comme récupéré, et un élagage ultérieur les récupère ; une entrée qui est un répertoire peut avoir déjà perdu les fichiers qu’elle contenait et qui n’étaient pas ouverts. |
retainedCount | integer | oui | Le nombre d’entrées conservées. |
reclaimedBytes | integer | oui | Le nombre d’octets récupérés. |
reclaimedBytesText | string | oui | Le même chiffre écrit de la manière dont une personne le lit. |
unattributedCount | integer | oui | Le nombre d’entrées qu’aucun détenteur ne revendique. |
unattributedSize | integer | oui | Le nombre d’octets que celles-ci occupent. |
unattributedSizeText | string | oui | Le même chiffre écrit de la manière dont une personne le lit. |
notPruneEligible | CacheShortfall[] ou null | oui | Ce qui a été laissé derrière, et ce qui le récupérerait. |
scope | CacheScope | oui | Jusqu’où porte une réponse sur le cache. Deux des classes de cache sont partagées par tous les projets de la machine, de sorte que chaque réponse sur le cache nomme celles qu’elle a touchées — sinon, une session ouverte sur un espace de travail serait lue comme ne rendant compte que de cet espace de travail. |
Les propriétés supplémentaires ne sont pas autorisées.
CacheEvictResult
Ce que la récupération d’espace jusqu’à une taille a supprimé, et ce qui reste.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
withinCapBefore | booléen | oui | Indique si ce qui était conservé tenait déjà sous la taille, de sorte que rien n’a eu besoin d’être supprimé. |
removed | CacheRemoval[] ou null | oui | Ce qui a été supprimé. |
heldOpen | CacheRemoval[] ou null | oui | Ce que la récupération d’espace aurait supprimé mais a laissé en place parce qu’un autre processus l’avait ouvert ; elle est passée à la place à l’entrée suivante la plus ancienne. Seul Windows refuse de supprimer un fichier ouvert, de sorte que partout ailleurs ceci est vide. Ces entrées comptent toujours dans les octets qui restent, et une récupération d’espace ultérieure peut les supprimer. |
totalBefore | integer | oui | Le nombre d’octets conservés auparavant. |
totalBeforeText | string | oui | Le même chiffre écrit de la manière dont une personne le lit. |
reclaimedBytes | integer | oui | Le nombre d’octets récupérés. |
reclaimedBytesText | string | oui | Le même chiffre écrit de la manière dont une personne le lit. |
remainingBytes | integer | oui | Le nombre d’octets qui restent. |
remainingBytesText | string | oui | Le même chiffre écrit de la manière dont une personne le lit. |
capBytes | integer | oui | La taille jusqu’à laquelle l’espace a été récupéré, en octets. |
capBytesText | string | oui | La même taille écrite de la manière dont une personne la lit. |
scope | CacheScope | oui | Jusqu’où porte une réponse sur le cache. Deux des classes de cache sont partagées par tous les projets de la machine, de sorte que chaque réponse sur le cache nomme celles qu’elle a touchées — sinon, une session ouverte sur un espace de travail serait lue comme ne rendant compte que de cet espace de travail. |
Les propriétés supplémentaires ne sont pas autorisées.
CacheClearResult
Ce que le vidage des caches a récupéré.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
cleared | CacheCleared[] ou null | oui | Chaque cache qui a été vidé. |
reclaimedBytes | integer | oui | Le nombre d’octets récupérés. |
reclaimedBytesText | string | oui | Le même chiffre écrit de la manière dont une personne le lit. |
scope | CacheScope | oui | Jusqu’où porte une réponse sur le cache. Deux des classes de cache sont partagées par tous les projets de la machine, de sorte que chaque réponse sur le cache nomme celles qu’elle a touchées — sinon, une session ouverte sur un espace de travail serait lue comme ne rendant compte que de cet espace de travail. |
Les propriétés supplémentaires ne sont pas autorisées.
RegistryListResult
Les registres au moyen desquels résout cet espace de travail.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
registries | Registry[] ou null | oui | Chaque registre configuré. |
credentialStateIsMachineWide | booléen | oui | Indique si la présence d’identifiants de connexion signalée pour chaque registre est un fait à l’échelle de toute la machine plutôt qu’un fait de l’espace de travail. Il est signalé afin qu’une réponse limitée à la session ne soit pas lue comme niant la portée plus large. |
Les propriétés supplémentaires ne sont pas autorisées.
SearchResult
Ce que les index locaux des registres ont proposé pour la recherche.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
records | RegistrySearchRecord[] ou null | oui | Les enregistrements qui ont correspondu. |
indexes | RegistrySearchIndex[] ou null | oui | Chaque hôte interrogé et le moment où son index a été rafraîchi pour la dernière fois. |
missingIndexHosts | string[] ou null | oui | Les hôtes configurés sans index local à interroger, de sorte qu’une réponse courte est expliquée plutôt que laissée à déduire. |
stale | booléen | oui | Indique si un index interrogé est assez ancien pour qu’il vaille la peine de le rafraîchir. |
registriesConfigured | booléen | oui | Indique si au moins un registre est configuré, ce qui distingue « rien n’a correspondu » de « rien n’a été interrogé ». |
Les propriétés supplémentaires ne sont pas autorisées.
RegistryAddResult
Ce que l’enregistrement d’un registre a écrit, où, et ce qu’il a lu depuis le registre lui-même.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
host | string | oui | L’hôte sous lequel l’entrée est indexée, qui n’est pas toujours la graphie qu’a utilisée la requête. |
scope | ConfigWriteScope | oui | Quel document de configuration a été écrit et jusqu’où il porte. Une requête nomme un espace de travail, de sorte qu’une réponse qui ne dirait rien serait lue comme portant sur cet espace de travail — et pour une écriture à l’échelle de toute la machine, cette lecture est fausse. |
trust | TrustFetchOutcome | oui | Ce qu’a donné la lecture de la politique de confiance annoncée par un registre. Les résultats sont tenus séparés parce qu’ils signifient des choses différentes : la politique annoncée a été adoptée, le registre n’a rien annoncé — ce qui n’est pas un échec —, la base de référence intégrée a été épinglée à sa place, ou aucune lecture n’a été tentée. Lorsque rien n’a été annoncé, il est indiqué à côté si le registre a pu être atteint ou non. |
Les propriétés supplémentaires ne sont pas autorisées.
RegistryRemoveResult
Ce que la suppression d’un registre a écrit, et où.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
host | string | oui | L’hôte dont l’entrée a été supprimée. |
scope | ConfigWriteScope | oui | Quel document de configuration a été écrit et jusqu’où il porte. Une requête nomme un espace de travail, de sorte qu’une réponse qui ne dirait rien serait lue comme portant sur cet espace de travail — et pour une écriture à l’échelle de toute la machine, cette lecture est fausse. |
Les propriétés supplémentaires ne sont pas autorisées.
RegistryUpdateResult
Ce que le rafraîchissement des index locaux a fait, par hôte.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
hosts | HostUpdate[] ou null | oui | Ce que le rafraîchissement a fait pour chaque hôte. |
failed | string[] ou null | oui | Les hôtes pour lesquels le rafraîchissement n’a pas pu aboutir. |
indexRoot | string | oui | Le répertoire sous lequel les index ont été écrits. |
registriesConfigured | booléen | oui | Indique si au moins un registre est configuré. |
reachedRegistries | booléen | oui | Toujours true sur cette réponse : le rafraîchissement des index s’adresse aux registres eux-mêmes, alors que leur listage et la recherche répondent à partir de la configuration et d’un index local. Le fait qu’un registre donné ait effectivement été atteint est indiqué dans sa propre entrée dans hosts, par unreachable. |
Les propriétés supplémentaires ne sont pas autorisées.
LogoutResult
Quel identifiant de connexion stocké a été supprimé, et jusqu’où porte le magasin.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
registry | string | oui | Le registre dont l’identifiant de connexion a été supprimé. |
scope | CredentialStoreScope | oui | Jusqu’où porte une modification d’identifiant de connexion. Le magasin est partagé par chaque projet de la machine et par tout autre outil qui s’adresse aux mêmes registres, de sorte que la réponse le signale plutôt que de laisser déduire une lecture limitée à la session. |
Les propriétés supplémentaires ne sont pas autorisées.
PublishEntityResult
Ce qu’a déposé la publication d’une entité, et où. Une publication qui a d’abord exécuté l’étape d’épinglage porte aussi ce que cette étape a fait, sous la forme de pin, qui est absent lorsque l’étape ne s’est pas exécutée.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
reference | string | oui | La référence sous laquelle l’entité a été publiée. |
tag | string | oui | Le tag sous lequel elle a été publiée. |
kind | string | oui | Le type d’entité qui a été publié. |
mediaType | string | oui | Le type de média enregistré pour les octets publiés. |
size | integer | oui | Combien d’octets ont été publiés. |
sizeText | string | oui | La même taille écrite de la manière dont une personne la lit. |
pluginSize | integer | non | Combien d’octets occupe le module de plugin publié avec une entité Plugin. |
pluginSizeText | string | non | La même taille écrite de la manière dont une personne la lit. |
digest | string | oui | Le digest de ce qui a été publié. Lors d’une exécution à blanc, le digest qu’une publication du même contenu déposerait, calculé à partir du seul contenu : celui qu’affiche aggrega push --dry-run. |
signed | booléen | oui | Indique si cette publication a attaché une signature : celle qu’elle a créée avant de publier ou, sur une version déjà publiée, une signature qui manquait à la version. |
alreadyPublished | booléen | oui | Indique si les mêmes octets étaient déjà présents, de sorte qu’aucun contenu n’a été téléversé. Seul ce qui manquait encore à cette publication-là a été attaché à côté : sa date de publication et, lorsque cette publication signe, sa signature ; signed indique si une signature a été attachée. |
dryRun | booléen | oui | Indique si ceci rend compte de ce que la publication aurait déposé plutôt que de ce qu’elle a déposé. |
reach | PublicationReach | oui | Jusqu’où une publication a porté. Ces réponses portent entièrement au-delà de cette machine — ce qu’elles attachent est ce que résout chaque consommateur de ce registre — de sorte que chacune nomme chaque registre auquel elle s’est adressée et indique si l’appel y a attaché quoi que ce soit. |
pin | PinResult | non | Ce que l’étape d’épinglage a fait au verrou situé à côté d’une entité, ou ferait lors d’une exécution à blanc. C’est la réponse à aggrega/pin, et une publication qui a exécuté l’étape la porte comme son pin. |
wholeDirectorySource | string | non | La source locale de l’entité telle qu’écrite, présente lorsqu’elle est écrite sous forme de template. Une telle source ne nomme son répertoire qu’une fois qu’une Release remplit le template, de sorte que la publication porte chaque fichier du répertoire de l’entité plutôt que seulement les fichiers que nomme l’entité. Absent lorsqu’elle ne porte que ces fichiers. |
windowsUnusableEntries | string[] | non | Les entrées de l’archive publiée dont le chemin contient une partie que Windows ne peut pas contenir telle qu’écrite — un nom que Windows réserve à un périphérique, comme CON, AUX ou NUL, quelle que soit la casse et quelle que soit l’extension qui suit, ou une partie se terminant par un point ou une espace —, le nom de fichier propre au document de l’entité en premier, puis les fichiers qu’il porte. Un espace de travail sous Windows refuse de les décompresser, et ne peut donc pas utiliser la version ; la publication se poursuit ou s’arrête exactement comme elle le ferait sans elles. Absent lorsqu’il n’y en a aucune, ce qui inclut une entité publiée sous la forme de son seul document. |
Les propriétés supplémentaires ne sont pas autorisées.
PublishArtifactResult
Ce qu’a déposé la publication d’un fichier, et où.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
reference | string | oui | La référence sous laquelle le fichier a été publié. |
tag | string | oui | Le tag sous lequel elle a été publiée. |
mediaType | string | oui | Le type de média enregistré pour les octets publiés. |
size | integer | oui | Combien d’octets ont été publiés. |
sizeText | string | oui | La même taille écrite de la manière dont une personne la lit. |
digest | string | oui | Le digest de ce qui a été publié. |
alreadyPublished | booléen | oui | Indique si les mêmes octets étaient déjà présents, de sorte qu’aucun contenu n’a été téléversé. Une date de publication a été attachée à côté seulement lorsque l’artefact n’en avait pas. |
dryRun | booléen | oui | Indique si ceci rend compte de ce que la publication aurait déposé plutôt que de ce qu’elle a déposé. |
reach | PublicationReach | oui | Jusqu’où une publication a porté. Ces réponses portent entièrement au-delà de cette machine — ce qu’elles attachent est ce que résout chaque consommateur de ce registre — de sorte que chacune nomme chaque registre auquel elle s’est adressée et indique si l’appel y a attaché quoi que ce soit. |
Les propriétés supplémentaires ne sont pas autorisées.
SignArtifactsResult
Ce qui a été signé, et où les signatures ont été déposées.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
signed | SignedArtifact[] ou null | oui | Chaque référence qui a été signée. |
reach | PublicationReach | oui | Jusqu’où une publication a porté. Ces réponses portent entièrement au-delà de cette machine — ce qu’elles attachent est ce que résout chaque consommateur de ce registre — de sorte que chacune nomme chaque registre auquel elle s’est adressée et indique si l’appel y a attaché quoi que ce soit. |
Les propriétés supplémentaires ne sont pas autorisées.
DeprecateArtifactResult
Ce qui a été marqué comme déprécié, et où les marqueurs ont été déposés.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
marked | DeprecationMarked[] ou null | oui | Chaque version qui a été marquée. |
reach | PublicationReach | oui | Jusqu’où une publication a porté. Ces réponses portent entièrement au-delà de cette machine — ce qu’elles attachent est ce que résout chaque consommateur de ce registre — de sorte que chacune nomme chaque registre auquel elle s’est adressée et indique si l’appel y a attaché quoi que ce soit. |
Les propriétés supplémentaires ne sont pas autorisées.
ResolveResult
Où est défini l’élément sous le curseur.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
location | null ou Location | oui | Où il est défini. Il vaut null lorsque rien sous le curseur ne se résout vers une définition. |
Les propriétés supplémentaires ne sont pas autorisées.
FindReferencesResult
Où il est fait référence à l’élément sous le curseur.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
locations | Location[] ou null | oui | Chaque endroit où il y est fait référence. |
Les propriétés supplémentaires ne sont pas autorisées.
FindImplementationsResult
Quels documents implémentent l’élément sous le curseur.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
locations | Location[] ou null | oui | Chaque endroit où il est implémenté. |
Les propriétés supplémentaires ne sont pas autorisées.
HoverResult
Ce qu’il faut afficher à propos de l’élément sous le curseur.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
contents | null ou MarkupContent | oui | Ce qu’il faut afficher. Il vaut null lorsqu’il n’y a rien à dire sur ce qui se trouve sous le curseur. |
Les propriétés supplémentaires ne sont pas autorisées.
CompletionResult
Ce qui peut être écrit à l’emplacement du curseur.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
items | CompletionItem[] ou null | oui | Chaque élément qui peut être écrit. |
Les propriétés supplémentaires ne sont pas autorisées.
CatalogIndexResult
Chaque entité que contient l’index de l’espace de travail, et les liens menant hors de l’espace de travail, vers des répertoires et vers des fichiers, qui n’ont pas été lus pour lui.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
entities | CatalogEntity[] ou null | oui | Chaque entité. |
unreadLinkedDirs | string[] | oui | Chaque lien sous la racine de l’espace de travail qui mène à un répertoire situé hors de celle-ci, nommé relativement à la racine à l’endroit où se trouve le lien lui-même, dans l’ordre dans lequel l’espace de travail est parcouru. Aucun répertoire hors de la racine n’est parcouru, de sorte qu’aucun document derrière l’un de ces liens ne figure parmi entities comme propre à l’espace de travail, et un client qui liste les entités peut dire pourquoi. Non nommés : un lien vers un répertoire situé à l’intérieur de la racine, qui est parcouru, ou laissé de côté, là où il se trouve réellement ; un lien partout où un répertoire serait laissé de côté, que ce soit en raison de l’endroit où il se trouve, de son nom ou d’un .gitignore ; un lien qui ne peut pas être résolu, parce qu’il ne mène nulle part ou tourne en boucle ; et, dans une réponse donnée dans les termes d’une Release, un lien situé sous un répertoire de catalogue que seules d’autres Releases lisent. Vide lorsque l’espace de travail n’en contient aucun. |
unreadLinkedFiles | string[] | oui | Chaque lien sous la racine de l’espace de travail qui est nommé comme un fichier YAML, son propre nom se terminant par .yaml ou .yml, et qui mène à un fichier situé hors de la racine, nommé relativement à la racine à l’endroit où se trouve le lien lui-même, dans l’ordre dans lequel l’espace de travail est parcouru. Un tel fichier n’est pas lu pour l’index, quoi qu’il déclare, de sorte que l’entité qu’il déclare ne figure pas parmi entities comme propre à l’espace de travail, et un client qui liste les entités peut dire pourquoi ; les répertoires de catalogue configurés sont le moyen par lequel les entités situées hors de l’espace de travail sont lues. Non nommés : un lien vers un fichier que la configuration de l’espace de travail nomme comme Release, comme build.authoring_release ou comme clé de workspace.releases, et qui en déclare une, lequel est lu et listé dans entities à l’endroit propre au lien ; un lien vers un fichier situé à l’intérieur de la racine, qui est lu à l’endroit propre au lien ; un lien qu’un .gitignore laisse de côté, ou un lien situé dans un répertoire que la recherche laisse de côté ; un lien qui ne mène à aucun fichier, que ce soit vers un répertoire, que nomme unreadLinkedDirs lorsqu’il mène hors de la racine, nulle part, ou en boucle ; et, dans une réponse donnée dans les termes d’une Release, un lien situé sous un répertoire de catalogue que seules d’autres Releases lisent. Un fichier de configuration de l’espace de travail qui est un lien menant hors de l’espace de travail, son propre .aggrega-config.yaml ou l’overlay détenu par la CI à côté de lui, est nommé que la recherche l’ait rencontré ou non, après les liens que la recherche a nommés : la configuration de l’espace de travail n’est alors pas lue du tout, cette réponse est l’index propre à l’espace de travail lu sans rien de configuré, de sorte qu’aucun répertoire de catalogue n’est lu pour lui, et chaque requête que décide la configuration, un index dans les termes d’une Release compris, est refusée pour cet espace de travail avec la condition du blocage de lecture. |
Les propriétés supplémentaires ne sont pas autorisées.
AttachCandidatesResult
Quelles Features peuvent être rattachées à l’entité, et les étiquettes d’après lesquelles elles ont été jugées ; et, pour une connexion que la requête a nommée, les slots que déclare son socket avec les Features qui peuvent remplir chacun d’eux.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
node | string | oui | L’entité pour laquelle les candidats ont été jugés. |
nodeLabels | map de string ou null | oui | Les étiquettes d’après lesquelles le jugement a été rendu. |
labelSource | string | oui | Quel ensemble d’étiquettes a été utilisé, ce qui n’est pas anodin : les étiquettes déclarées d’un document sont ce qu’une lecture de la source peut voir, tandis que celles d’un nœud du graphe sont l’ensemble finalisé d’après lequel le build lui-même juge. Une réponse calculée sur le second est une affirmation sur ce que fera le build. |
candidates | SourcedEntityRef[] ou null | oui | Chaque Feature qui peut être rattachée. |
slots | SlotCandidacy[] | non | Présent uniquement lorsque la requête a nommé une connexion : chaque slot que déclare le socket de la connexion, dans l’ordre dans lequel le Component les déclare, avec les Features qui peuvent le remplir. Vide lorsqu’aucun slot ne peut être rempli sur la connexion, et noSlotReason dit alors pourquoi — ce qu’un client lit plutôt que de prendre une liste vide pour des slots auxquels aucune Feature ne correspondait. |
noSlotReason | const “feature-created-connection” ou const “ad-hoc-socket” ou const “no-slot-declared” | non | Présent uniquement lorsque la requête a nommé une connexion et qu’aucun slot ne peut y être rempli : pourquoi rien ne peut s’y rattacher. Absent partout où le socket déclare un slot. L’ensemble est fermé. Valeurs autorisées : "feature-created-connection" — Une Feature a tracé la connexion, et un rattachement n’est écrit que sur une connexion que trace un composant ou la Release. "ad-hoc-socket" — Le socket est un socket que le Component ne déclare pas, de sorte qu’il ne déclare aucun slot qu’une connexion puisse remplir. "no-slot-declared" — Le Component déclare le socket et ne déclare aucun slot sur celui-ci. |
Les propriétés supplémentaires ne sont pas autorisées.
ConnectionCandidatesResult
À quelles entités chaque socket de l’entité peut être relié.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
node | string | oui | L’entité dont ce sont les sockets. |
adHocSocketsAccepted | booléen | oui | Indique si un socket que la définition propre de l’entité ne déclare pas à l’avance peut tout de même être écrit. |
sockets | SocketCandidacy[] ou null | oui | Chaque socket et ce qui peut y être relié. |
Les propriétés supplémentaires ne sont pas autorisées.
InsertionPointResult
Où, dans le document, se place une nouvelle entrée sous le conteneur nommé, et ce dont un client a besoin pour l’y écrire : le point lui-même, si un saut de ligne doit ouvrir le texte, les clés de conteneur encore manquantes, et l’indentation que prend chaque ligne.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
file | string | oui | Le document. |
container | string[] ou null | oui | Le chemin à travers le document jusqu’au conteneur. |
positionEncoding | string | oui | L’encodage dans lequel sont exprimées les positions de cette réponse. |
position | Position | oui | Un endroit dans un document : une ligne et un décalage de caractère dans celle-ci, tous deux comptés à partir de zéro. Le décalage est mesuré dans les unités de l’encodage dont la session a convenu à son ouverture, qui est UTF-16 sauf si le client en a demandé un autre. |
precededByLineBreak | booléen | oui | Indique si le texte écrit à la position doit commencer par un saut de ligne, parce que la position se trouve à la fin d’une ligne que le document contient déjà. Il ne vaut false que lorsque le document ne contient rien que l’entrée puisse suivre. |
missingContainerKeys | string[] ou null | oui | Les segments du chemin du conteneur que le document ne contient pas encore, le plus externe en premier. Chacun doit être écrit comme une clé à part entière, indenté d’un cran de plus que le précédent, avant que l’entrée puisse aller à l’intérieur du plus interne. Il vaut null lorsque le chemin entier est déjà présent. |
entryIndent | integer | oui | La colonne à laquelle commence la première ligne propre de l’entrée, comptée en espaces depuis le début de la ligne. |
indentStep | integer | oui | De combien chaque niveau d’imbrication est indenté en plus. |
indentStepMeasured | booléen | oui | Indique si le pas a été mesuré d’après l’imbrication propre de ce document. Lorsqu’il vaut false, le document ne présente aucune imbrication à mesurer et le pas est une valeur de repli, de sorte qu’un client qui préférerait imposer le sien sait qu’il est libre de le faire. |
entryShape | const “mapping” ou const “sequence” ou const “unknown” | oui | La forme sous laquelle le conteneur porte ses entrées, ce qui décide de la façon dont le texte propre de l’entrée est composé. Elle est lue sur le conteneur que le document contient déjà et n’est jamais déduite du nom du conteneur. L’ensemble est fermé. Valeurs autorisées : "mapping" — Le conteneur est un mapping de bloc, de sorte qu’une entrée qui lui est ajoutée est une clé et sa valeur. "sequence" — Le conteneur est une séquence de bloc, de sorte qu’une entrée qui lui est ajoutée est un tiret et sa valeur. "unknown" — Le document ne contient pas le conteneur, ou le contient sans rien à l’intérieur, de sorte qu’il revient au client de décider quelle forme prend une entrée. |
Les propriétés supplémentaires ne sont pas autorisées.
AttachmentContainerResult
Dans quel document, et à quel endroit de celui-ci, se place un rattachement sur le nœud du graphe, ou sur la connexion que la requête a nommée.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
node | string | oui | Le nœud du graphe auquel le rattachement est destiné. |
file | string | oui | Le document dans lequel se place le rattachement. |
container | string[] ou null | oui | Le chemin à travers ce document jusqu’à l’endroit où il se place. |
Les propriétés supplémentaires ne sont pas autorisées.
ConnectionAtPositionResult
La connexion dans l’entrée de laquelle tombe la position, ou pourquoi aucune n’est signalée. Exactement une moitié est présente : graphNode et connection ensemble, ou noConnectionReason seul. Une position n’importe où à l’intérieur d’une entrée — sur son alias, sa cible ou ses rattachements — est à l’intérieur de cette entrée, la plus interne là où des entrées s’imbriquent ; une position sur la clé propre d’un socket, au-dessus des entrées écrites sous celle-ci, n’est à l’intérieur d’aucune.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
graphNode | string | non | L’id du nœud dont le composant trace la connexion, tel que le graphe compilé l’indexe — la valeur que les requêtes de candidature et de conteneur prennent comme graphNode. |
connection | ConnectionCoordinate | non | La connexion, par son socket et son alias, avec document nommant le document dans lequel la position a été lue — la valeur que les requêtes de candidature et de conteneur prennent comme connection. |
noConnectionReason | const “no-connection-entry” ou const “feature-created-connection” ou const “unknown-connection” | non | Présent uniquement lorsqu’aucune connexion n’est signalée : pourquoi. L’ensemble est fermé. Valeurs autorisées : "no-connection-entry" — La position ne se trouve sur aucune entrée dans laquelle un rattachement est écrit : ni une connexion que trace un composant, écrite sous son alias, ni une entrée par arête dans la Release. Une connexion écrite sous forme de liste de cibles, et une connexion que trace le bloc propre d’une Feature, ne portent aucune entrée de ce genre. "feature-created-connection" — La position se trouve sur l’entrée de la Release pour une connexion qu’une Feature a tracée, et un rattachement n’est écrit que sur une connexion que trace un composant ou la Release. "unknown-connection" — La position se trouve sur une entrée qu’écrit la Release pour une connexion que le graphe compilé ne contient pas. |
Les propriétés supplémentaires ne sont pas autorisées.
ReleaseCandidatesResult
Les Releases que contient l’espace de travail, et les liens menant hors de celui-ci, vers des répertoires et vers des fichiers, qui n’ont pas été lus pour elles.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
releases | string[] ou null | oui | Chaque document de Release. |
lockfiles | map de string | oui | Le fichier de verrouillage de chaque Release listée, indexé par la Release exactement telle qu’elle est listée. Chacun est le fichier qu’un pull écrit pour cette Release et qu’un build lit, de sorte qu’un client lit l’endroit où il se trouve plutôt que de le déduire. Vide lorsque l’espace de travail ne contient aucune Release. |
unreadLinkedDirs | string[] | oui | Chaque lien sous la racine de l’espace de travail qui mène à un répertoire situé hors de celle-ci, nommé relativement à la racine à l’endroit où se trouve le lien lui-même, dans l’ordre dans lequel l’espace de travail est parcouru. Aucun répertoire hors de la racine n’est parcouru, de sorte qu’une Release atteinte uniquement par l’un de ces liens ne figure pas dans releases, et un client qui propose des Releases peut dire pourquoi. Non nommés : un lien vers un répertoire situé à l’intérieur de la racine, qui est parcouru, ou laissé de côté, là où il se trouve réellement ; un lien partout où un répertoire serait laissé de côté, que ce soit en raison de l’endroit où il se trouve ou de son nom ; et un lien qui ne peut pas être résolu, parce qu’il ne mène nulle part ou tourne en boucle. Vide lorsque l’espace de travail n’en contient aucun. |
unreadLinkedFiles | string[] | oui | Chaque lien sous la racine de l’espace de travail qui est nommé comme un fichier YAML, son propre nom se terminant par .yaml ou .yml, et qui mène à un fichier situé hors de la racine, nommé relativement à la racine à l’endroit où se trouve le lien lui-même, dans l’ordre dans lequel l’espace de travail est parcouru. Un tel fichier n’est pas lu, de sorte qu’une Release atteinte uniquement par l’un de ces liens ne figure pas dans releases, et un client qui propose des Releases peut dire pourquoi. Le fait qu’un fichier soit une Release n’est pas connu sans le lire, de sorte que chacun de ces liens est nommé quel que soit le contenu du fichier. Non nommés : un lien vers un fichier que la configuration de l’espace de travail nomme comme Release, comme build.authoring_release ou comme clé de workspace.releases, lequel est lu et listé dans releases à l’endroit propre au lien ; un lien vers un fichier situé à l’intérieur de la racine, qui est lu ; un lien situé dans un répertoire que la recherche laisse de côté ; et un lien qui ne mène à aucun fichier, que ce soit vers un répertoire, que nomme unreadLinkedDirs lorsqu’il mène hors de la racine, nulle part, ou en boucle. Un fichier de configuration de l’espace de travail qui est un lien menant hors de l’espace de travail, son propre .aggrega-config.yaml ou l’overlay détenu par la CI à côté de lui, est nommé que la recherche l’ait rencontré ou non, après les liens que la recherche a nommés : la configuration de l’espace de travail n’est alors pas lue du tout, cette réponse est lue sans rien de configuré, de sorte qu’aucune Release que la configuration nomme par un lien n’est listée, et chaque requête que décide la configuration est refusée pour cet espace de travail avec la condition du blocage de lecture. |
Les propriétés supplémentaires ne sont pas autorisées.
ActiveReleaseResult
Sur quelle Release un client devrait agir par défaut. Un espace de travail qui ne pointe vers aucune Release est un état ordinaire plutôt qu’un échec, de sorte qu’il est signalé ici avec un compte rendu de la manière dont le choix a été tenté plutôt que levé comme une erreur.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
release | string | oui | La Release sur laquelle le choix s’est arrêté, ou vide lorsqu’il ne s’est arrêté sur aucune. |
lockfile | string | non | Le fichier de verrouillage de la Release sur laquelle le choix s’est arrêté : le fichier qu’un pull écrit pour elle et qu’un build lit. Absent lorsque le choix ne s’est arrêté sur aucune Release. |
reason | string | non | Pourquoi le choix ne s’est arrêté sur aucune Release. |
trace | string | non | Chaque étape du choix et ce qu’elle a trouvé, de sorte qu’un appelant peut voir laquelle l’aurait tranché. |
Les propriétés supplémentaires ne sont pas autorisées.
EditDocumentResult
Ce qu’a écrit la modification, et où. Après une écriture, la lecture du document que détient le daemon est abandonnée, de sorte que la prochaine réponse le concernant est calculée à partir des octets que la modification a produits.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
file | string | oui | Le document qui a été modifié. |
edit | string | oui | Quelle modification a été appliquée. |
container | string[] ou null | oui | Le chemin à travers le document jusqu’à l’endroit où la modification a abouti. |
createdContainers | string[] ou null | oui | Les conteneurs que la modification a dû créer en chemin. |
written | string[] ou null | oui | Les documents qui ont été écrits. |
content | string | oui | Le document composé, pour une requête qui a demandé à voir le résultat plutôt qu’à le faire écrire. |
Les propriétés supplémentaires ne sont pas autorisées.
EffectiveConfigurationResult
La configuration que l’espace de travail a résolue, et le document dont provient chaque réglage.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
layers | string[] ou null | oui | Les documents de configuration qui ont été fusionnés, dans l’ordre dans lequel ils ont été fusionnés. |
settings | EffectiveConfigurationSetting[] ou null | oui | Chaque réglage résolu et sa provenance. |
Les propriétés supplémentaires ne sont pas autorisées.
ConfigInitResult
Ce qu’a écrit l’initialisation d’une configuration, où, et ce qu’elle a lu dans le registre.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
host | string | oui | Le registre pour lequel la configuration a été initialisée. |
scope | ConfigWriteScope | oui | Quel document de configuration a été écrit et jusqu’où il porte. Une requête nomme un espace de travail, de sorte qu’une réponse qui ne dirait rien serait lue comme portant sur cet espace de travail — et pour une écriture à l’échelle de toute la machine, cette lecture est fausse. |
trust | TrustFetchOutcome | oui | Ce qu’a donné la lecture de la politique de confiance annoncée par un registre. Les résultats sont tenus séparés parce qu’ils signifient des choses différentes : la politique annoncée a été adoptée, le registre n’a rien annoncé — ce qui n’est pas un échec —, la base de référence intégrée a été épinglée à sa place, ou aucune lecture n’a été tentée. Lorsque rien n’a été annoncé, il est indiqué à côté si le registre a pu être atteint ou non. |
written | booléen | oui | Indique si le document a été écrit, par opposition à renvoyé pour que l’appelant le place. |
existed | booléen | non | Présent et vaut true lorsque le document était déjà là, de sorte que l’entrée de registre y a été fusionnée plutôt qu’un nouveau document soit créé. Seule une requête envoyant force poursuit sur un document existant, de sorte qu’il est absent de toute réponse à une requête qui ne l’a pas fait. |
content | string | non | Le texte du document, pour une requête qui a demandé à le voir plutôt qu’à le faire écrire. |
Les propriétés supplémentaires ne sont pas autorisées.
ConfigCaptureResult
Ce que le figement de la configuration résolue a écrit dans le document propre de cet espace de travail.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
configFile | string | oui | Le document qui a été écrit. C’est toujours celui de cet espace de travail, puisque tout l’objet est de rendre un espace de travail autonome. |
workspaceRoot | string | oui | L’espace de travail que la requête a nommé. |
captured | booléen | oui | Indique si quoi que ce soit a été figé. |
sockets | ConfigCapturedSocket[] ou null | oui | Chaque socket qui a été figé, avec ses rattachements. |
catalogDirs | string[] ou null | oui | Les répertoires de catalogue qui ont été figés. |
Les propriétés supplémentaires ne sont pas autorisées.
ImportResult
Ce qu’a produit la conversion d’une source étrangère, et ce qu’elle n’a pas pu convertir.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
format | string | oui | Le format source qui a été converti. |
outputDir | string | oui | Le répertoire auquel chaque chemin de la réponse est relatif, et celui dans lequel les fichiers ont été écrits. |
written | string[] ou null | oui | Chaque fichier qui a atteint le disque, dans l’ordre d’écriture : les brouillons, puis l’enregistrement de ce que l’import a écrit. Sous sync, uniquement les brouillons que la synchronisation a modifiés et l’enregistrement lorsqu’il a changé. Vide sous dryRun. |
files | ImportedFile[] ou null | oui | Chaque fichier que la requête écrit, avec son texte, sous dryRun et sans : chaque brouillon, puis l’enregistrement de ce que l’import a écrit. Sous sync, chaque brouillon que la synchronisation modifie, avec son nouveau texte, puis l’enregistrement lorsqu’il change aussi, de sorte qu’une synchronisation déjà à jour répond par une liste vide. |
drift | ImportDrift[] | oui | Chaque partie qu’une synchronisation a mise à jour par rapport à la source, ou mettrait à jour sous dryRun, dans l’ordre dans lequel le brouillon les nomme ; un fichier rédigé que la synchronisation supprime en fait partie, retiré sans clés. Une liste vide pour une requête qui n’est pas une synchronisation, pour une synchronisation déjà à jour, et pour une synchronisation dont la conversion s’est arrêtée, qui n’écrit rien. |
diagnostics | ImportDiagnostic[] ou null | oui | Ce qui n’a pas pu être converti. |
decisions | ImportDecision[] | oui | La façon dont l’importateur a associé chaque nœud source, dans l’ordre de l’importateur et exactement tel qu’il l’a signalé : ce qui vous indique où la conversion a deviné. Présent avec les deux modes de livraison, que la conversion se soit arrêtée ou non, et une liste vide pour un importateur qui n’en signale aucune. |
owed | ImportOwed[] | non | Chaque valeur que les ébauches laissent encore vide, qu’aucune source n’a pu fournir et qu’aucune réponse n’a fournie, dans l’ordre où les ébauches sont écrites — les valeurs que nomment les constats d’avertissement. Chaque réponse le contient, sous forme de liste vide lorsque les ébauches ne doivent rien. |
halted | booléen | oui | Indique si la conversion s’est arrêtée plutôt que de se terminer avec des constats. |
Les propriétés supplémentaires ne sont pas autorisées.
ScaffoldEntityResult
Le document de départ rédigé, la liste des exemples exécutables, ou l’exemple écrit — chaque forme répondant avec ses propres champs et laissant les autres absents.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
kind | string | non | Le type d’entité qui a été rédigé. Présent sur un brouillon. |
skeleton | string | non | Le texte du document rédigé. Présent sur un brouillon. |
examples | ScaffoldExample[] | non | Chaque exemple exécutable que publie la documentation, chacun une fois, dans l’ordre des noms. Présent sur une liste qui en a trouvé. |
example | string | non | L’exemple qui a été écrit. Présent sur une écriture. |
dir | string | non | Le répertoire dans lequel l’exemple a été écrit, relatif à la racine de l’espace de travail, tel que la requête l’a nommé ou, lorsqu’elle n’en a nommé aucun, comme le nom de l’exemple. Présent sur une écriture. |
files | string[] | non | Chaque fichier écrit, relatif à dir et séparé par des barres obliques, dans l’ordre dans lequel la documentation les présente. Présent sur une écriture. |
next | string[] | non | Les commandes que la page de l’exemple donne pour le construire, ligne par ligne telles que la page les écrit, commentaires compris : le premier bloc shell sous son titre Build. Absent lorsque la page n’en donne aucune. |
version | string | non | La version de la documentation à partir de laquelle l’exemple a été lu : celle du binaire lorsqu’une version est publiée pour lui, sinon la plus récente publiée avant lui. Présent sur une écriture. |
Les propriétés supplémentaires ne sont pas autorisées.
ScaffoldExample
Un exemple exécutable que publie la documentation.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
name | string | oui | Le nom de l’exemple, qu’une requête envoie comme example pour l’écrire. |
level | string | oui | Le niveau que la page de l’exemple déclare pour lui. |
summary | string | oui | La première phrase de la page de l’exemple. |
Les propriétés supplémentaires ne sont pas autorisées.
LintResult
Ce qu’a trouvé la vérification des conventions, compté par gravité et listé par document. Une vérification de tout le catalogue exécutée une fois pour chaque Release porte aussi passes ; les décomptes et files couvrent alors toutes les passes ensemble.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
entity | string | non | L’unique entité qui a été vérifiée, lorsque la requête en a nommé une. |
release | string | non | La Release dont la fermeture a été vérifiée, lorsque la requête en a nommé une. |
checked | integer | oui | Le nombre de documents vérifiés. Lorsque la vérification a été exécutée une fois pour chaque Release, la somme sur les passes : un document que lisent deux passes est compté dans chacune. |
findings | integer | oui | Le nombre total de constats. |
errors | integer | oui | Combien d’entre eux sont des erreurs. |
warnings | integer | oui | Combien d’entre eux sont des avertissements. |
infos | integer | oui | Combien d’entre eux sont informatifs. |
files | LintFileFindings[] ou null | oui | Les constats, par document. |
halted | booléen | oui | Indique si la vérification s’est arrêtée plutôt que de se terminer avec des constats. |
passes | LintPass[] ou null | non | La vérification de tout le catalogue une passe à la fois, présente uniquement lorsqu’elle a été exécutée une fois pour chaque Release parce que l’espace de travail nomme des Releases sous workspace.releases. Chaque passe indique pour quelles Releases ses constats ont été trouvés. Absente pour un espace de travail qui n’en nomme aucune, lequel est vérifié une fois sur ses propres répertoires, et pour une vérification d’une seule entité ou de la fermeture d’une Release. |
Les propriétés supplémentaires ne sont pas autorisées.
LintPass
Une passe d’une vérification des conventions de tout le catalogue dans un espace de travail qui donne à ses Releases des répertoires de catalogue qui leur sont propres : les Releases pour lesquelles elle a été exécutée, les répertoires qu’elle a lus, et ce qu’elle y a trouvé.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
releases | string[] ou null | oui | Les Releases pour lesquelles la passe a été exécutée, chacune sous la forme d’un chemin relatif à la racine de l’espace de travail. Les Releases qui lisent les mêmes répertoires de catalogue partagent une passe. |
catalogDirs | string[] ou null | oui | Les répertoires de catalogue que la passe a lus, dans l’ordre dans lequel ils sont parcourus, chacun relatif à la racine de l’espace de travail lorsqu’il se trouve à l’intérieur de celle-ci. Vide lorsque ses Releases ne lisent aucun répertoire de catalogue, de sorte que la passe n’a rien vérifié et n’a fait échouer aucune des autres. |
checked | integer | oui | Le nombre de documents que la passe a vérifiés. |
findings | integer | oui | Le nombre de constats que la passe a trouvés. |
errors | integer | oui | Combien d’entre eux sont des erreurs. |
warnings | integer | oui | Combien d’entre eux sont des avertissements. |
infos | integer | oui | Combien d’entre eux sont informatifs. |
files | LintFileFindings[] ou null | oui | Les constats de la passe, par document. |
Les propriétés supplémentaires ne sont pas autorisées.
PluginAddResult
Ce qu’a écrit le rattachement d’un plugin, où, et quelle version il a épinglée.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
type | string | oui | Le socket auquel le plugin a été rattaché. |
identity | string | non | L’identité en laquelle le rattachement s’est résolu. |
uri | string | non | La référence à partir de laquelle le rattachement se résout. |
capability | string | non | La capacité à laquelle est destiné le rattachement. |
reference | string | non | La référence épinglée, version comprise. |
scope | PluginWriteScope | oui | Dans quel document de configuration une modification de plugin a été écrite et jusqu’où elle porte. La valeur par défaut propre au socket d’extension de commandes est le document de toute la machine, de sorte que chaque réponse indique lequel elle a écrit. |
written | booléen | oui | Indique si le document de configuration a été écrit, par opposition à renvoyé pour que l’appelant le place. |
content | string | non | Le texte du document de configuration, pour une requête qui a demandé à le voir plutôt qu’à le faire écrire. |
retraction | PluginRetraction | non | La façon dont un marqueur de dépréciation a déterminé quelle version du plugin a été épinglée. |
withdrawn | booléen | non | Vaut true lorsque la requête a nommé la version épinglée et qu’une rétractation à laquelle cet espace de travail fait confiance a retiré cette version. Une version nommée est épinglée malgré tout, car la nommer constitue la surcharge. Absent sinon, et l’absence ne signifie pas que la version n’est pas retirée : là où les marqueurs de retrait d’une version nommée n’ont pas pu être lus, retraction.unscreened indique pourquoi, et sans version nommée, la dernière version publiée est choisie et retraction indique ce que la vérification de retrait a conclu au sujet de ce choix. |
Les propriétés supplémentaires ne sont pas autorisées.
PluginRemoveResult
Ce qu’a écrit le détachement d’un plugin, et où.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
type | string | oui | Le socket auquel le plugin a été rattaché. |
query | string | oui | Quel rattachement a été retiré. |
scope | PluginWriteScope | oui | Dans quel document de configuration une modification de plugin a été écrite et jusqu’où elle porte. La valeur par défaut propre au socket d’extension de commandes est le document de toute la machine, de sorte que chaque réponse indique lequel elle a écrit. |
Les propriétés supplémentaires ne sont pas autorisées.
PluginSyncResult
Ce qu’a modifié l’alignement des enregistrements gérés par la machine d’une entité Plugin sur son module.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
entity | string | oui | Le document de l’entité Plugin qui a été aligné. |
hostFunctions | string[] ou null | oui | Les fonctions hôtes dont le module déclare avoir besoin. |
commands | PluginCLICommand[] ou null | oui | Les commandes que le module fournit. |
changed | booléen | oui | Indique si quoi que ce soit dans le document a effectivement changé. |
Les propriétés supplémentaires ne sont pas autorisées.
PluginGenCatalogResult
Les documents de catalogue qu’une génération a produits.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
documents | PluginGeneratedDocument[] | non | Chaque document généré et son texte. |
notices | string | non | Tout ce que la génération veut faire savoir à l’appelant. |
dryRun | booléen | oui | Indique si les documents ont été renvoyés plutôt qu’écrits. |
Les propriétés supplémentaires ne sont pas autorisées.
ExplainErrorResult
Ce que le compilateur déclare au sujet d’une condition, et les passages publiés qui enseignent la correction d’authoring.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
shortCode | string | oui | Le code court de la condition. |
code | string | oui | Le nom descriptif de la condition. |
message | string | oui | Ce que dit la condition lorsqu’elle est levée. |
entries | ExplainErrorEntry[] | non | Les passages publiés qui enseignent la correction. |
reference | string | oui | L’adresse publiée à laquelle la condition est expliquée. |
note | string | non | Pourquoi les passages publiés manquent, lorsqu’ils n’ont pas pu être acquis. Ce que le binaire lui-même déclare reçoit tout de même une réponse. |
Les propriétés supplémentaires ne sont pas autorisées.
GetSchemaResult
Le schéma d’un type, ou — lorsque la requête n’en a nommé aucun — quels types peuvent être nommés. Les deux largeurs passent par une seule réponse plutôt que par deux méthodes, parce que « que puis-je nommer » et « desquels un auteur écrit-il des documents » sont la même question à deux largeurs, et que deux réponses devraient être maintenues en accord.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
kind | string | non | Le type auquel s’applique le schéma. |
schema | any | non | Le schéma lui-même, transmis tel que le binaire le détient. |
kinds | string[] | non | Chaque jeton auquel ce binaire répond. |
entityKinds | EntityKindDescriptor[] | non | L’ensemble plus restreint dont un auteur écrit un document, chacun associant le jeton que nomme une requête au type que déclare l’en-tête propre du document. |
Les propriétés supplémentaires ne sont pas autorisées.
SkillsInstallResult
Ce qu’a écrit l’installation de la skill de l’assistant, et où.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
skill | string | oui | La skill qui a été écrite. |
installed | SkillsInstalledFolder[] | oui | Chaque dossier de skills écrit, dans l’ordre dans lequel la requête a nommé les assistants. Les assistants qui lisent un même dossier partagé partagent une entrée, parce que la skill y est écrite une seule fois. |
scope | SkillFolderScope | oui | Jusqu’où porte une installation de skill. Une requête nomme un espace de travail, de sorte qu’une réponse qui ne dirait rien serait lue comme portant sur cet espace de travail — et pour les dossiers par utilisateur, qu’un assistant lit dans chaque projet, cette lecture est fausse. |
Les propriétés supplémentaires ne sont pas autorisées.
SkillsInstalledFolder
Un dossier de skills qu’une installation a écrit.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
agents | string[] | oui | Les identifiants des assistants nommés qui lisent ce dossier, dans l’ordre dans lequel la requête les a nommés. |
folder | string | oui | Le dossier de la skill, sous la forme d’un chemin absolu. |
replaced | booléen | oui | Indique si une copie portant la ligne de commentaire que porte chaque copie écrite de la skill — une qu’une installation antérieure a écrite, ou une prise dans le dépôt de skills publié — se trouvait là et a été remplacée. Un fichier qui s’y trouve sans cette ligne est refusé plutôt que remplacé. |
Les propriétés supplémentaires ne sont pas autorisées.
SkillsListResult
Les skills que le binaire embarque et chaque assistant pour lequel une installation peut les écrire. Rien n’est écrit et rien n’est atteint.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
skills | SkillsListedSkill[] | oui | Chaque skill que le binaire embarque, dans un ordre fixe. |
agents | SkillsListedAgent[] | oui | Chaque assistant pour lequel une installation connaît un dossier de skills, trié par identifiant. |
Les propriétés supplémentaires ne sont pas autorisées.
SkillsListedSkill
Une skill que le binaire embarque.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
name | string | oui | Le nom de la skill, qui est aussi le nom du dossier qu’une installation écrit. |
description | string | oui | Le moment où un assistant utilise la skill, tel que la skill elle-même le déclare. |
Les propriétés supplémentaires ne sont pas autorisées.
SkillsListedAgent
Un assistant pour lequel une installation peut écrire une skill, avec les deux dossiers dans lesquels il lit les skills.
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
id | string | oui | L’identifiant par lequel une requête nomme l’assistant. |
name | string | oui | Le nom propre de l’assistant. |
projectFolder | string | oui | Le dossier, relatif à la racine d’un projet et séparé par des barres obliques, dans lequel l’assistant lit les skills d’un projet. Une installation de projet écrit le dossier de la skill à l’intérieur de celui-ci, dans l’espace de travail que nomme la requête. |
userFolder | string | oui | Le dossier, relatif au répertoire personnel et séparé par des barres obliques, dans lequel l’assistant lit les skills propres de l’utilisateur dans chaque projet. Une installation avec global écrit le dossier de la skill à l’intérieur de celui-ci. |
Les propriétés supplémentaires ne sont pas autorisées.