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

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

Referência gerada. Não edite à mão — gere 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 configurações e o espaço de trabalho sobre os quais a conversa foi aberta; o daemon é o processo que responde a uma requisição, envia uma notificação e mantém 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: uma requisição que o cliente envia, uma notificação que o cliente envia, uma notificação que o daemon envia, ou a resposta que o daemon retorna para uma requisição. Três propriedades da superfície decidem como as formas abaixo são escritas. Primeiro, toda requisição 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 a requisição atua, e workDoneToken, o valor gerado pelo chamador sob o qual o progresso é informado — então ambos aparecem aqui em todo objeto params de requisição, incluindo os três métodos cujo sujeito não é um espaço de trabalho: aggrega/getSchema e aggrega/scaffoldEntity aceitam workspaceRoot e o ignoram, e aggrega/initialize o lê como o espaço de trabalho que a sessão declara. Segundo, o daemon recusa um objeto params de requisição que traz um campo que o método não aceita, nomeando o que ele aceita, então aqui todo objeto params é fechado no seu nível superior; um objeto aninhado dentro de uma requisição não é fechado, porque a verificação lê apenas os nomes de campo mais externos. Terceiro, um resultado é composto pelo daemon em vez de fornecido por um chamador, então os objetos de resultado são fechados em todo nível cuja forma é fixa, e abertos apenas onde o valor é JSON opaco que o daemon repassa 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 informar e como uma coleção vazia quando o valor que informa está vazio, então 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 toda mensagem traz. Apenas a 2.0 é falada.

Tipo: const "2.0"

Constante: "2.0"

RequestId

O identificador do chamador para uma requisição, repetido na resposta que a atende. Uma mensagem que não traz nenhum identificador é uma notificação e nunca é respondida.

Tipo: string or number

ProgressToken

Um valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.

Tipo: string or number

WorkspaceRootSubject

O caminho absoluto do espaço de trabalho sobre o qual esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.

Tipo: string

WorkspaceRootAccepted

O caminho absoluto de um espaço de trabalho. O sujeito deste método não é um espaço de trabalho — ele responde a partir do que o próprio binário traz — então o campo é aceito e não lido. Ele é admitido porque um cliente pode enviá-lo de forma uniforme em toda requisição sem precisar saber quais métodos o consultam.

Tipo: string

RequestMethod

Todo método que uma requisição pode nomear. O conjunto é fechado: uma requisição que nomeia qualquer outra coisa é respondida com 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

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

Tipo: string (enum)

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

DaemonNotificationMethod

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

Tipo: string (enum)

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

Request

Uma requisição que o cliente envia e o daemon responde. O método nomeia o que está sendo pedido; o objeto params traz os campos próprios desse método mais os dois que todo método admite. Uma requisição que omite params por completo é lida como uma cujos campos estão todos ausentes.

PropriedadeTipoObrigatóriaDescrição
jsonrpcProtocolVersionsimA versão do JSON-RPC que toda mensagem traz. Apenas a 2.0 é falada.
idRequestIdsimO identificador do chamador para uma requisição, repetido na resposta que a atende. Uma mensagem que não traz nenhum identificador é uma notificação e nunca é respondida.
methodRequestMethodsimTodo método que uma requisição pode nomear. O conjunto é fechado: uma requisição que nomeia qualquer outra coisa é respondida com um erro de método não encontrado.
paramsobjectnã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. Ela não traz nenhum identificador e nunca é respondida.

PropriedadeTipoObrigatóriaDescrição
jsonrpcProtocolVersionsimA versão do JSON-RPC que toda mensagem traz. Apenas a 2.0 é falada.
methodClientNotificationMethodsimTodo método que uma notificação do cliente pode nomear. O conjunto é fechado, e nenhuma das duas notificações é respondida.
paramsobjectnã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. Ela não traz nenhum identificador e nunca é respondida.

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

Não são permitidas propriedades adicionais.

params para cada method:

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

CancelRequestParams

Pede ao daemon que abandone uma requisição já em andamento, nomeando-a pelo identificador que a requisição trazia. Para uma requisição já concluída, ou nunca enviada, simplesmente não há nada a cancelar, e nada é informado.

PropriedadeTipoObrigatóriaDescrição
idRequestIdsimO identificador do chamador para uma requisição, repetido na resposta que a atende. Uma mensagem que não traz nenhum identificador é uma notificação e nunca é respondida.

Não são permitidas propriedades adicionais.

ShutdownParams

Pede ao daemon que pare de aceitar trabalho e termine o que já assumiu. A notificação não traz campos, e a própria notificação costuma ser enviada sem nenhum objeto params. Uma segunda abandona o trabalho ainda em andamento 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 andamento, enviado apenas para uma requisição que gerou um token de progresso em uma sessão que declarou que podia recebê-los.

PropriedadeTipoObrigatóriaDescrição
tokenProgressTokensimUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
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 encerramento.

Não são permitidas propriedades adicionais.

ProgressBegin

Abre um relatório, dizendo 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. Ela não traz nenhuma fração: as operações que relatam aqui percorrem um conjunto cujo tamanho não é conhecido quando o trabalho começa, então 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 ao redor removidos.

Não são permitidas propriedades adicionais.

ProgressEnd

Encerra um relatório. Ele não traz nada além do tipo, porque o resultado viaja na resposta que o chamador já está aguardando.

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

Não são permitidas propriedades adicionais.

PublishDiagnosticsParams

Os achados de um arquivo, enviados pelo daemon quando uma validação os produziu para um documento diferente daquele que a requisição nomeou.

PropriedadeTipoObrigatóriaDescrição
filestringsimO arquivo ao qual os achados se referem.
diagnosticsDiagnostic[] ou nullsimOs achados, na ordem em que foram produzidos.

Não são permitidas propriedades adicionais.

SuccessResponse

A resposta a uma requisição bem-sucedida, trazendo o identificador da requisição que ela responde. Uma resposta não traz nenhum método, então qual forma de resultado se aplica é definido pela requisição à qual o identificador pertence e não por nada na própria resposta.

PropriedadeTipoObrigatóriaDescrição
jsonrpcProtocolVersionsimA versão do JSON-RPC que toda mensagem traz. Apenas a 2.0 é falada.
idRequestIdsimO identificador do chamador para uma requisição, repetido na resposta que a atende. Uma mensagem que não traz nenhum identificador é uma notificação e nunca é respondida.
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 solicitado retorna.

Não são permitidas propriedades adicionais.

ErrorResponse

A resposta a uma requisição que foi recusada ou falhou, trazendo o identificador da requisição que ela responde.

PropriedadeTipoObrigatóriaDescrição
jsonrpcProtocolVersionsimA versão do JSON-RPC que toda mensagem traz. Apenas a 2.0 é falada.
idRequestIdsimO identificador do chamador para uma requisição, repetido na resposta que a atende. Uma mensagem que não traz nenhum identificador é uma notificação e nunca é respondida.
errorErrorObjectsimO que deu errado: um código pelo qual um cliente pode ramificar sua lógica, uma mensagem escrita para uma pessoa ler e — onde a condição tem uma — os artefatos e a posição no código-fonte a que a mensagem se refere.

Não são permitidas propriedades adicionais.

ErrorObject

O que deu errado: um código pelo qual um cliente pode ramificar sua lógica, uma mensagem escrita para uma pessoa ler e — onde a condição tem uma — os artefatos e a posição no código-fonte a que a mensagem se refere.

PropriedadeTipoObrigatóriaDescrição
codeErrorCodesimA condição que a resposta informa. Os códigos negativos são o conjunto reservado do próprio protocolo; os códigos de quatro dígitos 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 deu errado, em prosa. É a mesma redação que a mesma condição traz em toda outra superfície que a informa.
dataErrorDatanãoOs artefatos e a posição no código-fonte a que a mensagem se refere, trazidos de forma estruturada para que um cliente não precise extraí-los da prosa. Todo campo é opcional e uma condição preenche apenas o que tem em mãos; nenhum campo substitui outro, então um cliente sabe o que recebeu pelo campo que leu e não pelo código ao lado dele.

Não são permitidas propriedades adicionais.

ErrorCode

A condição que a resposta informa. Os códigos negativos são o conjunto reservado do próprio protocolo; os códigos de quatro dígitos 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 é uma requisição bem formada.
  • -32601 — Não existe nenhum método com esse nome.
  • -32602 — Os params que a requisição trazia 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 mantém nenhuma leitura do arquivo e não está produzindo nenhuma. O cliente inicia uma pedindo uma validação e depois tenta novamente.
  • 1003 — O arquivo de bloqueio da Release que a requisição nomeou está ausente, e a operação precisa de um.
  • 1004 — Não foi possível resolver a entidade que a requisição nomeou nem a partir do catálogo nem a partir da Release que a requisição nomeou.
  • 1005 — O daemon está sendo encerrado e está recusando trabalho novo. O cliente não tenta novamente no mesmo daemon.
  • 1006 — Uma validação do arquivo está em execução agora e não terminou dentro do prazo que a requisição em espera permitia. O cliente aguarda e pede novamente, sem enviar nada nesse meio-tempo.

ErrorData

Os artefatos e a posição no código-fonte a que a mensagem se refere, trazidos de forma estruturada para que um cliente não precise extraí-los da prosa. Todo campo é opcional e uma condição preenche apenas o que tem em mãos; nenhum campo substitui outro, então um cliente sabe o que recebeu pelo campo que leu e não pelo código ao lado dele.

PropriedadeTipoObrigatóriaDescrição
filestringnãoO documento-fonte que os campos de posição localizam — o documento sendo 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 onde o token não tem um fim recuperável, caso em que um cliente exibe 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 a requisição a nomeou, para que um cliente possa compor a solução sem precisar remontá-la.
lockfilestringnãoO arquivo de bloqueio de que trata uma condição relativa ao arquivo de bloqueio: o caminho que foi procurado e não encontrado, ou que não pôde ser lido.
unreachablebooleanonãoSe a recusa diz respeito a um registro nomeado pela requisição que não pôde ser alcançado: seu nome não foi resolvido, uma conexão com ele foi recusada ou não pôde ser aberta, ou uma conexão segura com ele não pôde ser estabelecida. É lido da própria falha e não da mensagem, e só é definido onde a falha mostra que o registro nunca foi alcançado. Uma atualização de índice recusada que nomeia um registro o traz; um registro que respondeu, seja o que for que tenha respondido, o deixa 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 informa essa condição traz em seu próprio código. É por ele que um cliente ramifica sua lógica, e não pela mensagem nem pelo código numérico ao lado dele, que nomeia o estado da requisição e permanece o mesmo para toda condição. Presente exatamente quando a recusa nomeia uma condição registrada, e ausente quando não nomeia nenhuma.
shortCodestringnãoO código curto da condição, a letra E seguida de quatro dígitos: a forma que um leitor cita e consulta, 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

Um achado sobre um documento: onde está, quão grave é, o que diz e o código citável que nomeia a condição que ele informa.

PropriedadeTipoObrigatóriaDescrição
lineintegersimA linha a que o achado se refere, contada a partir de um.
columnintegersimA coluna a que o achado se refere, contada a partir de um.
severityconst “error” ou const “warning” ou const “info”simQuão grave é o achado. Valores permitidos: "error" — O achado é um erro. Um achado de plugin com severidade halt é informado neste nível. "warning" — O achado é informado e não é um erro. Um achado de plugin com severidade warn é informado neste nível. "info" — O achado é uma informação, como é um achado de plugin com severidade info.
messagestringsimO que o achado diz, em prosa.
codestringnãoO nome descritivo da condição, estável entre versões e citável em uma supressão.
shortCodestringnãoO código curto da condição, a forma que abre um diagnóstico bloqueante.
codeDescriptionCodeDescriptionnãoOnde a condição que o achado nomeia é explicada.
classificationstringnãoComo se chegou ao achado, onde a condição faz essa distinção.
suggeststringnãoA grafia que o achado propõe, onde a condição pode nomear uma — um identificador quase correto, por exemplo.
keyPathstringnãoO caminho através do documento até a chave a que o achado se refere.
sourcestringsimO que produziu o achado.
end_lineintegernãoA linha uma posição além do fim do token a que o achado se refere, para que um cliente possa exibir o token inteiro em vez de um único caractere. 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 o achado se refere.

Não são permitidas propriedades adicionais.

CodeDescription

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

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

Não são permitidas propriedades adicionais.

Position

Um ponto em um documento: uma linha e um deslocamento de caractere 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 em um documento: uma linha e um deslocamento de caractere 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 em um documento: uma linha e um deslocamento de caractere 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 em um documento nomeado.

PropriedadeTipoObrigatóriaDescrição
uristringsimO documento em que o trecho está, 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. Ele ainda admite os dois campos que toda requisição admite: o espaço de trabalho sobre o qual ela atua e um token de progresso.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.

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 em vez de um sujeito: ausente, vazio e um caminho são três coisas diferentes, e uma sessão aberta sem caminho é uma 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. Membros desconhecidos são ignorados em vez de recusados, então 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 string vazia é um caminho que o cliente forneceu e não é o mesmo que não enviar nenhum.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.

Não são permitidas propriedades adicionais.

ClientCapabilities

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

PropriedadeTipoObrigatóriaDescrição
generalobjectnãoCapacidades que não estão ligadas a um único tipo de resposta.
windowobjectnãoCapacidades sobre o que o cliente pode mostrar enquanto um trabalho está em andamento.

Propriedades adicionais são permitidas.

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.

Propriedades adicionais são permitidas.

ClientCapabilities.window

Capacidades sobre o que o cliente pode mostrar enquanto um trabalho está em andamento.

PropriedadeTipoObrigatóriaDescrição
workDoneProgressbooleanonãoSe o cliente pode receber notificações de progresso. Uma requisição que gera um token de progresso em uma sessão que não declarou isso é recusada.

Propriedades adicionais são permitidas.

ValidateParams

Verifica o espaço de trabalho, ou um documento nele, e responde com os achados.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
filestringnãoO documento a verificar. Se ausente, verifica o que o espaço de trabalho contém.
contentstringnãoO texto do documento como o cliente o mantém no momento, para verificar um buffer que não foi salvo. Se ausente, lê os bytes no disco.
releasestringnãoA Release com base na qual verificar, como caminho relativo à raiz do espaço de trabalho.

Não são permitidas propriedades adicionais.

