Pular para o conteúdo
AggregaAggrega
Selecionar língua: Português (Portugal)
Esta página foi traduzida automaticamente. Ler o original em inglês.

Esquema do protocolo de comunicação do daemon em segundo plano do Aggrega

Referência gerada. Não editar à mão — gerar novamente a partir do JSON Schema publicado.

ID do esquema: https://aggrega.ai/schemas/serve-wire-v1beta1.schema.json

As formas das mensagens trocadas com um daemon do compilador em segundo plano iniciado por aggrega serve. Um cliente abre uma sessão sobre esse daemon com o handshake, e a sessão é o que delimita as definições e o espaço de trabalho sobre os quais a conversa foi aberta; o daemon é o processo que responde a um pedido, envia uma notificação e guarda o que leu. O protocolo é JSON-RPC 2.0 sobre a entrada e a saída padrão, com cada mensagem delimitada por um cabeçalho Content-Length; este documento descreve os corpos das mensagens e nem a delimitação nem o transporte. Um corpo é uma de quatro coisas: um pedido que o cliente envia, uma notificação que o cliente envia, uma notificação que o daemon envia, ou a resposta que o daemon devolve para um pedido. Três propriedades da superfície decidem como as formas abaixo são escritas. Primeiro, cada pedido admite dois campos além dos que o seu próprio método declara — workspaceRoot, que nomeia o espaço de trabalho sobre o qual o pedido atua, e workDoneToken, o valor gerado pelo chamador sob o qual o progresso é reportado — pelo que ambos aparecem aqui em cada objeto params de pedido, incluindo os três métodos cujo sujeito não é um espaço de trabalho: aggrega/getSchema e aggrega/scaffoldEntity aceitam workspaceRoot e ignoram-no, e aggrega/initialize lê-o como o espaço de trabalho que a sessão declara. Segundo, o daemon recusa um objeto params de pedido que contenha um campo que o método não aceita, nomeando o que aceita, pelo que aqui cada objeto params é fechado no seu nível superior; um objeto aninhado dentro de um pedido não é fechado, porque a verificação lê apenas os nomes de campo mais exteriores. Terceiro, um resultado é composto pelo daemon em vez de fornecido por um chamador, pelo que os objetos de resultado são fechados em cada nível cuja forma é fixa, e abertos apenas onde o valor é JSON opaco que o daemon transporta sem ler. Uma consequência da codificação do daemon é visível nas mensagens transmitidas e é descrita em vez de escondida: uma coleção que o daemon não marca como opcional é emitida como null quando não tem nenhum valor a reportar e como uma coleção vazia quando o valor que reporta está vazio, pelo que ambas as formas são admitidas onde quer que isso se aplique.

Uma das seguintes formas

  • Request
  • ClientNotification
  • DaemonNotification
  • SuccessResponse
  • ErrorResponse

Definições

ProtocolVersion

A versão do JSON-RPC que cada mensagem contém. Apenas a 2.0 é falada.

Tipo: const "2.0"

Constante: "2.0"

RequestId

O identificador do chamador para um pedido, repetido na resposta que lhe responde. Uma mensagem que não contém nenhum identificador é uma notificação e nunca recebe resposta.

Tipo: string or number

ProgressToken

Um valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.

Tipo: string or number

WorkspaceRootSubject

O caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.

Tipo: string

WorkspaceRootAccepted

O caminho absoluto de um espaço de trabalho. O sujeito deste método não é um espaço de trabalho — responde a partir daquilo que o próprio binário contém — pelo que o campo é aceite e não lido. É admitido porque um cliente pode enviá-lo de forma uniforme em cada pedido sem ter de saber que métodos o consultam.

Tipo: string

RequestMethod

Cada método que um pedido pode nomear. O conjunto é fechado: um pedido que nomeie qualquer outra coisa recebe como resposta um erro de método não encontrado.

Tipo: string (enum)

Valores permitidos: "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

Cada método que uma notificação do cliente pode nomear. O conjunto é fechado, e nenhuma das duas notificações recebe resposta.

Tipo: string (enum)

Valores permitidos: "$/cancelRequest", "aggrega/shutdown"

DaemonNotificationMethod

Cada método que uma notificação enviada pelo daemon pode nomear. O conjunto é fechado.

Tipo: string (enum)

Valores permitidos: "$/progress", "aggrega/publishDiagnostics"

Request

Um pedido que o cliente envia e a que o daemon responde. O método nomeia o que está a ser pedido; o objeto params contém os campos próprios desse método mais os dois que qualquer método admite. Um pedido que omita params por completo é lido como um cujos campos estão todos ausentes.

PropriedadeTipoObrigatóriaDescrição
jsonrpcProtocolVersionsimA versão do JSON-RPC que cada mensagem contém. Apenas a 2.0 é falada.
idRequestIdsimO identificador do chamador para um pedido, repetido na resposta que lhe responde. Uma mensagem que não contém nenhum identificador é uma notificação e nunca recebe resposta.
methodRequestMethodsimCada método que um pedido pode nomear. O conjunto é fechado: um pedido que nomeie qualquer outra coisa recebe como resposta um erro de método não encontrado.
paramsobjetonão

Não são permitidas propriedades adicionais.

params para cada method:

methodparamsObrigatória
"aggrega/initialize"InitializeParamsnão
"aggrega/validate"ValidateParamsnão
"aggrega/invalidate"InvalidateParamsnão
"aggrega/diagnostics"DiagnosticsParamsnão
"aggrega/irGraph"IrGraphParamsnão
"aggrega/build"BuildParamsnão
"aggrega/buildPreview"BuildPreviewParamsnão
"aggrega/entityDefinition"EntityDefinitionParamsnão
"aggrega/releaseClosure"ReleaseClosureParamsnão
"aggrega/resolveDependencies"ResolveDependenciesParamsnão
"aggrega/pin"PinParamsnão
"aggrega/cacheStatus"WorkspaceAndProgressParamsnão
"aggrega/cachePrune"WorkspaceAndProgressParamsnão
"aggrega/cacheEvict"CacheEvictParamsnão
"aggrega/cacheClear"WorkspaceAndProgressParamsnão
"aggrega/registryList"WorkspaceAndProgressParamsnão
"aggrega/search"SearchParamsnão
"aggrega/registryAdd"RegistryAddParamsnão
"aggrega/registryRemove"RegistryRemoveParamsnão
"aggrega/registryUpdate"RegistryUpdateParamsnão
"aggrega/logout"LogoutParamsnão
"aggrega/publishEntity"PublishEntityParamsnão
"aggrega/publishArtifact"PublishArtifactParamsnão
"aggrega/signArtifacts"SignArtifactsParamsnão
"aggrega/deprecateArtifact"DeprecateArtifactParamsnão
"aggrega/resolve"ResolveParamsnão
"aggrega/findReferences"FindReferencesParamsnão
"aggrega/findImplementations"FindImplementationsParamsnão
"aggrega/hover"HoverParamsnão
"aggrega/completion"CompletionParamsnão
"aggrega/catalogIndex"CatalogIndexParamsnão
"aggrega/attachCandidates"AttachCandidatesParamsnão
"aggrega/connectionCandidates"ConnectionCandidatesParamsnão
"aggrega/insertionPoint"InsertionPointParamsnão
"aggrega/attachmentContainer"AttachmentContainerParamsnão
"aggrega/connectionAtPosition"ConnectionAtPositionParamsnão
"aggrega/releaseCandidates"WorkspaceAndProgressParamsnão
"aggrega/activeRelease"WorkspaceAndProgressParamsnão
"aggrega/setActiveRelease"SetActiveReleaseParamsnão
"aggrega/editDocument"EditDocumentParamsnão
"aggrega/effectiveConfiguration"WorkspaceAndProgressParamsnão
"aggrega/configInit"ConfigInitParamsnão
"aggrega/configCapture"ConfigCaptureParamsnão
"aggrega/import"ImportParamsnão
"aggrega/scaffoldEntity"ScaffoldEntityParamsnão
"aggrega/lint"LintParamsnão
"aggrega/pluginAdd"PluginAddParamsnão
"aggrega/pluginRemove"PluginRemoveParamsnão
"aggrega/pluginSync"PluginSyncParamsnão
"aggrega/pluginGenCatalog"PluginGenCatalogParamsnão
"aggrega/explainError"ExplainErrorParamsnão
"aggrega/getSchema"GetSchemaParamsnão
"aggrega/skillsInstall"SkillsInstallParamsnão
"aggrega/skillsList"WorkspaceAndProgressParamsnão

ClientNotification

Uma notificação que o cliente envia. Não contém nenhum identificador e nunca recebe resposta.

PropriedadeTipoObrigatóriaDescrição
jsonrpcProtocolVersionsimA versão do JSON-RPC que cada mensagem contém. Apenas a 2.0 é falada.
methodClientNotificationMethodsimCada método que uma notificação do cliente pode nomear. O conjunto é fechado, e nenhuma das duas notificações recebe resposta.
paramsobjetonão

Não são permitidas propriedades adicionais.

params para cada method:

methodparamsObrigatória
"$/cancelRequest"CancelRequestParamssim
"aggrega/shutdown"ShutdownParamsnão

DaemonNotification

Uma notificação que o daemon envia. Não contém nenhum identificador e nunca recebe resposta.

PropriedadeTipoObrigatóriaDescrição
jsonrpcProtocolVersionsimA versão do JSON-RPC que cada mensagem contém. Apenas a 2.0 é falada.
methodDaemonNotificationMethodsimCada método que uma notificação enviada pelo daemon pode nomear. O conjunto é fechado.
paramsobjetosim

Não são permitidas propriedades adicionais.

params para cada method:

methodparamsObrigatória
"$/progress"ProgressParamssim
"aggrega/publishDiagnostics"PublishDiagnosticsParamssim

CancelRequestParams

Pede ao daemon que abandone um pedido já em curso, nomeando-o pelo identificador que o pedido continha. Para um pedido já concluído, ou nunca enviado, simplesmente não há nada a cancelar, e nada é reportado.

PropriedadeTipoObrigatóriaDescrição
idRequestIdsimO identificador do chamador para um pedido, repetido na resposta que lhe responde. Uma mensagem que não contém nenhum identificador é uma notificação e nunca recebe resposta.

Não são permitidas propriedades adicionais.

ShutdownParams

Pede ao daemon que deixe de aceitar trabalho e termine o que já assumiu. A notificação não contém campos, e a própria notificação é normalmente enviada sem qualquer objeto params. Uma segunda abandona o trabalho ainda em curso em vez de esperar por ele.

Este objeto não declara propriedades fixas e não permite nenhuma.

ProgressParams

Um relatório de trabalho em curso, enviado apenas para um pedido que gerou um token de progresso numa sessão que declarou poder recebê-los.

PropriedadeTipoObrigatóriaDescrição
tokenProgressTokensimUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
valueProgressBegin ou ProgressReport ou ProgressEndsimO relatório em si. Um relatório de abertura, depois qualquer número de linhas, depois um relatório de fecho.

Não são permitidas propriedades adicionais.

ProgressBegin

Abre um relatório, indicando o que começou nos termos que a própria operação usa.

PropriedadeTipoObrigatóriaDescrição
kindconst “begin”simMarca este payload como a abertura de um relatório. Constante: "begin"
titlestringsimO que começou.

Não são permitidas propriedades adicionais.

ProgressReport

Uma linha do relato que a própria operação faz de si mesma. Não contém nenhuma fração: as operações que reportam aqui percorrem um conjunto cujo tamanho não é conhecido quando o trabalho começa, pelo que uma fração teria de ser inventada.

PropriedadeTipoObrigatóriaDescrição
kindconst “report”simMarca este payload como uma linha de um relatório aberto. Constante: "report"
messagestringsimUma linha da saída própria da operação, com os espaços em branco à volta removidos.

Não são permitidas propriedades adicionais.

ProgressEnd

Fecha um relatório. Não contém nada além do tipo, porque o resultado segue na resposta pela qual o chamador já está à espera.

PropriedadeTipoObrigatóriaDescrição
kindconst “end”simMarca este payload como o fecho de um relatório. Constante: "end"

Não são permitidas propriedades adicionais.

PublishDiagnosticsParams

As conclusões relativas a um ficheiro, enviadas pelo daemon quando uma validação as produziu para um documento diferente daquele que o pedido nomeou.

PropriedadeTipoObrigatóriaDescrição
filestringsimO ficheiro a que as conclusões se referem.
diagnosticsDiagnostic[] ou nullsimAs conclusões, pela ordem em que foram produzidas.

Não são permitidas propriedades adicionais.

SuccessResponse

A resposta a um pedido bem-sucedido, contendo o identificador do pedido a que responde. Uma resposta não contém nenhum método, pelo que a forma de resultado que se aplica é definida pelo pedido a que o identificador pertence e não por nada na própria resposta.

PropriedadeTipoObrigatóriaDescrição
jsonrpcProtocolVersionsimA versão do JSON-RPC que cada mensagem contém. Apenas a 2.0 é falada.
idRequestIdsimO identificador do chamador para um pedido, repetido na resposta que lhe responde. Uma mensagem que não contém nenhum identificador é uma notificação e nunca recebe resposta.
resultInitializeResult ou ValidateResult ou InvalidateResult ou DiagnosticsResult ou IrGraphResult ou BuildResult ou BuildPreviewResult ou EntityDefinitionResult ou ReleaseClosureResult ou ResolveDependenciesResult ou PinResult ou CacheStatusResult ou CachePruneResult ou CacheEvictResult ou CacheClearResult ou RegistryListResult ou SearchResult ou RegistryAddResult ou RegistryRemoveResult ou RegistryUpdateResult ou LogoutResult ou PublishEntityResult ou PublishArtifactResult ou SignArtifactsResult ou DeprecateArtifactResult ou ResolveResult ou FindReferencesResult ou FindImplementationsResult ou HoverResult ou CompletionResult ou CatalogIndexResult ou AttachCandidatesResult ou ConnectionCandidatesResult ou InsertionPointResult ou AttachmentContainerResult ou ConnectionAtPositionResult ou ReleaseCandidatesResult ou ActiveReleaseResult ou EditDocumentResult ou EffectiveConfigurationResult ou ConfigInitResult ou ConfigCaptureResult ou ImportResult ou ScaffoldEntityResult ou LintResult ou PluginAddResult ou PluginRemoveResult ou PluginSyncResult ou PluginGenCatalogResult ou ExplainErrorResult ou GetSchemaResult ou SkillsInstallResult ou SkillsListResultsimA resposta, na forma que o método pedido devolve.

Não são permitidas propriedades adicionais.

ErrorResponse

A resposta a um pedido que foi recusado ou falhou, contendo o identificador do pedido a que responde.

PropriedadeTipoObrigatóriaDescrição
jsonrpcProtocolVersionsimA versão do JSON-RPC que cada mensagem contém. Apenas a 2.0 é falada.
idRequestIdsimO identificador do chamador para um pedido, repetido na resposta que lhe responde. Uma mensagem que não contém nenhum identificador é uma notificação e nunca recebe resposta.
errorErrorObjectsimO que correu mal: um código pelo qual um cliente pode ramificar a sua lógica, uma mensagem escrita para ser lida por uma pessoa e — quando a condição tem uma — os artefactos e a posição no código-fonte a que a mensagem se refere.

Não são permitidas propriedades adicionais.

ErrorObject

O que correu mal: um código pelo qual um cliente pode ramificar a sua lógica, uma mensagem escrita para ser lida por uma pessoa e — quando a condição tem uma — os artefactos e a posição no código-fonte a que a mensagem se refere.

PropriedadeTipoObrigatóriaDescrição
codeErrorCodesimA condição que a resposta reporta. Os códigos negativos são o conjunto reservado do próprio protocolo; os códigos de quatro algarismos são condições que este daemon gera, cada uma nomeando um estado sobre o qual um cliente pode agir. O conjunto é fechado.
messagestringsimO que correu mal, em prosa. É a mesma redação que a mesma condição apresenta em qualquer outra superfície que a reporta.
dataErrorDatanãoOs artefactos e a posição no código-fonte a que a mensagem se refere, transportados de forma estruturada para que um cliente não tenha de os extrair da prosa. Cada campo é opcional e uma condição preenche apenas o que tem à mão; nenhum campo substitui outro, pelo que um cliente fica a saber o que recebeu pelo campo que leu e não pelo código ao lado.

Não são permitidas propriedades adicionais.

ErrorCode

A condição que a resposta reporta. Os códigos negativos são o conjunto reservado do próprio protocolo; os códigos de quatro algarismos são condições que este daemon gera, cada uma nomeando um estado sobre o qual um cliente pode agir. O conjunto é fechado.

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

Valores permitidos:

  • -32700 — Não foi possível analisar a mensagem como JSON.
  • -32600 — A mensagem foi analisada, mas não é um pedido bem formado.
  • -32601 — Não existe nenhum método com esse nome.
  • -32602 — Os params que o pedido continha não são admissíveis: um campo que o método não aceita, um campo do tipo errado ou um valor que o método recusa.
  • -32603 — O daemon falhou enquanto realizava o trabalho.
  • 1001 — O daemon não guarda nenhuma leitura do ficheiro e não está a produzir nenhuma. O cliente inicia uma pedindo uma validação e depois tenta novamente.
  • 1003 — O ficheiro de bloqueio da Release que o pedido nomeou está em falta, e a operação precisa de um.
  • 1004 — Não foi possível resolver a entidade que o pedido nomeou nem a partir do catálogo nem a partir da Release que o pedido nomeou.
  • 1005 — O daemon está a encerrar e a recusar trabalho novo. O cliente não volta a tentar no mesmo daemon.
  • 1006 — Uma validação do ficheiro está em curso e não terminou dentro do prazo que o pedido em espera permitia. O cliente aguarda e volta a pedir, sem enviar nada entretanto.

ErrorData

Os artefactos e a posição no código-fonte a que a mensagem se refere, transportados de forma estruturada para que um cliente não tenha de os extrair da prosa. Cada campo é opcional e uma condição preenche apenas o que tem à mão; nenhum campo substitui outro, pelo que um cliente fica a saber o que recebeu pelo campo que leu e não pelo código ao lado.

PropriedadeTipoObrigatóriaDescrição
filestringnãoO documento de origem que os campos de posição localizam — o documento a ser verificado, ou a Release cujo carregamento falhou.
lineintegernãoA linha a que a condição se refere, contada a partir de um.
columnintegernãoA coluna a que a condição se refere, contada a partir de um.
end_lineintegernãoA linha uma posição além do fim do token a que a condição se refere. Ausente quando o token não tem um fim recuperável, caso em que um cliente apresenta a posição como um ponto.
end_columnintegernãoA coluna uma posição além do fim do token a que a condição se refere.
releasestringnãoA Release a que a condição se refere, escrita da forma como o pedido a nomeou, para que um cliente possa compor a solução sem ter de a reconstituir.
lockfilestringnãoO ficheiro de bloqueio de que trata uma condição relativa ao ficheiro de bloqueio: o caminho que foi procurado e não encontrado, ou que não pôde ser lido.
unreachablebooleananãoSe a recusa diz respeito a um registo nomeado pelo pedido que não pôde ser alcançado: o seu nome não foi resolvido, uma ligação a ele foi recusada ou não pôde ser aberta, ou não foi possível estabelecer uma ligação segura a ele. É lido a partir da própria falha e não da mensagem, e só é definido quando a falha mostra que o registo nunca foi alcançado. Uma atualização de índice recusada que nomeia um registo contém-no; um registo que respondeu, fosse qual fosse a resposta, deixa-o ausente.
codestringnãoO nome descritivo da condição que a recusa nomeia, estável entre versões: o mesmo valor que um diagnóstico que reporta essa condição contém no seu próprio código. É por ele que um cliente ramifica a sua lógica, e não pela mensagem nem pelo código numérico ao lado, que nomeia o estado do pedido e se mantém o mesmo para cada condição. Presente exatamente quando a recusa nomeia uma condição registada, e ausente quando não nomeia nenhuma.
shortCodestringnãoO código curto da condição, a letra E seguida de quatro algarismos: a forma que um leitor cita e procura, e a que abre a mensagem de uma recusa que nomeia uma condição. Presente exatamente quando code está presente.

Não são permitidas propriedades adicionais.

Diagnostic

Uma conclusão sobre um documento: onde está, qual a sua gravidade, o que diz e o código citável que nomeia a condição que reporta.

PropriedadeTipoObrigatóriaDescrição
lineintegersimA linha a que a conclusão se refere, contada a partir de um.
columnintegersimA coluna a que a conclusão se refere, contada a partir de um.
severityconst “error” ou const “warning” ou const “info”simQual a gravidade da conclusão. Valores permitidos: "error" — A conclusão é um erro. Uma conclusão de plugin com severidade halt é reportada neste nível. "warning" — A conclusão é reportada e não é um erro. Uma conclusão de plugin com severidade warn é reportada neste nível. "info" — A conclusão é uma informação, como o é uma conclusão de plugin com severidade info.
messagestringsimO que a conclusão diz, em prosa.
codestringnãoO nome descritivo da condição, estável entre versões e citável numa supressão.
shortCodestringnãoO código curto da condição, a forma que abre um diagnóstico bloqueante.
codeDescriptionCodeDescriptionnãoOnde é explicada a condição que a conclusão nomeia.
classificationstringnãoComo se chegou à conclusão, quando a condição faz essa distinção.
suggeststringnãoA grafia que a conclusão propõe, quando a condição consegue nomear uma — um identificador quase correto, por exemplo.
keyPathstringnãoO caminho através do documento até à chave a que a conclusão se refere.
sourcestringsimO que produziu a conclusão.
end_lineintegernãoA linha uma posição além do fim do token a que a conclusão se refere, para que um cliente possa apresentar o token inteiro em vez de um único carácter. Ausente para um token que se estende por várias linhas.
end_columnintegernãoA coluna uma posição além do fim do token a que a conclusão se refere.

