Ir al contenido
AggregaAggrega
Seleccionar idioma: Español
Esta página se tradujo automáticamente. Lee el original en inglés.

Esquema del protocolo de comunicación del daemon en segundo plano de Aggrega

Referencia generada. No la edites a mano — regenérala a partir del JSON Schema publicado.

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

Las formas de los mensajes que se intercambian con un daemon del compilador en segundo plano iniciado por aggrega serve. Un cliente abre una sesión sobre ese daemon con el handshake, y la sesión es lo que delimita los ajustes y el espacio de trabajo sobre los que se abrió la conversación; el daemon es el proceso que responde a una solicitud, envía una notificación y conserva lo que ha leído. El protocolo es JSON-RPC 2.0 sobre la entrada y la salida estándar, con cada mensaje delimitado por un encabezado Content-Length; este documento describe los cuerpos de los mensajes y ni la delimitación ni el transporte. Un cuerpo es una de cuatro cosas: una solicitud que envía el cliente, una notificación que envía el cliente, una notificación que envía el daemon, o la respuesta que el daemon devuelve para una solicitud. Tres propiedades de la superficie deciden cómo se escriben las formas de abajo. Primero, cada solicitud admite dos campos además de los que declara su propio método — workspaceRoot, que nombra el espacio de trabajo sobre el que actúa la solicitud, y workDoneToken, el valor generado por el llamador bajo el que se informa del progreso — así que ambos aparecen aquí en cada objeto params de solicitud, incluidos los tres métodos cuyo sujeto no es un espacio de trabajo: aggrega/getSchema y aggrega/scaffoldEntity aceptan workspaceRoot y lo ignoran, y aggrega/initialize lo lee como el espacio de trabajo que declara la sesión. Segundo, el daemon rechaza un objeto params de solicitud que lleva un campo que el método no acepta, nombrando lo que sí acepta, así que aquí cada objeto params está cerrado en su nivel superior; un objeto anidado dentro de una solicitud no está cerrado, porque la comprobación solo lee los nombres de campo más externos. Tercero, un resultado lo compone el daemon en lugar de proporcionarlo un llamador, así que los objetos de resultado están cerrados en cada nivel cuya forma es fija, y abiertos solo donde el valor es JSON opaco que el daemon transmite sin leerlo. Una consecuencia de la codificación del daemon es visible en los mensajes transmitidos y se describe en lugar de ocultarse: una colección que el daemon no marca como opcional se emite como null cuando no tiene ningún valor que informar y como una colección vacía cuando el valor que informa está vacío, así que ambas formas se admiten dondequiera que eso se aplique.

Una de las siguientes formas

  • Request
  • ClientNotification
  • DaemonNotification
  • SuccessResponse
  • ErrorResponse

Definiciones

ProtocolVersion

La versión de JSON-RPC que lleva cada mensaje. Solo se habla la 2.0.

Tipo: const "2.0"

Constante: "2.0"

RequestId

El identificador del llamador para una solicitud, que se repite en la respuesta que la contesta. Un mensaje que no lleva ningún identificador es una notificación y nunca recibe respuesta.

Tipo: string or number

ProgressToken

Un valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.

Tipo: string or number

WorkspaceRootSubject

La ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.

Tipo: string

WorkspaceRootAccepted

La ruta absoluta de un espacio de trabajo. El sujeto de este método no es un espacio de trabajo — responde a partir de lo que lleva el propio binario — así que el campo se acepta y no se lee. Se admite para que un cliente pueda enviarlo de forma uniforme en cada solicitud sin tener que saber qué métodos lo consultan.

Tipo: string

RequestMethod

Cada método que una solicitud puede nombrar. El conjunto es cerrado: una solicitud que nombra cualquier otra cosa recibe como respuesta un error de método no encontrado.

Tipo: string (enum)

Valores permitidos: "aggrega/activeRelease", "aggrega/attachCandidates", "aggrega/attachmentContainer", "aggrega/build", "aggrega/buildPreview", "aggrega/cacheClear", "aggrega/cacheEvict", "aggrega/cachePrune", "aggrega/cacheStatus", "aggrega/catalogIndex", "aggrega/completion", "aggrega/configCapture", "aggrega/configInit", "aggrega/connectionAtPosition", "aggrega/connectionCandidates", "aggrega/deprecateArtifact", "aggrega/diagnostics", "aggrega/editDocument", "aggrega/effectiveConfiguration", "aggrega/entityDefinition", "aggrega/explainError", "aggrega/findImplementations", "aggrega/findReferences", "aggrega/getSchema", "aggrega/hover", "aggrega/import", "aggrega/initialize", "aggrega/insertionPoint", "aggrega/invalidate", "aggrega/irGraph", "aggrega/lint", "aggrega/logout", "aggrega/pin", "aggrega/pluginAdd", "aggrega/pluginGenCatalog", "aggrega/pluginRemove", "aggrega/pluginSync", "aggrega/publishArtifact", "aggrega/publishEntity", "aggrega/registryAdd", "aggrega/registryList", "aggrega/registryRemove", "aggrega/registryUpdate", "aggrega/releaseCandidates", "aggrega/releaseClosure", "aggrega/resolve", "aggrega/resolveDependencies", "aggrega/scaffoldEntity", "aggrega/search", "aggrega/setActiveRelease", "aggrega/signArtifacts", "aggrega/skillsInstall", "aggrega/skillsList", "aggrega/validate"

ClientNotificationMethod

Cada método que una notificación del cliente puede nombrar. El conjunto es cerrado, y ninguna de las dos notificaciones recibe respuesta.

Tipo: string (enum)

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

DaemonNotificationMethod

Cada método que una notificación enviada por el daemon puede nombrar. El conjunto es cerrado.

Tipo: string (enum)

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

Request

Una solicitud que envía el cliente y que responde el daemon. El método nombra lo que se pide; el objeto params lleva los campos propios de ese método más los dos que admite todo método. Una solicitud que omite params por completo se lee como una cuyos campos están todos ausentes.

PropiedadTipoObligatoriaDescripción
jsonrpcProtocolVersionsíLa versión de JSON-RPC que lleva cada mensaje. Solo se habla la 2.0.
idRequestIdsíEl identificador del llamador para una solicitud, que se repite en la respuesta que la contesta. Un mensaje que no lleva ningún identificador es una notificación y nunca recibe respuesta.
methodRequestMethodsíCada método que una solicitud puede nombrar. El conjunto es cerrado: una solicitud que nombra cualquier otra cosa recibe como respuesta un error de método no encontrado.
paramsobjectno

No se permiten propiedades adicionales.

params para cada method:

methodparamsObligatoria
"aggrega/initialize"InitializeParamsno
"aggrega/validate"ValidateParamsno
"aggrega/invalidate"InvalidateParamsno
"aggrega/diagnostics"DiagnosticsParamsno
"aggrega/irGraph"IrGraphParamsno
"aggrega/build"BuildParamsno
"aggrega/buildPreview"BuildPreviewParamsno
"aggrega/entityDefinition"EntityDefinitionParamsno
"aggrega/releaseClosure"ReleaseClosureParamsno
"aggrega/resolveDependencies"ResolveDependenciesParamsno
"aggrega/pin"PinParamsno
"aggrega/cacheStatus"WorkspaceAndProgressParamsno
"aggrega/cachePrune"WorkspaceAndProgressParamsno
"aggrega/cacheEvict"CacheEvictParamsno
"aggrega/cacheClear"WorkspaceAndProgressParamsno
"aggrega/registryList"WorkspaceAndProgressParamsno
"aggrega/search"SearchParamsno
"aggrega/registryAdd"RegistryAddParamsno
"aggrega/registryRemove"RegistryRemoveParamsno
"aggrega/registryUpdate"RegistryUpdateParamsno
"aggrega/logout"LogoutParamsno
"aggrega/publishEntity"PublishEntityParamsno
"aggrega/publishArtifact"PublishArtifactParamsno
"aggrega/signArtifacts"SignArtifactsParamsno
"aggrega/deprecateArtifact"DeprecateArtifactParamsno
"aggrega/resolve"ResolveParamsno
"aggrega/findReferences"FindReferencesParamsno
"aggrega/findImplementations"FindImplementationsParamsno
"aggrega/hover"HoverParamsno
"aggrega/completion"CompletionParamsno
"aggrega/catalogIndex"CatalogIndexParamsno
"aggrega/attachCandidates"AttachCandidatesParamsno
"aggrega/connectionCandidates"ConnectionCandidatesParamsno
"aggrega/insertionPoint"InsertionPointParamsno
"aggrega/attachmentContainer"AttachmentContainerParamsno
"aggrega/connectionAtPosition"ConnectionAtPositionParamsno
"aggrega/releaseCandidates"WorkspaceAndProgressParamsno
"aggrega/activeRelease"WorkspaceAndProgressParamsno
"aggrega/setActiveRelease"SetActiveReleaseParamsno
"aggrega/editDocument"EditDocumentParamsno
"aggrega/effectiveConfiguration"WorkspaceAndProgressParamsno
"aggrega/configInit"ConfigInitParamsno
"aggrega/configCapture"ConfigCaptureParamsno
"aggrega/import"ImportParamsno
"aggrega/scaffoldEntity"ScaffoldEntityParamsno
"aggrega/lint"LintParamsno
"aggrega/pluginAdd"PluginAddParamsno
"aggrega/pluginRemove"PluginRemoveParamsno
"aggrega/pluginSync"PluginSyncParamsno
"aggrega/pluginGenCatalog"PluginGenCatalogParamsno
"aggrega/explainError"ExplainErrorParamsno
"aggrega/getSchema"GetSchemaParamsno
"aggrega/skillsInstall"SkillsInstallParamsno
"aggrega/skillsList"WorkspaceAndProgressParamsno

ClientNotification

Una notificación que envía el cliente. No lleva ningún identificador y nunca recibe respuesta.

PropiedadTipoObligatoriaDescripción
jsonrpcProtocolVersionsíLa versión de JSON-RPC que lleva cada mensaje. Solo se habla la 2.0.
methodClientNotificationMethodsíCada método que una notificación del cliente puede nombrar. El conjunto es cerrado, y ninguna de las dos notificaciones recibe respuesta.
paramsobjectno

No se permiten propiedades adicionales.

params para cada method:

methodparamsObligatoria
"$/cancelRequest"CancelRequestParamssí
"aggrega/shutdown"ShutdownParamsno

DaemonNotification

Una notificación que envía el daemon. No lleva ningún identificador y nunca recibe respuesta.

PropiedadTipoObligatoriaDescripción
jsonrpcProtocolVersionsíLa versión de JSON-RPC que lleva cada mensaje. Solo se habla la 2.0.
methodDaemonNotificationMethodsíCada método que una notificación enviada por el daemon puede nombrar. El conjunto es cerrado.
paramsobjectsí

No se permiten propiedades adicionales.

params para cada method:

methodparamsObligatoria
"$/progress"ProgressParamssí
"aggrega/publishDiagnostics"PublishDiagnosticsParamssí

CancelRequestParams

Pide al daemon que abandone una solicitud ya en curso, nombrándola por el identificador que llevaba la solicitud. Para una solicitud ya terminada, o nunca enviada, simplemente no hay nada que cancelar, y no se informa de nada.

PropiedadTipoObligatoriaDescripción
idRequestIdsíEl identificador del llamador para una solicitud, que se repite en la respuesta que la contesta. Un mensaje que no lleva ningún identificador es una notificación y nunca recibe respuesta.

No se permiten propiedades adicionales.

ShutdownParams

Pide al daemon que deje de aceptar trabajo y termine lo que ya ha tomado. La notificación no lleva campos, y la propia notificación suele enviarse sin ningún objeto params. Una segunda abandona el trabajo aún en curso en lugar de esperarlo.

Este objeto no declara propiedades fijas y no permite ninguna.

ProgressParams

Un informe de trabajo en curso, enviado solo para una solicitud que generó un token de progreso en una sesión que declaró que podía recibirlos.

PropiedadTipoObligatoriaDescripción
tokenProgressTokensíUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
valueProgressBegin o ProgressReport o ProgressEndsíEl informe en sí. Un informe de apertura, luego cualquier número de líneas, luego un informe de cierre.

No se permiten propiedades adicionales.

ProgressBegin

Abre un informe, diciendo qué ha comenzado en los términos que usa la propia operación.

PropiedadTipoObligatoriaDescripción
kindconst “begin”síMarca este payload como la apertura de un informe. Constante: "begin"
titlestringsíLo que ha comenzado.

No se permiten propiedades adicionales.

ProgressReport

Una línea del relato que la propia operación hace de sí misma. No lleva ninguna fracción: las operaciones que informan aquí recorren un conjunto cuyo tamaño no se conoce cuando empieza el trabajo, así que habría que inventar una fracción.

PropiedadTipoObligatoriaDescripción
kindconst “report”síMarca este payload como una línea de un informe abierto. Constante: "report"
messagestringsíUna línea de la salida propia de la operación, sin los espacios en blanco que la rodean.

No se permiten propiedades adicionales.

ProgressEnd

Cierra un informe. No lleva nada más allá del tipo, porque el resultado viaja en la respuesta que el llamador ya está esperando.

PropiedadTipoObligatoriaDescripción
kindconst “end”síMarca este payload como el cierre de un informe. Constante: "end"

No se permiten propiedades adicionales.

PublishDiagnosticsParams

Los hallazgos de un archivo, enviados por el daemon cuando una validación los produjo para un documento distinto del que nombraba la solicitud.

PropiedadTipoObligatoriaDescripción
filestringsíEl archivo al que se refieren los hallazgos.
diagnosticsDiagnostic[] o nullsíLos hallazgos, en el orden en que se produjeron.

No se permiten propiedades adicionales.

SuccessResponse

La respuesta a una solicitud que tuvo éxito, que lleva el identificador de la solicitud a la que responde. Una respuesta no lleva ningún método, así que qué forma de resultado se aplica lo fija la solicitud a la que pertenece el identificador y no nada de la propia respuesta.

PropiedadTipoObligatoriaDescripción
jsonrpcProtocolVersionsíLa versión de JSON-RPC que lleva cada mensaje. Solo se habla la 2.0.
idRequestIdsíEl identificador del llamador para una solicitud, que se repite en la respuesta que la contesta. Un mensaje que no lleva ningún identificador es una notificación y nunca recibe respuesta.
resultInitializeResult o ValidateResult o InvalidateResult o DiagnosticsResult o IrGraphResult o BuildResult o BuildPreviewResult o EntityDefinitionResult o ReleaseClosureResult o ResolveDependenciesResult o PinResult o CacheStatusResult o CachePruneResult o CacheEvictResult o CacheClearResult o RegistryListResult o SearchResult o RegistryAddResult o RegistryRemoveResult o RegistryUpdateResult o LogoutResult o PublishEntityResult o PublishArtifactResult o SignArtifactsResult o DeprecateArtifactResult o ResolveResult o FindReferencesResult o FindImplementationsResult o HoverResult o CompletionResult o CatalogIndexResult o AttachCandidatesResult o ConnectionCandidatesResult o InsertionPointResult o AttachmentContainerResult o ConnectionAtPositionResult o ReleaseCandidatesResult o ActiveReleaseResult o EditDocumentResult o EffectiveConfigurationResult o ConfigInitResult o ConfigCaptureResult o ImportResult o ScaffoldEntityResult o LintResult o PluginAddResult o PluginRemoveResult o PluginSyncResult o PluginGenCatalogResult o ExplainErrorResult o GetSchemaResult o SkillsInstallResult o SkillsListResultsíLa respuesta, en la forma que devuelve el método que se pidió.

No se permiten propiedades adicionales.

ErrorResponse

La respuesta a una solicitud que se rechazó o falló, que lleva el identificador de la solicitud a la que responde.

PropiedadTipoObligatoriaDescripción
jsonrpcProtocolVersionsíLa versión de JSON-RPC que lleva cada mensaje. Solo se habla la 2.0.
idRequestIdsíEl identificador del llamador para una solicitud, que se repite en la respuesta que la contesta. Un mensaje que no lleva ningún identificador es una notificación y nunca recibe respuesta.
errorErrorObjectsíQué salió mal: un código según el cual un cliente puede ramificar su lógica, un mensaje escrito para que lo lea una persona y — donde la condición tiene una — los artefactos y la posición en el código fuente a los que se refiere el mensaje.

No se permiten propiedades adicionales.

ErrorObject

Qué salió mal: un código según el cual un cliente puede ramificar su lógica, un mensaje escrito para que lo lea una persona y — donde la condición tiene una — los artefactos y la posición en el código fuente a los que se refiere el mensaje.

PropiedadTipoObligatoriaDescripción
codeErrorCodesíLa condición que informa la respuesta. Los códigos negativos son el conjunto reservado propio del protocolo; los códigos de cuatro dígitos son condiciones que genera este daemon, cada una de las cuales nombra un estado sobre el que un cliente puede actuar. El conjunto es cerrado.
messagestringsíQué salió mal, en prosa. Es la misma redacción que lleva la misma condición en cualquier otra superficie que la informa.
dataErrorDatanoLos artefactos y la posición en el código fuente a los que se refiere el mensaje, llevados de forma estructurada para que un cliente no tenga que extraerlos de la prosa. Cada campo es opcional y una condición rellena solo lo que tiene a mano; ningún campo sustituye a otro, así que un cliente sabe qué ha recibido por el campo que leyó y no por el código que lo acompaña.

No se permiten propiedades adicionales.

ErrorCode

La condición que informa la respuesta. Los códigos negativos son el conjunto reservado propio del protocolo; los códigos de cuatro dígitos son condiciones que genera este daemon, cada una de las cuales nombra un estado sobre el que un cliente puede actuar. El conjunto es cerrado.

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 — No se pudo analizar el mensaje como JSON.
  • -32600 — El mensaje se analizó pero no es una solicitud bien formada.
  • -32601 — No existe ningún método con ese nombre.
  • -32602 — Los params que llevaba la solicitud no son admisibles: un campo que el método no acepta, un campo del tipo incorrecto o un valor que el método rechaza.
  • -32603 — El daemon falló mientras realizaba el trabajo.
  • 1001 — El daemon no conserva ninguna lectura del archivo y no está produciendo ninguna. El cliente inicia una pidiendo una validación y luego vuelve a intentarlo.
  • 1003 — Falta el archivo de bloqueo de la Release que nombraba la solicitud, y la operación necesita uno.
  • 1004 — No se pudo resolver la entidad que nombraba la solicitud ni desde el catálogo ni desde la Release que nombraba la solicitud.
  • 1005 — El daemon se está apagando y rechaza trabajo nuevo. El cliente no vuelve a intentarlo contra el mismo daemon.
  • 1006 — Una validación del archivo se está ejecutando ahora y no terminó dentro del margen de tiempo que permitía la solicitud en espera. El cliente espera y vuelve a pedir, sin enviar nada mientras tanto.

ErrorData

Los artefactos y la posición en el código fuente a los que se refiere el mensaje, llevados de forma estructurada para que un cliente no tenga que extraerlos de la prosa. Cada campo es opcional y una condición rellena solo lo que tiene a mano; ningún campo sustituye a otro, así que un cliente sabe qué ha recibido por el campo que leyó y no por el código que lo acompaña.

PropiedadTipoObligatoriaDescripción
filestringnoEl documento fuente que localizan los campos de posición — el documento que se está comprobando, o la Release cuya carga falló.
lineintegernoLa línea a la que se refiere la condición, contada desde uno.
columnintegernoLa columna a la que se refiere la condición, contada desde uno.
end_lineintegernoLa línea una posición después del final del token al que se refiere la condición. Ausente donde el token no tiene un final recuperable, en cuyo caso un cliente representa la posición como un punto.
end_columnintegernoLa columna una posición después del final del token al que se refiere la condición.
releasestringnoLa Release a la que se refiere la condición, escrita tal como la nombró la solicitud, para que un cliente pueda componer el remedio sin volver a ensamblarla.
lockfilestringnoEl archivo de bloqueo del que trata una condición relativa al archivo de bloqueo: la ruta que se buscó y no se encontró, o que no se pudo leer.
unreachablebooleanonoSi el rechazo se debe a un registro que nombró la solicitud y que no se pudo alcanzar: su nombre no se resolvió, una conexión con él se rechazó o no se pudo abrir, o no se pudo establecer una conexión segura con él. Se lee del propio fallo y no del mensaje, y solo se establece donde el fallo muestra que nunca se llegó al registro. Una actualización del índice rechazada que nombra un registro lo lleva; un registro que respondió, respondiera lo que respondiera, lo deja ausente.
codestringnoEl nombre descriptivo de la condición que nombra el rechazo, estable entre versiones: el mismo valor que lleva en su propio código un diagnóstico que informa de esa condición. Es aquello según lo cual un cliente ramifica su lógica, en lugar del mensaje o del código numérico que lo acompaña, que nombra el estado de la solicitud y sigue siendo el mismo para cada condición. Presente exactamente cuando el rechazo nombra una condición registrada, y ausente cuando no nombra ninguna.
shortCodestringnoEl código corto de la condición, la letra E seguida de cuatro dígitos: la forma que un lector cita y busca, y la que abre el mensaje de un rechazo que nombra una condición. Presente exactamente cuando lo está code.

No se permiten propiedades adicionales.

Diagnostic

Un hallazgo sobre un documento: dónde está, qué gravedad tiene, qué dice y el código citable que nombra la condición de la que informa.