InvalidateParams

Informa ao daemon que um documento do qual ele mantém 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 esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
filestringnãoO documento que mudou.
granularitystringnãoQuanto do que o daemon mantém deve ser descartado: file descarta apenas o que ele mantém para o documento nomeado; workspace, o padrão e a forma como qualquer outro valor é lido, descarta também o que ele mantém para todo o espaço de trabalho.

Não são permitidas propriedades adicionais.

DiagnosticsParams

Responde com os achados que o daemon já mantém para um documento, sem verificá-lo novamente.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
filestringnãoO documento sobre o qual informar. O daemon já deve manter uma leitura dele.

Não são permitidas propriedades adicionais.

IrGraphParams

Responde com o grafo resolvido em que uma Release é compilada, sem renderizá-lo.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
releasestringnãoA Release a resolver, como caminho relativo à raiz do espaço de trabalho. Um caminho absoluto é recusado.
unredactedbooleanonãoSe deve responder com os valores que um autor declarou sensíveis em texto claro. Se ausente ou false, cada um deles é retido do grafo e um marcador que indica o motivo fica em seu lugar, como a saída de grafo da linha de comando 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 artefatos renderizados no espaço de trabalho.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
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 o diretório de saída é criado, como caminho relativo à raiz do espaço de trabalho. Os artefatos chegam ao diretório de saída abaixo dele, organizados como ficam sob a raiz do espaço de trabalho quando nada é nomeado — então 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.
autoPullbooleanonãoSe deve resolver primeiro as dependências da Release. Pedir isso alcança os registros configurados e escreve o arquivo de bloqueio; sem pedir, a compilação não alcança nenhum registro.
policyInputstringnãoO diretório em que escrever, ao lado dos artefatos, o payload que cada papel de governança entrega a um plugin vinculado ali, como caminho relativo à raiz do espaço de trabalho — os arquivos que aggrega build --policy-input escreve, com os mesmos nomes, escritos quer a compilação termine, quer pare. Os avisos da resposta dizem quantos foram escritos e nomeiam cada papel para o qual nenhum arquivo foi escrito. Em uma requisição que falha, os arquivos escritos estão no disco e essa contagem não está na resposta: o erro traz 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 informa o que a escrita dos artefatos teria produzido, sem escrever nenhum deles. Recusa o campo de resolução de dependências que a compilação com escrita aceita, porque uma requisição que não escreve nada não pode preencher um arquivo de bloqueio.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
releasestringnãoA Release a compilar, como caminho relativo à raiz do espaço de trabalho.
autoPullbooleanonãoAceito nas mensagens transmitidas e recusado pelo método: esta requisição não escreve nada, então não pode preencher um arquivo de bloqueio e continuar sendo o que diz ser.
policyInputstringnãoO diretório em que escrever o payload que cada papel de governança entrega a um plugin vinculado ali, como caminho relativo à raiz do espaço de trabalho — os arquivos que aggrega build --dry-run --policy-input escreve, com os mesmos nomes. Se enviado, eles são a única coisa que esta requisição escreve; o diretório de saída e o arquivo de bloqueio ficam intactos. Os avisos da resposta dizem quantos foram escritos e nomeiam cada papel para o qual nenhum arquivo foi escrito. Em uma requisição que falha, os arquivos escritos estão no disco e essa contagem não está na resposta: o erro traz 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 está o documento que a define.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
namestringnãoA entidade a resolver, por nome — ou uma referência de registro, oci://<host>/<repository>:<tag> ou @<digest> no lugar 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 pelos diretórios de catálogo que a configuração do espaço de trabalho atribui a essa Release, de modo que um nome que várias variantes declaram em um mesmo espaço de trabalho, uma por Release, é resolvido para a variante com a qual 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 registro não aceita nenhuma Release e é recusada se trouxer uma, assim como um valor que não nomeia nenhum arquivo de Release.

Não são permitidas propriedades adicionais.

CatalogIndexParams

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

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
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, de modo que um espaço de trabalho que mantém variantes de uma entidade lado a lado, uma por Release, é listado com a variante com a qual essa Release é compilada. Se ausente, a listagem é a do próprio espaço de trabalho. Um valor que não nomeia nenhum arquivo de Release é recusado.

Não são permitidas propriedades adicionais.

ReleaseClosureParams

Responde com tudo 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 esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
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 arquivo de bloqueio e obtendo as entradas externas que sua renderização consome. Alcança os registros configurados e escreve.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
releasestringnãoA Release a resolver, como caminho relativo à raiz do espaço de trabalho.
upgradebooleanonãoSe deve resolver novamente dentro dos intervalos declarados em vez de respeitar o que o arquivo de bloqueio já fixa.
targetsstring[]nãoAs referências a resolver novamente, deixando o restante fixado como está. Vazio resolve tudo.
verifybooleanonãoSe deve comparar o arquivo de bloqueio registrado com a resolução que esta requisição realizaria sem ele, respeitando as fixações que essa requisição respeitaria, em vez de escrevê-lo. Uma verificação não escreve nenhum arquivo de bloqueio, registro de confiança de plugins nem entity.lock; o cache de conteúdo é lido e preenchido como essa resolução o leria e preencheria. Um desvio, e um arquivo de bloqueio ausente, fazem a requisição falhar. Não pode ser combinado com upgrade, targets ou pinSources, seja qual for o valor que pinSources traga: uma requisição que envia um deles ao lado dele é recusada como params inválidos antes que qualquer coisa seja resolvida.
pinSourcesbooleanonãoSe deve executar a etapa 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 a requisição por causa de uma cujo bloqueio não registra 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 configuração para esta requisição.

Não são permitidas propriedades adicionais.

PinParams

Registra, 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 artefato para cada Release que usa a entidade, então nada do que uma Release fornece é necessário para fixá-la. 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 esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
entitystringnãoO documento de entidade a fixar, como caminho relativo à raiz do espaço de trabalho.
dryRunbooleanonãoSe deve responder com o bloqueio que a etapa escreveria em vez de escrevê-lo. As entradas ainda são resolvidas, então o cache de conteúdo ainda é preenchido.

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 a requisição nomeia.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
maxSizestringnãoO tamanho 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 registros configurados oferecem. Lê o índice já presente no disco e não contata nenhum registro.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
querystringnãoO texto a comparar com o nome e a descrição de um registro.
kindsstring[]nãoOs tipos de entidade a manter. Vazio mantém todos os tipos.
selectorstringnãoUm seletor de rótulos que os registros mantidos devem satisfazer.
capabilitiesstring[]nãoAs capacidades que um registro de plugin mantido deve declarar.
pluginTypestringnãoO tipo de plugin a manter.
registrystringnãoO único host de registro no qual pesquisar. Se ausente, pesquisa em todo host configurado.
limitintegernãoO número máximo de registros com que responder.
includeRetractedbooleanonãoSe deve manter versões que um marcador publicado tornou obsoletas.

Não são permitidas propriedades adicionais.

RegistryAddParams

Cadastra um registro e a política de confiança que a resolução aplica ao que ele serve. Escreve o arquivo de configuração de toda a máquina, a menos que a requisição peça o contrário, de modo que todo espaço de trabalho da máquina resolve por meio da entrada.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
hoststringnãoO host de registro a cadastrar.
namestringnãoUm alias amigável que é resolvido para o host.
identitiesstring[]nãoAs identidades de assinatura confiáveis para o que este registro serve.
keyPathstringnãoO caminho de uma chave pública a considerar confiável, para um registro assinado com uma chave em vez de com uma identidade keyless.
trustedRootstringnãoO caminho da âncora de confiança com base na qual as assinaturas são verificadas.
requireSignaturesbooleanonãoSe um artefato deste registro deve trazer uma assinatura verificada. Se ausente, não declara nada e mantém em vigor o padrão resolvido.
advisorybooleanonãoSe uma verificação com falha é informada em vez de interromper a execução.
fetchTrustbooleanonãoSe deve ler a política de confiança que o registro anuncia e fixá-la. Se ausente, não declara nada e mantém em vigor o padrão resolvido.
globalbooleanonãoEscreve o arquivo de configuração de toda a máquina, que é o padrão próprio deste método.
workspacebooleanonãoEscreve o arquivo 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 registro cadastrado. Escreve o arquivo de configuração de toda a máquina, a menos que a requisição peça o contrário.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
registrystringnãoO registro a remover, por host ou por alias.
globalbooleanonãoEscreve o arquivo de configuração de toda a máquina, que é o padrão próprio deste método.
workspacebooleanonãoEscreve o arquivo 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 registro para isso. O que ele escreve é o índice sob o diretório de cache configurado próprio deste espaço de trabalho. Um registro que precisa de uma credencial que nenhuma fonte do ambiente fornece é recusado com a credencial nomeada, em vez de solicitá-la interativamente.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
registrystringnãoO único registro a atualizar. Se ausente, atualiza todo host configurado.
upgradebooleanonã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 registro armazenada. O armazenamento é compartilhado por todos os projetos da máquina, e a resposta informa isso.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
registrystringnãoO registro cuja credencial armazenada será removida.

Não são permitidas propriedades adicionais.

PublishEntityParams

Publica uma entidade em um registro. O que ela deposita é o que todo consumidor desse registro resolve, e uma versão publicada não pode ser recolhida de quem já a obteve. Nada é solicitado de forma interativa: a identidade é resolvida a partir do que a requisição forneceu ou do que o ambiente já traz.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
entitystringnãoO documento de entidade a publicar, como caminho relativo à raiz do espaço de trabalho.
registrystringnãoO registro no qual publicar. Se ausente, usa o padrão configurado.
dryRunbooleanonãoSe deve informar o que a publicação depositaria sem depositá-lo.
signbooleanonãoSe deve assinar o que é publicado. Se ausente, não declara nada e mantém em vigor o padrão resolvido.
pluginstringnãoO módulo de plugin a publicar junto com uma entidade Plugin.
fulcioUrlstringnãoA autoridade de certificação da qual obter um certificado de assinatura.
rekorUrlstringnãoO log de transparência no qual registrar a assinatura.
timestampUrlstringnãoA autoridade de carimbo de tempo com a qual contra-assinar.
identityTokenstringnãoO token de identidade com o qual assinar, fornecido pelo chamador em vez de obtido em um terminal.
pinSourcesbooleanonãoSe deve executar na entidade, antes que ela seja empacotada, a etapa de fixação que aggrega/pin executa, de modo que o entity.lock que a etapa escreve ao lado dela faça parte do que é publicado. A etapa é executada antes de qualquer recusa que julgue a entidade, e sob dryRun informa 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 configuração para esta requisição.

Não são permitidas propriedades adicionais.

PublishArtifactParams

Publica um arquivo arbitrário em um registro sob um nome e uma tag que a requisição lhe atribui.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
filestringnãoO arquivo 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 registrar para os bytes publicados.
registrystringnãoO registro no qual publicar. Se ausente, usa o padrão configurado.
dryRunbooleanonãoSe deve informar o que a publicação depositaria sem depositá-lo.

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 esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
referencesstring[]nãoAs referências publicadas a assinar.
fulcioUrlstringnãoA autoridade de certificação da qual obter um certificado de assinatura.
rekorUrlstringnãoO log de transparência no qual registrar a assinatura.
timestampUrlstringnãoA autoridade de carimbo de tempo com a qual contra-assinar.
identityTokenstringnãoO token de identidade com o qual assinar, fornecido pelo chamador em vez de obtido em um terminal.
jobsintegernãoQuantas referências são assinadas ao mesmo tempo. Se ausente, assina uma após a outra. Cada referência ainda é assinada exatamente como seria sozinha — no modo keyless, com o seu próprio certificado e a sua própria entrada no log de transparência — e a resposta mantém a ordem em que as referências foram fornecidas. Mínimo: 1.

Não são permitidas propriedades adicionais.

DeprecateArtifactParams

Marca uma versão publicada como descontinuada, para que a resolução possa informá-la ou recusá-la. O marcador é ele próprio publicado e assinado. Uma requisição envia ou uma referência com o seu conteúdo, ou um arquivo de lote cujas entradas trazem o seu próprio — nunca ambos, e nunca conteúdo ao lado do arquivo de lote.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
referencestringnãoA referência publicada a marcar. Uma alternativa a from: uma requisição que traz ambos é recusada.
severityconst “warning” ou const “error” ou const “retracted”nãoCom que força o marcador se pronuncia — se a resolução informa a versão ou a recusa. Obrigatório com reference; recusado ao lado de from, cujo arquivo de lote traz o próprio de cada marcador. Valores permitidos: "warning" — Descontinuada, no mais brando dos dois níveis consultivos: ainda selecionada quando uma versão é escolhida. "error" — Descontinuada, no mais forte dos dois níveis consultivos: ainda selecionada quando uma versão é escolhida. "retracted" — Retirada: excluída quando uma versão é escolhida.
reasonstringnãoPor que a versão está descontinuada. Obrigatório com reference; recusado ao lado de from, cujo arquivo de lote traz o próprio de cada marcador.
replacementstringnãoA referência a usar em seu lugar. Recusado ao lado de from, cujo arquivo de lote traz o próprio de cada marcador.
messagestringnãoO que é dito a um consumidor que encontra o marcador. Recusado ao lado de from, cujo arquivo de lote traz o próprio de cada marcador.
fromstringnãoUm arquivo de lote de entradas de retirada, como caminho relativo à raiz do espaço de trabalho, que anexa um marcador por entrada. Cada entrada traz 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: uma requisição que traz ambos, ou que traz ao lado dele uma severidade, um motivo, uma substituição ou uma mensagem, é recusada.
fulcioUrlstringnãoA autoridade de certificação da qual obter um certificado de assinatura.
rekorUrlstringnãoO log de transparência no qual registrar a assinatura.
timestampUrlstringnãoA autoridade de carimbo de tempo com a qual contra-assinar.
identityTokenstringnãoO token de identidade com o qual assinar, fornecido pelo chamador em vez de obtido em um 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 esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
uristringnãoO documento em que o cursor está.
positionPositionnãoUm ponto em um documento: uma linha e um deslocamento de caractere 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, nessa ordem, de modo que um nome que várias variantes em um mesmo espaço de trabalho declaram, uma por Release, leva à variante dessa Release; onde esses diretórios não declaram nenhuma entidade assim, os documentos do espaço de trabalho são pesquisados, deixando de fora os que estão sob um dos diretórios de catálogo do espaço de trabalho que a Release não lê. Se ausente, os documentos do espaço de trabalho são pesquisados primeiro, e os próprios diretórios de catálogo do espaço de trabalho apenas onde nenhum documento declara o nome. Um valor que não nomeia nenhum arquivo 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 esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
uristringnãoO documento em que o cursor está.
positionPositionnãoUm ponto em um documento: uma linha e um deslocamento de caractere 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 em 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 informada, de modo que variantes que um espaço de trabalho mantém lado a lado, uma por Release, nunca são informadas como referências umas das outras. Se ausente, todo documento do espaço de trabalho é pesquisado. Um valor que não nomeia nenhum arquivo de Release é recusado.