Não são permitidas propriedades adicionais.

CodeDescription

Onde é explicada a condição que a conclusão nomeia.

PropriedadeTipoObrigatóriaDescrição
hrefstringsimO endereço publicado no qual a condição é explicada.

Não são permitidas propriedades adicionais.

Position

Um ponto num documento: uma linha e um deslocamento de carácter dentro dela, ambos contados a partir de zero. O deslocamento é medido nas unidades da codificação que a sessão acordou ao ser aberta, que é UTF-16, a menos que o cliente tenha pedido outra.

PropriedadeTipoObrigatóriaDescrição
lineintegersimA linha, contada a partir de zero.
characterintegersimO deslocamento dentro da linha, contado a partir de zero, nas unidades da codificação que a sessão acordou.

Não são permitidas propriedades adicionais.

Range

Um trecho entre dois pontos de um documento.

PropriedadeTipoObrigatóriaDescrição
startPositionsimUm ponto num documento: uma linha e um deslocamento de carácter dentro dela, ambos contados a partir de zero. O deslocamento é medido nas unidades da codificação que a sessão acordou ao ser aberta, que é UTF-16, a menos que o cliente tenha pedido outra.
endPositionsimUm ponto num documento: uma linha e um deslocamento de carácter dentro dela, ambos contados a partir de zero. O deslocamento é medido nas unidades da codificação que a sessão acordou ao ser aberta, que é UTF-16, a menos que o cliente tenha pedido outra.

Não são permitidas propriedades adicionais.

Location

Um trecho num documento nomeado.

PropriedadeTipoObrigatóriaDescrição
uristringsimO documento em que o trecho se encontra, endereçado como URI.
rangeRangesimUm trecho entre dois pontos de um documento.

Não são permitidas propriedades adicionais.

WorkspaceAndProgressParams

O objeto params de um método que não declara campos próprios. Admite ainda assim os dois campos que cada pedido admite: o espaço de trabalho sobre o qual atua e um token de progresso.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.

Não são permitidas propriedades adicionais.

InitializeParams

Abre uma sessão sobre um espaço de trabalho e declara o que o cliente consegue tratar. Este é o único método em que workspaceRoot é uma declaração e não um sujeito: ausente, vazio e um caminho são três coisas diferentes, e uma sessão aberta sem caminho é uma sessão que o cliente ainda não apontou para um espaço de trabalho.

PropriedadeTipoObrigatóriaDescrição
capabilitiesClientCapabilitiesnãoO que o cliente consegue tratar. O que não é declarado é considerado não suportado. Os membros desconhecidos são ignorados em vez de recusados, pelo que um cliente pode declarar uma capacidade que este daemon ainda não lê.
workspaceRootstringnãoO caminho absoluto do espaço de trabalho a abrir. Se ausente, a sessão fica sem espaço de trabalho; uma cadeia de caracteres vazia é um caminho fornecido pelo cliente e não equivale a não enviar nenhum.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.

Não são permitidas propriedades adicionais.

ClientCapabilities

O que o cliente consegue tratar. O que não é declarado é considerado não suportado. Os membros desconhecidos são ignorados em vez de recusados, pelo que um cliente pode declarar uma capacidade que este daemon ainda não lê.

PropriedadeTipoObrigatóriaDescrição
generalobjetonãoCapacidades que não estão ligadas a um único tipo de resposta.
windowobjetonãoCapacidades relativas ao que o cliente pode mostrar enquanto há trabalho em curso.

São permitidas propriedades adicionais.

ClientCapabilities.general

Capacidades que não estão ligadas a um único tipo de resposta.

PropriedadeTipoObrigatóriaDescrição
positionEncodingsstring[]nãoAs codificações de posição que o cliente consegue ler, a melhor primeiro.

São permitidas propriedades adicionais.

ClientCapabilities.window

Capacidades relativas ao que o cliente pode mostrar enquanto há trabalho em curso.

PropriedadeTipoObrigatóriaDescrição
workDoneProgressbooleananãoSe o cliente pode receber notificações de progresso. Um pedido que gere um token de progresso numa sessão que não o declarou é recusado.

São permitidas propriedades adicionais.

ValidateParams

Verifica o espaço de trabalho, ou um documento nele, e responde com as conclusões.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
filestringnãoO documento a verificar. Se ausente, verifica o que o espaço de trabalho contém.
contentstringnãoO texto do documento tal como o cliente o detém neste momento, para verificar um buffer que não foi guardado. Se ausente, lê os bytes no disco.
releasestringnãoA Release face à qual verificar, como caminho relativo à raiz do espaço de trabalho.

Não são permitidas propriedades adicionais.

InvalidateParams

Informa o daemon de que um documento do qual guarda uma leitura mudou, para que a próxima resposta sobre ele seja calculada a partir dos novos bytes.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
filestringnãoO documento que mudou.
granularitystringnãoQuanto do que o daemon guarda deve ser descartado: file descarta apenas o que guarda para o documento nomeado; workspace, a predefinição e a forma como qualquer outro valor é lido, descarta também o que guarda para todo o espaço de trabalho.

Não são permitidas propriedades adicionais.

DiagnosticsParams

Responde com as conclusões que o daemon já guarda para um documento, sem o verificar de novo.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
filestringnãoO documento sobre o qual reportar. O daemon já tem de guardar uma leitura dele.

Não são permitidas propriedades adicionais.

IrGraphParams

Responde com o grafo resolvido em que uma Release é compilada, sem o renderizar.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
releasestringnãoA Release a resolver, como caminho relativo à raiz do espaço de trabalho. Um caminho absoluto é recusado.
unredactedbooleananãoSe deve responder com os valores que um autor declarou sensíveis em texto simples. Se ausente ou false, cada um deles é retido do grafo e um marcador que indica o motivo fica no seu lugar, tal como a saída de grafo da linha de comandos os retém; true responde com o grafo tal como a Release é compilada nele, incluindo esses valores.

Não são permitidas propriedades adicionais.

BuildParams

Compila uma Release e escreve os artefactos renderizados no espaço de trabalho.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
releasestringnãoA Release a compilar, como caminho relativo à raiz do espaço de trabalho. Um caminho absoluto é recusado.
outputParentstringnãoO diretório dentro do qual é criado o diretório de saída, como caminho relativo à raiz do espaço de trabalho. Os artefactos ficam no diretório de saída abaixo dele, organizados como ficam sob a raiz do espaço de trabalho quando nada é nomeado — pelo que isto nomeia o diretório pai do diretório de saída e nunca o próprio diretório de saída. Se ausente, ou vazio, escreve o diretório de saída sob a raiz do espaço de trabalho, como aggrega build faz de onde quer que seja executado. Um caminho absoluto, ou um que sobe para fora do espaço de trabalho, é recusado.
autoPullbooleananãoSe deve resolver primeiro as dependências da Release. Pedi-lo alcança os registos configurados e escreve o ficheiro de bloqueio; sem o pedir, a compilação não alcança nenhum registo.
policyInputstringnãoO diretório em que escrever, ao lado dos artefactos, o payload que cada papel de governação entrega a um plugin anexado aí, como caminho relativo à raiz do espaço de trabalho — os ficheiros que aggrega build --policy-input escreve, com os mesmos nomes, escritos quer a compilação termine quer pare. Os avisos da resposta indicam quantos foram escritos e nomeiam cada papel para o qual não foi escrito nenhum ficheiro. Num pedido que falha, os ficheiros escritos estão no disco e essa contagem não está na resposta: o erro contém apenas a recusa. Se ausente, não escreve nenhum. Um caminho absoluto, ou um que sobe para fora do espaço de trabalho, é recusado.

Não são permitidas propriedades adicionais.

BuildPreviewParams

Compila uma Release e reporta o que a escrita dos artefactos teria produzido, sem escrever nenhum deles. Recusa o campo de resolução de dependências que a compilação com escrita aceita, porque um pedido que não escreve nada não pode preencher um ficheiro de bloqueio.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
releasestringnãoA Release a compilar, como caminho relativo à raiz do espaço de trabalho.
autoPullbooleananãoAceite nas mensagens transmitidas e recusado pelo método: este pedido não escreve nada, pelo que não pode preencher um ficheiro de bloqueio e continuar a ser o que diz ser.
policyInputstringnãoO diretório em que escrever o payload que cada papel de governação entrega a um plugin anexado aí, como caminho relativo à raiz do espaço de trabalho — os ficheiros que aggrega build --dry-run --policy-input escreve, com os mesmos nomes. Se enviado, são a única coisa que este pedido escreve; o diretório de saída e o ficheiro de bloqueio ficam intactos. Os avisos da resposta indicam quantos foram escritos e nomeiam cada papel para o qual não foi escrito nenhum ficheiro. Num pedido que falha, os ficheiros escritos estão no disco e essa contagem não está na resposta: o erro contém apenas a recusa. Um caminho absoluto, ou um que sobe para fora do espaço de trabalho, é recusado.

Não são permitidas propriedades adicionais.

EntityDefinitionParams

Responde com aquilo em que um nome de entidade é resolvido e onde se encontra o documento que a define.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
namestringnãoA entidade a resolver, por nome — ou uma referência de registo, oci://<host>/<repository>:<tag> ou @<digest> em vez de :<tag>, para ler a entidade publicada nessa coordenada.
releasestringnãoA Release em cujos termos resolver o nome, como caminho relativo à raiz do espaço de trabalho. O nome é então resolvido através dos diretórios de catálogo que a configuração do espaço de trabalho atribui a essa Release, pelo que um nome que várias variantes declaram num mesmo espaço de trabalho, uma por Release, é resolvido para a variante com que essa Release é compilada, e um nome que ela não resolve é recusado com uma explicação que nomeia a entrada dessa Release sob workspace.releases. Se ausente, o nome é resolvido sobre os próprios diretórios de catálogo do espaço de trabalho. Uma referência de registo não aceita nenhuma Release e é recusada se contiver uma, tal como um valor que não nomeia nenhum ficheiro de Release.

Não são permitidas propriedades adicionais.

CatalogIndexParams

Responde com as entidades que o espaço de trabalho contém: cada entidade que os seus documentos declaram, e as Features que os seus diretórios de catálogo declaram.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
releasestringnãoA Release em cujos termos listar as entidades, como caminho relativo à raiz do espaço de trabalho. As Features são então as que declaram os diretórios de catálogo que a configuração do espaço de trabalho atribui a essa Release, e um documento sob um diretório de catálogo que apenas outras Releases leem é deixado de fora, pelo que um espaço de trabalho que mantém variantes de uma entidade lado a lado, uma por Release, é listado com a variante com que essa Release é compilada. Se ausente, a listagem é a do próprio espaço de trabalho. Um valor que não nomeia nenhum ficheiro de Release é recusado.

Não são permitidas propriedades adicionais.

ReleaseClosureParams

Responde com tudo aquilo de que uma Release depende, tal como a resolução o alcançou.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
releasestringnãoA Release a inspecionar, como caminho relativo à raiz do espaço de trabalho.

Não são permitidas propriedades adicionais.

ResolveDependenciesParams

Resolve as dependências de uma Release, fixando-as no ficheiro de bloqueio e obtendo as entradas externas que a sua renderização consome. Alcança os registos configurados e escreve.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
releasestringnãoA Release a resolver, como caminho relativo à raiz do espaço de trabalho.
upgradebooleananãoSe deve resolver de novo dentro dos intervalos declarados em vez de respeitar o que o ficheiro de bloqueio já fixa.
targetsstring[]nãoAs referências a resolver de novo, deixando o resto fixado como está. Vazio resolve tudo.
verifybooleananãoSe deve comparar o ficheiro de bloqueio registado com a resolução que este pedido realizaria sem ele, respeitando as fixações que esse pedido respeitaria, em vez de o escrever. Uma verificação não escreve nenhum ficheiro de bloqueio, registo de confiança de plugins nem entity.lock; a cache de conteúdo é lida e preenchida como essa resolução a leria e preencheria. Um desvio, e um ficheiro de bloqueio em falta, fazem o pedido falhar. Não pode ser combinado com upgrade, targets ou pinSources, seja qual for o valor que pinSources contenha: um pedido que envie um deles ao lado dele é recusado como params inválidos antes de qualquer coisa ser resolvida.
pinSourcesbooleananãoSe deve executar o passo de fixação que aggrega/pin executa sobre as Recipes e as FeatureRecipes que a Release compila a partir dos diretórios de catálogo do espaço de trabalho, escrevendo o entity.lock ao lado de cada uma, em vez de recusar o pedido por causa de uma cujo bloqueio não regista uma fixação de que uma entrada precisa. Se ausente, segue o pin_sources_at_pull do espaço de trabalho; qualquer um dos dois valores substitui essa definição para este pedido.

Não são permitidas propriedades adicionais.

PinParams

Regista, no entity.lock ao lado de uma Recipe ou de uma FeatureRecipe, a fixação de conteúdo de cada entrada que a entidade lê de fora do seu próprio documento. Nenhuma Release é nomeada: uma entrada cuja identidade a entidade escreve por completo nomeia um único artefacto para cada Release que usa a entidade, pelo que nada do que uma Release fornece é necessário para a fixar. Alcança os hosts que as fontes da entidade nomeiam e escreve ao lado da entidade; o próprio documento da entidade nunca é escrito.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
entitystringnãoO documento de entidade a fixar, como caminho relativo à raiz do espaço de trabalho.
dryRunbooleananãoSe deve responder com o bloqueio que o passo escreveria em vez de o escrever. As entradas continuam a ser resolvidas, pelo que a cache de conteúdo continua a ser preenchida.

Não são permitidas propriedades adicionais.

CacheEvictParams

Recupera espaço do conteúdo em cache até que o que resta caiba abaixo de um tamanho que o pedido nomeia.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
maxSizestringnãoO tamanho até ao qual reduzir o espaço ocupado, escrito como uma pessoa o escreve — por exemplo 500MB.

Não são permitidas propriedades adicionais.

SearchParams

Pesquisa o que os índices locais dos registos configurados oferecem. Lê o índice já presente no disco e não contacta nenhum registo.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
querystringnãoO texto a comparar com o nome e a descrição de um registo.
kindsstring[]nãoOs tipos de entidade a manter. Vazio mantém todos os tipos.
selectorstringnãoUm seletor de etiquetas que os registos mantidos têm de satisfazer.
capabilitiesstring[]nãoAs capacidades que um registo de plugin mantido tem de declarar.
pluginTypestringnãoO tipo de plugin a manter.
registrystringnãoO único host de registo no qual pesquisar. Se ausente, pesquisa em cada host configurado.
limitintegernãoO número máximo de registos com que responder.
includeRetractedbooleananãoSe deve manter versões que um marcador publicado descontinuou.

Não são permitidas propriedades adicionais.

RegistryAddParams

Adiciona um registo e a política de confiança que a resolução aplica ao que ele serve. Escreve o ficheiro de configuração de toda a máquina, a menos que o pedido peça o contrário, pelo que cada espaço de trabalho da máquina resolve através da entrada.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
hoststringnãoO host de registo a adicionar.
namestringnãoUm alias amigável que é resolvido para o host.
identitiesstring[]nãoAs identidades de assinatura de confiança para o que este registo serve.
keyPathstringnãoO caminho de uma chave pública a considerar de confiança, para um registo assinado com uma chave e não com uma identidade keyless.
trustedRootstringnãoO caminho da âncora de confiança face à qual as assinaturas são verificadas.
requireSignaturesbooleananãoSe um artefacto deste registo tem de conter uma assinatura verificada. Se ausente, não declara nada e mantém em vigor a predefinição resolvida.
advisorybooleananãoSe uma verificação falhada é reportada em vez de interromper a execução.
fetchTrustbooleananãoSe deve ler a política de confiança que o registo anuncia e fixá-la. Se ausente, não declara nada e mantém em vigor a predefinição resolvida.
globalbooleananãoEscreve o ficheiro de configuração de toda a máquina, que é a predefinição própria deste método.
workspacebooleananãoEscreve o ficheiro de configuração próprio deste espaço de trabalho em vez do de toda a máquina.

Não são permitidas propriedades adicionais.

RegistryRemoveParams

Remove um registo adicionado. Escreve o ficheiro de configuração de toda a máquina, a menos que o pedido peça o contrário.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
registrystringnãoO registo a remover, por host ou por alias.
globalbooleananãoEscreve o ficheiro de configuração de toda a máquina, que é a predefinição própria deste método.
workspacebooleananãoEscreve o ficheiro de configuração próprio deste espaço de trabalho em vez do de toda a máquina.

Não são permitidas propriedades adicionais.

RegistryUpdateParams

Atualiza o índice local que uma pesquisa lê, alcançando o registo para o fazer. O que escreve é o índice sob o diretório de cache configurado próprio deste espaço de trabalho. Um registo que precise de uma credencial que nenhuma fonte do ambiente fornece é recusado com a credencial nomeada, em vez de a solicitar interativamente.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
registrystringnãoO único registo a atualizar. Se ausente, atualiza cada host configurado.
upgradebooleananãoSe deve reconstruir o índice em vez de acrescentar ao que ele já contém.

Não são permitidas propriedades adicionais.

LogoutParams

Remove uma credencial de registo armazenada. O armazenamento é partilhado por todos os projetos da máquina, e a resposta indica-o.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
registrystringnãoO registo cuja credencial armazenada se pretende remover.

Não são permitidas propriedades adicionais.

PublishEntityParams

Publica uma entidade num registo. O que deposita é o que todos os consumidores desse registo resolvem, e uma versão publicada não pode ser recolhida de quem já a obteve. Nada é pedido de forma interativa: a identidade resolve-se a partir do que o pedido forneceu ou do que o ambiente já contém.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
entitystringnãoO documento de entidade a publicar, como caminho relativo à raiz do espaço de trabalho.
registrystringnãoO registo no qual publicar. Se ausente, é usada a predefinição configurada.
dryRunbooleananãoSe deve reportar o que a publicação depositaria sem o depositar.
signbooleananãoSe deve assinar o que é publicado. Se ausente, não declara nada e mantém em vigor a predefinição resolvida.
pluginstringnãoO módulo de plugin a publicar juntamente com uma entidade Plugin.
fulcioUrlstringnãoA autoridade de certificação da qual obter um certificado de assinatura.
rekorUrlstringnãoO registo de transparência no qual registar a assinatura.
timestampUrlstringnãoA autoridade de carimbo temporal com a qual contra-assinar.
identityTokenstringnãoO token de identidade com o qual assinar, fornecido pelo chamador em vez de obtido num terminal.
pinSourcesbooleananãoSe deve executar na entidade, antes de ser empacotada, o passo de fixação que aggrega/pin executa, para que o entity.lock que o passo escreve ao lado dela faça parte do que é publicado. O passo é executado antes de qualquer recusa que avalie a entidade, e sob dryRun reporta o bloqueio que escreveria e não escreve nada. Se ausente, segue o pin_sources_at_push do espaço de trabalho; qualquer um dos dois valores substitui essa definição para este pedido.

Não são permitidas propriedades adicionais.

PublishArtifactParams

Publica um ficheiro arbitrário num registo sob um nome e uma tag que o pedido lhe atribui.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
filestringnãoO ficheiro a publicar, como caminho relativo à raiz do espaço de trabalho.
namestringnãoO nome do repositório sob o qual publicar.
tagstringnãoA tag sob a qual publicar.
mediaTypestringnãoO tipo de média a registar para os bytes publicados.
registrystringnãoO registo no qual publicar. Se ausente, é usada a predefinição configurada.
dryRunbooleananãoSe deve reportar o que a publicação depositaria sem o depositar.

Não são permitidas propriedades adicionais.

SignArtifactsParams

Assina o que já está publicado. Uma assinatura não pode ser recolhida de quem já a obteve.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
referencesstring[]nãoAs referências publicadas a assinar.
fulcioUrlstringnãoA autoridade de certificação da qual obter um certificado de assinatura.
rekorUrlstringnãoO registo de transparência no qual registar a assinatura.
timestampUrlstringnãoA autoridade de carimbo temporal com a qual contra-assinar.
identityTokenstringnãoO token de identidade com o qual assinar, fornecido pelo chamador em vez de obtido num terminal.
jobsintegernãoQuantas referências são assinadas em simultâneo. Se ausente, são assinadas uma após a outra. Cada referência continua a ser assinada exatamente como seria sozinha — em modo keyless, com o seu próprio certificado e a sua própria entrada no registo de transparência — e a resposta mantém a ordem pela qual as referências foram indicadas. Mínimo: 1.

Não são permitidas propriedades adicionais.

DeprecateArtifactParams