PropiedadTipoObligatoriaDescripción
lineintegersíLa línea a la que se refiere el hallazgo, contada desde uno.
columnintegersíLa columna a la que se refiere el hallazgo, contada desde uno.
severityconst “error” o const “warning” o const “info”síQué gravedad tiene el hallazgo. Valores permitidos: "error" — El hallazgo es un error. Un hallazgo de un plugin con severidad halt se informa en este nivel. "warning" — El hallazgo se informa y no es un error. Un hallazgo de un plugin con severidad warn se informa en este nivel. "info" — El hallazgo es información, como lo es un hallazgo de un plugin con severidad info.
messagestringsíLo que dice el hallazgo, en prosa.
codestringnoEl nombre descriptivo de la condición, estable entre versiones y citable en una supresión.
shortCodestringnoEl código corto de la condición, la forma que abre un diagnóstico bloqueante.
codeDescriptionCodeDescriptionnoDónde se explica la condición que nombra el hallazgo.
classificationstringnoCómo se llegó al hallazgo, donde la condición hace esa distinción.
suggeststringnoLa grafía que propone el hallazgo, donde la condición puede nombrar una — un identificador casi correcto, por ejemplo.
keyPathstringnoLa ruta a través del documento hasta la clave a la que se refiere el hallazgo.
sourcestringsíLo que produjo el hallazgo.
end_lineintegernoLa línea una posición después del final del token al que se refiere el hallazgo, para que un cliente pueda representar el token completo en lugar de un solo carácter. Ausente para un token que abarca varias líneas.
end_columnintegernoLa columna una posición después del final del token al que se refiere el hallazgo.

No se permiten propiedades adicionales.

CodeDescription

Dónde se explica la condición que nombra el hallazgo.

PropiedadTipoObligatoriaDescripción
hrefstringsíLa dirección publicada en la que se explica la condición.

No se permiten propiedades adicionales.

Position

Un lugar en un documento: una línea y un desplazamiento de carácter dentro de ella, ambos contados desde cero. El desplazamiento se mide en las unidades de la codificación que la sesión acordó al abrirse, que es UTF-16 a menos que el cliente haya pedido otra.

PropiedadTipoObligatoriaDescripción
lineintegersíLa línea, contada desde cero.
characterintegersíEl desplazamiento dentro de la línea, contado desde cero, en las unidades de la codificación que acordó la sesión.

No se permiten propiedades adicionales.

Range

Un tramo entre dos lugares de un documento.

PropiedadTipoObligatoriaDescripción
startPositionsíUn lugar en un documento: una línea y un desplazamiento de carácter dentro de ella, ambos contados desde cero. El desplazamiento se mide en las unidades de la codificación que la sesión acordó al abrirse, que es UTF-16 a menos que el cliente haya pedido otra.
endPositionsíUn lugar en un documento: una línea y un desplazamiento de carácter dentro de ella, ambos contados desde cero. El desplazamiento se mide en las unidades de la codificación que la sesión acordó al abrirse, que es UTF-16 a menos que el cliente haya pedido otra.

No se permiten propiedades adicionales.

Location

Un tramo en un documento con nombre.

PropiedadTipoObligatoriaDescripción
uristringsíEl documento en el que está el tramo, direccionado como URI.
rangeRangesíUn tramo entre dos lugares de un documento.

No se permiten propiedades adicionales.

WorkspaceAndProgressParams

El objeto params de un método que no declara campos propios. Aun así admite los dos campos que admite cada solicitud: el espacio de trabajo sobre el que actúa y un token de progreso.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.

No se permiten propiedades adicionales.

InitializeParams

Abre una sesión sobre un espacio de trabajo e indica lo que el cliente puede manejar. Este es el único método en el que workspaceRoot es una declaración en lugar de un sujeto: ausente, vacío y una ruta son tres cosas distintas, y una sesión abierta sin ruta es una que el cliente aún no ha dirigido a un espacio de trabajo.

PropiedadTipoObligatoriaDescripción
capabilitiesClientCapabilitiesnoLo que el cliente puede manejar. Lo que no se indica se considera no admitido. Los miembros desconocidos se ignoran en lugar de rechazarse, así que un cliente puede indicar una capacidad que este daemon aún no lee.
workspaceRootstringnoLa ruta absoluta del espacio de trabajo que se abre. Si falta, la sesión queda sin espacio de trabajo; una cadena vacía es una ruta que proporcionó el cliente y no equivale a no enviar ninguna.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.

No se permiten propiedades adicionales.

ClientCapabilities

Lo que el cliente puede manejar. Lo que no se indica se considera no admitido. Los miembros desconocidos se ignoran en lugar de rechazarse, así que un cliente puede indicar una capacidad que este daemon aún no lee.

PropiedadTipoObligatoriaDescripción
generalobjectnoCapacidades que no están ligadas a un único tipo de respuesta.
windowobjectnoCapacidades sobre lo que el cliente puede mostrar mientras hay trabajo en curso.

Se permiten propiedades adicionales.

ClientCapabilities.general

Capacidades que no están ligadas a un único tipo de respuesta.

PropiedadTipoObligatoriaDescripción
positionEncodingsstring[]noLas codificaciones de posición que el cliente puede leer, la mejor primero.

Se permiten propiedades adicionales.

ClientCapabilities.window

Capacidades sobre lo que el cliente puede mostrar mientras hay trabajo en curso.

PropiedadTipoObligatoriaDescripción
workDoneProgressbooleanonoSi el cliente puede recibir notificaciones de progreso. Una solicitud que genera un token de progreso en una sesión que no declaró esto se rechaza.

Se permiten propiedades adicionales.

ValidateParams

Comprueba el espacio de trabajo, o un documento de él, y responde con los hallazgos.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
filestringnoEl documento que se comprueba. Si falta, se comprueba lo que contiene el espacio de trabajo.
contentstringnoEl texto del documento tal como lo tiene actualmente el cliente, para comprobar un búfer que no se ha guardado. Si falta, se leen los bytes del disco.
releasestringnoLa Release con la que se comprueba, como ruta relativa a la raíz del espacio de trabajo.

No se permiten propiedades adicionales.

InvalidateParams

Indica al daemon que un documento del que conserva una lectura ha cambiado, para que la siguiente respuesta sobre él se calcule a partir de los nuevos bytes.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
filestringnoEl documento que cambió.
granularitystringnoCuánto de lo que conserva el daemon se descarta: file descarta solo lo que conserva para el documento nombrado; workspace, el valor predeterminado y como se lee cualquier otro valor, descarta además lo que conserva para todo el espacio de trabajo.

No se permiten propiedades adicionales.

DiagnosticsParams

Responde con los hallazgos que el daemon ya conserva para un documento, sin volver a comprobarlo.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
filestringnoEl documento sobre el que se informa. El daemon ya debe conservar una lectura de él.

No se permiten propiedades adicionales.

IrGraphParams

Responde con el grafo resuelto en el que se compila una Release, sin renderizarlo.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
releasestringnoLa Release que se resuelve, como ruta relativa a la raíz del espacio de trabajo. Una ruta absoluta se rechaza.
unredactedbooleanonoSi se responde con los valores que un autor declaró sensibles en claro. Si falta o es false, cada uno de ellos se retiene del grafo y en su lugar aparece un marcador que indica el motivo, como los retiene la salida del grafo de la línea de comandos; true responde con el grafo tal como la Release se compila en él, incluidos esos valores.

No se permiten propiedades adicionales.

BuildParams

Compila una Release y escribe los artefactos renderizados en el espacio de trabajo.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
releasestringnoLa Release que se compila, como ruta relativa a la raíz del espacio de trabajo. Una ruta absoluta se rechaza.
outputParentstringnoEl directorio dentro del cual se crea el directorio de salida, como ruta relativa a la raíz del espacio de trabajo. Los artefactos llegan al directorio de salida que hay debajo, dispuestos como lo están bajo la raíz del espacio de trabajo cuando no se nombra nada — así que esto nombra el directorio padre del directorio de salida y nunca el directorio de salida en sí. Si falta, o está vacío, escribe el directorio de salida bajo la raíz del espacio de trabajo, como hace aggrega build desde dondequiera que se ejecute. Una ruta absoluta, o una que sale del espacio de trabajo, se rechaza.
autoPullbooleanonoSi se resuelven primero las dependencias de la Release. Pedirlo llega a los registros configurados y escribe el archivo de bloqueo; sin pedirlo, la compilación no llega a ningún registro.
policyInputstringnoEl directorio en el que se escribe, junto a los artefactos, el payload que cada rol de gobernanza entrega a un plugin vinculado allí, como ruta relativa a la raíz del espacio de trabajo — los archivos que escribe aggrega build --policy-input, con los mismos nombres, escritos tanto si la compilación termina como si se detiene. Los avisos de la respuesta dicen cuántos se escribieron y nombran cada rol para el que no se escribió ningún archivo. En una solicitud que falla, los archivos escritos están en el disco y ese recuento no está en la respuesta: el error lleva solo el rechazo. Si falta, no se escribe ninguno. Una ruta absoluta, o una que sale del espacio de trabajo, se rechaza.

No se permiten propiedades adicionales.

BuildPreviewParams

Compila una Release e informa de lo que habría producido escribir los artefactos, sin escribir ninguno. Rechaza el campo de resolución de dependencias que acepta la compilación que escribe, porque una solicitud que no escribe nada no puede rellenar un archivo de bloqueo.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
releasestringnoLa Release que se compila, como ruta relativa a la raíz del espacio de trabajo.
autoPullbooleanonoSe acepta en los mensajes transmitidos y el método lo rechaza: esta solicitud no escribe nada, así que no puede rellenar un archivo de bloqueo y seguir siendo lo que dice ser.
policyInputstringnoEl directorio en el que se escribe el payload que cada rol de gobernanza entrega a un plugin vinculado allí, como ruta relativa a la raíz del espacio de trabajo — los archivos que escribe aggrega build --dry-run --policy-input, con los mismos nombres. Si se envía, son lo único que escribe esta solicitud; el directorio de salida y el archivo de bloqueo quedan intactos. Los avisos de la respuesta dicen cuántos se escribieron y nombran cada rol para el que no se escribió ningún archivo. En una solicitud que falla, los archivos escritos están en el disco y ese recuento no está en la respuesta: el error lleva solo el rechazo. Una ruta absoluta, o una que sale del espacio de trabajo, se rechaza.

No se permiten propiedades adicionales.

EntityDefinitionParams

Responde con aquello en lo que se resuelve un nombre de entidad y dónde está el documento que la define.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
namestringnoLa entidad que se resuelve, por nombre — o una referencia de registro, oci://<host>/<repository>:<tag> o @<digest> en lugar de :<tag>, para leer la entidad publicada en esa coordenada.
releasestringnoLa Release en cuyos términos se resuelve el nombre, como ruta relativa a la raíz del espacio de trabajo. El nombre se resuelve entonces a través de los directorios de catálogo que la configuración del espacio de trabajo asigna a esa Release, de modo que un nombre que declaran varias variantes en un mismo espacio de trabajo, una por Release, se resuelve en la variante con la que se compila esa Release, y un nombre que no resuelve se rechaza con una explicación que nombra la entrada de esa Release bajo workspace.releases. Si falta, el nombre se resuelve sobre los propios directorios de catálogo del espacio de trabajo. Una referencia de registro no admite ninguna Release y se rechaza si lleva una, igual que un valor que no nombra ningún archivo de Release.

No se permiten propiedades adicionales.

CatalogIndexParams

Responde con las entidades que contiene el espacio de trabajo: cada entidad que declaran sus documentos, y las Features que declaran sus directorios de catálogo.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
releasestringnoLa Release en cuyos términos se enumeran las entidades, como ruta relativa a la raíz del espacio de trabajo. Las Features son entonces las que declaran los directorios de catálogo que la configuración del espacio de trabajo asigna a esa Release, y un documento bajo un directorio de catálogo que solo leen otras Releases se excluye, de modo que un espacio de trabajo que mantiene variantes de una entidad una junto a otra, una por Release, se enumera con la variante con la que se compila esa Release. Si falta, la lista es la propia del espacio de trabajo. Un valor que no nombra ningún archivo de Release se rechaza.

No se permiten propiedades adicionales.

ReleaseClosureParams

Responde con todo aquello de lo que depende una Release, tal como lo alcanzó la resolución.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
releasestringnoLa Release que se inspecciona, como ruta relativa a la raíz del espacio de trabajo.

No se permiten propiedades adicionales.

ResolveDependenciesParams

Resuelve las dependencias de una Release, fijándolas en el archivo de bloqueo y obteniendo las entradas externas que consume su renderizado. Llega a los registros configurados y escribe.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
releasestringnoLa Release que se resuelve, como ruta relativa a la raíz del espacio de trabajo.
upgradebooleanonoSi se vuelve a resolver dentro de los rangos declarados en lugar de respetar lo que el archivo de bloqueo ya fija.
targetsstring[]noLas referencias que se vuelven a resolver, dejando el resto fijado tal como está. Vacío resuelve todo.
verifybooleanonoSi se compara el archivo de bloqueo registrado con la resolución que esta solicitud realizaría sin él, respetando las fijaciones que esa solicitud respetaría, en lugar de escribirlo. Una verificación no escribe ningún archivo de bloqueo, registro de confianza de plugins ni entity.lock; la caché de contenido se lee y se rellena como esa resolución la leería y la rellenaría. Una deriva, y un archivo de bloqueo ausente, hacen fallar la solicitud. No se puede combinar con upgrade, targets ni pinSources, sea cual sea el valor que lleve pinSources: una solicitud que envía uno de ellos junto a él se rechaza como params no válidos antes de que se resuelva nada.
pinSourcesbooleanonoSi se ejecuta el paso de fijación que ejecuta aggrega/pin sobre las Recipes y las FeatureRecipes que la Release compila desde los directorios de catálogo del espacio de trabajo, escribiendo el entity.lock junto a cada una, en lugar de rechazar la solicitud por una cuyo bloqueo no registra una fijación que necesita una entrada. Si falta, sigue el pin_sources_at_pull del espacio de trabajo; cualquiera de los dos valores sustituye ese ajuste para esta solicitud.

No se permiten propiedades adicionales.

PinParams

Registra, en el entity.lock junto a una Recipe o una FeatureRecipe, la fijación de contenido de cada entrada que la entidad lee desde fuera de su propio documento. No se nombra ninguna Release: una entrada cuya identidad la entidad escribe por completo nombra un único artefacto para cada Release que usa la entidad, así que no se necesita nada de lo que proporciona una Release para fijarla. Llega a los hosts que nombran las fuentes de la entidad y escribe junto a la entidad; el propio documento de la entidad nunca se escribe.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
entitystringnoEl documento de entidad que se fija, como ruta relativa a la raíz del espacio de trabajo.
dryRunbooleanonoSi se responde con el bloqueo que escribiría el paso en lugar de escribirlo. Las entradas se resuelven de todos modos, así que la caché de contenido se rellena de todos modos.

No se permiten propiedades adicionales.

CacheEvictParams

Recupera espacio del contenido en caché hasta que lo que queda cabe por debajo de un tamaño que nombra la solicitud.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
maxSizestringnoEl tamaño al que se reduce el espacio ocupado, escrito como lo escribe una persona — por ejemplo 500MB.

No se permiten propiedades adicionales.

SearchParams

Busca lo que ofrecen los índices locales de los registros configurados. Lee el índice que ya está en el disco y no contacta con ningún registro.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
querystringnoEl texto que se compara con el nombre y la descripción de un registro.
kindsstring[]noLos tipos de entidad que se conservan. Vacío conserva todos los tipos.
selectorstringnoUn selector de etiquetas que deben cumplir los registros conservados.
capabilitiesstring[]noLas capacidades que debe declarar un registro de plugin conservado.
pluginTypestringnoEl tipo de plugin que se conserva.
registrystringnoEl único host de registro en el que se busca. Si falta, se busca en cada host configurado.
limitintegernoEl número máximo de registros con los que se responde.
includeRetractedbooleanonoSi se conservan las versiones que un marcador publicado ha declarado obsoletas.

No se permiten propiedades adicionales.

RegistryAddParams

Da de alta un registro y la política de confianza que la resolución aplica a lo que sirve. Escribe el archivo de configuración de toda la máquina a menos que la solicitud pida otra cosa, de modo que cada espacio de trabajo de la máquina resuelve a través de la entrada.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
hoststringnoEl host de registro que se da de alta.
namestringnoUn alias descriptivo que se resuelve en el host.
identitiesstring[]noLas identidades de firma de confianza para lo que sirve este registro.
keyPathstringnoLa ruta de una clave pública de confianza, para un registro firmado con una clave en lugar de con una identidad keyless.
trustedRootstringnoLa ruta del ancla de confianza con la que se verifican las firmas.
requireSignaturesbooleanonoSi un artefacto de este registro debe llevar una firma verificada. Si falta, no indica nada y deja vigente el valor predeterminado resuelto.
advisorybooleanonoSi una verificación fallida se informa en lugar de detener la ejecución.
fetchTrustbooleanonoSi se lee la política de confianza que anuncia el registro y se fija. Si falta, no indica nada y deja vigente el valor predeterminado resuelto.
globalbooleanonoEscribe el archivo de configuración de toda la máquina, que es el valor predeterminado propio de este método.
workspacebooleanonoEscribe el archivo de configuración propio de este espacio de trabajo en lugar del de toda la máquina.

No se permiten propiedades adicionales.

RegistryRemoveParams

Elimina un registro dado de alta. Escribe el archivo de configuración de toda la máquina a menos que la solicitud pida otra cosa.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
registrystringnoEl registro que se elimina, por host o por alias.
globalbooleanonoEscribe el archivo de configuración de toda la máquina, que es el valor predeterminado propio de este método.
workspacebooleanonoEscribe el archivo de configuración propio de este espacio de trabajo en lugar del de toda la máquina.

No se permiten propiedades adicionales.

RegistryUpdateParams

Actualiza el índice local que lee una búsqueda, llegando al registro para hacerlo. Lo que escribe es el índice bajo el directorio de caché configurado propio de este espacio de trabajo. Un registro que necesita una credencial que ninguna fuente del entorno proporciona se rechaza nombrando la credencial, en lugar de pedirla de forma interactiva.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
registrystringnoEl único registro que se actualiza. Si falta, se actualiza cada host configurado.
upgradebooleanonoSi se reconstruye el índice en lugar de añadir a lo que ya contiene.

No se permiten propiedades adicionales.

LogoutParams

Elimina una credencial de registro almacenada. El almacén lo comparten todos los proyectos de la máquina, y la respuesta lo indica.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
registrystringnoEl registro cuya credencial almacenada se va a eliminar.

No se permiten propiedades adicionales.

PublishEntityParams

Publica una entidad en un registro. Lo que deposita es lo que resuelve cada consumidor de ese registro, y una versión publicada no puede retirarse de nadie que ya la haya obtenido. No se pide nada de forma interactiva: la identidad se resuelve a partir de lo que la solicitud proporcionó o de lo que el entorno ya lleva.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
entitystringnoEl documento de entidad que se va a publicar, como ruta relativa a la raíz del espacio de trabajo.
registrystringnoEl registro en el que publicar. Si falta, se usa el predeterminado configurado.
dryRunbooleanonoSi se informa de lo que la publicación depositaría sin depositarlo.
signbooleanonoSi se firma lo que se publica. Si falta, no indica nada y deja vigente el valor predeterminado resuelto.
pluginstringnoEl módulo de plugin que se publica junto con una entidad Plugin.
fulcioUrlstringnoLa autoridad de certificación de la que obtener un certificado de firma.
rekorUrlstringnoEl registro de transparencia en el que registrar la firma.
timestampUrlstringnoLa autoridad de sellado de tiempo con la que refrendar la firma.
identityTokenstringnoEl token de identidad con el que firmar, proporcionado por el llamador en lugar de obtenido en un terminal.
pinSourcesbooleanonoSi se ejecuta sobre la entidad, antes de empaquetarla, el paso de fijación que ejecuta aggrega/pin, de modo que el entity.lock que el paso escribe junto a ella forme parte de lo que se publica. El paso se ejecuta antes de cualquier rechazo que juzgue la entidad, y con dryRun informa del bloqueo que escribiría y no escribe nada. Si falta, sigue el pin_sources_at_push del espacio de trabajo; cualquiera de los dos valores sustituye ese ajuste para esta solicitud.

No se permiten propiedades adicionales.

PublishArtifactParams

Publica un archivo arbitrario en un registro con un nombre y un tag que le asigna la solicitud.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
filestringnoEl archivo que se va a publicar, como ruta relativa a la raíz del espacio de trabajo.
namestringnoEl nombre de repositorio con el que publicar.
tagstringnoEl tag con el que publicar.
mediaTypestringnoEl tipo de medio que se registra para los bytes publicados.
registrystringnoEl registro en el que publicar. Si falta, se usa el predeterminado configurado.
dryRunbooleanonoSi se informa de lo que la publicación depositaría sin depositarlo.

No se permiten propiedades adicionales.

SignArtifactsParams

Firma lo que ya está publicado. Una firma no puede retirarse de nadie que ya la haya obtenido.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
referencesstring[]noLas referencias publicadas que se van a firmar.
fulcioUrlstringnoLa autoridad de certificación de la que obtener un certificado de firma.
rekorUrlstringnoEl registro de transparencia en el que registrar la firma.
timestampUrlstringnoLa autoridad de sellado de tiempo con la que refrendar la firma.
identityTokenstringnoEl token de identidad con el que firmar, proporcionado por el llamador en lugar de obtenido en un terminal.
jobsintegernoCuántas referencias se firman a la vez. Si falta, se firman una tras otra. Cada referencia se firma de todos modos exactamente como se firmaría sola — en modo keyless, con su propio certificado y su propia entrada en el registro de transparencia — y la respuesta conserva el orden en que se dieron las referencias. Mínimo: 1.