Não são permitidas propriedades adicionais.

FindImplementationsParams

Responde quais documentos implementam o elemento sob o cursor.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
uristringnãoO documento em que o cursor está.
positionPositionnãoUm ponto em um documento: uma linha e um deslocamento de caractere 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 informado, de modo que uma variante com a qual outra Release é compilada nunca é listada entre as desta Release. Se ausente, todo documento do espaço de trabalho é pesquisado. Um valor que não nomeia nenhum arquivo 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 esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
uristringnãoO documento em que o cursor está.
positionPositionnãoUm ponto em um documento: uma linha e um deslocamento de caractere 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, nessa ordem; onde esses diretórios não declaram nenhuma entidade assim, os documentos do espaço de trabalho são pesquisados, deixando de fora os que estão sob um dos diretórios de catálogo do espaço de trabalho que a Release não lê. Se ausente, os documentos do espaço de trabalho são pesquisados primeiro, e os próprios diretórios de catálogo do espaço de trabalho apenas onde nenhum documento declara o nome. Um valor que não nomeia nenhum arquivo 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 esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
uristringnãoO documento em que o cursor está.
positionPositionnãoUm ponto em um documento: uma linha e um deslocamento de caractere 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 a requisição, quando o cliente acompanha isso.
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ê, junto 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 nomeia nenhum arquivo de Release é recusado.

Não são permitidas propriedades adicionais.

CompletionContext

O que causou a requisição, quando o cliente acompanha isso.

PropriedadeTipoObrigatóriaDescrição
triggerKindintegernãoPor que o preenchimento automático foi solicitado.
triggerCharacterstringnãoO caractere que o causou, quando foi um caractere.

Propriedades adicionais são permitidas.

AttachCandidatesParams

Responde quais Features podem ser vinculadas a uma entidade, julgadas pelos rótulos dessa entidade, e, para uma conexão que o componente de um nó do grafo traça, quais podem preencher cada slot que o socket da conexão declara.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
nodestringnãoA entidade em relação à qual julgar os candidatos, por nome, lida a partir do que os documentos do espaço de trabalho declaram.
graphNodestringnãoO nó do grafo em relação ao qual julgar os candidatos, cujos rótulos são o conjunto finalizado com o qual o próprio build avalia a aplicabilidade. Uma resposta calculada sobre ele diz o que o build 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 estão sob um dos diretórios de catálogo do espaço de trabalho que a Release não lê, de modo que uma Feature mantida para outra Release nunca é oferecida para um nó do grafo desta.
labelsmapa de stringnãoRótulos em relação aos quais julgar diretamente, em vez de lê-los de uma entidade ou de um nó do grafo.
connectionConnectionCoordinatenãoUma conexão que o componente do nó nomeado por graphNode traça, para a qual responder além de para esse nó: a resposta então também traz slots, cada slot que o socket da conexão declara com as Features que podem preenchê-lo, ou noSlotReason onde nenhum slot pode ser preenchido. É enviada apenas com graphNode e release, porque uma conexão existe apenas em um grafo compilado; enviada com node ou labels, é recusada. Os candidatos ao lado dela mantêm o seu significado, as Features que podem se vincular ao próprio nó. O seu documento é aceito e não altera esta resposta: os slots são os do socket e os candidatos os das Features, os mesmos em qualquer documento em que uma vinculação seja escrita.

Não são permitidas propriedades adicionais.

ConnectionCandidatesParams

Responde a quais entidades um socket de uma entidade pode ser conectado.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
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, em um documento, pertence uma nova entrada sob um contêiner nomeado, deixando a composição e a aplicação da entrada ao chamador que é dono do buffer.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
filestringnãoO documento sobre o qual responder.
containerstring[]nãoO caminho através do documento até o contêiner sob o qual a entrada pertence.

Não são permitidas propriedades adicionais.

AttachmentContainerParams

Responde em qual documento, e em que ponto dele, pertence uma vinculação em um nó do grafo, ou em uma conexão que o seu componente traça.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
graphNodestringnãoO nó do grafo ao qual a vinculação se destina.
releasestringnãoA Release a cujo grafo o nó pertence, como caminho relativo à raiz do espaço de trabalho.
connectionConnectionCoordinatenãoUma conexão que o componente do nó do grafo traça, quando a vinculação é para essa conexão e não para o nó: a resposta então nomeia o contêiner features próprio da conexão no documento que o seu campo document nomeia, um campo obrigatório aqui. No Aggregate, é a entrada da conexão no documento em que o nó foi escrito, recusada para uma conexã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 conexão quer não, recusada onde a Release não escreve nenhuma entrada para o nó. Uma conexão que uma Feature traçou é recusada em qualquer um dos documentos, porque uma vinculação é escrita apenas em uma conexão que um componente ou a Release traça.

Não são permitidas propriedades adicionais.

ConnectionAtPositionParams

Responde dentro da entrada de qual conexão cai uma posição em um Aggregate ou em uma Release: o nó do grafo e a conexão, nos termos em que as requisições de candidatura e de contêiner os recebem, ou por que nenhuma conexão está escrita ali. As entradas são aquelas em que uma vinculação é escrita — a entrada com a qual um componente traça uma conexão, sob o alias da conexã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 registra, de modo que se uma chave é uma conexão nunca é deduzido de como ela se chama.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
filestringnãoO documento em que a posição está: a Release, ou um documento em que o grafo da Release registra componentes como escritos — o seu Aggregate, ou o documento de um módulo que esse Aggregate importa. Ele é lido primeiro a partir do que a sessão mantém para ele, e do disco caso contrário.
positionPositionnãoUm ponto em um documento: uma linha e um deslocamento de caractere 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 registra as conexões, como caminho relativo à raiz do espaço de trabalho. Ela é obrigatória também para uma posição no Aggregate, porque um nó do grafo e uma conexão existem apenas em um grafo compilado.

Não são permitidas propriedades adicionais.

ConnectionCoordinate

Uma conexão que o componente de um nó do grafo traça, endereçada pelo socket através do qual está conectada e pelo alias que traz nesse socket, e o documento em que uma vinculação nela é escrita. Uma conexão traz vinculações que preenchem os slots que o seu socket declara, e tanto o Aggregate quanto a Release podem escrevê-las.

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

Propriedades adicionais são permitidas.

SetActiveReleaseParams

Registra uma Release como a padrão do espaço de trabalho escrevendo um marcador no diretório .aggrega: a escolha que aggrega/activeRelease informa 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: onde o diretório .aggrega ou o marcador é um link que leva para fora do espaço de trabalho, exista ou não ainda o lugar para onde ele leva, a escrita é recusada nomeando o link e nada é escrito. A resposta é a que aggrega/activeRelease dá depois que o marcador é escrito, então ela nomeia uma Release diferente onde 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 esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
releasestringnãoA Release a registrar, 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; assim 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 adicionada sob um contêiner, ou um escalar definido. O documento composto é verificado em relação ao esquema do seu tipo e só chega ao disco se a verificação passar, então isto não pode escrever o que o esquema de authoring recusa. Uma edição recusada deixa o arquivo byte a byte como estava.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
filestringnãoO documento a editar.
editconst “add-component” ou const “attach-feature” ou const “wire-edge” ou const “set-value”nãoQual edição aplicar. Valores permitidos: "add-component" — Adiciona uma instância de componente sob um contêiner components: name é o nome da instância, value o Component que ela solicita. "attach-feature" — Vincula uma Feature ao nó que a requisição nomeia: name é o nome de instância da vinculação, value a Feature que ela solicita. "wire-edge" — Conecta uma conexão de dependência a partir do nó que a requisição nomeia, dentro de socket: name é o alias pelo qual a conexão é endereçada, value o nó para o qual ela aponta. "set-value" — Define um valor no nó que a requisição nomeia: name é a chave do valor, value um escalar.
nodestring[]nãoO caminho através do documento até a entrada que está sendo editada.
socketstringnãoO socket de que trata a edição, para uma edição que conecta um.
namestringnãoO nome que a edição escreve.
valueanynãoO valor que a edição escreve, na forma que a edição assumir.
dryRunbooleanonãoSe deve responder com o documento composto em vez de escrevê-lo.

Não são permitidas propriedades adicionais.

ConfigInitParams

Inicializa um documento de configuração. Por padrão, escreve o arquivo de toda a máquina, já que um registro e as identidades confiáveis nele são ferramentas de toda a máquina. Contata o registro nomeado para ler a política de confiança que ele anuncia; um registro que não anuncia nada é informado como tal e a inicialização prossegue, sobre a linha de base embutida para o hub oficial e sem nenhuma política para qualquer outro registro.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
registrystringnãoO registro para o qual inicializar a configuração.
forcebooleanonãoSe deve sobrescrever um documento de configuração que já existe.
globalbooleanonãoEscreve o arquivo de configuração de toda a máquina, que é o padrão próprio deste método.
workspacebooleanonãoEscreve o arquivo de configuração próprio deste espaço de trabalho em vez do de toda a máquina.
dryRunbooleanonãoSe deve responder com o conteúdo do documento em vez de escrevê-lo, 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, de modo que o espaço de trabalho seja autocontido. Sempre escreve o arquivo 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 esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
allPluginsbooleanonãoSe deve congelar todo plugin vinculado 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 registro do que a importação escreveu — o destino que lhe foi dado, quando lhe foi dado um, o snapshot do catálogo que ela leu, quando leu um, cada arquivo redigido e cada chave de um Aggregate ou de uma Release redigidos em qualquer profundidade —, que uma sincronização posterior lê. Uma fonte que ela não conseguiu converter por completo é uma resposta e não uma falha: os rascunhos que ela produziu são escritos e os achados dizem o que ela 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 esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
sourcestringnãoO arquivo ou o diretório a converter, como caminho absoluto ou relativo à raiz do espaço de trabalho; uma requisição sem ele é recusada. Ele é lido onde está, dentro do espaço de trabalho ou não, e um diretório é lido nos arquivos dele que os padrões de arquivo 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 sai 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 em um terminal sem nomear nenhum destino. Todo 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 o determina.
targetstringnãoUma capacidade do provedor, 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 leva o nome do tipo —; um tipo sem nenhuma, ou com várias e nenhuma com esse nome, fica sem mapeamento com um achado de aviso que o nomeia; um mapeamento que um importador redigiu por conta própria é mantido onde o catálogo o oferece para esse tipo e essa capacidade e, caso contrário, descartado com um achado 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 registro da importação anterior nomeia; uma sincronização que nomeia um destino redige para ele, e o registro passa então a nomeá-lo.
dryRunbooleanonãoSe deve responder com o conteúdo de cada arquivo que a requisição escreveria em vez de escrevê-lo. Todo outro comportamento é o da escrita, então uma requisição que a escrita recusaria é recusada também neste caso; com sync, responde com o que a sincronização escreveria e com cada parte que sofreria desvio.
syncbooleanonãoSe deve atualizar em relação à fonte o que uma importação anterior redigiu sob outputDir, em vez de escrever o rascunho inteiro. Só o que a importação escreveu muda, tal como o registro ao lado dos rascunhos o lista: uma parte que a fonte deixou intacta permanece como está no disco, editada ou não; uma parte que a fonte alterou, descartou ou ganhou é escrita de novo, removida — um arquivo redigido apagado por inteiro — ou adicionada, onde o que está no disco é o que a importação escreveu por último; e todo o resto, uma chave que um autor adicionou — entre elas o ambiente que uma Release redigida deixa para o seu autor — ou um comentário não escrito diretamente acima de uma chave redigida, permanece idêntico byte a byte. Uma sincronização que alteraria ou removeria o que um autor editou ou adicionou, ou adicionaria uma parte onde um autor já escreveu uma, é recusada nomeando cada parte, assim como uma sincronização sobre um Aggregate que nenhum registro lista; nada é escrito em nenhum dos casos. Sem este campo, uma requisição cujos rascunhos seriam escritos sobre um Aggregate já presente em outputDir é recusada, também sob dryRun.
upgradebooleanonãoSe deve baixar o snapshot do catálogo mais recente que o registro padrão do espaço de trabalho publica e importar com base nele, mantendo-o a partir de então no lugar daquele que o espaço de trabalho mantém ou daquele que o registro ao lado dos rascunhos nomeia; não muda nada onde o espaço de trabalho nomeia uma pasta de catálogo, e é recusado offline.
answersstringnãoO arquivo 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 como escrito ou por meio de um link, é recusado. Ele contém, sob o caminho de cada arquivo redigido, o caminho da chave dentro desse documento e sua resposta, e as respostas são escritas nos rascunhos. Se ausente, é lido o que o registro ao lado dos rascunhos nomeia, ou então import-answers.yaml ao lado do arquivo de origem ou dentro do diretório de origem. A resposta de um segredo nomeia de onde o segredo vem — 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 pendente é uma entrada de owed da resposta e um achado de aviso que nomeia o arquivo redigido, a chave e o que ela é, sua resposta é enviada como answered, e onde os rascunhos são escritos, o último achado diz quantos estão pendentes e onde. Quando os rascunhos incluem uma Release, não têm nada pendente e a conversão terminou, suas dependências são então baixadas, gravando seu lockfile, e um pull que falha encerra os achados dizendo por quê, com os rascunhos escritos; offline nada é baixado e um achado nomeia o pull a executar. Uma resposta para uma chave que esses rascunhos não deixam vazia é mantida no arquivo e não aplicada, de modo que um único arquivo de respostas serve a todos os destinos.
answeredImportAnswered[]nãoRespostas para valores que owed da resposta listou, cada uma nomeando o arquivo redigido e as chaves como owed as nomeou. Cada uma é avaliada, mantida no arquivo de respostas e escrita nos rascunhos exatamente como uma resposta digitada em um terminal: a resposta de um segredo nomeia de onde o segredo vem — um nome de variável, ${NAME}, ou o nome de um Kubernetes Secret — e uma que não faz isso não é mantida nem escrita, e seu valor continua pendente com o motivo como seu secretAdvice. Um valor que o arquivo de respostas já responde é respondido a partir do arquivo; uma resposta vazia, ou uma que nomeia um valor que os rascunhos não têm pendente, não é aplicada. Envie-a com sync depois que os rascunhos forem escritos, já que uma requisição que não é um sync é recusada 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 em um novo diretório do espaço de trabalho, ou os lista. A redação deriva o esqueleto do conjunto de esquemas que o binário traz, então nada é lido de um espaço de trabalho e nada é escrito — a resposta é texto, e para onde ele vai 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 há um, verificado em relação à política de assinatura do espaço de trabalho antes de ser mantido ou lido: um bundle que não passa na verificação é recusado, e offline só é lida uma cópia já em cache. Uma requisição que envia juntos os campos de duas formas — kind com example ou list, list com example, name com example ou list, dir sem example — é recusada antes que qualquer coisa seja 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 o exige: a configuração do espaço de trabalho decide de onde a documentação é obtida e quais assinaturas ela deve trazer, 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. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
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.
listbooleanonã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, ele é escrito ali em um diretório com o nome do exemplo. Ele não deve existir ainda ou deve estar vazio: um que contenha qualquer coisa é recusado e deixado como está, e um valor absoluto, ou um que sai do espaço de trabalho tal como está escrito ou através de um link, é recusado antes que qualquer coisa seja lida. Enviado apenas com example.