Marca uma versão publicada como descontinuada, para que a resolução a possa reportar ou recusar. O marcador é ele próprio publicado e assinado. Um pedido envia ou uma referência com o seu conteúdo, ou um ficheiro de lote cujas entradas contêm o seu próprio — nunca ambos, e nunca conteúdo ao lado do ficheiro de lote.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
referencestringnãoA referência publicada a marcar. Uma alternativa a from: um pedido que contenha ambos é recusado.
severityconst “warning” ou const “error” ou const “retracted”nãoCom que força o marcador se pronuncia — se a resolução reporta a versão ou a recusa. Obrigatório com reference; recusado ao lado de from, cujo ficheiro de lote contém o próprio de cada marcador. Valores permitidos: "warning" — Descontinuada, no mais brando dos dois níveis consultivos: continua a ser selecionada quando se escolhe uma versão. "error" — Descontinuada, no mais forte dos dois níveis consultivos: continua a ser selecionada quando se escolhe uma versão. "retracted" — Retirada: excluída quando se escolhe uma versão.
reasonstringnãoPor que razão a versão está descontinuada. Obrigatório com reference; recusado ao lado de from, cujo ficheiro de lote contém o próprio de cada marcador.
replacementstringnãoA referência a usar em vez desta. Recusado ao lado de from, cujo ficheiro de lote contém o próprio de cada marcador.
messagestringnãoO que é comunicado a um consumidor que encontre o marcador. Recusado ao lado de from, cujo ficheiro de lote contém o próprio de cada marcador.
fromstringnãoUm ficheiro de lote de entradas de retirada, como caminho relativo à raiz do espaço de trabalho, que anexa um marcador por entrada. Cada entrada contém a sua própria referência, a sua própria severidade e o seu próprio motivo, e opcionalmente uma substituição e uma mensagem. Uma alternativa a reference: um pedido que contenha ambos, ou que contenha ao lado dele uma severidade, um motivo, uma substituição ou uma mensagem, é recusado.
fulcioUrlstringnãoA autoridade de certificação da qual obter um certificado de assinatura.
rekorUrlstringnãoO registo de transparência no qual registar a assinatura.
timestampUrlstringnãoA autoridade de carimbo temporal com a qual contra-assinar.
identityTokenstringnãoO token de identidade com o qual assinar, fornecido pelo chamador em vez de obtido num terminal.

Não são permitidas propriedades adicionais.

ResolveParams

Responde onde está definido o elemento sob o cursor.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
uristringnãoO documento em que o cursor se encontra.
positionPositionnãoUm ponto num documento: uma linha e um deslocamento de carácter dentro dela, ambos contados a partir de zero. O deslocamento é medido nas unidades da codificação que a sessão acordou ao ser aberta, que é UTF-16, a menos que o cliente tenha pedido outra.
releasestringnãoA Release em cujos termos responder, como caminho relativo à raiz do espaço de trabalho. A definição é então o documento para o qual a referência se resolve através dos diretórios de catálogo que a configuração do espaço de trabalho atribui a essa Release, por essa ordem, pelo que um nome que várias variantes num mesmo espaço de trabalho declaram, uma por Release, leva à variante dessa Release; quando esses diretórios não declaram nenhuma entidade desse tipo, são pesquisados os documentos do espaço de trabalho, deixando de fora os que estejam sob um dos diretórios de catálogo do espaço de trabalho que a Release não lê. Se ausente, são pesquisados primeiro os documentos do espaço de trabalho, e os diretórios de catálogo próprios do espaço de trabalho apenas quando nenhum documento declara o nome. Um valor que não nomeie nenhum ficheiro de Release é recusado.

Não são permitidas propriedades adicionais.

FindReferencesParams

Responde onde se faz referência ao elemento sob o cursor.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
uristringnãoO documento em que o cursor se encontra.
positionPositionnãoUm ponto num documento: uma linha e um deslocamento de carácter dentro dela, ambos contados a partir de zero. O deslocamento é medido nas unidades da codificação que a sessão acordou ao ser aberta, que é UTF-16, a menos que o cliente tenha pedido outra.
releasestringnãoA Release em cujos termos responder, como caminho relativo à raiz do espaço de trabalho. Uma referência feita num documento sob um dos diretórios de catálogo do espaço de trabalho que a Release não lê não é então reportada, pelo que as variantes que um espaço de trabalho mantém lado a lado, uma por Release, nunca são reportadas como referências umas das outras. Se ausente, é pesquisado cada documento do espaço de trabalho. Um valor que não nomeie nenhum ficheiro de Release é recusado.

Não são permitidas propriedades adicionais.

FindImplementationsParams

Responde que documentos implementam o elemento sob o cursor.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
uristringnãoO documento em que o cursor se encontra.
positionPositionnãoUm ponto num documento: uma linha e um deslocamento de carácter dentro dela, ambos contados a partir de zero. O deslocamento é medido nas unidades da codificação que a sessão acordou ao ser aberta, que é UTF-16, a menos que o cliente tenha pedido outra.
releasestringnãoA Release em cujos termos responder, como caminho relativo à raiz do espaço de trabalho. Um documento sob um dos diretórios de catálogo do espaço de trabalho que a Release não lê não é então reportado, pelo que uma variante com que outra Release é compilada nunca é listada entre as desta Release. Se ausente, é pesquisado cada documento do espaço de trabalho. Um valor que não nomeie nenhum ficheiro de Release é recusado.

Não são permitidas propriedades adicionais.

HoverParams

Responde com o que mostrar sobre o elemento sob o cursor.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
uristringnãoO documento em que o cursor se encontra.
positionPositionnãoUm ponto num documento: uma linha e um deslocamento de carácter dentro dela, ambos contados a partir de zero. O deslocamento é medido nas unidades da codificação que a sessão acordou ao ser aberta, que é UTF-16, a menos que o cliente tenha pedido outra.
releasestringnãoA Release em cujos termos responder, como caminho relativo à raiz do espaço de trabalho. A entidade mostrada é então aquela para a qual a referência se resolve através dos diretórios de catálogo que a configuração do espaço de trabalho atribui a essa Release, por essa ordem; quando esses diretórios não declaram nenhuma entidade desse tipo, são pesquisados os documentos do espaço de trabalho, deixando de fora os que estejam sob um dos diretórios de catálogo do espaço de trabalho que a Release não lê. Se ausente, são pesquisados primeiro os documentos do espaço de trabalho, e os diretórios de catálogo próprios do espaço de trabalho apenas quando nenhum documento declara o nome. Um valor que não nomeie nenhum ficheiro de Release é recusado.

Não são permitidas propriedades adicionais.

CompletionParams

Responde com o que pode ser escrito na posição do cursor.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
uristringnãoO documento em que o cursor se encontra.
positionPositionnãoUm ponto num documento: uma linha e um deslocamento de carácter dentro dela, ambos contados a partir de zero. O deslocamento é medido nas unidades da codificação que a sessão acordou ao ser aberta, que é UTF-16, a menos que o cliente tenha pedido outra.
contextCompletionContextnãoO que causou o pedido, quando o cliente o acompanha.
releasestringnãoA Release em cujos termos responder, como caminho relativo à raiz do espaço de trabalho. Os nomes oferecidos são então os que os documentos do espaço de trabalho declaram, menos os documentos sob um dos diretórios de catálogo do espaço de trabalho que a Release não lê, juntamente com os Components e as Features que os diretórios de catálogo atribuídos a essa Release pela configuração do espaço de trabalho declaram. Se ausente, são os documentos do espaço de trabalho e os Components e as Features que os seus próprios diretórios de catálogo declaram. Um valor que não nomeie nenhum ficheiro de Release é recusado.

Não são permitidas propriedades adicionais.

CompletionContext

O que causou o pedido, quando o cliente o acompanha.

PropriedadeTipoObrigatóriaDescrição
triggerKindintegernãoPor que razão foi pedido o preenchimento automático.
triggerCharacterstringnãoO carácter que o causou, quando foi um carácter.

São permitidas propriedades adicionais.

AttachCandidatesParams

Responde que Features podem ser anexadas a uma entidade, avaliadas face às etiquetas dessa entidade, e, para uma ligação que o componente de um nó do grafo traça, quais podem preencher cada slot que o socket da ligação declara.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
nodestringnãoA entidade face à qual avaliar os candidatos, por nome, lida a partir do que os documentos do espaço de trabalho declaram.
graphNodestringnãoO nó do grafo face ao qual avaliar os candidatos, cujas etiquetas são o conjunto finalizado com que a própria compilação avalia a aplicabilidade. Uma resposta calculada sobre ele diz o que a compilação fará.
releasestringnãoA Release a cujo grafo o nó pertence, como caminho relativo à raiz do espaço de trabalho. Os candidatos são então obtidos nos termos dessa Release: as Features que os diretórios de catálogo atribuídos a essa Release pela configuração do espaço de trabalho declaram, e os documentos do espaço de trabalho menos os que estejam sob um dos diretórios de catálogo do espaço de trabalho que a Release não lê, pelo que uma Feature mantida para outra Release nunca é oferecida para um nó do grafo desta.
labelsmapa de stringnãoEtiquetas face às quais avaliar diretamente, em vez de as ler de uma entidade ou de um nó do grafo.
connectionConnectionCoordinatenãoUma ligação que o componente do nó nomeado por graphNode traça, para a qual responder além desse nó: a resposta contém então também slots, cada slot que o socket da ligação declara com as Features que o podem preencher, ou noSlotReason quando nenhum slot pode ser preenchido. Só é enviada com graphNode e release, porque uma ligação só existe num grafo compilado; enviada com node ou labels, é recusada. Os candidatos ao lado dela mantêm o seu significado, as Features que se podem anexar ao próprio nó. O seu documento é aceite e não altera esta resposta: os slots são os do socket e os candidatos os das Features, os mesmos seja qual for o documento em que um anexo é escrito.

Não são permitidas propriedades adicionais.

ConnectionCandidatesParams

Responde a que entidades um socket de uma entidade pode ser ligado.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
nodestringnãoA entidade sobre cujos sockets se pergunta.
socketstringnãoO único socket para o qual responder. Se ausente, responde para cada socket que a entidade declara.

Não são permitidas propriedades adicionais.

InsertionPointParams

Responde onde, num documento, pertence uma nova entrada sob um contentor nomeado, deixando a composição e a aplicação da entrada ao chamador que detém o buffer.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
filestringnãoO documento sobre o qual responder.
containerstring[]nãoO caminho através do documento até ao contentor sob o qual a entrada pertence.

Não são permitidas propriedades adicionais.

AttachmentContainerParams

Responde em que documento, e em que ponto dele, pertence um anexo num nó do grafo, ou numa ligação que o seu componente traça.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
graphNodestringnãoO nó do grafo ao qual o anexo se destina.
releasestringnãoA Release a cujo grafo o nó pertence, como caminho relativo à raiz do espaço de trabalho.
connectionConnectionCoordinatenãoUma ligação que o componente do nó do grafo traça, quando o anexo é para essa ligação e não para o nó: a resposta nomeia então o contentor features próprio da ligação no documento que o seu campo document nomeia, um campo aqui obrigatório. No Aggregate, é a entrada da ligação no documento em que o nó foi escrito, recusada para uma ligação que a Release traçou, para a qual o Aggregate não contém nenhuma entrada. Na Release, é a entrada por aresta sob a entrada própria da Release para o nó, quer a Release já escreva uma para essa ligação quer não, recusada quando a Release não escreve nenhuma entrada para o nó. Uma ligação que uma Feature traçou é recusada em qualquer um dos documentos, porque um anexo só é escrito numa ligação que um componente ou a Release traça.

Não são permitidas propriedades adicionais.

ConnectionAtPositionParams

Responde dentro da entrada de que ligação cai uma posição num Aggregate ou numa Release: o nó do grafo e a ligação, nos termos em que os pedidos de candidatura e de contentor os recebem, ou porque é que nenhuma ligação está escrita aí. As entradas são aquelas em que um anexo é escrito — a entrada com que um componente traça uma ligação, sob o alias da ligação, no documento em que o componente foi escrito, e cada entrada por aresta que a Release escreve —, cada uma onde o grafo compilado a regista, pelo que se uma chave é uma ligação nunca é deduzido da forma como se chama.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
filestringnãoO documento em que a posição se encontra: a Release, ou um documento em que o grafo da Release regista componentes como escritos — o seu Aggregate, ou o documento de um módulo que esse Aggregate importa. É lido primeiro a partir do que a sessão guarda para ele, e caso contrário a partir do disco.
positionPositionnãoUm ponto num documento: uma linha e um deslocamento de carácter dentro dela, ambos contados a partir de zero. O deslocamento é medido nas unidades da codificação que a sessão acordou ao ser aberta, que é UTF-16, a menos que o cliente tenha pedido outra.
releasestringnãoA Release cujo grafo compilado regista as ligações, como caminho relativo à raiz do espaço de trabalho. É obrigatória também para uma posição no Aggregate, porque um nó do grafo e uma ligação só existem num grafo compilado.

Não são permitidas propriedades adicionais.

ConnectionCoordinate

Uma ligação que o componente de um nó do grafo traça, endereçada pelo socket através do qual está ligada e pelo alias que tem nesse socket, e o documento em que um anexo nela é escrito. Uma ligação contém anexos que preenchem os slots que o seu socket declara, e tanto o Aggregate como a Release os podem escrever.

PropriedadeTipoObrigatóriaDescrição
socketstringsimO socket de dependência através do qual a ligação está ligada.
aliasstringsimO nome que a ligação tem dentro do seu socket.
documentconst “aggregate” ou const “release”nãoO documento em que um anexo na ligação é escrito. O conjunto é fechado, e um valor fora dele é recusado. Valores permitidos: "aggregate" — O Aggregate, onde o programador escreve um anexo na entrada da ligação. "release" — A Release, onde o operador escreve um anexo na entrada por aresta da ligação.

São permitidas propriedades adicionais.

SetActiveReleaseParams

Regista uma Release como a predefinida do espaço de trabalho escrevendo um marcador no diretório .aggrega: a escolha que aggrega/activeRelease reporta lê esse marcador depois da Release de authoring da configuração. O marcador é escrito dentro do espaço de trabalho e em nenhum outro lugar: quando o diretório .aggrega ou o marcador é um link que conduz para fora do espaço de trabalho, exista ou não já o local para onde conduz, a escrita é recusada nomeando o link e nada é escrito. A resposta é a que aggrega/activeRelease dá depois de o marcador ser escrito, pelo que nomeia uma Release diferente quando a Release de authoring da configuração tem precedência sobre o marcador.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
releasestringnãoA Release a registar, como caminho relativo à raiz do espaço de trabalho. Um caminho absoluto, e um que sobe para fora do espaço de trabalho, são recusados; tal como um que sai dele através de um link, a menos que a configuração do espaço de trabalho nomeie essa Release.

Não são permitidas propriedades adicionais.

EditDocumentParams

Aplica uma única edição delimitada a um documento que o espaço de trabalho contém: uma entrada acrescentada sob um contentor, ou um escalar definido. O documento composto é verificado face ao esquema do seu tipo e só chega ao disco se a verificação passar, pelo que isto não pode escrever o que o esquema de authoring recusa. Uma edição recusada deixa o ficheiro byte a byte como estava.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
filestringnãoO documento a editar.
editconst “add-component” ou const “attach-feature” ou const “wire-edge” ou const “set-value”nãoQue edição aplicar. Valores permitidos: "add-component" — Acrescenta uma instância de componente sob um contentor components: name é o nome da instância, value o Component que pede. "attach-feature" — Anexa uma Feature ao nó que o pedido nomeia: name é o nome de instância do anexo, value a Feature que pede. "wire-edge" — Estabelece uma ligação de dependência a partir do nó que o pedido nomeia, dentro de socket: name é o alias pelo qual a ligação é endereçada, value o nó para o qual aponta. "set-value" — Define um valor no nó que o pedido nomeia: name é a chave do valor, value um escalar.
nodestring[]nãoO caminho através do documento até à entrada que está a ser editada.
socketstringnãoO socket de que trata a edição, para uma edição que liga um.
namestringnãoO nome que a edição escreve.
valueanynãoO valor que a edição escreve, na forma que a edição assumir.
dryRunbooleananãoSe deve responder com o documento composto em vez de o escrever.

Não são permitidas propriedades adicionais.

ConfigInitParams

Inicializa um documento de configuração. Escreve por predefinição o ficheiro de toda a máquina, uma vez que um registo e as identidades fidedignas nele são ferramentas de toda a máquina. Contacta o registo nomeado para ler a política de confiança que este anuncia; um registo que não anuncia nada é reportado como tal e a inicialização prossegue, sobre a base de referência incorporada para o hub oficial e sem nenhuma política para qualquer outro registo.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
registrystringnãoO registo para o qual inicializar a configuração.
forcebooleananãoSe deve substituir um documento de configuração que já exista.
globalbooleananãoEscreve o ficheiro de configuração de toda a máquina, que é a predefinição própria deste método.
workspacebooleananãoEscreve o ficheiro de configuração próprio deste espaço de trabalho em vez do de toda a máquina.
dryRunbooleananãoSe deve responder com o conteúdo do documento em vez de o escrever, para um cliente que mantém o seu próprio modelo de documento.

Não são permitidas propriedades adicionais.

ConfigCaptureParams

Congela a configuração resolvida no documento próprio deste espaço de trabalho, para que o espaço de trabalho seja autossuficiente. Escreve sempre o ficheiro desse espaço de trabalho e não alcança nada fora dele.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
allPluginsbooleananãoSe deve congelar cada plugin anexado em vez de apenas os que o próprio espaço de trabalho configurou.

Não são permitidas propriedades adicionais.

ImportParams

Converte uma descrição de fonte externa em documentos de authoring em rascunho, e escreve ao lado deles .aggrega-import.json, o registo daquilo que a importação escreveu — o destino que lhe foi dado, quando lhe foi dado um, o snapshot do catálogo que leu, quando leu um, cada ficheiro redigido e cada chave de um Aggregate ou de uma Release redigidos a qualquer profundidade —, que uma sincronização posterior lê. Uma fonte que não conseguiu converter por completo é uma resposta e não uma falha: os rascunhos que produziu são escritos e as conclusões dizem o que não conseguiu converter — exceto sob sync, que não escreve nada a partir de uma conversão que parou.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
sourcestringnãoO ficheiro ou o diretório a converter, como caminho absoluto ou relativo à raiz do espaço de trabalho; um pedido sem ele é recusado. É lido onde está, dentro do espaço de trabalho ou não, e um diretório é lido nos ficheiros dele que os padrões de ficheiro declarados do importador selecionam.
outputDirstringnãoO diretório sob o espaço de trabalho no qual escrever os rascunhos, relativo à raiz do espaço de trabalho; um valor absoluto, ou um que saia do espaço de trabalho tal como está escrito ou através de um link, é recusado. Se ausente, escreve sob a raiz do espaço de trabalho, onde escreve a mesma conversão executada num terminal sem nomear nenhum destino. Cada caminho redigido é relativo ao diretório que a resposta nomeia como outputDir, também sob dryRun.
formatstringnãoO formato da fonte. Se ausente, a conversão determina-o.
targetstringnãoUma capacidade do fornecedor, como compose ou helm — a palavra à qual o spec.capability de uma Recipe se associa —, para a qual redigir um Manifest ao lado dos rascunhos, como manifest.yaml: cada tipo de componente e tipo de funcionalidade de que os rascunhos precisam, incluídos os tipos de um Aggregate do catálogo que o redigido compõe, é mapeado para a Recipe ou receita de funcionalidade dessa capacidade que o catálogo do espaço de trabalho oferece para ele — a que existe, ou entre várias a que tem o nome do tipo —; um tipo sem nenhuma, ou com várias e nenhuma com esse nome, fica sem mapeamento com uma conclusão de aviso que o nomeia; um mapeamento que um importador redigiu por si próprio é mantido onde o catálogo o oferece para esse tipo e essa capacidade e, caso contrário, descartado com uma conclusão de aviso; e o spec.manifest da Release redigida é definido como o Manifest. Uma capacidade à qual nenhuma Recipe do catálogo se associa é recusada antes de a conversão ser executada, e nada é escrito. Se ausente, nenhum Manifest é redigido, exceto sob sync, que redige para o destino que o registo da importação anterior nomeia; uma sincronização que nomeia um destino redige para ele, e o registo passa então a nomeá-lo.
dryRunbooleananãoSe deve responder com o conteúdo de cada ficheiro que o pedido escreveria em vez de o escrever. Todo o outro comportamento é o da escrita, pelo que um pedido que a escrita recusaria é recusado também neste caso; com sync, responde com o que a sincronização escreveria e com cada parte que sofreria desvio.
syncbooleananãoSe deve atualizar face à fonte aquilo que uma importação anterior redigiu sob outputDir, em vez de escrever o rascunho por inteiro. Só muda o que a importação escreveu, tal como o registo ao lado dos rascunhos o lista: uma parte que a fonte deixou intacta fica como está no disco, editada ou não; uma parte que a fonte alterou, descartou ou ganhou é escrita de novo, removida — um ficheiro redigido apagado por inteiro — ou acrescentada, quando o que está no disco é o que a importação escreveu por último; e tudo o resto, uma chave que um autor acrescentou — entre elas o ambiente que uma Release redigida deixa ao seu autor — ou um comentário não escrito diretamente acima de uma chave redigida, fica igual byte a byte. Uma sincronização que alteraria ou removeria o que um autor editou ou acrescentou, ou acrescentaria uma parte onde um autor já escreveu uma, é recusada nomeando cada parte, tal como uma sincronização sobre um Aggregate que nenhum registo lista; nada é escrito em nenhum dos casos. Sem este campo, um pedido cujos rascunhos seriam escritos sobre um Aggregate já presente em outputDir é recusado, também sob dryRun.
upgradebooleananãoSe deve obter o snapshot do catálogo mais recente que o registo predefinido do espaço de trabalho publica e importar com base nele, guardando-o a partir daí em vez daquele que o espaço de trabalho guarda ou daquele que o registo ao lado dos rascunhos indica; não altera nada onde o espaço de trabalho indica uma pasta de catálogo, e é recusado sem ligação à rede.
answersstringnãoO ficheiro de respostas do qual são lidos, e no qual são escritos, os valores que os rascunhos deixam vazios e que nenhuma origem pode conter, relativo à raiz do espaço de trabalho; um valor absoluto, ou um que sai do espaço de trabalho tal como escrito ou através de uma ligação, é recusado. Contém, sob o caminho de cada ficheiro redigido, o caminho da chave dentro desse documento e a sua resposta, e as respostas são escritas nos rascunhos. Se ausente, é lido o que o registo ao lado dos rascunhos indica, ou então import-answers.yaml ao lado do ficheiro de origem ou dentro do diretório de origem. A resposta de um segredo indica de onde provém o segredo — um nome de variável, ${NAME}, ou o nome de um Kubernetes Secret — e qualquer outra coisa é recusada sem que nada seja escrito. Nada é perguntado: cada valor ainda em falta é uma entrada de owed da resposta e uma conclusão de aviso que indica o ficheiro redigido, a chave e o que ela é, a sua resposta é enviada como answered, e onde os rascunhos são escritos a última conclusão indica quantos estão em falta e onde. Quando os rascunhos incluem uma Release, não têm nada em falta e a conversão terminou, as suas dependências são então obtidas, escrevendo o seu lockfile, e um pull que falha encerra as conclusões indicando porquê, com os rascunhos escritos; sem ligação nada é obtido e uma conclusão indica o pull a executar. Uma resposta para uma chave que estes rascunhos não deixam vazia é mantida no ficheiro e não aplicada, pelo que um único ficheiro de respostas serve todos os destinos.
answeredImportAnswered[]nãoRespostas para valores que owed da resposta listou, cada uma indicando o ficheiro redigido e as chaves tal como owed as indicou. Cada uma é avaliada, mantida no ficheiro de respostas e escrita nos rascunhos exatamente como uma resposta introduzida num terminal: a resposta de um segredo indica de onde provém o segredo — um nome de variável, ${NAME}, ou o nome de um Kubernetes Secret — e uma que não o faça não é mantida nem escrita, ficando o seu valor em falta com o motivo como o seu secretAdvice. Um valor a que o ficheiro de respostas já responde é respondido a partir do ficheiro; uma resposta vazia, ou uma que indique um valor que os rascunhos não têm em falta, não é aplicada. Envie-a com sync depois de os rascunhos serem escritos, uma vez que um pedido que não seja um sync é recusado sobre um Aggregate já presente em outputDir. Sob dryRun, que não mantém nenhuma resposta, e sob um sync cuja conversão parou, que não escreve nada, nenhuma resposta enviada é aplicada.