No se permiten propiedades adicionales.

DeprecateArtifactParams

Marca una versión publicada como obsoleta, para que la resolución pueda informar de ella o rechazarla. El marcador se publica y se firma a su vez. Una solicitud envía o bien una referencia con su contenido, o bien un archivo de lote cuyas entradas llevan el suyo propio — nunca ambos, y nunca contenido junto al archivo de lote.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
referencestringnoLa referencia publicada que se va a marcar. Una alternativa a from: una solicitud que lleva ambos se rechaza.
severityconst “warning” o const “error” o const “retracted”noCon qué fuerza se pronuncia el marcador — si la resolución informa de la versión o la rechaza. Obligatorio con reference; rechazado junto a from, cuyo archivo de lote lleva el propio de cada marcador. Valores permitidos: "warning" — Obsoleta, en el más leve de los dos niveles de aviso: sigue seleccionándose cuando se elige una versión. "error" — Obsoleta, en el más fuerte de los dos niveles de aviso: sigue seleccionándose cuando se elige una versión. "retracted" — Retirada: se excluye cuando se elige una versión.
reasonstringnoPor qué la versión es obsoleta. Obligatorio con reference; rechazado junto a from, cuyo archivo de lote lleva el propio de cada marcador.
replacementstringnoLa referencia que se debe usar en su lugar. Rechazado junto a from, cuyo archivo de lote lleva el propio de cada marcador.
messagestringnoLo que se le dice a un consumidor que encuentra el marcador. Rechazado junto a from, cuyo archivo de lote lleva el propio de cada marcador.
fromstringnoUn archivo de lote de entradas de retirada, como ruta relativa a la raíz del espacio de trabajo, que adjunta un marcador por entrada. Cada entrada lleva su propia referencia, su propia severidad y su propio motivo, y opcionalmente un reemplazo y un mensaje. Una alternativa a reference: una solicitud que lleva ambos, o que lleva junto a él una severidad, un motivo, un reemplazo o un mensaje, se rechaza.
fulcioUrlstringnoLa autoridad de certificación de la que obtener un certificado de firma.
rekorUrlstringnoEl registro de transparencia en el que registrar la firma.
timestampUrlstringnoLa autoridad de sellado de tiempo con la que refrendar la firma.
identityTokenstringnoEl token de identidad con el que firmar, proporcionado por el llamador en lugar de obtenido en un terminal.

No se permiten propiedades adicionales.

ResolveParams

Responde dónde está definido el elemento bajo el cursor.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
uristringnoEl documento en el que está el cursor.
positionPositionnoUn lugar en un documento: una línea y un desplazamiento de carácter dentro de ella, ambos contados desde cero. El desplazamiento se mide en las unidades de la codificación que la sesión acordó al abrirse, que es UTF-16 a menos que el cliente haya pedido otra.
releasestringnoLa Release en cuyos términos responder, como ruta relativa a la raíz del espacio de trabajo. La definición es entonces el documento al que se resuelve la referencia a través de los directorios de catálogo que la configuración del espacio de trabajo asigna a esa Release, en ese orden, de modo que un nombre que declaran varias variantes en un mismo espacio de trabajo, una por Release, lleva a la variante de esa Release; donde esos directorios no declaran ninguna entidad así, se buscan los documentos del espacio de trabajo, dejando fuera los que estén bajo uno de los directorios de catálogo del espacio de trabajo que la Release no lee. Si falta, se buscan primero los documentos del espacio de trabajo, y los propios directorios de catálogo del espacio de trabajo solo donde ningún documento declara el nombre. Un valor que no nombra ningún archivo de Release se rechaza.

No se permiten propiedades adicionales.

FindReferencesParams

Responde dónde se hace referencia al elemento bajo el cursor.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
uristringnoEl documento en el que está el cursor.
positionPositionnoUn lugar en un documento: una línea y un desplazamiento de carácter dentro de ella, ambos contados desde cero. El desplazamiento se mide en las unidades de la codificación que la sesión acordó al abrirse, que es UTF-16 a menos que el cliente haya pedido otra.
releasestringnoLa Release en cuyos términos responder, como ruta relativa a la raíz del espacio de trabajo. Una referencia hecha en un documento bajo uno de los directorios de catálogo del espacio de trabajo que la Release no lee no se informa entonces, de modo que las variantes que un espacio de trabajo mantiene una junto a otra, una por Release, nunca se informan como referencias unas de otras. Si falta, se busca en cada documento del espacio de trabajo. Un valor que no nombra ningún archivo de Release se rechaza.

No se permiten propiedades adicionales.

FindImplementationsParams

Responde qué documentos implementan el elemento bajo el cursor.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
uristringnoEl documento en el que está el cursor.
positionPositionnoUn lugar en un documento: una línea y un desplazamiento de carácter dentro de ella, ambos contados desde cero. El desplazamiento se mide en las unidades de la codificación que la sesión acordó al abrirse, que es UTF-16 a menos que el cliente haya pedido otra.
releasestringnoLa Release en cuyos términos responder, como ruta relativa a la raíz del espacio de trabajo. Un documento bajo uno de los directorios de catálogo del espacio de trabajo que la Release no lee no se informa entonces, de modo que una variante con la que se compila otra Release nunca aparece entre las de esta Release. Si falta, se busca en cada documento del espacio de trabajo. Un valor que no nombra ningún archivo de Release se rechaza.

No se permiten propiedades adicionales.

HoverParams

Responde con lo que se debe mostrar sobre el elemento bajo el cursor.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
uristringnoEl documento en el que está el cursor.
positionPositionnoUn lugar en un documento: una línea y un desplazamiento de carácter dentro de ella, ambos contados desde cero. El desplazamiento se mide en las unidades de la codificación que la sesión acordó al abrirse, que es UTF-16 a menos que el cliente haya pedido otra.
releasestringnoLa Release en cuyos términos responder, como ruta relativa a la raíz del espacio de trabajo. La entidad mostrada es entonces aquella a la que se resuelve la referencia a través de los directorios de catálogo que la configuración del espacio de trabajo asigna a esa Release, en ese orden; donde esos directorios no declaran ninguna entidad así, se buscan los documentos del espacio de trabajo, dejando fuera los que estén bajo uno de los directorios de catálogo del espacio de trabajo que la Release no lee. Si falta, se buscan primero los documentos del espacio de trabajo, y los propios directorios de catálogo del espacio de trabajo solo donde ningún documento declara el nombre. Un valor que no nombra ningún archivo de Release se rechaza.

No se permiten propiedades adicionales.

CompletionParams

Responde con lo que se puede escribir en la posición del cursor.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
uristringnoEl documento en el que está el cursor.
positionPositionnoUn lugar en un documento: una línea y un desplazamiento de carácter dentro de ella, ambos contados desde cero. El desplazamiento se mide en las unidades de la codificación que la sesión acordó al abrirse, que es UTF-16 a menos que el cliente haya pedido otra.
contextCompletionContextnoQué provocó la solicitud, donde el cliente lo registra.
releasestringnoLa Release en cuyos términos responder, como ruta relativa a la raíz del espacio de trabajo. Los nombres ofrecidos son entonces los que declaran los documentos del espacio de trabajo, menos los documentos bajo uno de los directorios de catálogo del espacio de trabajo que la Release no lee, junto con los Components y las Features que declaran los directorios de catálogo que la configuración del espacio de trabajo asigna a esa Release. Si falta, son los documentos del espacio de trabajo y los Components y las Features que declaran sus propios directorios de catálogo. Un valor que no nombra ningún archivo de Release se rechaza.

No se permiten propiedades adicionales.

CompletionContext

Qué provocó la solicitud, donde el cliente lo registra.

PropiedadTipoObligatoriaDescripción
triggerKindintegernoPor qué se pidió el autocompletado.
triggerCharacterstringnoEl carácter que lo provocó, cuando fue un carácter.

Se permiten propiedades adicionales.

AttachCandidatesParams

Responde qué Features pueden vincularse a una entidad, juzgadas según las etiquetas de esa entidad, y, para una conexión que traza el componente de un nodo del grafo, cuáles pueden llenar cada slot que declara el socket de la conexión.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
nodestringnoLa entidad según la cual juzgar los candidatos, por nombre, leída de lo que declaran los documentos del espacio de trabajo.
graphNodestringnoEl nodo del grafo según el cual juzgar los candidatos, cuyas etiquetas son el conjunto finalizado con el que la propia compilación evalúa la aplicabilidad. Una respuesta calculada sobre él dice lo que hará la compilación.
releasestringnoLa Release a cuyo grafo pertenece el nodo, como ruta relativa a la raíz del espacio de trabajo. Los candidatos se toman entonces en los términos de esa Release: las Features que declaran los directorios de catálogo que la configuración del espacio de trabajo asigna a esa Release, y los documentos del espacio de trabajo menos los que estén bajo uno de los directorios de catálogo del espacio de trabajo que la Release no lee, de modo que una Feature mantenida para otra Release nunca se ofrece para un nodo del grafo de esta.
labelsmapa de stringnoEtiquetas según las cuales juzgar directamente, en lugar de leerlas de una entidad o de un nodo del grafo.
connectionConnectionCoordinatenoUna conexión que traza el componente del nodo que nombra graphNode, para la que responder además de para ese nodo: la respuesta lleva entonces también slots, cada slot que declara el socket de la conexión con las Features que pueden llenarlo, o noSlotReason donde no se puede llenar ningún slot. Solo se envía con graphNode y release, porque una conexión solo existe en un grafo compilado; enviada con node o labels, se rechaza. Los candidatos junto a ella conservan su significado, las Features que pueden vincularse al propio nodo. Su documento se acepta y no cambia esta respuesta: los slots son los del socket y los candidatos los de las Features, los mismos sea cual sea el documento en el que se escriba una vinculación.

No se permiten propiedades adicionales.

ConnectionCandidatesParams

Responde a qué entidades puede conectarse un socket de una entidad.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
nodestringnoLa entidad sobre cuyos sockets se pregunta.
socketstringnoEl único socket para el que responder. Si falta, responde para cada socket que declara la entidad.

No se permiten propiedades adicionales.

InsertionPointParams

Responde dónde, en un documento, corresponde una nueva entrada bajo un contenedor nombrado, dejando la composición y la aplicación de la entrada al llamador que es dueño del búfer.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
filestringnoEl documento sobre el que responder.
containerstring[]noLa ruta a través del documento hasta el contenedor bajo el que corresponde la entrada.

No se permiten propiedades adicionales.

AttachmentContainerParams

Responde en qué documento, y en qué lugar de él, corresponde una vinculación sobre un nodo del grafo, o sobre una conexión que traza su componente.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
graphNodestringnoEl nodo del grafo al que está destinada la vinculación.
releasestringnoLa Release a cuyo grafo pertenece el nodo, como ruta relativa a la raíz del espacio de trabajo.
connectionConnectionCoordinatenoUna conexión que traza el componente del nodo del grafo, cuando la vinculación es para esa conexión y no para el nodo: la respuesta nombra entonces el contenedor features propio de la conexión en el documento que nombra su campo document, un campo obligatorio aquí. En el Aggregate, es la entrada de la conexión en el documento en el que se escribió el nodo, rechazada para una conexión que trazó la Release, para la que el Aggregate no contiene ninguna entrada. En la Release, es la entrada por arista bajo la entrada propia de la Release para el nodo, tanto si la Release ya escribe una para esa conexión como si no, rechazada donde la Release no escribe ninguna entrada para el nodo. Una conexión que trazó una Feature se rechaza en cualquiera de los dos documentos, porque una vinculación solo se escribe sobre una conexión que traza un componente o la Release.

No se permiten propiedades adicionales.

ConnectionAtPositionParams

Responde dentro de la entrada de qué conexión cae una posición en un Aggregate o en una Release: el nodo del grafo y la conexión, en los términos en que los toman las solicitudes de candidatura y de contenedor, o por qué no hay ninguna conexión escrita allí. Las entradas son aquellas en las que se escribe una vinculación — la entrada con la que un componente traza una conexión, bajo el alias de la conexión, en el documento en el que se escribió el componente, y cada entrada por arista que escribe la Release —, cada una donde la registra el grafo compilado, de modo que si una clave es una conexión nunca se deduce de cómo se llama.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
filestringnoEl documento en el que está la posición: la Release, o un documento en el que el grafo de la Release registra componentes como escritos — su Aggregate, o el documento de un módulo que ese Aggregate importa. Se lee primero de lo que la sesión conserva para él y, en caso contrario, del disco.
positionPositionnoUn lugar en un documento: una línea y un desplazamiento de carácter dentro de ella, ambos contados desde cero. El desplazamiento se mide en las unidades de la codificación que la sesión acordó al abrirse, que es UTF-16 a menos que el cliente haya pedido otra.
releasestringnoLa Release cuyo grafo compilado registra las conexiones, como ruta relativa a la raíz del espacio de trabajo. Es obligatoria también para una posición en el Aggregate, porque un nodo del grafo y una conexión solo existen en un grafo compilado.

No se permiten propiedades adicionales.

ConnectionCoordinate

Una conexión que traza el componente de un nodo del grafo, direccionada por el socket a través del cual está conectada y el alias que lleva en ese socket, y el documento en el que se escribe una vinculación sobre ella. Una conexión lleva vinculaciones que llenan los slots que declara su socket, y tanto el Aggregate como la Release pueden escribirlas.

PropiedadTipoObligatoriaDescripción
socketstringsíEl socket de dependencia a través del cual está conectada la conexión.
aliasstringsíEl nombre que lleva la conexión dentro de su socket.
documentconst “aggregate” o const “release”noEl documento en el que se escribe una vinculación sobre la conexión. El conjunto es cerrado, y un valor fuera de él se rechaza. Valores permitidos: "aggregate" — El Aggregate, donde el desarrollador escribe una vinculación sobre la entrada de la conexión. "release" — La Release, donde el operador escribe una vinculación sobre la entrada por arista de la conexión.

Se permiten propiedades adicionales.

SetActiveReleaseParams

Registra una Release como la predeterminada del espacio de trabajo escribiendo un marcador en el directorio .aggrega: la elección que informa aggrega/activeRelease lee ese marcador después de la Release de authoring de la configuración. El marcador se escribe dentro del espacio de trabajo y en ningún otro lugar: donde el directorio .aggrega o el marcador es un enlace que lleva fuera del espacio de trabajo, exista ya o no el lugar al que lleva, la escritura se rechaza nombrando el enlace y no se escribe nada. La respuesta es la que da aggrega/activeRelease una vez escrito el marcador, de modo que nombra una Release distinta donde la Release de authoring de la configuración tiene prioridad sobre el marcador.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
releasestringnoLa Release que se va a registrar, como ruta relativa a la raíz del espacio de trabajo. Una ruta absoluta, y una que sale hacia arriba del espacio de trabajo, se rechazan; también una que sale de él a través de un enlace, a menos que la configuración del espacio de trabajo nombre esa Release.

No se permiten propiedades adicionales.

EditDocumentParams

Aplica una única edición acotada a un documento que contiene el espacio de trabajo: una entrada añadida bajo un contenedor, o un escalar establecido. El documento compuesto se comprueba contra el esquema de su tipo y solo llega al disco si la comprobación se supera, así que esto no puede escribir lo que el esquema de authoring rechaza. Una edición rechazada deja el archivo idéntico byte a byte a como estaba.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
filestringnoEl documento que se va a editar.
editconst “add-component” o const “attach-feature” o const “wire-edge” o const “set-value”noQué edición aplicar. Valores permitidos: "add-component" — Añade una instancia de componente bajo un contenedor components: name es el nombre de la instancia, value el Component que solicita. "attach-feature" — Vincula una Feature al nodo que nombra la solicitud: name es el nombre de instancia de la vinculación, value la Feature que solicita. "wire-edge" — Conecta una conexión de dependencia desde el nodo que nombra la solicitud, dentro de socket: name es el alias por el que se direcciona la conexión, value el nodo al que apunta. "set-value" — Establece un valor en el nodo que nombra la solicitud: name es la clave del valor, value un escalar.
nodestring[]noLa ruta a través del documento hasta la entrada que se edita.
socketstringnoEl socket del que trata la edición, para una edición que conecta uno.
namestringnoEl nombre que escribe la edición.
valueanynoEl valor que escribe la edición, en la forma que adopte la edición.
dryRunbooleanonoSi se responde con el documento compuesto en lugar de escribirlo.

No se permiten propiedades adicionales.

ConfigInitParams

Inicializa un documento de configuración. Escribe de forma predeterminada el archivo de toda la máquina, ya que un registro y las identidades de confianza en él son herramientas de toda la máquina. Contacta con el registro nombrado para leer la política de confianza que anuncia; un registro que no anuncia nada se informa como tal y la inicialización continúa, sobre la base de referencia integrada para el hub oficial y sin ninguna política para cualquier otro registro.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
registrystringnoEl registro para el que inicializar la configuración.
forcebooleanonoSi se sobrescribe un documento de configuración que ya existe.
globalbooleanonoEscribe el archivo de configuración de toda la máquina, que es el valor predeterminado propio de este método.
workspacebooleanonoEscribe el archivo de configuración propio de este espacio de trabajo en lugar del de toda la máquina.
dryRunbooleanonoSi se responde con el contenido del documento en lugar de escribirlo, para un cliente que mantiene su propio modelo de documento.

No se permiten propiedades adicionales.

ConfigCaptureParams

Congela la configuración resuelta en el documento propio de este espacio de trabajo, de modo que el espacio de trabajo sea autónomo. Siempre escribe el archivo de ese espacio de trabajo y no alcanza nada fuera de él.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
allPluginsbooleanonoSi se congela cada plugin vinculado en lugar de solo los que el propio espacio de trabajo configuró.

No se permiten propiedades adicionales.

ImportParams

Convierte una descripción de fuente externa en documentos de authoring en borrador, y escribe junto a ellos .aggrega-import.json, el registro de lo que escribió la importación — el destino que se le dio, donde se le dio uno, la instantánea del catálogo que leyó, donde leyó una, cada archivo redactado y cada clave de un Aggregate o de una Release redactados a cualquier profundidad —, que lee una sincronización posterior. Una fuente que no pudo convertir por completo es una respuesta y no un fallo: los borradores que sí produjo se escriben y los hallazgos dicen lo que no pudo convertir — salvo con sync, que no escribe nada a partir de una conversión que se detuvo.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
sourcestringnoEl archivo o el directorio que se va a convertir, como ruta absoluta o relativa a la raíz del espacio de trabajo; una solicitud sin él se rechaza. Se lee donde está, dentro del espacio de trabajo o no, y un directorio se lee en aquellos de sus archivos que seleccionan los patrones de archivo declarados del importador.
outputDirstringnoEl directorio bajo el espacio de trabajo en el que escribir los borradores, relativo a la raíz del espacio de trabajo; un valor absoluto, o uno que sale del espacio de trabajo tal como está escrito o a través de un enlace, se rechaza. Si falta, se escribe bajo la raíz del espacio de trabajo, donde escribe la misma conversión ejecutada en un terminal sin nombrar ningún destino. Cada ruta redactada es relativa al directorio que la respuesta nombra como outputDir, también con dryRun.
formatstringnoEl formato de la fuente. Si falta, la conversión lo determina.
targetstringnoUna capacidad del proveedor, como compose o helm — la palabra a la que se enlaza el spec.capability de una Recipe —, para la que redactar un Manifest junto a los borradores, como manifest.yaml: cada tipo de componente y tipo de funcionalidad que necesitan los borradores, incluidos los tipos de un Aggregate del catálogo que compone el redactado, se asigna a la Recipe o receta de funcionalidad de esa capacidad que ofrece para él el catálogo del espacio de trabajo — la que hay, o entre varias la que lleva el nombre del tipo —; un tipo sin ninguna, o con varias y ninguna con ese nombre, se deja sin asignar con un hallazgo de advertencia que lo nombra; una asignación que un importador redactó por sí mismo se conserva donde el catálogo la ofrece para ese tipo y esa capacidad, y se descarta con un hallazgo de advertencia en caso contrario; y el spec.manifest de la Release redactada se establece en el Manifest. Una capacidad a la que no se enlaza ninguna Recipe del catálogo se rechaza antes de que se ejecute la conversión, y no se escribe nada. Si falta, no se redacta ningún Manifest, salvo con sync, que redacta para el destino que nombra el registro de la importación anterior; una sincronización que nombra un destino redacta para él, y el registro lo nombra entonces.
dryRunbooleanonoSi se responde con el contenido de cada archivo que escribiría la solicitud en lugar de escribirlo. Todo otro comportamiento es el de la escritura, así que una solicitud que la escritura rechazaría se rechaza también en este caso; con sync, responde con lo que escribiría la sincronización y con cada parte que derivaría.
syncbooleanonoSi se pone al día con la fuente lo que una importación anterior redactó bajo outputDir, en lugar de escribir el borrador completo. Solo cambia lo que escribió la importación, tal como lo enumera el registro junto a los borradores: una parte que la fuente dejó intacta queda como está en el disco, editada o no; una parte que la fuente cambió, eliminó o ganó se escribe de nuevo, se quita — un archivo redactado borrado por completo — o se añade, donde lo que hay en el disco es lo que la importación escribió por última vez; y todo lo demás, una clave que añadió un autor — entre ellas el entorno que una Release redactada deja a su autor — o un comentario no escrito directamente encima de una clave redactada, queda idéntico byte a byte. Una sincronización que cambiaría o quitaría lo que un autor editó o añadió, o añadiría una parte donde un autor ya escribió una, se rechaza nombrando cada parte, y lo mismo ocurre con una sincronización sobre un Aggregate que ningún registro enumera; en ninguno de los dos casos se escribe nada. Sin este campo, una solicitud cuyos borradores se escribirían sobre un Aggregate que ya está en outputDir se rechaza, también con dryRun.
upgradebooleanonoSi se descarga la instantánea del catálogo más reciente que publica el registro predeterminado del espacio de trabajo y se importa con respecto a ella, conservándola desde entonces en lugar de la que contiene el espacio de trabajo o de la que nombra el registro situado junto a los borradores; no cambia nada donde el espacio de trabajo nombra una carpeta de catálogo, y se rechaza sin conexión.
answersstringnoEl archivo de respuestas del que se leen, y en el que se escriben, los valores que los borradores dejan vacíos y que ningún origen puede contener, relativo a la raíz del espacio de trabajo; un valor absoluto, o uno que sale del espacio de trabajo tal como está escrito o a través de un enlace, se rechaza. Contiene, bajo la ruta de cada archivo redactado, la ruta de la clave dentro de ese documento y su respuesta, y las respuestas se escriben en los borradores. Si falta, se lee el que nombra el registro junto a los borradores, o en su defecto import-answers.yaml junto al archivo de origen o dentro del directorio de origen. La respuesta de un secreto nombra de dónde procede el secreto — un nombre de variable, ${NAME}, o el nombre de un Kubernetes Secret — y cualquier otra cosa se rechaza sin escribir nada. No se pregunta nada: cada valor aún pendiente es una entrada de owed de la respuesta y un hallazgo de advertencia que nombra el archivo redactado, la clave y qué es, su respuesta se envía como answered, y donde se escriben los borradores, el último hallazgo indica cuántos quedan pendientes y dónde. Cuando los borradores incluyen una Release, no tienen nada pendiente y la conversión ha terminado, se descargan entonces sus dependencias, escribiendo su lockfile, y un pull que falla cierra los hallazgos indicando por qué, con los borradores escritos; sin conexión no se descarga nada y un hallazgo nombra el pull que hay que ejecutar. Una respuesta para una clave que estos borradores no dejan vacía se conserva en el archivo y no se aplica, de modo que un mismo archivo de respuestas sirve para todos los destinos.
answeredImportAnswered[]noRespuestas para valores que owed de la respuesta enumeró, cada una de las cuales nombra el archivo redactado y las claves tal como owed las nombró. Cada una se evalúa, se conserva en el archivo de respuestas y se escribe en los borradores exactamente como una respuesta escrita en un terminal: la respuesta de un secreto nombra de dónde procede el secreto — un nombre de variable, ${NAME}, o el nombre de un Kubernetes Secret — y una que no lo hace no se conserva ni se escribe, y su valor sigue pendiente con el motivo como su secretAdvice. Un valor que el archivo de respuestas ya responde se responde desde el archivo; una respuesta vacía, o una que nombra un valor que los borradores no tienen pendiente, no se aplica. Envíala con sync una vez escritos los borradores, ya que una solicitud que no es un sync se rechaza sobre un Aggregate que ya está en outputDir. Con dryRun, que no conserva ninguna respuesta, y con un sync cuya conversión se detuvo, que no escribe nada, no se aplica ninguna respuesta enviada.