Não são permitidas propriedades adicionais.

LintParams

Verifica as convenções de publicação do catálogo em uma única entidade, em tudo o que o fechamento de uma Release alcança, ou em tudo 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: em um 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; em um 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 juntos.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
entitystringnãoO único documento de entidade a verificar.
releasestringnãoA Release cujo fechamento verificar, como caminho relativo à raiz do espaço de trabalho.
prePublishbooleanonãoSe deve comparar cada entidade com a sua versão publicada anteriormente, o que alcança os registros configurados.

Não são permitidas propriedades adicionais.

PluginAddParams

Vincula um plugin a um socket que o espaço de trabalho configura. Alcança um registro para resolver a consulta para um ú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, então o cliente pergunta a quem o estiver conduzindo e esta superfície nunca espera por um prompt.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
typestringnãoO socket ao qual o plugin se vincula.
querystringnãoO que resolver para um único plugin.
capabilitystringnãoA capacidade a que a vinculação se destina, quando o socket traz várias.
rolestringnãoO papel em que a vinculação é executada, o que determina o que ela pode emitir.
globalbooleanonãoEscreve o arquivo de configuração de toda a máquina.
workspacebooleanonãoEscreve o arquivo de configuração próprio deste espaço de trabalho.
acceptCapabilitiesbooleanonãoSe o chamador aceita as capacidades que um plugin de extensão de comandos declara.
dryRunbooleanonãoSe deve responder com o conteúdo do documento de configuração em vez de escrevê-lo.

Não são permitidas propriedades adicionais.

PluginRemoveParams

Desvincula 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 esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
typestringnãoO socket ao qual o plugin está vinculado.
querystringnãoQual vinculação remover.
globalbooleanonãoEscreve o arquivo de configuração de toda a máquina.
workspacebooleanonãoEscreve o arquivo de configuração próprio deste espaço de trabalho.

Não são permitidas propriedades adicionais.

PluginSyncParams

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

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
entitystringnãoO documento da entidade Plugin a alinhar.
pluginstringnãoO módulo de plugin do qual ler os registros.

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 esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
fromEmbeddedbooleanonãoSe deve ler os metadados dos plugins que o binário já traz.
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 é mesclado sobre os metadados gerados.
dryRunbooleanonãoSe deve responder com o conteúdo dos documentos em vez de escrevê-los.

Não são permitidas propriedades adicionais.

ExplainErrorParams

Expande um código que um achado trazia no 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 consegue obtê-la, ainda responde com o que o binário declara, e diz por que o texto explicativo está ausente.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
codestringnãoA condição a expandir, nomeada pelo código que um achado trazia 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 quais tipos podem ser nomeados. Responde pelo binário em execução, e não por qualquer cópia instalada em outro lugar, então 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 — ele responde a partir do que o próprio binário traz — então o campo é aceito e não lido. Ele é admitido porque um cliente pode enviá-lo de forma uniforme em toda requisição sem precisar saber quais métodos o consultam.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
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 embutida no binário na pasta de skills de cada assistente que a requisição nomeia ou, para uma requisição 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 a requisição nomeia, e todo caminho que escreveria ali fica restrito a esse espaço de trabalho; com global, escreve a pasta por usuário de cada assistente sob o diretório home. Todo destino é verificado antes que qualquer coisa seja escrita, então uma recusa deixa toda pasta como estava.

PropriedadeTipoObrigatóriaDescrição
workspaceRootWorkspaceRootSubjectsimO caminho absoluto do espaço de trabalho sobre o qual esta requisição atua. É o sujeito da requisição: o daemon o resolve antes que o método seja executado, e uma requisição que o omite ou o escreve como algo diferente de uma string é recusada.
workDoneTokenProgressTokennãoUm valor que o chamador gera para poder associar as notificações de progresso à chamada que as pediu. Ele é devolvido inalterado em toda notificação, então um chamador pode compará-lo com o valor que enviou. É aceito em toda requisição, e uma requisição que envia um em uma sessão que não declarou nenhuma capacidade de progresso é recusada.
agentsstring[]nãoOs assistentes para os quais instalar a skill, pelos identificadores que a listagem informa. Uma requisição de projeto que não nomeia nenhum é recusada. Uma requisição global que não nomeia nenhum instala a skill para os assistentes encontrados nesta máquina, cada um cuja pasta de configuração está no diretório home ou cujo comando está no PATH, e é recusada sem escrever nada quando nenhum é encontrado. Um identificador para o qual nenhuma pasta de skills é conhecida é recusado, pelo nome, e um identificador informado duas vezes é instalado uma vez.
globalbooleanonãoEscreve a pasta de skills por usuário de cada assistente sob o diretório home, que ele lê em todo 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 com base no que o cliente disse que consegue tratar.

PropriedadeTipoObrigatóriaDescrição
positionEncodingstringsimA codificação em que toda posição nesta sessão é expressa.
workDoneProgressbooleanonãoSe o daemon enviará notificações de progresso nesta sessão. Presente apenas quando o cliente declarou que pode recebê-las.

Não são permitidas propriedades adicionais.

ClosureEntity

Uma entidade da qual 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 registro durante essa execução), cache-reuse (uma cópia já no cache, reutilizada sem ser obtida), local (encontrada no sistema de arquivos 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 arquivo 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 registro é fetched-fresh em vez disso). 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 de que a Release depende. O arquivo de bloqueio não registra nenhuma origem. Omitido para uma entidade cuja origem a execução não registrou.

Não são permitidas propriedades adicionais.

ToolchainCorePlugin

Um plugin que o próprio compilador traz, 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 ele traz.

PropriedadeTipoObrigatóriaDescrição
compilerVersionstringsimA versão do compilador que fez a resolução.
corePluginsToolchainCorePlugin[]nãoOs plugins que o compilador traz, 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 arquivo de bloqueio que a resolução escreveu, ou aquele com o qual uma verificação comparou.
verifiedbooleanonãoSe a requisição foi uma verificação, que comparou o arquivo de bloqueio registrado e não escreveu nenhum arquivo de bloqueio, registro 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 artefatos de origem foram obtidos.
trustedPluginsintegersimQuantos dos plugins fixados traziam uma assinatura verificada.
toolchainToolchainReportnãoO compilador que fez a resolução, e os plugins que ele traz.
externalInputsintegersimQuantas entradas externas que a renderização consome foram obtidas.
incompleteExternalInputsstringnãoQuais entradas externas não puderam ser obtidas, quando algumas não puderam.

Não são permitidas propriedades adicionais.

BuildNotice

Algo que o build quer que o chamador saiba, que não é nem um achado 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 uma resposta sobre o cache alcança. Duas das classes de cache são compartilhadas por todos os projetos da máquina, então toda resposta sobre o cache nomeia quais delas tocou — caso contrário, uma sessão aberta sobre um espaço de trabalho seria lida como se informasse apenas sobre esse espaço de trabalho.

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

Não são permitidas propriedades adicionais.

CacheElement

Algo que um cache contém.

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

Não são permitidas propriedades adicionais.

CacheClass

Um cache sobre o qual o daemon informa.

PropriedadeTipoObrigatóriaDescrição
namestringsimQual cache é este.
reachstringsimSe o cache pertence a este espaço de trabalho ou é compartilhado na máquina.
prunablebooleanosimSe recuperar o espaço deste cache é algo que o daemon fará.
elementsCacheElement[] ou nullsimO que o cache contém.

Não são permitidas propriedades adicionais.

CacheProvenance

Sob quais identidades um artefato em cache foi obtido, e quão amplamente ele é compartilhado.

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

Não são permitidas propriedades adicionais.

CacheRemoval

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

PropriedadeTipoObrigatóriaDescrição
classstringsimA qual cache pertence.
labelstringsimO que é.
reachstringsimSe esse cache pertence a este espaço de trabalho ou é compartilhado na máquina.
sizeintegersimQuantos bytes ocupa, ou ocupava antes de ser removido.
sizeTextstringsimO mesmo tamanho escrito do jeito que 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 número menor do que esperava saiba o porquê em vez de deduzi-lo.

PropriedadeTipoObrigatóriaDescrição
classstringsimQual cache contém o que foi deixado.
countintegersimQuantas entradas foram deixadas.
sizeintegersimQuantos bytes elas ocupam.
sizeTextstringsimO mesmo tamanho escrito do jeito que uma pessoa o lê.
reachstringsimSe esse cache pertence a este espaço de trabalho ou é compartilhado na máquina.
reclaimedBystring[] ou nullsimO que as recuperaria.

Não são permitidas propriedades adicionais.

CacheCleared

Um cache que uma limpeza esvaziou.

PropriedadeTipoObrigatóriaDescrição
classstringsimQual cache foi esvaziado.
reachstringsimSe ele pertence a este espaço de trabalho ou é compartilhado na máquina.
sizeintegersimQuantos bytes foram recuperados dele.
sizeTextstringsimO mesmo tamanho escrito do jeito que uma pessoa o lê.
heldOpenFilesintegersimQuantos arquivos a limpeza deixou neste cache porque outro processo os mantinha abertos. Apenas o Windows se recusa a remover um arquivo aberto, então em qualquer outro lugar isto é zero. Uma limpeza posterior os remove assim que esse processo terminar de usá-los.
heldOpenBytesintegersimQuantos bytes esses arquivos ocupam. Eles não são contados em size, que é o que a limpeza recuperou.
heldOpenBytesTextstringsimO mesmo número escrito da forma como uma pessoa o lê.

Não são permitidas propriedades adicionais.

ConfigWriteScope

Qual documento de configuração foi escrito e até onde ele alcança. Uma requisição nomeia um espaço de trabalho, então uma resposta que não dissesse nada seria lida como se fosse sobre 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.
machineWidebooleanosimSe esse documento é aquele por meio do qual todo espaço de trabalho da máquina resolve.
workspaceRootstringsimO espaço de trabalho que a requisição nomeou.

Não são permitidas propriedades adicionais.

PluginWriteScope

Em qual documento de configuração uma alteração de plugin foi escrita e até onde ela alcança. O padrão próprio do socket de extensão de comandos é o documento de toda a máquina, então toda resposta diz qual escreveu.

PropriedadeTipoObrigatóriaDescrição
configFilestringsimO documento que foi escrito.
machineWidebooleanosimSe esse documento é aquele por meio do qual todo espaço de trabalho da máquina resolve.
workspaceRootstringsimO espaço de trabalho que a requisição nomeou.

Não são permitidas propriedades adicionais.

CredentialStoreScope

Até onde uma alteração de credencial alcança. O armazenamento é compartilhado por todo projeto da máquina e por qualquer outra ferramenta que se dirija aos mesmos registros, então a resposta informa isso em vez de deixar que se deduza uma leitura limitada à sessão.

PropriedadeTipoObrigatóriaDescrição
machineWidebooleanosimSe o armazenamento que a alteração tocou é compartilhado na máquina.
workspaceRootstringsimO espaço de trabalho que a requisição nomeou.

Não são permitidas propriedades adicionais.

SkillFolderScope

Até onde uma instalação de skill alcança. Uma requisição nomeia um espaço de trabalho, então uma resposta que não dissesse nada seria lida como se fosse sobre esse espaço de trabalho — e para as pastas por usuário, que um assistente lê em todo projeto, essa leitura está errada.

PropriedadeTipoObrigatóriaDescrição
machineWidebooleanosimSe as pastas escritas são as por usuário sob o diretório home, que o assistente lê em todo projeto da máquina.
workspaceRootstringsimO espaço de trabalho que a requisição nomeou.

Não são permitidas propriedades adicionais.

PublicationReach

Até onde uma publicação chegou. Essas respostas chegam inteiramente além desta máquina — o que elas anexam é o que todo consumidor desse registro resolve —, então cada uma nomeia todo registro ao qual se dirigiu e se a chamada anexou algo ali.

PropriedadeTipoObrigatóriaDescrição
registriesstring[]simTodo host de registro ao qual a chamada se dirigiu, cada um nomeado uma única vez, na ordem em que a chamada se dirigiu a ele pela primeira vez. Uma chamada de referência única nomeia um; uma execução de teste nomeia o destino ao qual teria se dirigido.
beyondThisMachinebooleanosimSe a chamada anexou algo que um registro agora serve a outros: conteúdo enviado, uma assinatura, uma data de publicação ou um marcador de descontinuação. É false em uma execução de teste, e em uma chamada que encontrou já presente tudo o que teria anexado — uma publicação executada novamente sobre uma versão completa, ou um lote de assinatura em que toda referência já trazia 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 lugar de onde foi lida. Um documento do espaço de trabalho informa o seu caminho relativo ao espaço de trabalho; uma entidade resolvida a partir dos diretórios de catálogo configurados informa um caminho vazio, porque o único caminho que ela tem não significaria nada 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 ela veio dos diretórios de catálogo configurados.
originstringsimDe onde a entidade foi lida.