Não são permitidas propriedades adicionais.

ScaffoldEntityParams

Redige um documento inicial para um tipo de entidade, ou escreve um dos exemplos executáveis da documentação num novo diretório do espaço de trabalho, ou lista-os. A redação deriva o esqueleto do conjunto de esquemas que o binário contém, pelo que nada é lido de um espaço de trabalho e nada é escrito — a resposta é texto, e o destino que lhe é dado cabe ao cliente. Escrever um exemplo escreve o novo diretório e nada mais, e os exemplos são lidos do bundle de documentação assinado publicado para a versão do binário, ou do mais recente publicado antes dela quando não existe nenhum, verificado face à política de assinatura do espaço de trabalho antes de ser guardado ou lido: um bundle que não passa na verificação é recusado, e offline só é lida uma cópia já em cache. Um pedido que envie em conjunto os campos de duas formas — kind com example ou list, list com example, name com example ou list, dir sem example — é recusado antes de qualquer coisa ser lida.

PropriedadeTipoObrigatóriaDescrição
workspaceRootstringnãoO caminho absoluto do espaço de trabalho. A redação não o lê. Escrever ou listar um exemplo exige-o: a configuração do espaço de trabalho decide de onde a documentação é obtida e que assinaturas tem de conter, e um exemplo é escrito dentro dele.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
kindstringnãoO tipo de entidade a redigir, nomeado pelo seu token em minúsculas, como component, aggregate, release, recipe ou featurerecipe — o token que aggrega/getSchema lista para ele.
namestringnãoO nome a escrever no documento redigido. Enviado apenas com kind.
examplestringnãoO exemplo executável a escrever, pelo nome que a lista de exemplos lhe dá. Enviado em vez de kind.
listbooleananãoSe deve responder com cada exemplo executável que a documentação publica, sem escrever nada. Enviado sem example e sem kind.
dirstringnãoO novo diretório no qual escrever o exemplo, relativo à raiz do espaço de trabalho; se ausente, é escrito aí num diretório com o nome do exemplo. Não pode existir ainda ou tem de estar vazio: um que contenha alguma coisa é recusado e deixado como está, e um valor absoluto, ou um que saia do espaço de trabalho tal como está escrito ou através de um link, é recusado antes de qualquer coisa ser lida. Enviado apenas com example.

Não são permitidas propriedades adicionais.

LintParams

Verifica as convenções de publicação do catálogo numa única entidade, em tudo o que o fecho de uma Release alcança, ou em tudo o que está sob os diretórios de catálogo configurados. Nada é escrito em nenhum modo. Não nomear nem uma entidade nem uma Release verifica o catálogo inteiro: num espaço de trabalho cuja configuração não dá a nenhuma Release diretórios de catálogo próprios, uma vez sobre os diretórios do espaço de trabalho; num espaço de trabalho que nomeia Releases sob workspace.releases, uma vez para cada Release sobre os diretórios que essa Release lê, nunca sobre todos em conjunto.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
entitystringnãoO único documento de entidade a verificar.
releasestringnãoA Release cujo fecho verificar, como caminho relativo à raiz do espaço de trabalho.
prePublishbooleananãoSe deve comparar cada entidade com a sua versão publicada anteriormente, o que alcança os registos configurados.

Não são permitidas propriedades adicionais.

PluginAddParams

Anexa um plugin a um socket que o espaço de trabalho configura. Alcança um registo para resolver a consulta num único plugin e fixar uma versão. A única decisão que um terminal obteria — aceitar as capacidades declaradas de um plugin de extensão de comandos — chega aqui como um campo, pelo que o cliente pergunta a quem o estiver a conduzir e esta superfície nunca espera por um prompt.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
typestringnãoO socket ao qual o plugin se anexa.
querystringnãoO que resolver num único plugin.
capabilitystringnãoA capacidade a que o anexo se destina, quando o socket contém várias.
rolestringnãoO papel em que o anexo é executado, o que determina o que pode emitir.
globalbooleananãoEscreve o ficheiro de configuração de toda a máquina.
workspacebooleananãoEscreve o ficheiro de configuração próprio deste espaço de trabalho.
acceptCapabilitiesbooleananãoSe o chamador aceita as capacidades que um plugin de extensão de comandos declara.
dryRunbooleananãoSe deve responder com o conteúdo do documento de configuração em vez de o escrever.

Não são permitidas propriedades adicionais.

PluginRemoveParams

Desanexa um plugin de um socket que o espaço de trabalho configura.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
typestringnãoO socket ao qual o plugin está anexado.
querystringnãoQue anexo remover.
globalbooleananãoEscreve o ficheiro de configuração de toda a máquina.
workspacebooleananãoEscreve o ficheiro de configuração próprio deste espaço de trabalho.

Não são permitidas propriedades adicionais.

PluginSyncParams

Alinha os registos geridos pela máquina de uma entidade Plugin com o módulo para o qual ela aponta. Reescreve esses registos e mantém inalterado cada outro byte do documento.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
entitystringnãoO documento da entidade Plugin a alinhar.
pluginstringnãoO módulo de plugin do qual ler os registos.

Não são permitidas propriedades adicionais.

PluginGenCatalogParams

Gera documentos de catálogo Plugin a partir dos metadados declarados do próprio plugin mais um overlay escrito pelo autor. Regenerar sobre entradas inalteradas produz documentos idênticos byte a byte.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
fromEmbeddedbooleananãoSe deve ler os metadados dos plugins que o binário já contém.
pluginstringnãoO módulo de plugin do qual ler os metadados.
outputDirstringnãoO diretório sob o espaço de trabalho no qual escrever os documentos.
overlaystringnãoO documento escrito pelo autor cujo conteúdo é fundido sobre os metadados gerados.
dryRunbooleananãoSe deve responder com o conteúdo dos documentos em vez de os escrever.

Não são permitidas propriedades adicionais.

ExplainErrorParams

Expande um código que uma conclusão continha naquilo que o compilador declara sobre essa condição e nas entradas publicadas que ensinam a correção de authoring. Obtém a documentação publicada quando o espaço de trabalho não tem uma cópia; se não a conseguir obter, responde ainda assim com o que o binário declara, e diz porque é que o texto explicativo está em falta.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
codestringnãoA condição a expandir, nomeada pelo código que uma conclusão continha ou pelo seu código curto.

Não são permitidas propriedades adicionais.

GetSchemaParams

Responde com o esquema de um tipo, ou — quando nenhum tipo é nomeado — com os tipos que podem ser nomeados. Responde pelo binário em execução e não por qualquer cópia instalada noutro local, pelo que não precisa de nenhum espaço de trabalho e não lê nenhum.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootAcceptednãoO caminho absoluto de um espaço de trabalho. O sujeito deste método não é um espaço de trabalho — responde a partir daquilo que o próprio binário contém — pelo que o campo é aceite e não lido. É admitido porque um cliente pode enviá-lo de forma uniforme em cada pedido sem ter de saber que métodos o consultam.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
kindstringnãoO tipo cujo esquema devolver na resposta. Se ausente, responde em vez disso com os tipos que podem ser nomeados.

Não são permitidas propriedades adicionais.

SkillsInstallParams

Escreve a skill de assistente incorporada no binário na pasta de skills de cada assistente que o pedido nomeia ou, para um pedido global que não nomeia nenhum, de cada assistente encontrado nesta máquina. Sem global, escreve a pasta de projeto de cada assistente dentro do espaço de trabalho que o pedido nomeia, e cada caminho que aí escreveria fica restrito a esse espaço de trabalho; com global, escreve a pasta por utilizador de cada assistente sob o diretório pessoal. Cada destino é verificado antes de qualquer coisa ser escrita, pelo que uma recusa deixa cada pasta como estava.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual este pedido atua. É o sujeito do pedido: o daemon resolve-o antes de o método ser executado, e um pedido que o omita ou o escreva como algo diferente de uma cadeia de caracteres é recusado.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. É devolvido inalterado em cada notificação, pelo que um chamador pode compará-lo com o valor que enviou. É aceite em cada pedido, e um pedido que envie um numa sessão que não declarou nenhuma capacidade de progresso é recusado.
agentsstring[]nãoOs assistentes para os quais instalar a skill, pelos identificadores que a listagem reporta. Um pedido de projeto que não nomeie nenhum é recusado. Um pedido global que não nomeie nenhum instala a skill para os assistentes encontrados nesta máquina, cada um cuja pasta de configuração está no diretório pessoal ou cujo comando está no PATH, e é recusado sem nada escrito quando não é encontrado nenhum. Um identificador para o qual não se conhece nenhuma pasta de skills é recusado, pelo nome, e um identificador indicado duas vezes é instalado uma vez.
globalbooleananãoEscreve a pasta de skills por utilizador de cada assistente sob o diretório pessoal, que este lê em cada projeto, em vez da sua pasta de projeto no espaço de trabalho.

Não são permitidas propriedades adicionais.

ServerCapabilities

O que o daemon fará nesta sessão, acertado face ao que o cliente disse conseguir tratar.

PropriedadeTipoObrigatóriaDescrição
positionEncodingstringsimA codificação em que cada posição nesta sessão é expressa.
workDoneProgressbooleananãoSe o daemon enviará notificações de progresso nesta sessão. Presente apenas quando o cliente declarou que as pode receber.

Não são permitidas propriedades adicionais.

ClosureEntity

Uma entidade de que uma Release depende, na versão que a resolução determinou.

PropriedadeTipoObrigatóriaDescrição
uristringsimA referência a partir da qual a entidade é resolvida.
versionstringsimA versão que foi determinada.
kindstringnãoO tipo de entidade.
sourcestringnãoDe onde a execução que produziu esta entrada tirou a entidade, com a mesma palavra que aggrega pull --detail imprime para ela: fetched-fresh (obtida de um registo durante essa execução), cache-reuse (uma cópia já na cache, reutilizada sem ser obtida), local (encontrada no sistema de ficheiros local, como um diretório de catálogo), in-binary (a cópia dentro do binário do compilador) ou external (o Aggregate ou o Manifest próprio da Release, lido do ficheiro ou da entrada que a Release nomeia em vez de resolvido como uma das suas dependências; um Aggregate que a execução obteve de um registo é antes fetched-fresh). Presente nas entradas do relatório de uma resolução de dependências, onde descreve o que essa execução fez nesta máquina, e ausente de uma listagem das dependências resolvidas de uma Release, que descreve aquilo de que a Release depende. O ficheiro de bloqueio não regista nenhuma origem. Omitido para uma entidade cuja origem a execução não registou.

Não são permitidas propriedades adicionais.

ToolchainCorePlugin

Um plugin que o próprio compilador contém, e a versão dele que foi usada.

PropriedadeTipoObrigatóriaDescrição
pluginstringsimA referência do plugin.
versionstringsimA versão que foi usada.

Não são permitidas propriedades adicionais.

ToolchainReport

O compilador que fez a resolução, e os plugins que contém.

PropriedadeTipoObrigatóriaDescrição
compilerVersionstringsimA versão do compilador que fez a resolução.
corePluginsToolchainCorePlugin[]nãoOs plugins que o compilador contém, com a versão de cada um que foi usada.

Não são permitidas propriedades adicionais.

DependencyResolutionReport

O que uma resolução de dependências fixou e obteve.

PropriedadeTipoObrigatóriaDescrição
lockfilestringsimO ficheiro de bloqueio que a resolução escreveu, ou aquele com o qual uma verificação comparou.
verifiedbooleananãoSe o pedido foi uma verificação, que comparou o ficheiro de bloqueio registado e não escreveu nenhum ficheiro de bloqueio, registo de confiança de plugins nem entity.lock.
entitiesClosureEntity[] ou nullsimAs entidades que a resolução fixou, ou que uma verificação comparou.
librariesClosureEntity[] ou nullsimAs bibliotecas que a resolução fixou, ou que uma verificação comparou.
pluginsClosureEntity[] ou nullsimOs plugins que a resolução fixou, ou que uma verificação comparou.
sourceArtifactsintegersimQuantos artefactos de origem foram obtidos.
trustedPluginsintegersimQuantos dos plugins fixados continham uma assinatura verificada.
toolchainToolchainReportnãoO compilador que fez a resolução, e os plugins que contém.
externalInputsintegersimQuantas entradas externas que a renderização consome foram obtidas.
incompleteExternalInputsstringnãoQue entradas externas não puderam ser obtidas, quando algumas não puderam.

Não são permitidas propriedades adicionais.

BuildNotice

Algo que a compilação quer que o chamador saiba, que não é nem uma conclusão sobre um documento nem uma falha.

PropriedadeTipoObrigatóriaDescrição
classstringsimQue tipo de aviso é este.
textstringsimO que o aviso diz.

Não são permitidas propriedades adicionais.

CacheScope

Até onde chega uma resposta sobre a cache. Duas das classes de cache são partilhadas por todos os projetos da máquina, pelo que cada resposta sobre a cache nomeia quais delas tocou — caso contrário, uma sessão aberta sobre um espaço de trabalho seria lida como reportando apenas sobre esse espaço de trabalho.

PropriedadeTipoObrigatóriaDescrição
machineWideClassesstring[] ou nullsimAs classes de cache tocadas por esta resposta que são partilhadas entre todos os projetos da máquina.
workspaceRootstringsimO espaço de trabalho que o pedido nomeou.

Não são permitidas propriedades adicionais.

CacheElement

Algo que uma cache contém.

PropriedadeTipoObrigatóriaDescrição
labelstringsimDe que é a entrada.
sizeintegersimQuantos bytes ocupa.
sizeTextstringsimO mesmo tamanho escrito da forma como uma pessoa o lê.
digeststringnãoO digest de conteúdo sob o qual a entrada é indexada, quando tem um.
notestringnãoQualquer outra coisa que valha a pena dizer sobre a entrada.

Não são permitidas propriedades adicionais.

CacheClass

Uma cache sobre a qual o daemon reporta.

PropriedadeTipoObrigatóriaDescrição
namestringsimQue cache é esta.
reachstringsimSe a cache pertence a este espaço de trabalho ou é partilhada na máquina.
prunablebooleanasimSe recuperar o espaço desta cache é algo que o daemon fará.
elementsCacheElement[] ou nullsimO que a cache contém.

Não são permitidas propriedades adicionais.

CacheProvenance

Sob que identidades um artefacto em cache foi obtido, e quão amplamente é partilhado.

PropriedadeTipoObrigatóriaDescrição
identitiesstring[] ou nullsimAs identidades às quais o artefacto é atribuído.
sharedByintegernãoQuantos detentores partilham o artefacto.

Não são permitidas propriedades adicionais.

CacheRemoval

Algo que uma recuperação de espaço removeu — ou, numa lista do que deixou no lugar, algo que teria removido.

PropriedadeTipoObrigatóriaDescrição
classstringsimA que cache pertence.
labelstringsimO que é.
reachstringsimSe essa cache pertence a este espaço de trabalho ou é partilhada na máquina.
sizeintegersimQuantos bytes ocupa, ou ocupava antes de ser removido.
sizeTextstringsimO mesmo tamanho escrito da forma como uma pessoa o lê.

Não são permitidas propriedades adicionais.

CacheShortfall

O que uma recuperação de espaço deixou para trás, e o que o recuperaria, para que um chamador que lê um valor menor do que esperava saiba porquê em vez de o deduzir.

PropriedadeTipoObrigatóriaDescrição
classstringsimQue cache contém o que foi deixado.
countintegersimQuantas entradas foram deixadas.
sizeintegersimQuantos bytes ocupam.
sizeTextstringsimO mesmo tamanho escrito da forma como uma pessoa o lê.
reachstringsimSe essa cache pertence a este espaço de trabalho ou é partilhada na máquina.
reclaimedBystring[] ou nullsimO que as recuperaria.

Não são permitidas propriedades adicionais.

CacheCleared

Uma cache que uma limpeza esvaziou.

PropriedadeTipoObrigatóriaDescrição
classstringsimQue cache foi esvaziada.
reachstringsimSe pertence a este espaço de trabalho ou é partilhada na máquina.
sizeintegersimQuantos bytes foram recuperados dela.
sizeTextstringsimO mesmo tamanho escrito da forma como uma pessoa o lê.
heldOpenFilesintegersimQuantos ficheiros a limpeza deixou nesta cache porque outro processo os tinha abertos. Apenas o Windows se recusa a remover um ficheiro aberto, pelo que em qualquer outro lado isto é zero. Uma limpeza posterior remove-os assim que esse processo tiver terminado de os usar.
heldOpenBytesintegersimQuantos bytes esses ficheiros ocupam. Não são contados em size, que é o que a limpeza recuperou.
heldOpenBytesTextstringsimO mesmo valor escrito da forma como uma pessoa o lê.

Não são permitidas propriedades adicionais.

ConfigWriteScope

Que documento de configuração foi escrito e até onde alcança. Um pedido nomeia um espaço de trabalho, pelo que uma resposta que nada dissesse seria lida como dizendo respeito a esse espaço de trabalho — e, para uma escrita de toda a máquina, essa leitura está errada.

PropriedadeTipoObrigatóriaDescrição
configFilestringsimO documento que foi escrito.
machineWidebooleanasimSe esse documento é aquele através do qual cada espaço de trabalho da máquina resolve.
workspaceRootstringsimO espaço de trabalho que o pedido nomeou.

Não são permitidas propriedades adicionais.

PluginWriteScope

Em que documento de configuração uma alteração de plugin foi escrita e até onde alcança. A predefinição própria do socket de extensão de comandos é o documento de toda a máquina, pelo que cada resposta diz qual escreveu.

PropriedadeTipoObrigatóriaDescrição
configFilestringsimO documento que foi escrito.
machineWidebooleanasimSe esse documento é aquele através do qual cada espaço de trabalho da máquina resolve.
workspaceRootstringsimO espaço de trabalho que o pedido nomeou.

Não são permitidas propriedades adicionais.

CredentialStoreScope

Até onde alcança uma alteração de credencial. O armazenamento é partilhado por cada projeto da máquina e por qualquer outra ferramenta que se dirija aos mesmos registos, pelo que a resposta o reporta em vez de deixar que se deduza uma leitura limitada à sessão.

PropriedadeTipoObrigatóriaDescrição
machineWidebooleanasimSe o armazenamento em que a alteração tocou é partilhado na máquina.
workspaceRootstringsimO espaço de trabalho que o pedido nomeou.

Não são permitidas propriedades adicionais.

SkillFolderScope

Até onde alcança uma instalação de skill. Um pedido nomeia um espaço de trabalho, pelo que uma resposta que nada dissesse seria lida como dizendo respeito a esse espaço de trabalho — e, para as pastas por utilizador, que um assistente lê em cada projeto, essa leitura está errada.

PropriedadeTipoObrigatóriaDescrição
machineWidebooleanasimSe as pastas escritas são as por utilizador sob o diretório pessoal, que o assistente lê em cada projeto da máquina.
workspaceRootstringsimO espaço de trabalho que o pedido nomeou.

Não são permitidas propriedades adicionais.

PublicationReach

Até onde chegou uma publicação. Estas respostas chegam inteiramente para além desta máquina — o que anexam é o que cada consumidor desse registo resolve —, pelo que cada uma nomeia cada registo a que se dirigiu e se a chamada anexou algo aí.