No se permiten propiedades adicionales.

ScaffoldEntityParams

Redacta un documento inicial para un tipo de entidad, o escribe uno de los ejemplos ejecutables de la documentación en un directorio nuevo del espacio de trabajo, o los enumera. La redacción deriva el esqueleto del conjunto de esquemas que lleva el binario, así que no se lee nada de un espacio de trabajo y no se escribe nada — la respuesta es texto, y adónde va le corresponde al cliente. Escribir un ejemplo escribe el directorio nuevo y nada más, y los ejemplos se leen del bundle de documentación firmado publicado para la versión del binario, o del más reciente publicado antes de ella donde no lo hay, verificado contra la política de firmas del espacio de trabajo antes de conservarlo o leerlo: un bundle que no supera la verificación se rechaza, y sin conexión solo se lee una copia que ya esté en caché. Una solicitud que envía juntos los campos de dos formas — kind con example o list, list con example, name con example o list, dir sin example — se rechaza antes de leer nada.

PropiedadTipoObligatoriaDescripción
workspaceRootstringnoLa ruta absoluta del espacio de trabajo. La redacción no la lee. Escribir o enumerar un ejemplo la requiere: la configuración del espacio de trabajo decide de dónde se obtiene la documentación y qué firmas debe llevar, y un ejemplo se escribe dentro de él.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
kindstringnoEl tipo de entidad que se redacta, nombrado por su token en minúsculas, como component, aggregate, release, recipe o featurerecipe — el token que aggrega/getSchema enumera para él.
namestringnoEl nombre que se escribe en el documento redactado. Se envía solo con kind.
examplestringnoEl ejemplo ejecutable que se escribe, por el nombre que le da la lista de ejemplos. Se envía en lugar de kind.
listbooleanonoSi se responde con cada ejemplo ejecutable que publica la documentación, sin escribir nada. Se envía sin example y sin kind.
dirstringnoEl directorio nuevo en el que escribir el ejemplo, relativo a la raíz del espacio de trabajo; si falta, se escribe allí en un directorio con el nombre del ejemplo. No debe existir todavía o debe estar vacío: uno que contiene algo se rechaza y se deja como está, y un valor absoluto, o uno que sale del espacio de trabajo tal como está escrito o a través de un enlace, se rechaza antes de leer nada. Se envía solo con example.

No se permiten propiedades adicionales.

LintParams

Comprueba las convenciones de publicación del catálogo sobre una sola entidad, sobre todo lo que alcanza el cierre de una Release, o sobre todo lo que hay bajo los directorios de catálogo configurados. No se escribe nada en ningún modo. No nombrar ni una entidad ni una Release comprueba todo el catálogo: en un espacio de trabajo cuya configuración no da a ninguna Release directorios de catálogo propios, una vez sobre los directorios del espacio de trabajo; en un espacio de trabajo que nombra Releases bajo workspace.releases, una vez por cada Release sobre los directorios que lee esa Release, nunca sobre todos juntos.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
entitystringnoEl único documento de entidad que se comprueba.
releasestringnoLa Release cuyo cierre se comprueba, como ruta relativa a la raíz del espacio de trabajo.
prePublishbooleanonoSi se compara cada entidad con su versión publicada anteriormente, lo que llega a los registros configurados.

No se permiten propiedades adicionales.

PluginAddParams

Vincula un plugin a un socket que configura el espacio de trabajo. Llega a un registro para resolver la consulta en un único plugin y fijar una versión. La única decisión que obtendría un terminal — aceptar las capacidades declaradas de un plugin de extensión de comandos — llega aquí como un campo, así que el cliente pregunta a quien lo esté manejando y esta superficie nunca espera una pregunta interactiva.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
typestringnoEl socket al que se vincula el plugin.
querystringnoLo que se resuelve en un único plugin.
capabilitystringnoLa capacidad para la que es la vinculación, donde el socket lleva varias.
rolestringnoEl rol en el que se ejecuta la vinculación, que determina lo que puede emitir.
globalbooleanonoEscribe el archivo de configuración de toda la máquina.
workspacebooleanonoEscribe el archivo de configuración propio de este espacio de trabajo.
acceptCapabilitiesbooleanonoSi el llamador acepta las capacidades que declara un plugin de extensión de comandos.
dryRunbooleanonoSi se responde con el contenido del documento de configuración en lugar de escribirlo.

No se permiten propiedades adicionales.

PluginRemoveParams

Desvincula un plugin de un socket que configura el espacio de trabajo.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
typestringnoEl socket al que está vinculado el plugin.
querystringnoQué vinculación se elimina.
globalbooleanonoEscribe el archivo de configuración de toda la máquina.
workspacebooleanonoEscribe el archivo de configuración propio de este espacio de trabajo.

No se permiten propiedades adicionales.

PluginSyncParams

Alinea los registros gestionados por la máquina de una entidad Plugin con el módulo al que apunta. Reescribe esos registros y conserva sin cambios cada otro byte del documento.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
entitystringnoEl documento de entidad Plugin que se alinea.
pluginstringnoEl módulo de plugin del que leer los registros.

No se permiten propiedades adicionales.

PluginGenCatalogParams

Genera documentos de catálogo Plugin a partir de los metadatos declarados por el propio plugin más un overlay escrito por el autor. Regenerar sobre entradas sin cambios produce documentos idénticos byte a byte.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
fromEmbeddedbooleanonoSi se leen los metadatos de los plugins que el binario ya lleva.
pluginstringnoEl módulo de plugin del que leer los metadatos.
outputDirstringnoEl directorio bajo el espacio de trabajo en el que escribir los documentos.
overlaystringnoEl documento escrito por el autor cuyo contenido se fusiona sobre los metadatos generados.
dryRunbooleanonoSi se responde con el contenido de los documentos en lugar de escribirlos.

No se permiten propiedades adicionales.

ExplainErrorParams

Expande un código que llevaba un hallazgo en lo que el compilador declara sobre esa condición y en las entradas publicadas que enseñan la corrección de authoring. Obtiene la documentación publicada cuando el espacio de trabajo no tiene una copia; si no puede obtenerla, responde igualmente con lo que declara el binario, y dice por qué falta el texto explicativo.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
codestringnoLa condición que se expande, nombrada por el código que llevaba un hallazgo o por su código corto.

No se permiten propiedades adicionales.

GetSchemaParams

Responde con el esquema de un tipo o — cuando no se nombra ningún tipo — con los tipos que se pueden nombrar. Responde para el binario en ejecución en lugar de para cualquier copia instalada en otro lugar, así que no necesita ningún espacio de trabajo y no lee ninguno.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootAcceptednoLa ruta absoluta de un espacio de trabajo. El sujeto de este método no es un espacio de trabajo — responde a partir de lo que lleva el propio binario — así que el campo se acepta y no se lee. Se admite para que un cliente pueda enviarlo de forma uniforme en cada solicitud sin tener que saber qué métodos lo consultan.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
kindstringnoEl tipo cuyo esquema se devuelve en la respuesta. Si falta, responde en su lugar con los tipos que se pueden nombrar.

No se permiten propiedades adicionales.

SkillsInstallParams

Escribe la skill de asistente integrada en el binario en la carpeta de skills de cada asistente que nombra la solicitud o, para una solicitud global que no nombra ninguno, de cada asistente encontrado en esta máquina. Sin global escribe la carpeta de proyecto de cada asistente dentro del espacio de trabajo que nombra la solicitud, y cada ruta que escribiría allí se limita a ese espacio de trabajo; con global escribe la carpeta por usuario de cada asistente bajo el directorio personal. Cada destino se comprueba antes de escribir nada, así que un rechazo deja cada carpeta como estaba.

PropiedadTipoObligatoriaDescripción
workspaceRootWorkspaceRootSubjectsíLa ruta absoluta del espacio de trabajo sobre el que actúa esta solicitud. Es el sujeto de la solicitud: el daemon la resuelve antes de que se ejecute el método, y una solicitud que la omite o la escribe como algo distinto de una cadena se rechaza.
workDoneTokenProgressTokennoUn valor que el llamador genera para poder asociar las notificaciones de progreso con la llamada que las pidió. Se devuelve sin cambios en cada notificación, así que un llamador puede compararlo con el valor que envió. Se acepta en cada solicitud, y una solicitud que envía uno en una sesión que no declaró ninguna capacidad de progreso se rechaza.
agentsstring[]noLos asistentes para los que instalar la skill, por los identificadores que informa el listado. Una solicitud de proyecto que no nombra ninguno se rechaza. Una solicitud global que no nombra ninguno instala la skill para los asistentes encontrados en esta máquina, cada uno cuya carpeta de configuración está en el directorio personal o cuyo comando está en el PATH, y se rechaza sin escribir nada donde no se encuentra ninguno. Un identificador para el que no se conoce ninguna carpeta de skills se rechaza, por nombre, y un identificador dado dos veces se instala una vez.
globalbooleanonoEscribe la carpeta de skills por usuario de cada asistente bajo el directorio personal, que lee en cada proyecto, en lugar de su carpeta de proyecto en el espacio de trabajo.

No se permiten propiedades adicionales.

ServerCapabilities

Lo que hará el daemon en esta sesión, acordado según lo que el cliente dijo que puede manejar.

PropiedadTipoObligatoriaDescripción
positionEncodingstringsíLa codificación en la que se expresa cada posición en esta sesión.
workDoneProgressbooleanonoSi el daemon enviará notificaciones de progreso en esta sesión. Presente solo donde el cliente declaró que puede recibirlas.

No se permiten propiedades adicionales.

ClosureEntity

Una entidad de la que depende una Release, en la versión que determinó la resolución.

PropiedadTipoObligatoriaDescripción
uristringsíLa referencia desde la que se resuelve la entidad.
versionstringsíLa versión que se determinó.
kindstringnoEl tipo de entidad.
sourcestringnoDe dónde tomó la entidad la ejecución que produjo esta entrada, con la misma palabra que imprime para ella aggrega pull --detail: fetched-fresh (obtenida de un registro durante esa ejecución), cache-reuse (una copia que ya estaba en la caché, reutilizada sin obtenerla), local (encontrada en el sistema de archivos local, como un directorio de catálogo), in-binary (la copia dentro del binario del compilador) o external (el Aggregate o el Manifest propio de la Release, leído del archivo o de la entrada que nombra la Release en lugar de resuelto como una de sus dependencias; un Aggregate que la ejecución obtuvo de un registro es fetched-fresh en su lugar). Presente en las entradas del informe de una resolución de dependencias, donde describe lo que esa ejecución hizo en esta máquina, y ausente de un listado de las dependencias resueltas de una Release, que describe de qué depende la Release. El archivo de bloqueo no registra ningún origen. Se omite para una entidad cuyo origen no registró la ejecución.

No se permiten propiedades adicionales.

ToolchainCorePlugin

Un plugin que lleva el propio compilador, y la versión de él que se usó.

PropiedadTipoObligatoriaDescripción
pluginstringsíLa referencia del plugin.
versionstringsíLa versión que se usó.

No se permiten propiedades adicionales.

ToolchainReport

El compilador que resolvió, y los plugins que lleva.

PropiedadTipoObligatoriaDescripción
compilerVersionstringsíLa versión del compilador que resolvió.
corePluginsToolchainCorePlugin[]noLos plugins que lleva el compilador, con la versión de cada uno que se usó.

No se permiten propiedades adicionales.

DependencyResolutionReport

Lo que una resolución de dependencias fijó y obtuvo.

PropiedadTipoObligatoriaDescripción
lockfilestringsíEl archivo de bloqueo que escribió la resolución, o aquel con el que comparó una verificación.
verifiedbooleanonoSi la solicitud fue una verificación, que comparó el archivo de bloqueo registrado y no escribió ningún archivo de bloqueo, registro de confianza de plugins ni entity.lock.
entitiesClosureEntity[] o nullsíLas entidades que fijó la resolución, o que comparó una verificación.
librariesClosureEntity[] o nullsíLas bibliotecas que fijó la resolución, o que comparó una verificación.
pluginsClosureEntity[] o nullsíLos plugins que fijó la resolución, o que comparó una verificación.
sourceArtifactsintegersíCuántos artefactos de origen se obtuvieron.
trustedPluginsintegersíCuántos de los plugins fijados llevaban una firma verificada.
toolchainToolchainReportnoEl compilador que resolvió, y los plugins que lleva.
externalInputsintegersíCuántas entradas externas que consume el renderizado se obtuvieron.
incompleteExternalInputsstringnoQué entradas externas no se pudieron obtener, donde algunas no se pudieron.

No se permiten propiedades adicionales.

BuildNotice

Algo que la compilación quiere que sepa el llamador, que no es ni un hallazgo sobre un documento ni un fallo.

PropiedadTipoObligatoriaDescripción
classstringsíQué tipo de aviso es este.
textstringsíLo que dice el aviso.

No se permiten propiedades adicionales.

CacheScope

Hasta dónde llega una respuesta sobre la caché. Dos de las clases de caché las comparten todos los proyectos de la máquina, así que cada respuesta sobre la caché nombra cuáles tocó — de lo contrario, una sesión abierta sobre un espacio de trabajo se leería como si informara solo sobre ese espacio de trabajo.

PropiedadTipoObligatoriaDescripción
machineWideClassesstring[] o nullsíLas clases de caché que tocó esta respuesta y que se comparten entre todos los proyectos de la máquina.
workspaceRootstringsíEl espacio de trabajo que nombró la solicitud.

No se permiten propiedades adicionales.

CacheElement

Algo que contiene una caché.

PropiedadTipoObligatoriaDescripción
labelstringsíDe qué es la entrada.
sizeintegersíCuántos bytes ocupa.
sizeTextstringsíEl mismo tamaño escrito como lo lee una persona.
digeststringnoEl digest de contenido bajo el que se indexa la entrada, donde tiene uno.
notestringnoCualquier otra cosa que valga la pena decir sobre la entrada.

No se permiten propiedades adicionales.

CacheClass

Una caché sobre la que informa el daemon.

PropiedadTipoObligatoriaDescripción
namestringsíQué caché es esta.
reachstringsíSi la caché pertenece a este espacio de trabajo o se comparte en la máquina.
prunablebooleanosíSi recuperar el espacio de esta caché es algo que hará el daemon.
elementsCacheElement[] o nullsíLo que contiene la caché.

No se permiten propiedades adicionales.

CacheProvenance

Bajo qué identidades se obtuvo un artefacto en caché, y hasta qué punto se comparte.

PropiedadTipoObligatoriaDescripción
identitiesstring[] o nullsíLas identidades a las que se atribuye el artefacto.
sharedByintegernoCuántos titulares comparten el artefacto.

No se permiten propiedades adicionales.

CacheRemoval

Algo que una recuperación de espacio eliminó — o, en una lista de lo que dejó en su sitio, algo que habría eliminado.

PropiedadTipoObligatoriaDescripción
classstringsíA qué caché pertenece.
labelstringsíQué es.
reachstringsíSi esa caché pertenece a este espacio de trabajo o se comparte en la máquina.
sizeintegersíCuántos bytes ocupa, u ocupaba antes de eliminarse.
sizeTextstringsíEl mismo tamaño escrito como lo lee una persona.

No se permiten propiedades adicionales.

CacheShortfall

Lo que una recuperación de espacio dejó atrás, y lo que lo recuperaría, para que un llamador que lee una cifra menor de la que esperaba sepa por qué en lugar de deducirlo.

PropiedadTipoObligatoriaDescripción
classstringsíQué caché contiene lo que se dejó.
countintegersíCuántas entradas se dejaron.
sizeintegersíCuántos bytes ocupan.
sizeTextstringsíEl mismo tamaño escrito como lo lee una persona.
reachstringsíSi esa caché pertenece a este espacio de trabajo o se comparte en la máquina.
reclaimedBystring[] o nullsíQué las recuperaría.

No se permiten propiedades adicionales.

CacheCleared

Una caché que una limpieza vació.

PropiedadTipoObligatoriaDescripción
classstringsíQué caché se vació.
reachstringsíSi pertenece a este espacio de trabajo o se comparte en la máquina.
sizeintegersíCuántos bytes se recuperaron de ella.
sizeTextstringsíEl mismo tamaño escrito como lo lee una persona.
heldOpenFilesintegersíCuántos archivos dejó la limpieza en esta caché porque otro proceso los tenía abiertos. Solo Windows se niega a eliminar un archivo abierto, así que en cualquier otro lugar esto es cero. Una limpieza posterior los elimina una vez que ese proceso ha terminado con ellos.
heldOpenBytesintegersíCuántos bytes ocupan esos archivos. No se cuentan en size, que es lo que recuperó la limpieza.
heldOpenBytesTextstringsíLa misma cifra escrita como la lee una persona.

No se permiten propiedades adicionales.

ConfigWriteScope

Qué documento de configuración se escribió y hasta dónde alcanza. Una solicitud nombra un espacio de trabajo, así que una respuesta que no dijera nada se leería como referida a ese espacio de trabajo — y para una escritura de toda la máquina esa lectura es errónea.

PropiedadTipoObligatoriaDescripción
configFilestringsíEl documento que se escribió.
machineWidebooleanosíSi ese documento es aquel a través del cual resuelve cada espacio de trabajo de la máquina.
workspaceRootstringsíEl espacio de trabajo que nombró la solicitud.

No se permiten propiedades adicionales.

PluginWriteScope

En qué documento de configuración se escribió un cambio de plugin y hasta dónde alcanza. El valor predeterminado propio del socket de extensión de comandos es el documento de toda la máquina, así que cada respuesta dice cuál escribió.

PropiedadTipoObligatoriaDescripción
configFilestringsíEl documento que se escribió.
machineWidebooleanosíSi ese documento es aquel a través del cual resuelve cada espacio de trabajo de la máquina.
workspaceRootstringsíEl espacio de trabajo que nombró la solicitud.

No se permiten propiedades adicionales.

CredentialStoreScope

Hasta dónde alcanza un cambio de credencial. El almacén lo comparten todos los proyectos de la máquina y cualquier otra herramienta que se dirija a los mismos registros, así que la respuesta lo informa en lugar de dejar que se deduzca una lectura limitada a la sesión.