Não são permitidas propriedades adicionais.

SocketCandidacy

Um socket em uma entidade, e o que pode ser conectado a ele.

PropriedadeTipoObrigatóriaDescrição
socketstringsimO nome do socket.
declarationstringsimOnde o socket é declarado.
selectorstringsimO seletor de rótulos que um destino deve satisfazer.
requiredbooleanosimSe o socket deve estar conectado para que o build prossiga.
targetsWorkspaceEntityRef[] ou nullsimAs entidades que podem ser conectadas a ele.

Não são permitidas propriedades adicionais.

SlotCandidacy

Um slot que o socket de uma conexão declara, tal como o Component consumidor o declara no socket, e as Features que podem preenchê-lo nessa conexão.

PropriedadeTipoObrigatóriaDescrição
slotstringsimO nome do slot, que é a chave sob a qual uma vinculação que o preenche é escrita nas features da conexão.
selectorstringsimO seletor de rótulos que uma Feature que preenche o slot deve satisfazer com os seus próprios rótulos. Vazio onde o slot não declara nenhum, o que admite qualquer Feature.
requiredbooleanosimSe toda conexão conectada através do socket deve preencher o slot para que o build prossiga.
injectstring[]simOs mecanismos de entrega que o slot permite para o que o preenche, na ordem em que o Component os declara. Vazio onde ele não declara nenhum.
sensitivebooleanosimSe o slot declara que o que o preenche lida com material secreto. Ele marca a vinculação que o preenche e não recusa nada.
descriptionstringsimPara que serve o slot segundo o Component. Vazio onde ele não diz nada.
candidatesSourcedEntityRef[]simCada Feature que pode preencher o slot nesta conexão: uma cuja aplicabilidade declarada os rótulos do nó do grafo satisfazem, requisito ao qual toda vinculação que o nó traz está sujeita, e cujos próprios rótulos satisfazem o seletor do slot. Uma Feature cuja aplicabilidade ou cujos rótulos não podem ser lidos em relação ao seletor não é oferecida, porque um build a recusa em vez de admiti-la.

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 nullsimOs rótulos 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 possa escolher um ícone para ele.
detailstringnãoUm qualificador curto mostrado ao lado do rótulo.
documentationstringnãoO que o elemento é, em detalhe.
sortTextstringnãoO valor pelo qual ordenar, quando difere do rótulo.

Não são permitidas propriedades adicionais.

MarkupContent

Texto a mostrar, e como ele 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 uma requisição nomeia ao tipo que o próprio documento declara, e diz quais operações aceitam um documento desse tipo.

PropriedadeTipoObrigatóriaDescrição
kindstringsimO token em minúsculas que uma requisição nomeia, como component ou featurerecipe.
documentKindstringsimO tipo que o próprio cabeçalho do documento declara.
acceptedByEntityKindAcceptancesimQuais operações aceitam um documento deste tipo nomeado sozinho — pelo seu caminho, ou pelo seu nome para inspeção — sem nada mais enviado ao lado dele. Um campo é true quando essa operação não recusa um documento por ser deste tipo; um documento que ela aceita ainda pode 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 sozinho. Todo campo está presente em toda entrada, então false é uma afirmação e não uma omissão.

PropriedadeTipoObrigatóriaDescrição
singleEntityValidationbooleanosimSe o escopo de entidade única de aggrega validate — o comando ao qual se dá o caminho de um único documento — verifica um documento deste tipo. Um tipo que ele recusa é verificado em vez disso pelo escopo do catálogo inteiro ou pelo escopo da Release.
publicationbooleanosimSe 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 uma requisição que nomeia apenas o documento é recusada para ele; um Manifest e uma Release são false porque nenhum dos dois tipos é publicado.
inspectionByNamebooleanosimSe aggrega/entityDefinition resolve um nome para uma entidade deste tipo, com o nome enviado tal como é escrito onde uma entidade referencia outra.

Não são permitidas propriedades adicionais.

RegistryTrust

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

PropriedadeTipoObrigatóriaDescrição
signaturesRequiredbooleanosimSe um artefato deste registro deve trazer uma assinatura verificada.
verificationSkippedbooleanonãoSe a verificação está sendo ignorada.
advisorybooleanonãoSe uma verificação com falha é informada em vez de interromper a execução.
anchorstringnãoA âncora de confiança com base na qual as assinaturas são verificadas.
keylessIdentitiesintegernãoQuantas identidades de assinatura são confiáveis para este registro.

Não são permitidas propriedades adicionais.

Registry

Um registro configurado. Nenhum campo aqui traz material de credenciais, o seu comprimento, a sua forma ou qualquer representação dele — a presença é tudo o que é informado, e é isso que torna o valor seguro para colar em uma issue.

PropriedadeTipoObrigatóriaDescrição
hoststringsimO host do registro, que é a sua identidade.
namestringnãoO alias amigável que é resolvido para o host, quando há um configurado.
defaultbooleanosimSe este é o registro ao qual se dirige uma operação que não nomeia nenhum registro.
authStatestringsimSe uma credencial para este host está presente no armazenamento de toda a máquina. É informado 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 registro serve.

Não são permitidas propriedades adicionais.

TrustFetchOutcome

O que a leitura da política de confiança anunciada de um registro produziu. Os resultados são mantidos separados porque significam coisas diferentes: a política anunciada foi adotada, o registro não anunciou nada — o que não é uma falha —, a linha de base embutida foi fixada em seu lugar, ou nenhuma leitura foi tentada. Onde nada foi anunciado, se o registro pôde sequer ser alcançado é indicado ao lado.

PropriedadeTipoObrigatóriaDescrição
pinnedbooleanosimSe a política anunciada foi adotada.
notAdvertisedbooleanonãoSe o registro foi consultado e não anunciou nenhuma política, caso em que a operação prossegue com o que a requisição declarou. Um registro que o modo offline impediu de ser consultado nunca é informado assim. Um registro que não pôde ser alcançado também é informado assim, já que nenhuma política voltou dele, e traz unreachable ao lado; leia unreachable para distinguir os dois casos.
unreachablebooleanonãoSe o registro não pôde ser alcançado quando a sua política anunciada foi solicitada: o seu nome não foi resolvido, uma conexão com ele foi recusada ou não pôde ser aberta, ou uma conexão segura com ele não pôde ser estabelecida. É lido da própria falha em vez de reason, fica ao lado de notAdvertised, e só é definido onde a falha mostra que o registro nunca foi alcançado; um registro que respondeu — sem política, ou com uma falha — o deixa ausente.
baselinebooleanonãoSe a linha de base embutida, que apenas o hub oficial traz, foi fixada porque nenhuma política anunciada foi adotada. Fica ao lado de notAdvertised onde o hub foi consultado e não anunciou nada, e sozinho onde o modo offline impediu que o hub fosse consultado.
skippedbooleanonãoSe nenhuma leitura foi tentada, porque uma política declarada a substituiu ou a requisição não pediu nenhuma.
identitiesintegernãoQuantas identidades de assinatura a política anunciada trazia.
reasonstringnãoPor que a política anunciada não foi adotada: o que o endpoint do registro fez, ou a recusa offline que impediu que ele fosse consultado.

Não são permitidas propriedades adicionais.

SkippedRepo

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

PropriedadeTipoObrigatóriaDescrição
repostringsimO repositório que foi ignorado.
reasonstringsimPor que ele 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 informados em pé de igualdade, de modo que registrar muitos não passa em silêncio enquanto recusar um se faz notar.

PropriedadeTipoObrigatóriaDescrição
repostringsimO repositório em que o marcador está.
versionstringsimA versão que o marcador abrange.
recordedbooleanosimSe a própria assinatura do marcador foi verificada, e o índice portanto o traz.
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: ainda selecionada quando uma versão é escolhida. "error" — Descontinuada, no mais forte dos dois níveis consultivos: ainda selecionada quando uma versão é escolhida. "retracted" — Retirada: excluída quando uma versão é escolhida.
reasonstringnãoPor que a versão está descontinuada.

Não são permitidas propriedades adicionais.

HostUpdate

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

PropriedadeTipoObrigatóriaDescrição
hoststringsimO host de registro que foi atualizado.
indexedintegersimQuantos registros foram escritos.
deprecationsExaminedbooleanosimSe o percurso sequer procurou marcadores de descontinuação. É separado da contagem porque “este registro não publicou nenhum” e “esta execução não tinha base para julgar um” são fatos 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 registro recusou ou interrompeu no caminho e foram solicitadas novamente, cada leitura contada uma única vez, independentemente de quantas tentativas tenha exigido e de ter tido sucesso depois ou não; zero onde não houve nenhuma. Um percurso cujas leituras tiveram todas sucesso no final não lista nenhum repositório sob skipped, então é esta contagem que diz quão perto ele chegou de deixar um de fora. Mínimo: 0.
errorstringnãoO que falhou para este host, de modo que um percurso sobre vários informa quais deles falharam sem que o chamador precise correlacionar nada.
unreachablebooleanonãoSe este registro não pôde ser alcançado: o seu nome não foi resolvido, uma conexão com ele foi recusada ou não pôde ser aberta, ou uma conexão segura com ele não pôde ser estabelecida. É lido da própria falha em vez de error, só é definido ao lado de error, e apenas onde a falha mostra que o registro nunca foi alcançado; um registro que respondeu, seja o que for que tenha respondido, o deixa 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; onde 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, onde algo o registra, 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 onde essa política não fixa nem uma chave pública nem uma identidade confiável ou desativa a verificação de assinaturas. Nenhum desses casos é uma base para nomear um signatário, e a sua ausência não diz nada além disso. A data de publicação está ausente onde a publicação não declarou nenhuma e nenhuma assinatura keyless verificada por essa política registra 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 em vez de pela sua tag.
signerVerifiedSignaturenãoUma assinatura verificada em relação à política de confiança de um registro: como ela 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 um carimbo de tempo RFC 3339 em UTC com precisão de segundos. A sua origem é publishedAtSource, e os dois estão presentes juntos ou não estão.
publishedAtSourceconst “transparency-log” ou const “publisher”nãoDe onde vem publishedAt, para que um momento que um log 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 log de transparência registrou a assinatura keyless da versão, que a política de confiança sob a qual o índice foi construído verificou junto com a promessa assinada do log 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, pelo próprio relógio da máquina que publica. Nada o atesta. Uma publicação declara um onde a sua assinatura não traz nenhum momento atestado: uma assinatura com chave, ou nenhuma assinatura. Onde há vários anexos, é usado o mais antigo.

Não são permitidas propriedades adicionais.

VerifiedSignature

Uma assinatura verificada em relação à política de confiança de um registro: como ela 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 registrado 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" — Em relação a um certificado de assinatura cuja identidade e cujo emissor correspondem a uns em que a política confia, que se encadeia até a raiz de confiança que a política fixa ou, onde ela não fixa nenhuma, até a raiz public-good do Sigstore, e cuja assinatura um log de transparência registra. "keyed" — Em relação à chave pública que a política fixa.

Não são permitidas propriedades adicionais.

RegistrySearchRecord

Um registro ao qual uma busca 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 registro é resolvido.
namestringsimO nome da entidade.
versionstringsimA versão sob a qual o registro é indexado.
versionsstring[]nãoToda 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ãoOs rótulos que a entidade declara.
pluginTypestringnãoO socket ao qual um registro de plugin se vincula.
capabilitiesstring[]nãoAs capacidades que um registro de plugin declara.
manifestDigeststringnãoO digest do manifesto publicado.
listingDigeststringnãoO digest da listagem da qual o registro foi lido.
deprecationsobject[]nãoOs marcadores de descontinuação que o índice traz para esta referência, cada um com a versão que abrange e o próprio marcador verificado.
publishedPublishedVersion[]nãoToda versão que o índice contém para esta referência, na 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 onde 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 onde algo as registra. Uma versão registrada sem signatário não traz nenhuma assinatura verificada por essa política, e nada mais é dito sobre ela. Para registrar isso, apenas manifestos, anexos de assinatura e anexos de data de publicação são lidos do registro; 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 snapshot não traz nenhum horário, para que um chamador possa distinguir “não registrado” do epoch.

Não são permitidas propriedades adicionais.

EffectiveConfigurationSetting

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

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

Não são permitidas propriedades adicionais.

ImportedFile

Um arquivo que uma importação escreve: um documento em rascunho, ou o registro do que a importação escreveu.

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

Não são permitidas propriedades adicionais.

ImportDrift

Uma parte que uma sincronização atualizou em relação à 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 ela descartou; ou changed, para uma que ela alterou.
filestringsimO arquivo redigido em que a parte está, 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 contém um ponto continue sendo uma única entrada. Vazio onde a parte é o arquivo 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 arquivo redigido em que o valor está, como um caminho relativo ao outputDir da resposta.
keystring[]simAs chaves que levam ao valor a partir do topo desse documento, uma entrada por chave, de modo que uma chave que contém um ponto continua sendo uma única entrada. Uma resposta enviada como answered nomeia o valor por essas chaves.
questionstringsimO que o valor é: a descrição de seu esquema, ou então o comentário que o rascunho escreve acima de sua chave, ou então o que seu esquema diz que ele aceita.
sensitivebooleanosimSe o valor é o de um segredo, cuja resposta nomeia de onde o segredo vem e nunca contém o próprio segredo.
secretAdvicestringnãoPresente no valor de um segredo: o que sua resposta deve ser, na frase mostrada a uma pessoa que o responde em um terminal — ou, quando a resposta enviada para ele como answered foi recusada, por que foi recusada.

Não são permitidas propriedades adicionais.

ImportAnswered

Uma resposta para um valor que owed da resposta listou.

PropriedadeTipoObrigatóriaDescrição
filestringsimO arquivo redigido em que o valor está, como owed o nomeia.
keystring[]simAs chaves que levam ao valor, como owed as nomeia.
answerstringsimA resposta. Uma resposta vazia deixa o valor pendente.

Não são permitidas propriedades adicionais.

ImportDiagnostic

Algo que uma conversão não conseguiu converter. Estes são a saída mais útil da conversão, então são informados por completo em vez de reduzidos a um veredito.