PropriedadeTipoObrigatóriaDescrição
registriesstring[]simCada host de registo a que a chamada se dirigiu, cada um nomeado uma única vez, pela ordem em que a chamada se lhe dirigiu pela primeira vez. Uma chamada de referência única nomeia um; uma execução de teste nomeia o destino a que se teria dirigido.
beyondThisMachinebooleanasimSe a chamada anexou algo que um registo agora serve a outros: conteúdo carregado, uma assinatura, uma data de publicação ou um marcador de descontinuação. É false numa execução de teste, e numa chamada que encontrou já presente tudo o que teria anexado — uma publicação executada de novo sobre uma versão completa, ou um lote de assinatura em que cada referência já continha uma assinatura que se verifica.

Não são permitidas propriedades adicionais.

WorkspaceEntityRef

Uma entidade, por tipo e nome, com o documento que a declara.

PropriedadeTipoObrigatóriaDescrição
kindstringsimO tipo de entidade.
namestringsimO nome da entidade.
filestringsimO documento que a declara, como caminho relativo à raiz do espaço de trabalho.

Não são permitidas propriedades adicionais.

SourcedEntityRef

Uma entidade, com o local de onde foi lida. Um documento do espaço de trabalho reporta o seu caminho relativo ao espaço de trabalho; uma entidade resolvida a partir dos diretórios de catálogo configurados reporta um caminho vazio, porque o único caminho que tem nada significaria para um cliente. A origem diz qual dos dois casos é, em vez de deixar que um caminho vazio seja lido como um campo que ninguém preencheu.

PropriedadeTipoObrigatóriaDescrição
kindstringsimO tipo de entidade.
namestringsimO nome da entidade.
filestringsimO documento que a declara, como caminho relativo à raiz do espaço de trabalho, ou vazio quando veio dos diretórios de catálogo configurados.
originstringsimDe onde a entidade foi lida.

Não são permitidas propriedades adicionais.

SocketCandidacy

Um socket numa entidade, e o que lhe pode ser ligado.

PropriedadeTipoObrigatóriaDescrição
socketstringsimO nome do socket.
declarationstringsimOnde o socket é declarado.
selectorstringsimO seletor de etiquetas que um destino tem de satisfazer.
requiredbooleanasimSe o socket tem de estar ligado para que a compilação prossiga.
targetsWorkspaceEntityRef[] ou nullsimAs entidades que lhe podem ser ligadas.

Não são permitidas propriedades adicionais.

SlotCandidacy

Um slot que o socket de uma ligação declara, tal como o Component consumidor o declara no socket, e as Features que o podem preencher nessa ligação.

PropriedadeTipoObrigatóriaDescrição
slotstringsimO nome do slot, que é a chave sob a qual um anexo que o preenche é escrito nas features da ligação.
selectorstringsimO seletor de etiquetas que uma Feature que preenche o slot tem de satisfazer com as suas próprias etiquetas. Vazio quando o slot não declara nenhum, o que admite qualquer Feature.
requiredbooleanasimSe cada ligação ligada através do socket tem de preencher o slot para que a compilação prossiga.
injectstring[]simOs mecanismos de entrega que o slot permite para o que o preenche, pela ordem em que o Component os declara. Vazio quando não declara nenhum.
sensitivebooleanasimSe o slot declara que o que o preenche lida com material secreto. Marca o anexo que o preenche e não recusa nada.
descriptionstringsimPara que serve o slot segundo o Component. Vazio quando não diz nada.
candidatesSourcedEntityRef[]simCada Feature que pode preencher o slot nesta ligação: uma cuja aplicabilidade declarada as etiquetas do nó do grafo satisfazem, requisito a que cada anexo que o nó contém está sujeito, e cujas próprias etiquetas satisfazem o seletor do slot. Uma Feature cuja aplicabilidade ou cujas etiquetas não podem ser lidas face ao seletor não é oferecida, porque uma compilação a recusa em vez de a admitir.

Não são permitidas propriedades adicionais.

CatalogEntity

Uma entidade que o índice do espaço de trabalho contém.

PropriedadeTipoObrigatóriaDescrição
kindstringsimO tipo de entidade.
namestringsimO nome da entidade.
apiVersionstringsimA versão de esquema que o documento declara.
descriptionstringsimPara que serve a entidade segundo o documento.
labelsmapa de string ou nullsimAs etiquetas que o documento declara.
filestringsimO documento que a declara, como caminho relativo à raiz do espaço de trabalho.
originstringsimDe onde a entidade foi lida.

Não são permitidas propriedades adicionais.

CompletionItem

Algo que pode ser escrito na posição do cursor.

PropriedadeTipoObrigatóriaDescrição
labelstringsimO texto a escrever.
kindintegernãoQue tipo de elemento é, para que um cliente lhe possa escolher um ícone.
detailstringnãoUm qualificador curto mostrado ao lado da etiqueta.
documentationstringnãoO que é o elemento, em detalhe.
sortTextstringnãoO valor pelo qual ordenar, quando difere da etiqueta.

Não são permitidas propriedades adicionais.

MarkupContent

Texto a mostrar, e como está marcado.

PropriedadeTipoObrigatóriaDescrição
kindstringsimComo o texto está marcado.
valuestringsimO texto.

Não são permitidas propriedades adicionais.

EntityKindDescriptor

Um tipo de que um autor escreve um documento, que associa o token que um pedido nomeia ao tipo que o próprio documento declara, e diz que operações aceitam um documento desse tipo.

PropriedadeTipoObrigatóriaDescrição
kindstringsimO token em minúsculas que um pedido nomeia, como component ou featurerecipe.
documentKindstringsimO tipo que o próprio cabeçalho do documento declara.
acceptedByEntityKindAcceptancesimQue operações aceitam um documento deste tipo nomeado isoladamente — pelo seu caminho, ou pelo seu nome para inspeção — sem mais nada enviado ao lado dele. Um campo é true quando essa operação não recusa um documento por ser deste tipo; um documento que aceita pode ainda assim ser recusado pelo que o documento diz.

Não são permitidas propriedades adicionais.

EntityKindAcceptance

Para um tipo que um autor escreve, se cada operação aceita um documento desse tipo nomeado isoladamente. Cada campo está presente em cada entrada, pelo que false é uma afirmação e não uma omissão.

PropriedadeTipoObrigatóriaDescrição
singleEntityValidationbooleanasimSe o âmbito de entidade única de aggrega validate — o comando a que se dá o caminho de um único documento — verifica um documento deste tipo. Um tipo que recusa é verificado, em vez disso, pelo âmbito do catálogo inteiro ou pelo âmbito da Release.
publicationbooleanasimSe aggrega/publishEntity, nomeando apenas o documento, publica um documento deste tipo. Um tipo cuja publicação também associa um executável nomeado ao lado do documento — um Plugin — é false, porque um pedido que nomeie apenas o documento é recusado para ele; um Manifest e uma Release são false porque nenhum dos dois tipos é publicado.
inspectionByNamebooleanasimSe aggrega/entityDefinition resolve um nome para uma entidade deste tipo, com o nome enviado tal como é escrito onde uma entidade faz referência a outra.

Não são permitidas propriedades adicionais.

RegistryTrust

A política de confiança que a resolução aplica ao que um registo serve.

PropriedadeTipoObrigatóriaDescrição
signaturesRequiredbooleanasimSe um artefacto deste registo tem de conter uma assinatura verificada.
verificationSkippedbooleananãoSe a verificação está a ser ignorada.
advisorybooleananãoSe uma verificação falhada é reportada em vez de interromper a execução.
anchorstringnãoA âncora de confiança face à qual as assinaturas são verificadas.
keylessIdentitiesintegernãoQuantas identidades de assinatura são de confiança para este registo.

Não são permitidas propriedades adicionais.

Registry

Um registo configurado. Nenhum campo aqui contém material de credenciais, o seu comprimento, a sua forma ou qualquer representação dele — a presença é tudo o que é reportado, e é isso que torna o valor seguro para colar numa issue.

PropriedadeTipoObrigatóriaDescrição
hoststringsimO host do registo, que é a sua identidade.
namestringnãoO alias amigável que é resolvido para o host, quando há um configurado.
defaultbooleanasimSe este é o registo a que se dirige uma operação que não nomeia nenhum registo.
authStatestringsimSe uma credencial para este host está presente no armazenamento de toda a máquina. É reportado mesmo quando vazio, para que um chamador possa distinguir «nenhuma credencial está presente» de «a listagem não verificou».
trustRegistryTrustsimA política de confiança que a resolução aplica ao que um registo serve.

Não são permitidas propriedades adicionais.

TrustFetchOutcome

O que a leitura da política de confiança anunciada de um registo produziu. Os resultados são mantidos separados porque significam coisas diferentes: a política anunciada foi adotada, o registo não anunciou nada — o que não é uma falha —, a base de referência incorporada foi fixada no seu lugar, ou não foi tentada nenhuma leitura. Quando nada foi anunciado, indica-se ao lado se o registo pôde sequer ser alcançado.

PropriedadeTipoObrigatóriaDescrição
pinnedbooleanasimSe a política anunciada foi adotada.
notAdvertisedbooleananãoSe o registo foi consultado e não anunciou nenhuma política, caso em que a operação prossegue com o que o pedido declarou. Um registo que o modo offline impediu de ser consultado nunca é reportado assim. Um registo que não pôde ser alcançado também é reportado assim, uma vez que nenhuma política voltou dele, e contém unreachable ao lado; leia-se unreachable para distinguir os dois casos.
unreachablebooleananãoSe o registo não pôde ser alcançado quando a sua política anunciada foi pedida: o seu nome não foi resolvido, uma ligação a ele foi recusada ou não pôde ser aberta, ou uma ligação segura a ele não pôde ser estabelecida. É lido a partir da própria falha e não de reason, fica ao lado de notAdvertised, e só é definido quando a falha mostra que o registo nunca foi alcançado; um registo que respondeu — sem política, ou com uma falha — deixa-o ausente.
baselinebooleananãoSe a base de referência incorporada, que apenas o hub oficial contém, foi fixada porque nenhuma política anunciada foi adotada. Fica ao lado de notAdvertised quando o hub foi consultado e não anunciou nada, e sozinho quando o modo offline impediu que o hub fosse consultado.
skippedbooleananãoSe não foi tentada nenhuma leitura, porque uma política declarada a substituiu ou o pedido não pediu nenhuma.
identitiesintegernãoQuantas identidades de assinatura a política anunciada continha.
reasonstringnãoPor que razão a política anunciada não foi adotada: o que o endpoint do registo fez, ou a recusa offline que impediu que fosse consultado.

Não são permitidas propriedades adicionais.

SkippedRepo

Um repositório que o percurso do índice ignorou, e porquê.

PropriedadeTipoObrigatóriaDescrição
repostringsimO repositório que foi ignorado.
reasonstringsimPor que razão foi ignorado.

Não são permitidas propriedades adicionais.

DeprecationNote

Um marcador de descontinuação que o percurso do índice encontrou, e o que fez com ele. Um marcador que foi respeitado e um que estava presente e foi recusado são reportados em pé de igualdade, pelo que registar muitos não passa em silêncio enquanto recusar um se faz notar.

PropriedadeTipoObrigatóriaDescrição
repostringsimO repositório em que o marcador se encontra.
versionstringsimA versão que o marcador abrange.
recordedbooleanasimSe a própria assinatura do marcador foi verificada, e o índice, por isso, o contém.
severityconst “warning” ou const “error” ou const “retracted”nãoCom que força o marcador se pronuncia. Valores permitidos: "warning" — Descontinuada, no mais brando dos dois níveis consultivos: continua a ser selecionada quando se escolhe uma versão. "error" — Descontinuada, no mais forte dos dois níveis consultivos: continua a ser selecionada quando se escolhe uma versão. "retracted" — Retirada: excluída quando se escolhe uma versão.
reasonstringnãoPor que razão a versão está descontinuada.

Não são permitidas propriedades adicionais.

HostUpdate

O que uma atualização do índice fez para um registo.

PropriedadeTipoObrigatóriaDescrição
hoststringsimO host de registo que foi atualizado.
indexedintegersimQuantos registos foram escritos.
deprecationsExaminedbooleanasimSe o percurso sequer procurou marcadores de descontinuação. É separado da contagem porque «este registo não publicou nenhum» e «esta execução não tinha base para julgar um» são factos diferentes.
deprecationsRecordedintegersimQuantos marcadores foram respeitados.
skippedSkippedRepo[] ou nullsimOs repositórios que o percurso ignorou.
deprecationsDeprecationNote[] ou nullsimOs marcadores que o percurso encontrou.
readsRetriedintegersimQuantas das leituras do percurso o registo recusou ou interrompeu pelo caminho e foram pedidas novamente, cada leitura contada uma única vez, independentemente de quantas tentativas tenha exigido e de ter tido êxito depois ou não; zero quando não houve nenhuma. Um percurso cujas leituras tiveram todas êxito no fim não lista nenhum repositório sob skipped, pelo que é esta contagem que diz quão perto esteve de deixar um de fora. Mínimo: 0.
errorstringnãoO que falhou para este host, pelo que um percurso sobre vários reporta quais deles falharam sem que o chamador tenha de correlacionar nada.
unreachablebooleananãoSe este registo não pôde ser alcançado: o seu nome não foi resolvido, uma ligação a ele foi recusada ou não pôde ser aberta, ou uma ligação segura a ele não pôde ser estabelecida. É lido a partir da própria falha e não de error, só é definido ao lado de error, e apenas quando a falha mostra que o registo nunca foi alcançado; um registo que respondeu, fosse o que fosse que tenha respondido, deixa-o ausente.

Não são permitidas propriedades adicionais.

PublishedVersion

Uma versão que o índice contém para uma referência: o digest do manifesto para o qual a sua tag era resolvida quando o índice foi construído; quando a política de confiança sob a qual o índice foi construído verificou a própria assinatura da versão, o signatário que essa verificação estabeleceu; e, quando algo o regista, quando a versão foi publicada, com a fonte que o afirma. O signatário está ausente para uma versão sem assinatura, para uma da qual nenhuma assinatura foi verificada, e quando essa política não fixa nem uma chave pública nem uma identidade de confiança ou desativa a verificação de assinaturas. Nenhum desses casos é uma base para nomear um signatário, e a sua ausência nada mais diz. A data de publicação está ausente quando a publicação não declarou nenhuma e nenhuma assinatura keyless verificada por essa política regista uma.

PropriedadeTipoObrigatóriaDescrição
versionstringsimA versão, tal como a sua tag a nomeia.
manifestDigeststringsimO digest do manifesto para o qual a tag da versão era resolvida quando o índice foi construído, que endereça a versão pelos bytes que nomeia e não pela sua tag.
signerVerifiedSignaturenãoUma assinatura verificada face à política de confiança de um registo: como foi verificada, o signatário que a verificação estabeleceu e o digest do bundle de assinatura que foi verificado.
publishedAtstringnãoQuando a versão foi publicada, como carimbo temporal RFC 3339 em UTC com precisão ao segundo. A sua origem é publishedAtSource, e os dois estão presentes em conjunto ou não estão de todo.
publishedAtSourceconst “transparency-log” ou const “publisher”nãoDe onde vem publishedAt, para que um momento que um registo de transparência atesta nunca seja confundido com um que quem publica declara. O conjunto é fechado. Valores permitidos: "transparency-log" — O momento em que um registo de transparência registou a assinatura keyless da versão, que a política de confiança sob a qual o índice foi construído verificou juntamente com a promessa assinada do registo sobre esse momento. Para uma versão assinada ao ser publicada, é a publicação; para uma assinada depois, é quando essa assinatura foi feita. "publisher" — O momento que a publicação declarou ao lado do que publicou, segundo o próprio relógio da máquina que publica. Nada o atesta. Uma publicação declara um quando a sua assinatura não contém nenhum momento atestado: uma assinatura com chave, ou nenhuma assinatura. Quando há vários anexos, é usado o mais antigo.

Não são permitidas propriedades adicionais.

VerifiedSignature

Uma assinatura verificada face à política de confiança de um registo: como foi verificada, o signatário que a verificação estabeleceu e o digest do bundle de assinatura que foi verificado.

PropriedadeTipoObrigatóriaDescrição
bundleDigeststringsimO digest do bundle de assinatura que foi verificado, como sha256: seguido de 64 caracteres hexadecimais minúsculos.
identitystringnãoO signatário que a verificação da assinatura estabeleceu: para uma assinatura keyless, a identidade para a qual o certificado de assinatura foi emitido, que é o seu subject alternative name; para uma assinatura com chave, keyed:sha256: seguido do SHA-256 em hexadecimal minúsculo do texto PEM da chave pública fixada.
issuerstringnãoO emissor OIDC registado no certificado de assinatura, para uma assinatura keyless. Está ausente para uma assinatura com chave.
modeconst “keyless” ou const “keyed”simComo a assinatura foi verificada. O conjunto é fechado. Valores permitidos: "keyless" — Face a um certificado de assinatura cuja identidade e cujo emissor correspondem a uns em que a política confia, que se encadeia até à raiz de confiança que a política fixa ou, quando não fixa nenhuma, até à raiz public-good do Sigstore, e cuja assinatura um registo de transparência regista. "keyed" — Face à chave pública que a política fixa.

Não são permitidas propriedades adicionais.

RegistrySearchRecord

Um registo a que uma pesquisa correspondeu, tal como o índice local o contém, mais quais das suas versões um marcador publicado descontinuou.

PropriedadeTipoObrigatóriaDescrição
uristringsimA referência a partir da qual o registo é resolvido.
namestringsimO nome da entidade.
versionstringsimA versão sob a qual o registo é indexado.
versionsstring[]nãoCada versão que o índice contém para esta referência.
kindstringnãoO tipo de entidade.
descriptionstringnãoPara que serve a entidade.
categorystringnãoA categoria sob a qual a entidade é publicada.
labelsmapa de stringnãoAs etiquetas que a entidade declara.
pluginTypestringnãoO socket ao qual um registo de plugin se anexa.
capabilitiesstring[]nãoAs capacidades que um registo de plugin declara.
manifestDigeststringnãoO digest do manifesto publicado.
listingDigeststringnãoO digest da listagem da qual o registo foi lido.
deprecationsobject[]nãoOs marcadores de descontinuação que o índice contém para esta referência, cada um com a versão que abrange e o próprio marcador verificado.
publishedPublishedVersion[]nãoCada versão que o índice contém para esta referência, pela mesma ordem de versions, cada uma com o digest do manifesto para o qual a sua tag era resolvida quando o índice foi construído, com o seu signatário verificado quando a política de confiança sob a qual o índice foi construído verificou a própria assinatura dessa versão, e com a sua data de publicação e a fonte dessa data quando algo as regista. Uma versão registada sem signatário não contém nenhuma assinatura verificada por essa política, e nada mais é dito sobre ela. Para registar isto, apenas manifestos, anexos de assinatura e anexos de data de publicação são lidos do registo; o conteúdo de nenhuma entidade é obtido.
retractedstring[]nãoAs versões que um marcador publicado descontinuou.

Não são permitidas propriedades adicionais.

RegistrySearchIndex

A atualidade de um host pesquisado.

PropriedadeTipoObrigatóriaDescrição
hoststringsimO host cujo índice foi pesquisado.
lastUpdatedstringnãoQuando o índice foi atualizado pela última vez. Está ausente em vez de zero quando o instantâneo não contém nenhuma hora, para que um chamador possa distinguir «não registado» do epoch.

Não são permitidas propriedades adicionais.

EffectiveConfigurationSetting

Uma definição resolvida, e o documento de onde veio.

PropriedadeTipoObrigatóriaDescrição
fieldstringsimA definição.
valuestringsimO valor que foi resolvido.
sourcestringsimDe onde veio o valor.

Não são permitidas propriedades adicionais.

ImportedFile

Um ficheiro que uma importação escreve: um documento em rascunho, ou o registo daquilo que a importação escreveu.

PropriedadeTipoObrigatóriaDescrição
pathstringsimOnde o ficheiro deve ficar, como caminho relativo ao outputDir da resposta.
contentstringsimO texto do ficheiro.

Não são permitidas propriedades adicionais.

ImportDrift

Uma parte que uma sincronização atualizou face à fonte, ou atualizaria sob dryRun.

PropriedadeTipoObrigatóriaDescrição
changestringsimComo a parte sofreu desvio: added, para uma parte que a fonte ganhou; removed, para uma que descartou; ou changed, para uma que alterou.
filestringsimO ficheiro redigido em que a parte se encontra, como caminho relativo ao outputDir da resposta.
keystring[]simAs chaves que levam à parte a partir do topo de um Aggregate ou de uma Release redigidos, uma entrada por chave, para que uma chave que contenha um ponto continue a ser uma única entrada. Vazio quando a parte é o ficheiro inteiro.

Não são permitidas propriedades adicionais.

ImportOwed

Um valor que os rascunhos ainda deixam vazio, que nenhuma origem pôde fornecer e que nenhuma resposta forneceu.

PropriedadeTipoObrigatóriaDescrição
filestringsimO ficheiro redigido em que o valor se encontra, como caminho relativo ao outputDir da resposta.
keystring[]simAs chaves que levam ao valor a partir do topo desse documento, uma entrada por chave, pelo que uma chave que contém um ponto continua a ser uma única entrada. Uma resposta enviada como answered indica o valor através destas chaves.
questionstringsimO que o valor é: a descrição do seu esquema, ou então o comentário que o rascunho escreve acima da sua chave, ou então o que o seu esquema diz que aceita.
sensitivebooleanasimSe o valor é o de um segredo, cuja resposta indica de onde provém o segredo e nunca contém o próprio segredo.
secretAdvicestringnãoPresente no valor de um segredo: o que a sua resposta deve ser, na frase mostrada a uma pessoa que lhe responde num terminal — ou, quando a resposta enviada para ele como answered foi recusada, porque foi recusada.