PropiedadTipoObligatoriaDescripción
machineWidebooleanosíSi el almacén que tocó el cambio se comparte en la máquina.
workspaceRootstringsíEl espacio de trabajo que nombró la solicitud.

No se permiten propiedades adicionales.

SkillFolderScope

Hasta dónde alcanza una instalación de skill. Una solicitud nombra un espacio de trabajo, así que una respuesta que no dijera nada se leería como referida a ese espacio de trabajo — y para las carpetas por usuario, que un asistente lee en cada proyecto, esa lectura es errónea.

PropiedadTipoObligatoriaDescripción
machineWidebooleanosíSi las carpetas escritas son las carpetas por usuario bajo el directorio personal, que el asistente lee en cada proyecto de la máquina.
workspaceRootstringsíEl espacio de trabajo que nombró la solicitud.

No se permiten propiedades adicionales.

PublicationReach

Hasta dónde llegó una publicación. Estas respuestas llegan por completo más allá de esta máquina — lo que adjuntan es lo que resuelve cada consumidor de ese registro —, así que cada una nombra cada registro al que se dirigió y si la llamada adjuntó algo allí.

PropiedadTipoObligatoriaDescripción
registriesstring[]síCada host de registro al que se dirigió la llamada, cada uno nombrado una sola vez, en el orden en que la llamada se dirigió a él por primera vez. Una llamada de una sola referencia nombra uno; una ejecución de prueba nombra el destino al que se habría dirigido.
beyondThisMachinebooleanosíSi la llamada adjuntó algo que un registro sirve ahora a otros: contenido subido, una firma, una fecha de publicación o un marcador de obsolescencia. Es false en una ejecución de prueba, y en una llamada que encontró ya presente todo lo que habría adjuntado — una publicación ejecutada de nuevo sobre una versión completa, o un lote de firma cuyas referencias llevaban ya todas una firma que se verifica.

No se permiten propiedades adicionales.

WorkspaceEntityRef

Una entidad, por tipo y nombre, con el documento que la declara.

PropiedadTipoObligatoriaDescripción
kindstringsíEl tipo de entidad.
namestringsíEl nombre de la entidad.
filestringsíEl documento que la declara, como ruta relativa a la raíz del espacio de trabajo.

No se permiten propiedades adicionales.

SourcedEntityRef

Una entidad, con el lugar del que se leyó. Un documento del espacio de trabajo informa de su ruta relativa al espacio de trabajo; una entidad resuelta desde los directorios de catálogo configurados informa de una ruta vacía, porque la única ruta que tiene no significaría nada para un cliente. El origen dice cuál de los dos casos es, en lugar de dejar que una ruta vacía se lea como un campo que nadie rellenó.

PropiedadTipoObligatoriaDescripción
kindstringsíEl tipo de entidad.
namestringsíEl nombre de la entidad.
filestringsíEl documento que la declara, como ruta relativa a la raíz del espacio de trabajo, o vacío donde procede de los directorios de catálogo configurados.
originstringsíDe dónde se leyó la entidad.

No se permiten propiedades adicionales.

SocketCandidacy

Un socket de una entidad, y lo que puede conectarse a él.

PropiedadTipoObligatoriaDescripción
socketstringsíEl nombre del socket.
declarationstringsíDónde se declara el socket.
selectorstringsíEl selector de etiquetas que debe cumplir un destino.
requiredbooleanosíSi el socket debe estar conectado para que la compilación continúe.
targetsWorkspaceEntityRef[] o nullsíLas entidades que pueden conectarse a él.

No se permiten propiedades adicionales.

SlotCandidacy

Un slot que declara el socket de una conexión, tal como el Component consumidor lo declara en el socket, y las Features que pueden llenarlo en esa conexión.

PropiedadTipoObligatoriaDescripción
slotstringsíEl nombre del slot, que es la clave bajo la que se escribe una vinculación que lo llena en las features de la conexión.
selectorstringsíEl selector de etiquetas que una Feature que llena el slot debe cumplir con sus propias etiquetas. Vacío donde el slot no declara ninguno, lo que admite cualquier Feature.
requiredbooleanosíSi cada conexión conectada a través del socket debe llenar el slot para que la compilación continúe.
injectstring[]síLos mecanismos de entrega que el slot permite para lo que lo llena, en el orden en que el Component los declara. Vacío donde no declara ninguno.
sensitivebooleanosíSi el slot declara que lo que lo llena maneja material secreto. Marca la vinculación que lo llena y no rechaza nada.
descriptionstringsíPara qué sirve el slot según el Component. Vacío donde no dice nada.
candidatesSourcedEntityRef[]síCada Feature que puede llenar el slot en esta conexión: una cuya aplicabilidad declarada cumplen las etiquetas del nodo del grafo, requisito al que se somete cada vinculación que lleva el nodo, y cuyas propias etiquetas cumplen el selector del slot. Una Feature cuya aplicabilidad o cuyas etiquetas no pueden leerse frente al selector no se ofrece, porque una compilación la rechaza en lugar de admitirla.

No se permiten propiedades adicionales.

CatalogEntity

Una entidad que contiene el índice del espacio de trabajo.

PropiedadTipoObligatoriaDescripción
kindstringsíEl tipo de entidad.
namestringsíEl nombre de la entidad.
apiVersionstringsíLa versión de esquema que declara el documento.
descriptionstringsíPara qué sirve la entidad según el documento.
labelsmapa de string o nullsíLas etiquetas que declara el documento.
filestringsíEl documento que la declara, como ruta relativa a la raíz del espacio de trabajo.
originstringsíDe dónde se leyó la entidad.

No se permiten propiedades adicionales.

CompletionItem

Algo que se puede escribir en la posición del cursor.

PropiedadTipoObligatoriaDescripción
labelstringsíEl texto que se escribe.
kindintegernoQué clase de elemento es, para que un cliente pueda elegirle un icono.
detailstringnoUn calificador breve que se muestra junto a la etiqueta.
documentationstringnoQué es el elemento, en detalle.
sortTextstringnoEl valor por el que ordenar, donde difiere de la etiqueta.

No se permiten propiedades adicionales.

MarkupContent

Texto que mostrar, y cómo está marcado.

PropiedadTipoObligatoriaDescripción
kindstringsíCómo está marcado el texto.
valuestringsíEl texto.

No se permiten propiedades adicionales.

EntityKindDescriptor

Un tipo del que un autor escribe un documento, que empareja el token que nombra una solicitud con el tipo que declara el propio documento, y dice qué operaciones aceptan un documento de ese tipo.

PropiedadTipoObligatoriaDescripción
kindstringsíEl token en minúsculas que nombra una solicitud, como component o featurerecipe.
documentKindstringsíEl tipo que declara el propio encabezado del documento.
acceptedByEntityKindAcceptancesíQué operaciones aceptan un documento de este tipo nombrado por sí solo — por su ruta, o por su nombre para inspección — sin nada más enviado junto a él. Un campo es true cuando esa operación no rechaza un documento por ser de este tipo; un documento que acepta puede aun así rechazarse por lo que dice el documento.

No se permiten propiedades adicionales.

EntityKindAcceptance

Para un tipo que escribe un autor, si cada operación acepta un documento de ese tipo nombrado por sí solo. Cada campo está presente en cada entrada, así que false es una afirmación y no una omisión.

PropiedadTipoObligatoriaDescripción
singleEntityValidationbooleanosíSi el ámbito de entidad única de aggrega validate — el comando al que se da la ruta de un solo documento — comprueba un documento de este tipo. Un tipo que rechaza se comprueba en su lugar con el ámbito de catálogo completo o con el ámbito de la Release.
publicationbooleanosíSi aggrega/publishEntity, nombrando solo el documento, publica un documento de este tipo. Un tipo cuya publicación asocia además un ejecutable nombrado junto al documento — un Plugin — es false, porque una solicitud que nombra solo el documento se rechaza para él; un Manifest y una Release son false porque ninguno de los dos tipos se publica.
inspectionByNamebooleanosíSi aggrega/entityDefinition resuelve un nombre en una entidad de este tipo, con el nombre enviado tal como se escribe donde una entidad hace referencia a otra.

No se permiten propiedades adicionales.

RegistryTrust

La política de confianza que la resolución aplica a lo que sirve un registro.

PropiedadTipoObligatoriaDescripción
signaturesRequiredbooleanosíSi un artefacto de este registro debe llevar una firma verificada.
verificationSkippedbooleanonoSi se está omitiendo la verificación.
advisorybooleanonoSi una verificación fallida se informa en lugar de detener la ejecución.
anchorstringnoEl ancla de confianza con la que se verifican las firmas.
keylessIdentitiesintegernoCuántas identidades de firma son de confianza para este registro.

No se permiten propiedades adicionales.

Registry

Un registro configurado. Ningún campo aquí lleva material de credenciales, su longitud, su forma ni ninguna representación de él — la presencia es todo lo que se informa, que es lo que hace que el valor sea seguro para pegarlo en una incidencia.

PropiedadTipoObligatoriaDescripción
hoststringsíEl host del registro, que es su identidad.
namestringnoEl alias descriptivo que se resuelve en el host, donde hay uno configurado.
defaultbooleanosíSi este es el registro al que se dirige una operación que no nombra ningún registro.
authStatestringsíSi en el almacén de toda la máquina hay una credencial para este host. Se informa incluso cuando está vacío, para que un llamador pueda distinguir «no hay ninguna credencial» de «el listado no lo comprobó».
trustRegistryTrustsíLa política de confianza que la resolución aplica a lo que sirve un registro.

No se permiten propiedades adicionales.

TrustFetchOutcome

Qué produjo la lectura de la política de confianza anunciada de un registro. Los resultados se mantienen separados porque significan cosas distintas: se adoptó la política anunciada, el registro no anunció nada — lo cual no es un fallo —, se fijó en su lugar la base de referencia integrada, o no se intentó ninguna lectura. Donde no se anunció nada, se indica junto a ello si se pudo llegar al registro en absoluto.

PropiedadTipoObligatoriaDescripción
pinnedbooleanosíSi se adoptó la política anunciada.
notAdvertisedbooleanonoSi se preguntó al registro y no anunció ninguna política, en cuyo caso la operación continúa con lo que indicó la solicitud. Un registro al que el modo sin conexión impidió preguntar nunca se informa así. Un registro al que no se pudo llegar también se informa así, ya que de él no volvió ninguna política, y lleva unreachable junto a ello; lee unreachable para distinguir los dos casos.
unreachablebooleanonoSi no se pudo llegar al registro cuando se pidió su política anunciada: su nombre no se resolvió, una conexión con él se rechazó o no se pudo abrir, o no se pudo establecer una conexión segura con él. Se lee del propio fallo en lugar de reason, figura junto a notAdvertised, y solo se establece donde el fallo muestra que nunca se llegó al registro; un registro que respondió — sin política, o con un fallo — lo deja ausente.
baselinebooleanonoSi se fijó la base de referencia integrada, que solo lleva el hub oficial, porque no se adoptó ninguna política anunciada. Figura junto a notAdvertised donde se preguntó al hub y no anunció nada, y solo donde el modo sin conexión impidió preguntar al hub.
skippedbooleanonoSi no se intentó ninguna lectura, porque una política indicada la sustituyó o la solicitud no pidió ninguna.
identitiesintegernoCuántas identidades de firma llevaba la política anunciada.
reasonstringnoPor qué no se adoptó la política anunciada: lo que hizo el endpoint del registro, o el rechazo sin conexión que impidió preguntarle.

No se permiten propiedades adicionales.

SkippedRepo

Un repositorio que el recorrido del índice omitió, y por qué.

PropiedadTipoObligatoriaDescripción
repostringsíEl repositorio que se omitió.
reasonstringsíPor qué se omitió.

No se permiten propiedades adicionales.

DeprecationNote

Un marcador de obsolescencia que encontró el recorrido del índice, y lo que hizo con él. Un marcador que se respetó y uno que estaba presente y se descartó se informan en pie de igualdad, de modo que registrar muchos no pasa en silencio mientras que descartar uno se hace notar.

PropiedadTipoObligatoriaDescripción
repostringsíEl repositorio en el que está el marcador.
versionstringsíLa versión que cubre el marcador.
recordedbooleanosíSi la propia firma del marcador se verificó, y el índice por tanto lo lleva.
severityconst “warning” o const “error” o const “retracted”noCon qué fuerza se pronuncia el marcador. Valores permitidos: "warning" — Obsoleta, en el más leve de los dos niveles de aviso: sigue seleccionándose cuando se elige una versión. "error" — Obsoleta, en el más fuerte de los dos niveles de aviso: sigue seleccionándose cuando se elige una versión. "retracted" — Retirada: se excluye cuando se elige una versión.
reasonstringnoPor qué la versión es obsoleta.

No se permiten propiedades adicionales.

HostUpdate

Qué hizo una actualización del índice para un registro.

PropiedadTipoObligatoriaDescripción
hoststringsíEl host de registro que se actualizó.
indexedintegersíCuántos registros se escribieron.
deprecationsExaminedbooleanosíSi el recorrido buscó siquiera marcadores de obsolescencia. Está separado del recuento porque «este registro no publicó ninguno» y «esta ejecución no tenía base para juzgar uno» son hechos distintos.
deprecationsRecordedintegersíCuántos marcadores se respetaron.
skippedSkippedRepo[] o nullsíLos repositorios que omitió el recorrido.
deprecationsDeprecationNote[] o nullsíLos marcadores que encontró el recorrido.
readsRetriedintegersíCuántas de las lecturas del recorrido rechazó o cortó por el camino el registro y se volvieron a pedir, contando cada lectura una sola vez independientemente de cuántos intentos necesitó y de si después tuvo éxito o no; cero donde no hubo ninguna. Un recorrido cuyas lecturas tuvieron todas éxito al final no lista ningún repositorio bajo skipped, así que este recuento es lo que dice lo cerca que estuvo de dejar uno fuera. Mínimo: 0.
errorstringnoQué falló para este host, de modo que un recorrido sobre varios informa de cuáles fallaron sin que el llamador tenga que correlacionar nada.
unreachablebooleanonoSi no se pudo llegar a este registro: su nombre no se resolvió, una conexión con él se rechazó o no se pudo abrir, o no se pudo establecer una conexión segura con él. Se lee del propio fallo en lugar de error, solo se establece junto a error, y solo donde el fallo muestra que nunca se llegó al registro; un registro que respondió, respondiera lo que respondiera, lo deja ausente.

No se permiten propiedades adicionales.

PublishedVersion

Una versión que el índice contiene para una referencia: el digest del manifiesto en el que se resolvía su tag cuando se construyó el índice; donde la política de confianza con la que se construyó el índice verificó la propia firma de la versión, el firmante que estableció esa verificación; y, donde algo lo registra, cuándo se publicó la versión, con la fuente que lo indica. El firmante está ausente para una versión sin firma, para una de la que no se verificó ninguna firma, y donde esa política no fija ni una clave pública ni una identidad de confianza o desactiva la verificación de firmas. Ninguno de esos casos es una base para nombrar un firmante, y su ausencia no dice nada más. La fecha de publicación está ausente donde la publicación no indicó ninguna y ninguna firma keyless verificada por esa política registra una.

PropiedadTipoObligatoriaDescripción
versionstringsíLa versión, tal como la nombra su tag.
manifestDigeststringsíEl digest del manifiesto en el que se resolvía el tag de la versión cuando se construyó el índice, que direcciona la versión por los bytes que nombra en lugar de por su tag.
signerVerifiedSignaturenoUna firma que se verificó contra la política de confianza de un registro: cómo se verificó, el firmante que estableció la verificación y el digest del bundle de firma que se verificó.
publishedAtstringnoCuándo se publicó la versión, como marca de tiempo RFC 3339 en UTC al segundo. De dónde procede es publishedAtSource, y ambos están presentes juntos o no lo están en absoluto.
publishedAtSourceconst “transparency-log” o const “publisher”noDe dónde procede publishedAt, para que un momento que atestigua un registro de transparencia nunca se confunda con uno que indica quien publica. El conjunto es cerrado. Valores permitidos: "transparency-log" — El momento en que un registro de transparencia registró la firma keyless de la versión, que la política de confianza con la que se construyó el índice verificó junto con la promesa firmada del registro sobre ese momento. Para una versión firmada al publicarse, es la publicación; para una firmada después, es cuándo se hizo esa firma. "publisher" — El momento que la publicación indicó junto a lo que publicó, según el propio reloj de la máquina que publica. Nada lo atestigua. Una publicación indica uno donde su firma no lleva ningún momento atestiguado: una firma con clave, o ninguna firma. Donde hay varios adjuntos, se toma el más antiguo.

No se permiten propiedades adicionales.

VerifiedSignature

Una firma que se verificó contra la política de confianza de un registro: cómo se verificó, el firmante que estableció la verificación y el digest del bundle de firma que se verificó.

PropiedadTipoObligatoriaDescripción
bundleDigeststringsíEl digest del bundle de firma que se verificó, como sha256: seguido de 64 caracteres hexadecimales en minúsculas.
identitystringnoEl firmante que estableció la verificación de la firma: para una firma keyless, la identidad para la que se emitió el certificado de firma, que es su subject alternative name; para una firma con clave, keyed:sha256: seguido del SHA-256 en hexadecimal en minúsculas del texto PEM de la clave pública fijada.
issuerstringnoEl emisor OIDC registrado en el certificado de firma, para una firma keyless. Está ausente para una firma con clave.
modeconst “keyless” o const “keyed”síCómo se verificó la firma. El conjunto es cerrado. Valores permitidos: "keyless" — Contra un certificado de firma cuya identidad y cuyo emisor coinciden con unos en los que la política confía, que se encadena hasta la raíz de confianza que fija la política o, donde no fija ninguna, hasta la raíz public-good de Sigstore, y cuya firma registra un registro de transparencia. "keyed" — Contra la clave pública que fija la política.

No se permiten propiedades adicionales.

RegistrySearchRecord

Un registro con el que coincidió una búsqueda, tal como lo contiene el índice local, más cuáles de sus versiones ha marcado como obsoletas un marcador publicado.

PropiedadTipoObligatoriaDescripción
uristringsíLa referencia desde la que se resuelve el registro.
namestringsíEl nombre de la entidad.
versionstringsíLa versión bajo la que está indexado el registro.
versionsstring[]noCada versión que el índice contiene para esta referencia.
kindstringnoEl tipo de entidad.
descriptionstringnoPara qué sirve la entidad.
categorystringnoLa categoría bajo la que está publicada la entidad.
labelsmapa de stringnoLas etiquetas que declara la entidad.
pluginTypestringnoEl socket al que se vincula un registro de plugin.
capabilitiesstring[]noLas capacidades que declara un registro de plugin.
manifestDigeststringnoEl digest del manifiesto publicado.
listingDigeststringnoEl digest del listado del que se leyó el registro.
deprecationsobject[]noLos marcadores de obsolescencia que el índice lleva para esta referencia, cada uno con la versión que cubre y el propio marcador verificado.
publishedPublishedVersion[]noCada versión que el índice contiene para esta referencia, en el mismo orden que versions, cada una con el digest del manifiesto en el que se resolvía su tag cuando se construyó el índice, con su firmante verificado donde la política de confianza con la que se construyó el índice verificó la propia firma de esa versión, y con su fecha de publicación y la fuente de esa fecha donde algo las registra. Una versión registrada sin firmante no lleva ninguna firma verificada por esa política, y no se dice nada más sobre ella. Para registrar esto solo se leen del registro manifiestos, adjuntos de firma y adjuntos de fecha de publicación; no se obtiene el contenido de ninguna entidad.
retractedstring[]noLas versiones que un marcador publicado ha marcado como obsoletas.

No se permiten propiedades adicionales.

RegistrySearchIndex

La actualidad de un host en el que se buscó.

PropiedadTipoObligatoriaDescripción
hoststringsíEl host en cuyo índice se buscó.
lastUpdatedstringnoCuándo se actualizó el índice por última vez. Está ausente en lugar de ser cero cuando la instantánea no lleva ninguna hora, para que un llamador pueda distinguir «no registrado» del epoch.

No se permiten propiedades adicionales.

EffectiveConfigurationSetting

Un ajuste resuelto, y el documento del que procede.

PropiedadTipoObligatoriaDescripción
fieldstringsíEl ajuste.
valuestringsíEl valor que se resolvió.
sourcestringsíDe dónde procede el valor.

No se permiten propiedades adicionales.

ImportedFile

Un archivo que escribe una importación: un documento en borrador, o el registro de lo que escribió la importación.

PropiedadTipoObligatoriaDescripción
pathstringsíDónde va el archivo, como ruta relativa al outputDir de la respuesta.
contentstringsíEl texto del archivo.

No se permiten propiedades adicionales.

ImportDrift

Una parte que una sincronización puso al día con la fuente, o que pondría al día con dryRun.

PropiedadTipoObligatoriaDescripción
changestringsíCómo derivó la parte: added, para una parte que ganó la fuente; removed, para una que eliminó; o changed, para una que cambió.
filestringsíEl archivo redactado en el que está la parte, como ruta relativa al outputDir de la respuesta.
keystring[]síLas claves que llevan a la parte desde la raíz de un Aggregate o de una Release redactados, una entrada por clave, para que una clave que contiene un punto siga siendo una sola entrada. Vacío donde la parte es el archivo completo.

No se permiten propiedades adicionales.

ImportOwed

Un valor que los borradores aún dejan vacío, que ningún origen pudo proporcionar y que ninguna respuesta proporcionó.