PropriedadeTipoObrigatóriaDescrição
severitystringsimQuão grave é.
messagestringsimO que não pôde ser convertido.
codestringnãoO nome citável da condição, quando ela 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, o que ele escolheu, por quê, e como trocar a escolha.

PropriedadeTipoObrigatóriaDescrição
sourceNodeDecisionSourceNodesimO nó da fonte de que trata 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 onde ele não avaliou nenhum.
chosenDecisionChoicenãoO que o importador escolheu para um nó da fonte. Ausente de uma decisão em que ele não fez nenhuma escolha.
rationalestringnãoPor que o importador fez a escolha, com as suas próprias palavras. Ausente onde ele não escreveu nenhuma.
swapHintstringnãoComo trocar a escolha por uma alternativa, com as próprias palavras do importador. Ausente onde ele não escreveu nenhuma.

Não são permitidas propriedades adicionais.

DecisionSourceNode

O nó da fonte de que trata 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 dos rótulos 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 ele não fez nenhuma escolha.

PropriedadeTipoObrigatóriaDescrição
targetstringsimO nome do Component escolhido: um Component existente do catálogo, ou o 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 em um documento.

PropriedadeTipoObrigatóriaDescrição
filestringsimO documento.
diagnosticsDiagnostic[] ou nullsimOs achados nele.

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 ele foi ignorado.

Não são permitidas propriedades adicionais.

PluginRetractionProvenance

De onde veio o conhecimento do 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 qual versão do plugin foi fixada.

PropriedadeTipoObrigatóriaDescrição
referencestringsimA referência à qual 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 por quê.
provenancePluginRetractionProvenancenãoDe onde veio o conhecimento do 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 em um comando que ele contribui.

PropriedadeTipoObrigatóriaDescrição
namestringsimO nome longo da flag.
shorthandstringnãoO alias de um único caractere da flag, quando ela 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 contribui.

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

Não são permitidas propriedades adicionais.

ConfigCapturedAttachment

Uma vinculação 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 a vinculação é resolvida.
capabilitystringnãoA capacidade a que a vinculação se destina.
functionstringnãoA exportação para a qual a vinculação é despachada.
rolestringnãoO papel em que a vinculação é executada, o que determina o que ela pode emitir.

Não são permitidas propriedades adicionais.

ConfigCapturedSocket

Um socket que um congelamento escreveu, com as vinculações que ele congelou nele.

PropriedadeTipoObrigatóriaDescrição
socketstringsimO socket.
fieldstringsimO campo de configuração sob o qual o socket é escrito.
attachmentsConfigCapturedAttachment[] ou nullsimAs vinculações que foram congeladas nele.

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 artefato publicado que uma assinatura abrangeu.

PropriedadeTipoObrigatóriaDescrição
referencestringsimA referência que foi assinada.
digeststringsimO digest do 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: ainda selecionada quando uma versão é escolhida. "error" — Descontinuada, no mais forte dos dois níveis consultivos: ainda selecionada quando uma versão é escolhida. "retracted" — Retirada: excluída quando uma versão é escolhida.
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 qual camada de configuração ela resolveu.

PropriedadeTipoObrigatóriaDescrição
capabilitiesServerCapabilitiessimO que o daemon fará nesta sessão, acertado com base no que o cliente disse que consegue tratar.
workspaceRootstringsimO espaço de trabalho sobre o qual a sessão foi aberta.
configSourcestringsimA partir de qual camada de configuração a sessão resolveu as suas configurações.
workspaceMarkerstringnãoO arquivo 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 informa para esse binário. Ela descreve o processo em execução, então, depois que o arquivo a partir do qual o daemon foi iniciado tiver sido substituído, isto ainda nomeia a versão que está em execução, enquanto consultar o arquivo 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 nullsimOs achados. É 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 mantinha algo sobre o documento a descartar.

PropriedadeTipoObrigatóriaDescrição
invalidatedbooleanosimSe algo foi descartado.

Não são permitidas propriedades adicionais.

DiagnosticsResult

Os achados que o daemon já mantém para o documento.

PropriedadeTipoObrigatóriaDescrição
diagnosticsDiagnostic[] ou nullsimOs achados. É null em vez de uma lista vazia quando não há nenhum.

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 a requisição os tenha pedido com unredacted; todo o resto é repassado 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 um build escreveu.

PropriedadeTipoObrigatóriaDescrição
outputDirectorystringsimO diretório no qual os artefatos foram escritos.
filesstring[] ou nullsimOs artefatos que foram escritos, como caminhos relativos ao diretório de saída.
noticesBuildNotice[]nãoQualquer coisa que o build queira que o chamador saiba e que não seja nem um achado 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 um build teria escrito. Nada foi escrito, então não há nenhum diretório de saída a nomear.

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

Não são permitidas propriedades adicionais.

EntityDefinitionResult

Para o que um nome de entidade é resolvido, e o documento que a define. Uma resposta lida de uma referência de registro traz published, e uma resposta que o catálogo resolveu pelo nome nunca o traz.

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 é publicada.
filestringsimO documento que a define.
authoredLengthintegersimQuantos bytes o documento escrito pelo autor contém, 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 registro leu: a coordenada, como ela continha a entidade, e o manifesto por meio do qual foi lida. Todo campo está presente onde quer que isto esteja.

Não são permitidas propriedades adicionais.

PublishedArtifact

O que uma referência de registro leu: a coordenada, como ela continha a entidade, e o manifesto por meio do qual foi lida. Todo campo está presente onde quer que isto esteja.

PropriedadeTipoObrigatóriaDescrição
referencestringsimA referência de registro que foi lida.
archivebooleanosimSe os bytes da coordenada eram um arquivo compactado do qual o documento da entidade foi extraído. False onde a coordenada continha o próprio documento da entidade.
mediaTypestringsimO tipo de artefato que o manifesto declara.
manifestDigeststringsimO digest do manifesto por meio do qual a entidade foi lida — o valor a nomear depois de @ para ler de novo exatamente os mesmos bytes.

Não são permitidas propriedades adicionais.

ReleaseClosureResult

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

PropriedadeTipoObrigatóriaDescrição
releasestringsimA Release que foi inspecionada.
aggregatestringsimO Aggregate que ela implanta.
manifeststringsimO Manifest por meio do qual ela é resolvida.
environmentstringsimO ambiente que ela nomeia.
entitiesClosureEntity[] ou nullsimAs entidades que o fechamento alcança.
librariesClosureEntity[] ou nullsimAs bibliotecas que o fechamento alcança.
pluginsClosureEntity[] ou nullsimOs plugins que o fechamento 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 fechamento encontrou.

Não são permitidas propriedades adicionais.

ResolveDependenciesResult

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

PropriedadeTipoObrigatóriaDescrição
lockfilestringsimO arquivo de bloqueio que a resolução escreveu, ou aquele com o qual uma verificação comparou.
verifiedbooleanonãoSe a requisição foi uma verificação, que comparou o arquivo de bloqueio registrado e não escreveu nenhum arquivo de bloqueio, registro 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 artefatos de origem foram obtidos.
trustedPluginsintegersimQuantos dos plugins fixados traziam uma assinatura verificada.
toolchainToolchainReportnãoO compilador que fez a resolução, e os plugins que ele traz.
externalInputsintegersimQuantas entradas externas que a renderização consome foram obtidas.
incompleteExternalInputsstringnãoQuais 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 a etapa de fixação fez com o bloqueio ao lado de uma entidade, ou faria em uma execução de teste. É a resposta a aggrega/pin, e uma publicação que executou a etapa a traz como o seu pin.

PropriedadeTipoObrigatóriaDescrição
entitystringsimO documento de entidade que a etapa 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.
pinnablebooleanosimSe uma entidade deste tipo lê algo para o qual um bloqueio registra uma fixação, como fazem uma Recipe e uma FeatureRecipe. Onde é false, nada ao lado da entidade foi tocado, changed é false, e lock, removed, pins e content estão ausentes.
lockstringnãoO bloqueio que a etapa escreveu, ou escreveria, como caminho relativo à raiz do espaço de trabalho.
changedbooleanosimSe o bloqueio mudou, ou mudaria em uma execução de teste. False onde o bloqueio já registrava toda fixação de que a entidade precisa e foi deixado idêntico byte a byte.
removedbooleanonãoSe a mudança é uma remoção: a entidade não lê nada para o qual um bloqueio registre uma fixação, então nenhum bloqueio fica ao lado dela.
dryRunbooleanonãoSe isto informa o que a etapa faria em vez do que ela fez.
pinsPinClassCount[]nãoQuantas fixações de cada classe o bloqueio contém após a etapa, ou conteria após uma execução de teste. Toda classe que o bloqueio pode conter é listada, inclusive uma classe sem nenhuma fixação.
contentstringnãoO bloqueio que uma execução de teste escreveria. Ausente onde o bloqueio seria deixado como está ou removido, e em toda 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 nomeia uma ausente 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 os caches que servem este espaço de trabalho contêm.

PropriedadeTipoObrigatóriaDescrição
classesCacheClass[] ou nullsimCada cache e o que ele contém.
provenanceCacheProvenance[] ou nullsimSob quais identidades os artefatos em cache foram obtidos.
totalCountintegersimQuantas entradas os caches contêm no total.
totalSizeintegersimQuantos bytes eles ocupam no total.
totalSizeTextstringsimO mesmo total escrito do jeito que uma pessoa o lê.
scopeCacheScopesimAté onde uma resposta sobre o cache alcança. Duas das classes de cache são compartilhadas por todos os projetos da máquina, então toda resposta sobre o cache nomeia quais delas tocou — caso contrário, uma sessão aberta sobre um espaço de trabalho seria lida como se informasse 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 mantinha aberto. Apenas o Windows se recusa a remover um arquivo aberto, então em qualquer outro lugar isto fica vazio. Essas entradas não são contadas nem como removidas nem como mantidas, nenhum dos seus bytes conta como recuperado, e uma poda posterior as recupera; uma entrada que é um diretório pode já ter perdido os arquivos dentro dela que não estavam abertos.
retainedCountintegersimQuantas entradas foram mantidas.
reclaimedBytesintegersimQuantos bytes foram recuperados.
reclaimedBytesTextstringsimO mesmo número escrito da forma como uma pessoa o lê.
unattributedCountintegersimQuantas entradas nenhum detentor reivindica.
unattributedSizeintegersimQuantos bytes essas entradas ocupam.
unattributedSizeTextstringsimO mesmo número escrito da forma como uma pessoa o lê.
notPruneEligibleCacheShortfall[] ou nullsimO que foi deixado para trás, e o que o recuperaria.
scopeCacheScopesimAté onde uma resposta sobre o cache alcança. Duas das classes de cache são compartilhadas por todos os projetos da máquina, então toda resposta sobre o cache nomeia quais delas tocou — caso contrário, uma sessão aberta sobre um espaço de trabalho seria lida como se informasse 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
withinCapBeforebooleanosimSe o que estava mantido já cabia abaixo do tamanho, de modo que nada precisou 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 mantinha aberto; em vez disso, ela passou para a próxima entrada mais antiga. Apenas o Windows se recusa a remover um arquivo aberto, então em qualquer outro lugar isto fica vazio. Essas entradas ainda contam para os bytes que restam, e uma recuperação de espaço posterior pode removê-las.
totalBeforeintegersimQuantos bytes eram mantidos antes.
totalBeforeTextstringsimO mesmo número escrito da forma como uma pessoa o lê.
reclaimedBytesintegersimQuantos bytes foram recuperados.
reclaimedBytesTextstringsimO mesmo número escrito da forma como uma pessoa o lê.
remainingBytesintegersimQuantos bytes restam.
remainingBytesTextstringsimO mesmo número escrito da forma como uma pessoa o lê.
capBytesintegersimO tamanho até o qual o espaço foi recuperado, em bytes.
capBytesTextstringsimO mesmo tamanho escrito do jeito que uma pessoa o lê.
scopeCacheScopesimAté onde uma resposta sobre o cache alcança. Duas das classes de cache são compartilhadas por todos os projetos da máquina, então toda resposta sobre o cache nomeia quais delas tocou — caso contrário, uma sessão aberta sobre um espaço de trabalho seria lida como se informasse apenas sobre esse espaço de trabalho.

Não são permitidas propriedades adicionais.

CacheClearResult

O que o esvaziamento dos caches recuperou.

PropriedadeTipoObrigatóriaDescrição
clearedCacheCleared[] ou nullsimCada cache que foi esvaziado.
reclaimedBytesintegersimQuantos bytes foram recuperados.
reclaimedBytesTextstringsimO mesmo número escrito da forma como uma pessoa o lê.
scopeCacheScopesimAté onde uma resposta sobre o cache alcança. Duas das classes de cache são compartilhadas por todos os projetos da máquina, então toda resposta sobre o cache nomeia quais delas tocou — caso contrário, uma sessão aberta sobre um espaço de trabalho seria lida como se informasse apenas sobre esse espaço de trabalho.

Não são permitidas propriedades adicionais.

RegistryListResult

Os registros por meio dos quais este espaço de trabalho resolve.

PropriedadeTipoObrigatóriaDescrição
registriesRegistry[] ou nullsimCada registro configurado.
credentialStateIsMachineWidebooleanosimSe a presença de credenciais informada para cada registro é um fato de toda a máquina em vez de um fato do espaço de trabalho. É informado para que uma resposta limitada à sessão não seja lida como se negasse o alcance mais amplo.

Não são permitidas propriedades adicionais.

SearchResult

O que os índices locais dos registros ofereceram para a busca.

PropriedadeTipoObrigatóriaDescrição
recordsRegistrySearchRecord[] ou nullsimOs registros 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.
stalebooleanosimSe algum índice pesquisado é antigo o bastante para que valha a pena atualizá-lo.
registriesConfiguredbooleanosimSe há algum registro configurado, o que distingue “nada correspondeu” de “nada foi pesquisado”.

Não são permitidas propriedades adicionais.

RegistryAddResult

O que o cadastro de um registro escreveu, onde, e o que ele leu do próprio registro.