Não são permitidas propriedades adicionais.

ImportAnswered

Uma resposta para um valor que owed da resposta listou.

PropriedadeTipoObrigatóriaDescrição
filestringsimO ficheiro redigido em que o valor se encontra, tal como owed o indica.
keystring[]simAs chaves que levam ao valor, tal como owed as indica.
answerstringsimA resposta. Uma resposta vazia deixa o valor em falta.

Não são permitidas propriedades adicionais.

ImportDiagnostic

Algo que uma conversão não conseguiu converter. Estes são o resultado mais útil da conversão, pelo que são reportados por inteiro em vez de reduzidos a um veredicto.

PropriedadeTipoObrigatóriaDescrição
severitystringsimQuão grave é.
messagestringsimO que não pôde ser convertido.
codestringnãoO nome citável da condição, quando tem um.

Não são permitidas propriedades adicionais.

ImportDecision

Como uma conversão mapeou um nó da fonte: os Components do catálogo que o importador avaliou, aquele que escolheu, porquê, e como trocar a escolha.

PropriedadeTipoObrigatóriaDescrição
sourceNodeDecisionSourceNodesimO nó da fonte a que diz respeito uma decisão de mapeamento.
candidatesImportCandidate[]nãoOs Components do catálogo que o importador avaliou para o nó, cada um com a sua pontuação. Ausente quando não avaliou nenhum.
chosenDecisionChoicenãoO que o importador escolheu para um nó da fonte. Ausente de uma decisão em que não fez nenhuma escolha.
rationalestringnãoPorque é que o importador fez a escolha, nas suas próprias palavras. Ausente quando não escreveu nenhuma.
swapHintstringnãoComo trocar a escolha por uma alternativa, nas próprias palavras do importador. Ausente quando não escreveu nenhuma.

Não são permitidas propriedades adicionais.

DecisionSourceNode

O nó da fonte a que diz respeito uma decisão de mapeamento.

PropriedadeTipoObrigatóriaDescrição
idstringsimO identificador do nó na fonte.
typestringsimO tipo do nó, tal como a fonte o nomeia.
paramsSummarystringsimUm resumo dos parâmetros do nó, para mostrar ao lado da decisão.

Não são permitidas propriedades adicionais.

ImportCandidate

Um Component do catálogo que o importador avaliou para um nó da fonte.

PropriedadeTipoObrigatóriaDescrição
componentNamestringsimO nome do Component.
scorenumbersimQuão bem o Component corresponde ao nó, segundo a pontuação do importador.
tierstringsimO nível de correspondência em que a pontuação se enquadra.
signalsCandidateSignalssimO que cada um dos sinais do importador contribuiu para a pontuação de um candidato.

Não são permitidas propriedades adicionais.

CandidateSignals

O que cada um dos sinais do importador contribuiu para a pontuação de um candidato.

PropriedadeTipoObrigatóriaDescrição
tablenumbersimA contribuição do sinal da tabela de mapeamento.
categorynumbersimA contribuição do sinal de categoria.
domainLabelsnumbersimA contribuição do sinal das etiquetas de domínio.
shapenumbersimA contribuição do sinal de forma.
namenumbersimA contribuição do sinal de nome.

Não são permitidas propriedades adicionais.

DecisionChoice

O que o importador escolheu para um nó da fonte. Ausente de uma decisão em que não fez nenhuma escolha.

PropriedadeTipoObrigatóriaDescrição
targetstringsimO nome do Component escolhido: um Component existente do catálogo, ou aquele que foi redigido para o nó.
modestringsimComo a escolha é escrita: como uma referência a um Component existente, ou como um recém-redigido.
tierstringsimO nível de correspondência da escolha.

Não são permitidas propriedades adicionais.

LintFileFindings

O que uma verificação de convenções encontrou num documento.

PropriedadeTipoObrigatóriaDescrição
filestringsimO documento.
diagnosticsDiagnostic[] ou nullsimAs conclusões nele contidas.

Não são permitidas propriedades adicionais.

PluginRetractionExclusion

Uma versão que estava disponível e não foi escolhida.

PropriedadeTipoObrigatóriaDescrição
versionstringsimA versão que foi ignorada.
reasonstringnãoPor que razão foi ignorado.

Não são permitidas propriedades adicionais.

PluginRetractionProvenance

De onde veio o conhecimento daquilo que está descontinuado.

PropriedadeTipoObrigatóriaDescrição
sourcestringsimO que foi consultado.
lastUpdatedstringnãoQuando isso foi atualizado pela última vez.

Não são permitidas propriedades adicionais.

PluginRetraction

Como um marcador de descontinuação determinou que versão do plugin foi fixada.

PropriedadeTipoObrigatóriaDescrição
referencestringsimA referência a que as versões pertencem.
selectedstringnãoA versão que foi fixada.
excludedPluginRetractionExclusion[]nãoAs versões que estavam disponíveis e foram ignoradas.
unscreenedstringnãoO que não pôde ser confrontado com um marcador, e porquê.
provenancePluginRetractionProvenancenãoDe onde veio o conhecimento daquilo que está descontinuado.

Não são permitidas propriedades adicionais.

PluginGeneratedDocument

Um documento de catálogo que uma geração produziu.

PropriedadeTipoObrigatóriaDescrição
pathstringsimOnde o documento deve ficar, como caminho relativo à raiz do espaço de trabalho.
contentstringsimO texto do documento.

Não são permitidas propriedades adicionais.

PluginCommandFlag

Uma flag que um plugin declara num comando que fornece.

PropriedadeTipoObrigatóriaDescrição
namestringsimO nome longo da flag.
shorthandstringnãoO alias de um único carácter da flag, quando tem um.
descriptionstringnãoO texto de ajuda de uma linha da flag.
typestringnãoO tipo de valor da flag.
defaultstringnãoO valor usado quando a flag não é passada.

Não são permitidas propriedades adicionais.

PluginCLICommand

Um verbo de comando de nível superior que um plugin fornece.

PropriedadeTipoObrigatóriaDescrição
namestringsimO verbo do comando.
descriptionstringnãoO texto de ajuda de uma linha do comando.
flagsPluginCommandFlag[]nãoAs flags do comando, pela ordem declarada.

Não são permitidas propriedades adicionais.

ConfigCapturedAttachment

Um anexo que um congelamento escreveu na configuração própria deste espaço de trabalho.

PropriedadeTipoObrigatóriaDescrição
uristringnãoA referência a partir da qual o anexo é resolvido.
capabilitystringnãoA capacidade a que o anexo se destina.
functionstringnãoA exportação para a qual o anexo é encaminhado.
rolestringnãoO papel em que o anexo é executado, o que determina o que pode emitir.

Não são permitidas propriedades adicionais.

ConfigCapturedSocket

Um socket que um congelamento escreveu, com os anexos que nele congelou.

PropriedadeTipoObrigatóriaDescrição
socketstringsimO socket.
fieldstringsimO campo de configuração sob o qual o socket é escrito.
attachmentsConfigCapturedAttachment[] ou nullsimOs anexos que nele foram congelados.

Não são permitidas propriedades adicionais.

ExplainErrorEntry

Uma passagem publicada que ensina a correção de authoring para uma condição.

PropriedadeTipoObrigatóriaDescrição
headingstringsimO título da passagem.
bodystringsimA passagem.

Não são permitidas propriedades adicionais.

SignedArtifact

Um artefacto publicado que uma assinatura abrangeu.

PropriedadeTipoObrigatóriaDescrição
referencestringsimA referência que foi assinada.
digeststringsimO digest daquilo que foi assinado.

Não são permitidas propriedades adicionais.

DeprecationMarked

Uma versão publicada que uma descontinuação marcou.

PropriedadeTipoObrigatóriaDescrição
referencestringsimA referência que foi marcada.
severityconst “warning” ou const “error” ou const “retracted”simCom que força o marcador se pronuncia. Valores permitidos: "warning" — Descontinuada, no mais brando dos dois níveis consultivos: continua a ser selecionada quando se escolhe uma versão. "error" — Descontinuada, no mais forte dos dois níveis consultivos: continua a ser selecionada quando se escolhe uma versão. "retracted" — Retirada: excluída quando se escolhe uma versão.
issuedOnstringsimQuando o marcador foi emitido.
digeststringsimO digest do marcador que foi publicado.

Não são permitidas propriedades adicionais.

InitializeResult

O que a sessão acertou para este cliente, e a partir de que camada de configuração resolveu.

PropriedadeTipoObrigatóriaDescrição
capabilitiesServerCapabilitiessimO que o daemon fará nesta sessão, acertado face ao que o cliente disse conseguir tratar.
workspaceRootstringsimO espaço de trabalho sobre o qual a sessão foi aberta.
configSourcestringsimA partir de que camada de configuração a sessão resolveu as suas definições.
workspaceMarkerstringnãoO ficheiro que identificou a raiz do espaço de trabalho, quando houve um.
versionstringsimA versão do binário que responde a esta sessão: o mesmo valor que aggrega version reporta para esse binário. Descreve o processo em execução, pelo que, depois de o ficheiro a partir do qual o daemon foi iniciado ter sido substituído, isto continua a nomear a versão que está em execução, enquanto consultar o ficheiro nomeia a versão que o substituiu.

Não são permitidas propriedades adicionais.

ValidateResult

O que a verificação encontrou, e quanto foi verificado.

PropriedadeTipoObrigatóriaDescrição
diagnosticsDiagnostic[] ou nullsimAs conclusões. É null em vez de uma lista vazia quando a verificação não encontrou nada.
checkedstringnãoQuanto foi verificado — um documento, ou o que o espaço de trabalho contém.

Não são permitidas propriedades adicionais.

InvalidateResult

Se o daemon guardava alguma coisa sobre o documento a descartar.

PropriedadeTipoObrigatóriaDescrição
invalidatedbooleanasimSe alguma coisa foi descartada.

Não são permitidas propriedades adicionais.

DiagnosticsResult

As conclusões que o daemon já guarda para o documento.

PropriedadeTipoObrigatóriaDescrição
diagnosticsDiagnostic[] ou nullsimAs conclusões. É null em vez de uma lista vazia quando não há nenhuma.

Não são permitidas propriedades adicionais.

IrGraphResult

O grafo resolvido em que uma Release é compilada.

PropriedadeTipoObrigatóriaDescrição
graphanysimO documento do grafo. Os valores que um autor declarou sensíveis são retidos dele, a menos que o pedido os tenha pedido com unredacted; tudo o resto é transmitido tal como o compilador o emitiu. A sua própria forma é o contrato publicado do grafo e não é repetida aqui.

Não são permitidas propriedades adicionais.

BuildResult

O que uma compilação escreveu.

PropriedadeTipoObrigatóriaDescrição
outputDirectorystringsimO diretório no qual os artefactos foram escritos.
filesstring[] ou nullsimOs artefactos que foram escritos, como caminhos relativos ao diretório de saída.
noticesBuildNotice[]nãoQualquer coisa que a compilação queira que o chamador saiba e que não seja nem uma conclusão nem uma falha.
dependencyResolutionDependencyResolutionReportnãoO que uma resolução de dependências fixou e obteve.

Não são permitidas propriedades adicionais.

BuildPreviewResult

O que uma compilação teria escrito. Nada foi escrito, pelo que não há nenhum diretório de saída a nomear.

PropriedadeTipoObrigatóriaDescrição
filesstring[] ou nullsimOs artefactos que a escrita teria produzido.
noticesBuildNotice[]nãoQualquer coisa que o processo de compilação queira que o chamador saiba e que não seja nem uma conclusão nem uma falha.

Não são permitidas propriedades adicionais.

EntityDefinitionResult

Aquilo em que um nome de entidade é resolvido, e o documento que a define. Uma resposta lida de uma referência de registo contém published, e uma resposta que o catálogo resolveu pelo nome nunca o contém.

PropriedadeTipoObrigatóriaDescrição
kindstringsimO tipo de entidade.
namestringsimO nome da entidade.
versionstringsimA versão que foi resolvida.
descriptionstringnãoPara que serve a entidade segundo o documento.
publishScopestringnãoQuão amplamente a entidade está publicada.
filestringsimO documento que a define.
authoredLengthintegersimQuantos bytes contém o documento escrito pelo autor, para que um cliente possa distinguir um documento escrito pelo autor de uma representação resolvida de um.
definitionstringsimO texto da definição.
publishedPublishedArtifactnãoO que uma referência de registo leu: a coordenada, como continha a entidade, e o manifesto através do qual foi lida. Cada campo está presente sempre que isto esteja.

Não são permitidas propriedades adicionais.

PublishedArtifact

O que uma referência de registo leu: a coordenada, como continha a entidade, e o manifesto através do qual foi lida. Cada campo está presente sempre que isto esteja.

PropriedadeTipoObrigatóriaDescrição
referencestringsimA referência de registo que foi lida.
archivebooleanasimSe os bytes da coordenada eram um arquivo do qual o documento da entidade foi extraído. False quando a coordenada continha o próprio documento da entidade.
mediaTypestringsimO tipo de artefacto que o manifesto declara.
manifestDigeststringsimO digest do manifesto através do qual a entidade foi lida — o valor a nomear depois de @ para voltar a ler exatamente os mesmos bytes.

Não são permitidas propriedades adicionais.

ReleaseClosureResult

Tudo aquilo de que uma Release depende, tal como a resolução o alcançou. Reporta o fecho em vez do grafo dele derivado: um documento diferente sobre a mesma Release.

PropriedadeTipoObrigatóriaDescrição
releasestringsimA Release que foi inspecionada.
aggregatestringsimO Aggregate que implanta.
manifeststringsimO Manifest através do qual resolve.
environmentstringsimO ambiente que nomeia.
entitiesClosureEntity[] ou nullsimAs entidades que o fecho alcança.
librariesClosureEntity[] ou nullsimAs bibliotecas que o fecho alcança.
pluginsClosureEntity[] ou nullsimOs plugins que o fecho alcança.
mappingDiagnosticsstring[] ou nullsimO que a resolução dos mapeamentos do Manifest teve a dizer.
deprecationsstring[] ou nullsimOs marcadores de descontinuação que o fecho encontrou.

Não são permitidas propriedades adicionais.

ResolveDependenciesResult

O que uma resolução de dependências fixou e obteve, mais qualquer coisa que queira que o chamador saiba. Os próprios campos do relatório são transportados diretamente nesta resposta em vez de aninhados sob um campo dela.

PropriedadeTipoObrigatóriaDescrição
lockfilestringsimO ficheiro de bloqueio que a resolução escreveu, ou aquele com o qual uma verificação comparou.
verifiedbooleananãoSe o pedido foi uma verificação, que comparou o ficheiro de bloqueio registado e não escreveu nenhum ficheiro de bloqueio, registo de confiança de plugins nem entity.lock.
entitiesClosureEntity[] ou nullsimAs entidades que a resolução fixou, ou que uma verificação comparou.
librariesClosureEntity[] ou nullsimAs bibliotecas que a resolução fixou, ou que uma verificação comparou.
pluginsClosureEntity[] ou nullsimOs plugins que a resolução fixou, ou que uma verificação comparou.
sourceArtifactsintegersimQuantos artefactos de origem foram obtidos.
trustedPluginsintegersimQuantos dos plugins fixados continham uma assinatura verificada.
toolchainToolchainReportnãoO compilador que fez a resolução, e os plugins que contém.
externalInputsintegersimQuantas entradas externas que a renderização consome foram obtidas.
incompleteExternalInputsstringnãoQue entradas externas não puderam ser obtidas, quando algumas não puderam.
noticesstring[]nãoQualquer coisa que a resolução queira que o chamador saiba.

Não são permitidas propriedades adicionais.

PinResult

O que o passo de fixação fez ao bloqueio ao lado de uma entidade, ou faria numa execução de teste. É a resposta a aggrega/pin, e uma publicação que executou o passo contém-na como o seu pin.

PropriedadeTipoObrigatóriaDescrição
entitystringsimO documento de entidade que o passo leu, como caminho relativo à raiz do espaço de trabalho.
kindstringsimO tipo da entidade, tal como o seu documento o declara.
namestringsimO nome da entidade, tal como o seu documento o declara.
pinnablebooleanasimSe uma entidade deste tipo lê alguma coisa para a qual um bloqueio regista uma fixação, como fazem uma Recipe e uma FeatureRecipe. Quando é false, nada ao lado da entidade foi tocado, changed é false, e lock, removed, pins e content estão ausentes.
lockstringnãoO bloqueio que o passo escreveu, ou escreveria, como caminho relativo à raiz do espaço de trabalho.
changedbooleanasimSe o bloqueio mudou, ou mudaria numa execução de teste. False quando o bloqueio já registava cada fixação de que a entidade precisa e foi deixado idêntico byte a byte.
removedbooleananãoSe a mudança é uma remoção: a entidade não lê nada para o qual um bloqueio registe uma fixação, pelo que nenhum bloqueio fica ao lado dela.
dryRunbooleananãoSe isto reporta o que o passo faria em vez daquilo que fez.
pinsPinClassCount[]nãoQuantas fixações de cada classe o bloqueio contém após o passo, ou conteria após uma execução de teste. Cada classe que o bloqueio pode conter é listada, incluindo uma classe sem nenhuma fixação.
contentstringnãoO bloqueio que uma execução de teste escreveria. Ausente quando o bloqueio seria deixado como está ou removido, e em cada resposta que não seja uma execução de teste.

Não são permitidas propriedades adicionais.

PinClassCount

Quantas fixações de uma classe um bloqueio contém.

PropriedadeTipoObrigatóriaDescrição
classstringsimA classe da fixação, nas palavras que uma recusa que nomeie uma em falta usa — remote source ou imported file, por exemplo.
pinsintegersimQuantas fixações dessa classe o bloqueio contém.

Não são permitidas propriedades adicionais.

CacheStatusResult

O que contêm as caches que servem este espaço de trabalho.

PropriedadeTipoObrigatóriaDescrição
classesCacheClass[] ou nullsimCada cache e o que contém.
provenanceCacheProvenance[] ou nullsimSob que identidades os artefactos em cache foram obtidos.
totalCountintegersimQuantas entradas as caches contêm no total.
totalSizeintegersimQuantos bytes ocupam no total.
totalSizeTextstringsimO mesmo total escrito da forma como uma pessoa o lê.
scopeCacheScopesimAté onde chega uma resposta sobre a cache. Duas das classes de cache são partilhadas por todos os projetos da máquina, pelo que cada resposta sobre a cache nomeia quais delas tocou — caso contrário, uma sessão aberta sobre um espaço de trabalho seria lida como reportando apenas sobre esse espaço de trabalho.

Não são permitidas propriedades adicionais.

CachePruneResult

O que uma recuperação de espaço removeu, o que manteve e o que não conseguiu recuperar.

PropriedadeTipoObrigatóriaDescrição
removedCacheRemoval[] ou nullsimO que foi removido.
heldOpenCacheRemoval[] ou nullsimO que a poda teria removido, mas deixou no lugar porque outro processo o tinha aberto. Apenas o Windows se recusa a remover um ficheiro aberto, pelo que em qualquer outro lado isto está vazio. Estas entradas não são contadas nem como removidas nem como mantidas, nenhum dos seus bytes conta como recuperado, e uma poda posterior recupera-as; uma entrada que seja um diretório pode já ter perdido os ficheiros nela contidos que não estavam abertos.
retainedCountintegersimQuantas entradas foram mantidas.
reclaimedBytesintegersimQuantos bytes foram recuperados.
reclaimedBytesTextstringsimO mesmo valor escrito da forma como uma pessoa o lê.
unattributedCountintegersimQuantas entradas nenhum detentor reivindica.
unattributedSizeintegersimQuantos bytes essas entradas ocupam.
unattributedSizeTextstringsimO mesmo valor escrito da forma como uma pessoa o lê.
notPruneEligibleCacheShortfall[] ou nullsimO que foi deixado para trás, e o que o recuperaria.
scopeCacheScopesimAté onde chega uma resposta sobre a cache. Duas das classes de cache são partilhadas por todos os projetos da máquina, pelo que cada resposta sobre a cache nomeia quais delas tocou — caso contrário, uma sessão aberta sobre um espaço de trabalho seria lida como reportando apenas sobre esse espaço de trabalho.

Não são permitidas propriedades adicionais.

CacheEvictResult

O que a recuperação de espaço até um tamanho removeu, e o que resta.

PropriedadeTipoObrigatóriaDescrição
withinCapBeforebooleanasimSe aquilo que era guardado já cabia abaixo do tamanho, pelo que nada precisou de ser removido.
removedCacheRemoval[] ou nullsimO que foi removido.
heldOpenCacheRemoval[] ou nullsimO que a recuperação de espaço teria removido, mas deixou no lugar porque outro processo o tinha aberto; em vez disso, passou para a entrada seguinte mais antiga. Apenas o Windows se recusa a remover um ficheiro aberto, pelo que em qualquer outro lado isto está vazio. Estas entradas continuam a contar para os bytes que restam, e uma recuperação de espaço posterior pode removê-las.
totalBeforeintegersimQuantos bytes eram guardados antes.
totalBeforeTextstringsimO mesmo valor escrito da forma como uma pessoa o lê.
reclaimedBytesintegersimQuantos bytes foram recuperados.
reclaimedBytesTextstringsimO mesmo valor escrito da forma como uma pessoa o lê.
remainingBytesintegersimQuantos bytes restam.
remainingBytesTextstringsimO mesmo valor escrito da forma como uma pessoa o lê.
capBytesintegersimO tamanho até ao qual o espaço foi recuperado, em bytes.
capBytesTextstringsimO mesmo tamanho escrito da forma como uma pessoa o lê.
scopeCacheScopesimAté onde chega uma resposta sobre a cache. Duas das classes de cache são partilhadas por todos os projetos da máquina, pelo que cada resposta sobre a cache nomeia quais delas tocou — caso contrário, uma sessão aberta sobre um espaço de trabalho seria lida como reportando apenas sobre esse espaço de trabalho.