PropiedadTipoObligatoriaDescripción
filestringsíEl archivo redactado en el que está el valor, como ruta relativa al outputDir de la respuesta.
keystring[]síLas claves que llevan al valor desde la parte superior de ese documento, una entrada por clave, de modo que una clave que contiene un punto sigue siendo una sola entrada. Una respuesta enviada como answered nombra el valor mediante estas claves.
questionstringsíQué es el valor: la descripción de su esquema, o en su defecto el comentario que el borrador escribe encima de su clave, o en su defecto lo que su esquema dice que admite.
sensitivebooleanosíSi el valor es el de un secreto, cuya respuesta nombra de dónde procede el secreto y nunca contiene el secreto en sí.
secretAdvicestringnoPresente en el valor de un secreto: lo que debe ser su respuesta, en la frase que se muestra a una persona que lo responde en un terminal — o, donde la respuesta enviada para él como answered fue rechazada, por qué fue rechazada.

No se permiten propiedades adicionales.

ImportAnswered

Una respuesta para un valor que owed de la respuesta enumeró.

PropiedadTipoObligatoriaDescripción
filestringsíEl archivo redactado en el que está el valor, tal como lo nombra owed.
keystring[]síLas claves que llevan al valor, tal como las nombra owed.
answerstringsíLa respuesta. Una respuesta vacía deja el valor pendiente.

No se permiten propiedades adicionales.

ImportDiagnostic

Algo que una conversión no pudo convertir. Estos son la salida más útil de la conversión, así que se informan por completo en lugar de reducirse a un veredicto.

PropiedadTipoObligatoriaDescripción
severitystringsíQué gravedad tiene.
messagestringsíLo que no se pudo convertir.
codestringnoEl nombre citable de la condición, donde tiene uno.

No se permiten propiedades adicionales.

ImportDecision

Cómo asignó una conversión un nodo de la fuente: los Components del catálogo que sopesó el importador, el que eligió, por qué, y cómo cambiar la elección.

PropiedadTipoObligatoriaDescripción
sourceNodeDecisionSourceNodesíEl nodo de la fuente al que se refiere una decisión de asignación.
candidatesImportCandidate[]noLos Components del catálogo que sopesó el importador para el nodo, cada uno con su puntuación. Ausente donde no sopesó ninguno.
chosenDecisionChoicenoLo que eligió el importador para un nodo de la fuente. Ausente de una decisión en la que no hizo ninguna elección.
rationalestringnoPor qué hizo el importador la elección, en sus propias palabras. Ausente donde no escribió ninguna.
swapHintstringnoCómo cambiar la elección por una alternativa, en las propias palabras del importador. Ausente donde no escribió ninguna.

No se permiten propiedades adicionales.

DecisionSourceNode

El nodo de la fuente al que se refiere una decisión de asignación.

PropiedadTipoObligatoriaDescripción
idstringsíEl identificador del nodo en la fuente.
typestringsíEl tipo del nodo, tal como lo nombra la fuente.
paramsSummarystringsíUn resumen de los parámetros del nodo, para mostrar junto a la decisión.

No se permiten propiedades adicionales.

ImportCandidate

Un Component del catálogo que sopesó el importador para un nodo de la fuente.

PropiedadTipoObligatoriaDescripción
componentNamestringsíEl nombre del Component.
scorenumbersíQué tan bien coincide el Component con el nodo, según la puntuación del importador.
tierstringsíEl nivel de coincidencia en el que cae la puntuación.
signalsCandidateSignalssíLo que aportó cada una de las señales del importador a la puntuación de un candidato.

No se permiten propiedades adicionales.

CandidateSignals

Lo que aportó cada una de las señales del importador a la puntuación de un candidato.

PropiedadTipoObligatoriaDescripción
tablenumbersíLa aportación de la señal de la tabla de asignación.
categorynumbersíLa aportación de la señal de categoría.
domainLabelsnumbersíLa aportación de la señal de las etiquetas de dominio.
shapenumbersíLa aportación de la señal de forma.
namenumbersíLa aportación de la señal de nombre.

No se permiten propiedades adicionales.

DecisionChoice

Lo que eligió el importador para un nodo de la fuente. Ausente de una decisión en la que no hizo ninguna elección.

PropiedadTipoObligatoriaDescripción
targetstringsíEl nombre del Component elegido: un Component existente del catálogo, o el que se redactó para el nodo.
modestringsíCómo se escribe la elección: como referencia a un Component existente, o como uno redactado de nuevo.
tierstringsíEl nivel de coincidencia de la elección.

No se permiten propiedades adicionales.

LintFileFindings

Lo que encontró una comprobación de convenciones en un documento.

PropiedadTipoObligatoriaDescripción
filestringsíEl documento.
diagnosticsDiagnostic[] o nullsíLos hallazgos que contiene.

No se permiten propiedades adicionales.

PluginRetractionExclusion

Una versión que estaba disponible y no se eligió.

PropiedadTipoObligatoriaDescripción
versionstringsíLa versión que se omitió.
reasonstringnoPor qué se omitió.

No se permiten propiedades adicionales.

PluginRetractionProvenance

De dónde procede el conocimiento de lo que está obsoleto.

PropiedadTipoObligatoriaDescripción
sourcestringsíLo que se consultó.
lastUpdatedstringnoCuándo se actualizó eso por última vez.

No se permiten propiedades adicionales.

PluginRetraction

Cómo determinó un marcador de obsolescencia qué versión del plugin se fijó.

PropiedadTipoObligatoriaDescripción
referencestringsíLa referencia a la que pertenecen las versiones.
selectedstringnoLa versión que se fijó.
excludedPluginRetractionExclusion[]noLas versiones que estaban disponibles y se omitieron.
unscreenedstringnoLo que no se pudo cotejar con un marcador, y por qué.
provenancePluginRetractionProvenancenoDe dónde procede el conocimiento de lo que está obsoleto.

No se permiten propiedades adicionales.

PluginGeneratedDocument

Un documento de catálogo que produjo una generación.

PropiedadTipoObligatoriaDescripción
pathstringsíDónde va el documento, como ruta relativa a la raíz del espacio de trabajo.
contentstringsíEl texto del documento.

No se permiten propiedades adicionales.

PluginCommandFlag

Un flag que un plugin declara en un comando que aporta.

PropiedadTipoObligatoriaDescripción
namestringsíEl nombre largo del flag.
shorthandstringnoEl alias de un solo carácter del flag, donde tiene uno.
descriptionstringnoEl texto de ayuda de una línea del flag.
typestringnoEl tipo de valor del flag.
defaultstringnoEl valor que se usa cuando no se pasa el flag.

No se permiten propiedades adicionales.

PluginCLICommand

Un verbo de comando de nivel superior que aporta un plugin.

PropiedadTipoObligatoriaDescripción
namestringsíEl verbo del comando.
descriptionstringnoEl texto de ayuda de una línea del comando.
flagsPluginCommandFlag[]noLos flags del comando, en el orden declarado.

No se permiten propiedades adicionales.

ConfigCapturedAttachment

Una vinculación que una congelación escribió en la configuración propia de este espacio de trabajo.

PropiedadTipoObligatoriaDescripción
uristringnoLa referencia desde la que se resuelve la vinculación.
capabilitystringnoLa capacidad para la que es la vinculación.
functionstringnoLa exportación a la que se despacha la vinculación.
rolestringnoEl rol en el que se ejecuta la vinculación, que determina lo que puede emitir.

No se permiten propiedades adicionales.

ConfigCapturedSocket

Un socket que escribió una congelación, con las vinculaciones que congeló en él.

PropiedadTipoObligatoriaDescripción
socketstringsíEl socket.
fieldstringsíEl campo de configuración bajo el que se escribe el socket.
attachmentsConfigCapturedAttachment[] o nullsíLas vinculaciones que se congelaron en él.

No se permiten propiedades adicionales.

ExplainErrorEntry

Un pasaje publicado que enseña la corrección de authoring para una condición.

PropiedadTipoObligatoriaDescripción
headingstringsíEl encabezado del pasaje.
bodystringsíEl pasaje.

No se permiten propiedades adicionales.

SignedArtifact

Un artefacto publicado que cubrió una firma.

PropiedadTipoObligatoriaDescripción
referencestringsíLa referencia que se firmó.
digeststringsíEl digest de lo que se firmó.

No se permiten propiedades adicionales.

DeprecationMarked

Una versión publicada que marcó una declaración de obsolescencia.

PropiedadTipoObligatoriaDescripción
referencestringsíLa referencia que se marcó.
severityconst “warning” o const “error” o const “retracted”síCon qué fuerza se pronuncia el marcador. Valores permitidos: "warning" — Obsoleta, en el más leve de los dos niveles de aviso: sigue seleccionándose cuando se elige una versión. "error" — Obsoleta, en el más fuerte de los dos niveles de aviso: sigue seleccionándose cuando se elige una versión. "retracted" — Retirada: se excluye cuando se elige una versión.
issuedOnstringsíCuándo se emitió el marcador.
digeststringsíEl digest del marcador que se publicó.

No se permiten propiedades adicionales.

InitializeResult

Lo que la sesión acordó para este cliente, y desde qué capa de configuración resolvió.

PropiedadTipoObligatoriaDescripción
capabilitiesServerCapabilitiessíLo que hará el daemon en esta sesión, acordado según lo que el cliente dijo que puede manejar.
workspaceRootstringsíEl espacio de trabajo sobre el que se abrió la sesión.
configSourcestringsíDesde qué capa de configuración resolvió la sesión sus ajustes.
workspaceMarkerstringnoEl archivo que identificó la raíz del espacio de trabajo, donde lo hubo.
versionstringsíLa versión del binario que responde a esta sesión: el mismo valor que aggrega version informa para ese binario. Describe el proceso en ejecución, así que una vez que se ha reemplazado el archivo desde el que se inició el daemon, esto sigue nombrando la versión que está en ejecución, mientras que preguntar al archivo nombra la versión que lo reemplazó.

No se permiten propiedades adicionales.

ValidateResult

Lo que encontró la comprobación, y cuánto se comprobó.

PropiedadTipoObligatoriaDescripción
diagnosticsDiagnostic[] o nullsíLos hallazgos. Es null en lugar de una lista vacía cuando la comprobación no encontró nada.
checkedstringnoCuánto se comprobó — un documento, o lo que contiene el espacio de trabajo.

No se permiten propiedades adicionales.

InvalidateResult

Si el daemon conservaba algo sobre el documento que descartar.

PropiedadTipoObligatoriaDescripción
invalidatedbooleanosíSi se descartó algo.

No se permiten propiedades adicionales.

DiagnosticsResult

Los hallazgos que el daemon ya conserva para el documento.

PropiedadTipoObligatoriaDescripción
diagnosticsDiagnostic[] o nullsíLos hallazgos. Es null en lugar de una lista vacía cuando no hay ninguno.

No se permiten propiedades adicionales.

IrGraphResult

El grafo resuelto en el que se compila una Release.

PropiedadTipoObligatoriaDescripción
graphanysíEl documento del grafo. Los valores que un autor declaró sensibles se retienen de él a menos que la solicitud los haya pedido con unredacted; todo lo demás se transmite tal como lo emitió el compilador. Su propia forma es el contrato publicado del grafo y no se repite aquí.

No se permiten propiedades adicionales.

BuildResult

Lo que escribió una compilación.

PropiedadTipoObligatoriaDescripción
outputDirectorystringsíEl directorio en el que se escribieron los artefactos.
filesstring[] o nullsíLos artefactos que se escribieron, como rutas relativas al directorio de salida.
noticesBuildNotice[]noCualquier cosa que la compilación quiera que sepa el llamador y que no sea ni un hallazgo ni un fallo.
dependencyResolutionDependencyResolutionReportnoLo que una resolución de dependencias fijó y obtuvo.

No se permiten propiedades adicionales.

BuildPreviewResult

Lo que habría escrito una compilación. No se escribió nada, así que no hay ningún directorio de salida que nombrar.

PropiedadTipoObligatoriaDescripción
filesstring[] o nullsíLos artefactos que habría producido la escritura.
noticesBuildNotice[]noCualquier cosa que el proceso de compilación quiera que sepa el llamador y que no sea ni un hallazgo ni un fallo.

No se permiten propiedades adicionales.

EntityDefinitionResult

En qué se resuelve un nombre de entidad, y el documento que la define. Una respuesta leída de una referencia de registro lleva published, y una respuesta que el catálogo resolvió por nombre nunca lo lleva.

PropiedadTipoObligatoriaDescripción
kindstringsíEl tipo de entidad.
namestringsíEl nombre de la entidad.
versionstringsíLa versión que se resolvió.
descriptionstringnoPara qué sirve la entidad según el documento.
publishScopestringnoQué tan ampliamente está publicada la entidad.
filestringsíEl documento que la define.
authoredLengthintegersíCuántos bytes contiene el documento escrito por el autor, para que un cliente pueda distinguir un documento escrito por el autor de una representación resuelta de uno.
definitionstringsíEl texto de la definición.
publishedPublishedArtifactnoLo que leyó una referencia de registro: la coordenada, cómo contenía la entidad, y el manifiesto a través del cual se leyó. Cada campo está presente dondequiera que lo esté este.

No se permiten propiedades adicionales.

PublishedArtifact

Lo que leyó una referencia de registro: la coordenada, cómo contenía la entidad, y el manifiesto a través del cual se leyó. Cada campo está presente dondequiera que lo esté este.

PropiedadTipoObligatoriaDescripción
referencestringsíLa referencia de registro que se leyó.
archivebooleanosíSi los bytes de la coordenada eran un archivo comprimido del que se extrajo el documento de la entidad. False donde la coordenada contenía el propio documento de la entidad.
mediaTypestringsíEl tipo de artefacto que declara el manifiesto.
manifestDigeststringsíEl digest del manifiesto a través del cual se leyó la entidad — el valor que se nombra después de @ para volver a leer exactamente los mismos bytes.

No se permiten propiedades adicionales.

ReleaseClosureResult

Todo aquello de lo que depende una Release, tal como lo alcanzó la resolución. Informa del cierre en lugar del grafo derivado de él: un documento distinto sobre la misma Release.

PropiedadTipoObligatoriaDescripción
releasestringsíLa Release que se inspeccionó.
aggregatestringsíEl Aggregate que despliega.
manifeststringsíEl Manifest a través del cual se resuelve.
environmentstringsíEl entorno que nombra.
entitiesClosureEntity[] o nullsíLas entidades que alcanza el cierre.
librariesClosureEntity[] o nullsíLas bibliotecas que alcanza el cierre.
pluginsClosureEntity[] o nullsíLos plugins que alcanza el cierre.
mappingDiagnosticsstring[] o nullsíLo que tuvo que decir la resolución de las asignaciones del Manifest.
deprecationsstring[] o nullsíLos marcadores de obsolescencia que encontró el cierre.

No se permiten propiedades adicionales.

ResolveDependenciesResult

Lo que una resolución de dependencias fijó y obtuvo, más cualquier cosa que quiera que sepa el llamador. Los propios campos del informe se llevan directamente en esta respuesta en lugar de anidarse bajo uno de sus campos.

PropiedadTipoObligatoriaDescripción
lockfilestringsíEl archivo de bloqueo que escribió la resolución, o aquel con el que comparó una verificación.
verifiedbooleanonoSi la solicitud fue una verificación, que comparó el archivo de bloqueo registrado y no escribió ningún archivo de bloqueo, registro de confianza de plugins ni entity.lock.
entitiesClosureEntity[] o nullsíLas entidades que fijó la resolución, o que comparó una verificación.
librariesClosureEntity[] o nullsíLas bibliotecas que fijó la resolución, o que comparó una verificación.
pluginsClosureEntity[] o nullsíLos plugins que fijó la resolución, o que comparó una verificación.
sourceArtifactsintegersíCuántos artefactos de origen se obtuvieron.
trustedPluginsintegersíCuántos de los plugins fijados llevaban una firma verificada.
toolchainToolchainReportnoEl compilador que resolvió, y los plugins que lleva.
externalInputsintegersíCuántas entradas externas que consume el renderizado se obtuvieron.
incompleteExternalInputsstringnoQué entradas externas no se pudieron obtener, donde algunas no se pudieron.
noticesstring[]noCualquier cosa que la resolución quiera que sepa el llamador.

No se permiten propiedades adicionales.

PinResult

Lo que hizo el paso de fijación al bloqueo que está junto a una entidad, o lo que haría en una ejecución de prueba. Es la respuesta a aggrega/pin, y una publicación que ejecutó el paso la lleva como su pin.

PropiedadTipoObligatoriaDescripción
entitystringsíEl documento de entidad que leyó el paso, como ruta relativa a la raíz del espacio de trabajo.
kindstringsíEl tipo de la entidad, tal como lo declara su documento.
namestringsíEl nombre de la entidad, tal como lo declara su documento.
pinnablebooleanosíSi una entidad de este tipo lee algo para lo que un bloqueo registra una fijación, como hacen una Recipe y una FeatureRecipe. Donde es false, no se tocó nada junto a la entidad, changed es false, y lock, removed, pins y content están ausentes.
lockstringnoEl bloqueo que escribió el paso, o que escribiría, como ruta relativa a la raíz del espacio de trabajo.
changedbooleanosíSi el bloqueo cambió, o cambiaría en una ejecución de prueba. False donde el bloqueo ya registraba cada fijación que necesita la entidad y se dejó idéntico byte a byte.
removedbooleanonoSi el cambio es una eliminación: la entidad no lee nada para lo que un bloqueo registre una fijación, así que no queda ningún bloqueo junto a ella.
dryRunbooleanonoSi esto informa de lo que haría el paso en lugar de lo que hizo.
pinsPinClassCount[]noCuántas fijaciones de cada clase contiene el bloqueo después del paso, o contendría después de una ejecución de prueba. Se enumera cada clase que puede contener el bloqueo, incluida una clase sin ninguna fijación.
contentstringnoEl bloqueo que escribiría una ejecución de prueba. Ausente donde el bloqueo se dejaría como está o se eliminaría, y en toda respuesta que no sea una ejecución de prueba.

No se permiten propiedades adicionales.

PinClassCount

Cuántas fijaciones de una clase contiene un bloqueo.

PropiedadTipoObligatoriaDescripción
classstringsíLa clase de fijación, con las palabras que usa un rechazo que nombra una que falta — remote source o imported file, por ejemplo.
pinsintegersíCuántas fijaciones de esa clase contiene el bloqueo.

No se permiten propiedades adicionales.

CacheStatusResult

Lo que contienen las cachés que sirven a este espacio de trabajo.

PropiedadTipoObligatoriaDescripción
classesCacheClass[] o nullsíCada caché y lo que contiene.
provenanceCacheProvenance[] o nullsíBajo qué identidades se obtuvieron los artefactos en caché.
totalCountintegersíCuántas entradas contienen las cachés en total.
totalSizeintegersíCuántos bytes ocupan en total.
totalSizeTextstringsíEl mismo total escrito como lo lee una persona.
scopeCacheScopesíHasta dónde llega una respuesta sobre la caché. Dos de las clases de caché las comparten todos los proyectos de la máquina, así que cada respuesta sobre la caché nombra cuáles tocó — de lo contrario, una sesión abierta sobre un espacio de trabajo se leería como si informara solo sobre ese espacio de trabajo.

No se permiten propiedades adicionales.

CachePruneResult

Lo que eliminó una recuperación de espacio, lo que conservó y lo que no pudo recuperar.

PropiedadTipoObligatoriaDescripción
removedCacheRemoval[] o nullsíLo que se eliminó.
heldOpenCacheRemoval[] o nullsíLo que la poda habría eliminado pero dejó en su sitio porque otro proceso lo tenía abierto. Solo Windows se niega a eliminar un archivo abierto, así que en cualquier otro lugar esto está vacío. Estas entradas no se cuentan ni como eliminadas ni como conservadas, ninguno de sus bytes cuenta como recuperado, y una poda posterior las recupera; una entrada que es un directorio puede haber perdido ya los archivos que contenía que no estaban abiertos.
retainedCountintegersíCuántas entradas se conservaron.
reclaimedBytesintegersíCuántos bytes se recuperaron.
reclaimedBytesTextstringsíLa misma cifra escrita como la lee una persona.
unattributedCountintegersíCuántas entradas no reclama ningún titular.
unattributedSizeintegersíCuántos bytes ocupan esas entradas.
unattributedSizeTextstringsíLa misma cifra escrita como la lee una persona.
notPruneEligibleCacheShortfall[] o nullsíLo que se dejó atrás, y lo que lo recuperaría.
scopeCacheScopesíHasta dónde llega una respuesta sobre la caché. Dos de las clases de caché las comparten todos los proyectos de la máquina, así que cada respuesta sobre la caché nombra cuáles tocó — de lo contrario, una sesión abierta sobre un espacio de trabajo se leería como si informara solo sobre ese espacio de trabajo.

No se permiten propiedades adicionales.

CacheEvictResult

Lo que eliminó la recuperación de espacio hasta un tamaño, y lo que queda.