PropriedadeTipoObrigatóriaDescrição
hoststringsimO host sob o qual a entrada é indexada, que nem sempre é a grafia que a requisição usou.
scopeConfigWriteScopesimQual documento de configuração foi escrito e até onde ele alcança. Uma requisição nomeia um espaço de trabalho, então uma resposta que não dissesse nada seria lida como se fosse sobre 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 registro produziu. Os resultados são mantidos separados porque significam coisas diferentes: a política anunciada foi adotada, o registro não anunciou nada — o que não é uma falha —, a linha de base embutida foi fixada em seu lugar, ou nenhuma leitura foi tentada. Onde nada foi anunciado, se o registro pôde sequer ser alcançado é indicado ao lado.

Não são permitidas propriedades adicionais.

RegistryRemoveResult

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

PropriedadeTipoObrigatóriaDescrição
hoststringsimO host cuja entrada foi removida.
scopeConfigWriteScopesimQual documento de configuração foi escrito e até onde ele alcança. Uma requisição nomeia um espaço de trabalho, então uma resposta que não dissesse nada seria lida como se fosse sobre 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.
registriesConfiguredbooleanosimSe há algum registro configurado.
reachedRegistriesbooleanosimSempre true nesta resposta: atualizar os índices vai até os próprios registros, enquanto listá-los e pesquisar respondem a partir da configuração e de um índice local. Se um dado registro foi de fato alcançado é indicado na sua própria entrada em hosts, por unreachable.

Não são permitidas propriedades adicionais.

LogoutResult

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

PropriedadeTipoObrigatóriaDescrição
registrystringsimO registro cuja credencial foi removida.
scopeCredentialStoreScopesimAté onde uma alteração de credencial alcança. O armazenamento é compartilhado por todo projeto da máquina e por qualquer outra ferramenta que se dirija aos mesmos registros, então a resposta informa isso 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 a etapa de fixação também traz o que essa etapa fez, como pin, que fica ausente onde a etapa não foi executada.

PropriedadeTipoObrigatóriaDescrição
referencestringsimA referência sob a qual a entidade foi publicada.
tagstringsimA tag sob a qual ela foi publicada.
kindstringsimO tipo de entidade que foi publicado.
mediaTypestringsimO tipo de mídia registrado para os bytes publicados.
sizeintegersimQuantos bytes foram publicados.
sizeTextstringsimO mesmo tamanho escrito do jeito que uma pessoa o lê.
pluginSizeintegernãoQuantos bytes ocupa o módulo de plugin publicado junto com uma entidade Plugin.
pluginSizeTextstringnãoO mesmo tamanho escrito do jeito que uma pessoa o lê.
digeststringsimO digest do que foi publicado. Em uma 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.
signedbooleanosimSe esta publicação anexou uma assinatura: a que ela criou antes de publicar ou, em uma versão já publicada, uma que faltava à versão.
alreadyPublishedbooleanosimSe os mesmos bytes já estavam lá, de modo que nenhum conteúdo foi enviado. Apenas o que ainda faltava àquela publicação foi anexado ao lado deles: a sua data de publicação e, onde esta publicação assina, a sua assinatura; signed diz se uma assinatura foi anexada.
dryRunbooleanosimSe isto informa o que a publicação teria depositado em vez do que ela depositou.
reachPublicationReachsimAté onde uma publicação chegou. Essas respostas chegam inteiramente além desta máquina — o que elas anexam é o que todo consumidor desse registro resolve —, então cada uma nomeia todo registro ao qual se dirigiu e se a chamada anexou algo ali.
pinPinResultnãoO que a etapa de fixação fez com o bloqueio ao lado de uma entidade, ou faria em uma execução de teste. É a resposta a aggrega/pin, e uma publicação que executou a etapa a traz como o seu pin.
wholeDirectorySourcestringnãoA fonte local da entidade tal como escrita, presente quando ela é escrita como template. Uma fonte assim só nomeia o seu diretório depois que uma Release preenche o template, então a publicação traz todo arquivo no diretório da entidade em vez de apenas os arquivos que a entidade nomeia. Ausente onde ela traz apenas esses arquivos.
windowsUnusableEntriesstring[]nãoAs entradas do arquivo compactado publicado cujo caminho contém uma parte que o Windows não consegue conter tal como 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 vem a seguir, ou uma parte que termina em ponto ou em espaço —, primeiro o próprio nome de arquivo do documento da entidade, depois os arquivos que ele traz. Um espaço de trabalho no Windows se recusa a descompactá-las, então não consegue usar a versão; a publicação prossegue ou para exatamente como faria sem elas. Ausente onde 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 arquivo depositou, e onde.

PropriedadeTipoObrigatóriaDescrição
referencestringsimA referência sob a qual o arquivo foi publicado.
tagstringsimA tag sob a qual ela foi publicada.
mediaTypestringsimO tipo de mídia registrado para os bytes publicados.
sizeintegersimQuantos bytes foram publicados.
sizeTextstringsimO mesmo tamanho escrito do jeito que uma pessoa o lê.
digeststringsimO digest do que foi publicado.
alreadyPublishedbooleanosimSe os mesmos bytes já estavam lá, de modo que nenhum conteúdo foi enviado. Uma data de publicação foi anexada ao lado deles apenas onde faltava uma ao artefato.
dryRunbooleanosimSe isto informa o que a publicação teria depositado em vez do que ela depositou.
reachPublicationReachsimAté onde uma publicação chegou. Essas respostas chegam inteiramente além desta máquina — o que elas anexam é o que todo consumidor desse registro resolve —, então cada uma nomeia todo registro ao qual se dirigiu e se a chamada anexou algo ali.

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 uma publicação chegou. Essas respostas chegam inteiramente além desta máquina — o que elas anexam é o que todo consumidor desse registro resolve —, então cada uma nomeia todo registro ao qual se dirigiu e se a chamada anexou algo ali.

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 uma publicação chegou. Essas respostas chegam inteiramente além desta máquina — o que elas anexam é o que todo consumidor desse registro resolve —, então cada uma nomeia todo registro ao qual se dirigiu e se a chamada anexou algo ali.

Não são permitidas propriedades adicionais.

ResolveResult

Onde está definido o elemento sob o cursor.

PropriedadeTipoObrigatóriaDescrição
locationnull ou LocationsimOnde ele está definido. É null onde nada sob o cursor se resolve em uma 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 lugar em que se faz referência a ele.

Não são permitidas propriedades adicionais.

FindImplementationsResult

Quais documentos implementam o elemento sob o cursor.

PropriedadeTipoObrigatóriaDescrição
locationsLocation[] ou nullsimCada lugar em que ele é 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 onde 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 levam para fora do espaço de trabalho, para diretórios e para arquivos, 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 leva a um diretório fora dela, nomeado de forma relativa à raiz no lugar em que o próprio link está, na ordem em que o espaço de trabalho é pesquisado. Nenhum diretório fora da raiz é pesquisado, então nenhum documento por trás de um desses links está entre entities como próprio do espaço de trabalho, e um cliente que lista entidades pode dizer por quê. Não nomeados: um link para um diretório dentro da raiz, que é pesquisado, ou deixado de fora, onde realmente está; um link em qualquer lugar onde um diretório seria deixado de fora, seja por onde está, pelo seu nome ou por um .gitignore; um link que não pode ser resolvido, porque não leva a lugar nenhum ou gira em um ciclo; e, em uma 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 é nomeado como um arquivo YAML, com o seu próprio nome terminando em .yaml ou .yml, e leva a um arquivo fora da raiz, nomeado de forma relativa à raiz no lugar em que o próprio link está, na ordem em que o espaço de trabalho é pesquisado. Um arquivo assim não é lido para o índice, seja o que for que declare, então a entidade que ele declara não está entre entities como própria do espaço de trabalho, e um cliente que lista entidades pode dizer por quê; 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 arquivo 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 lugar próprio do link; um link para um arquivo dentro da raiz, que é lido no lugar 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 leva a nenhum arquivo, seja a um diretório, que unreadLinkedDirs nomeia onde ele leva para fora da raiz, a lugar nenhum ou a um ciclo; e, em uma resposta dada nos termos de uma Release, um link sob um diretório de catálogo que apenas outras Releases leem. Um arquivo de configuração do espaço de trabalho que é um link que leva para fora do espaço de trabalho, o seu próprio .aggrega-config.yaml ou o overlay de propriedade da 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 então não é lida de forma alguma, esta resposta é o índice próprio do espaço de trabalho lido sem nada configurado, então nenhum diretório de catálogo é lido para ele, e toda requisição que a configuração decide, incluindo um índice nos termos de uma Release, é recusada para esse espaço de trabalho com a condição do bloqueio de leitura.

Não são permitidas propriedades adicionais.

AttachCandidatesResult

Quais Features podem ser vinculadas à entidade, e os rótulos em relação aos quais foram julgadas; e, para uma conexão que a requisição 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 julgados.
nodeLabelsmapa de string ou nullsimOs rótulos em relação aos quais o julgamento foi feito.
labelSourcestringsimQual conjunto de rótulos foi usado, o que não é cosmético: os rótulos declarados de um documento são o que uma leitura da fonte pode ver, enquanto os de um nó do grafo são o conjunto finalizado em relação ao qual o próprio build julga. Uma resposta calculada sobre o segundo é uma afirmação sobre o que o build fará.
candidatesSourcedEntityRef[] ou nullsimCada Feature que pode ser vinculada.
slotsSlotCandidacy[]nãoPresente apenas quando a requisição nomeou uma conexão: cada slot que o socket da conexão declara, na ordem em que o Component os declara, com as Features que podem preenchê-lo. Vazio quando nenhum slot pode ser preenchido na conexão, e noSlotReason então diz por quê — o que um cliente lê em vez de tomar uma lista vazia por slots aos quais nenhuma Feature correspondeu.
noSlotReasonconst “feature-created-connection” ou const “ad-hoc-socket” ou const “no-slot-declared”nãoPresente apenas quando a requisição nomeou uma conexão e nenhum slot pode ser preenchido nela: por que nada pode ser vinculado ali. Ausente sempre que o socket declara um slot. O conjunto é fechado. Valores permitidos: "feature-created-connection" — Uma Feature traçou a conexão, e uma vinculação é escrita apenas em uma conexão que um componente ou a Release traça. "ad-hoc-socket" — O socket é um que o Component não declara, então ele não declara nenhum slot para uma conexã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 quais entidades cada socket da entidade pode ser conectado.

PropriedadeTipoObrigatóriaDescrição
nodestringsimA entidade de que são estes sockets.
adHocSocketsAcceptedbooleanosimSe um socket que a própria definição da entidade não declara previamente ainda pode ser escrito.
socketsSocketCandidacy[] ou nullsimCada socket e o que pode ser conectado a ele.

Não são permitidas propriedades adicionais.

InsertionPointResult

Onde, no documento, pertence uma nova entrada sob o contêiner nomeado, e o que um cliente precisa para escrevê-la ali: o próprio ponto, se uma quebra de linha precisa abrir o texto, as chaves de contêiner que ainda faltam e a indentação que cada linha recebe.

PropriedadeTipoObrigatóriaDescrição
filestringsimO documento.
containerstring[] ou nullsimO caminho através do documento até o contêiner.
positionEncodingstringsimA codificação em que as posições desta resposta são expressas.
positionPositionsimUm ponto em um documento: uma linha e um deslocamento de caractere 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.
precededByLineBreakbooleanosimSe o texto escrito na posição precisa começar com uma quebra de linha, porque a posição fica no fim de uma linha que o documento já contém. É false apenas onde o documento não contém nada que a entrada possa seguir.
missingContainerKeysstring[] ou nullsimOs segmentos do caminho do contêiner que o documento ainda não contém, do mais externo para o mais interno. Cada um precisa ser escrito como uma chave própria, indentado um nível a mais do que o anterior, antes que a entrada possa ir dentro do mais interno. É null onde 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 cada nível de aninhamento é indentado.
indentStepMeasuredbooleanosimSe o passo foi medido a partir do aninhamento próprio deste documento. Onde é false, o documento não apresenta nenhum aninhamento a medir e o passo é um valor alternativo, então um cliente que prefira impor o seu próprio sabe que está livre para isso.
entryShapeconst “mapping” ou const “sequence” ou const “unknown”simA forma em que o contêiner traz as suas entradas, que é o que decide como o texto próprio da entrada é composto. Ela é lida do contêiner que o documento já contém e nunca é deduzida de como o contêiner se chama. O conjunto é fechado. Valores permitidos: "mapping" — O contêiner é um mapeamento em bloco, então uma entrada acrescentada a ele é uma chave e o seu valor. "sequence" — O contêiner é uma sequência em bloco, então uma entrada acrescentada a ele é um hífen e o seu valor. "unknown" — O documento não contém o contêiner, ou o contém sem nada dentro, então cabe ao cliente decidir qual forma uma entrada assume.

Não são permitidas propriedades adicionais.

AttachmentContainerResult

Em qual documento, e em que ponto dele, pertence uma vinculação no nó do grafo, ou na conexão que a requisição nomeou.

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

Não são permitidas propriedades adicionais.

ConnectionAtPositionResult

A conexão dentro de cuja entrada a posição cai, ou por que nenhuma é informada. Exatamente uma metade está presente: graphNode e connection juntos, ou noConnectionReason sozinho. Uma posição em qualquer lugar dentro de uma entrada — no seu alias, no seu destino ou nas suas vinculações — está dentro dessa entrada, a mais interna onde 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 conexão, tal como o grafo compilado o indexa — o valor que as requisições de candidatura e de contêiner recebem como graphNode.
connectionConnectionCoordinatenãoA conexão, pelo seu socket e pelo seu alias, com document nomeando o documento em que a posição foi lida — o valor que as requisições de candidatura e de contêiner recebem como connection.
noConnectionReasonconst “no-connection-entry” ou const “feature-created-connection” ou const “unknown-connection”nãoPresente apenas onde nenhuma conexão é informada: o motivo. O conjunto é fechado. Valores permitidos: "no-connection-entry" — A posição não está em nenhuma entrada em que uma vinculação é escrita: nem uma conexão que um componente traça, escrita sob o seu alias, nem uma entrada por aresta na Release. Uma conexão escrita como uma lista de destinos, e uma que o próprio bloco de uma Feature traça, não trazem nenhuma entrada assim. "feature-created-connection" — A posição está na entrada da Release para uma conexão que uma Feature traçou, e uma vinculação é escrita apenas em uma conexão que um componente ou a Release traça. "unknown-connection" — A posição está em uma entrada que a Release escreve para uma conexã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 levam para fora dele, para diretórios e para arquivos, que não foram lidos para elas.