Não são permitidas propriedades adicionais.

CacheClearResult

O que o esvaziamento das caches recuperou.

PropriedadeTipoObrigatóriaDescrição
clearedCacheCleared[] ou nullsimCada cache que foi esvaziada.
reclaimedBytesintegersimQuantos bytes foram recuperados.
reclaimedBytesTextstringsimO mesmo valor escrito da forma como uma pessoa o lê.
scopeCacheScopesimAté onde chega uma resposta sobre a cache. Duas das classes de cache são partilhadas por todos os projetos da máquina, pelo que cada resposta sobre a cache nomeia quais delas tocou — caso contrário, uma sessão aberta sobre um espaço de trabalho seria lida como reportando apenas sobre esse espaço de trabalho.

Não são permitidas propriedades adicionais.

RegistryListResult

Os registos através dos quais este espaço de trabalho resolve.

PropriedadeTipoObrigatóriaDescrição
registriesRegistry[] ou nullsimCada registo configurado.
credentialStateIsMachineWidebooleanasimSe a presença de credenciais reportada para cada registo é um facto de toda a máquina em vez de um facto do espaço de trabalho. É reportado para que uma resposta limitada à sessão não seja lida como negando o alcance mais amplo.

Não são permitidas propriedades adicionais.

SearchResult

O que os índices locais dos registos ofereceram para a pesquisa.

PropriedadeTipoObrigatóriaDescrição
recordsRegistrySearchRecord[] ou nullsimOs registos que corresponderam.
indexesRegistrySearchIndex[] ou nullsimCada host pesquisado e quando o seu índice foi atualizado pela última vez.
missingIndexHostsstring[] ou nullsimOs hosts configurados sem nenhum índice local em que pesquisar, para que uma resposta curta seja explicada em vez de deixada para ser deduzida.
stalebooleanasimSe algum índice pesquisado é suficientemente antigo para que valha a pena atualizá-lo.
registriesConfiguredbooleanasimSe há algum registo configurado, o que distingue «nada correspondeu» de «nada foi pesquisado».

Não são permitidas propriedades adicionais.

RegistryAddResult

O que a adição de um registo escreveu, onde, e o que leu do próprio registo.

PropriedadeTipoObrigatóriaDescrição
hoststringsimO host sob o qual a entrada é indexada, que nem sempre é a grafia que o pedido usou.
scopeConfigWriteScopesimQue documento de configuração foi escrito e até onde alcança. Um pedido nomeia um espaço de trabalho, pelo que uma resposta que nada dissesse seria lida como dizendo respeito a esse espaço de trabalho — e, para uma escrita de toda a máquina, essa leitura está errada.
trustTrustFetchOutcomesimO que a leitura da política de confiança anunciada de um registo produziu. Os resultados são mantidos separados porque significam coisas diferentes: a política anunciada foi adotada, o registo não anunciou nada — o que não é uma falha —, a base de referência incorporada foi fixada no seu lugar, ou não foi tentada nenhuma leitura. Quando nada foi anunciado, indica-se ao lado se o registo pôde sequer ser alcançado.

Não são permitidas propriedades adicionais.

RegistryRemoveResult

O que a remoção de um registo escreveu, e onde.

PropriedadeTipoObrigatóriaDescrição
hoststringsimO host cuja entrada foi removida.
scopeConfigWriteScopesimQue documento de configuração foi escrito e até onde alcança. Um pedido nomeia um espaço de trabalho, pelo que uma resposta que nada dissesse seria lida como dizendo respeito a esse espaço de trabalho — e, para uma escrita de toda a máquina, essa leitura está errada.

Não são permitidas propriedades adicionais.

RegistryUpdateResult

O que a atualização dos índices locais fez, por host.

PropriedadeTipoObrigatóriaDescrição
hostsHostUpdate[] ou nullsimO que a atualização fez para cada host.
failedstring[] ou nullsimOs hosts para os quais a atualização não pôde ser concluída.
indexRootstringsimO diretório sob o qual os índices foram escritos.
registriesConfiguredbooleanasimSe há algum registo configurado.
reachedRegistriesbooleanasimSempre true nesta resposta: atualizar os índices vai até aos próprios registos, ao passo que listá-los e pesquisar respondem a partir da configuração e de um índice local. Se um dado registo foi de facto alcançado é indicado na sua própria entrada em hosts, por unreachable.

Não são permitidas propriedades adicionais.

LogoutResult

Que credencial armazenada foi removida, e até onde alcança o armazenamento.

PropriedadeTipoObrigatóriaDescrição
registrystringsimO registo cuja credencial foi removida.
scopeCredentialStoreScopesimAté onde alcança uma alteração de credencial. O armazenamento é partilhado por cada projeto da máquina e por qualquer outra ferramenta que se dirija aos mesmos registos, pelo que a resposta o reporta em vez de deixar que se deduza uma leitura limitada à sessão.

Não são permitidas propriedades adicionais.

PublishEntityResult

O que a publicação de uma entidade depositou, e onde. Uma publicação que executou primeiro o passo de fixação contém também o que esse passo fez, como pin, que está ausente quando o passo não foi executado.

PropriedadeTipoObrigatóriaDescrição
referencestringsimA referência sob a qual a entidade foi publicada.
tagstringsimA tag sob a qual foi publicada.
kindstringsimO tipo de entidade que foi publicado.
mediaTypestringsimO tipo de média registado para os bytes publicados.
sizeintegersimQuantos bytes foram publicados.
sizeTextstringsimO mesmo tamanho escrito da forma como uma pessoa o lê.
pluginSizeintegernãoQuantos bytes ocupa o módulo de plugin publicado juntamente com uma entidade Plugin.
pluginSizeTextstringnãoO mesmo tamanho escrito da forma como uma pessoa o lê.
digeststringsimO digest do que foi publicado. Numa execução de teste, o digest que uma publicação do mesmo conteúdo depositaria, calculado apenas a partir do conteúdo: o que aggrega push --dry-run imprime.
signedbooleanasimSe esta publicação anexou uma assinatura: a que criou antes de publicar ou, numa versão já publicada, uma que faltava à versão.
alreadyPublishedbooleanasimSe os mesmos bytes já lá estavam, pelo que nenhum conteúdo foi carregado. Apenas o que ainda faltava a essa publicação foi anexado ao lado deles: a sua data de publicação e, quando esta publicação assina, a sua assinatura; signed diz se uma assinatura foi anexada.
dryRunbooleanasimSe isto reporta o que a publicação teria depositado em vez do que depositou.
reachPublicationReachsimAté onde chegou uma publicação. Estas respostas chegam inteiramente para além desta máquina — o que anexam é o que cada consumidor desse registo resolve —, pelo que cada uma nomeia cada registo a que se dirigiu e se a chamada anexou algo aí.
pinPinResultnãoO que o passo de fixação fez ao bloqueio ao lado de uma entidade, ou faria numa execução de teste. É a resposta a aggrega/pin, e uma publicação que executou o passo contém-na como o seu pin.
wholeDirectorySourcestringnãoA fonte local da entidade tal como foi escrita, presente quando está escrita como modelo. Uma fonte assim só nomeia o seu diretório depois de uma Release preencher o modelo, pelo que a publicação contém cada ficheiro do diretório da entidade em vez de apenas os ficheiros que a entidade nomeia. Ausente quando contém apenas esses ficheiros.
windowsUnusableEntriesstring[]nãoAs entradas do arquivo publicado cujo caminho contém uma parte que o Windows não consegue conter tal como está escrita — um nome que o Windows reserva para um dispositivo, como CON, AUX ou NUL, em qualquer combinação de maiúsculas e minúsculas e seja qual for a extensão que se segue, ou uma parte que termina em ponto ou em espaço —, primeiro o próprio nome de ficheiro do documento da entidade, depois os ficheiros que contém. Um espaço de trabalho no Windows recusa-se a descompactá-las, pelo que não pode usar a versão; a publicação prossegue ou para exatamente como faria sem elas. Ausente quando não há nenhuma, o que inclui uma entidade publicada apenas como o seu documento.

Não são permitidas propriedades adicionais.

PublishArtifactResult

O que a publicação de um ficheiro depositou, e onde.

PropriedadeTipoObrigatóriaDescrição
referencestringsimA referência sob a qual o ficheiro foi publicado.
tagstringsimA tag sob a qual foi publicada.
mediaTypestringsimO tipo de média registado para os bytes publicados.
sizeintegersimQuantos bytes foram publicados.
sizeTextstringsimO mesmo tamanho escrito da forma como uma pessoa o lê.
digeststringsimO digest do que foi publicado.
alreadyPublishedbooleanasimSe os mesmos bytes já lá estavam, pelo que nenhum conteúdo foi carregado. Uma data de publicação foi anexada ao lado deles apenas quando faltava uma ao artefacto.
dryRunbooleanasimSe isto reporta o que a publicação teria depositado em vez do que depositou.
reachPublicationReachsimAté onde chegou uma publicação. Estas respostas chegam inteiramente para além desta máquina — o que anexam é o que cada consumidor desse registo resolve —, pelo que cada uma nomeia cada registo a que se dirigiu e se a chamada anexou algo aí.

Não são permitidas propriedades adicionais.

SignArtifactsResult

O que foi assinado, e onde as assinaturas foram depositadas.

PropriedadeTipoObrigatóriaDescrição
signedSignedArtifact[] ou nullsimCada referência que foi assinada.
reachPublicationReachsimAté onde chegou uma publicação. Estas respostas chegam inteiramente para além desta máquina — o que anexam é o que cada consumidor desse registo resolve —, pelo que cada uma nomeia cada registo a que se dirigiu e se a chamada anexou algo aí.

Não são permitidas propriedades adicionais.

DeprecateArtifactResult

O que foi marcado como descontinuado, e onde os marcadores foram depositados.

PropriedadeTipoObrigatóriaDescrição
markedDeprecationMarked[] ou nullsimCada versão que foi marcada.
reachPublicationReachsimAté onde chegou uma publicação. Estas respostas chegam inteiramente para além desta máquina — o que anexam é o que cada consumidor desse registo resolve —, pelo que cada uma nomeia cada registo a que se dirigiu e se a chamada anexou algo aí.

Não são permitidas propriedades adicionais.

ResolveResult

Onde está definido o elemento sob o cursor.

PropriedadeTipoObrigatóriaDescrição
locationnull ou LocationsimOnde está definido. É null quando nada sob o cursor se resolve numa definição.

Não são permitidas propriedades adicionais.

FindReferencesResult

Onde se faz referência ao elemento sob o cursor.

PropriedadeTipoObrigatóriaDescrição
locationsLocation[] ou nullsimCada local em que se lhe faz referência.

Não são permitidas propriedades adicionais.

FindImplementationsResult

Que documentos implementam o elemento sob o cursor.

PropriedadeTipoObrigatóriaDescrição
locationsLocation[] ou nullsimCada local em que está implementado.

Não são permitidas propriedades adicionais.

HoverResult

O que mostrar sobre o elemento sob o cursor.

PropriedadeTipoObrigatóriaDescrição
contentsnull ou MarkupContentsimO que mostrar. É null quando não há nada a dizer sobre o que está sob o cursor.

Não são permitidas propriedades adicionais.

CompletionResult

O que pode ser escrito na posição do cursor.

PropriedadeTipoObrigatóriaDescrição
itemsCompletionItem[] ou nullsimCada elemento que pode ser escrito.

Não são permitidas propriedades adicionais.

CatalogIndexResult

Cada entidade que o índice do espaço de trabalho contém, e os links que conduzem para fora do espaço de trabalho, para diretórios e para ficheiros, que não foram lidos para ele.

PropriedadeTipoObrigatóriaDescrição
entitiesCatalogEntity[] ou nullsimCada entidade.
unreadLinkedDirsstring[]simCada link sob a raiz do espaço de trabalho que conduz a um diretório fora dela, nomeado de forma relativa à raiz no local onde o próprio link se encontra, pela ordem em que o espaço de trabalho é pesquisado. Nenhum diretório fora da raiz é pesquisado, pelo que nenhum documento por trás de um destes links está entre entities como próprio do espaço de trabalho, e um cliente que lista entidades pode dizer porquê. Não nomeados: um link para um diretório dentro da raiz, que é pesquisado, ou deixado de fora, onde realmente se encontra; um link em qualquer local onde um diretório seria deixado de fora, seja pelo local onde se encontra, pelo seu nome ou por um .gitignore; um link que não pode ser resolvido, porque não conduz a lado nenhum ou anda em círculo; e, numa resposta dada nos termos de uma Release, um link sob um diretório de catálogo que apenas outras Releases leem. Vazio quando o espaço de trabalho não contém nenhum.
unreadLinkedFilesstring[]simCada link sob a raiz do espaço de trabalho que tem nome de ficheiro YAML, com o seu próprio nome a terminar em .yaml ou .yml, e conduz a um ficheiro fora da raiz, nomeado de forma relativa à raiz no local onde o próprio link se encontra, pela ordem em que o espaço de trabalho é pesquisado. Um ficheiro assim não é lido para o índice, seja o que for que declare, pelo que a entidade que declara não está entre entities como própria do espaço de trabalho, e um cliente que lista entidades pode dizer porquê; os diretórios de catálogo configurados são o meio pelo qual as entidades fora do espaço de trabalho são lidas. Não nomeados: um link para um ficheiro que a configuração do espaço de trabalho nomeia como Release, como build.authoring_release ou como chave de workspace.releases, e que declara uma, o qual é lido e listado em entities no local próprio do link; um link para um ficheiro dentro da raiz, que é lido no local próprio do link; um link que um .gitignore deixa de fora, ou um dentro de um diretório que a pesquisa deixa de fora; um link que não conduz a nenhum ficheiro, seja a um diretório, que unreadLinkedDirs nomeia quando conduz para fora da raiz, a lado nenhum ou em círculo; e, numa resposta dada nos termos de uma Release, um link sob um diretório de catálogo que apenas outras Releases leem. Um ficheiro de configuração do espaço de trabalho que é um link que conduz para fora do espaço de trabalho, o seu próprio .aggrega-config.yaml ou o overlay detido pela CI ao lado dele, é nomeado quer a pesquisa o tenha encontrado quer não, depois dos links que a pesquisa nomeou: a configuração do espaço de trabalho não é então lida de todo, esta resposta é o índice próprio do espaço de trabalho lido sem nada configurado, pelo que nenhum diretório de catálogo é lido para ele, e cada pedido que a configuração decide, incluindo um índice nos termos de uma Release, é recusado para esse espaço de trabalho com a condição do bloqueio de leitura.

Não são permitidas propriedades adicionais.

AttachCandidatesResult

Que Features podem ser anexadas à entidade, e as etiquetas face às quais foram avaliadas; e, para uma ligação que o pedido nomeou, os slots que o seu socket declara com as Features que podem preencher cada um.

PropriedadeTipoObrigatóriaDescrição
nodestringsimA entidade para a qual os candidatos foram avaliados.
nodeLabelsmapa de string ou nullsimAs etiquetas face às quais a avaliação foi feita.
labelSourcestringsimQue conjunto de etiquetas foi usado, o que não é cosmético: as etiquetas declaradas de um documento são o que uma leitura da fonte consegue ver, enquanto as de um nó do grafo são o conjunto finalizado face ao qual a própria compilação avalia. Uma resposta calculada sobre o segundo é uma afirmação sobre o que a compilação fará.
candidatesSourcedEntityRef[] ou nullsimCada Feature que pode ser anexada.
slotsSlotCandidacy[]nãoPresente apenas quando o pedido nomeou uma ligação: cada slot que o socket da ligação declara, pela ordem em que o Component os declara, com as Features que o podem preencher. Vazio quando nenhum slot pode ser preenchido na ligação, e noSlotReason diz então porquê — o que um cliente lê em vez de tomar uma lista vazia por slots a que nenhuma Feature correspondeu.
noSlotReasonconst “feature-created-connection” ou const “ad-hoc-socket” ou const “no-slot-declared”nãoPresente apenas quando o pedido nomeou uma ligação e nenhum slot pode ser preenchido nela: porque é que nada se pode anexar aí. Ausente sempre que o socket declara um slot. O conjunto é fechado. Valores permitidos: "feature-created-connection" — Uma Feature traçou a ligação, e um anexo só é escrito numa ligação que um componente ou a Release traça. "ad-hoc-socket" — O socket é um que o Component não declara, pelo que não declara nenhum slot para uma ligação preencher. "no-slot-declared" — O Component declara o socket e não declara nenhum slot nele.

Não são permitidas propriedades adicionais.

ConnectionCandidatesResult

A que entidades cada socket da entidade pode ser ligado.

PropriedadeTipoObrigatóriaDescrição
nodestringsimA entidade a que pertencem estes sockets.
adHocSocketsAcceptedbooleanasimSe um socket que a própria definição da entidade não declara previamente pode ainda assim ser escrito.
socketsSocketCandidacy[] ou nullsimCada socket e o que lhe pode ser ligado.

Não são permitidas propriedades adicionais.

InsertionPointResult

Onde, no documento, pertence uma nova entrada sob o contentor nomeado, e o que um cliente precisa para a escrever aí: o próprio ponto, se uma quebra de linha tem de abrir o texto, as chaves de contentor que ainda faltam e a indentação que cada linha leva.

PropriedadeTipoObrigatóriaDescrição
filestringsimO documento.
containerstring[] ou nullsimO caminho através do documento até ao contentor.
positionEncodingstringsimA codificação em que as posições desta resposta são expressas.
positionPositionsimUm ponto num documento: uma linha e um deslocamento de carácter dentro dela, ambos contados a partir de zero. O deslocamento é medido nas unidades da codificação que a sessão acordou ao ser aberta, que é UTF-16, a menos que o cliente tenha pedido outra.
precededByLineBreakbooleanasimSe o texto escrito na posição tem de começar com uma quebra de linha, porque a posição se encontra no fim de uma linha que o documento já contém. É false apenas quando o documento não contém nada a que a entrada possa seguir-se.
missingContainerKeysstring[] ou nullsimOs segmentos do caminho do contentor que o documento ainda não contém, do mais exterior para o mais interior. Cada um tem de ser escrito como uma chave própria, indentado um nível mais do que o anterior, antes de a entrada poder ir para dentro do mais interior. É null quando o caminho inteiro já está presente.
entryIndentintegersimA coluna em que começa a primeira linha própria da entrada, contada em espaços a partir do início da linha.
indentStepintegersimQuanto mais é indentado cada nível de aninhamento.
indentStepMeasuredbooleanasimSe o passo foi medido a partir do aninhamento próprio deste documento. Quando é false, o documento não apresenta nenhum aninhamento a medir e o passo é um valor alternativo, pelo que um cliente que prefira impor o seu sabe que é livre de o fazer.
entryShapeconst “mapping” ou const “sequence” ou const “unknown”simA forma em que o contentor contém as suas entradas, que é o que decide como o texto próprio da entrada é composto. É lida a partir do contentor que o documento já contém e nunca é deduzida da forma como o contentor se chama. O conjunto é fechado. Valores permitidos: "mapping" — O contentor é um mapeamento em bloco, pelo que uma entrada acrescentada a ele é uma chave e o seu valor. "sequence" — O contentor é uma sequência em bloco, pelo que uma entrada acrescentada a ele é um hífen e o seu valor. "unknown" — O documento não contém o contentor, ou contém-no sem nada lá dentro, pelo que cabe ao cliente decidir que forma uma entrada assume.

Não são permitidas propriedades adicionais.

AttachmentContainerResult

Em que documento, e em que ponto dele, pertence um anexo no nó do grafo, ou na ligação que o pedido nomeou.

PropriedadeTipoObrigatóriaDescrição
nodestringsimO nó do grafo ao qual o anexo se destina.
filestringsimO documento a que o anexo pertence.
containerstring[] ou nullsimO caminho através desse documento até onde pertence.

Não são permitidas propriedades adicionais.

ConnectionAtPositionResult

A ligação dentro de cuja entrada a posição cai, ou porque é que nenhuma é reportada. Exatamente uma metade está presente: graphNode e connection juntos, ou noConnectionReason sozinho. Uma posição em qualquer ponto dentro de uma entrada — no seu alias, no seu destino ou nos seus anexos — está dentro dessa entrada, a mais interior quando as entradas se aninham; uma posição na própria chave de um socket, acima das entradas escritas sob ela, não está dentro de nenhuma.

PropriedadeTipoObrigatóriaDescrição
graphNodestringnãoO id do nó cujo componente traça a ligação, tal como o grafo compilado o indexa — o valor que os pedidos de candidatura e de contentor recebem como graphNode.
connectionConnectionCoordinatenãoA ligação, pelo seu socket e pelo seu alias, com document a nomear o documento em que a posição foi lida — o valor que os pedidos de candidatura e de contentor recebem como connection.
noConnectionReasonconst “no-connection-entry” ou const “feature-created-connection” ou const “unknown-connection”nãoPresente apenas quando nenhuma ligação é reportada: o motivo. O conjunto é fechado. Valores permitidos: "no-connection-entry" — A posição não está em nenhuma entrada em que um anexo é escrito: nem uma ligação que um componente traça, escrita sob o seu alias, nem uma entrada por aresta na Release. Uma ligação escrita como uma lista de destinos, e uma que o próprio bloco de uma Feature traça, não contêm nenhuma entrada desse tipo. "feature-created-connection" — A posição está na entrada da Release para uma ligação que uma Feature traçou, e um anexo só é escrito numa ligação que um componente ou a Release traça. "unknown-connection" — A posição está numa entrada que a Release escreve para uma ligação que o grafo compilado não contém.