PropiedadTipoObligatoriaDescripción
withinCapBeforebooleanosíSi lo que se conservaba ya cabía bajo el tamaño, de modo que no hacía falta eliminar nada.
removedCacheRemoval[] o nullsíLo que se eliminó.
heldOpenCacheRemoval[] o nullsíLo que la recuperación de espacio habría eliminado pero dejó en su sitio porque otro proceso lo tenía abierto; en su lugar pasó a la siguiente entrada más antigua. Solo Windows se niega a eliminar un archivo abierto, así que en cualquier otro lugar esto está vacío. Estas entradas siguen contando para los bytes que quedan, y una recuperación de espacio posterior puede eliminarlas.
totalBeforeintegersíCuántos bytes se conservaban antes.
totalBeforeTextstringsíLa misma cifra escrita como la lee una persona.
reclaimedBytesintegersíCuántos bytes se recuperaron.
reclaimedBytesTextstringsíLa misma cifra escrita como la lee una persona.
remainingBytesintegersíCuántos bytes quedan.
remainingBytesTextstringsíLa misma cifra escrita como la lee una persona.
capBytesintegersíEl tamaño hasta el que se recuperó espacio, en bytes.
capBytesTextstringsíEl mismo tamaño escrito como lo lee una persona.
scopeCacheScopesíHasta dónde llega una respuesta sobre la caché. Dos de las clases de caché las comparten todos los proyectos de la máquina, así que cada respuesta sobre la caché nombra cuáles tocó — de lo contrario, una sesión abierta sobre un espacio de trabajo se leería como si informara solo sobre ese espacio de trabajo.

No se permiten propiedades adicionales.

CacheClearResult

Lo que recuperó el vaciado de las cachés.

PropiedadTipoObligatoriaDescripción
clearedCacheCleared[] o nullsíCada caché que se vació.
reclaimedBytesintegersíCuántos bytes se recuperaron.
reclaimedBytesTextstringsíLa misma cifra escrita como la lee una persona.
scopeCacheScopesíHasta dónde llega una respuesta sobre la caché. Dos de las clases de caché las comparten todos los proyectos de la máquina, así que cada respuesta sobre la caché nombra cuáles tocó — de lo contrario, una sesión abierta sobre un espacio de trabajo se leería como si informara solo sobre ese espacio de trabajo.

No se permiten propiedades adicionales.

RegistryListResult

Los registros a través de los que resuelve este espacio de trabajo.

PropiedadTipoObligatoriaDescripción
registriesRegistry[] o nullsíCada registro configurado.
credentialStateIsMachineWidebooleanosíSi la presencia de credenciales informada para cada registro es un hecho de toda la máquina en lugar de uno del espacio de trabajo. Se informa para que una respuesta limitada a la sesión no se lea como si negara el alcance más amplio.

No se permiten propiedades adicionales.

SearchResult

Lo que ofrecieron para la búsqueda los índices locales de los registros.

PropiedadTipoObligatoriaDescripción
recordsRegistrySearchRecord[] o nullsíLos registros que coincidieron.
indexesRegistrySearchIndex[] o nullsíCada host en el que se buscó y cuándo se actualizó su índice por última vez.
missingIndexHostsstring[] o nullsíLos hosts configurados sin ningún índice local en el que buscar, para que una respuesta corta se explique en lugar de dejarse a la deducción.
stalebooleanosíSi algún índice en el que se buscó es lo bastante antiguo como para que valga la pena actualizarlo.
registriesConfiguredbooleanosíSi hay algún registro configurado, lo que distingue «nada coincidió» de «no se buscó en nada».

No se permiten propiedades adicionales.

RegistryAddResult

Lo que escribió dar de alta un registro, dónde, y lo que leyó del propio registro.

PropiedadTipoObligatoriaDescripción
hoststringsíEl host bajo el que está indexada la entrada, que no siempre es la grafía que usó la solicitud.
scopeConfigWriteScopesíQué documento de configuración se escribió y hasta dónde alcanza. Una solicitud nombra un espacio de trabajo, así que una respuesta que no dijera nada se leería como referida a ese espacio de trabajo — y para una escritura de toda la máquina esa lectura es errónea.
trustTrustFetchOutcomesíQué produjo la lectura de la política de confianza anunciada de un registro. Los resultados se mantienen separados porque significan cosas distintas: se adoptó la política anunciada, el registro no anunció nada — lo cual no es un fallo —, se fijó en su lugar la base de referencia integrada, o no se intentó ninguna lectura. Donde no se anunció nada, se indica junto a ello si se pudo llegar al registro en absoluto.

No se permiten propiedades adicionales.

RegistryRemoveResult

Lo que escribió quitar un registro, y dónde.

PropiedadTipoObligatoriaDescripción
hoststringsíEl host cuya entrada se eliminó.
scopeConfigWriteScopesíQué documento de configuración se escribió y hasta dónde alcanza. Una solicitud nombra un espacio de trabajo, así que una respuesta que no dijera nada se leería como referida a ese espacio de trabajo — y para una escritura de toda la máquina esa lectura es errónea.

No se permiten propiedades adicionales.

RegistryUpdateResult

Lo que hizo la actualización de los índices locales, por host.

PropiedadTipoObligatoriaDescripción
hostsHostUpdate[] o nullsíLo que hizo la actualización para cada host.
failedstring[] o nullsíLos hosts para los que la actualización no pudo completarse.
indexRootstringsíEl directorio bajo el que se escribieron los índices.
registriesConfiguredbooleanosíSi hay algún registro configurado.
reachedRegistriesbooleanosíSiempre true en esta respuesta: actualizar los índices llega hasta los propios registros, mientras que listarlos y buscar responden desde la configuración y desde un índice local. Si se llegó realmente a un registro dado se indica en su propia entrada en hosts, mediante unreachable.

No se permiten propiedades adicionales.

LogoutResult

Qué credencial almacenada se eliminó, y hasta dónde alcanza el almacén.

PropiedadTipoObligatoriaDescripción
registrystringsíEl registro cuya credencial se eliminó.
scopeCredentialStoreScopesíHasta dónde alcanza un cambio de credencial. El almacén lo comparten todos los proyectos de la máquina y cualquier otra herramienta que se dirija a los mismos registros, así que la respuesta lo informa en lugar de dejar que se deduzca una lectura limitada a la sesión.

No se permiten propiedades adicionales.

PublishEntityResult

Lo que depositó la publicación de una entidad, y dónde. Una publicación que ejecutó primero el paso de fijación lleva también lo que hizo ese paso, como pin, que está ausente donde el paso no se ejecutó.

PropiedadTipoObligatoriaDescripción
referencestringsíLa referencia con la que se publicó la entidad.
tagstringsíEl tag con el que se publicó.
kindstringsíEl tipo de entidad que se publicó.
mediaTypestringsíEl tipo de medio registrado para los bytes publicados.
sizeintegersíCuántos bytes se publicaron.
sizeTextstringsíEl mismo tamaño escrito como lo lee una persona.
pluginSizeintegernoCuántos bytes ocupa el módulo de plugin publicado junto con una entidad Plugin.
pluginSizeTextstringnoEl mismo tamaño escrito como lo lee una persona.
digeststringsíEl digest de lo que se publicó. En una ejecución de prueba, el digest que depositaría una publicación del mismo contenido, calculado solo a partir del contenido: el que imprime aggrega push --dry-run.
signedbooleanosíSi esta publicación adjuntó una firma: la que creó antes de publicar o, en una versión ya publicada, una que le faltaba a la versión.
alreadyPublishedbooleanosíSi los mismos bytes ya estaban allí, de modo que no se subió ningún contenido. Solo se adjuntó junto a ellos lo que aún le faltaba a esa publicación: su fecha de publicación y, donde esta publicación firma, su firma; signed dice si se adjuntó una firma.
dryRunbooleanosíSi esto informa de lo que la publicación habría depositado en lugar de lo que depositó.
reachPublicationReachsíHasta dónde llegó una publicación. Estas respuestas llegan por completo más allá de esta máquina — lo que adjuntan es lo que resuelve cada consumidor de ese registro —, así que cada una nombra cada registro al que se dirigió y si la llamada adjuntó algo allí.
pinPinResultnoLo que hizo el paso de fijación al bloqueo que está junto a una entidad, o lo que haría en una ejecución de prueba. Es la respuesta a aggrega/pin, y una publicación que ejecutó el paso la lleva como su pin.
wholeDirectorySourcestringnoLa fuente local de la entidad tal como se escribió, presente cuando está escrita como plantilla. Una fuente así solo nombra su directorio una vez que una Release rellena la plantilla, de modo que la publicación lleva cada archivo del directorio de la entidad en lugar de solo los archivos que nombra la entidad. Ausente donde solo lleva esos archivos.
windowsUnusableEntriesstring[]noLas entradas del archivo comprimido publicado cuya ruta contiene una parte que Windows no puede contener tal como está escrita — un nombre que Windows reserva para un dispositivo, como CON, AUX o NUL, en cualquier combinación de mayúsculas y minúsculas y con cualquier extensión que siga, o una parte que termina en punto o en espacio —, primero el propio nombre de archivo del documento de la entidad y luego los archivos que lleva. Un espacio de trabajo en Windows se niega a desempaquetarlas, así que no puede usar la versión; la publicación sigue adelante o se detiene exactamente como lo haría sin ellas. Ausente donde no hay ninguna, lo que incluye una entidad publicada solo como su documento.

No se permiten propiedades adicionales.

PublishArtifactResult

Lo que depositó la publicación de un archivo, y dónde.

PropiedadTipoObligatoriaDescripción
referencestringsíLa referencia con la que se publicó el archivo.
tagstringsíEl tag con el que se publicó.
mediaTypestringsíEl tipo de medio registrado para los bytes publicados.
sizeintegersíCuántos bytes se publicaron.
sizeTextstringsíEl mismo tamaño escrito como lo lee una persona.
digeststringsíEl digest de lo que se publicó.
alreadyPublishedbooleanosíSi los mismos bytes ya estaban allí, de modo que no se subió ningún contenido. Se adjuntó una fecha de publicación junto a ellos solo donde al artefacto le faltaba una.
dryRunbooleanosíSi esto informa de lo que la publicación habría depositado en lugar de lo que depositó.
reachPublicationReachsíHasta dónde llegó una publicación. Estas respuestas llegan por completo más allá de esta máquina — lo que adjuntan es lo que resuelve cada consumidor de ese registro —, así que cada una nombra cada registro al que se dirigió y si la llamada adjuntó algo allí.

No se permiten propiedades adicionales.

SignArtifactsResult

Qué se firmó, y dónde se depositaron las firmas.

PropiedadTipoObligatoriaDescripción
signedSignedArtifact[] o nullsíCada referencia que se firmó.
reachPublicationReachsíHasta dónde llegó una publicación. Estas respuestas llegan por completo más allá de esta máquina — lo que adjuntan es lo que resuelve cada consumidor de ese registro —, así que cada una nombra cada registro al que se dirigió y si la llamada adjuntó algo allí.

No se permiten propiedades adicionales.

DeprecateArtifactResult

Qué se marcó como obsoleto, y dónde se depositaron los marcadores.

PropiedadTipoObligatoriaDescripción
markedDeprecationMarked[] o nullsíCada versión que se marcó.
reachPublicationReachsíHasta dónde llegó una publicación. Estas respuestas llegan por completo más allá de esta máquina — lo que adjuntan es lo que resuelve cada consumidor de ese registro —, así que cada una nombra cada registro al que se dirigió y si la llamada adjuntó algo allí.

No se permiten propiedades adicionales.

ResolveResult

Dónde está definido el elemento bajo el cursor.

PropiedadTipoObligatoriaDescripción
locationnull o LocationsíDónde está definido. Es null donde nada bajo el cursor se resuelve en una definición.

No se permiten propiedades adicionales.

FindReferencesResult

Dónde se hace referencia al elemento bajo el cursor.

PropiedadTipoObligatoriaDescripción
locationsLocation[] o nullsíCada lugar en el que se hace referencia a él.

No se permiten propiedades adicionales.

FindImplementationsResult

Qué documentos implementan el elemento bajo el cursor.

PropiedadTipoObligatoriaDescripción
locationsLocation[] o nullsíCada lugar en el que está implementado.

No se permiten propiedades adicionales.

HoverResult

Qué mostrar sobre el elemento bajo el cursor.

PropiedadTipoObligatoriaDescripción
contentsnull o MarkupContentsíQué mostrar. Es null donde no hay nada que decir sobre lo que está bajo el cursor.

No se permiten propiedades adicionales.

CompletionResult

Lo que se puede escribir en la posición del cursor.

PropiedadTipoObligatoriaDescripción
itemsCompletionItem[] o nullsíCada elemento que se puede escribir.

No se permiten propiedades adicionales.

CatalogIndexResult

Cada entidad que contiene el índice del espacio de trabajo, y los enlaces que llevan fuera del espacio de trabajo, a directorios y a archivos, que no se leyeron para él.

PropiedadTipoObligatoriaDescripción
entitiesCatalogEntity[] o nullsíCada entidad.
unreadLinkedDirsstring[]síCada enlace bajo la raíz del espacio de trabajo que lleva a un directorio fuera de ella, nombrado de forma relativa a la raíz en el lugar donde está el propio enlace, en el orden en que se busca en el espacio de trabajo. No se busca en ningún directorio fuera de la raíz, así que ningún documento detrás de uno de estos enlaces figura entre entities como propio del espacio de trabajo, y un cliente que lista entidades puede decir por qué. No se nombran: un enlace a un directorio dentro de la raíz, en el que se busca, o que se deja fuera, donde realmente está; un enlace allí donde un directorio se dejaría fuera, ya sea por dónde está, por su nombre o por un .gitignore; un enlace que no se puede resolver, porque no lleva a ninguna parte o da vueltas en un bucle; y, en una respuesta dada en los términos de una Release, un enlace bajo un directorio de catálogo que solo leen otras Releases. Vacío cuando el espacio de trabajo no contiene ninguno.
unreadLinkedFilesstring[]síCada enlace bajo la raíz del espacio de trabajo que tiene nombre de archivo YAML, con su propio nombre terminado en .yaml o .yml, y lleva a un archivo fuera de la raíz, nombrado de forma relativa a la raíz en el lugar donde está el propio enlace, en el orden en que se busca en el espacio de trabajo. Un archivo así no se lee para el índice, declare lo que declare, así que la entidad que declara no figura entre entities como propia del espacio de trabajo, y un cliente que lista entidades puede decir por qué; los directorios de catálogo configurados son la forma en que se leen las entidades de fuera del espacio de trabajo. No se nombran: un enlace a un archivo que la configuración del espacio de trabajo nombra como Release, como build.authoring_release o como clave de workspace.releases, y que declara una, que se lee y se lista en entities en el lugar propio del enlace; un enlace a un archivo dentro de la raíz, que se lee en el lugar propio del enlace; un enlace que un .gitignore deja fuera, o uno dentro de un directorio que la búsqueda deja fuera; un enlace que no lleva a ningún archivo, ya sea a un directorio, que unreadLinkedDirs nombra donde lleva fuera de la raíz, a ninguna parte o en un bucle; y, en una respuesta dada en los términos de una Release, un enlace bajo un directorio de catálogo que solo leen otras Releases. Un archivo de configuración del espacio de trabajo que es un enlace que lleva fuera del espacio de trabajo, su propio .aggrega-config.yaml o el overlay propiedad de la CI junto a él, se nombra tanto si la búsqueda lo encontró como si no, después de los enlaces que nombró la búsqueda: la configuración del espacio de trabajo no se lee entonces en absoluto, esta respuesta es el índice propio del espacio de trabajo leído sin nada configurado, así que no se lee ningún directorio de catálogo para él, y cada solicitud que decide la configuración, incluido un índice en los términos de una Release, se rechaza para ese espacio de trabajo con la condición del bloqueo de lectura.

No se permiten propiedades adicionales.

AttachCandidatesResult

Qué Features pueden vincularse a la entidad, y las etiquetas según las cuales se juzgaron; y, para una conexión que nombró la solicitud, los slots que declara su socket con las Features que pueden llenar cada uno.

PropiedadTipoObligatoriaDescripción
nodestringsíLa entidad para la que se juzgaron los candidatos.
nodeLabelsmapa de string o nullsíLas etiquetas según las cuales se hizo el juicio.
labelSourcestringsíQué conjunto de etiquetas se usó, lo cual no es cosmético: las etiquetas declaradas de un documento son lo que puede ver una lectura de la fuente, mientras que las de un nodo del grafo son el conjunto finalizado según el cual juzga la propia compilación. Una respuesta calculada sobre el segundo es una afirmación sobre lo que hará la compilación.
candidatesSourcedEntityRef[] o nullsíCada Feature que puede vincularse.
slotsSlotCandidacy[]noPresente solo cuando la solicitud nombró una conexión: cada slot que declara el socket de la conexión, en el orden en que el Component los declara, con las Features que pueden llenarlo. Vacío cuando no se puede llenar ningún slot en la conexión, y noSlotReason dice entonces por qué — lo que un cliente lee en lugar de tomar una lista vacía por slots con los que ninguna Feature coincidió.
noSlotReasonconst “feature-created-connection” o const “ad-hoc-socket” o const “no-slot-declared”noPresente solo cuando la solicitud nombró una conexión y no se puede llenar ningún slot en ella: por qué nada puede vincularse allí. Ausente dondequiera que el socket declare un slot. El conjunto es cerrado. Valores permitidos: "feature-created-connection" — Una Feature trazó la conexión, y una vinculación solo se escribe sobre una conexión que traza un componente o la Release. "ad-hoc-socket" — El socket es uno que el Component no declara, así que no declara ningún slot que pueda llenar una conexión. "no-slot-declared" — El Component declara el socket y no declara ningún slot en él.

No se permiten propiedades adicionales.

ConnectionCandidatesResult

A qué entidades puede conectarse cada socket de la entidad.

PropiedadTipoObligatoriaDescripción
nodestringsíLa entidad de la que son estos sockets.
adHocSocketsAcceptedbooleanosíSi un socket que la propia definición de la entidad no declara de antemano puede escribirse de todos modos.
socketsSocketCandidacy[] o nullsíCada socket y lo que puede conectarse a él.

No se permiten propiedades adicionales.

InsertionPointResult

Dónde, en el documento, corresponde una nueva entrada bajo el contenedor nombrado, y lo que necesita un cliente para escribirla allí: el propio punto, si un salto de línea tiene que abrir el texto, las claves de contenedor que aún faltan y la sangría que lleva cada línea.

PropiedadTipoObligatoriaDescripción
filestringsíEl documento.
containerstring[] o nullsíLa ruta a través del documento hasta el contenedor.
positionEncodingstringsíLa codificación en la que se expresan las posiciones de esta respuesta.
positionPositionsíUn lugar en un documento: una línea y un desplazamiento de carácter dentro de ella, ambos contados desde cero. El desplazamiento se mide en las unidades de la codificación que la sesión acordó al abrirse, que es UTF-16 a menos que el cliente haya pedido otra.
precededByLineBreakbooleanosíSi el texto escrito en la posición tiene que empezar con un salto de línea, porque la posición está al final de una línea que el documento ya contiene. Es false solo donde el documento no contiene nada a lo que pueda seguir la entrada.
missingContainerKeysstring[] o nullsíLos segmentos de la ruta del contenedor que el documento aún no contiene, el más externo primero. Cada uno tiene que escribirse como una clave propia, con un nivel más de sangría que el anterior, antes de que la entrada pueda ir dentro del más interno. Es null donde toda la ruta ya está presente.
entryIndentintegersíLa columna en la que empieza la primera línea propia de la entrada, contada en espacios desde el inicio de la línea.
indentStepintegersíCuánto más se sangra cada nivel de anidamiento.
indentStepMeasuredbooleanosíSi el paso se midió a partir del anidamiento propio de este documento. Donde es false, el documento no muestra ningún anidamiento que medir y el paso es un valor de respaldo, así que un cliente que prefiera imponer el suyo sabe que es libre de hacerlo.
entryShapeconst “mapping” o const “sequence” o const “unknown”síLa forma en que el contenedor lleva sus entradas, que es lo que decide cómo se compone el texto propio de la entrada. Se lee del contenedor que el documento ya contiene y nunca se deduce de cómo se llama el contenedor. El conjunto es cerrado. Valores permitidos: "mapping" — El contenedor es un mapeo de bloque, así que una entrada añadida a él es una clave y su valor. "sequence" — El contenedor es una secuencia de bloque, así que una entrada añadida a él es un guion y su valor. "unknown" — El documento no contiene el contenedor, o lo contiene sin nada dentro, así que qué forma adopta una entrada lo decide el cliente.

No se permiten propiedades adicionales.

AttachmentContainerResult

En qué documento, y en qué lugar de él, corresponde una vinculación sobre el nodo del grafo, o sobre la conexión que nombró la solicitud.

PropiedadTipoObligatoriaDescripción
nodestringsíEl nodo del grafo al que está destinada la vinculación.
filestringsíEl documento en el que corresponde la vinculación.
containerstring[] o nullsíLa ruta a través de ese documento hasta donde corresponde.

No se permiten propiedades adicionales.

ConnectionAtPositionResult

La conexión dentro de cuya entrada cae la posición, o por qué no se informa ninguna. Está presente exactamente una mitad: graphNode y connection juntos, o noConnectionReason solo. Una posición en cualquier lugar dentro de una entrada — en su alias, su destino o sus vinculaciones — está dentro de esa entrada, la más interna donde las entradas se anidan; una posición en la propia clave de un socket, por encima de las entradas escritas bajo ella, no está dentro de ninguna.

