Schema del protocollo di comunicazione del daemon in background di Aggrega
Riferimento generato. Non modificarlo a mano — rigeneralo a partire dal JSON Schema pubblicato.
Id dello schema: https://aggrega.ai/schemas/serve-wire-v1beta1.schema.json
Le forme dei messaggi scambiati con un daemon del compilatore in background avviato da aggrega serve. Un client apre una sessione su quel daemon con l’handshake, e la sessione è ciò che delimita le impostazioni e il workspace su cui è stata aperta la conversazione; il daemon è il processo che risponde a una richiesta, invia una notifica e conserva ciò che ha letto. Il protocollo è JSON-RPC 2.0 su standard input e standard output, con ogni messaggio delimitato da un header Content-Length; questo documento descrive i corpi dei messaggi e né la delimitazione né il trasporto. Un corpo è una di quattro cose: una richiesta che il client invia, una notifica che il client invia, una notifica che il daemon invia, oppure la risposta che il daemon restituisce per una richiesta. Tre proprietà della superficie decidono come sono scritte le forme qui sotto. Primo, ogni richiesta ammette due campi oltre a quelli che il suo metodo dichiara — workspaceRoot, che nomina il workspace su cui la richiesta agisce, e workDoneToken, il valore generato dal chiamante sotto cui viene riportato l’avanzamento — quindi entrambi compaiono qui su ogni oggetto params di richiesta, compresi i tre metodi il cui soggetto non è un workspace: aggrega/getSchema e aggrega/scaffoldEntity accettano workspaceRoot e lo ignorano, e aggrega/initialize lo legge come il workspace che la sessione dichiara. Secondo, il daemon rifiuta un oggetto params di richiesta che porta un campo che il metodo non accetta, nominando ciò che accetta, quindi qui ogni oggetto params è chiuso al suo primo livello; un oggetto annidato all’interno di una richiesta non è chiuso, perché il controllo legge solo i nomi dei campi più esterni. Terzo, un risultato è composto dal daemon anziché fornito da un chiamante, quindi gli oggetti risultato sono chiusi a ogni livello la cui forma è fissa, e aperti solo dove il valore è JSON opaco che il daemon trasporta senza leggerlo. Una conseguenza della codifica del daemon è visibile nei messaggi trasmessi ed è descritta anziché nascosta: una collezione che il daemon non contrassegna come opzionale viene emessa come null quando non ha alcun valore da riportare e come collezione vuota quando il valore che riporta è vuoto, quindi entrambe le forme sono ammesse ovunque ciò si applichi.
Una delle forme seguenti
RequestClientNotificationDaemonNotificationSuccessResponseErrorResponse
Definizioni
ProtocolVersion
La versione di JSON-RPC che ogni messaggio porta. Si parla solo la 2.0.
Tipo: const "2.0"
Costante: "2.0"
RequestId
L’identificatore del chiamante per una richiesta, ripetuto sulla risposta che le risponde. Un messaggio che non porta alcun identificatore è una notifica e non riceve mai risposta.
Tipo: string or number
ProgressToken
Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata.
Tipo: string or number
WorkspaceRootSubject
Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata.
Tipo: string
WorkspaceRootAccepted
Il percorso assoluto di un workspace. Il soggetto di questo metodo non è un workspace — risponde a partire da ciò che il binario stesso contiene — quindi il campo è accettato e non letto. È ammesso perché un client possa inviarlo in modo uniforme su ogni richiesta senza dover sapere quali metodi lo consultano.
Tipo: string
RequestMethod
Ogni metodo che una richiesta può nominare. L’insieme è chiuso: a una richiesta che nomina qualsiasi altra cosa si risponde con un errore di metodo non trovato.
Tipo: string (enum)
Valori consentiti: "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
Ogni metodo che una notifica del client può nominare. L’insieme è chiuso, e nessuna delle due notifiche riceve risposta.
Tipo: string (enum)
Valori consentiti: "$/cancelRequest", "aggrega/shutdown"
DaemonNotificationMethod
Ogni metodo che una notifica inviata dal daemon può nominare. L’insieme è chiuso.
Tipo: string (enum)
Valori consentiti: "$/progress", "aggrega/publishDiagnostics"
Request
Una richiesta che il client invia e a cui il daemon risponde. Il metodo nomina ciò che viene chiesto; l’oggetto params porta i campi propri di quel metodo più i due che ogni metodo ammette. Una richiesta che omette del tutto params viene letta come una i cui campi sono tutti assenti.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
jsonrpc | ProtocolVersion | sì | La versione di JSON-RPC che ogni messaggio porta. Si parla solo la 2.0. |
id | RequestId | sì | L’identificatore del chiamante per una richiesta, ripetuto sulla risposta che le risponde. Un messaggio che non porta alcun identificatore è una notifica e non riceve mai risposta. |
method | RequestMethod | sì | Ogni metodo che una richiesta può nominare. L’insieme è chiuso: a una richiesta che nomina qualsiasi altra cosa si risponde con un errore di metodo non trovato. |
params | object | no |
Non sono consentite proprietà aggiuntive.
params per ogni method:
method | params | Obbligatoria |
|---|---|---|
"aggrega/initialize" | InitializeParams | no |
"aggrega/validate" | ValidateParams | no |
"aggrega/invalidate" | InvalidateParams | no |
"aggrega/diagnostics" | DiagnosticsParams | no |
"aggrega/irGraph" | IrGraphParams | no |
"aggrega/build" | BuildParams | no |
"aggrega/buildPreview" | BuildPreviewParams | no |
"aggrega/entityDefinition" | EntityDefinitionParams | no |
"aggrega/releaseClosure" | ReleaseClosureParams | no |
"aggrega/resolveDependencies" | ResolveDependenciesParams | no |
"aggrega/pin" | PinParams | no |
"aggrega/cacheStatus" | WorkspaceAndProgressParams | no |
"aggrega/cachePrune" | WorkspaceAndProgressParams | no |
"aggrega/cacheEvict" | CacheEvictParams | no |
"aggrega/cacheClear" | WorkspaceAndProgressParams | no |
"aggrega/registryList" | WorkspaceAndProgressParams | no |
"aggrega/search" | SearchParams | no |
"aggrega/registryAdd" | RegistryAddParams | no |
"aggrega/registryRemove" | RegistryRemoveParams | no |
"aggrega/registryUpdate" | RegistryUpdateParams | no |
"aggrega/logout" | LogoutParams | no |
"aggrega/publishEntity" | PublishEntityParams | no |
"aggrega/publishArtifact" | PublishArtifactParams | no |
"aggrega/signArtifacts" | SignArtifactsParams | no |
"aggrega/deprecateArtifact" | DeprecateArtifactParams | no |
"aggrega/resolve" | ResolveParams | no |
"aggrega/findReferences" | FindReferencesParams | no |
"aggrega/findImplementations" | FindImplementationsParams | no |
"aggrega/hover" | HoverParams | no |
"aggrega/completion" | CompletionParams | no |
"aggrega/catalogIndex" | CatalogIndexParams | no |
"aggrega/attachCandidates" | AttachCandidatesParams | no |
"aggrega/connectionCandidates" | ConnectionCandidatesParams | no |
"aggrega/insertionPoint" | InsertionPointParams | no |
"aggrega/attachmentContainer" | AttachmentContainerParams | no |
"aggrega/connectionAtPosition" | ConnectionAtPositionParams | no |
"aggrega/releaseCandidates" | WorkspaceAndProgressParams | no |
"aggrega/activeRelease" | WorkspaceAndProgressParams | no |
"aggrega/setActiveRelease" | SetActiveReleaseParams | no |
"aggrega/editDocument" | EditDocumentParams | no |
"aggrega/effectiveConfiguration" | WorkspaceAndProgressParams | no |
"aggrega/configInit" | ConfigInitParams | no |
"aggrega/configCapture" | ConfigCaptureParams | no |
"aggrega/import" | ImportParams | no |
"aggrega/scaffoldEntity" | ScaffoldEntityParams | no |
"aggrega/lint" | LintParams | no |
"aggrega/pluginAdd" | PluginAddParams | no |
"aggrega/pluginRemove" | PluginRemoveParams | no |
"aggrega/pluginSync" | PluginSyncParams | no |
"aggrega/pluginGenCatalog" | PluginGenCatalogParams | no |
"aggrega/explainError" | ExplainErrorParams | no |
"aggrega/getSchema" | GetSchemaParams | no |
"aggrega/skillsInstall" | SkillsInstallParams | no |
"aggrega/skillsList" | WorkspaceAndProgressParams | no |
ClientNotification
Una notifica che il client invia. Non porta alcun identificatore e non riceve mai risposta.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
jsonrpc | ProtocolVersion | sì | La versione di JSON-RPC che ogni messaggio porta. Si parla solo la 2.0. |
method | ClientNotificationMethod | sì | Ogni metodo che una notifica del client può nominare. L’insieme è chiuso, e nessuna delle due notifiche riceve risposta. |
params | object | no |
Non sono consentite proprietà aggiuntive.
params per ogni method:
method | params | Obbligatoria |
|---|---|---|
"$/cancelRequest" | CancelRequestParams | sì |
"aggrega/shutdown" | ShutdownParams | no |
DaemonNotification
Una notifica che il daemon invia. Non porta alcun identificatore e non riceve mai risposta.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
jsonrpc | ProtocolVersion | sì | La versione di JSON-RPC che ogni messaggio porta. Si parla solo la 2.0. |
method | DaemonNotificationMethod | sì | Ogni metodo che una notifica inviata dal daemon può nominare. L’insieme è chiuso. |
params | object | sì |
Non sono consentite proprietà aggiuntive.
params per ogni method:
method | params | Obbligatoria |
|---|---|---|
"$/progress" | ProgressParams | sì |
"aggrega/publishDiagnostics" | PublishDiagnosticsParams | sì |
CancelRequestParams
Chiede al daemon di abbandonare una richiesta già in corso, nominandola tramite l’identificatore che la richiesta portava. Per una richiesta già terminata, o mai inviata, semplicemente non c’è nulla da annullare, e non viene segnalato nulla.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
id | RequestId | sì | L’identificatore del chiamante per una richiesta, ripetuto sulla risposta che le risponde. Un messaggio che non porta alcun identificatore è una notifica e non riceve mai risposta. |
Non sono consentite proprietà aggiuntive.
ShutdownParams
Chiede al daemon di smettere di accettare lavoro e di finire ciò che ha già preso in carico. La notifica non porta campi, e la notifica stessa viene di solito inviata senza alcun oggetto params. Una seconda notifica abbandona il lavoro ancora in corso invece di attenderlo.
Questo oggetto non dichiara proprietà fisse e non ne consente alcuna.
ProgressParams
Un singolo resoconto del lavoro in corso, inviato solo per una richiesta che ha generato un token di avanzamento in una sessione che ha dichiarato di poterli ricevere.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
token | ProgressToken | sì | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
value | ProgressBegin o ProgressReport o ProgressEnd | sì | Il resoconto stesso. Un resoconto di apertura, poi un numero qualsiasi di righe, poi un resoconto di chiusura. |
Non sono consentite proprietà aggiuntive.
ProgressBegin
Apre un resoconto, dicendo che cosa è iniziato nei termini che usa l’operazione stessa.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
kind | const “begin” | sì | Contrassegna questo payload come l’apertura di un resoconto. Costante: "begin" |
title | string | sì | Ciò che è iniziato. |
Non sono consentite proprietà aggiuntive.
ProgressReport
Una riga del resoconto che l’operazione fa di sé stessa. Non porta alcuna frazione: le operazioni che riportano qui elaborano un insieme la cui dimensione non è nota quando il lavoro inizia, quindi una frazione dovrebbe essere inventata.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
kind | const “report” | sì | Contrassegna questo payload come una riga di un resoconto aperto. Costante: "report" |
message | string | sì | Una riga dell’output proprio dell’operazione, con gli spazi bianchi circostanti rimossi. |
Non sono consentite proprietà aggiuntive.
ProgressEnd
Chiude un resoconto. Non porta nulla oltre al tipo, perché l’esito viaggia sulla risposta che il chiamante sta già attendendo.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
kind | const “end” | sì | Contrassegna questo payload come la chiusura di un resoconto. Costante: "end" |
Non sono consentite proprietà aggiuntive.
PublishDiagnosticsParams
I rilievi relativi a un file, inviati dal daemon quando una validazione li ha prodotti per un documento diverso da quello nominato dalla richiesta.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
file | string | sì | Il file a cui si riferiscono i rilievi. |
diagnostics | Diagnostic[] o null | sì | I rilievi, nell’ordine in cui sono stati prodotti. |
Non sono consentite proprietà aggiuntive.
SuccessResponse
La risposta a una richiesta riuscita, che porta l’identificatore della richiesta a cui risponde. Una risposta non porta alcun metodo, quindi quale forma di risultato si applica è stabilito dalla richiesta a cui appartiene l’identificatore anziché da qualcosa nella risposta stessa.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
jsonrpc | ProtocolVersion | sì | La versione di JSON-RPC che ogni messaggio porta. Si parla solo la 2.0. |
id | RequestId | sì | L’identificatore del chiamante per una richiesta, ripetuto sulla risposta che le risponde. Un messaggio che non porta alcun identificatore è una notifica e non riceve mai risposta. |
result | InitializeResult o ValidateResult o InvalidateResult o DiagnosticsResult o IrGraphResult o BuildResult o BuildPreviewResult o EntityDefinitionResult o ReleaseClosureResult o ResolveDependenciesResult o PinResult o CacheStatusResult o CachePruneResult o CacheEvictResult o CacheClearResult o RegistryListResult o SearchResult o RegistryAddResult o RegistryRemoveResult o RegistryUpdateResult o LogoutResult o PublishEntityResult o PublishArtifactResult o SignArtifactsResult o DeprecateArtifactResult o ResolveResult o FindReferencesResult o FindImplementationsResult o HoverResult o CompletionResult o CatalogIndexResult o AttachCandidatesResult o ConnectionCandidatesResult o InsertionPointResult o AttachmentContainerResult o ConnectionAtPositionResult o ReleaseCandidatesResult o ActiveReleaseResult o EditDocumentResult o EffectiveConfigurationResult o ConfigInitResult o ConfigCaptureResult o ImportResult o ScaffoldEntityResult o LintResult o PluginAddResult o PluginRemoveResult o PluginSyncResult o PluginGenCatalogResult o ExplainErrorResult o GetSchemaResult o SkillsInstallResult o SkillsListResult | sì | La risposta, nella forma che restituisce il metodo richiesto. |
Non sono consentite proprietà aggiuntive.
ErrorResponse
La risposta a una richiesta che è stata rifiutata o non è riuscita, che porta l’identificatore della richiesta a cui risponde.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
jsonrpc | ProtocolVersion | sì | La versione di JSON-RPC che ogni messaggio porta. Si parla solo la 2.0. |
id | RequestId | sì | L’identificatore del chiamante per una richiesta, ripetuto sulla risposta che le risponde. Un messaggio che non porta alcun identificatore è una notifica e non riceve mai risposta. |
error | ErrorObject | sì | Che cosa è andato storto: un codice in base al quale un client può diramare la propria logica, un messaggio scritto perché lo legga una persona e — dove la condizione ne ha una — gli artefatti e la posizione nel sorgente a cui il messaggio si riferisce. |
Non sono consentite proprietà aggiuntive.
ErrorObject
Che cosa è andato storto: un codice in base al quale un client può diramare la propria logica, un messaggio scritto perché lo legga una persona e — dove la condizione ne ha una — gli artefatti e la posizione nel sorgente a cui il messaggio si riferisce.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
code | ErrorCode | sì | La condizione che la risposta riporta. I codici negativi sono l’insieme riservato proprio del protocollo; i codici a quattro cifre sono condizioni che questo daemon solleva, ciascuna delle quali nomina uno stato su cui un client può agire. L’insieme è chiuso. |
message | string | sì | Che cosa è andato storto, in prosa. È la stessa formulazione che la stessa condizione porta su ogni altra superficie che la riporta. |
data | ErrorData | no | Gli artefatti e la posizione nel sorgente a cui il messaggio si riferisce, portati in forma strutturata così che un client non debba ricavarli dalla prosa. Ogni campo è opzionale e una condizione popola solo ciò che ha a disposizione; nessun campo ne sostituisce un altro, così un client apprende che cosa ha ricevuto dal campo che ha letto anziché dal codice accanto a esso. |
Non sono consentite proprietà aggiuntive.
ErrorCode
La condizione che la risposta riporta. I codici negativi sono l’insieme riservato proprio del protocollo; i codici a quattro cifre sono condizioni che questo daemon solleva, ciascuna delle quali nomina uno stato su cui un client può agire. L’insieme è chiuso.
Tipo: 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
Valori consentiti:
-32700— Non è stato possibile analizzare il messaggio come JSON.-32600— Il messaggio è stato analizzato ma non è una richiesta ben formata.-32601— Non esiste alcun metodo con quel nome.-32602— I params portati dalla richiesta non sono ammissibili: un campo che il metodo non accetta, un campo del tipo sbagliato o un valore che il metodo rifiuta.-32603— Il daemon ha fallito mentre svolgeva il lavoro.1001— Il daemon non conserva alcuna lettura del file e non ne sta producendo alcuna. Il client ne avvia una chiedendo una validazione, poi riprova.1003— Il file di lock per la Release nominata dalla richiesta è assente, e l’operazione ne ha bisogno.1004— Non è stato possibile risolvere l’entità nominata dalla richiesta né dal catalogo né dalla Release nominata dalla richiesta.1005— Il daemon si sta arrestando e rifiuta nuovo lavoro. Il client non riprova sullo stesso daemon.1006— Una validazione del file è in corso e non è terminata entro il margine di tempo concesso dalla richiesta in attesa. Il client attende e chiede di nuovo, senza inviare nulla nel frattempo.
ErrorData
Gli artefatti e la posizione nel sorgente a cui il messaggio si riferisce, portati in forma strutturata così che un client non debba ricavarli dalla prosa. Ogni campo è opzionale e una condizione popola solo ciò che ha a disposizione; nessun campo ne sostituisce un altro, così un client apprende che cosa ha ricevuto dal campo che ha letto anziché dal codice accanto a esso.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
file | string | no | Il documento sorgente che i campi di posizione localizzano — il documento in fase di controllo, o la Release il cui caricamento non è riuscito. |
line | integer | no | La riga a cui si riferisce la condizione, contata a partire da uno. |
column | integer | no | La colonna a cui si riferisce la condizione, contata a partire da uno. |
end_line | integer | no | La riga una posizione oltre la fine del token a cui si riferisce la condizione. Assente dove il token non ha una fine recuperabile, nel qual caso un client rappresenta la posizione come un punto. |
end_column | integer | no | La colonna una posizione oltre la fine del token a cui si riferisce la condizione. |
release | string | no | La Release a cui si riferisce la condizione, scritta nel modo in cui la richiesta l’ha nominata, così che un client possa comporre il rimedio senza doverla riassemblare. |
lockfile | string | no | Il file di lock di cui tratta una condizione relativa al file di lock: il percorso che è stato cercato e non trovato, o che non è stato possibile leggere. |
unreachable | booleana | no | Se il rifiuto riguarda un registry nominato dalla richiesta che non è stato possibile raggiungere: il suo nome non è stato risolto, una connessione verso di esso è stata rifiutata o non è stato possibile aprirla, oppure non è stato possibile stabilire una connessione sicura verso di esso. Viene letto dal fallimento stesso anziché dal messaggio, ed è impostato solo dove il fallimento mostra che il registry non è mai stato raggiunto. Un aggiornamento dell’indice rifiutato che nomina un registry lo porta; un registry che ha risposto, qualunque cosa abbia risposto, lo lascia assente. |
code | string | no | Il nome descrittivo della condizione che il rifiuto nomina, stabile tra le versioni: lo stesso valore che una diagnostica che riporta quella condizione porta nel proprio codice. È ciò in base a cui un client dirama la propria logica, anziché in base al messaggio o al codice numerico accanto a esso, che nomina lo stato della richiesta e resta quello che è per ogni condizione. Presente esattamente quando il rifiuto nomina una condizione registrata, e assente quando non ne nomina alcuna. |
shortCode | string | no | Il codice breve della condizione, la lettera E seguita da quattro cifre: la forma che un lettore cita e cerca, e quella che apre il messaggio di un rifiuto che nomina una condizione. Presente esattamente quando è presente code. |
Non sono consentite proprietà aggiuntive.
Diagnostic
Un rilievo su un documento: dove si trova, quanto è grave, che cosa dice e il codice citabile che nomina la condizione che riporta.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
line | integer | sì | La riga a cui si riferisce il rilievo, contata a partire da uno. |
column | integer | sì | La colonna a cui si riferisce il rilievo, contata a partire da uno. |
severity | const “error” o const “warning” o const “info” | sì | Quanto è grave il rilievo. Valori consentiti: "error" — Il rilievo è un errore. Un rilievo di un plugin con severità halt viene riportato a questo livello. "warning" — Il rilievo viene riportato e non è un errore. Un rilievo di un plugin con severità warn viene riportato a questo livello. "info" — Il rilievo è un’informazione, come lo è un rilievo di un plugin con severità info. |
message | string | sì | Che cosa dice il rilievo, in prosa. |
code | string | no | Il nome descrittivo della condizione, stabile tra le versioni e citabile in una soppressione. |
shortCode | string | no | Il codice breve della condizione, la forma che apre una diagnostica bloccante. |
codeDescription | CodeDescription | no | Dove è spiegata la condizione che il rilievo nomina. |
classification | string | no | Come si è giunti al rilievo, dove la condizione fa questa distinzione. |
suggest | string | no | La grafia che il rilievo propone, dove la condizione è in grado di nominarne una — un identificatore scritto quasi correttamente, per esempio. |
keyPath | string | no | Il percorso attraverso il documento fino alla chiave a cui si riferisce il rilievo. |
source | string | sì | Che cosa ha prodotto il rilievo. |
end_line | integer | no | La riga una posizione oltre la fine del token a cui si riferisce il rilievo, così che un client possa rappresentare l’intero token anziché un singolo carattere. Assente per un token che si estende su più righe. |
end_column | integer | no | La colonna una posizione oltre la fine del token a cui si riferisce il rilievo. |
Non sono consentite proprietà aggiuntive.
CodeDescription
Dove è spiegata la condizione che il rilievo nomina.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
href | string | sì | L’indirizzo pubblicato presso cui è spiegata la condizione. |
Non sono consentite proprietà aggiuntive.
Position
Un punto in un documento: una riga e un offset di carattere al suo interno, entrambi contati a partire da zero. L’offset è misurato nelle unità della codifica che la sessione ha concordato quando è stata aperta, che è UTF-16 a meno che il client non ne abbia chiesta un’altra.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
line | integer | sì | La riga, contata a partire da zero. |
character | integer | sì | L’offset all’interno della riga, contato a partire da zero, nelle unità della codifica che la sessione ha concordato. |
Non sono consentite proprietà aggiuntive.
Range
Un intervallo tra due punti in un documento.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
start | Position | sì | Un punto in un documento: una riga e un offset di carattere al suo interno, entrambi contati a partire da zero. L’offset è misurato nelle unità della codifica che la sessione ha concordato quando è stata aperta, che è UTF-16 a meno che il client non ne abbia chiesta un’altra. |
end | Position | sì | Un punto in un documento: una riga e un offset di carattere al suo interno, entrambi contati a partire da zero. L’offset è misurato nelle unità della codifica che la sessione ha concordato quando è stata aperta, che è UTF-16 a meno che il client non ne abbia chiesta un’altra. |
Non sono consentite proprietà aggiuntive.
Location
Un intervallo in un documento con nome.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
uri | string | sì | Il documento in cui si trova l’intervallo, indirizzato come URI. |
range | Range | sì | Un intervallo tra due punti in un documento. |
Non sono consentite proprietà aggiuntive.
WorkspaceAndProgressParams
L’oggetto params di un metodo che non dichiara campi propri. Ammette comunque i due campi che ogni richiesta ammette: il workspace su cui agisce e un token di avanzamento.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
Non sono consentite proprietà aggiuntive.
InitializeParams
Apre una sessione su un workspace e dichiara che cosa il client è in grado di gestire. Questo è l’unico metodo in cui workspaceRoot è una dichiarazione anziché un soggetto: assente, vuoto e un percorso sono tre cose diverse, e una sessione aperta senza percorso è una sessione che il client non ha ancora indirizzato verso un workspace.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
capabilities | ClientCapabilities | no | Che cosa il client è in grado di gestire. Ciò che non è dichiarato viene considerato non supportato. I membri sconosciuti vengono ignorati anziché rifiutati, così un client può dichiarare una capacità che questo daemon non legge ancora. |
workspaceRoot | string | no | Il percorso assoluto del workspace da aprire. Se assente, la sessione resta senza workspace; una stringa vuota è un percorso fornito dal client e non equivale a non inviarne alcuno. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
Non sono consentite proprietà aggiuntive.
ClientCapabilities
Che cosa il client è in grado di gestire. Ciò che non è dichiarato viene considerato non supportato. I membri sconosciuti vengono ignorati anziché rifiutati, così un client può dichiarare una capacità che questo daemon non legge ancora.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
general | object | no | Capacità che non sono legate a un solo tipo di risposta. |
window | object | no | Capacità relative a ciò che il client può mostrare mentre un lavoro è in corso. |
Le proprietà aggiuntive sono consentite.
ClientCapabilities.general
Capacità che non sono legate a un solo tipo di risposta.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
positionEncodings | string[] | no | Le codifiche di posizione che il client sa leggere, la migliore per prima. |
Le proprietà aggiuntive sono consentite.
ClientCapabilities.window
Capacità relative a ciò che il client può mostrare mentre un lavoro è in corso.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workDoneProgress | booleana | no | Se il client può ricevere notifiche di avanzamento. Una richiesta che genera un token di avanzamento in una sessione che non l’ha dichiarato viene rifiutata. |
Le proprietà aggiuntive sono consentite.
ValidateParams
Controlla il workspace, o un documento al suo interno, e risponde con i rilievi.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
file | string | no | Il documento da controllare. Se assente, controlla ciò che il workspace contiene. |
content | string | no | Il testo del documento così come il client lo detiene attualmente, per controllare un buffer non ancora salvato. Se assente, legge i byte su disco. |
release | string | no | La Release rispetto a cui controllare, come percorso relativo alla radice del workspace. |
Non sono consentite proprietà aggiuntive.
InvalidateParams
Comunica al daemon che un documento di cui conserva una lettura è cambiato, così che la risposta successiva che lo riguarda venga calcolata dai nuovi byte.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
file | string | no | Il documento che è cambiato. |
granularity | string | no | Quanto di ciò che il daemon conserva va scartato: file scarta ciò che conserva solo per il documento nominato; workspace, il valore predefinito e il modo in cui viene letto qualsiasi altro valore, scarta anche ciò che conserva per l’intero workspace. |
Non sono consentite proprietà aggiuntive.
DiagnosticsParams
Risponde con i rilievi che il daemon già conserva per un documento, senza controllarlo di nuovo.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
file | string | no | Il documento su cui riferire. Il daemon deve già conservarne una lettura. |
Non sono consentite proprietà aggiuntive.
IrGraphParams
Risponde con il grafo risolto in cui una Release viene compilata, senza eseguirne il rendering.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
release | string | no | La Release da risolvere, come percorso relativo alla radice del workspace. Un percorso assoluto viene rifiutato. |
unredacted | booleana | no | Se rispondere con in chiaro i valori che un autore ha dichiarato sensibili. Se assente o false, ciascuno di essi viene trattenuto dal grafo e al suo posto compare un marcatore che ne indica il motivo, come li trattiene l’output del grafo della riga di comando; true risponde con il grafo così come la Release viene compilata, inclusi quei valori. |
Non sono consentite proprietà aggiuntive.
BuildParams
Compila una Release e scrive gli artefatti renderizzati nel workspace.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
release | string | no | La Release di cui eseguire la build, come percorso relativo alla radice del workspace. Un percorso assoluto viene rifiutato. |
outputParent | string | no | La directory all’interno della quale viene creata la directory di output, come percorso relativo alla radice del workspace. Gli artefatti finiscono nella directory di output sottostante, disposti come lo sono sotto la radice del workspace quando non viene nominato nulla — quindi questo campo nomina la directory padre della directory di output e mai la directory di output stessa. Se assente, o vuoto, scrive la directory di output sotto la radice del workspace, come fa aggrega build da qualunque posizione venga eseguito. Un percorso assoluto, o uno che risale fuori dal workspace, viene rifiutato. |
autoPull | booleana | no | Se risolvere prima le dipendenze della Release. Richiederlo raggiunge i registry configurati e scrive il file di lock; se non viene richiesto, la build non raggiunge alcun registry. |
policyInput | string | no | La directory in cui scrivere, accanto agli artefatti, il payload che ciascun ruolo di governance consegna a un plugin associato lì, come percorso relativo alla radice del workspace — i file che aggrega build --policy-input scrive, con gli stessi nomi, scritti sia che la build finisca sia che si arresti. Gli avvisi della risposta dicono quanti ne sono stati scritti e nominano ogni ruolo per cui non è stato scritto alcun file. Su una richiesta che fallisce, i file scritti sono su disco e quelle informazioni non sono nella risposta: l’errore porta soltanto il rifiuto. Se assente, non ne scrive alcuno. Un percorso assoluto, o uno che risale fuori dal workspace, viene rifiutato. |
Non sono consentite proprietà aggiuntive.
BuildPreviewParams
Compila una Release e riporta che cosa avrebbe prodotto la scrittura degli artefatti, senza scriverne alcuno. Rifiuta il campo di risoluzione delle dipendenze che la build con scrittura accetta, perché una richiesta che non scrive nulla non può riempire un file di lock.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
release | string | no | La Release da compilare, come percorso relativo alla radice del workspace. |
autoPull | booleana | no | Accettato nei messaggi trasmessi e rifiutato dal metodo: questa richiesta non scrive nulla, quindi non può riempire un file di lock e restare ciò che dichiara di essere. |
policyInput | string | no | La directory in cui scrivere il payload che ciascun ruolo di governance consegna a un plugin associato lì, come percorso relativo alla radice del workspace — i file che aggrega build --dry-run --policy-input scrive, con gli stessi nomi. Se inviato, sono l’unica cosa che questa richiesta scrive; la directory di output e il file di lock restano intatti. Gli avvisi della risposta dicono quanti ne sono stati scritti e nominano ogni ruolo per cui non è stato scritto alcun file. Su una richiesta che fallisce, i file scritti sono su disco e quelle informazioni non sono nella risposta: l’errore porta soltanto il rifiuto. Un percorso assoluto, o uno che risale fuori dal workspace, viene rifiutato. |
Non sono consentite proprietà aggiuntive.
EntityDefinitionParams
Risponde con ciò in cui si risolve un nome di entità e con il luogo in cui si trova il documento che la definisce.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
name | string | no | L’entità da risolvere, per nome — oppure un riferimento a un registry, oci://<host>/<repository>:<tag> o @<digest> al posto di :<tag>, per leggere l’entità pubblicata a quella coordinata. |
release | string | no | La Release nei cui termini risolvere il nome, come percorso relativo alla radice del workspace. Il nome viene allora risolto tramite le directory di catalogo che la configurazione del workspace assegna a quella Release, così un nome che più varianti dichiarano in un unico workspace, una per Release, si risolve nella variante con cui quella Release esegue la build, e un nome che essa non risolve viene rifiutato con una spiegazione che nomina la voce di quella Release sotto workspace.releases. Se assente, il nome viene risolto sulle directory di catalogo proprie del workspace. Un riferimento a un registry non accetta alcuna Release e viene rifiutato se ne porta una, come lo è un valore che non nomina alcun file di Release. |
Non sono consentite proprietà aggiuntive.
CatalogIndexParams
Risponde con le entità che il workspace contiene: ogni entità che i suoi documenti dichiarano, e le Features che le sue directory di catalogo dichiarano.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
release | string | no | La Release nei cui termini elencare le entità, come percorso relativo alla radice del workspace. Le Features sono allora quelle dichiarate dalle directory di catalogo che la configurazione del workspace assegna a quella Release, e un documento sotto una directory di catalogo letta solo da altre Releases viene escluso, così un workspace che tiene affiancate varianti di una stessa entità, una per Release, viene elencato con la variante con cui quella Release esegue la build. Se assente, l’elenco è quello proprio del workspace. Un valore che non nomina alcun file di Release viene rifiutato. |
Non sono consentite proprietà aggiuntive.
ReleaseClosureParams
Risponde con tutto ciò da cui una Release dipende, così come la risoluzione l’ha raggiunto.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
release | string | no | La Release da ispezionare, come percorso relativo alla radice del workspace. |
Non sono consentite proprietà aggiuntive.
ResolveDependenciesParams
Risolve le dipendenze di una Release, fissandole nel file di lock e acquisendo gli input esterni che il suo rendering consuma. Raggiunge i registry configurati e scrive.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
release | string | no | La Release da risolvere, come percorso relativo alla radice del workspace. |
upgrade | booleana | no | Se risolvere di nuovo entro gli intervalli dichiarati anziché rispettare ciò che il file di lock già fissa. |
targets | string[] | no | I riferimenti da risolvere di nuovo, lasciando il resto fissato com’è. Se vuoto, risolve tutto. |
verify | booleana | no | Se confrontare il file di lock registrato con la risoluzione che questa richiesta eseguirebbe senza di esso, rispettando i fissaggi che quella richiesta rispetterebbe, invece di scriverlo. Una verifica non scrive alcun file di lock, registro di fiducia dei plugin né entity.lock; la cache dei contenuti viene letta e riempita come quella risoluzione la leggerebbe e la riempirebbe. Una deriva, e un file di lock mancante, fanno fallire la richiesta. Non può essere combinato con upgrade, targets o pinSources, qualunque valore porti pinSources: una richiesta che ne invia uno accanto a esso viene rifiutata come params non validi prima che venga risolto alcunché. |
pinSources | booleana | no | Se eseguire il passo di fissaggio che aggrega/pin esegue sulle Recipes e sulle FeatureRecipes che la Release compila a partire dalle directory di catalogo del workspace, scrivendo l’entity.lock accanto a ciascuna, anziché rifiutare la richiesta a causa di una il cui lock non registra un fissaggio di cui un input ha bisogno. Se assente, segue pin_sources_at_pull del workspace; l’uno o l’altro valore prevale su quell’impostazione per questa richiesta. |
Non sono consentite proprietà aggiuntive.
PinParams
Registra, nell’entity.lock accanto a una Recipe o a una FeatureRecipe, il fissaggio del contenuto per ogni input che l’entità legge al di fuori del proprio documento. Non viene nominata alcuna Release: un input la cui identità l’entità scrive per intero nomina un unico artefatto per ogni Release che usa l’entità, quindi per fissarlo non serve nulla di ciò che una Release fornisce. Raggiunge gli host che le sorgenti dell’entità nominano e scrive accanto all’entità; il documento dell’entità stesso non viene mai scritto.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
entity | string | no | Il documento di entità da fissare, come percorso relativo alla radice del workspace. |
dryRun | booleana | no | Se rispondere con il lock che il passo scriverebbe anziché scriverlo. Gli input vengono comunque risolti, quindi la cache dei contenuti si riempie comunque. |
Non sono consentite proprietà aggiuntive.
CacheEvictParams
Recupera spazio dal contenuto in cache finché ciò che resta rientra sotto una dimensione nominata dalla richiesta.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
maxSize | string | no | La dimensione a cui ridurre lo spazio occupato, scritta come la scriverebbe una persona — per esempio 500MB. |
Non sono consentite proprietà aggiuntive.
SearchParams
Cerca ciò che offrono gli indici locali dei registry configurati. Legge l’indice già presente su disco e non contatta alcun registry.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
query | string | no | Il testo da confrontare con il nome e la descrizione di un record. |
kinds | string[] | no | I tipi di entità da mantenere. Se vuoto, mantiene ogni tipo. |
selector | string | no | Un selettore di etichette che i record mantenuti devono soddisfare. |
capabilities | string[] | no | Le capacità che un record di plugin mantenuto deve dichiarare. |
pluginType | string | no | Il tipo di plugin da mantenere. |
registry | string | no | L’unico host di registry in cui cercare. Se assente, cerca in ogni host configurato. |
limit | integer | no | Il numero massimo di record con cui rispondere. |
includeRetracted | booleana | no | Se mantenere le versioni che un marcatore pubblicato ha deprecato. |
Non sono consentite proprietà aggiuntive.
RegistryAddParams
Registra un registry e la policy di fiducia che la risoluzione applica a ciò che esso serve. Scrive il file di configurazione dell’intera macchina a meno che la richiesta non chieda altrimenti, così ogni workspace della macchina risolve tramite la voce.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
host | string | no | L’host del registry da registrare. |
name | string | no | Un alias di comodo che si risolve nell’host. |
identities | string[] | no | Le identità di firma ritenute attendibili per ciò che questo registry serve. |
keyPath | string | no | Il percorso di una chiave pubblica da ritenere attendibile, per un registry firmato con una chiave anziché con un’identità keyless. |
trustedRoot | string | no | Il percorso dell’ancora di fiducia rispetto a cui verificare le firme. |
requireSignatures | booleana | no | Se un artefatto proveniente da questo registry deve portare una firma verificata. Se assente, non dichiara nulla e lascia in vigore il valore predefinito risolto. |
advisory | booleana | no | Se una verifica non riuscita viene segnalata anziché arrestare l’esecuzione. |
fetchTrust | booleana | no | Se leggere la policy di fiducia che il registry rende nota e fissarla. Se assente, non dichiara nulla e lascia in vigore il valore predefinito risolto. |
global | booleana | no | Scrive il file di configurazione dell’intera macchina, che è il valore predefinito proprio di questo metodo. |
workspace | booleana | no | Scrive il file di configurazione proprio di questo workspace invece di quello dell’intera macchina. |
Non sono consentite proprietà aggiuntive.
RegistryRemoveParams
Rimuove un registry registrato. Scrive il file di configurazione dell’intera macchina a meno che la richiesta non chieda altrimenti.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
registry | string | no | Il registry da rimuovere, per host o per alias. |
global | booleana | no | Scrive il file di configurazione dell’intera macchina, che è il valore predefinito proprio di questo metodo. |
workspace | booleana | no | Scrive il file di configurazione proprio di questo workspace invece di quello dell’intera macchina. |
Non sono consentite proprietà aggiuntive.
RegistryUpdateParams
Aggiorna l’indice locale che una ricerca legge, raggiungendo il registry per farlo. Ciò che scrive è l’indice sotto la directory di cache configurata propria di questo workspace. Un registry che richiede una credenziale che nessuna sorgente dell’ambiente fornisce viene rifiutato nominando la credenziale, anziché richiederla interattivamente.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
registry | string | no | L’unico registry da aggiornare. Se assente, aggiorna ogni host configurato. |
upgrade | booleana | no | Se ricostruire l’indice anziché aggiungere a ciò che già contiene. |
Non sono consentite proprietà aggiuntive.
LogoutParams
Rimuove una credenziale di registry memorizzata. L’archivio è condiviso da ogni progetto sulla macchina, e la risposta lo dice.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
registry | string | no | Il registry di cui rimuovere la credenziale memorizzata. |
Non sono consentite proprietà aggiuntive.
PublishEntityParams
Pubblica un’entità in un registry. Ciò che vi deposita è ciò che risolve ogni consumatore di quel registry, e una versione pubblicata non può essere ritirata da chi l’ha già recuperata. Non viene chiesto nulla in modo interattivo: l’identità si risolve da ciò che la richiesta ha fornito o da ciò che l’ambiente già porta con sé.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
entity | string | no | Il documento dell’entità da pubblicare, come percorso relativo alla radice del workspace. |
registry | string | no | Il registry in cui pubblicare. Se assente, si usa quello predefinito configurato. |
dryRun | booleana | no | Se riportare ciò che la pubblicazione depositerebbe senza depositarlo. |
sign | booleana | no | Se firmare ciò che viene pubblicato. Se assente, non dichiara nulla e lascia in vigore il valore predefinito risolto. |
plugin | string | no | Il modulo del plugin da pubblicare insieme a un’entità Plugin. |
fulcioUrl | string | no | L’autorità di certificazione da cui ottenere un certificato di firma. |
rekorUrl | string | no | Il transparency log in cui registrare la firma. |
timestampUrl | string | no | L’autorità di timestamp con cui controfirmare. |
identityToken | string | no | Il token di identità con cui firmare, fornito dal chiamante anziché ottenuto da un terminale. |
pinSources | booleana | no | Se eseguire sull’entità, prima che venga impacchettata, il passo di fissaggio che esegue aggrega/pin, così che l’entity.lock che il passo scrive accanto a essa faccia parte di ciò che viene pubblicato. Il passo viene eseguito prima di ogni rifiuto che giudica l’entità, e con dryRun riporta il lock che scriverebbe e non scrive nulla. Se assente, segue pin_sources_at_push del workspace; l’uno o l’altro valore prevale su quell’impostazione per questa richiesta. |
Non sono consentite proprietà aggiuntive.
PublishArtifactParams
Pubblica un file arbitrario in un registry con un nome e un tag che la richiesta gli assegna.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
file | string | no | Il file da pubblicare, come percorso relativo alla radice del workspace. |
name | string | no | Il nome del repository sotto cui pubblicare. |
tag | string | no | Il tag sotto cui pubblicare. |
mediaType | string | no | Il tipo di media da registrare per i byte pubblicati. |
registry | string | no | Il registry in cui pubblicare. Se assente, si usa quello predefinito configurato. |
dryRun | booleana | no | Se riportare ciò che la pubblicazione depositerebbe senza depositarlo. |
Non sono consentite proprietà aggiuntive.
SignArtifactsParams
Firma ciò che è già pubblicato. Una firma non può essere ritirata da chi l’ha già recuperata.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
references | string[] | no | I riferimenti pubblicati da firmare. |
fulcioUrl | string | no | L’autorità di certificazione da cui ottenere un certificato di firma. |
rekorUrl | string | no | Il transparency log in cui registrare la firma. |
timestampUrl | string | no | L’autorità di timestamp con cui controfirmare. |
identityToken | string | no | Il token di identità con cui firmare, fornito dal chiamante anziché ottenuto da un terminale. |
jobs | integer | no | Quanti riferimenti vengono firmati contemporaneamente. Se assente, vengono firmati uno dopo l’altro. Ogni riferimento è comunque firmato esattamente come lo sarebbe da solo — in modalità keyless, con il proprio certificato e la propria voce nel transparency log — e la risposta mantiene l’ordine in cui i riferimenti sono stati forniti. Minimo: 1. |
Non sono consentite proprietà aggiuntive.
DeprecateArtifactParams
Contrassegna una versione pubblicata come deprecata, così che la risoluzione possa segnalarla o rifiutarla. Il marcatore è a sua volta pubblicato e firmato. Una richiesta invia o un riferimento con il suo contenuto, o un file batch le cui voci portano il proprio — mai entrambi, e mai contenuto accanto al file batch.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
reference | string | no | Il riferimento pubblicato da contrassegnare. Un’alternativa a from: una richiesta che porta entrambi viene rifiutata. |
severity | const “warning” o const “error” o const “retracted” | no | Quanto è forte il marcatore — se la risoluzione segnala la versione o la rifiuta. Obbligatorio con reference; rifiutato accanto a from, il cui file batch porta quello proprio di ciascun marcatore. Valori consentiti: "warning" — Deprecata, al più lieve dei due livelli consultivi: ancora selezionata quando viene scelta una versione. "error" — Deprecata, al più forte dei due livelli consultivi: ancora selezionata quando viene scelta una versione. "retracted" — Ritirata: esclusa quando viene scelta una versione. |
reason | string | no | Il motivo per cui la versione è deprecata. Obbligatorio con reference; rifiutato accanto a from, il cui file batch porta quello proprio di ciascun marcatore. |
replacement | string | no | Il riferimento da usare al suo posto. Rifiutato accanto a from, il cui file batch porta quello proprio di ciascun marcatore. |
message | string | no | Ciò che viene detto a un consumatore che incontra il marcatore. Rifiutato accanto a from, il cui file batch porta quello proprio di ciascun marcatore. |
from | string | no | Un file batch di voci di ritiro, come percorso relativo alla radice del workspace, che allega un marcatore per voce. Ogni voce porta il proprio riferimento, la propria severità e il proprio motivo, e facoltativamente una sostituzione e un messaggio. Un’alternativa a reference: una richiesta che porta entrambi, o che porta una severità, un motivo, una sostituzione o un messaggio accanto a esso, viene rifiutata. |
fulcioUrl | string | no | L’autorità di certificazione da cui ottenere un certificato di firma. |
rekorUrl | string | no | Il transparency log in cui registrare la firma. |
timestampUrl | string | no | L’autorità di timestamp con cui controfirmare. |
identityToken | string | no | Il token di identità con cui firmare, fornito dal chiamante anziché ottenuto da un terminale. |
Non sono consentite proprietà aggiuntive.
ResolveParams
Risponde indicando dove è definito l’elemento sotto il cursore.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
uri | string | no | Il documento in cui si trova il cursore. |
position | Position | no | Un punto in un documento: una riga e un offset di carattere al suo interno, entrambi contati a partire da zero. L’offset è misurato nelle unità della codifica che la sessione ha concordato quando è stata aperta, che è UTF-16 a meno che il client non ne abbia chiesta un’altra. |
release | string | no | La Release nei cui termini rispondere, come percorso relativo alla radice del workspace. La definizione è allora il documento in cui il riferimento si risolve attraverso le directory di catalogo che la configurazione del workspace assegna a quella Release, in quell’ordine, così un nome che più varianti in un unico workspace dichiarano, una per Release, rimanda alla variante di quella Release; dove quelle directory non dichiarano alcuna entità del genere, vengono cercati i documenti del workspace, escludendo quelli sotto una delle directory di catalogo del workspace che la Release non legge. Se assente, vengono cercati prima i documenti del workspace, e le directory di catalogo proprie del workspace solo dove nessun documento dichiara il nome. Un valore che non nomina alcun file di Release viene rifiutato. |
Non sono consentite proprietà aggiuntive.
FindReferencesParams
Risponde indicando dove si fa riferimento all’elemento sotto il cursore.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
uri | string | no | Il documento in cui si trova il cursore. |
position | Position | no | Un punto in un documento: una riga e un offset di carattere al suo interno, entrambi contati a partire da zero. L’offset è misurato nelle unità della codifica che la sessione ha concordato quando è stata aperta, che è UTF-16 a meno che il client non ne abbia chiesta un’altra. |
release | string | no | La Release nei cui termini rispondere, come percorso relativo alla radice del workspace. Un riferimento fatto in un documento sotto una delle directory di catalogo del workspace che la Release non legge non viene allora riportato, così le varianti che un workspace tiene affiancate, una per Release, non vengono mai riportate come riferimenti l’una dell’altra. Se assente, viene cercato ogni documento del workspace. Un valore che non nomina alcun file di Release viene rifiutato. |
Non sono consentite proprietà aggiuntive.
FindImplementationsParams
Risponde indicando quali documenti implementano l’elemento sotto il cursore.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
uri | string | no | Il documento in cui si trova il cursore. |
position | Position | no | Un punto in un documento: una riga e un offset di carattere al suo interno, entrambi contati a partire da zero. L’offset è misurato nelle unità della codifica che la sessione ha concordato quando è stata aperta, che è UTF-16 a meno che il client non ne abbia chiesta un’altra. |
release | string | no | La Release nei cui termini rispondere, come percorso relativo alla radice del workspace. Un documento sotto una delle directory di catalogo del workspace che la Release non legge non viene allora riportato, così una variante con cui un’altra Release esegue la build non viene mai elencata tra quelle di questa Release. Se assente, viene cercato ogni documento del workspace. Un valore che non nomina alcun file di Release viene rifiutato. |
Non sono consentite proprietà aggiuntive.
HoverParams
Risponde con ciò che va mostrato sull’elemento sotto il cursore.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
uri | string | no | Il documento in cui si trova il cursore. |
position | Position | no | Un punto in un documento: una riga e un offset di carattere al suo interno, entrambi contati a partire da zero. L’offset è misurato nelle unità della codifica che la sessione ha concordato quando è stata aperta, che è UTF-16 a meno che il client non ne abbia chiesta un’altra. |
release | string | no | La Release nei cui termini rispondere, come percorso relativo alla radice del workspace. L’entità mostrata è allora quella in cui il riferimento si risolve attraverso le directory di catalogo che la configurazione del workspace assegna a quella Release, in quell’ordine; dove quelle directory non dichiarano alcuna entità del genere, vengono cercati i documenti del workspace, escludendo quelli sotto una delle directory di catalogo del workspace che la Release non legge. Se assente, vengono cercati prima i documenti del workspace, e le directory di catalogo proprie del workspace solo dove nessun documento dichiara il nome. Un valore che non nomina alcun file di Release viene rifiutato. |
Non sono consentite proprietà aggiuntive.
CompletionParams
Risponde con ciò che può essere scritto nella posizione del cursore.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
uri | string | no | Il documento in cui si trova il cursore. |
position | Position | no | Un punto in un documento: una riga e un offset di carattere al suo interno, entrambi contati a partire da zero. L’offset è misurato nelle unità della codifica che la sessione ha concordato quando è stata aperta, che è UTF-16 a meno che il client non ne abbia chiesta un’altra. |
context | CompletionContext | no | Che cosa ha causato la richiesta, dove il client ne tiene traccia. |
release | string | no | La Release nei cui termini rispondere, come percorso relativo alla radice del workspace. I nomi offerti sono allora quelli che dichiarano i documenti del workspace, meno i documenti sotto una delle directory di catalogo del workspace che la Release non legge, insieme ai Components e alle Features che dichiarano le directory di catalogo assegnate a quella Release dalla configurazione del workspace. Se assente, sono i documenti del workspace e i Components e le Features che dichiarano le sue directory di catalogo proprie. Un valore che non nomina alcun file di Release viene rifiutato. |
Non sono consentite proprietà aggiuntive.
CompletionContext
Che cosa ha causato la richiesta, dove il client ne tiene traccia.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
triggerKind | integer | no | Perché è stato chiesto il completamento. |
triggerCharacter | string | no | Il carattere che lo ha causato, dove è stato un carattere. |
Le proprietà aggiuntive sono consentite.
AttachCandidatesParams
Risponde indicando quali Features possono essere associate a un’entità, giudicate rispetto alle etichette di quell’entità, e, per una connessione tracciata dal componente di un nodo del grafo, quali possono riempire ciascuno slot che il socket della connessione dichiara.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
node | string | no | L’entità rispetto a cui giudicare i candidati, per nome, letta da ciò che dichiarano i documenti del workspace. |
graphNode | string | no | Il nodo del grafo rispetto a cui giudicare i candidati, le cui etichette sono l’insieme finalizzato con cui la build stessa valuta l’applicabilità. Una risposta calcolata su di esso dice ciò che farà la build. |
release | string | no | La Release al cui grafo appartiene il nodo, come percorso relativo alla radice del workspace. I candidati sono allora tratti nei termini di quella Release: le Features che dichiarano le directory di catalogo assegnate a quella Release dalla configurazione del workspace, e i documenti del workspace meno quelli sotto una delle directory di catalogo del workspace che la Release non legge, così una Feature tenuta per un’altra Release non viene mai offerta per un nodo del grafo di questa. |
labels | mappa di string | no | Etichette rispetto a cui giudicare direttamente, al posto di leggerle da un’entità o da un nodo del grafo. |
connection | ConnectionCoordinate | no | Una connessione tracciata dal componente del nodo che graphNode nomina, per cui rispondere oltre che per quel nodo: la risposta porta allora anche slots, ciascuno slot che il socket della connessione dichiara con le Features che possono riempirlo, oppure noSlotReason dove nessuno slot può essere riempito. Viene inviata solo con graphNode e release, perché una connessione esiste solo su un grafo compilato; inviata con node o labels viene rifiutata. I candidati accanto a essa mantengono il loro significato, le Features che possono associarsi al nodo stesso. Il suo documento viene accettato e non cambia questa risposta: gli slot sono quelli del socket e i candidati quelli delle Features, gli stessi in qualunque documento venga scritta un’associazione. |
Non sono consentite proprietà aggiuntive.
ConnectionCandidatesParams
Risponde indicando a quali entità può essere collegato un socket di un’entità.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
node | string | no | L’entità sui cui socket si chiede. |
socket | string | no | L’unico socket per cui rispondere. Se assente, risponde per ogni socket che l’entità dichiara. |
Non sono consentite proprietà aggiuntive.
InsertionPointParams
Risponde indicando dove, in un documento, va collocata una nuova voce sotto un contenitore nominato, lasciando la composizione e l’applicazione della voce al chiamante che possiede il buffer.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
file | string | no | Il documento su cui rispondere. |
container | string[] | no | Il percorso attraverso il documento fino al contenitore sotto cui va collocata la voce. |
Non sono consentite proprietà aggiuntive.
AttachmentContainerParams
Risponde indicando in quale documento, e in quale punto di esso, va collocata un’associazione su un nodo del grafo, o su una connessione tracciata dal suo componente.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
graphNode | string | no | Il nodo del grafo a cui è destinata l’associazione. |
release | string | no | La Release al cui grafo appartiene il nodo, come percorso relativo alla radice del workspace. |
connection | ConnectionCoordinate | no | Una connessione tracciata dal componente del nodo del grafo, quando l’associazione è per quella connessione anziché per il nodo: la risposta nomina allora il contenitore features proprio della connessione nel documento che nomina il suo campo document, un campo qui obbligatorio. Nell’Aggregate, è la voce della connessione nel documento in cui il nodo è stato scritto, rifiutata per una connessione tracciata dalla Release, per la quale l’Aggregate non contiene alcuna voce. Nella Release, è la voce per singolo arco sotto la voce propria della Release per il nodo, che la Release ne scriva già una per quella connessione o no, rifiutata dove la Release non scrive alcuna voce per il nodo. Una connessione tracciata da una Feature viene rifiutata in entrambi i documenti, perché un’associazione viene scritta solo su una connessione tracciata da un componente o dalla Release. |
Non sono consentite proprietà aggiuntive.
ConnectionAtPositionParams
Risponde indicando all’interno della voce di quale connessione ricade una posizione in un Aggregate o in una Release: il nodo del grafo e la connessione, nei termini in cui li accettano le richieste di candidatura e di contenitore, oppure il motivo per cui lì non è scritta alcuna connessione. Le voci sono quelle in cui viene scritta un’associazione — la voce con cui un componente traccia una connessione, sotto l’alias della connessione, nel documento in cui il componente è stato scritto, e ogni voce per singolo arco che la Release scrive — ciascuna dove la registra il grafo compilato, così se una chiave è una connessione non viene mai dedotto da come si chiama.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
file | string | no | Il documento in cui si trova la posizione: la Release, o un documento in cui il grafo della Release registra componenti come scritti — il suo Aggregate, o il documento di un modulo che quell’Aggregate importa. Viene letto prima da ciò che la sessione conserva per esso, e altrimenti dal disco. |
position | Position | no | Un punto in un documento: una riga e un offset di carattere al suo interno, entrambi contati a partire da zero. L’offset è misurato nelle unità della codifica che la sessione ha concordato quando è stata aperta, che è UTF-16 a meno che il client non ne abbia chiesta un’altra. |
release | string | no | La Release il cui grafo compilato registra le connessioni, come percorso relativo alla radice del workspace. È obbligatoria anche per una posizione nell’Aggregate, perché un nodo del grafo e una connessione esistono solo su un grafo compilato. |
Non sono consentite proprietà aggiuntive.
ConnectionCoordinate
Una connessione tracciata dal componente di un nodo del grafo, indirizzata dal socket attraverso cui è collegata e dall’alias che porta in quel socket, e il documento in cui viene scritta un’associazione su di essa. Una connessione porta associazioni che riempiono gli slot dichiarati dal suo socket, e possono scriverle sia l’Aggregate sia la Release.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
socket | string | sì | Il socket di dipendenza attraverso cui è collegata la connessione. |
alias | string | sì | Il nome che la connessione porta all’interno del suo socket. |
document | const “aggregate” o const “release” | no | Il documento in cui viene scritta un’associazione sulla connessione. L’insieme è chiuso, e un valore al di fuori di esso viene rifiutato. Valori consentiti: "aggregate" — L’Aggregate, dove lo sviluppatore scrive un’associazione sulla voce della connessione. "release" — La Release, dove l’operatore scrive un’associazione sulla voce per singolo arco della connessione. |
Le proprietà aggiuntive sono consentite.
SetActiveReleaseParams
Registra una Release come predefinita del workspace scrivendo un marcatore nella directory .aggrega: la scelta che riporta aggrega/activeRelease legge quel marcatore dopo la Release di authoring della configurazione. Il marcatore viene scritto all’interno del workspace e da nessun’altra parte: dove la directory .aggrega o il marcatore è un collegamento che porta fuori dal workspace, che il luogo a cui porta esista già o no, la scrittura viene rifiutata nominando il collegamento e non viene scritto nulla. La risposta è quella che aggrega/activeRelease dà una volta scritto il marcatore, quindi nomina una Release diversa dove la Release di authoring della configurazione ha la precedenza sul marcatore.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
release | string | no | La Release da registrare, come percorso relativo alla radice del workspace. Un percorso assoluto, e uno che risale fuori dal workspace, vengono rifiutati; lo stesso vale per uno che ne esce attraverso un collegamento, a meno che la configurazione del workspace non nomini quella Release. |
Non sono consentite proprietà aggiuntive.
EditDocumentParams
Applica una singola modifica circoscritta a un documento contenuto nel workspace: una voce aggiunta sotto un contenitore, o un valore scalare impostato. Il documento composto viene verificato rispetto allo schema del suo tipo e raggiunge il disco solo se la verifica ha esito positivo, quindi questa operazione non può scrivere ciò che lo schema di authoring rifiuta. Una modifica rifiutata lascia il file identico byte per byte a com’era.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
file | string | no | Il documento da modificare. |
edit | const “add-component” o const “attach-feature” o const “wire-edge” o const “set-value” | no | Quale modifica applicare. Valori consentiti: "add-component" — Aggiunge un’istanza di componente sotto un contenitore components: name è il nome dell’istanza, value il Component che richiede. "attach-feature" — Associa una Feature al nodo nominato dalla richiesta: name è il nome dell’istanza dell’associazione, value la Feature che richiede. "wire-edge" — Collega una connessione di dipendenza dal nodo nominato dalla richiesta, all’interno di socket: name è l’alias con cui la connessione è indirizzata, value il nodo a cui punta. "set-value" — Imposta un valore sul nodo nominato dalla richiesta: name è la chiave del valore, value uno scalare. |
node | string[] | no | Il percorso attraverso il documento fino alla voce da modificare. |
socket | string | no | Il socket di cui tratta la modifica, per una modifica che ne collega uno. |
name | string | no | Il nome che la modifica scrive. |
value | any | no | Il valore che la modifica scrive, in qualunque forma richieda la modifica. |
dryRun | booleana | no | Se rispondere con il documento composto anziché scriverlo. |
Non sono consentite proprietà aggiuntive.
ConfigInitParams
Inizializza un documento di configurazione. Per impostazione predefinita scrive il file dell’intera macchina, poiché un registry e le identità ritenute attendibili su di esso sono strumenti dell’intera macchina. Contatta il registry nominato per leggere la policy di fiducia che annuncia; un registry che non annuncia nulla viene segnalato come tale e l’inizializzazione prosegue, sulla baseline integrata per l’hub ufficiale e senza alcuna policy per qualsiasi altro registry.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
registry | string | no | Il registry per cui inizializzare la configurazione. |
force | booleana | no | Se sovrascrivere un documento di configurazione già esistente. |
global | booleana | no | Scrive il file di configurazione dell’intera macchina, che è il valore predefinito proprio di questo metodo. |
workspace | booleana | no | Scrive il file di configurazione proprio di questo workspace invece di quello dell’intera macchina. |
dryRun | booleana | no | Se rispondere con il contenuto del documento anziché scriverlo, per un client che mantiene un proprio modello del documento. |
Non sono consentite proprietà aggiuntive.
ConfigCaptureParams
Congela la configurazione risolta nel documento proprio di questo workspace, così che il workspace sia autosufficiente. Scrive sempre il file di quel workspace e non raggiunge nulla al di fuori di esso.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
allPlugins | booleana | no | Se congelare ogni plugin associato anziché solo quelli che il workspace stesso ha configurato. |
Non sono consentite proprietà aggiuntive.
ImportParams
Converte una descrizione di sorgente esterna in documenti di authoring in bozza, e scrive accanto a essi .aggrega-import.json, il registro di ciò che l’importazione ha scritto — la destinazione che le è stata data, dove gliene è stata data una, lo snapshot del catalogo che ha letto, dove ne ha letto uno, ogni file redatto e ogni chiave di un Aggregate o di una Release redatti a qualsiasi profondità — che una sincronizzazione successiva legge. Una sorgente che non ha potuto convertire completamente è una risposta anziché un errore: le bozze che ha prodotto vengono scritte e i rilievi dicono ciò che non ha potuto convertire — tranne sotto sync, che non scrive nulla da una conversione che si è interrotta.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
source | string | no | Il file o la directory da convertire, come percorso assoluto o relativo alla radice del workspace; una richiesta che ne è priva viene rifiutata. Viene letto dove si trova, all’interno del workspace o no, e una directory viene letta nei suoi file che i pattern di file dichiarati dall’importatore selezionano. |
outputDir | string | no | La directory sotto il workspace in cui scrivere le bozze, relativa alla radice del workspace; un valore assoluto, o uno che porta fuori dal workspace così come è scritto o attraverso un collegamento, viene rifiutato. Se assente, scrive sotto la radice del workspace, dove scrive la stessa conversione eseguita a un terminale che non nomina alcuna destinazione. Ogni percorso redatto è relativo alla directory che la risposta nomina come outputDir, anche sotto dryRun. |
format | string | no | Il formato della sorgente. Se assente, lo determina la conversione. |
target | string | no | Una capacità del provider, come compose o helm — la parola a cui si lega lo spec.capability di una Recipe — per cui redigere un Manifest accanto alle bozze, come manifest.yaml: ogni tipo di componente e tipo di funzionalità di cui le bozze hanno bisogno, compresi i tipi di un Aggregate del catalogo che quello redatto compone, viene mappato sulla Recipe o sulla ricetta di funzionalità di quella capacità che il catalogo del workspace offre per esso — quella che c’è, o tra più d’una quella che porta il nome del tipo — un tipo che non ne ha nessuna, o ne ha più d’una e nessuna con quel nome, viene lasciato non mappato con un rilievo di avviso che lo nomina, una mappatura che un importatore ha redatto da sé viene mantenuta dove il catalogo la offre per quel tipo e quella capacità e altrimenti scartata con un rilievo di avviso, e lo spec.manifest della Release redatta viene impostato sul Manifest. Una capacità a cui nessuna Recipe del catalogo si lega viene rifiutata prima che la conversione venga eseguita, e non viene scritto nulla. Se assente, non redige alcun Manifest, tranne sotto sync, che redige per la destinazione nominata dal registro dell’importazione precedente; una sincronizzazione che nomina una destinazione redige per essa, e il registro allora la nomina. |
dryRun | booleana | no | Se rispondere con il contenuto di ogni file che la richiesta scriverebbe anziché scriverlo. Ogni altro comportamento è quello della scrittura, quindi una richiesta che la scrittura rifiuterebbe viene rifiutata anche in questo caso; con sync, risponde con ciò che la sincronizzazione scriverebbe e con ogni parte che andrebbe in deriva. |
sync | booleana | no | Se allineare alla sorgente ciò che un’importazione precedente ha redatto sotto outputDir, anziché scrivere la bozza per intero. Cambia solo ciò che l’importazione ha scritto, come lo elenca il registro accanto alle bozze: una parte che la sorgente ha lasciato invariata resta com’è sul disco, modificata o no; una parte che la sorgente ha cambiato, eliminato o acquisito viene scritta di nuovo, rimossa — un file redatto cancellato per intero — o aggiunta, dove ciò che si trova sul disco è ciò che l’importazione ha scritto l’ultima volta; e tutto il resto, una chiave che un autore ha aggiunto — tra cui l’ambiente che una Release redatta lascia al suo autore — o un commento non scritto direttamente sopra una chiave redatta, resta identico byte per byte. Una sincronizzazione che cambierebbe o rimuoverebbe ciò che un autore ha modificato o aggiunto, o aggiungerebbe una parte dove un autore ne ha già scritta una, viene rifiutata nominando ogni parte, e lo stesso vale per una sincronizzazione su un Aggregate che nessun registro elenca; in entrambi i casi non viene scritto nulla. Senza di esso, una richiesta le cui bozze verrebbero scritte sopra un Aggregate già presente in outputDir viene rifiutata, anche sotto dryRun. |
upgrade | booleana | no | Se scaricare lo snapshot del catalogo più recente che il registry predefinito del workspace pubblica e importare rispetto a esso, conservandolo da quel momento in poi al posto di quello che il workspace contiene o di quello che il registro accanto alle bozze nomina; non cambia nulla dove il workspace nomina una cartella del catalogo, ed è rifiutato offline. |
answers | string | no | Il file delle risposte da cui vengono letti e in cui vengono scritti i valori che le bozze lasciano vuoti e che nessuna sorgente può contenere, relativo alla radice del workspace; un valore assoluto, o uno che porta fuori dal workspace così come è scritto o tramite un link, viene rifiutato. Contiene, sotto il percorso di ciascun file redatto, il percorso della chiave all’interno di quel documento e la sua risposta, e le risposte vengono scritte nelle bozze. Se assente, si legge quello nominato dal registro accanto alle bozze, oppure import-answers.yaml accanto al file sorgente o all’interno della directory sorgente. La risposta per un segreto nomina da dove proviene il segreto — un nome di variabile, ${NAME}, o il nome di un Kubernetes Secret — e qualsiasi altra cosa viene rifiutata senza scrivere nulla. Non viene chiesto nulla: ogni valore ancora dovuto è una voce di owed della risposta e un rilievo di avviso che nomina il file redatto, la chiave e che cosa è, la sua risposta viene inviata come answered, e dove le bozze vengono scritte l’ultimo rilievo dice quanti ne sono dovuti e dove. Dove le bozze includono una Release, non devono nulla e la conversione è terminata, le sue dipendenze vengono poi scaricate, scrivendone il lockfile, e un pull che fallisce chiude i rilievi dicendo perché, con le bozze scritte; offline non viene scaricato nulla e un rilievo nomina il pull da eseguire. Una risposta per una chiave che queste bozze non lasciano vuota viene mantenuta nel file e non applicata, così un unico file delle risposte serve ogni target. |
answered | ImportAnswered[] | no | Risposte per i valori elencati in owed della risposta, ciascuna delle quali nomina il file redatto e le chiavi come le ha nominate owed. Ciascuna viene valutata, mantenuta nel file delle risposte e scritta nelle bozze esattamente come una risposta digitata in un terminale: la risposta per un segreto nomina da dove proviene il segreto — un nome di variabile, ${NAME}, o il nome di un Kubernetes Secret — e una che non lo fa non viene né mantenuta né scritta, e il suo valore resta dovuto con il motivo come suo secretAdvice. Un valore a cui il file delle risposte risponde già riceve la risposta dal file; una risposta vuota, o una che nomina un valore che le bozze non devono, non viene applicata. Inviala con sync una volta scritte le bozze, poiché una richiesta che non è un sync viene rifiutata su un Aggregate già presente in outputDir. Con dryRun, che non mantiene alcuna risposta, e con un sync la cui conversione si è interrotta, che non scrive nulla, nessuna risposta inviata viene applicata. |
Non sono consentite proprietà aggiuntive.
ScaffoldEntityParams
Redige un documento iniziale per un tipo di entità, oppure scrive uno degli esempi eseguibili della documentazione in una nuova directory del workspace, oppure li elenca. La redazione ricava lo scheletro dall’insieme di schemi che il binario contiene, quindi nulla viene letto da un workspace e nulla viene scritto — la risposta è testo, e dove va spetta al client. La scrittura di un esempio scrive la nuova directory e nient’altro, e gli esempi vengono letti dal bundle firmato della documentazione pubblicato per la versione del binario, o dal più recente pubblicato prima di essa dove non ce n’è uno, verificato rispetto alla policy di firma del workspace prima di essere conservato o letto: un bundle che non supera la verifica viene rifiutato, e offline viene letta solo una copia già in cache. Una richiesta che invia insieme i campi di due forme — kind con example o list, list con example, name con example o list, dir senza example — viene rifiutata prima che venga letto alcunché.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | string | no | Il percorso assoluto del workspace. La redazione non lo legge. La scrittura o l’elenco di un esempio lo richiede: la configurazione del workspace decide da dove viene recuperata la documentazione e quali firme deve portare, e un esempio viene scritto al suo interno. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
kind | string | no | Il tipo di entità da redigere, nominato dal suo token in minuscolo, come component, aggregate, release, recipe o featurerecipe — il token che aggrega/getSchema elenca per esso. |
name | string | no | Il nome da scrivere nel documento redatto. Inviato solo con kind. |
example | string | no | L’esempio eseguibile da scrivere, con il nome che gli dà l’elenco degli esempi. Inviato al posto di kind. |
list | booleana | no | Se rispondere con ogni esempio eseguibile che la documentazione pubblica, senza scrivere nulla. Inviato senza example e senza kind. |
dir | string | no | La nuova directory in cui scrivere l’esempio, relativa alla radice del workspace; se assente, lo scrive lì in una directory che prende il nome dall’esempio. Non deve ancora esistere o deve essere vuota: una che contiene qualcosa viene rifiutata e lasciata com’è, e un valore assoluto, o uno che porta fuori dal workspace così come è scritto o attraverso un collegamento, viene rifiutato prima che venga letto alcunché. Inviato solo con example. |
Non sono consentite proprietà aggiuntive.
LintParams
Controlla le convenzioni di pubblicazione del catalogo su una singola entità, su tutto ciò che la chiusura di una Release raggiunge, o su tutto ciò che si trova sotto le directory di catalogo configurate. In nessuna modalità viene scritto nulla. Non nominare né un’entità né una Release controlla l’intero catalogo: in un workspace la cui configurazione non assegna a nessuna Release directory di catalogo proprie, una volta sulle directory del workspace; in un workspace che nomina Releases sotto workspace.releases, una volta per ogni Release sulle directory che quella Release legge, mai su tutte insieme.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
entity | string | no | L’unico documento di entità da controllare. |
release | string | no | La Release di cui controllare la chiusura, come percorso relativo alla radice del workspace. |
prePublish | booleana | no | Se confrontare ogni entità con la sua versione pubblicata in precedenza, il che raggiunge i registry configurati. |
Non sono consentite proprietà aggiuntive.
PluginAddParams
Associa un plugin a un socket che il workspace configura. Raggiunge un registry per risolvere la query in un unico plugin e per fissarne una versione. L’unica decisione che un terminale otterrebbe — accettare le capacità dichiarate di un plugin di estensione dei comandi — arriva qui come campo, così il client chiede a chiunque lo stia pilotando e questa superficie non attende mai un prompt.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
type | string | no | Il socket a cui si associa il plugin. |
query | string | no | Ciò da risolvere in un unico plugin. |
capability | string | no | La capacità a cui è destinata l’associazione, dove il socket ne porta diverse. |
role | string | no | Il ruolo in cui viene eseguita l’associazione, che stabilisce ciò che può emettere. |
global | booleana | no | Scrive il file di configurazione dell’intera macchina. |
workspace | booleana | no | Scrive il file di configurazione proprio di questo workspace. |
acceptCapabilities | booleana | no | Se il chiamante accetta le capacità che un plugin di estensione dei comandi dichiara. |
dryRun | booleana | no | Se rispondere con il contenuto del documento di configurazione anziché scriverlo. |
Non sono consentite proprietà aggiuntive.
PluginRemoveParams
Dissocia un plugin da un socket che il workspace configura.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
type | string | no | Il socket a cui è associato il plugin. |
query | string | no | Quale associazione rimuovere. |
global | booleana | no | Scrive il file di configurazione dell’intera macchina. |
workspace | booleana | no | Scrive il file di configurazione proprio di questo workspace. |
Non sono consentite proprietà aggiuntive.
PluginSyncParams
Allinea i record gestiti dalla macchina di un’entità Plugin al modulo a cui essa punta. Riscrive quei record e riporta invariato ogni altro byte del documento.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
entity | string | no | Il documento dell’entità Plugin da allineare. |
plugin | string | no | Il modulo del plugin da cui leggere i record. |
Non sono consentite proprietà aggiuntive.
PluginGenCatalogParams
Genera documenti di catalogo Plugin a partire dai metadati dichiarati dal plugin stesso più un overlay scritto dall’autore. Rigenerare su input invariati produce documenti identici byte per byte.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
fromEmbedded | booleana | no | Se leggere i metadati dai plugin che il binario porta già con sé. |
plugin | string | no | Il modulo del plugin da cui leggere i metadati. |
outputDir | string | no | La directory sotto il workspace in cui scrivere i documenti. |
overlay | string | no | Il documento scritto dall’autore il cui contenuto viene unito sopra i metadati generati. |
dryRun | booleana | no | Se rispondere con il contenuto dei documenti anziché scriverli. |
Non sono consentite proprietà aggiuntive.
ExplainErrorParams
Espande un codice che un rilievo portava in ciò che il compilatore dichiara su quella condizione e nelle voci pubblicate che insegnano la correzione di authoring. Acquisisce la documentazione pubblicata quando il workspace non ne ha una copia; se non riesce ad acquisirla, risponde comunque con ciò che il binario dichiara, e dice perché manca il testo esplicativo.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
code | string | no | La condizione da espandere, nominata dal codice che un rilievo portava o dal suo codice breve. |
Non sono consentite proprietà aggiuntive.
GetSchemaParams
Risponde con lo schema di un tipo, oppure — quando non viene nominato alcun tipo — con i tipi che possono essere nominati. Risponde per il binario in esecuzione anziché per qualunque copia sia installata altrove, quindi non ha bisogno di alcun workspace e non ne legge nessuno.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootAccepted | no | Il percorso assoluto di un workspace. Il soggetto di questo metodo non è un workspace — risponde a partire da ciò che il binario stesso contiene — quindi il campo è accettato e non letto. È ammesso perché un client possa inviarlo in modo uniforme su ogni richiesta senza dover sapere quali metodi lo consultano. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
kind | string | no | Il tipo il cui schema restituire nella risposta. Se assente, risponde invece con i tipi che possono essere nominati. |
Non sono consentite proprietà aggiuntive.
SkillsInstallParams
Scrive la skill per assistenti integrata nel binario nella cartella delle skill di ciascun assistente che la richiesta nomina oppure, per una richiesta globale che non ne nomina nessuno, di ciascun assistente trovato su questa macchina. Senza global scrive la cartella di progetto di ciascun assistente all’interno del workspace che la richiesta nomina, e ogni percorso che vi scriverebbe è vincolato a quel workspace; con global scrive la cartella per utente di ciascun assistente sotto la directory home. Ogni destinazione viene controllata prima che venga scritto qualcosa, così un rifiuto lascia ogni cartella com’era.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | sì | Il percorso assoluto del workspace su cui agisce questa richiesta. È il soggetto della richiesta: il daemon lo risolve prima che il metodo venga eseguito, e una richiesta che lo omette o lo scrive come qualcosa di diverso da una stringa viene rifiutata. |
workDoneToken | ProgressToken | no | Un valore che il chiamante genera per poter abbinare le notifiche di avanzamento alla chiamata che le ha chieste. Viene ripetuto invariato su ogni notifica, così un chiamante può confrontarlo con il valore che ha inviato. È accettato su ogni richiesta, e una richiesta che ne invia uno in una sessione che non ha dichiarato alcuna capacità di avanzamento viene rifiutata. |
agents | string[] | no | Gli assistenti per cui installare la skill, tramite gli identificatori che l’elenco riporta. Una richiesta di progetto che non ne nomina nessuno viene rifiutata. Una richiesta globale che non ne nomina nessuno installa la skill per gli assistenti trovati su questa macchina, ciascuno la cui cartella di configurazione si trova nella directory home o il cui comando si trova nel PATH, e viene rifiutata senza scrivere nulla dove non ne viene trovato nessuno. Un identificatore per cui non è nota alcuna cartella delle skill viene rifiutato, per nome, e un identificatore dato due volte viene installato una volta. |
global | booleana | no | Scrive la cartella delle skill per utente di ciascun assistente sotto la directory home, che esso legge in ogni progetto, invece della sua cartella di progetto nel workspace. |
Non sono consentite proprietà aggiuntive.
ServerCapabilities
Ciò che il daemon farà in questa sessione, concordato rispetto a ciò che il client ha detto di saper gestire.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
positionEncoding | string | sì | La codifica in cui è espressa ogni posizione in questa sessione. |
workDoneProgress | booleana | no | Se il daemon invierà notifiche di avanzamento in questa sessione. Presente solo dove il client ha dichiarato di poterle ricevere. |
Non sono consentite proprietà aggiuntive.
ClosureEntity
Un’entità da cui dipende una Release, alla versione stabilita dalla risoluzione.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
uri | string | sì | Il riferimento da cui si risolve l’entità. |
version | string | sì | La versione che è stata stabilita. |
kind | string | no | Il tipo di entità. |
source | string | no | Da dove l’esecuzione che ha prodotto questa voce ha preso l’entità, con la stessa parola che aggrega pull --detail stampa per essa: fetched-fresh (recuperata da un registry durante quell’esecuzione), cache-reuse (una copia già nella cache, riusata senza recuperarla), local (trovata sul filesystem locale, come una directory di catalogo), in-binary (la copia all’interno del binario del compilatore) o external (l’Aggregate o il Manifest proprio della Release, letto dal file o dalla voce che la Release nomina anziché risolto come una delle sue dipendenze; un Aggregate che l’esecuzione ha recuperato da un registry è invece fetched-fresh). Presente sulle voci del report di una risoluzione delle dipendenze, dove descrive ciò che quell’esecuzione ha fatto su questa macchina, e assente da un elenco delle dipendenze risolte di una Release, che descrive ciò da cui la Release dipende. Il file di lock non registra alcuna origine. Omesso per un’entità di cui l’esecuzione non ha registrato l’origine. |
Non sono consentite proprietà aggiuntive.
ToolchainCorePlugin
Un plugin che il compilatore stesso porta con sé, e la versione di esso che è stata usata.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
plugin | string | sì | Il riferimento del plugin. |
version | string | sì | La versione che è stata usata. |
Non sono consentite proprietà aggiuntive.
ToolchainReport
Il compilatore che ha eseguito la risoluzione, e i plugin che porta con sé.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
compilerVersion | string | sì | La versione del compilatore che ha eseguito la risoluzione. |
corePlugins | ToolchainCorePlugin[] | no | I plugin che il compilatore porta con sé, con la versione di ciascuno che è stata usata. |
Non sono consentite proprietà aggiuntive.
DependencyResolutionReport
Ciò che una risoluzione delle dipendenze ha fissato e acquisito.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
lockfile | string | sì | Il file di lock che la risoluzione ha scritto, o quello con cui una verifica ha confrontato. |
verified | booleana | no | Se la richiesta era una verifica, che ha confrontato il file di lock registrato e non ha scritto alcun file di lock, registro di fiducia dei plugin né entity.lock. |
entities | ClosureEntity[] o null | sì | Le entità che la risoluzione ha fissato, o che una verifica ha confrontato. |
libraries | ClosureEntity[] o null | sì | Le librerie che la risoluzione ha fissato, o che una verifica ha confrontato. |
plugins | ClosureEntity[] o null | sì | I plugin che la risoluzione ha fissato, o che una verifica ha confrontato. |
sourceArtifacts | integer | sì | Quanti artefatti sorgente sono stati acquisiti. |
trustedPlugins | integer | sì | Quanti dei plugin fissati portavano una firma verificata. |
toolchain | ToolchainReport | no | Il compilatore che ha eseguito la risoluzione, e i plugin che porta con sé. |
externalInputs | integer | sì | Quanti input esterni consumati dal rendering sono stati acquisiti. |
incompleteExternalInputs | string | no | Quali input esterni non è stato possibile acquisire, dove alcuni non lo sono stati. |
Non sono consentite proprietà aggiuntive.
BuildNotice
Una cosa che la build vuole far sapere al chiamante, che non è né un rilievo su un documento né un errore.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
class | string | sì | Che tipo di avviso è questo. |
text | string | sì | Ciò che dice l’avviso. |
Non sono consentite proprietà aggiuntive.
CacheScope
Fin dove arriva una risposta sulla cache. Due delle classi di cache sono condivise da ogni progetto sulla macchina, quindi ogni risposta sulla cache nomina quelle che ha toccato — altrimenti una sessione aperta su un workspace verrebbe letta come se riferisse solo su quel workspace.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
machineWideClasses | string[] o null | sì | Le classi di cache toccate da questa risposta che sono condivise tra tutti i progetti sulla macchina. |
workspaceRoot | string | sì | Il workspace che la richiesta ha nominato. |
Non sono consentite proprietà aggiuntive.
CacheElement
Una cosa che una cache contiene.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
label | string | sì | Di che cosa è la voce. |
size | integer | sì | Quanti byte occupa. |
sizeText | string | sì | La stessa dimensione scritta nel modo in cui la legge una persona. |
digest | string | no | Il digest del contenuto sotto cui è indicizzata la voce, dove ne ha uno. |
note | string | no | Qualsiasi altra cosa che valga la pena dire sulla voce. |
Non sono consentite proprietà aggiuntive.
CacheClass
Una cache su cui il daemon riferisce.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
name | string | sì | Quale cache è questa. |
reach | string | sì | Se la cache appartiene a questo workspace o è condivisa sulla macchina. |
prunable | booleana | sì | Se recuperare lo spazio di questa cache è qualcosa che il daemon farà. |
elements | CacheElement[] o null | sì | Ciò che la cache contiene. |
Non sono consentite proprietà aggiuntive.
CacheProvenance
Sotto quali identità è stato acquisito un artefatto in cache, e quanto ampiamente è condiviso.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
identities | string[] o null | sì | Le identità a cui è attribuito l’artefatto. |
sharedBy | integer | no | Quanti detentori condividono l’artefatto. |
Non sono consentite proprietà aggiuntive.
CacheRemoval
Una cosa che un recupero di spazio ha rimosso — oppure, in un elenco di ciò che ha lasciato al suo posto, una cosa che avrebbe rimosso.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
class | string | sì | La cache a cui appartiene. |
label | string | sì | Che cosa è. |
reach | string | sì | Se quella cache appartiene a questo workspace o è condivisa sulla macchina. |
size | integer | sì | Quanti byte occupa, o occupava prima di essere rimossa. |
sizeText | string | sì | La stessa dimensione scritta nel modo in cui la legge una persona. |
Non sono consentite proprietà aggiuntive.
CacheShortfall
Ciò che un recupero di spazio ha lasciato dietro di sé, e ciò che lo recupererebbe, così un chiamante che legge una cifra più piccola di quella che si aspettava apprende il perché anziché dedurlo.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
class | string | sì | Quale cache contiene ciò che è stato lasciato. |
count | integer | sì | Quante voci sono state lasciate. |
size | integer | sì | Quanti byte occupano. |
sizeText | string | sì | La stessa dimensione scritta nel modo in cui la legge una persona. |
reach | string | sì | Se quella cache appartiene a questo workspace o è condivisa sulla macchina. |
reclaimedBy | string[] o null | sì | Che cosa le recupererebbe. |
Non sono consentite proprietà aggiuntive.
CacheCleared
Una cache che una pulizia ha svuotato.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
class | string | sì | Quale cache è stata svuotata. |
reach | string | sì | Se appartiene a questo workspace o è condivisa sulla macchina. |
size | integer | sì | Quanti byte sono stati recuperati da essa. |
sizeText | string | sì | La stessa dimensione scritta nel modo in cui la legge una persona. |
heldOpenFiles | integer | sì | Quanti file la pulizia ha lasciato in questa cache perché un altro processo li teneva aperti. Solo Windows rifiuta di rimuovere un file aperto, quindi ovunque altrove questo valore è zero. Una pulizia successiva li rimuove una volta che quel processo ha finito di usarli. |
heldOpenBytes | integer | sì | Quanti byte occupano quei file. Non sono conteggiati in size, che è ciò che la pulizia ha recuperato. |
heldOpenBytesText | string | sì | La stessa cifra scritta nel modo in cui la legge una persona. |
Non sono consentite proprietà aggiuntive.
ConfigWriteScope
Quale documento di configurazione è stato scritto e fin dove arriva. Una richiesta nomina un unico workspace, quindi una risposta che non dicesse nulla verrebbe letta come relativa a quel workspace — e per una scrittura sull’intera macchina quella lettura è sbagliata.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
configFile | string | sì | Il documento che è stato scritto. |
machineWide | booleana | sì | Se quel documento è quello tramite cui risolve ogni workspace della macchina. |
workspaceRoot | string | sì | Il workspace che la richiesta ha nominato. |
Non sono consentite proprietà aggiuntive.
PluginWriteScope
In quale documento di configurazione è stata scritta una modifica ai plugin e fin dove arriva. Il valore predefinito proprio del socket di estensione dei comandi è il documento dell’intera macchina, quindi ogni risposta dice quale ha scritto.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
configFile | string | sì | Il documento che è stato scritto. |
machineWide | booleana | sì | Se quel documento è quello tramite cui risolve ogni workspace della macchina. |
workspaceRoot | string | sì | Il workspace che la richiesta ha nominato. |
Non sono consentite proprietà aggiuntive.
CredentialStoreScope
Fin dove arriva una modifica a una credenziale. L’archivio è condiviso da ogni progetto sulla macchina e da ogni altro strumento che si rivolge agli stessi registry, quindi la risposta lo riporta anziché lasciare che se ne deduca una lettura limitata alla sessione.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
machineWide | booleana | sì | Se l’archivio toccato dalla modifica è condiviso sulla macchina. |
workspaceRoot | string | sì | Il workspace che la richiesta ha nominato. |
Non sono consentite proprietà aggiuntive.
SkillFolderScope
Fin dove arriva un’installazione di skill. Una richiesta nomina un unico workspace, quindi una risposta che non dicesse nulla verrebbe letta come relativa a quel workspace — e per le cartelle per utente, che un assistente legge in ogni progetto, quella lettura è sbagliata.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
machineWide | booleana | sì | Se le cartelle scritte sono quelle per utente sotto la directory home, che l’assistente legge in ogni progetto sulla macchina. |
workspaceRoot | string | sì | Il workspace che la richiesta ha nominato. |
Non sono consentite proprietà aggiuntive.
PublicationReach
Fin dove è arrivata una pubblicazione. Queste risposte arrivano del tutto oltre questa macchina — ciò che allegano è ciò che risolve ogni consumatore di quel registry — quindi ciascuna nomina ogni registry a cui si è rivolta e se la chiamata vi ha allegato qualcosa.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
registries | string[] | sì | Ogni host di registry a cui la chiamata si è rivolta, ciascuno nominato una sola volta, nell’ordine in cui la chiamata vi si è rivolta per la prima volta. Una chiamata su un singolo riferimento ne nomina uno; un’esecuzione di prova nomina la destinazione a cui si sarebbe rivolta. |
beyondThisMachine | booleana | sì | Se la chiamata ha allegato qualcosa che un registry ora serve ad altri: contenuto caricato, una firma, una data di pubblicazione o un marcatore di deprecazione. Vale false in un’esecuzione di prova, e in una chiamata che ha trovato già presente tutto ciò che avrebbe allegato — una pubblicazione eseguita di nuovo su una versione completa, o un lotto di firma in cui ogni riferimento portava già una firma che si verifica. |
Non sono consentite proprietà aggiuntive.
WorkspaceEntityRef
Un’entità, per tipo e nome, con il documento che la dichiara.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
kind | string | sì | Il tipo di entità. |
name | string | sì | Il nome dell’entità. |
file | string | sì | Il documento che la dichiara, come percorso relativo alla radice del workspace. |
Non sono consentite proprietà aggiuntive.
SourcedEntityRef
Un’entità, con il luogo da cui è stata letta. Un documento del workspace riporta il proprio percorso relativo al workspace; un’entità risolta dalle directory di catalogo configurate riporta un percorso vuoto, perché l’unico percorso che ha non significherebbe nulla per un client. L’origine dice quale dei due casi sia, anziché lasciare che un percorso vuoto venga letto come un campo che nessuno ha compilato.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
kind | string | sì | Il tipo di entità. |
name | string | sì | Il nome dell’entità. |
file | string | sì | Il documento che la dichiara, come percorso relativo alla radice del workspace, oppure vuoto dove proviene dalle directory di catalogo configurate. |
origin | string | sì | Da dove è stata letta l’entità. |
Non sono consentite proprietà aggiuntive.
SocketCandidacy
Un socket su un’entità, e ciò che può esservi collegato.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
socket | string | sì | Il nome del socket. |
declaration | string | sì | Dove è dichiarato il socket. |
selector | string | sì | Il selettore di etichette che una destinazione deve soddisfare. |
required | booleana | sì | Se il socket deve essere collegato perché la build prosegua. |
targets | WorkspaceEntityRef[] o null | sì | Le entità che possono esservi collegate. |
Non sono consentite proprietà aggiuntive.
SlotCandidacy
Uno slot che il socket di una connessione dichiara, così come il Component consumatore lo dichiara sul socket, e le Features che possono riempirlo su quella connessione.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
slot | string | sì | Il nome dello slot, che è la chiave sotto cui un’associazione che lo riempie viene scritta nelle features della connessione. |
selector | string | sì | Il selettore di etichette che una Feature che riempie lo slot deve soddisfare con le proprie etichette. Vuoto dove lo slot non ne dichiara alcuno, il che ammette qualsiasi Feature. |
required | booleana | sì | Se ogni connessione collegata tramite il socket deve riempire lo slot perché la build prosegua. |
inject | string[] | sì | I meccanismi di consegna che lo slot consente per ciò che lo riempie, nell’ordine in cui il Component li dichiara. Vuoto dove non ne dichiara alcuno. |
sensitive | booleana | sì | Se lo slot dichiara che ciò che lo riempie gestisce materiale segreto. Contrassegna l’associazione che lo riempie e non rifiuta nulla. |
description | string | sì | A cosa serve lo slot secondo il Component. Vuoto dove non dice nulla. |
candidates | SourcedEntityRef[] | sì | Ogni Feature che può riempire lo slot su questa connessione: una la cui applicabilità dichiarata è soddisfatta dalle etichette del nodo del grafo, requisito a cui è tenuta ogni associazione che il nodo porta, e le cui etichette soddisfano il selettore dello slot. Una Feature la cui applicabilità o le cui etichette non possono essere lette rispetto al selettore non viene offerta, perché una build la rifiuta anziché ammetterla. |
Non sono consentite proprietà aggiuntive.
CatalogEntity
Un’entità contenuta nell’indice del workspace.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
kind | string | sì | Il tipo di entità. |
name | string | sì | Il nome dell’entità. |
apiVersion | string | sì | La versione dello schema che il documento dichiara. |
description | string | sì | A cosa serve l’entità secondo il documento. |
labels | mappa di string o null | sì | Le etichette che il documento dichiara. |
file | string | sì | Il documento che la dichiara, come percorso relativo alla radice del workspace. |
origin | string | sì | Da dove è stata letta l’entità. |
Non sono consentite proprietà aggiuntive.
CompletionItem
Un elemento che può essere scritto nella posizione del cursore.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
label | string | sì | Il testo da scrivere. |
kind | integer | no | Di che genere di elemento si tratta, così che un client possa sceglierne un’icona. |
detail | string | no | Un breve qualificatore mostrato accanto all’etichetta. |
documentation | string | no | Che cos’è l’elemento, per esteso. |
sortText | string | no | Il valore in base a cui ordinare, dove differisce dall’etichetta. |
Non sono consentite proprietà aggiuntive.
MarkupContent
Testo da mostrare, e con quale markup è scritto.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
kind | string | sì | Con quale markup è scritto il testo. |
value | string | sì | Il testo. |
Non sono consentite proprietà aggiuntive.
EntityKindDescriptor
Un tipo di cui un autore scrive un documento, che abbina il token nominato da una richiesta al tipo che il documento stesso dichiara, e dice quali operazioni accettano un documento di quel tipo.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
kind | string | sì | Il token in minuscolo che una richiesta nomina, come component o featurerecipe. |
documentKind | string | sì | Il tipo che dichiara l’intestazione del documento stesso. |
acceptedBy | EntityKindAcceptance | sì | Quali operazioni accettano un documento di questo tipo nominato da solo — tramite il suo percorso, o tramite il suo nome per l’ispezione — senza nient’altro inviato accanto a esso. Un campo è true quando quell’operazione non rifiuta un documento per il fatto di essere di questo tipo; un documento che accetta può comunque essere rifiutato per ciò che il documento dice. |
Non sono consentite proprietà aggiuntive.
EntityKindAcceptance
Per un tipo che un autore scrive, se ciascuna operazione accetta un documento di quel tipo nominato da solo. Ogni campo è presente in ogni voce, quindi false è un’affermazione anziché un’omissione.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
singleEntityValidation | booleana | sì | Se l’ambito a entità singola di aggrega validate — il comando a cui viene dato il percorso di un solo documento — controlla un documento di questo tipo. Un tipo che rifiuta viene invece controllato dall’ambito dell’intero catalogo o dall’ambito della Release. |
publication | booleana | sì | Se aggrega/publishEntity, nominando solo il documento, pubblica un documento di questo tipo. Un tipo la cui pubblicazione lega anche un eseguibile nominato accanto al documento — un Plugin — è false, perché per esso una richiesta che nomina solo il documento viene rifiutata; un Manifest e una Release sono false perché nessuno dei due tipi viene pubblicato. |
inspectionByName | booleana | sì | Se aggrega/entityDefinition risolve un nome in un’entità di questo tipo, con il nome inviato così come viene scritto dove un’entità fa riferimento a un’altra. |
Non sono consentite proprietà aggiuntive.
RegistryTrust
La policy di fiducia che la risoluzione applica a ciò che un registry serve.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
signaturesRequired | booleana | sì | Se un artefatto proveniente da questo registry deve portare una firma verificata. |
verificationSkipped | booleana | no | Se la verifica viene saltata. |
advisory | booleana | no | Se una verifica non riuscita viene segnalata anziché arrestare l’esecuzione. |
anchor | string | no | L’ancora di fiducia rispetto a cui vengono verificate le firme. |
keylessIdentities | integer | no | Quante identità di firma sono ritenute attendibili per questo registry. |
Non sono consentite proprietà aggiuntive.
Registry
Un registry configurato. Nessun campo qui porta materiale di credenziali, la sua lunghezza, la sua forma o una qualsiasi sua rappresentazione — la presenza è tutto ciò che viene riportato, ed è ciò che rende il valore sicuro da incollare in una issue.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
host | string | sì | L’host del registry, che ne costituisce l’identità. |
name | string | no | L’alias di comodo che si risolve nell’host, dove ne è configurato uno. |
default | booleana | sì | Se questo è il registry a cui si rivolge un’operazione che non nomina alcun registry. |
authState | string | sì | Se nell’archivio dell’intera macchina è presente una credenziale per questo host. Viene riportato anche quando è vuoto, così un chiamante può distinguere «nessuna credenziale è presente» da «l’elenco non ha controllato». |
trust | RegistryTrust | sì | La policy di fiducia che la risoluzione applica a ciò che un registry serve. |
Non sono consentite proprietà aggiuntive.
TrustFetchOutcome
Che cosa ha prodotto la lettura della policy di fiducia annunciata da un registry. Gli esiti sono tenuti distinti perché significano cose diverse: la policy annunciata è stata adottata, il registry non ha annunciato nulla — il che non è un errore — al suo posto è stata fissata la baseline integrata, oppure non è stata tentata alcuna lettura. Dove non è stato annunciato nulla, accanto a ciò si indica se il registry fosse raggiungibile.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
pinned | booleana | sì | Se la policy annunciata è stata adottata. |
notAdvertised | booleana | no | Se al registry è stato chiesto e non ha annunciato alcuna policy, nel qual caso l’operazione prosegue su ciò che la richiesta ha dichiarato. Un registry a cui la modalità offline ha impedito di chiedere non viene mai riportato in questo modo. Un registry che non è stato possibile raggiungere viene riportato anch’esso in questo modo, poiché da esso non è tornata alcuna policy, e porta unreachable accanto; leggi unreachable per distinguere i due casi. |
unreachable | booleana | no | Se non è stato possibile raggiungere il registry quando è stata chiesta la sua policy annunciata: il suo nome non si è risolto, una connessione verso di esso è stata rifiutata o non ha potuto essere aperta, oppure non è stato possibile stabilire una connessione sicura verso di esso. Viene letto dall’errore stesso anziché da reason, sta accanto a notAdvertised, e viene impostato solo dove l’errore mostra che il registry non è mai stato raggiunto; un registry che ha risposto — senza policy, o con un errore — lo lascia assente. |
baseline | booleana | no | Se la baseline integrata, che solo l’hub ufficiale porta, è stata fissata perché non è stata adottata alcuna policy annunciata. Sta accanto a notAdvertised dove all’hub è stato chiesto e non ha annunciato nulla, e da solo dove la modalità offline ha impedito di chiedere all’hub. |
skipped | booleana | no | Se non è stata tentata alcuna lettura, perché una policy dichiarata l’ha sostituita o la richiesta non ne ha chiesta alcuna. |
identities | integer | no | Quante identità di firma portava la policy annunciata. |
reason | string | no | Perché la policy annunciata non è stata adottata: che cosa ha fatto l’endpoint del registry, oppure il rifiuto offline che ha impedito di interrogarlo. |
Non sono consentite proprietà aggiuntive.
SkippedRepo
Un repository che la visita dell’indice ha saltato, e il motivo.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
repo | string | sì | Il repository che è stato saltato. |
reason | string | sì | Perché è stato saltato. |
Non sono consentite proprietà aggiuntive.
DeprecationNote
Un marcatore di deprecazione che la visita dell’indice ha incontrato, e che cosa ne ha fatto. Un marcatore che è stato rispettato e uno che era presente ed è stato respinto vengono riportati sullo stesso piano, così registrarne molti non passa sotto silenzio mentre respingerne uno si fa notare.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
repo | string | sì | Il repository su cui si trova il marcatore. |
version | string | sì | La versione coperta dal marcatore. |
recorded | booleana | sì | Se la firma propria del marcatore è stata verificata, e l’indice quindi lo porta. |
severity | const “warning” o const “error” o const “retracted” | no | Quanto è forte il marcatore. Valori consentiti: "warning" — Deprecata, al più lieve dei due livelli consultivi: ancora selezionata quando viene scelta una versione. "error" — Deprecata, al più forte dei due livelli consultivi: ancora selezionata quando viene scelta una versione. "retracted" — Ritirata: esclusa quando viene scelta una versione. |
reason | string | no | Il motivo per cui la versione è deprecata. |
Non sono consentite proprietà aggiuntive.
HostUpdate
Che cosa ha fatto un aggiornamento dell’indice per un registry.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
host | string | sì | L’host del registry che è stato aggiornato. |
indexed | integer | sì | Quanti record sono stati scritti. |
deprecationsExamined | booleana | sì | Se la visita ha cercato marcatori di deprecazione. È separato dal conteggio perché «questo registry non ne ha pubblicato nessuno» e «questa esecuzione non aveva basi per giudicarne uno» sono fatti diversi. |
deprecationsRecorded | integer | sì | Quanti marcatori sono stati rispettati. |
skipped | SkippedRepo[] o null | sì | I repository che la visita ha saltato. |
deprecations | DeprecationNote[] o null | sì | I marcatori che la visita ha incontrato. |
readsRetried | integer | sì | Quante delle letture della visita il registry ha rifiutato o interrotto strada facendo e sono state richieste di nuovo, ogni lettura contata una sola volta indipendentemente da quanti tentativi abbia richiesto e dal fatto che poi sia riuscita o no; zero dove non ce n’è stata nessuna. Una visita le cui letture sono tutte riuscite alla fine non elenca alcun repository sotto skipped, quindi è questo conteggio a dire quanto sia andata vicina a tralasciarne uno. Minimo: 0. |
error | string | no | Che cosa non è riuscito per questo host, così una visita su più host riporta quali di essi non sono riusciti senza che il chiamante debba correlare nulla. |
unreachable | booleana | no | Se non è stato possibile raggiungere questo registry: il suo nome non si è risolto, una connessione verso di esso è stata rifiutata o non ha potuto essere aperta, oppure non è stato possibile stabilire una connessione sicura verso di esso. Viene letto dall’errore stesso anziché da error, viene impostato solo accanto a error, e solo dove l’errore mostra che il registry non è mai stato raggiunto; un registry che ha risposto, qualunque cosa abbia risposto, lo lascia assente. |
Non sono consentite proprietà aggiuntive.
PublishedVersion
Una versione che l’indice contiene per un riferimento: il digest del manifest in cui si risolveva il suo tag quando l’indice è stato costruito; dove la policy di fiducia con cui l’indice è stato costruito ha verificato la firma propria della versione, il firmatario risultante da quella verifica; e, dove qualcosa lo registra, quando la versione è stata pubblicata, con la fonte che lo afferma. Il firmatario è assente per una versione senza firma, per una nessuna delle cui firme è stata verificata, e dove quella policy non fissa né una chiave pubblica né un’identità attendibile oppure disattiva la verifica delle firme. Nessuno di questi casi è una base per nominare un firmatario, e la sua assenza non dice nulla di più. La data di pubblicazione è assente dove la pubblicazione non ne ha dichiarata alcuna e nessuna firma keyless verificata da quella policy ne registra una.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
version | string | sì | La versione, come la nomina il suo tag. |
manifestDigest | string | sì | Il digest del manifest in cui si risolveva il tag della versione quando l’indice è stato costruito, che indirizza la versione tramite i byte che nomina anziché tramite il suo tag. |
signer | VerifiedSignature | no | Una firma verificata rispetto alla policy di fiducia di un registry: come è stata verificata, il firmatario risultante dalla verifica e il digest del bundle della firma che è stato verificato. |
publishedAt | string | no | Quando la versione è stata pubblicata, come timestamp RFC 3339 in UTC al secondo. La sua provenienza è publishedAtSource, e i due sono presenti insieme o per niente. |
publishedAtSource | const “transparency-log” o const “publisher” | no | Da dove proviene publishedAt, così che un istante attestato da un transparency log non venga mai scambiato per uno dichiarato da chi pubblica. L’insieme è chiuso. Valori consentiti: "transparency-log" — L’istante in cui un transparency log ha registrato la firma keyless della versione, che la policy di fiducia con cui l’indice è stato costruito ha verificato insieme alla promessa firmata del log riguardo a quell’istante. Per una versione firmata al momento della pubblicazione, è la pubblicazione; per una firmata in seguito, è il momento in cui quella firma è stata apposta. "publisher" — L’istante che la pubblicazione ha dichiarato accanto a ciò che ha pubblicato, dall’orologio proprio della macchina che pubblica. Nulla lo attesta. Una pubblicazione ne dichiara uno dove la sua firma non porta alcun istante attestato: una firma con chiave, o nessuna firma. Dove ne sono allegati diversi, viene preso il più antico. |
Non sono consentite proprietà aggiuntive.
VerifiedSignature
Una firma verificata rispetto alla policy di fiducia di un registry: come è stata verificata, il firmatario risultante dalla verifica e il digest del bundle della firma che è stato verificato.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
bundleDigest | string | sì | Il digest del bundle della firma che è stato verificato, come sha256: seguito da 64 caratteri esadecimali minuscoli. |
identity | string | no | Il firmatario risultante dalla verifica della firma: per una firma keyless, l’identità per cui è stato emesso il certificato di firma, ossia il suo subject alternative name; per una firma con chiave, keyed:sha256: seguito dallo SHA-256 in esadecimale minuscolo del testo PEM della chiave pubblica fissata. |
issuer | string | no | L’emittente OIDC registrato nel certificato di firma, per una firma keyless. È assente per una firma con chiave. |
mode | const “keyless” o const “keyed” | sì | Come è stata verificata la firma. L’insieme è chiuso. Valori consentiti: "keyless" — Rispetto a un certificato di firma la cui identità e il cui emittente corrispondono a quelli che la policy ritiene attendibili, che si concatena alla radice di fiducia fissata dalla policy o, dove non ne fissa alcuna, alla radice public-good di Sigstore, e la cui firma è registrata da un transparency log. "keyed" — Rispetto alla chiave pubblica fissata dalla policy. |
Non sono consentite proprietà aggiuntive.
RegistrySearchRecord
Un record trovato da una ricerca, così come lo contiene l’indice locale, più quali delle sue versioni un marcatore pubblicato ha deprecato.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
uri | string | sì | Il riferimento da cui si risolve il record. |
name | string | sì | Il nome dell’entità. |
version | string | sì | La versione sotto cui è indicizzato il record. |
versions | string[] | no | Ogni versione che l’indice contiene per questo riferimento. |
kind | string | no | Il tipo di entità. |
description | string | no | A cosa serve l’entità. |
category | string | no | La categoria sotto cui è pubblicata l’entità. |
labels | mappa di string | no | Le etichette che l’entità dichiara. |
pluginType | string | no | Il socket a cui si associa un record di plugin. |
capabilities | string[] | no | Le capacità che un record di plugin dichiara. |
manifestDigest | string | no | Il digest del manifest pubblicato. |
listingDigest | string | no | Il digest dell’elenco da cui è stato letto il record. |
deprecations | object[] | no | I marcatori di deprecazione che l’indice porta per questo riferimento, ciascuno con la versione che copre e il marcatore verificato stesso. |
published | PublishedVersion[] | no | Ogni versione che l’indice contiene per questo riferimento, nello stesso ordine di versions, ciascuna con il digest del manifest in cui si risolveva il suo tag quando l’indice è stato costruito, dove la policy di fiducia con cui l’indice è stato costruito ha verificato la firma propria di quella versione il suo firmatario verificato, e dove qualcosa le registra la sua data di pubblicazione e la fonte di quella data. Una versione registrata senza firmatario non porta alcuna firma verificata da quella policy, e non se ne dice altro. Per registrare ciò vengono letti dal registry solo manifest, allegati di firma e allegati di data di pubblicazione; il contenuto di nessuna entità viene recuperato. |
retracted | string[] | no | Le versioni che un marcatore pubblicato ha deprecato. |
Non sono consentite proprietà aggiuntive.
RegistrySearchIndex
La freschezza di un host cercato.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
host | string | sì | L’host il cui indice è stato cercato. |
lastUpdated | string | no | Quando l’indice è stato aggiornato l’ultima volta. È assente anziché zero quando l’istantanea non porta alcun orario, così un chiamante può distinguere «non registrato» dall’epoch. |
Non sono consentite proprietà aggiuntive.
EffectiveConfigurationSetting
Un’impostazione risolta, e il documento da cui proviene.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
field | string | sì | L’impostazione. |
value | string | sì | Il valore che è stato risolto. |
source | string | sì | Da dove proviene il valore. |
Non sono consentite proprietà aggiuntive.
ImportedFile
Un file che un’importazione scrive: un documento in bozza, o il registro di ciò che l’importazione ha scritto.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
path | string | sì | Dove va collocato il file, come percorso relativo all’outputDir della risposta. |
content | string | sì | Il testo del file. |
Non sono consentite proprietà aggiuntive.
ImportDrift
Una parte che una sincronizzazione ha allineato alla sorgente, o che allineerebbe sotto dryRun.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
change | string | sì | Come la parte è andata in deriva: added, per una parte che la sorgente ha acquisito; removed, per una che ha eliminato; oppure changed, per una che ha cambiato. |
file | string | sì | Il file redatto in cui si trova la parte, come percorso relativo all’outputDir della risposta. |
key | string[] | sì | Le chiavi che portano alla parte dalla cima di un Aggregate o di una Release redatti, una voce per chiave, così una chiave che contiene un punto resta un’unica voce. Vuoto dove la parte è l’intero file. |
Non sono consentite proprietà aggiuntive.
ImportOwed
Un valore che le bozze lasciano ancora vuoto, che nessuna sorgente ha potuto fornire e che nessuna risposta ha fornito.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
file | string | sì | Il file redatto in cui si trova il valore, come percorso relativo all’outputDir della risposta. |
key | string[] | sì | Le chiavi che portano al valore dalla cima di quel documento, una voce per chiave, così una chiave che contiene un punto resta una sola voce. Una risposta inviata come answered nomina il valore tramite queste chiavi. |
question | string | sì | Che cosa è il valore: la descrizione del suo schema, oppure il commento che la bozza scrive sopra la sua chiave, oppure ciò che il suo schema dice che accetta. |
sensitive | booleana | sì | Se il valore è quello di un segreto, la cui risposta nomina da dove proviene il segreto e non contiene mai il segreto stesso. |
secretAdvice | string | no | Presente sul valore di un segreto: che cosa deve essere la sua risposta, nella frase mostrata a una persona che vi risponde in un terminale — oppure, dove la risposta inviata per esso come answered è stata rifiutata, perché è stata rifiutata. |
Non sono consentite proprietà aggiuntive.
ImportAnswered
Una risposta per un valore elencato in owed della risposta.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
file | string | sì | Il file redatto in cui si trova il valore, come lo nomina owed. |
key | string[] | sì | Le chiavi che portano al valore, come le nomina owed. |
answer | string | sì | La risposta. Una risposta vuota lascia il valore dovuto. |
Non sono consentite proprietà aggiuntive.
ImportDiagnostic
Una cosa che una conversione non ha potuto convertire. Queste sono l’output più utile della conversione, quindi vengono riportate per intero anziché ridotte a un verdetto.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
severity | string | sì | Quanto è grave. |
message | string | sì | Che cosa non è stato possibile convertire. |
code | string | no | Il nome citabile della condizione, dove ne ha uno. |
Non sono consentite proprietà aggiuntive.
ImportDecision
Come una conversione ha mappato un nodo della sorgente: i Components del catalogo che l’importatore ha valutato, quello che ha scelto, perché, e come sostituire la scelta.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
sourceNode | DecisionSourceNode | sì | Il nodo della sorgente a cui si riferisce una decisione di mappatura. |
candidates | ImportCandidate[] | no | I Components del catalogo che l’importatore ha valutato per il nodo, ciascuno con il suo punteggio. Assente dove non ne ha valutato nessuno. |
chosen | DecisionChoice | no | Ciò che l’importatore ha scelto per un nodo della sorgente. Assente da una decisione in cui non ha fatto alcuna scelta. |
rationale | string | no | Perché l’importatore ha fatto la scelta, con parole sue. Assente dove non ne ha scritte. |
swapHint | string | no | Come sostituire la scelta con un’alternativa, con le parole dell’importatore. Assente dove non ne ha scritte. |
Non sono consentite proprietà aggiuntive.
DecisionSourceNode
Il nodo della sorgente a cui si riferisce una decisione di mappatura.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
id | string | sì | L’identificatore del nodo nella sorgente. |
type | string | sì | Il tipo del nodo, come lo nomina la sorgente. |
paramsSummary | string | sì | Un riepilogo dei parametri del nodo, da mostrare accanto alla decisione. |
Non sono consentite proprietà aggiuntive.
ImportCandidate
Un Component del catalogo che l’importatore ha valutato per un nodo della sorgente.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
componentName | string | sì | Il nome del Component. |
score | number | sì | Quanto bene il Component corrisponde al nodo, secondo il punteggio dell’importatore. |
tier | string | sì | Il livello di corrispondenza in cui ricade il punteggio. |
signals | CandidateSignals | sì | Il contributo di ciascuno dei segnali dell’importatore al punteggio di un candidato. |
Non sono consentite proprietà aggiuntive.
CandidateSignals
Il contributo di ciascuno dei segnali dell’importatore al punteggio di un candidato.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
table | number | sì | Il contributo del segnale della tabella di mappatura. |
category | number | sì | Il contributo del segnale della categoria. |
domainLabels | number | sì | Il contributo del segnale delle etichette di dominio. |
shape | number | sì | Il contributo del segnale della forma. |
name | number | sì | Il contributo del segnale del nome. |
Non sono consentite proprietà aggiuntive.
DecisionChoice
Ciò che l’importatore ha scelto per un nodo della sorgente. Assente da una decisione in cui non ha fatto alcuna scelta.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
target | string | sì | Il nome del Component scelto: un Component esistente del catalogo, o quello redatto per il nodo. |
mode | string | sì | Come è scritta la scelta: come riferimento a un Component esistente, o come uno redatto ex novo. |
tier | string | sì | Il livello di corrispondenza della scelta. |
Non sono consentite proprietà aggiuntive.
LintFileFindings
Ciò che un controllo delle convenzioni ha trovato in un documento.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
file | string | sì | Il documento. |
diagnostics | Diagnostic[] o null | sì | I rilievi che contiene. |
Non sono consentite proprietà aggiuntive.
PluginRetractionExclusion
Una versione che era disponibile e non è stata scelta.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
version | string | sì | La versione che è stata saltata. |
reason | string | no | Perché è stato saltato. |
Non sono consentite proprietà aggiuntive.
PluginRetractionProvenance
Da dove proviene la conoscenza di ciò che è deprecato.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
source | string | sì | Che cosa è stato consultato. |
lastUpdated | string | no | Quando è stato aggiornato l’ultima volta. |
Non sono consentite proprietà aggiuntive.
PluginRetraction
Come un marcatore di deprecazione ha determinato quale versione del plugin è stata fissata.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
reference | string | sì | Il riferimento a cui appartengono le versioni. |
selected | string | no | La versione che è stata fissata. |
excluded | PluginRetractionExclusion[] | no | Le versioni che erano disponibili e sono state saltate. |
unscreened | string | no | Che cosa non è stato possibile vagliare rispetto a un marcatore, e perché. |
provenance | PluginRetractionProvenance | no | Da dove proviene la conoscenza di ciò che è deprecato. |
Non sono consentite proprietà aggiuntive.
PluginGeneratedDocument
Un documento di catalogo prodotto da una generazione.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
path | string | sì | Dove va collocato il documento, come percorso relativo alla radice del workspace. |
content | string | sì | Il testo del documento. |
Non sono consentite proprietà aggiuntive.
PluginCommandFlag
Un flag che un plugin dichiara su un comando che fornisce.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
name | string | sì | Il nome lungo del flag. |
shorthand | string | no | L’alias di un solo carattere del flag, dove ne ha uno. |
description | string | no | Il testo di aiuto di una riga del flag. |
type | string | no | Il tipo di valore del flag. |
default | string | no | Il valore usato quando il flag non viene passato. |
Non sono consentite proprietà aggiuntive.
PluginCLICommand
Un verbo di comando di primo livello che un plugin fornisce.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
name | string | sì | Il verbo del comando. |
description | string | no | Il testo di aiuto di una riga del comando. |
flags | PluginCommandFlag[] | no | I flag del comando, nell’ordine dichiarato. |
Non sono consentite proprietà aggiuntive.
ConfigCapturedAttachment
Un’associazione che un congelamento ha scritto nella configurazione propria di questo workspace.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
uri | string | no | Il riferimento da cui si risolve l’associazione. |
capability | string | no | La capacità a cui è destinata l’associazione. |
function | string | no | L’export a cui viene indirizzata l’associazione. |
role | string | no | Il ruolo in cui viene eseguita l’associazione, che stabilisce ciò che può emettere. |
Non sono consentite proprietà aggiuntive.
ConfigCapturedSocket
Un socket che un congelamento ha scritto, con le associazioni che vi ha congelato sopra.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
socket | string | sì | Il socket. |
field | string | sì | Il campo di configurazione sotto cui è scritto il socket. |
attachments | ConfigCapturedAttachment[] o null | sì | Le associazioni che vi sono state congelate sopra. |
Non sono consentite proprietà aggiuntive.
ExplainErrorEntry
Un passo pubblicato che insegna la correzione di authoring per una condizione.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
heading | string | sì | Il titolo del passo. |
body | string | sì | Il passo. |
Non sono consentite proprietà aggiuntive.
SignedArtifact
Un artefatto pubblicato coperto da una firma.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
reference | string | sì | Il riferimento che è stato firmato. |
digest | string | sì | Il digest di ciò che è stato firmato. |
Non sono consentite proprietà aggiuntive.
DeprecationMarked
Una versione pubblicata che una deprecazione ha contrassegnato.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
reference | string | sì | Il riferimento che è stato contrassegnato. |
severity | const “warning” o const “error” o const “retracted” | sì | Quanto è forte il marcatore. Valori consentiti: "warning" — Deprecata, al più lieve dei due livelli consultivi: ancora selezionata quando viene scelta una versione. "error" — Deprecata, al più forte dei due livelli consultivi: ancora selezionata quando viene scelta una versione. "retracted" — Ritirata: esclusa quando viene scelta una versione. |
issuedOn | string | sì | Quando è stato emesso il marcatore. |
digest | string | sì | Il digest del marcatore che è stato pubblicato. |
Non sono consentite proprietà aggiuntive.
InitializeResult
Ciò su cui la sessione si è accordata per questo client, e da quale livello di configurazione l’ha risolto.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
capabilities | ServerCapabilities | sì | Ciò che il daemon farà in questa sessione, concordato rispetto a ciò che il client ha detto di saper gestire. |
workspaceRoot | string | sì | Il workspace su cui si è aperta la sessione. |
configSource | string | sì | Da quale livello di configurazione la sessione ha risolto le sue impostazioni. |
workspaceMarker | string | no | Il file che ha identificato la radice del workspace, dove ce n’è stato uno. |
version | string | sì | La versione del binario che risponde a questa sessione: lo stesso valore che aggrega version riporta per quel binario. Descrive il processo in esecuzione, quindi una volta che il file da cui il daemon è stato avviato è stato sostituito, questo nomina ancora la versione in esecuzione, mentre interrogare il file nomina la versione che l’ha sostituito. |
Non sono consentite proprietà aggiuntive.
ValidateResult
Che cosa ha trovato il controllo, e quanto è stato controllato.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
diagnostics | Diagnostic[] o null | sì | I rilievi. È null anziché una lista vuota quando il controllo non ha trovato nulla. |
checked | string | no | Quanto è stato controllato — un documento, o ciò che il workspace contiene. |
Non sono consentite proprietà aggiuntive.
InvalidateResult
Se il daemon conservava qualcosa sul documento da scartare.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
invalidated | booleana | sì | Se è stato scartato qualcosa. |
Non sono consentite proprietà aggiuntive.
DiagnosticsResult
I rilievi che il daemon conserva già per il documento.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
diagnostics | Diagnostic[] o null | sì | I rilievi. È null anziché una lista vuota quando non ce ne sono. |
Non sono consentite proprietà aggiuntive.
IrGraphResult
Il grafo risolto in cui si compila una Release.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
graph | any | sì | Il documento del grafo. I valori che un autore ha dichiarato sensibili ne vengono esclusi a meno che la richiesta non li abbia chiesti con unredacted; tutto il resto viene riportato così come l’ha emesso il compilatore. La sua forma è il contratto pubblicato del grafo e non viene ripetuta qui. |
Non sono consentite proprietà aggiuntive.
BuildResult
Che cosa ha scritto una build.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
outputDirectory | string | sì | La directory in cui sono stati scritti gli artefatti. |
files | string[] o null | sì | Gli artefatti che sono stati scritti, come percorsi relativi alla directory di output. |
notices | BuildNotice[] | no | Qualsiasi cosa la build voglia far sapere al chiamante che non sia né un rilievo né un errore. |
dependencyResolution | DependencyResolutionReport | no | Ciò che una risoluzione delle dipendenze ha fissato e acquisito. |
Non sono consentite proprietà aggiuntive.
BuildPreviewResult
Che cosa avrebbe scritto una build. Non è stato scritto nulla, quindi non c’è alcuna directory di output da nominare.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
files | string[] o null | sì | Gli artefatti che la scrittura avrebbe prodotto. |
notices | BuildNotice[] | no | Qualsiasi cosa la compilazione voglia far sapere al chiamante che non sia né un rilievo né un errore. |
Non sono consentite proprietà aggiuntive.
EntityDefinitionResult
In che cosa si risolve un nome di entità, e il documento che la definisce. Una risposta letta da un riferimento di registry porta published, e una risposta che il catalogo ha risolto per nome non lo porta mai.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
kind | string | sì | Il tipo di entità. |
name | string | sì | Il nome dell’entità. |
version | string | sì | La versione che è stata risolta. |
description | string | no | A cosa serve l’entità secondo il documento. |
publishScope | string | no | Quanto ampiamente è pubblicata l’entità. |
file | string | sì | Il documento che la definisce. |
authoredLength | integer | sì | Quanti byte contiene il documento scritto dall’autore, così un client può distinguere un documento scritto dall’autore da una sua rappresentazione risolta. |
definition | string | sì | Il testo della definizione. |
published | PublishedArtifact | no | Che cosa ha letto un riferimento di registry: la coordinata, come conteneva l’entità, e il manifest attraverso cui è stata letta. Ogni campo è presente ovunque lo sia questo. |
Non sono consentite proprietà aggiuntive.
PublishedArtifact
Che cosa ha letto un riferimento di registry: la coordinata, come conteneva l’entità, e il manifest attraverso cui è stata letta. Ogni campo è presente ovunque lo sia questo.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
reference | string | sì | Il riferimento di registry che è stato letto. |
archive | booleana | sì | Se i byte della coordinata erano un archivio da cui è stato estratto il documento dell’entità. False dove la coordinata conteneva il documento dell’entità stesso. |
mediaType | string | sì | Il tipo di artefatto che il manifest dichiara. |
manifestDigest | string | sì | Il digest del manifest attraverso cui è stata letta l’entità — il valore da nominare dopo @ per leggere di nuovo esattamente gli stessi byte. |
Non sono consentite proprietà aggiuntive.
ReleaseClosureResult
Tutto ciò da cui dipende una Release, come lo ha raggiunto la risoluzione. Riporta la chiusura anziché il grafo che ne deriva: un documento diverso sulla stessa Release.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
release | string | sì | La Release che è stata ispezionata. |
aggregate | string | sì | L’Aggregate che distribuisce. |
manifest | string | sì | Il Manifest attraverso cui si risolve. |
environment | string | sì | L’ambiente che nomina. |
entities | ClosureEntity[] o null | sì | Le entità che la chiusura raggiunge. |
libraries | ClosureEntity[] o null | sì | Le librerie che la chiusura raggiunge. |
plugins | ClosureEntity[] o null | sì | I plugin che la chiusura raggiunge. |
mappingDiagnostics | string[] o null | sì | Che cosa ha avuto da dire la risoluzione delle mappature del Manifest. |
deprecations | string[] o null | sì | I marcatori di deprecazione che la chiusura ha incontrato. |
Non sono consentite proprietà aggiuntive.
ResolveDependenciesResult
Ciò che una risoluzione delle dipendenze ha fissato e acquisito, più qualsiasi cosa voglia far sapere al chiamante. I campi propri del report sono portati direttamente su questa risposta anziché annidati sotto un suo campo.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
lockfile | string | sì | Il file di lock che la risoluzione ha scritto, o quello con cui una verifica ha confrontato. |
verified | booleana | no | Se la richiesta era una verifica, che ha confrontato il file di lock registrato e non ha scritto alcun file di lock, registro di fiducia dei plugin né entity.lock. |
entities | ClosureEntity[] o null | sì | Le entità che la risoluzione ha fissato, o che una verifica ha confrontato. |
libraries | ClosureEntity[] o null | sì | Le librerie che la risoluzione ha fissato, o che una verifica ha confrontato. |
plugins | ClosureEntity[] o null | sì | I plugin che la risoluzione ha fissato, o che una verifica ha confrontato. |
sourceArtifacts | integer | sì | Quanti artefatti sorgente sono stati acquisiti. |
trustedPlugins | integer | sì | Quanti dei plugin fissati portavano una firma verificata. |
toolchain | ToolchainReport | no | Il compilatore che ha eseguito la risoluzione, e i plugin che porta con sé. |
externalInputs | integer | sì | Quanti input esterni consumati dal rendering sono stati acquisiti. |
incompleteExternalInputs | string | no | Quali input esterni non è stato possibile acquisire, dove alcuni non lo sono stati. |
notices | string[] | no | Qualsiasi cosa la risoluzione voglia far sapere al chiamante. |
Non sono consentite proprietà aggiuntive.
PinResult
Che cosa ha fatto il passo di fissaggio al lock accanto a un’entità, o che cosa farebbe in un’esecuzione di prova. È la risposta a aggrega/pin, e una pubblicazione che ha eseguito il passo la porta come suo pin.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
entity | string | sì | Il documento di entità che il passo ha letto, come percorso relativo alla radice del workspace. |
kind | string | sì | Il tipo dell’entità, come lo dichiara il suo documento. |
name | string | sì | Il nome dell’entità, come lo dichiara il suo documento. |
pinnable | booleana | sì | Se un’entità di questo tipo legge qualcosa per cui un lock registra un fissaggio, come fanno una Recipe e una FeatureRecipe. Dove è false, nulla accanto all’entità è stato toccato, changed è false, e lock, removed, pins e content sono assenti. |
lock | string | no | Il lock che il passo ha scritto, o scriverebbe, come percorso relativo alla radice del workspace. |
changed | booleana | sì | Se il lock è cambiato, o cambierebbe in un’esecuzione di prova. False dove il lock registrava già ogni fissaggio di cui l’entità ha bisogno ed è stato lasciato identico byte per byte. |
removed | booleana | no | Se il cambiamento è una rimozione: l’entità non legge nulla per cui un lock registra un fissaggio, quindi accanto a essa non resta alcun lock. |
dryRun | booleana | no | Se questo riporta ciò che il passo farebbe anziché ciò che ha fatto. |
pins | PinClassCount[] | no | Quanti fissaggi di ciascuna classe il lock contiene dopo il passo, o conterrebbe dopo un’esecuzione di prova. Ogni classe che il lock può contenere è elencata, compresa una classe senza alcun fissaggio. |
content | string | no | Il lock che un’esecuzione di prova scriverebbe. Assente dove il lock verrebbe lasciato com’è o rimosso, e in ogni risposta che non sia un’esecuzione di prova. |
Non sono consentite proprietà aggiuntive.
PinClassCount
Quanti fissaggi di una classe contiene un lock.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
class | string | sì | La classe del fissaggio, con le parole che usa un rifiuto che ne nomina uno mancante — remote source o imported file, per esempio. |
pins | integer | sì | Quanti fissaggi di quella classe contiene il lock. |
Non sono consentite proprietà aggiuntive.
CacheStatusResult
Che cosa contengono le cache che servono questo workspace.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
classes | CacheClass[] o null | sì | Ciascuna cache e ciò che contiene. |
provenance | CacheProvenance[] o null | sì | Sotto quali identità sono stati acquisiti gli artefatti in cache. |
totalCount | integer | sì | Quante voci contengono le cache in totale. |
totalSize | integer | sì | Quanti byte occupano in totale. |
totalSizeText | string | sì | Lo stesso totale scritto nel modo in cui lo legge una persona. |
scope | CacheScope | sì | Fin dove arriva una risposta sulla cache. Due delle classi di cache sono condivise da ogni progetto sulla macchina, quindi ogni risposta sulla cache nomina quelle che ha toccato — altrimenti una sessione aperta su un workspace verrebbe letta come se riferisse solo su quel workspace. |
Non sono consentite proprietà aggiuntive.
CachePruneResult
Che cosa ha rimosso un recupero di spazio, che cosa ha mantenuto e che cosa non ha potuto recuperare.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
removed | CacheRemoval[] o null | sì | Che cosa è stato rimosso. |
heldOpen | CacheRemoval[] o null | sì | Ciò che la potatura avrebbe rimosso ma ha lasciato al suo posto perché un altro processo lo teneva aperto. Solo Windows rifiuta di rimuovere un file aperto, quindi ovunque altrove questo è vuoto. Queste voci non sono conteggiate né come rimosse né come mantenute, nessuno dei loro byte conta come recuperato, e una potatura successiva le recupera; una voce che è una directory può aver già perso i file al suo interno che non erano aperti. |
retainedCount | integer | sì | Quante voci sono state mantenute. |
reclaimedBytes | integer | sì | Quanti byte sono stati recuperati. |
reclaimedBytesText | string | sì | La stessa cifra scritta nel modo in cui la legge una persona. |
unattributedCount | integer | sì | Quante voci non rivendica alcun detentore. |
unattributedSize | integer | sì | Quanti byte occupano quelle voci. |
unattributedSizeText | string | sì | La stessa cifra scritta nel modo in cui la legge una persona. |
notPruneEligible | CacheShortfall[] o null | sì | Che cosa è stato lasciato indietro, e che cosa lo recupererebbe. |
scope | CacheScope | sì | Fin dove arriva una risposta sulla cache. Due delle classi di cache sono condivise da ogni progetto sulla macchina, quindi ogni risposta sulla cache nomina quelle che ha toccato — altrimenti una sessione aperta su un workspace verrebbe letta come se riferisse solo su quel workspace. |
Non sono consentite proprietà aggiuntive.
CacheEvictResult
Che cosa ha rimosso il recupero di spazio fino a una dimensione, e che cosa resta.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
withinCapBefore | booleana | sì | Se ciò che era contenuto stava già sotto la dimensione, così che non è stato necessario rimuovere nulla. |
removed | CacheRemoval[] o null | sì | Che cosa è stato rimosso. |
heldOpen | CacheRemoval[] o null | sì | Ciò che il recupero di spazio avrebbe rimosso ma ha lasciato al suo posto perché un altro processo lo teneva aperto; è passato invece alla voce successiva più vecchia. Solo Windows rifiuta di rimuovere un file aperto, quindi ovunque altrove questo è vuoto. Queste voci contano ancora nei byte che restano, e un recupero di spazio successivo può rimuoverle. |
totalBefore | integer | sì | Quanti byte erano contenuti prima. |
totalBeforeText | string | sì | La stessa cifra scritta nel modo in cui la legge una persona. |
reclaimedBytes | integer | sì | Quanti byte sono stati recuperati. |
reclaimedBytesText | string | sì | La stessa cifra scritta nel modo in cui la legge una persona. |
remainingBytes | integer | sì | Quanti byte restano. |
remainingBytesText | string | sì | La stessa cifra scritta nel modo in cui la legge una persona. |
capBytes | integer | sì | La dimensione fino a cui è stato recuperato spazio, in byte. |
capBytesText | string | sì | La stessa dimensione scritta nel modo in cui la legge una persona. |
scope | CacheScope | sì | Fin dove arriva una risposta sulla cache. Due delle classi di cache sono condivise da ogni progetto sulla macchina, quindi ogni risposta sulla cache nomina quelle che ha toccato — altrimenti una sessione aperta su un workspace verrebbe letta come se riferisse solo su quel workspace. |
Non sono consentite proprietà aggiuntive.
CacheClearResult
Che cosa ha recuperato lo svuotamento delle cache.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
cleared | CacheCleared[] o null | sì | Ciascuna cache che è stata svuotata. |
reclaimedBytes | integer | sì | Quanti byte sono stati recuperati. |
reclaimedBytesText | string | sì | La stessa cifra scritta nel modo in cui la legge una persona. |
scope | CacheScope | sì | Fin dove arriva una risposta sulla cache. Due delle classi di cache sono condivise da ogni progetto sulla macchina, quindi ogni risposta sulla cache nomina quelle che ha toccato — altrimenti una sessione aperta su un workspace verrebbe letta come se riferisse solo su quel workspace. |
Non sono consentite proprietà aggiuntive.
RegistryListResult
I registry tramite cui questo workspace risolve.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
registries | Registry[] o null | sì | Ciascun registry configurato. |
credentialStateIsMachineWide | booleana | sì | Se la presenza di credenziali riportata per ciascun registry è un fatto dell’intera macchina anziché del workspace. Viene riportato così che una risposta limitata alla sessione non venga letta come se negasse la portata più ampia. |
Non sono consentite proprietà aggiuntive.
SearchResult
Che cosa hanno offerto per la ricerca gli indici locali dei registry.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
records | RegistrySearchRecord[] o null | sì | I record che corrispondevano. |
indexes | RegistrySearchIndex[] o null | sì | Ciascun host cercato e quando il suo indice è stato aggiornato l’ultima volta. |
missingIndexHosts | string[] o null | sì | Gli host configurati senza un indice locale in cui cercare, così una risposta breve viene spiegata anziché lasciata da dedurre. |
stale | booleana | sì | Se un indice cercato è abbastanza vecchio da valere la pena di aggiornarlo. |
registriesConfigured | booleana | sì | Se è configurato almeno un registry, il che distingue «nulla corrispondeva» da «nulla è stato cercato». |
Non sono consentite proprietà aggiuntive.
RegistryAddResult
Che cosa ha scritto la registrazione di un registry, dove, e che cosa ha letto dal registry stesso.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
host | string | sì | L’host sotto cui è indicizzata la voce, che non è sempre la grafia usata dalla richiesta. |
scope | ConfigWriteScope | sì | Quale documento di configurazione è stato scritto e fin dove arriva. Una richiesta nomina un unico workspace, quindi una risposta che non dicesse nulla verrebbe letta come relativa a quel workspace — e per una scrittura sull’intera macchina quella lettura è sbagliata. |
trust | TrustFetchOutcome | sì | Che cosa ha prodotto la lettura della policy di fiducia annunciata da un registry. Gli esiti sono tenuti distinti perché significano cose diverse: la policy annunciata è stata adottata, il registry non ha annunciato nulla — il che non è un errore — al suo posto è stata fissata la baseline integrata, oppure non è stata tentata alcuna lettura. Dove non è stato annunciato nulla, accanto a ciò si indica se il registry fosse raggiungibile. |
Non sono consentite proprietà aggiuntive.
RegistryRemoveResult
Che cosa ha scritto la rimozione di un registry, e dove.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
host | string | sì | L’host la cui voce è stata rimossa. |
scope | ConfigWriteScope | sì | Quale documento di configurazione è stato scritto e fin dove arriva. Una richiesta nomina un unico workspace, quindi una risposta che non dicesse nulla verrebbe letta come relativa a quel workspace — e per una scrittura sull’intera macchina quella lettura è sbagliata. |
Non sono consentite proprietà aggiuntive.
RegistryUpdateResult
Che cosa ha fatto l’aggiornamento degli indici locali, per host.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
hosts | HostUpdate[] o null | sì | Che cosa ha fatto l’aggiornamento per ciascun host. |
failed | string[] o null | sì | Gli host per cui l’aggiornamento non ha potuto completarsi. |
indexRoot | string | sì | La directory sotto cui sono stati scritti gli indici. |
registriesConfigured | booleana | sì | Se è configurato almeno un registry. |
reachedRegistries | booleana | sì | Sempre true in questa risposta: l’aggiornamento degli indici si rivolge ai registry stessi, mentre elencarli e cercare rispondono dalla configurazione e da un indice locale. Se un dato registry sia stato effettivamente raggiunto è indicato nella sua voce in hosts, da unreachable. |
Non sono consentite proprietà aggiuntive.
LogoutResult
Quale credenziale memorizzata è stata rimossa, e fin dove arriva l’archivio.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
registry | string | sì | Il registry la cui credenziale è stata rimossa. |
scope | CredentialStoreScope | sì | Fin dove arriva una modifica a una credenziale. L’archivio è condiviso da ogni progetto sulla macchina e da ogni altro strumento che si rivolge agli stessi registry, quindi la risposta lo riporta anziché lasciare che se ne deduca una lettura limitata alla sessione. |
Non sono consentite proprietà aggiuntive.
PublishEntityResult
Ciò che la pubblicazione di un’entità ha depositato, e dove. Una pubblicazione che ha eseguito prima il passo di fissaggio porta anche ciò che quel passo ha fatto, come pin, che è assente dove il passo non è stato eseguito.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
reference | string | sì | Il riferimento sotto cui è stata pubblicata l’entità. |
tag | string | sì | Il tag sotto cui è stata pubblicata. |
kind | string | sì | Il tipo di entità che è stato pubblicato. |
mediaType | string | sì | Il tipo di media registrato per i byte pubblicati. |
size | integer | sì | Quanti byte sono stati pubblicati. |
sizeText | string | sì | La stessa dimensione scritta nel modo in cui la legge una persona. |
pluginSize | integer | no | Quanti byte occupa il modulo del plugin pubblicato insieme a un’entità Plugin. |
pluginSizeText | string | no | La stessa dimensione scritta nel modo in cui la legge una persona. |
digest | string | sì | Il digest di ciò che è stato pubblicato. In un’esecuzione di prova, il digest che una pubblicazione dello stesso contenuto depositerebbe, calcolato dal solo contenuto: quello che stampa aggrega push --dry-run. |
signed | booleana | sì | Se questa pubblicazione ha allegato una firma: quella che ha creato prima di pubblicare oppure, su una versione già pubblicata, una che alla versione mancava. |
alreadyPublished | booleana | sì | Se gli stessi byte erano già presenti, così che non è stato caricato alcun contenuto. Accanto a essi è stato allegato solo ciò che a quella pubblicazione ancora mancava: la sua data di pubblicazione e, dove questa pubblicazione firma, la sua firma; signed dice se è stata allegata una firma. |
dryRun | booleana | sì | Se questo riporta ciò che la pubblicazione avrebbe depositato anziché ciò che ha depositato. |
reach | PublicationReach | sì | Fin dove è arrivata una pubblicazione. Queste risposte arrivano del tutto oltre questa macchina — ciò che allegano è ciò che risolve ogni consumatore di quel registry — quindi ciascuna nomina ogni registry a cui si è rivolta e se la chiamata vi ha allegato qualcosa. |
pin | PinResult | no | Che cosa ha fatto il passo di fissaggio al lock accanto a un’entità, o che cosa farebbe in un’esecuzione di prova. È la risposta a aggrega/pin, e una pubblicazione che ha eseguito il passo la porta come suo pin. |
wholeDirectorySource | string | no | Il sorgente locale dell’entità così come è stato scritto, presente quando è scritto come template. Un sorgente del genere nomina la propria directory solo una volta che una Release riempie il template, quindi la pubblicazione porta ogni file nella directory dell’entità anziché solo i file che l’entità nomina. Assente dove porta solo quei file. |
windowsUnusableEntries | string[] | no | Le voci dell’archivio pubblicato il cui percorso contiene una parte che Windows non può contenere così come è scritta — un nome che Windows riserva a un dispositivo, come CON, AUX o NUL, in qualsiasi combinazione di maiuscole e minuscole e qualunque estensione segua, oppure una parte che termina con un punto o uno spazio — prima il nome di file del documento dell’entità stesso, poi i file che porta. Un workspace su Windows si rifiuta di estrarle, quindi non può usare la versione; la pubblicazione prosegue o si arresta esattamente come farebbe senza di esse. Assente dove non ce n’è nessuna, il che include un’entità pubblicata come solo documento. |
Non sono consentite proprietà aggiuntive.
PublishArtifactResult
Ciò che la pubblicazione di un file ha depositato, e dove.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
reference | string | sì | Il riferimento sotto cui è stato pubblicato il file. |
tag | string | sì | Il tag sotto cui è stata pubblicata. |
mediaType | string | sì | Il tipo di media registrato per i byte pubblicati. |
size | integer | sì | Quanti byte sono stati pubblicati. |
sizeText | string | sì | La stessa dimensione scritta nel modo in cui la legge una persona. |
digest | string | sì | Il digest di ciò che è stato pubblicato. |
alreadyPublished | booleana | sì | Se gli stessi byte erano già presenti, così che non è stato caricato alcun contenuto. Una data di pubblicazione è stata allegata accanto a essi solo dove all’artefatto ne mancava una. |
dryRun | booleana | sì | Se questo riporta ciò che la pubblicazione avrebbe depositato anziché ciò che ha depositato. |
reach | PublicationReach | sì | Fin dove è arrivata una pubblicazione. Queste risposte arrivano del tutto oltre questa macchina — ciò che allegano è ciò che risolve ogni consumatore di quel registry — quindi ciascuna nomina ogni registry a cui si è rivolta e se la chiamata vi ha allegato qualcosa. |
Non sono consentite proprietà aggiuntive.
SignArtifactsResult
Che cosa è stato firmato, e dove sono state depositate le firme.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
signed | SignedArtifact[] o null | sì | Ogni riferimento che è stato firmato. |
reach | PublicationReach | sì | Fin dove è arrivata una pubblicazione. Queste risposte arrivano del tutto oltre questa macchina — ciò che allegano è ciò che risolve ogni consumatore di quel registry — quindi ciascuna nomina ogni registry a cui si è rivolta e se la chiamata vi ha allegato qualcosa. |
Non sono consentite proprietà aggiuntive.
DeprecateArtifactResult
Che cosa è stato contrassegnato come deprecato, e dove sono stati depositati i marcatori.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
marked | DeprecationMarked[] o null | sì | Ogni versione che è stata contrassegnata. |
reach | PublicationReach | sì | Fin dove è arrivata una pubblicazione. Queste risposte arrivano del tutto oltre questa macchina — ciò che allegano è ciò che risolve ogni consumatore di quel registry — quindi ciascuna nomina ogni registry a cui si è rivolta e se la chiamata vi ha allegato qualcosa. |
Non sono consentite proprietà aggiuntive.
ResolveResult
Dove è definito l’elemento sotto il cursore.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
location | null o Location | sì | Dove è definito. È null dove nulla sotto il cursore si risolve in una definizione. |
Non sono consentite proprietà aggiuntive.
FindReferencesResult
Dove si fa riferimento all’elemento sotto il cursore.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
locations | Location[] o null | sì | Ogni punto in cui vi si fa riferimento. |
Non sono consentite proprietà aggiuntive.
FindImplementationsResult
Quali documenti implementano l’elemento sotto il cursore.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
locations | Location[] o null | sì | Ogni punto in cui è implementato. |
Non sono consentite proprietà aggiuntive.
HoverResult
Che cosa mostrare sull’elemento sotto il cursore.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
contents | null o MarkupContent | sì | Che cosa mostrare. È null dove non c’è nulla da dire su ciò che si trova sotto il cursore. |
Non sono consentite proprietà aggiuntive.
CompletionResult
Che cosa può essere scritto nella posizione del cursore.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
items | CompletionItem[] o null | sì | Ogni elemento che può essere scritto. |
Non sono consentite proprietà aggiuntive.
CatalogIndexResult
Ogni entità che l’indice del workspace contiene, e i collegamenti che portano fuori dal workspace, verso directory e verso file, che non sono stati letti per esso.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
entities | CatalogEntity[] o null | sì | Ogni entità. |
unreadLinkedDirs | string[] | sì | Ogni collegamento sotto la radice del workspace che porta a una directory al di fuori di essa, nominato relativamente alla radice nel punto in cui si trova il collegamento stesso, nell’ordine in cui il workspace viene cercato. Nessuna directory al di fuori della radice viene cercata, quindi nessun documento dietro uno di questi collegamenti figura tra entities come proprio del workspace, e un client che elenca le entità può dire perché. Non nominati: un collegamento a una directory all’interno della radice, che viene cercata, o esclusa, dove si trova effettivamente; un collegamento ovunque una directory verrebbe esclusa, che sia per dove si trova, per il suo nome o per un .gitignore; un collegamento che non può essere risolto, perché non porta da nessuna parte o porta in un ciclo; e, in una risposta data nei termini di una Release, un collegamento sotto una directory di catalogo letta solo da altre Releases. Vuoto quando il workspace non ne contiene nessuno. |
unreadLinkedFiles | string[] | sì | Ogni collegamento sotto la radice del workspace che ha un nome da file YAML, il cui nome termina con .yaml o .yml, e porta a un file al di fuori della radice, nominato relativamente alla radice nel punto in cui si trova il collegamento stesso, nell’ordine in cui il workspace viene cercato. Un file del genere non viene letto per l’indice, qualunque cosa dichiari, quindi l’entità che dichiara non figura tra entities come propria del workspace, e un client che elenca le entità può dire perché; le directory di catalogo configurate sono il modo in cui vengono lette le entità al di fuori del workspace. Non nominati: un collegamento a un file che la configurazione del workspace nomina come Release, come build.authoring_release o come chiave di workspace.releases, e che ne dichiara una, il quale viene letto ed elencato in entities nel punto proprio del collegamento; un collegamento a un file all’interno della radice, che viene letto nel punto proprio del collegamento; un collegamento che un .gitignore esclude, o uno all’interno di una directory che la ricerca esclude; un collegamento che non porta ad alcun file, che porti a una directory, che unreadLinkedDirs nomina dove porta fuori dalla radice, o da nessuna parte, o in un ciclo; e, in una risposta data nei termini di una Release, un collegamento sotto una directory di catalogo letta solo da altre Releases. Un file di configurazione del workspace che è un collegamento che porta fuori dal workspace, il suo .aggrega-config.yaml o l’overlay gestito dalla CI accanto a esso, viene nominato che la ricerca lo abbia incontrato o no, dopo i collegamenti nominati dalla ricerca: la configurazione del workspace allora non viene letta affatto, questa risposta è l’indice proprio del workspace letto senza nulla di configurato, quindi nessuna directory di catalogo viene letta per esso, e ogni richiesta decisa dalla configurazione, compreso un indice nei termini di una Release, viene rifiutata per quel workspace con la condizione del blocco di lettura. |
Non sono consentite proprietà aggiuntive.
AttachCandidatesResult
Quali Features possono essere associate all’entità, e le etichette rispetto a cui sono state giudicate; e, per una connessione nominata dalla richiesta, gli slot che il suo socket dichiara con le Features che possono riempire ciascuno.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
node | string | sì | L’entità per cui sono stati giudicati i candidati. |
nodeLabels | mappa di string o null | sì | Le etichette rispetto a cui è stato espresso il giudizio. |
labelSource | string | sì | Quale insieme di etichette è stato usato, il che non è un dettaglio estetico: le etichette dichiarate di un documento sono ciò che può vedere una lettura del sorgente, mentre quelle di un nodo del grafo sono l’insieme finalizzato rispetto a cui la build stessa giudica. Una risposta calcolata sul secondo è un’affermazione su ciò che farà la build. |
candidates | SourcedEntityRef[] o null | sì | Ogni Feature che può essere associata. |
slots | SlotCandidacy[] | no | Presente solo quando la richiesta ha nominato una connessione: ogni slot che il socket della connessione dichiara, nell’ordine in cui il Component li dichiara, con le Features che possono riempirlo. Vuoto quando nessuno slot può essere riempito sulla connessione, e noSlotReason dice allora perché — cosa che un client legge anziché prendere un elenco vuoto per slot a cui nessuna Feature corrispondeva. |
noSlotReason | const “feature-created-connection” o const “ad-hoc-socket” o const “no-slot-declared” | no | Presente solo quando la richiesta ha nominato una connessione e nessuno slot può esservi riempito: perché nulla può associarsi lì. Assente ovunque il socket dichiari uno slot. L’insieme è chiuso. Valori consentiti: "feature-created-connection" — Una Feature ha tracciato la connessione, e un’associazione viene scritta solo su una connessione tracciata da un componente o dalla Release. "ad-hoc-socket" — Il socket è uno che il Component non dichiara, quindi non dichiara alcuno slot da riempire per una connessione. "no-slot-declared" — Il Component dichiara il socket e non dichiara alcuno slot su di esso. |
Non sono consentite proprietà aggiuntive.
ConnectionCandidatesResult
A quali entità può essere collegato ciascun socket dell’entità.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
node | string | sì | L’entità di cui sono questi socket. |
adHocSocketsAccepted | booleana | sì | Se un socket che la definizione propria dell’entità non dichiara in anticipo può comunque essere scritto. |
sockets | SocketCandidacy[] o null | sì | Ogni socket e ciò che può esservi collegato. |
Non sono consentite proprietà aggiuntive.
InsertionPointResult
Dove, nel documento, va collocata una nuova voce sotto il contenitore nominato, e ciò di cui un client ha bisogno per scriverla lì: il punto stesso, se il testo deve iniziare con un’interruzione di riga, le chiavi del contenitore che ancora mancano e l’indentazione che prende ogni riga.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
file | string | sì | Il documento. |
container | string[] o null | sì | Il percorso attraverso il documento fino al contenitore. |
positionEncoding | string | sì | La codifica in cui sono espresse le posizioni in questa risposta. |
position | Position | sì | Un punto in un documento: una riga e un offset di carattere al suo interno, entrambi contati a partire da zero. L’offset è misurato nelle unità della codifica che la sessione ha concordato quando è stata aperta, che è UTF-16 a meno che il client non ne abbia chiesta un’altra. |
precededByLineBreak | booleana | sì | Se il testo scritto nella posizione deve iniziare con un’interruzione di riga, perché la posizione si trova alla fine di una riga che il documento già contiene. È false solo dove il documento non contiene nulla a cui la voce possa seguire. |
missingContainerKeys | string[] o null | sì | I segmenti del percorso del contenitore che il documento non contiene ancora, dal più esterno. Ciascuno deve essere scritto come chiave a sé, indentato di un livello in più rispetto a quello precedente, prima che la voce possa andare all’interno di quello più interno. È null dove l’intero percorso è già presente. |
entryIndent | integer | sì | La colonna da cui inizia la prima riga propria della voce, contata in spazi dall’inizio della riga. |
indentStep | integer | sì | Di quanto in più viene indentato ciascun livello di annidamento. |
indentStepMeasured | booleana | sì | Se il passo è stato misurato dall’annidamento proprio di questo documento. Dove è false, il documento non presenta alcun annidamento da misurare e il passo è un valore di ripiego, così un client che preferisce imporre il proprio sa di essere libero di farlo. |
entryShape | const “mapping” o const “sequence” o const “unknown” | sì | La forma in cui il contenitore porta le proprie voci, che è ciò che decide come viene composto il testo proprio della voce. Viene letta dal contenitore che il documento già contiene e non viene mai dedotta da come si chiama il contenitore. L’insieme è chiuso. Valori consentiti: "mapping" — Il contenitore è una mappatura a blocchi, quindi una voce aggiunta a esso è una chiave e il suo valore. "sequence" — Il contenitore è una sequenza a blocchi, quindi una voce aggiunta a esso è un trattino e il suo valore. "unknown" — Il documento non contiene il contenitore, o lo contiene senza nulla al suo interno, quindi spetta al client decidere quale forma prende una voce. |
Non sono consentite proprietà aggiuntive.
AttachmentContainerResult
In quale documento, e in quale punto di esso, va collocata un’associazione sul nodo del grafo, o sulla connessione nominata dalla richiesta.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
node | string | sì | Il nodo del grafo a cui è destinata l’associazione. |
file | string | sì | Il documento in cui va collocata l’associazione. |
container | string[] o null | sì | Il percorso attraverso quel documento fino al punto in cui va collocata. |
Non sono consentite proprietà aggiuntive.
ConnectionAtPositionResult
La connessione all’interno della cui voce ricade la posizione, o il motivo per cui non ne viene riportata alcuna. È presente esattamente una metà: graphNode e connection insieme, oppure noConnectionReason da solo. Una posizione in qualsiasi punto all’interno di una voce — sul suo alias, sulla sua destinazione o sulle sue associazioni — è all’interno di quella voce, la più interna dove le voci sono annidate; una posizione sulla chiave propria di un socket, sopra le voci scritte sotto di essa, non è all’interno di nessuna.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
graphNode | string | no | L’id del nodo il cui componente traccia la connessione, così come lo indicizza il grafo compilato — il valore che le richieste di candidatura e di contenitore accettano come graphNode. |
connection | ConnectionCoordinate | no | La connessione, tramite il suo socket e il suo alias, con document che nomina il documento in cui è stata letta la posizione — il valore che le richieste di candidatura e di contenitore accettano come connection. |
noConnectionReason | const “no-connection-entry” o const “feature-created-connection” o const “unknown-connection” | no | Presente solo dove non viene riportata alcuna connessione: il perché. L’insieme è chiuso. Valori consentiti: "no-connection-entry" — La posizione non è su alcuna voce in cui viene scritta un’associazione: né una connessione che un componente traccia, scritta sotto il suo alias, né una voce per singolo arco nella Release. Una connessione scritta come elenco di destinazioni, e una che il blocco proprio di una Feature traccia, non portano alcuna voce del genere. "feature-created-connection" — La posizione è sulla voce della Release per una connessione tracciata da una Feature, e un’associazione viene scritta solo su una connessione tracciata da un componente o dalla Release. "unknown-connection" — La posizione è su una voce che la Release scrive per una connessione che il grafo compilato non contiene. |
Non sono consentite proprietà aggiuntive.
ReleaseCandidatesResult
Le Releases che il workspace contiene, e i collegamenti che portano fuori da esso, verso directory e verso file, che non sono stati letti per esse.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
releases | string[] o null | sì | Ogni documento di Release. |
lockfiles | mappa di string | sì | Il file di lock di ciascuna Release elencata, indicizzato per Release esattamente come è elencata. Ciascuno è il file che un pull scrive per quella Release e che una build legge, così un client legge dove si trova anziché ricavarlo. Vuoto quando il workspace non contiene alcuna Release. |
unreadLinkedDirs | string[] | sì | Ogni collegamento sotto la radice del workspace che porta a una directory al di fuori di essa, nominato relativamente alla radice nel punto in cui si trova il collegamento stesso, nell’ordine in cui il workspace viene cercato. Nessuna directory al di fuori della radice viene cercata, quindi una Release raggiunta solo attraverso uno di questi collegamenti non è in releases, e un client che offre Releases può dire perché. Non nominati: un collegamento a una directory all’interno della radice, che viene cercata, o esclusa, dove si trova effettivamente; un collegamento ovunque una directory verrebbe esclusa, che sia per dove si trova o per il suo nome; e un collegamento che non può essere risolto, perché non porta da nessuna parte o porta in un ciclo. Vuoto quando il workspace non ne contiene nessuno. |
unreadLinkedFiles | string[] | sì | Ogni collegamento sotto la radice del workspace che ha un nome da file YAML, il cui nome termina con .yaml o .yml, e porta a un file al di fuori della radice, nominato relativamente alla radice nel punto in cui si trova il collegamento stesso, nell’ordine in cui il workspace viene cercato. Un file del genere non viene letto, quindi una Release raggiunta solo attraverso uno di questi collegamenti non è in releases, e un client che offre Releases può dire perché. Se un file sia una Release non si sa senza leggerlo, quindi ogni collegamento del genere viene nominato qualunque cosa contenga il file. Non nominati: un collegamento a un file che la configurazione del workspace nomina come Release, come build.authoring_release o come chiave di workspace.releases, il quale viene letto ed elencato in releases nel punto proprio del collegamento; un collegamento a un file all’interno della radice, che viene letto; un collegamento all’interno di una directory che la ricerca esclude; e un collegamento che non porta ad alcun file, che porti a una directory, che unreadLinkedDirs nomina dove porta fuori dalla radice, o da nessuna parte, o in un ciclo. Un file di configurazione del workspace che è un collegamento che porta fuori dal workspace, il suo .aggrega-config.yaml o l’overlay gestito dalla CI accanto a esso, viene nominato che la ricerca lo abbia incontrato o no, dopo i collegamenti nominati dalla ricerca: la configurazione del workspace allora non viene letta affatto, questa risposta viene letta senza nulla di configurato, quindi non viene elencata alcuna Release che la configurazione nomina tramite un collegamento, e ogni richiesta decisa dalla configurazione viene rifiutata per quel workspace con la condizione del blocco di lettura. |
Non sono consentite proprietà aggiuntive.
ActiveReleaseResult
Su quale Release un client dovrebbe agire per impostazione predefinita. Un workspace che non punta ad alcuna Release è uno stato ordinario anziché un errore, quindi viene riportato qui con un resoconto di come è stata tentata la scelta anziché sollevato come errore.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
release | string | sì | La Release su cui è ricaduta la scelta, o vuoto dove non è ricaduta su nessuna. |
lockfile | string | no | Il file di lock della Release su cui è ricaduta la scelta: il file che un pull scrive per essa e che una build legge. Assente dove la scelta non è ricaduta su alcuna Release. |
reason | string | no | Perché la scelta non è ricaduta su alcuna Release. |
trace | string | no | Ogni passo della scelta e ciò che ha trovato, così un chiamante può vedere quale l’avrebbe decisa. |
Non sono consentite proprietà aggiuntive.
EditDocumentResult
Ciò che la modifica ha scritto, e dove. Dopo una scrittura la lettura del documento che il daemon conserva viene scartata, così la risposta successiva che lo riguarda viene calcolata dai byte prodotti dalla modifica.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
file | string | sì | Il documento che è stato modificato. |
edit | string | sì | Quale modifica è stata applicata. |
container | string[] o null | sì | Il percorso attraverso il documento fino al punto in cui è finita la modifica. |
createdContainers | string[] o null | sì | I contenitori che la modifica ha dovuto creare lungo il percorso. |
written | string[] o null | sì | I documenti che sono stati scritti. |
content | string | sì | Il documento composto, per una richiesta che ha chiesto di vedere il risultato anziché farlo scrivere. |
Non sono consentite proprietà aggiuntive.
EffectiveConfigurationResult
La configurazione che il workspace ha risolto, e da quale documento proviene ciascuna impostazione.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
layers | string[] o null | sì | I documenti di configurazione che sono stati uniti, nell’ordine in cui sono stati uniti. |
settings | EffectiveConfigurationSetting[] o null | sì | Ogni impostazione risolta e da dove proviene. |
Non sono consentite proprietà aggiuntive.
ConfigInitResult
Ciò che l’inizializzazione di una configurazione ha scritto, dove, e ciò che ha letto dal registry.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
host | string | sì | Il registry per cui è stata inizializzata la configurazione. |
scope | ConfigWriteScope | sì | Quale documento di configurazione è stato scritto e fin dove arriva. Una richiesta nomina un unico workspace, quindi una risposta che non dicesse nulla verrebbe letta come relativa a quel workspace — e per una scrittura sull’intera macchina quella lettura è sbagliata. |
trust | TrustFetchOutcome | sì | Che cosa ha prodotto la lettura della policy di fiducia annunciata da un registry. Gli esiti sono tenuti distinti perché significano cose diverse: la policy annunciata è stata adottata, il registry non ha annunciato nulla — il che non è un errore — al suo posto è stata fissata la baseline integrata, oppure non è stata tentata alcuna lettura. Dove non è stato annunciato nulla, accanto a ciò si indica se il registry fosse raggiungibile. |
written | booleana | sì | Se il documento è stato scritto, anziché restituito perché il chiamante lo collochi. |
existed | booleana | no | Presente e true quando il documento era già presente, così la voce del registry è stata unita in esso anziché creare un nuovo documento. Solo una richiesta che invia force procede su un documento esistente, quindi è assente da ogni risposta a una richiesta che non lo ha fatto. |
content | string | no | Il testo del documento, per una richiesta che ha chiesto di vederlo anziché farlo scrivere. |
Non sono consentite proprietà aggiuntive.
ConfigCaptureResult
Ciò che il congelamento della configurazione risolta ha scritto nel documento proprio di questo workspace.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
configFile | string | sì | Il documento che è stato scritto. È sempre quello proprio di questo workspace, poiché lo scopo stesso è rendere autosufficiente un unico workspace. |
workspaceRoot | string | sì | Il workspace che la richiesta ha nominato. |
captured | booleana | sì | Se è stato congelato qualcosa. |
sockets | ConfigCapturedSocket[] o null | sì | Ogni socket che è stato congelato, con le sue associazioni. |
catalogDirs | string[] o null | sì | Le directory di catalogo che sono state congelate. |
Non sono consentite proprietà aggiuntive.
ImportResult
Ciò che la conversione di una sorgente esterna ha prodotto, e ciò che non ha potuto convertire.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
format | string | sì | Il formato sorgente che è stato convertito. |
outputDir | string | sì | La directory rispetto a cui è relativo ogni percorso nella risposta, e quella in cui sono stati scritti i file. |
written | string[] o null | sì | Ogni file che è arrivato su disco, nell’ordine di scrittura: le bozze, poi il registro di ciò che l’importazione ha scritto. Sotto sync, solo le bozze che la sincronizzazione ha cambiato e il registro dove è cambiato. Vuoto sotto dryRun. |
files | ImportedFile[] o null | sì | Ogni file che la richiesta scrive, con il suo testo, sotto dryRun e senza di esso: ogni bozza, poi il registro di ciò che l’importazione ha scritto. Sotto sync, ogni bozza che la sincronizzazione cambia, con il suo nuovo testo, poi il registro dove cambia anch’esso, così una sincronizzazione già allineata risponde con una lista vuota. |
drift | ImportDrift[] | sì | Ogni parte che una sincronizzazione ha allineato alla sorgente, o che allineerebbe sotto dryRun, nell’ordine in cui la bozza le nomina; un file redatto che la sincronizzazione elimina è una di esse, rimossa senza chiavi. Una lista vuota per una richiesta che non è una sincronizzazione, per una sincronizzazione già allineata, e per una sincronizzazione la cui conversione si è arrestata, che non scrive nulla. |
diagnostics | ImportDiagnostic[] o null | sì | Che cosa non è stato possibile convertire. |
decisions | ImportDecision[] | sì | Come l’importatore ha mappato ciascun nodo della sorgente, nell’ordine dell’importatore ed esattamente come l’ha riportato: ciò che ti dice dove la conversione ha tirato a indovinare. Presente in entrambe le modalità di consegna e indipendentemente dal fatto che la conversione si sia arrestata, e una lista vuota per un importatore che non ne riporta alcuna. |
owed | ImportOwed[] | no | Ogni valore che le bozze lasciano ancora vuoto e che nessuna sorgente ha potuto fornire né alcuna risposta ha fornito, nell’ordine in cui le bozze vengono scritte — i valori che i rilievi di avviso indicano. Ogni risposta lo riporta, come elenco vuoto dove le bozze non devono nulla. |
halted | booleana | sì | Se la conversione si è arrestata anziché concludersi con dei rilievi. |
Non sono consentite proprietà aggiuntive.
ScaffoldEntityResult
Il documento di partenza redatto, la lista degli esempi eseguibili, o l’esempio scritto — ciascuna forma risponde con i propri campi e lascia assenti gli altri.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
kind | string | no | Il tipo di entità che è stato redatto. Presente in una bozza. |
skeleton | string | no | Il testo del documento redatto. Presente in una bozza. |
examples | ScaffoldExample[] | no | Ogni esempio eseguibile che la documentazione pubblica, ciascuno una volta, in ordine di nome. Presente in un elenco che ne ha trovato almeno uno. |
example | string | no | L’esempio che è stato scritto. Presente in una scrittura. |
dir | string | no | La directory in cui è stato scritto l’esempio, relativa alla radice del workspace, come l’ha nominata la richiesta o, dove non ne ha nominata alcuna, come il nome dell’esempio. Presente in una scrittura. |
files | string[] | no | Ogni file scritto, relativo a dir e separato da barre, nell’ordine in cui la documentazione li riporta. Presente in una scrittura. |
next | string[] | no | I comandi che la pagina dell’esempio fornisce per eseguirne la build, riga per riga come la pagina li scrive, commenti inclusi: il primo blocco shell sotto il suo titolo Build. Assente dove la pagina non ne fornisce. |
version | string | no | La versione della documentazione da cui è stato letto l’esempio: quella propria del binario dove ne è pubblicata una per esso, altrimenti la più recente pubblicata prima di esso. Presente in una scrittura. |
Non sono consentite proprietà aggiuntive.
ScaffoldExample
Un esempio eseguibile che la documentazione pubblica.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
name | string | sì | Il nome dell’esempio, che una richiesta invia come example per scriverlo. |
level | string | sì | Il livello che la pagina dell’esempio dichiara per esso. |
summary | string | sì | La prima frase della pagina dell’esempio. |
Non sono consentite proprietà aggiuntive.
LintResult
Ciò che il controllo delle convenzioni ha trovato, contato per gravità ed elencato per documento. Un controllo dell’intero catalogo eseguito una volta per ciascuna Release porta anche passes; i conteggi e files coprono allora tutti i passaggi insieme.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
entity | string | no | L’unica entità che è stata controllata, dove la richiesta ne ha nominata una. |
release | string | no | La Release la cui chiusura è stata controllata, dove la richiesta ne ha nominata una. |
checked | integer | sì | Quanti documenti sono stati controllati. Dove il controllo è stato eseguito una volta per ciascuna Release, la somma sui passaggi: un documento letto da due passaggi viene contato in ciascuno. |
findings | integer | sì | Quanti rilievi ci sono in totale. |
errors | integer | sì | Quanti di essi sono errori. |
warnings | integer | sì | Quanti di essi sono avvertimenti. |
infos | integer | sì | Quanti di essi sono informativi. |
files | LintFileFindings[] o null | sì | I rilievi, per documento. |
halted | booleana | sì | Se il controllo si è arrestato anziché concludersi con dei rilievi. |
passes | LintPass[] o null | no | Il controllo dell’intero catalogo un passaggio alla volta, presente solo dove è stato eseguito una volta per ciascuna Release perché il workspace nomina delle Releases sotto workspace.releases. Ogni passaggio dice per quali Releases sono stati trovati i suoi rilievi. Assente per un workspace che non ne nomina nessuna, che viene controllato una volta sulle proprie directory, e per un controllo di una sola entità o della chiusura di una Release. |
Non sono consentite proprietà aggiuntive.
LintPass
Un passaggio di un controllo delle convenzioni sull’intero catalogo in un workspace che dà alle sue Releases directory di catalogo proprie: le Releases per cui è stato eseguito, le directory che ha letto, e ciò che vi ha trovato.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
releases | string[] o null | sì | Le Releases per cui è stato eseguito il passaggio, ciascuna come percorso relativo alla radice del workspace. Le Releases che leggono le stesse directory di catalogo condividono un unico passaggio. |
catalogDirs | string[] o null | sì | Le directory di catalogo che il passaggio ha letto, nell’ordine in cui vengono cercate, ciascuna relativa alla radice del workspace dove si trova al suo interno. Vuoto dove le sue Releases non leggono alcuna directory di catalogo, così il passaggio non ha controllato nulla e non ha fatto fallire nessuno degli altri. |
checked | integer | sì | Quanti documenti ha controllato il passaggio. |
findings | integer | sì | Quanti rilievi ha trovato il passaggio. |
errors | integer | sì | Quanti di essi sono errori. |
warnings | integer | sì | Quanti di essi sono avvertimenti. |
infos | integer | sì | Quanti di essi sono informativi. |
files | LintFileFindings[] o null | sì | I rilievi del passaggio, per documento. |
Non sono consentite proprietà aggiuntive.
PluginAddResult
Ciò che l’associazione di un plugin ha scritto, dove, e quale versione ha fissato.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
type | string | sì | Il socket a cui è stato associato il plugin. |
identity | string | no | L’identità in cui si è risolta l’associazione. |
uri | string | no | Il riferimento da cui si risolve l’associazione. |
capability | string | no | La capacità a cui è destinata l’associazione. |
reference | string | no | Il riferimento fissato, versione inclusa. |
scope | PluginWriteScope | sì | In quale documento di configurazione è stata scritta una modifica ai plugin e fin dove arriva. Il valore predefinito proprio del socket di estensione dei comandi è il documento dell’intera macchina, quindi ogni risposta dice quale ha scritto. |
written | booleana | sì | Se il documento di configurazione è stato scritto, anziché restituito perché il chiamante lo collochi. |
content | string | no | Il testo del documento di configurazione, per una richiesta che ha chiesto di vederlo anziché farlo scrivere. |
retraction | PluginRetraction | no | Come un marcatore di deprecazione ha determinato quale versione del plugin è stata fissata. |
withdrawn | booleana | no | Vale true quando la query ha nominato la versione fissata e una ritrattazione ritenuta attendibile da questo workspace ha ritirato quella versione. Una versione nominata viene fissata comunque, perché nominarla è l’override. Assente altrimenti, e l’assenza non significa che la versione non sia ritirata: dove non è stato possibile leggere i marcatori di ritiro di una versione nominata, retraction.unscreened ne indica il motivo, e senza alcuna versione nominata viene scelta l’ultima versione pubblicata e retraction riporta ciò che il controllo dei ritiri ha concluso su quella scelta. |
Non sono consentite proprietà aggiuntive.
PluginRemoveResult
Ciò che la dissociazione di un plugin ha scritto, e dove.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
type | string | sì | Il socket a cui è stato associato il plugin. |
query | string | sì | Quale associazione è stata rimossa. |
scope | PluginWriteScope | sì | In quale documento di configurazione è stata scritta una modifica ai plugin e fin dove arriva. Il valore predefinito proprio del socket di estensione dei comandi è il documento dell’intera macchina, quindi ogni risposta dice quale ha scritto. |
Non sono consentite proprietà aggiuntive.
PluginSyncResult
Che cosa ha cambiato l’allineamento dei record gestiti dalla macchina di un’entità Plugin con il suo modulo.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
entity | string | sì | Il documento dell’entità Plugin che è stato allineato. |
hostFunctions | string[] o null | sì | Le funzioni host di cui il modulo dichiara di avere bisogno. |
commands | PluginCLICommand[] o null | sì | I comandi che il modulo fornisce. |
changed | booleana | sì | Se qualcosa nel documento è effettivamente cambiato. |
Non sono consentite proprietà aggiuntive.
PluginGenCatalogResult
I documenti di catalogo prodotti da una generazione.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
documents | PluginGeneratedDocument[] | no | Ogni documento generato e il suo testo. |
notices | string | no | Qualsiasi cosa la generazione voglia far sapere al chiamante. |
dryRun | booleana | sì | Se i documenti sono stati restituiti anziché scritti. |
Non sono consentite proprietà aggiuntive.
ExplainErrorResult
Ciò che il compilatore dichiara su una condizione, e i passi pubblicati che insegnano la correzione di authoring.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
shortCode | string | sì | Il codice breve della condizione. |
code | string | sì | Il nome descrittivo della condizione. |
message | string | sì | Ciò che la condizione dice quando viene sollevata. |
entries | ExplainErrorEntry[] | no | I passi pubblicati che insegnano la correzione. |
reference | string | sì | L’indirizzo pubblicato presso cui è spiegata la condizione. |
note | string | no | Perché mancano i passi pubblicati, dove non è stato possibile acquisirli. Ciò che il binario stesso dichiara riceve comunque risposta. |
Non sono consentite proprietà aggiuntive.
GetSchemaResult
Lo schema di un tipo, oppure — dove la richiesta non ne ha nominato alcuno — quali tipi possono essere nominati. Le due ampiezze viaggiano su un’unica risposta anziché su due metodi, perché «che cosa posso nominare» e «di quali di questi un autore scrive documenti» sono la stessa domanda a due ampiezze, e due risposte dovrebbero essere mantenute concordi.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
kind | string | no | Il tipo a cui è destinato lo schema. |
schema | any | no | Lo schema stesso, trasmesso così come lo contiene il binario. |
kinds | string[] | no | Ogni token a cui questo binario risponde. |
entityKinds | EntityKindDescriptor[] | no | L’insieme più ristretto di cui un autore scrive un documento, ciascuno dei quali abbina il token nominato da una richiesta al tipo dichiarato dall’intestazione propria del documento. |
Non sono consentite proprietà aggiuntive.
SkillsInstallResult
Ciò che l’installazione della skill per l’assistente ha scritto, e dove.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
skill | string | sì | La skill che è stata scritta. |
installed | SkillsInstalledFolder[] | sì | Ogni cartella delle skill scritta, nell’ordine in cui la richiesta ha nominato gli assistenti. Gli assistenti che leggono un’unica cartella condivisa condividono un’unica voce, perché la skill vi viene scritta una sola volta. |
scope | SkillFolderScope | sì | Fin dove arriva un’installazione di skill. Una richiesta nomina un unico workspace, quindi una risposta che non dicesse nulla verrebbe letta come relativa a quel workspace — e per le cartelle per utente, che un assistente legge in ogni progetto, quella lettura è sbagliata. |
Non sono consentite proprietà aggiuntive.
SkillsInstalledFolder
Una cartella delle skill che un’installazione ha scritto.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
agents | string[] | sì | Gli identificatori degli assistenti nominati che leggono questa cartella, nell’ordine in cui la richiesta li ha nominati. |
folder | string | sì | La cartella della skill, come percorso assoluto. |
replaced | booleana | sì | Se una copia che porta la riga di commento presente in ogni copia scritta della skill — una che un’installazione precedente ha scritto, o una presa dal repository pubblicato delle skill — era presente ed è stata sostituita. Un file lì presente senza quella riga viene rifiutato anziché sostituito. |
Non sono consentite proprietà aggiuntive.
SkillsListResult
Le skill che il binario include e ogni assistente per cui un’installazione può scriverle. Non viene scritto nulla e non viene raggiunto nulla.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
skills | SkillsListedSkill[] | sì | Ogni skill che il binario include, in un ordine fisso. |
agents | SkillsListedAgent[] | sì | Ogni assistente per cui un’installazione conosce una cartella delle skill, ordinato per identificatore. |
Non sono consentite proprietà aggiuntive.
SkillsListedSkill
Una skill che il binario include.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
name | string | sì | Il nome della skill, che è anche il nome della cartella che un’installazione scrive. |
description | string | sì | Quando un assistente usa la skill, come lo dichiara la skill stessa. |
Non sono consentite proprietà aggiuntive.
SkillsListedAgent
Un assistente per cui un’installazione può scrivere una skill, con le due cartelle da cui legge le skill.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
id | string | sì | L’identificatore con cui una richiesta nomina l’assistente. |
name | string | sì | Il nome proprio dell’assistente. |
projectFolder | string | sì | La cartella, relativa alla radice di un progetto e separata da barre, da cui l’assistente legge le skill di un progetto. Un’installazione di progetto scrive la cartella della skill al suo interno, nel workspace che la richiesta nomina. |
userFolder | string | sì | La cartella, relativa alla directory home e separata da barre, da cui l’assistente legge le skill proprie dell’utente in ogni progetto. Un’installazione con global scrive la cartella della skill al suo interno. |
Non sono consentite proprietà aggiuntive.