Não são permitidas propriedades adicionais.

ReleaseCandidatesResult

As Releases que o espaço de trabalho contém, e os links que conduzem para fora dele, para diretórios e para ficheiros, que não foram lidos para elas.

PropriedadeTipoObrigatóriaDescrição
releasesstring[] ou nullsimCada documento de Release.
lockfilesmapa de stringsimO ficheiro de bloqueio de cada Release listada, indexado pela Release exatamente como está listada. Cada um é o ficheiro que um pull escreve para essa Release e que uma compilação lê, pelo que um cliente lê onde se encontra em vez de o deduzir. Vazio quando o espaço de trabalho não contém nenhuma Release.
unreadLinkedDirsstring[]simCada link sob a raiz do espaço de trabalho que conduz a um diretório fora dela, nomeado de forma relativa à raiz no local onde o próprio link se encontra, pela ordem em que o espaço de trabalho é pesquisado. Nenhum diretório fora da raiz é pesquisado, pelo que uma Release alcançada apenas através de um destes links não está em releases, e um cliente que oferece Releases pode dizer porquê. Não nomeados: um link para um diretório dentro da raiz, que é pesquisado, ou deixado de fora, onde realmente se encontra; um link em qualquer local onde um diretório seria deixado de fora, seja pelo local onde se encontra ou pelo seu nome; e um link que não pode ser resolvido, porque não conduz a lado nenhum ou anda em círculo. Vazio quando o espaço de trabalho não contém nenhum.
unreadLinkedFilesstring[]simCada link sob a raiz do espaço de trabalho que tem nome de ficheiro YAML, com o seu próprio nome a terminar em .yaml ou .yml, e conduz a um ficheiro fora da raiz, nomeado de forma relativa à raiz no local onde o próprio link se encontra, pela ordem em que o espaço de trabalho é pesquisado. Um ficheiro assim não é lido, pelo que uma Release alcançada apenas através de um destes links não está em releases, e um cliente que oferece Releases pode dizer porquê. Se um ficheiro é uma Release não se sabe sem o ler, pelo que cada link deste tipo é nomeado seja o que for que o ficheiro contenha. Não nomeados: um link para um ficheiro que a configuração do espaço de trabalho nomeia como Release, como build.authoring_release ou como chave de workspace.releases, o qual é lido e listado em releases no local próprio do link; um link para um ficheiro dentro da raiz, que é lido; um link dentro de um diretório que a pesquisa deixa de fora; e um link que não conduz a nenhum ficheiro, seja a um diretório, que unreadLinkedDirs nomeia quando conduz para fora da raiz, a lado nenhum ou em círculo. Um ficheiro de configuração do espaço de trabalho que é um link que conduz para fora do espaço de trabalho, o seu próprio .aggrega-config.yaml ou o overlay detido pela CI ao lado dele, é nomeado quer a pesquisa o tenha encontrado quer não, depois dos links que a pesquisa nomeou: a configuração do espaço de trabalho não é então lida de todo, esta resposta é lida sem nada configurado, pelo que nenhuma Release que a configuração nomeie através de um link é listada, e cada pedido que a configuração decide é recusado para esse espaço de trabalho com a condição do bloqueio de leitura.

Não são permitidas propriedades adicionais.

ActiveReleaseResult

Sobre que Release um cliente deve agir por predefinição. Um espaço de trabalho que não aponta para nenhuma Release é um estado normal e não uma falha, pelo que é reportado aqui com um relato de como a escolha foi tentada, em vez de ser levantado como erro.

PropriedadeTipoObrigatóriaDescrição
releasestringsimA Release que foi escolhida, ou vazio quando nenhuma foi.
lockfilestringnãoO ficheiro de bloqueio da Release que foi escolhida: o ficheiro que um pull escreve para ela e que uma compilação lê. Ausente quando nenhuma Release foi escolhida.
reasonstringnãoPor que razão nenhuma Release foi escolhida.
tracestringnãoCada passo da escolha e o que encontrou, para que um chamador possa ver qual a teria decidido.

Não são permitidas propriedades adicionais.

EditDocumentResult

O que a edição escreveu, e onde. Depois de uma escrita, a leitura do documento que o daemon guarda é descartada, pelo que a resposta seguinte sobre ele é calculada a partir dos bytes que a edição produziu.

PropriedadeTipoObrigatóriaDescrição
filestringsimO documento que foi editado.
editstringsimQue edição foi aplicada.
containerstring[] ou nullsimO caminho através do documento até onde a edição foi parar.
createdContainersstring[] ou nullsimOs contentores que a edição teve de criar pelo caminho.
writtenstring[] ou nullsimOs documentos que foram escritos.
contentstringsimO documento composto, para um pedido que pediu para ver o resultado em vez de o mandar escrever.

Não são permitidas propriedades adicionais.

EffectiveConfigurationResult

A configuração que o espaço de trabalho resolveu, e de que documento veio cada definição.

PropriedadeTipoObrigatóriaDescrição
layersstring[] ou nullsimOs documentos de configuração que foram fundidos, pela ordem em que foram fundidos.
settingsEffectiveConfigurationSetting[] ou nullsimCada definição resolvida e de onde veio.

Não são permitidas propriedades adicionais.

ConfigInitResult

O que a inicialização de uma configuração escreveu, onde, e o que leu do registo.

PropriedadeTipoObrigatóriaDescrição
hoststringsimO registo para o qual a configuração foi inicializada.
scopeConfigWriteScopesimQue documento de configuração foi escrito e até onde alcança. Um pedido nomeia um espaço de trabalho, pelo que uma resposta que nada dissesse seria lida como dizendo respeito a esse espaço de trabalho — e, para uma escrita de toda a máquina, essa leitura está errada.
trustTrustFetchOutcomesimO que a leitura da política de confiança anunciada de um registo produziu. Os resultados são mantidos separados porque significam coisas diferentes: a política anunciada foi adotada, o registo não anunciou nada — o que não é uma falha —, a base de referência incorporada foi fixada no seu lugar, ou não foi tentada nenhuma leitura. Quando nada foi anunciado, indica-se ao lado se o registo pôde sequer ser alcançado.
writtenbooleanasimSe o documento foi escrito, em vez de devolvido para o chamador o colocar.
existedbooleananãoPresente e true quando o documento já lá estava, pelo que a entrada do registo foi fundida nele em vez de ser criado um novo documento. Apenas um pedido que envie force prossegue sobre um documento existente, pelo que está ausente de cada resposta a um pedido que não o tenha feito.
contentstringnãoO texto do documento, para um pedido que pediu para o ver em vez de o mandar escrever.

Não são permitidas propriedades adicionais.

ConfigCaptureResult

O que o congelamento da configuração resolvida escreveu no documento próprio deste espaço de trabalho.

PropriedadeTipoObrigatóriaDescrição
configFilestringsimO documento que foi escrito. É sempre o próprio deste espaço de trabalho, uma vez que todo o propósito é tornar um espaço de trabalho autossuficiente.
workspaceRootstringsimO espaço de trabalho que o pedido nomeou.
capturedbooleanasimSe algo foi congelado.
socketsConfigCapturedSocket[] ou nullsimCada socket que foi congelado, com os seus anexos.
catalogDirsstring[] ou nullsimOs diretórios de catálogo que foram congelados.

Não são permitidas propriedades adicionais.

ImportResult

O que a conversão de uma fonte externa produziu, e o que não conseguiu converter.

PropriedadeTipoObrigatóriaDescrição
formatstringsimO formato de origem que foi convertido.
outputDirstringsimO diretório ao qual cada caminho na resposta é relativo, e aquele em que os ficheiros foram escritos.
writtenstring[] ou nullsimCada ficheiro que chegou ao disco, pela ordem de escrita: os rascunhos, depois o registo daquilo que a importação escreveu. Sob sync, apenas os rascunhos que a sincronização alterou e o registo quando este mudou. Vazio sob dryRun.
filesImportedFile[] ou nullsimCada ficheiro que o pedido escreve, com o seu texto, sob dryRun e sem ele: cada rascunho, depois o registo daquilo que a importação escreveu. Sob sync, cada rascunho que a sincronização altera, com o seu novo texto, depois o registo quando também este muda, pelo que uma sincronização já em dia responde com uma lista vazia.
driftImportDrift[]simCada parte que uma sincronização atualizou face à fonte, ou atualizaria sob dryRun, pela ordem em que o rascunho as nomeia; um ficheiro redigido que a sincronização elimina é uma delas, removida sem chaves. Uma lista vazia para um pedido que não é uma sincronização, para uma sincronização já em dia, e para uma sincronização cuja conversão parou, que não escreve nada.
diagnosticsImportDiagnostic[] ou nullsimO que não pôde ser convertido.
decisionsImportDecision[]simComo o importador mapeou cada nó da fonte, pela ordem do importador e exatamente como o reportou: aquilo que indica onde a conversão adivinhou. Presente em ambas as formas de entrega e quer a conversão tenha parado quer não, e uma lista vazia para um importador que não reporta nenhuma.
owedImportOwed[]nãoCada valor que os rascunhos ainda deixam vazio e que nenhuma fonte pôde fornecer nem nenhuma resposta forneceu, pela ordem em que os rascunhos são escritos — os valores que as constatações de aviso indicam. Todas as respostas o incluem, como uma lista vazia quando os rascunhos nada devem.
haltedbooleanasimSe a conversão parou em vez de terminar com conclusões.

Não são permitidas propriedades adicionais.

ScaffoldEntityResult

O documento inicial redigido, a lista de exemplos executáveis ou o exemplo escrito — cada forma responde com os seus próprios campos e deixa os outros ausentes.

PropriedadeTipoObrigatóriaDescrição
kindstringnãoO tipo de entidade que foi redigido. Presente num rascunho.
skeletonstringnãoO texto do documento redigido. Presente num rascunho.
examplesScaffoldExample[]nãoCada exemplo executável que a documentação publica, cada um uma vez, por ordem de nome. Presente numa listagem que encontrou algum.
examplestringnãoO exemplo que foi escrito. Presente numa escrita.
dirstringnãoO diretório em que o exemplo foi escrito, relativo à raiz do espaço de trabalho, tal como o pedido o nomeou ou, quando não nomeou nenhum, como o nome do exemplo. Presente numa escrita.
filesstring[]nãoCada ficheiro escrito, relativo a dir e separado por barras, pela ordem em que a documentação os apresenta. Presente numa escrita.
nextstring[]nãoOs comandos que a página do exemplo indica para o compilar, linha a linha tal como a página os escreve, comentários incluídos: o primeiro bloco de shell sob o seu título Build. Ausente quando a página não indica nenhum.
versionstringnãoA versão da documentação a partir da qual o exemplo foi lido: a do próprio binário, quando existe uma publicada para ele, caso contrário a mais recente publicada antes dele. Presente numa escrita.

Não são permitidas propriedades adicionais.

ScaffoldExample

Um exemplo executável que a documentação publica.

PropriedadeTipoObrigatóriaDescrição
namestringsimO nome do exemplo, que um pedido envia como example para o escrever.
levelstringsimO nível que a página do exemplo declara para ele.
summarystringsimA primeira frase da página do exemplo.

Não são permitidas propriedades adicionais.

LintResult

O que a verificação de convenções encontrou, contado por gravidade e listado por documento. Uma verificação do catálogo inteiro que foi executada uma vez para cada Release contém também passes; as contagens e files abrangem então todas as passagens em conjunto.

PropriedadeTipoObrigatóriaDescrição
entitystringnãoA única entidade que foi verificada, quando o pedido nomeou uma.
releasestringnãoA Release cujo fecho foi verificado, quando o pedido nomeou uma.
checkedintegersimQuantos documentos foram verificados. Quando a verificação foi executada uma vez para cada Release, a soma sobre as passagens: um documento que duas passagens leem é contado em cada uma.
findingsintegersimQuantas conclusões há no total.
errorsintegersimQuantas delas são erros.
warningsintegersimQuantas delas são alertas.
infosintegersimQuantas delas são informativas.
filesLintFileFindings[] ou nullsimAs conclusões, por documento.
haltedbooleanasimSe a verificação parou em vez de terminar com conclusões.
passesLintPass[] ou nullnãoA verificação do catálogo inteiro uma passagem de cada vez, presente apenas quando foi executada uma vez para cada Release porque o espaço de trabalho nomeia Releases sob workspace.releases. Cada passagem diz para que Releases as suas conclusões foram encontradas. Ausente para um espaço de trabalho que não nomeia nenhuma, que é verificado uma vez sobre os seus próprios diretórios, e para uma verificação de uma única entidade ou do fecho de uma Release.

Não são permitidas propriedades adicionais.

LintPass

Uma passagem de uma verificação de convenções do catálogo inteiro num espaço de trabalho que dá às suas Releases diretórios de catálogo próprios: as Releases para as quais foi executada, os diretórios que leu e o que lá encontrou.

PropriedadeTipoObrigatóriaDescrição
releasesstring[] ou nullsimAs Releases para as quais a passagem foi executada, cada uma como caminho relativo à raiz do espaço de trabalho. As Releases que leem os mesmos diretórios de catálogo partilham uma passagem.
catalogDirsstring[] ou nullsimOs diretórios de catálogo que a passagem leu, pela ordem em que são pesquisados, cada um relativo à raiz do espaço de trabalho quando se encontra dentro dela. Vazio quando as suas Releases não leem nenhum diretório de catálogo, pelo que a passagem não verificou nada e não fez falhar nenhuma das outras.
checkedintegersimQuantos documentos a passagem verificou.
findingsintegersimQuantas conclusões a passagem encontrou.
errorsintegersimQuantas delas são erros.
warningsintegersimQuantas delas são alertas.
infosintegersimQuantas delas são informativas.
filesLintFileFindings[] ou nullsimAs conclusões da passagem, por documento.

Não são permitidas propriedades adicionais.

PluginAddResult

O que anexar um plugin escreveu, onde e que versão fixou.

PropriedadeTipoObrigatóriaDescrição
typestringsimO socket ao qual o plugin foi anexado.
identitystringnãoA identidade em que o anexo foi resolvido.
uristringnãoA referência a partir da qual o anexo é resolvido.
capabilitystringnãoA capacidade a que o anexo se destina.
referencestringnãoA referência fixada, versão incluída.
scopePluginWriteScopesimEm que documento de configuração uma alteração de plugin foi escrita e até onde alcança. A predefinição própria do socket de extensão de comandos é o documento de toda a máquina, pelo que cada resposta diz qual escreveu.
writtenbooleanasimSe o documento de configuração foi escrito, em vez de devolvido para o chamador o colocar.
contentstringnãoO texto do documento de configuração, para um pedido que pediu para o ver em vez de o mandar escrever.
retractionPluginRetractionnãoComo um marcador de descontinuação determinou que versão do plugin foi fixada.
withdrawnbooleananãoÉ true quando a consulta indicou a versão que foi fixada e uma retratação em que este espaço de trabalho confia retirou essa versão. Uma versão indicada é fixada mesmo assim, porque indicá-la é a substituição. Ausente caso contrário, e a ausência não significa que a versão não esteja retirada: onde os marcadores de retirada de uma versão indicada não puderam ser lidos, retraction.unscreened indica porquê, e, sem nenhuma versão indicada, é escolhida a versão publicada mais recente e retraction comunica o que a verificação de retirada concluiu sobre essa escolha.

Não são permitidas propriedades adicionais.

PluginRemoveResult

O que desanexar um plugin escreveu, e onde.

PropriedadeTipoObrigatóriaDescrição
typestringsimO socket ao qual o plugin foi anexado.
querystringsimQue anexo foi removido.
scopePluginWriteScopesimEm que documento de configuração uma alteração de plugin foi escrita e até onde alcança. A predefinição própria do socket de extensão de comandos é o documento de toda a máquina, pelo que cada resposta diz qual escreveu.

Não são permitidas propriedades adicionais.

PluginSyncResult

O que o alinhamento dos registos geridos pela máquina de uma entidade Plugin com o seu módulo alterou.

PropriedadeTipoObrigatóriaDescrição
entitystringsimO documento da entidade Plugin que foi alinhado.
hostFunctionsstring[] ou nullsimAs funções de host de que o módulo declara precisar.
commandsPluginCLICommand[] ou nullsimOs comandos que o módulo fornece.
changedbooleanasimSe algo no documento mudou efetivamente.

Não são permitidas propriedades adicionais.

PluginGenCatalogResult

Os documentos de catálogo que uma geração produziu.

PropriedadeTipoObrigatóriaDescrição
documentsPluginGeneratedDocument[]nãoCada documento gerado e o seu texto.
noticesstringnãoQualquer coisa que a geração queira dar a conhecer ao chamador.
dryRunbooleanasimSe os documentos foram devolvidos em vez de escritos.

Não são permitidas propriedades adicionais.

ExplainErrorResult

O que o compilador declara sobre uma condição, e as passagens publicadas que ensinam a correção de authoring.

PropriedadeTipoObrigatóriaDescrição
shortCodestringsimO código curto da condição.
codestringsimO nome descritivo da condição.
messagestringsimO que a condição diz quando é levantada.
entriesExplainErrorEntry[]nãoAs passagens publicadas que ensinam a correção.
referencestringsimO endereço publicado no qual a condição é explicada.
notestringnãoPorque é que as passagens publicadas estão ausentes, quando não puderam ser obtidas. Aquilo que o próprio binário declara continua a ser respondido.

Não são permitidas propriedades adicionais.

GetSchemaResult

O esquema de um tipo ou — quando o pedido não nomeou nenhum — que tipos podem ser nomeados. As duas amplitudes seguem numa única resposta em vez de em dois métodos, porque «o que posso nomear» e «de quais destes um autor escreve documentos» são a mesma pergunta em duas amplitudes, e duas respostas teriam de ser mantidas em concordância.

PropriedadeTipoObrigatóriaDescrição
kindstringnãoO tipo a que o esquema se destina.
schemaanynãoO próprio esquema, transmitido tal como o binário o guarda.
kindsstring[]nãoCada token a que este binário responde.
entityKindsEntityKindDescriptor[]nãoO conjunto mais restrito de que um autor escreve um documento, cada um associando o token que um pedido nomeia ao tipo que o próprio cabeçalho do documento declara.

Não são permitidas propriedades adicionais.

SkillsInstallResult

O que a instalação da skill do assistente escreveu, e onde.

PropriedadeTipoObrigatóriaDescrição
skillstringsimA skill que foi escrita.
installedSkillsInstalledFolder[]simCada pasta de skills escrita, pela ordem em que o pedido nomeou os assistentes. Os assistentes que leem uma mesma pasta partilhada partilham uma entrada, porque a skill é lá escrita uma única vez.
scopeSkillFolderScopesimAté onde alcança uma instalação de skill. Um pedido nomeia um espaço de trabalho, pelo que uma resposta que nada dissesse seria lida como dizendo respeito a esse espaço de trabalho — e, para as pastas por utilizador, que um assistente lê em cada projeto, essa leitura está errada.

Não são permitidas propriedades adicionais.

SkillsInstalledFolder

Uma pasta de skills que uma instalação escreveu.

PropriedadeTipoObrigatóriaDescrição
agentsstring[]simOs identificadores dos assistentes nomeados que leem esta pasta, pela ordem em que o pedido os nomeou.
folderstringsimA pasta da skill, como caminho absoluto.
replacedbooleanasimSe uma cópia que contém a linha de comentário que cada cópia escrita da skill contém — uma que uma instalação anterior escreveu, ou uma obtida do repositório de skills publicado — estava lá e foi substituída. Um ficheiro lá presente sem essa linha é recusado em vez de substituído.

Não são permitidas propriedades adicionais.

SkillsListResult

As skills que o binário inclui e cada assistente para o qual uma instalação as pode escrever. Nada é escrito e nada é contactado.

PropriedadeTipoObrigatóriaDescrição
skillsSkillsListedSkill[]simCada skill que o binário inclui, por uma ordem fixa.
agentsSkillsListedAgent[]simCada assistente para o qual uma instalação conhece uma pasta de skills, ordenado por identificador.

Não são permitidas propriedades adicionais.

SkillsListedSkill

Uma skill que o binário inclui.

PropriedadeTipoObrigatóriaDescrição
namestringsimO nome da skill, que é também o nome da pasta que uma instalação escreve.
descriptionstringsimQuando um assistente usa a skill, tal como a própria skill o declara.

Não são permitidas propriedades adicionais.

SkillsListedAgent

Um assistente para o qual uma instalação pode escrever uma skill, com as duas pastas a partir das quais lê skills.

PropriedadeTipoObrigatóriaDescrição
idstringsimO identificador pelo qual um pedido nomeia o assistente.
namestringsimO próprio nome do assistente.
projectFolderstringsimA pasta, relativa à raiz de um projeto e separada por barras, a partir da qual o assistente lê as skills de um projeto. Uma instalação de projeto escreve a pasta da skill dentro dela, no espaço de trabalho que o pedido nomeia.
userFolderstringsimA pasta, relativa ao diretório pessoal e separada por barras, a partir da qual o assistente lê as skills próprias do utilizador em cada projeto. Uma instalação com global escreve a pasta da skill dentro dela.

Não são permitidas propriedades adicionais.