PropiedadTipoObligatoriaDescripción
graphNodestringnoEl id del nodo cuyo componente traza la conexión, tal como lo indexa el grafo compilado — el valor que las solicitudes de candidatura y de contenedor toman como graphNode.
connectionConnectionCoordinatenoLa conexión, por su socket y su alias, con document nombrando el documento en el que se leyó la posición — el valor que las solicitudes de candidatura y de contenedor toman como connection.
noConnectionReasonconst “no-connection-entry” o const “feature-created-connection” o const “unknown-connection”noPresente solo donde no se informa ninguna conexión: el porqué. El conjunto es cerrado. Valores permitidos: "no-connection-entry" — La posición no está en ninguna entrada en la que se escriba una vinculación: ni una conexión que traza un componente, escrita bajo su alias, ni una entrada por arista en la Release. Una conexión escrita como lista de destinos, y una que traza el propio bloque de una Feature, no llevan ninguna entrada así. "feature-created-connection" — La posición está en la entrada de la Release para una conexión que trazó una Feature, y una vinculación solo se escribe sobre una conexión que traza un componente o la Release. "unknown-connection" — La posición está en una entrada que la Release escribe para una conexión que el grafo compilado no contiene.

No se permiten propiedades adicionales.

ReleaseCandidatesResult

Las Releases que contiene el espacio de trabajo, y los enlaces que llevan fuera de él, a directorios y a archivos, que no se leyeron para ellas.

PropiedadTipoObligatoriaDescripción
releasesstring[] o nullsíCada documento de Release.
lockfilesmapa de stringsíEl archivo de bloqueo de cada Release listada, indexado por la Release exactamente como está listada. Cada uno es el archivo que un pull escribe para esa Release y que lee una compilación, así que un cliente lee dónde está en lugar de deducirlo. Vacío cuando el espacio de trabajo no contiene ninguna Release.
unreadLinkedDirsstring[]síCada enlace bajo la raíz del espacio de trabajo que lleva a un directorio fuera de ella, nombrado de forma relativa a la raíz en el lugar donde está el propio enlace, en el orden en que se busca en el espacio de trabajo. No se busca en ningún directorio fuera de la raíz, así que una Release a la que solo se llega a través de uno de estos enlaces no está en releases, y un cliente que ofrece Releases puede decir por qué. No se nombran: un enlace a un directorio dentro de la raíz, en el que se busca, o que se deja fuera, donde realmente está; un enlace allí donde un directorio se dejaría fuera, ya sea por dónde está o por su nombre; y un enlace que no se puede resolver, porque no lleva a ninguna parte o da vueltas en un bucle. Vacío cuando el espacio de trabajo no contiene ninguno.
unreadLinkedFilesstring[]síCada enlace bajo la raíz del espacio de trabajo que tiene nombre de archivo YAML, con su propio nombre terminado en .yaml o .yml, y lleva a un archivo fuera de la raíz, nombrado de forma relativa a la raíz en el lugar donde está el propio enlace, en el orden en que se busca en el espacio de trabajo. Un archivo así no se lee, así que una Release a la que solo se llega a través de uno de estos enlaces no está en releases, y un cliente que ofrece Releases puede decir por qué. Si un archivo es una Release no se sabe sin leerlo, así que cada enlace así se nombra sea cual sea el contenido del archivo. No se nombran: un enlace a un archivo que la configuración del espacio de trabajo nombra como Release, como build.authoring_release o como clave de workspace.releases, que se lee y se lista en releases en el lugar propio del enlace; un enlace a un archivo dentro de la raíz, que se lee; un enlace dentro de un directorio que la búsqueda deja fuera; y un enlace que no lleva a ningún archivo, ya sea a un directorio, que unreadLinkedDirs nombra donde lleva fuera de la raíz, a ninguna parte o en un bucle. Un archivo de configuración del espacio de trabajo que es un enlace que lleva fuera del espacio de trabajo, su propio .aggrega-config.yaml o el overlay propiedad de la CI junto a él, se nombra tanto si la búsqueda lo encontró como si no, después de los enlaces que nombró la búsqueda: la configuración del espacio de trabajo no se lee entonces en absoluto, esta respuesta se lee sin nada configurado, así que no se lista ninguna Release que la configuración nombre a través de un enlace, y cada solicitud que decide la configuración se rechaza para ese espacio de trabajo con la condición del bloqueo de lectura.

No se permiten propiedades adicionales.

ActiveReleaseResult

Sobre qué Release debe actuar un cliente de forma predeterminada. Un espacio de trabajo que no apunta a ninguna Release es un estado ordinario y no un fallo, así que se informa aquí con una relación de cómo se intentó la elección en lugar de lanzarse como error.

PropiedadTipoObligatoriaDescripción
releasestringsíLa Release que se eligió, o vacío donde no se eligió ninguna.
lockfilestringnoEl archivo de bloqueo de la Release que se eligió: el archivo que un pull escribe para ella y que lee una compilación. Ausente donde no se eligió ninguna Release.
reasonstringnoPor qué no se eligió ninguna Release.
tracestringnoCada paso de la elección y lo que encontró, para que un llamador pueda ver cuál la habría decidido.

No se permiten propiedades adicionales.

EditDocumentResult

Lo que escribió la edición, y dónde. Después de una escritura se descarta la lectura del documento que tiene el daemon, así que la siguiente respuesta sobre él se calcula a partir de los bytes que produjo la edición.

PropiedadTipoObligatoriaDescripción
filestringsíEl documento que se editó.
editstringsíQué edición se aplicó.
containerstring[] o nullsíLa ruta a través del documento hasta donde llegó la edición.
createdContainersstring[] o nullsíLos contenedores que la edición tuvo que crear por el camino.
writtenstring[] o nullsíLos documentos que se escribieron.
contentstringsíEl documento compuesto, para una solicitud que pidió que se le mostrara el resultado en lugar de escribirlo.

No se permiten propiedades adicionales.

EffectiveConfigurationResult

La configuración que resolvió el espacio de trabajo, y de qué documento procede cada ajuste.

PropiedadTipoObligatoriaDescripción
layersstring[] o nullsíLos documentos de configuración que se fusionaron, en el orden en que se fusionaron.
settingsEffectiveConfigurationSetting[] o nullsíCada ajuste resuelto y de dónde procede.

No se permiten propiedades adicionales.

ConfigInitResult

Lo que escribió la inicialización de una configuración, dónde, y lo que leyó del registro.

PropiedadTipoObligatoriaDescripción
hoststringsíEl registro para el que se inicializó la configuración.
scopeConfigWriteScopesíQué documento de configuración se escribió y hasta dónde alcanza. Una solicitud nombra un espacio de trabajo, así que una respuesta que no dijera nada se leería como referida a ese espacio de trabajo — y para una escritura de toda la máquina esa lectura es errónea.
trustTrustFetchOutcomesíQué produjo la lectura de la política de confianza anunciada de un registro. Los resultados se mantienen separados porque significan cosas distintas: se adoptó la política anunciada, el registro no anunció nada — lo cual no es un fallo —, se fijó en su lugar la base de referencia integrada, o no se intentó ninguna lectura. Donde no se anunció nada, se indica junto a ello si se pudo llegar al registro en absoluto.
writtenbooleanosíSi el documento se escribió, en lugar de devolverse para que el llamador lo coloque.
existedbooleanonoPresente y true cuando el documento ya estaba allí, de modo que la entrada de registro se fusionó en él en lugar de crearse un documento nuevo. Solo una solicitud que envía force continúa sobre un documento existente, así que está ausente de cada respuesta a una solicitud que no lo hizo.
contentstringnoEl texto del documento, para una solicitud que pidió que se le mostrara en lugar de escribirlo.

No se permiten propiedades adicionales.

ConfigCaptureResult

Lo que escribió la congelación de la configuración resuelta en el documento propio de este espacio de trabajo.

PropiedadTipoObligatoriaDescripción
configFilestringsíEl documento que se escribió. Siempre es el propio de este espacio de trabajo, ya que todo el propósito es hacer autónomo un espacio de trabajo.
workspaceRootstringsíEl espacio de trabajo que nombró la solicitud.
capturedbooleanosíSi se congeló algo.
socketsConfigCapturedSocket[] o nullsíCada socket que se congeló, con sus vinculaciones.
catalogDirsstring[] o nullsíLos directorios de catálogo que se congelaron.

No se permiten propiedades adicionales.

ImportResult

Lo que produjo la conversión de una fuente externa, y lo que no pudo convertir.

PropiedadTipoObligatoriaDescripción
formatstringsíEl formato de origen que se convirtió.
outputDirstringsíEl directorio respecto al que es relativa cada ruta de la respuesta, y aquel en el que se escribieron los archivos.
writtenstring[] o nullsíCada archivo que llegó al disco, en el orden de escritura: los borradores, luego el registro de lo que escribió la importación. Con sync, solo los borradores que cambió la sincronización y el registro donde cambió. Vacío con dryRun.
filesImportedFile[] o nullsíCada archivo que escribe la solicitud, con su texto, con dryRun y sin él: cada borrador, luego el registro de lo que escribió la importación. Con sync, cada borrador que cambia la sincronización, con su nuevo texto, luego el registro donde también cambia, de modo que una sincronización ya al día responde con una lista vacía.
driftImportDrift[]síCada parte que una sincronización puso al día con la fuente, o que pondría al día con dryRun, en el orden en que el borrador las nombra; un archivo redactado que la sincronización elimina es una de ellas, eliminada sin claves. Una lista vacía para una solicitud que no es una sincronización, para una sincronización ya al día, y para una sincronización cuya conversión se detuvo, que no escribe nada.
diagnosticsImportDiagnostic[] o nullsíLo que no se pudo convertir.
decisionsImportDecision[]síCómo asignó el importador cada nodo de la fuente, en el orden del importador y exactamente como lo informó: lo que te dice dónde adivinó la conversión. Presente con ambas formas de entrega y tanto si la conversión se detuvo como si no, y una lista vacía para un importador que no informa ninguna.
owedImportOwed[]noCada valor que los borradores aún dejan vacío y que ninguna fuente pudo aportar ni ninguna respuesta aportó, en el orden en que se escriben los borradores — los valores que nombran los hallazgos de advertencia. Toda respuesta lo incluye, como una lista vacía cuando los borradores no deben nada.
haltedbooleanosíSi la conversión se detuvo en lugar de terminar con hallazgos.

No se permiten propiedades adicionales.

ScaffoldEntityResult

El documento inicial redactado, la lista de ejemplos ejecutables o el ejemplo escrito — cada forma responde con sus propios campos y deja ausentes los demás.

PropiedadTipoObligatoriaDescripción
kindstringnoEl tipo de entidad que se redactó. Presente en un borrador.
skeletonstringnoEl texto del documento redactado. Presente en un borrador.
examplesScaffoldExample[]noCada ejemplo ejecutable que publica la documentación, cada uno una vez, en orden de nombre. Presente en un listado que encontró alguno.
examplestringnoEl ejemplo que se escribió. Presente en una escritura.
dirstringnoEl directorio en el que se escribió el ejemplo, relativo a la raíz del espacio de trabajo, tal como lo nombró la solicitud o, donde no nombró ninguno, como el nombre del ejemplo. Presente en una escritura.
filesstring[]noCada archivo escrito, relativo a dir y separado por barras, en el orden en que la documentación los presenta. Presente en una escritura.
nextstring[]noLos comandos que da la página del ejemplo para compilarlo, línea por línea tal como la página los escribe, comentarios incluidos: el primer bloque de shell bajo su encabezado Build. Ausente donde la página no da ninguno.
versionstringnoLa versión de la documentación de la que se leyó el ejemplo: la propia del binario donde hay una publicada para él; si no, la más reciente publicada antes que él. Presente en una escritura.

No se permiten propiedades adicionales.

ScaffoldExample

Un ejemplo ejecutable que publica la documentación.

PropiedadTipoObligatoriaDescripción
namestringsíEl nombre del ejemplo, que una solicitud envía como example para escribirlo.
levelstringsíEl nivel que la página del ejemplo declara para él.
summarystringsíLa primera oración de la página del ejemplo.

No se permiten propiedades adicionales.

LintResult

Lo que encontró la comprobación de convenciones, contado por gravedad y listado por documento. Una comprobación de todo el catálogo que se ejecutó una vez por cada Release también lleva passes; los recuentos y files cubren entonces todas las pasadas juntas.

PropiedadTipoObligatoriaDescripción
entitystringnoLa única entidad que se comprobó, donde la solicitud nombró una.
releasestringnoLa Release cuyo cierre se comprobó, donde la solicitud nombró una.
checkedintegersíCuántos documentos se comprobaron. Donde la comprobación se ejecutó una vez por cada Release, la suma sobre las pasadas: un documento que leen dos pasadas se cuenta en cada una.
findingsintegersíCuántos hallazgos hay en total.
errorsintegersíCuántos de ellos son errores.
warningsintegersíCuántos de ellos son advertencias.
infosintegersíCuántos de ellos son informativos.
filesLintFileFindings[] o nullsíLos hallazgos, por documento.
haltedbooleanosíSi la comprobación se detuvo en lugar de terminar con hallazgos.
passesLintPass[] o nullnoLa comprobación de todo el catálogo una pasada a la vez, presente solo donde se ejecutó una vez por cada Release porque el espacio de trabajo nombra Releases bajo workspace.releases. Cada pasada dice para qué Releases se encontraron sus hallazgos. Ausente para un espacio de trabajo que no nombra ninguna, que se comprueba una vez sobre sus propios directorios, y para una comprobación de una sola entidad o del cierre de una Release.

No se permiten propiedades adicionales.

LintPass

Una pasada de una comprobación de convenciones de todo el catálogo en un espacio de trabajo que da a sus Releases directorios de catálogo propios: las Releases para las que se ejecutó, los directorios que leyó y lo que encontró allí.

PropiedadTipoObligatoriaDescripción
releasesstring[] o nullsíLas Releases para las que se ejecutó la pasada, cada una como ruta relativa a la raíz del espacio de trabajo. Las Releases que leen los mismos directorios de catálogo comparten una pasada.
catalogDirsstring[] o nullsíLos directorios de catálogo que leyó la pasada, en el orden en que se buscan, cada uno relativo a la raíz del espacio de trabajo donde está dentro de ella. Vacío donde sus Releases no leen ningún directorio de catálogo, de modo que la pasada no comprobó nada y no hizo fallar a ninguna de las demás.
checkedintegersíCuántos documentos comprobó la pasada.
findingsintegersíCuántos hallazgos encontró la pasada.
errorsintegersíCuántos de ellos son errores.
warningsintegersíCuántos de ellos son advertencias.
infosintegersíCuántos de ellos son informativos.
filesLintFileFindings[] o nullsíLos hallazgos de la pasada, por documento.

No se permiten propiedades adicionales.

PluginAddResult

Lo que escribió la vinculación de un plugin, dónde y qué versión fijó.

PropiedadTipoObligatoriaDescripción
typestringsíEl socket al que se vinculó el plugin.
identitystringnoLa identidad en la que se resolvió la vinculación.
uristringnoLa referencia desde la que se resuelve la vinculación.
capabilitystringnoLa capacidad para la que es la vinculación.
referencestringnoLa referencia fijada, con la versión incluida.
scopePluginWriteScopesíEn qué documento de configuración se escribió un cambio de plugin y hasta dónde alcanza. El valor predeterminado propio del socket de extensión de comandos es el documento de toda la máquina, así que cada respuesta dice cuál escribió.
writtenbooleanosíSi el documento de configuración se escribió, en lugar de devolverse para que el llamador lo coloque.
contentstringnoEl texto del documento de configuración, para una solicitud que pidió que se le mostrara en lugar de escribirlo.
retractionPluginRetractionnoCómo determinó un marcador de obsolescencia qué versión del plugin se fijó.
withdrawnbooleanonoEs true cuando la consulta nombró la versión fijada y una retractación en la que confía este espacio de trabajo ha retirado esa versión. Una versión nombrada se fija igualmente, porque nombrarla es la anulación. Ausente en caso contrario, y la ausencia no significa que la versión no esté retirada: donde no se pudieron leer los marcadores de retirada de una versión nombrada, retraction.unscreened indica por qué, y sin ninguna versión nombrada se elige la última versión publicada y retraction informa de lo que concluyó la comprobación de retirada sobre esa elección.

No se permiten propiedades adicionales.

PluginRemoveResult

Lo que escribió la desvinculación de un plugin, y dónde.

PropiedadTipoObligatoriaDescripción
typestringsíEl socket al que se vinculó el plugin.
querystringsíQué vinculación se eliminó.
scopePluginWriteScopesíEn qué documento de configuración se escribió un cambio de plugin y hasta dónde alcanza. El valor predeterminado propio del socket de extensión de comandos es el documento de toda la máquina, así que cada respuesta dice cuál escribió.

No se permiten propiedades adicionales.

PluginSyncResult

Lo que cambió la alineación de los registros gestionados por la máquina de una entidad Plugin con su módulo.

PropiedadTipoObligatoriaDescripción
entitystringsíEl documento de entidad Plugin que se alineó.
hostFunctionsstring[] o nullsíLas funciones de host que el módulo declara necesitar.
commandsPluginCLICommand[] o nullsíLos comandos que aporta el módulo.
changedbooleanosíSi algo en el documento cambió realmente.

No se permiten propiedades adicionales.

PluginGenCatalogResult

Los documentos de catálogo que produjo una generación.

PropiedadTipoObligatoriaDescripción
documentsPluginGeneratedDocument[]noCada documento generado y su texto.
noticesstringnoCualquier cosa que la generación quiera que sepa el llamador.
dryRunbooleanosíSi los documentos se devolvieron en lugar de escribirse.

No se permiten propiedades adicionales.

ExplainErrorResult

Lo que el compilador declara sobre una condición, y los pasajes publicados que enseñan la corrección de authoring.

PropiedadTipoObligatoriaDescripción
shortCodestringsíEl código corto de la condición.
codestringsíEl nombre descriptivo de la condición.
messagestringsíLo que dice la condición cuando se genera.
entriesExplainErrorEntry[]noLos pasajes publicados que enseñan la corrección.
referencestringsíLa dirección publicada en la que se explica la condición.
notestringnoPor qué faltan los pasajes publicados, donde no se pudieron obtener. Lo que declara el propio binario se sigue respondiendo.

No se permiten propiedades adicionales.

GetSchemaResult

El esquema de un tipo o — donde la solicitud no nombró ninguno — qué tipos se pueden nombrar. Las dos amplitudes viajan en una sola respuesta en lugar de en dos métodos, porque «qué puedo nombrar» y «de cuáles de ellos escribe documentos un autor» son la misma pregunta con dos amplitudes, y dos respuestas tendrían que mantenerse de acuerdo.

PropiedadTipoObligatoriaDescripción
kindstringnoEl tipo al que corresponde el esquema.
schemaanynoEl propio esquema, transmitido tal como lo tiene el binario.
kindsstring[]noCada token al que responde este binario.
entityKindsEntityKindDescriptor[]noEl conjunto más reducido del que un autor escribe un documento, cada uno de los cuales empareja el token que nombra una solicitud con el tipo que declara el propio encabezado del documento.

No se permiten propiedades adicionales.

SkillsInstallResult

Lo que escribió la instalación de la skill del asistente, y dónde.

PropiedadTipoObligatoriaDescripción
skillstringsíLa skill que se escribió.
installedSkillsInstalledFolder[]síCada carpeta de skills escrita, en el orden en que la solicitud nombró a los asistentes. Los asistentes que leen una misma carpeta compartida comparten una entrada, porque la skill se escribe allí una sola vez.
scopeSkillFolderScopesíHasta dónde alcanza una instalación de skill. Una solicitud nombra un espacio de trabajo, así que una respuesta que no dijera nada se leería como referida a ese espacio de trabajo — y para las carpetas por usuario, que un asistente lee en cada proyecto, esa lectura es errónea.

No se permiten propiedades adicionales.

SkillsInstalledFolder

Una carpeta de skills que escribió una instalación.

PropiedadTipoObligatoriaDescripción
agentsstring[]síLos identificadores de los asistentes nombrados que leen esta carpeta, en el orden en que la solicitud los nombró.
folderstringsíLa carpeta de la skill, como ruta absoluta.
replacedbooleanosíSi una copia que lleva la línea de comentario que lleva toda copia escrita de la skill — una que escribió una instalación anterior, o una tomada del repositorio de skills publicado — estaba allí y se ha reemplazado. Un archivo allí sin esa línea se rechaza en lugar de reemplazarse.

No se permiten propiedades adicionales.

SkillsListResult

Las skills que incluye el binario y cada asistente para el que una instalación puede escribirlas. No se escribe nada y no se accede a nada.

PropiedadTipoObligatoriaDescripción
skillsSkillsListedSkill[]síCada skill que incluye el binario, en un orden fijo.
agentsSkillsListedAgent[]síCada asistente para el que una instalación conoce una carpeta de skills, ordenado por identificador.

No se permiten propiedades adicionales.

SkillsListedSkill

Una skill que incluye el binario.

PropiedadTipoObligatoriaDescripción
namestringsíEl nombre de la skill, que es también el nombre de la carpeta que escribe una instalación.
descriptionstringsíCuándo usa un asistente la skill, tal como la propia skill lo declara.

No se permiten propiedades adicionales.

SkillsListedAgent

Un asistente para el que una instalación puede escribir una skill, con las dos carpetas de las que lee skills.

PropiedadTipoObligatoriaDescripción
idstringsíEl identificador con el que una solicitud nombra al asistente.
namestringsíEl nombre propio del asistente.
projectFolderstringsíLa carpeta, relativa a la raíz de un proyecto y separada por barras, de la que el asistente lee las skills de un proyecto. Una instalación de proyecto escribe la carpeta de la skill dentro de ella, en el espacio de trabajo que nombra la solicitud.
userFolderstringsíLa carpeta, relativa al directorio personal y separada por barras, de la que el asistente lee las skills propias del usuario en cada proyecto. Una instalación con global escribe la carpeta de la skill dentro de ella.

No se permiten propiedades adicionales.