PropriedadeTipoObrigatóriaDescrição
releasesstring[] ou nullsimCada documento de Release.
lockfilesmapa de stringsimO arquivo de bloqueio de cada Release listada, indexado pela Release exatamente como ela está listada. Cada um é o arquivo que um pull escreve para essa Release e que um build lê, então um cliente lê onde ele fica em vez de deduzi-lo. 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 leva a um diretório fora dela, nomeado de forma relativa à raiz no lugar em que o próprio link está, na ordem em que o espaço de trabalho é pesquisado. Nenhum diretório fora da raiz é pesquisado, então uma Release alcançada apenas através de um desses links não está em releases, e um cliente que oferece Releases pode dizer por quê. Não nomeados: um link para um diretório dentro da raiz, que é pesquisado, ou deixado de fora, onde realmente está; um link em qualquer lugar onde um diretório seria deixado de fora, seja por onde está ou pelo seu nome; e um link que não pode ser resolvido, porque não leva a lugar nenhum ou gira em um ciclo. Vazio quando o espaço de trabalho não contém nenhum.
unreadLinkedFilesstring[]simCada link sob a raiz do espaço de trabalho que é nomeado como um arquivo YAML, com o seu próprio nome terminando em .yaml ou .yml, e leva a um arquivo fora da raiz, nomeado de forma relativa à raiz no lugar em que o próprio link está, na ordem em que o espaço de trabalho é pesquisado. Um arquivo assim não é lido, então uma Release alcançada apenas através de um desses links não está em releases, e um cliente que oferece Releases pode dizer por quê. Se um arquivo é uma Release não se sabe sem lê-lo, então cada link assim é nomeado seja o que for que o arquivo contenha. Não nomeados: um link para um arquivo 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 lugar próprio do link; um link para um arquivo dentro da raiz, que é lido; um link dentro de um diretório que a pesquisa deixa de fora; e um link que não leva a nenhum arquivo, seja a um diretório, que unreadLinkedDirs nomeia onde ele leva para fora da raiz, a lugar nenhum ou a um ciclo. Um arquivo de configuração do espaço de trabalho que é um link que leva para fora do espaço de trabalho, o seu próprio .aggrega-config.yaml ou o overlay de propriedade da 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 então não é lida de forma alguma, esta resposta é lida sem nada configurado, então nenhuma Release que a configuração nomeia através de um link é listada, e toda requisição que a configuração decide é recusada para esse espaço de trabalho com a condição do bloqueio de leitura.

Não são permitidas propriedades adicionais.

ActiveReleaseResult

Sobre qual Release um cliente deve agir por padrão. Um espaço de trabalho que não aponta para nenhuma Release é um estado comum e não uma falha, então isso é informado 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 onde nenhuma foi.
lockfilestringnãoO arquivo de bloqueio da Release que foi escolhida: o arquivo que um pull escreve para ela e que um build lê. Ausente onde nenhuma Release foi escolhida.
reasonstringnãoPor que nenhuma Release foi escolhida.
tracestringnãoCada etapa da escolha e o que ela 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 mantida pelo daemon é descartada, então a próxima resposta sobre ele é calculada a partir dos bytes que a edição produziu.

PropriedadeTipoObrigatóriaDescrição
filestringsimO documento que foi editado.
editstringsimQual edição foi aplicada.
containerstring[] ou nullsimO caminho através do documento até onde a edição foi parar.
createdContainersstring[] ou nullsimOs contêineres que a edição precisou criar no caminho.
writtenstring[] ou nullsimOs documentos que foram escritos.
contentstringsimO documento composto, para uma requisição que pediu para ver o resultado em vez de tê-lo escrito.

Não são permitidas propriedades adicionais.

EffectiveConfigurationResult

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

PropriedadeTipoObrigatóriaDescrição
layersstring[] ou nullsimOs documentos de configuração que foram mesclados, na ordem em que foram mesclados.
settingsEffectiveConfigurationSetting[] ou nullsimCada configuração resolvida e de onde ela 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 registro.

PropriedadeTipoObrigatóriaDescrição
hoststringsimO registro para o qual a configuração foi inicializada.
scopeConfigWriteScopesimQual documento de configuração foi escrito e até onde ele alcança. Uma requisição nomeia um espaço de trabalho, então uma resposta que não dissesse nada seria lida como se fosse sobre 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 registro produziu. Os resultados são mantidos separados porque significam coisas diferentes: a política anunciada foi adotada, o registro não anunciou nada — o que não é uma falha —, a linha de base embutida foi fixada em seu lugar, ou nenhuma leitura foi tentada. Onde nada foi anunciado, se o registro pôde sequer ser alcançado é indicado ao lado.
writtenbooleanosimSe o documento foi escrito, em vez de devolvido para o chamador posicionar.
existedbooleanonãoPresente e true quando o documento já estava lá, de modo que a entrada do registro foi mesclada nele em vez de um novo documento ser criado. Apenas uma requisição que envia force prossegue sobre um documento existente, então ele fica ausente de toda resposta a uma requisição que não o fez.
contentstringnãoO texto do documento, para uma requisição que pediu para vê-lo em vez de tê-lo escrito.

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, já que todo o propósito é tornar um espaço de trabalho autocontido.
workspaceRootstringsimO espaço de trabalho que a requisição nomeou.
capturedbooleanosimSe algo foi congelado.
socketsConfigCapturedSocket[] ou nullsimCada socket que foi congelado, com as suas vinculações.
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 ela 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 arquivos foram escritos.
writtenstring[] ou nullsimCada arquivo que chegou ao disco, na ordem de escrita: os rascunhos, depois o registro do que a importação escreveu. Sob sync, apenas os rascunhos que a sincronização alterou e o registro onde ele mudou. Vazio sob dryRun.
filesImportedFile[] ou nullsimCada arquivo que a requisição escreve, com o seu texto, sob dryRun e sem ele: cada rascunho, depois o registro do que a importação escreveu. Sob sync, cada rascunho que a sincronização altera, com o seu novo texto, depois o registro onde ele também muda, de modo que uma sincronização já em dia responde com uma lista vazia.
driftImportDrift[]simCada parte que uma sincronização atualizou em relação à fonte, ou atualizaria sob dryRun, na ordem em que o rascunho as nomeia; um arquivo redigido que a sincronização exclui é uma delas, removida sem chaves. Uma lista vazia para uma requisição 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, na ordem do importador e exatamente como ele o informou: o que diz a você 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 informa nenhuma.
owedImportOwed[]nãoCada valor que os rascunhos ainda deixam vazio e que nenhuma fonte pôde fornecer nem nenhuma resposta forneceu, na ordem em que os rascunhos são escritos — os valores que os achados de aviso nomeiam. Toda resposta o inclui, como uma lista vazia quando os rascunhos não devem nada.
haltedbooleanosimSe a conversão parou em vez de terminar com achados.

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 em um rascunho.
skeletonstringnãoO texto do documento redigido. Presente em um rascunho.
examplesScaffoldExample[]nãoCada exemplo executável que a documentação publica, cada um uma vez, em ordem de nome. Presente em uma listagem que encontrou algum.
examplestringnãoO exemplo que foi escrito. Presente em uma escrita.
dirstringnãoO diretório em que o exemplo foi escrito, relativo à raiz do espaço de trabalho, como a requisição o nomeou ou, onde ela não nomeou nenhum, como o nome do exemplo. Presente em uma escrita.
filesstring[]nãoCada arquivo escrito, relativo a dir e separado por barras, na ordem em que a documentação os apresenta. Presente em uma escrita.
nextstring[]nãoOs comandos que a página do exemplo fornece para fazer o build dele, linha por linha como a página os escreve, comentários incluídos: o primeiro bloco de shell sob o seu título Build. Ausente onde a página não fornece nenhum.
versionstringnãoA versão da documentação da qual o exemplo foi lido: a do próprio binário, onde uma é publicada para ele, caso contrário a mais recente publicada antes dele. Presente em uma 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 uma requisição envia como example para escrevê-lo.
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 também traz passes; as contagens e files cobrem então todas as passagens juntas.

PropriedadeTipoObrigatóriaDescrição
entitystringnãoA única entidade que foi verificada, onde a requisição nomeou uma.
releasestringnãoA Release cujo fechamento foi verificado, onde a requisição nomeou uma.
checkedintegersimQuantos documentos foram verificados. Onde 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.
findingsintegersimQuantos achados há no total.
errorsintegersimQuantos deles são erros.
warningsintegersimQuantos deles são alertas.
infosintegersimQuantos deles são informativos.
filesLintFileFindings[] ou nullsimOs achados, por documento.
haltedbooleanosimSe a verificação parou em vez de terminar com achados.
passesLintPass[] ou nullnãoA verificação do catálogo inteiro uma passagem por vez, presente apenas onde foi executada uma vez para cada Release porque o espaço de trabalho nomeia Releases sob workspace.releases. Cada passagem diz para quais Releases os seus achados foram encontrados. 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 fechamento de uma Release.

Não são permitidas propriedades adicionais.

LintPass

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

PropriedadeTipoObrigatóriaDescrição
releasesstring[] ou nullsimAs Releases para as quais a passagem foi executada, cada uma como um caminho relativo à raiz do espaço de trabalho. Releases que leem os mesmos diretórios de catálogo compartilham uma passagem.
catalogDirsstring[] ou nullsimOs diretórios de catálogo que a passagem leu, na ordem em que são pesquisados, cada um relativo à raiz do espaço de trabalho onde fica dentro dela. Vazio onde as suas Releases não leem nenhum diretório de catálogo, de modo que a passagem não verificou nada e não fez falhar nenhuma das outras.
checkedintegersimQuantos documentos a passagem verificou.
findingsintegersimQuantos achados a passagem encontrou.
errorsintegersimQuantos deles são erros.
warningsintegersimQuantos deles são alertas.
infosintegersimQuantos deles são informativos.
filesLintFileFindings[] ou nullsimOs achados da passagem, por documento.

Não são permitidas propriedades adicionais.

PluginAddResult

O que a vinculação de um plugin escreveu, onde e qual versão ela fixou.

PropriedadeTipoObrigatóriaDescrição
typestringsimO socket ao qual o plugin foi vinculado.
identitystringnãoA identidade em que a vinculação foi resolvida.
uristringnãoA referência a partir da qual a vinculação é resolvida.
capabilitystringnãoA capacidade a que a vinculação se destina.
referencestringnãoA referência fixada, versão incluída.
scopePluginWriteScopesimEm qual documento de configuração uma alteração de plugin foi escrita e até onde ela alcança. O padrão próprio do socket de extensão de comandos é o documento de toda a máquina, então toda resposta diz qual escreveu.
writtenbooleanosimSe o documento de configuração foi escrito, em vez de devolvido para o chamador posicionar.
contentstringnãoO texto do documento de configuração, para uma requisição que pediu para vê-lo em vez de tê-lo escrito.
retractionPluginRetractionnãoComo um marcador de descontinuação determinou qual versão do plugin foi fixada.
withdrawnbooleanonãoÉ true quando a consulta nomeou a versão que foi fixada e uma retratação na qual este espaço de trabalho confia retirou essa versão. Uma versão nomeada é fixada mesmo assim, porque nomeá-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 nomeada não puderam ser lidos, retraction.unscreened diz por quê, e, sem nenhuma versão nomeada, a versão publicada mais recente é escolhida e retraction informa o que a verificação de retirada concluiu sobre essa escolha.

Não são permitidas propriedades adicionais.

PluginRemoveResult

O que a desvinculação de um plugin escreveu, e onde.

PropriedadeTipoObrigatóriaDescrição
typestringsimO socket ao qual o plugin foi vinculado.
querystringsimQual vinculação foi removida.
scopePluginWriteScopesimEm qual documento de configuração uma alteração de plugin foi escrita e até onde ela alcança. O padrão próprio do socket de extensão de comandos é o documento de toda a máquina, então toda resposta diz qual escreveu.

Não são permitidas propriedades adicionais.

PluginSyncResult

O que o alinhamento dos registros gerenciados 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 contribui.
changedbooleanosimSe algo no documento realmente mudou.

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 que o chamador saiba.
dryRunbooleanosimSe 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ãoPor que as passagens publicadas estão ausentes, onde não puderam ser obtidas. O que o próprio binário declara continua sendo respondido.

Não são permitidas propriedades adicionais.

GetSchemaResult

O esquema de um tipo ou — onde a requisição não nomeou nenhum — quais tipos podem ser nomeados. As duas amplitudes seguem em uma única resposta em vez de em dois métodos, porque “o que posso nomear” e “de quais deles 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, repassado tal como o binário o mantém.
kindsstring[]nãoCada token ao qual este binário responde.
entityKindsEntityKindDescriptor[]nãoO conjunto mais restrito do qual um autor escreve um documento, cada um associando o token que uma requisição 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, na ordem em que a requisição nomeou os assistentes. Assistentes que leem uma mesma pasta compartilhada compartilham uma entrada, porque a skill é escrita lá uma única vez.
scopeSkillFolderScopesimAté onde uma instalação de skill alcança. Uma requisição nomeia um espaço de trabalho, então uma resposta que não dissesse nada seria lida como se fosse sobre esse espaço de trabalho — e para as pastas por usuário, que um assistente lê em todo 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, na ordem em que a requisição os nomeou.
folderstringsimA pasta da skill, como um caminho absoluto.
replacedbooleanosimSe uma cópia que traz a linha de comentário que toda cópia escrita da skill traz — uma que uma instalação anterior escreveu, ou uma obtida do repositório de skills publicado — estava lá e foi substituída. Um arquivo lá 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 pode escrevê-las. Nada é escrito e nada é acessado.

PropriedadeTipoObrigatóriaDescrição
skillsSkillsListedSkill[]simCada skill que o binário inclui, em 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 das quais ele lê skills.

PropriedadeTipoObrigatóriaDescrição
idstringsimO identificador pelo qual uma requisição nomeia o assistente.
namestringsimO próprio nome do assistente.
projectFolderstringsimA pasta, relativa à raiz de um projeto e separada por barras, 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 a requisição nomeia.
userFolderstringsimA pasta, relativa ao diretório home e separada por barras, da qual o assistente lê as skills próprias do usuário em todo projeto. Uma instalação com global escreve a pasta da skill dentro dela.

Não são permitidas propriedades adicionais.