콘텐츠로 이동
AggregaAggrega
언어 선택: 한국어
이 페이지는 기계 번역되었습니다. 영어 원문 읽기.

Aggrega 백그라운드 데몬 와이어 프로토콜 스키마

자동 생성된 레퍼런스입니다. 직접 편집하지 말고 게시된 JSON Schema에서 다시 생성하십시오.

스키마 id: https://aggrega.ai/schemas/serve-wire-v1beta1.schema.json

aggrega serve로 시작된 백그라운드 컴파일러 데몬과 주고받는 메시지 형태입니다. 클라이언트는 핸드셰이크로 해당 데몬에 대한 세션을 열며, 세션은 대화가 열린 설정과 워크스페이스의 범위를 정합니다. 데몬은 요청에 응답하고, 알림을 보내고, 읽어 들인 내용을 보유하는 프로세스입니다. 프로토콜은 표준 입력과 출력을 통한 JSON-RPC 2.0이며, 각 메시지는 Content-Length 헤더로 프레이밍됩니다. 이 문서는 메시지 본문을 설명하며 프레이밍이나 전송 방식은 설명하지 않습니다. 본문은 네 가지 중 하나입니다. 클라이언트가 보내는 요청, 클라이언트가 보내는 알림, 데몬이 보내는 알림, 또는 데몬이 요청에 대해 반환하는 응답입니다. 이 인터페이스의 세 가지 속성이 아래 형태의 작성 방식을 결정합니다. 첫째, 모든 요청은 해당 메서드가 자체적으로 선언하는 필드 외에 두 필드를 허용합니다. 요청이 작용하는 워크스페이스를 지정하는 workspaceRoot와, 호출자가 생성하며 진행 상황이 그 아래에서 보고되는 값인 workDoneToken입니다. 따라서 대상이 워크스페이스가 아닌 세 메서드를 포함하여, 여기의 모든 요청 params 객체에 두 필드가 모두 나타납니다. aggrega/getSchema와 aggrega/scaffoldEntity는 workspaceRoot를 허용하되 무시하고, aggrega/initialize는 이를 세션이 선언하는 워크스페이스로 읽습니다. 둘째, 데몬은 메서드가 허용하지 않는 필드를 담은 요청 params 객체를 거부하고 허용하는 필드를 알려 주므로, 여기의 모든 params 객체는 최상위 수준에서 닫혀 있습니다. 요청 내부의 중첩 객체는 닫혀 있지 않은데, 검사가 가장 바깥쪽 필드 이름만 읽기 때문입니다. 셋째, 결과는 호출자가 제공하는 것이 아니라 데몬이 구성하므로, 결과 객체는 형태가 고정된 모든 수준에서 닫혀 있으며, 데몬이 읽지 않고 그대로 전달하는 불투명한 JSON 값인 곳에서만 열려 있습니다. 데몬의 인코딩 방식에서 비롯된 한 가지 결과가 와이어에 드러나며, 이를 감추지 않고 그대로 설명합니다. 데몬이 선택 사항으로 표시하지 않은 컬렉션은 보고할 값이 없을 때 null로, 보고하는 값이 비어 있을 때 빈 컬렉션으로 출력되므로, 이것이 해당되는 모든 곳에서 두 형태가 모두 허용됩니다.

다음 형태 중 하나

  • Request
  • ClientNotification
  • DaemonNotification
  • SuccessResponse
  • ErrorResponse

정의

ProtocolVersion

모든 메시지가 담는 JSON-RPC 버전입니다. 2.0만 사용합니다.

타입: const "2.0"

상수: "2.0"

RequestId

호출자가 요청에 부여한 식별자로, 그 요청에 답하는 응답에 그대로 되돌려집니다. 식별자가 없는 메시지는 알림이며 응답을 받지 않습니다.

타입: string or number

ProgressToken

호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.

타입: string or number

WorkspaceRootSubject

이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.

타입: string

WorkspaceRootAccepted

워크스페이스의 절대 경로입니다. 이 메서드의 대상은 워크스페이스가 아니므로(바이너리 자체가 담고 있는 내용으로 답합니다), 이 필드는 허용되지만 읽히지 않습니다. 클라이언트가 어떤 메서드가 이 필드를 참조하는지 알 필요 없이 모든 요청에 일관되게 보낼 수 있도록 허용됩니다.

타입: string

RequestMethod

요청이 지정할 수 있는 모든 메서드입니다. 이 집합은 닫혀 있습니다. 그 밖의 것을 지정한 요청에는 method-not-found 오류로 응답합니다.

타입: string (enum)

허용되는 값: "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

클라이언트 알림이 지정할 수 있는 모든 메서드입니다. 이 집합은 닫혀 있으며, 어느 알림도 응답을 받지 않습니다.

타입: string (enum)

허용되는 값: "$/cancelRequest", "aggrega/shutdown"

DaemonNotificationMethod

데몬이 보내는 알림이 지정할 수 있는 모든 메서드입니다. 이 집합은 닫혀 있습니다.

타입: string (enum)

허용되는 값: "$/progress", "aggrega/publishDiagnostics"

Request

클라이언트가 보내고 데몬이 응답하는 요청입니다. 메서드는 요청 내용을 지정하고, params 객체는 해당 메서드 고유의 필드와 모든 메서드가 허용하는 두 필드를 담습니다. params를 아예 생략한 요청은 모든 필드가 없는 요청으로 읽힙니다.

속성타입필수설명
jsonrpcProtocolVersion예모든 메시지가 담는 JSON-RPC 버전입니다. 2.0만 사용합니다.
idRequestId예호출자가 요청에 부여한 식별자로, 그 요청에 답하는 응답에 그대로 되돌려집니다. 식별자가 없는 메시지는 알림이며 응답을 받지 않습니다.
methodRequestMethod예요청이 지정할 수 있는 모든 메서드입니다. 이 집합은 닫혀 있습니다. 그 밖의 것을 지정한 요청에는 method-not-found 오류로 응답합니다.
paramsobject아니요

추가 속성은 허용되지 않습니다.

각 method의 params:

methodparams필수
"aggrega/initialize"InitializeParams아니요
"aggrega/validate"ValidateParams아니요
"aggrega/invalidate"InvalidateParams아니요
"aggrega/diagnostics"DiagnosticsParams아니요
"aggrega/irGraph"IrGraphParams아니요
"aggrega/build"BuildParams아니요
"aggrega/buildPreview"BuildPreviewParams아니요
"aggrega/entityDefinition"EntityDefinitionParams아니요
"aggrega/releaseClosure"ReleaseClosureParams아니요
"aggrega/resolveDependencies"ResolveDependenciesParams아니요
"aggrega/pin"PinParams아니요
"aggrega/cacheStatus"WorkspaceAndProgressParams아니요
"aggrega/cachePrune"WorkspaceAndProgressParams아니요
"aggrega/cacheEvict"CacheEvictParams아니요
"aggrega/cacheClear"WorkspaceAndProgressParams아니요
"aggrega/registryList"WorkspaceAndProgressParams아니요
"aggrega/search"SearchParams아니요
"aggrega/registryAdd"RegistryAddParams아니요
"aggrega/registryRemove"RegistryRemoveParams아니요
"aggrega/registryUpdate"RegistryUpdateParams아니요
"aggrega/logout"LogoutParams아니요
"aggrega/publishEntity"PublishEntityParams아니요
"aggrega/publishArtifact"PublishArtifactParams아니요
"aggrega/signArtifacts"SignArtifactsParams아니요
"aggrega/deprecateArtifact"DeprecateArtifactParams아니요
"aggrega/resolve"ResolveParams아니요
"aggrega/findReferences"FindReferencesParams아니요
"aggrega/findImplementations"FindImplementationsParams아니요
"aggrega/hover"HoverParams아니요
"aggrega/completion"CompletionParams아니요
"aggrega/catalogIndex"CatalogIndexParams아니요
"aggrega/attachCandidates"AttachCandidatesParams아니요
"aggrega/connectionCandidates"ConnectionCandidatesParams아니요
"aggrega/insertionPoint"InsertionPointParams아니요
"aggrega/attachmentContainer"AttachmentContainerParams아니요
"aggrega/connectionAtPosition"ConnectionAtPositionParams아니요
"aggrega/releaseCandidates"WorkspaceAndProgressParams아니요
"aggrega/activeRelease"WorkspaceAndProgressParams아니요
"aggrega/setActiveRelease"SetActiveReleaseParams아니요
"aggrega/editDocument"EditDocumentParams아니요
"aggrega/effectiveConfiguration"WorkspaceAndProgressParams아니요
"aggrega/configInit"ConfigInitParams아니요
"aggrega/configCapture"ConfigCaptureParams아니요
"aggrega/import"ImportParams아니요
"aggrega/scaffoldEntity"ScaffoldEntityParams아니요
"aggrega/lint"LintParams아니요
"aggrega/pluginAdd"PluginAddParams아니요
"aggrega/pluginRemove"PluginRemoveParams아니요
"aggrega/pluginSync"PluginSyncParams아니요
"aggrega/pluginGenCatalog"PluginGenCatalogParams아니요
"aggrega/explainError"ExplainErrorParams아니요
"aggrega/getSchema"GetSchemaParams아니요
"aggrega/skillsInstall"SkillsInstallParams아니요
"aggrega/skillsList"WorkspaceAndProgressParams아니요

ClientNotification

클라이언트가 보내는 알림입니다. 식별자가 없으며 응답을 받지 않습니다.

속성타입필수설명
jsonrpcProtocolVersion예모든 메시지가 담는 JSON-RPC 버전입니다. 2.0만 사용합니다.
methodClientNotificationMethod예클라이언트 알림이 지정할 수 있는 모든 메서드입니다. 이 집합은 닫혀 있으며, 어느 알림도 응답을 받지 않습니다.
paramsobject아니요

추가 속성은 허용되지 않습니다.

각 method의 params:

methodparams필수
"$/cancelRequest"CancelRequestParams예
"aggrega/shutdown"ShutdownParams아니요

DaemonNotification

데몬이 보내는 알림입니다. 식별자가 없으며 응답을 받지 않습니다.

속성타입필수설명
jsonrpcProtocolVersion예모든 메시지가 담는 JSON-RPC 버전입니다. 2.0만 사용합니다.
methodDaemonNotificationMethod예데몬이 보내는 알림이 지정할 수 있는 모든 메서드입니다. 이 집합은 닫혀 있습니다.
paramsobject예

추가 속성은 허용되지 않습니다.

각 method의 params:

methodparams필수
"$/progress"ProgressParams예
"aggrega/publishDiagnostics"PublishDiagnosticsParams예

CancelRequestParams

이미 진행 중인 요청을 그 요청이 담았던 식별자로 지정하여, 데몬에 해당 요청을 중단하도록 요청합니다. 이미 완료되었거나 보낸 적이 없는 요청은 취소할 대상이 없는 것으로 조용히 처리됩니다.

속성타입필수설명
idRequestId예호출자가 요청에 부여한 식별자로, 그 요청에 답하는 응답에 그대로 되돌려집니다. 식별자가 없는 메시지는 알림이며 응답을 받지 않습니다.

추가 속성은 허용되지 않습니다.

ShutdownParams

데몬에 작업 수락을 멈추고 이미 받은 작업을 마치도록 요청합니다. 이 알림은 필드를 담지 않으며, 알림 자체는 보통 params 객체 없이 전송됩니다. 두 번째 알림은 진행 중인 작업을 기다리지 않고 중단합니다.

이 객체는 고정 속성을 선언하지 않으며 어떤 속성도 허용하지 않습니다.

ProgressParams

진행 중인 작업에 대한 하나의 보고로, 진행 알림을 받을 수 있다고 선언한 세션에서 진행 토큰을 생성한 요청에 대해서만 전송됩니다.

속성타입필수설명
tokenProgressToken예호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
valueProgressBegin 또는 ProgressReport 또는 ProgressEnd예보고 자체입니다. 시작 보고 하나, 이어서 임의 개수의 줄, 그다음 종료 보고 하나로 이루어집니다.

추가 속성은 허용되지 않습니다.

ProgressBegin

보고를 시작하며, 무엇이 시작되었는지를 작업 자체가 쓰는 용어로 알립니다.

속성타입필수설명
kindconst “begin”예이 페이로드를 보고의 시작으로 표시합니다. 상수: "begin"
titlestring예시작된 내용입니다.

추가 속성은 허용되지 않습니다.

ProgressReport

작업이 스스로에 대해 기술하는 한 줄입니다. 진행률은 담지 않습니다. 여기서 보고하는 작업은 작업 시작 시점에 크기를 알 수 없는 집합을 처리하므로, 진행률을 담으려면 지어내야 하기 때문입니다.

속성타입필수설명
kindconst “report”예이 페이로드를 열려 있는 보고의 한 줄로 표시합니다. 상수: "report"
messagestring예작업 자체 출력의 한 줄로, 앞뒤 공백이 제거된 것입니다.

추가 속성은 허용되지 않습니다.

ProgressEnd

보고를 종료합니다. 결과는 호출자가 이미 기다리고 있는 응답에 담겨 전달되므로, 종류 외에는 아무것도 담지 않습니다.

속성타입필수설명
kindconst “end”예이 페이로드를 보고의 종료로 표시합니다. 상수: "end"

추가 속성은 허용되지 않습니다.

PublishDiagnosticsParams

한 파일에 대한 발견 사항으로, 검증이 요청에서 지정한 문서가 아닌 다른 문서에 대해 발견 사항을 생성했을 때 데몬이 푸시합니다.

속성타입필수설명
filestring예발견 사항이 해당하는 파일입니다.
diagnosticsDiagnostic[] 또는 null예생성된 순서대로 나열된 발견 사항입니다.

추가 속성은 허용되지 않습니다.

SuccessResponse

성공한 요청에 대한 응답으로, 응답 대상 요청의 식별자를 담습니다. 응답에는 메서드가 없으므로, 어떤 결과 형태가 적용되는지는 응답 자체의 내용이 아니라 식별자가 속한 요청에 의해 정해집니다.

속성타입필수설명
jsonrpcProtocolVersion예모든 메시지가 담는 JSON-RPC 버전입니다. 2.0만 사용합니다.
idRequestId예호출자가 요청에 부여한 식별자로, 그 요청에 답하는 응답에 그대로 되돌려집니다. 식별자가 없는 메시지는 알림이며 응답을 받지 않습니다.
resultInitializeResult 또는 ValidateResult 또는 InvalidateResult 또는 DiagnosticsResult 또는 IrGraphResult 또는 BuildResult 또는 BuildPreviewResult 또는 EntityDefinitionResult 또는 ReleaseClosureResult 또는 ResolveDependenciesResult 또는 PinResult 또는 CacheStatusResult 또는 CachePruneResult 또는 CacheEvictResult 또는 CacheClearResult 또는 RegistryListResult 또는 SearchResult 또는 RegistryAddResult 또는 RegistryRemoveResult 또는 RegistryUpdateResult 또는 LogoutResult 또는 PublishEntityResult 또는 PublishArtifactResult 또는 SignArtifactsResult 또는 DeprecateArtifactResult 또는 ResolveResult 또는 FindReferencesResult 또는 FindImplementationsResult 또는 HoverResult 또는 CompletionResult 또는 CatalogIndexResult 또는 AttachCandidatesResult 또는 ConnectionCandidatesResult 또는 InsertionPointResult 또는 AttachmentContainerResult 또는 ConnectionAtPositionResult 또는 ReleaseCandidatesResult 또는 ActiveReleaseResult 또는 EditDocumentResult 또는 EffectiveConfigurationResult 또는 ConfigInitResult 또는 ConfigCaptureResult 또는 ImportResult 또는 ScaffoldEntityResult 또는 LintResult 또는 PluginAddResult 또는 PluginRemoveResult 또는 PluginSyncResult 또는 PluginGenCatalogResult 또는 ExplainErrorResult 또는 GetSchemaResult 또는 SkillsInstallResult 또는 SkillsListResult예요청된 메서드가 반환하는 형태의 응답입니다.

추가 속성은 허용되지 않습니다.

ErrorResponse

거부되었거나 실패한 요청에 대한 응답으로, 응답 대상 요청의 식별자를 담습니다.

속성타입필수설명
jsonrpcProtocolVersion예모든 메시지가 담는 JSON-RPC 버전입니다. 2.0만 사용합니다.
idRequestId예호출자가 요청에 부여한 식별자로, 그 요청에 답하는 응답에 그대로 되돌려집니다. 식별자가 없는 메시지는 알림이며 응답을 받지 않습니다.
errorErrorObject예무엇이 잘못되었는지를 나타냅니다. 클라이언트가 분기에 사용할 수 있는 코드, 사람이 읽도록 작성된 메시지, 그리고 해당 조건에 있는 경우 메시지가 가리키는 아티팩트와 소스 위치를 담습니다.

추가 속성은 허용되지 않습니다.

ErrorObject

무엇이 잘못되었는지를 나타냅니다. 클라이언트가 분기에 사용할 수 있는 코드, 사람이 읽도록 작성된 메시지, 그리고 해당 조건에 있는 경우 메시지가 가리키는 아티팩트와 소스 위치를 담습니다.

속성타입필수설명
codeErrorCode예응답이 보고하는 조건입니다. 음수 코드는 프로토콜 자체의 예약된 집합이며, 네 자리 코드는 이 데몬이 발생시키는 조건으로, 각각 클라이언트가 대응할 수 있는 상태를 나타냅니다. 이 집합은 닫혀 있습니다.
messagestring예무엇이 잘못되었는지를 산문으로 설명합니다. 같은 조건을 보고하는 다른 모든 곳에서 그 조건이 담는 문구와 동일합니다.
dataErrorData아니요메시지가 가리키는 아티팩트와 소스 위치로, 클라이언트가 산문에서 다시 읽어 낼 필요가 없도록 구조화되어 전달됩니다. 모든 필드는 선택 사항이며 조건은 자신이 가진 것만 채웁니다. 어떤 필드도 다른 필드를 대신하지 않으므로, 클라이언트는 무엇을 받았는지를 옆에 있는 코드가 아니라 자신이 읽은 필드에서 알게 됩니다.

추가 속성은 허용되지 않습니다.

ErrorCode

응답이 보고하는 조건입니다. 음수 코드는 프로토콜 자체의 예약된 집합이며, 네 자리 코드는 이 데몬이 발생시키는 조건으로, 각각 클라이언트가 대응할 수 있는 상태를 나타냅니다. 이 집합은 닫혀 있습니다.

타입: 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

허용되는 값:

  • -32700 — 메시지를 JSON으로 구문 분석할 수 없습니다.
  • -32600 — 메시지는 구문 분석되었지만 올바른 형식의 요청이 아닙니다.
  • -32601 — 해당 이름의 메서드가 없습니다.
  • -32602 — 요청에 담긴 params를 허용할 수 없습니다. 메서드가 허용하지 않는 필드, 잘못된 타입의 필드, 또는 메서드가 거부하는 값이 있습니다.
  • -32603 — 데몬이 작업을 수행하는 중에 실패했습니다.
  • 1001 — 데몬이 해당 파일에 대해 읽어 둔 결과를 보유하지 않으며 생성하고 있지도 않습니다. 클라이언트는 validation을 요청하여 읽기 결과를 만들게 한 다음 다시 시도합니다.
  • 1003 — 요청이 지정한 Release의 lockfile이 없으며, 작업에 lockfile이 필요합니다.
  • 1004 — 요청이 지정한 엔터티를 카탈로그나 요청이 지정한 Release에서 해석할 수 없습니다.
  • 1005 — 데몬이 종료 중이며 새 작업을 거부하고 있습니다. 클라이언트는 같은 데몬에 다시 시도하지 않습니다.
  • 1006 — 해당 파일의 validation이 현재 실행 중이며, 대기 중인 요청이 허용한 시간 안에 완료되지 않았습니다. 클라이언트는 기다렸다가 다시 요청하며, 그동안 아무것도 보내지 않습니다.

ErrorData

메시지가 가리키는 아티팩트와 소스 위치로, 클라이언트가 산문에서 다시 읽어 낼 필요가 없도록 구조화되어 전달됩니다. 모든 필드는 선택 사항이며 조건은 자신이 가진 것만 채웁니다. 어떤 필드도 다른 필드를 대신하지 않으므로, 클라이언트는 무엇을 받았는지를 옆에 있는 코드가 아니라 자신이 읽은 필드에서 알게 됩니다.

속성타입필수설명
filestring아니요위치 필드가 가리키는 소스 문서입니다. 검사 중인 문서이거나 로드에 실패한 Release입니다.
lineinteger아니요조건이 가리키는 줄로, 1부터 셉니다.
columninteger아니요조건이 가리키는 열로, 1부터 셉니다.
end_lineinteger아니요조건이 가리키는 토큰의 끝 바로 다음 줄입니다. 토큰의 끝을 복구할 수 없는 경우에는 없으며, 이때 클라이언트는 위치를 한 점으로 표시합니다.
end_columninteger아니요조건이 가리키는 토큰의 끝 바로 다음 열입니다.
releasestring아니요조건이 가리키는 Release로, 요청이 지정한 방식 그대로 표기되므로 클라이언트는 다시 조립하지 않고도 해결책을 구성할 수 있습니다.
lockfilestring아니요lockfile 범위 조건이 다루는 lockfile입니다. 찾았으나 발견되지 않았거나 읽을 수 없었던 경로입니다.
unreachable불리언아니요거부가 요청이 지정한 레지스트리에 도달할 수 없었던 경우인지 여부입니다. 즉 이름이 해석되지 않았거나, 연결이 거부되었거나 열 수 없었거나, 보안 연결을 수립할 수 없었던 경우입니다. 이 값은 메시지가 아니라 실패 자체에서 읽으며, 실패가 레지스트리에 전혀 도달하지 못했음을 보여 줄 때만 설정됩니다. 하나의 레지스트리를 지정한 인덱스 새로 고침이 거부되면 이 값을 담고, 레지스트리가 응답했다면 그 응답이 무엇이든 이 값은 없습니다.
codestring아니요거부가 지정하는 조건의 설명적 이름으로, 릴리스 간에 안정적입니다. 그 조건을 보고하는 진단이 자체 코드에 담는 값과 같습니다. 클라이언트는 메시지나 옆에 있는 숫자 코드가 아니라 이 값으로 분기합니다. 숫자 코드는 요청의 상태를 나타내며 모든 조건에서 그대로입니다. 거부가 등록된 조건을 지정할 때 정확히 존재하며, 아무 조건도 지정하지 않으면 없습니다.
shortCodestring아니요조건의 짧은 코드로, 문자 E와 네 자리 숫자입니다. 독자가 인용하고 찾아보는 형식이며, 조건을 지정하는 거부의 메시지 맨 앞에 오는 형식입니다. code가 있을 때 정확히 존재합니다.

추가 속성은 허용되지 않습니다.

Diagnostic

한 문서에 대한 하나의 발견 사항입니다. 위치, 심각도, 내용, 그리고 보고하는 조건을 나타내는 인용 가능한 코드를 담습니다.

속성타입필수설명
lineinteger예발견 사항이 가리키는 줄로, 1부터 셉니다.
columninteger예발견 사항이 가리키는 열로, 1부터 셉니다.
severityconst “error” 또는 const “warning” 또는 const “info”예결과의 심각도입니다. 허용되는 값: "error" — 결과가 결함입니다. halt 심각도의 플러그인 결과는 이 등급으로 보고됩니다. "warning" — 결과는 보고되지만 결함은 아닙니다. warn 심각도의 플러그인 결과는 이 등급으로 보고됩니다. "info" — 결과는 정보이며, info 심각도의 플러그인 결과가 이에 해당합니다.
messagestring예발견 사항의 내용을 산문으로 나타낸 것입니다.
codestring아니요조건의 설명적 이름으로, 릴리스 간에 안정적이며 억제 설정에 인용할 수 있습니다.
shortCodestring아니요조건의 짧은 코드로, 중단 진단의 맨 앞에 오는 형식입니다.
codeDescriptionCodeDescription아니요발견 사항이 지정하는 조건이 설명된 곳입니다.
classificationstring아니요조건이 이를 구분하는 경우, 발견 사항에 이르게 된 방식입니다.
suggeststring아니요조건이 제시할 수 있는 경우 발견 사항이 제안하는 표기입니다. 예를 들어 식별자의 오타에 대한 제안입니다.
keyPathstring아니요문서 안에서 발견 사항이 가리키는 키까지의 경로입니다.
sourcestring예발견 사항을 생성한 주체입니다.
end_lineinteger아니요발견 사항이 가리키는 토큰의 끝 바로 다음 줄로, 클라이언트가 한 문자가 아니라 토큰 전체를 표시할 수 있게 합니다. 여러 줄에 걸친 토큰에는 없습니다.
end_columninteger아니요발견 사항이 가리키는 토큰의 끝 바로 다음 열입니다.

추가 속성은 허용되지 않습니다.

CodeDescription

발견 사항이 지정하는 조건이 설명된 곳입니다.

속성타입필수설명
hrefstring예조건이 설명된 게시 주소입니다.

추가 속성은 허용되지 않습니다.

Position

문서 안의 한 위치로, 줄과 그 줄 안의 문자 오프셋이며 둘 다 0부터 셉니다. 오프셋은 세션이 열릴 때 합의한 인코딩의 단위로 측정되며, 클라이언트가 다른 인코딩을 요청하지 않으면 UTF-16입니다.

속성타입필수설명
lineinteger예줄로, 0부터 셉니다.
characterinteger예줄 안의 오프셋으로, 0부터 세며 세션이 합의한 인코딩의 단위를 사용합니다.

추가 속성은 허용되지 않습니다.

Range

문서 안의 두 위치 사이의 구간입니다.

속성타입필수설명
startPosition예문서 안의 한 위치로, 줄과 그 줄 안의 문자 오프셋이며 둘 다 0부터 셉니다. 오프셋은 세션이 열릴 때 합의한 인코딩의 단위로 측정되며, 클라이언트가 다른 인코딩을 요청하지 않으면 UTF-16입니다.
endPosition예문서 안의 한 위치로, 줄과 그 줄 안의 문자 오프셋이며 둘 다 0부터 셉니다. 오프셋은 세션이 열릴 때 합의한 인코딩의 단위로 측정되며, 클라이언트가 다른 인코딩을 요청하지 않으면 UTF-16입니다.

추가 속성은 허용되지 않습니다.

Location

이름이 지정된 문서 안의 구간입니다.

속성타입필수설명
uristring예구간이 속한 문서로, URI로 지정됩니다.
rangeRange예문서 안의 두 위치 사이의 구간입니다.

추가 속성은 허용되지 않습니다.

WorkspaceAndProgressParams

자체 필드를 선언하지 않는 메서드의 params 객체입니다. 그래도 모든 요청이 허용하는 두 필드, 즉 작업 대상 워크스페이스와 진행 토큰은 허용합니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.

추가 속성은 허용되지 않습니다.

InitializeParams

워크스페이스에 대한 세션을 열고 클라이언트가 처리할 수 있는 것을 명시합니다. 이 메서드는 workspaceRoot가 대상이 아니라 선언인 유일한 메서드입니다. 생략, 빈 값, 경로는 서로 다른 세 가지이며, 경로 없이 열린 세션은 클라이언트가 아직 워크스페이스를 지정하지 않은 세션입니다.

속성타입필수설명
capabilitiesClientCapabilities아니요클라이언트가 처리할 수 있는 것입니다. 명시되지 않은 것은 지원하지 않는 것으로 간주됩니다. 알 수 없는 멤버는 거부되지 않고 무시되므로, 클라이언트는 이 데몬이 아직 읽지 않는 기능을 명시할 수 있습니다.
workspaceRootstring아니요열 워크스페이스의 절대 경로입니다. 생략하면 세션에 워크스페이스가 없는 상태로 남습니다. 빈 문자열은 클라이언트가 제공한 경로이며, 아무것도 보내지 않은 것과 같지 않습니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.

추가 속성은 허용되지 않습니다.

ClientCapabilities

클라이언트가 처리할 수 있는 것입니다. 명시되지 않은 것은 지원하지 않는 것으로 간주됩니다. 알 수 없는 멤버는 거부되지 않고 무시되므로, 클라이언트는 이 데몬이 아직 읽지 않는 기능을 명시할 수 있습니다.

속성타입필수설명
generalobject아니요한 종류의 응답에 묶이지 않는 기능입니다.
windowobject아니요작업이 진행되는 동안 클라이언트가 표시할 수 있는 것에 관한 기능입니다.

추가 속성이 허용됩니다.

ClientCapabilities.general

한 종류의 응답에 묶이지 않는 기능입니다.

속성타입필수설명
positionEncodingsstring[]아니요클라이언트가 읽을 수 있는 위치 인코딩으로, 가장 선호하는 것이 먼저 옵니다.

추가 속성이 허용됩니다.

ClientCapabilities.window

작업이 진행되는 동안 클라이언트가 표시할 수 있는 것에 관한 기능입니다.

속성타입필수설명
workDoneProgress불리언아니요클라이언트가 진행 알림을 받을 수 있는지 여부입니다. 이를 선언하지 않은 세션에서 진행 토큰을 발급하는 요청은 거부됩니다.

추가 속성이 허용됩니다.

ValidateParams

워크스페이스 또는 그 안의 문서 하나를 검사하고, 발견 사항으로 응답합니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
filestring아니요검사할 문서입니다. 생략하면 워크스페이스가 가진 것을 검사합니다.
contentstring아니요저장되지 않은 버퍼를 검사하기 위한, 클라이언트가 현재 가지고 있는 문서의 텍스트입니다. 생략하면 디스크의 바이트를 읽습니다.
releasestring아니요검사 기준이 될 Release로, 워크스페이스 루트에 대한 상대 경로입니다.

추가 속성은 허용되지 않습니다.

InvalidateParams

데몬이 읽어 둔 문서가 변경되었음을 데몬에 알려, 해당 문서에 대한 다음 응답이 새 바이트로부터 계산되도록 합니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
filestring아니요변경된 문서입니다.
granularitystring아니요데몬이 보유한 내용 중 어느 범위를 삭제할지입니다. file은 지정된 문서에 대해 보유한 내용만 삭제합니다. 기본값인 workspace는 다른 모든 값도 이것으로 해석되며, 워크스페이스 전체에 대해 보유한 내용도 삭제합니다.

추가 속성은 허용되지 않습니다.

DiagnosticsParams

문서를 다시 검사하지 않고, 데몬이 이미 가지고 있는 해당 문서의 발견 사항으로 응답합니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
filestring아니요보고할 문서입니다. 데몬이 이미 이 문서를 읽어 두었어야 합니다.

추가 속성은 허용되지 않습니다.

IrGraphParams

Release가 컴파일되는 해석된 그래프로 응답하며, 렌더링은 하지 않습니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
releasestring아니요해석할 Release로, 워크스페이스 루트에 대한 상대 경로입니다. 절대 경로는 거부됩니다.
unredacted불리언아니요작성자가 민감하다고 선언한 값을 평문으로 포함해 응답할지 여부입니다. 생략하거나 false이면, 명령줄의 그래프 출력이 그렇듯 각 값은 그래프에서 제외되고 그 이유를 나타내는 표시가 그 자리를 대신합니다. true이면 해당 값을 포함해 Release가 컴파일되는 그대로의 그래프로 응답합니다.

추가 속성은 허용되지 않습니다.

BuildParams

Release를 컴파일하고 렌더링된 아티팩트를 워크스페이스에 기록합니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
releasestring아니요빌드할 Release로, 워크스페이스 루트에 대한 상대 경로입니다. 절대 경로는 거부됩니다.
outputParentstring아니요출력 디렉터리가 생성될 디렉터리로, 워크스페이스 루트에 대한 상대 경로입니다. 아티팩트는 그 아래의 출력 디렉터리에, 아무것도 지정하지 않았을 때 워크스페이스 루트 아래에 배치되는 것과 같은 구조로 놓입니다. 따라서 이 값은 출력 디렉터리 자체가 아니라 그 상위 디렉터리를 지정합니다. 생략하거나 비어 있으면, aggrega build가 어디에서 실행되든 그렇듯 출력 디렉터리를 워크스페이스 루트 아래에 기록합니다. 절대 경로나 워크스페이스 밖으로 벗어나는 경로는 거부됩니다.
autoPull불리언아니요Release의 의존성을 먼저 해석할지 여부입니다. 요청하면 구성된 레지스트리에 접속하고 lockfile을 기록합니다. 요청하지 않으면 빌드는 어떤 레지스트리에도 접속하지 않습니다.
policyInputstring아니요각 거버넌스 역할이 그곳에 연결된 플러그인에 전달하는 페이로드를 아티팩트 옆에 기록할 디렉터리로, 워크스페이스 루트에 대한 상대 경로입니다. aggrega build --policy-input이 기록하는 것과 같은 이름의 파일이며, 빌드가 완료되든 중단되든 기록됩니다. 응답의 알림에는 기록된 파일 수와 파일이 기록되지 않은 각 역할이 표시됩니다. 요청이 실패하면 기록된 파일은 디스크에 남지만 그 내역은 회신에 포함되지 않으며, 오류에는 거부 내용만 담깁니다. 생략하면 아무것도 기록하지 않습니다. 절대 경로나 워크스페이스 밖으로 벗어나는 경로는 거부됩니다.

추가 속성은 허용되지 않습니다.

BuildPreviewParams

Release를 컴파일하고, 아티팩트를 기록했다면 무엇이 생성되었을지를 보고하며, 아티팩트는 하나도 기록하지 않습니다. 기록하는 빌드가 받는 의존성 해석 필드는 거부합니다. 아무것도 기록하지 않는 요청은 lockfile을 채울 수 없기 때문입니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
releasestring아니요컴파일할 Release로, 워크스페이스 루트에 대한 상대 경로입니다.
autoPull불리언아니요와이어에서는 허용되지만 메서드에서 거부됩니다. 이 요청은 아무것도 기록하지 않으므로, lockfile을 채우면서 스스로 표방하는 바를 유지할 수 없습니다.
policyInputstring아니요각 거버넌스 역할이 그곳에 연결된 플러그인에 전달하는 페이로드를 기록할 디렉터리로, 워크스페이스 루트에 대한 상대 경로입니다. aggrega build --dry-run --policy-input이 기록하는 것과 같은 이름의 파일입니다. 지정하면 이 파일들이 이 요청이 기록하는 유일한 것이며, 출력 디렉터리와 lockfile은 건드리지 않습니다. 응답의 알림에는 기록된 파일 수와 파일이 기록되지 않은 각 역할이 표시됩니다. 요청이 실패하면 기록된 파일은 디스크에 남지만 그 내역은 회신에 포함되지 않으며, 오류에는 거부 내용만 담깁니다. 절대 경로나 워크스페이스 밖으로 벗어나는 경로는 거부됩니다.

추가 속성은 허용되지 않습니다.

EntityDefinitionParams

하나의 엔터티 이름이 무엇으로 해석되는지와 그것을 정의하는 문서가 어디에 있는지로 응답합니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
namestring아니요해석할 엔터티로, 이름으로 지정합니다. 또는 해당 좌표에 게시된 엔터티를 읽으려면 레지스트리 참조 oci://<host>/<repository>:<tag>를 사용하며, :<tag> 대신 @<digest>를 쓸 수 있습니다.
releasestring아니요이름을 해석할 기준이 되는 Release로, 워크스페이스 루트에 대한 상대 경로입니다. 이때 이름은 워크스페이스 구성이 해당 Release에 부여하는 카탈로그 디렉터리를 통해 해석되므로, 한 워크스페이스에서 Release마다 하나씩 여러 변형이 선언하는 이름은 해당 Release가 빌드에 사용하는 변형으로 해석되며, 해석되지 않는 이름은 workspace.releases 아래 해당 Release의 항목을 명시하는 설명과 함께 거부됩니다. 생략하면 이름은 워크스페이스 자체의 카탈로그 디렉터리에서 해석됩니다. 레지스트리 참조는 Release를 받지 않으며 Release와 함께 보내면 거부되고, Release 파일을 가리키지 않는 값도 마찬가지로 거부됩니다.

추가 속성은 허용되지 않습니다.

CatalogIndexParams

워크스페이스가 가진 엔터티, 즉 문서들이 선언하는 모든 엔터티와 카탈로그 디렉터리가 선언하는 Features로 응답합니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
releasestring아니요엔터티를 나열할 기준이 되는 Release로, 워크스페이스 루트에 대한 상대 경로입니다. 이때 Features는 워크스페이스 구성이 해당 Release에 부여하는 카탈로그 디렉터리가 선언하는 것들이며, 다른 Releases만 읽는 카탈로그 디렉터리 아래의 문서는 제외됩니다. 따라서 Release마다 하나씩 한 엔터티의 변형을 나란히 두는 워크스페이스는 해당 Release가 빌드에 사용하는 변형으로 나열됩니다. 생략하면 워크스페이스 자체의 목록이 됩니다. Release 파일을 가리키지 않는 값은 거부됩니다.

추가 속성은 허용되지 않습니다.

ReleaseClosureParams

Release가 의존하는 모든 것을 해석이 도달한 그대로 응답합니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
releasestring아니요검사할 Release로, 워크스페이스 루트에 대한 상대 경로입니다.

추가 속성은 허용되지 않습니다.

ResolveDependenciesParams

Release의 의존성을 해석하여 lockfile에 고정하고, 렌더링이 소비하는 외부 입력을 획득합니다. 구성된 레지스트리에 접속하며 기록을 수행합니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
releasestring아니요해석할 Release로, 워크스페이스 루트에 대한 상대 경로입니다.
upgrade불리언아니요lockfile이 이미 고정한 것을 따르지 않고 선언된 범위 안에서 다시 해석할지 여부입니다.
targetsstring[]아니요다시 해석할 참조로, 나머지는 고정된 그대로 둡니다. 비어 있으면 모든 것을 해석합니다.
verify불리언아니요lockfile을 기록하는 대신, 기록된 lockfile을 이 요청이 lockfile 없이 수행할 해석과 비교할지 여부이며, 그 요청이 따를 고정을 따릅니다. 검증은 lockfile, 플러그인 신뢰 기록, entity.lock을 기록하지 않으며, 콘텐츠 캐시는 해당 해석이 읽고 채우는 대로 읽히고 채워집니다. 차이가 있거나 lockfile이 없으면 요청이 실패합니다. upgrade, targets, pinSources와는 pinSources의 값과 관계없이 함께 사용할 수 없으며, 이 중 하나를 함께 보내는 요청은 무엇이든 해석되기 전에 잘못된 매개변수로 거부됩니다.
pinSources불리언아니요Release가 워크스페이스의 카탈로그 디렉터리에서 빌드하는 Recipes와 FeatureRecipes에 대해 aggrega/pin이 실행하는 고정 단계를 실행하여 각각 옆에 entity.lock을 기록할지 여부입니다. 그렇지 않으면 입력에 필요한 고정을 lock이 기록하지 않은 항목 때문에 요청이 거부됩니다. 생략하면 워크스페이스의 pin_sources_at_pull을 따르며, 어느 값이든 이 요청에 대해 해당 설정을 재정의합니다.

추가 속성은 허용되지 않습니다.

PinParams

Recipe 또는 FeatureRecipe 옆의 entity.lock에, 엔티티가 자신의 문서 바깥에서 읽는 모든 입력의 콘텐츠 고정을 기록합니다. Release는 지정하지 않습니다. 엔티티가 식별 정보를 완전히 기술한 입력은 그 엔티티를 사용하는 모든 Release에 대해 하나의 아티팩트를 가리키므로, 이를 고정하는 데 Release가 제공하는 것은 필요하지 않습니다. 엔티티의 소스가 지정하는 호스트에 접속하며 엔티티 옆에 씁니다. 엔티티 문서 자체는 절대 쓰지 않습니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
entitystring아니요고정할 엔티티 문서이며, 워크스페이스 루트에 대한 상대 경로로 지정합니다.
dryRun불리언아니요단계가 쓸 잠금을 쓰지 않고 응답으로 돌려줄지 여부입니다. 입력은 여전히 해석되므로 콘텐츠 캐시는 여전히 채워집니다.

추가 속성은 허용되지 않습니다.

CacheEvictParams

남은 캐시 콘텐츠가 요청이 지정한 크기 이하가 될 때까지 캐시된 콘텐츠를 회수합니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
maxSizestring아니요회수 후 남길 크기이며, 사람이 쓰는 방식으로 씁니다. 예: 500MB.

추가 속성은 허용되지 않습니다.

SearchParams

구성된 레지스트리의 로컬 인덱스가 제공하는 항목을 검색합니다. 이미 디스크에 있는 인덱스를 읽으며 어떤 레지스트리에도 접속하지 않습니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
querystring아니요레코드의 이름과 설명에 대해 일치시킬 텍스트입니다.
kindsstring[]아니요남길 엔티티 종류입니다. 비어 있으면 모든 종류를 남깁니다.
selectorstring아니요남기는 레코드가 만족해야 하는 레이블 셀렉터입니다.
capabilitiesstring[]아니요남기는 플러그인 레코드가 선언해야 하는 기능입니다.
pluginTypestring아니요남길 플러그인 유형입니다.
registrystring아니요검색할 단일 레지스트리 호스트입니다. 없으면 구성된 모든 호스트를 검색합니다.
limitinteger아니요응답할 레코드의 최대 개수입니다.
includeRetracted불리언아니요게시된 마커가 사용 중단으로 표시한 버전을 남길지 여부입니다.

추가 속성은 허용되지 않습니다.

RegistryAddParams

레지스트리와, 그 레지스트리가 제공하는 것에 해석이 적용하는 신뢰 정책을 등록합니다. 요청이 달리 요구하지 않는 한 머신 전역 구성 파일에 쓰므로, 머신의 모든 워크스페이스가 이 항목을 통해 해석합니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
hoststring아니요등록할 레지스트리 호스트입니다.
namestring아니요호스트로 해석되는 알기 쉬운 별칭입니다.
identitiesstring[]아니요이 레지스트리가 제공하는 것에 대해 신뢰하는 서명 ID입니다.
keyPathstring아니요키리스 ID가 아닌 공개 키로 서명된 레지스트리의 경우, 신뢰할 공개 키의 경로입니다.
trustedRootstring아니요서명을 검증할 기준이 되는 트러스트 앵커의 경로입니다.
requireSignatures불리언아니요이 레지스트리의 아티팩트가 검증된 서명을 지녀야 하는지 여부입니다. 없으면 아무것도 지정하지 않으며 해석된 기본값을 그대로 둡니다.
advisory불리언아니요검증 실패 시 중단하지 않고 보고할지 여부입니다.
fetchTrust불리언아니요레지스트리가 공지하는 신뢰 정책을 읽어 고정할지 여부입니다. 없으면 아무것도 지정하지 않으며 해석된 기본값을 그대로 둡니다.
global불리언아니요머신 전역 구성 파일에 씁니다. 이 메서드의 기본 동작입니다.
workspace불리언아니요머신 전역 구성 파일 대신 이 워크스페이스 자체의 구성 파일에 씁니다.

추가 속성은 허용되지 않습니다.

RegistryRemoveParams

등록된 레지스트리를 제거합니다. 요청이 달리 요구하지 않는 한 머신 전역 구성 파일에 씁니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
registrystring아니요제거할 레지스트리이며, 호스트 또는 별칭으로 지정합니다.
global불리언아니요머신 전역 구성 파일에 씁니다. 이 메서드의 기본 동작입니다.
workspace불리언아니요머신 전역 구성 파일 대신 이 워크스페이스 자체의 구성 파일에 씁니다.

추가 속성은 허용되지 않습니다.

RegistryUpdateParams

검색이 읽는 로컬 인덱스를 새로 고치며, 이를 위해 레지스트리에 접속합니다. 쓰는 대상은 이 워크스페이스 자체에 구성된 캐시 디렉터리 아래의 인덱스입니다. 주변 환경의 어떤 소스에도 없는 자격 증명이 필요한 레지스트리는 입력을 요청하지 않고, 해당 자격 증명을 명시하여 거부됩니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
registrystring아니요새로 고칠 단일 레지스트리입니다. 없으면 구성된 모든 호스트를 새로 고칩니다.
upgrade불리언아니요인덱스에 이미 있는 내용에 추가하지 않고 인덱스를 다시 빌드할지 여부입니다.

추가 속성은 허용되지 않습니다.

LogoutParams

저장된 레지스트리 자격 증명을 제거합니다. 저장소는 머신의 모든 프로젝트가 공유하며, 응답에서 이를 알려 줍니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
registrystring아니요저장된 자격 증명을 제거할 레지스트리입니다.

추가 속성은 허용되지 않습니다.

PublishEntityParams

엔터티를 레지스트리에 게시합니다. 게시된 내용은 해당 레지스트리의 모든 소비자가 해석하는 대상이 되며, 게시된 버전은 이미 가져간 사용자로부터 회수할 수 없습니다. 아무것도 입력을 요청하지 않습니다. 신원은 요청이 제공한 값이나 환경이 이미 가지고 있는 값으로부터 해석됩니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
entitystring아니요게시할 엔터티 문서로, 워크스페이스 루트 기준 상대 경로입니다.
registrystring아니요게시할 대상 레지스트리입니다. 없으면 구성된 기본값을 사용합니다.
dryRun불리언아니요실제로 게시하지 않고 게시 시 반영될 내용을 보고할지 여부입니다.
sign불리언아니요게시하는 내용에 서명할지 여부입니다. 없으면 아무것도 지정하지 않으며 해석된 기본값이 그대로 유지됩니다.
pluginstring아니요Plugin 엔터티와 함께 게시할 플러그인 모듈입니다.
fulcioUrlstring아니요서명 인증서를 발급받을 인증 기관입니다.
rekorUrlstring아니요서명을 기록할 투명성 로그입니다.
timestampUrlstring아니요연서명에 사용할 타임스탬프 기관입니다.
identityTokenstring아니요서명에 사용할 신원 토큰으로, 터미널에서 얻는 대신 호출자가 제공합니다.
pinSources불리언아니요엔터티를 번들로 묶기 전에 aggrega/pin이 실행하는 고정 단계를 엔터티에 실행할지 여부로, 이 단계가 엔터티 옆에 쓰는 entity.lock이 게시 내용에 포함되도록 합니다. 이 단계는 엔터티를 판정하는 모든 거부보다 먼저 실행되며, dryRun에서는 쓸 lock을 보고하고 아무것도 쓰지 않습니다. 없으면 워크스페이스의 pin_sources_at_push를 따르며, 어느 값이든 이 요청에 대해 해당 설정을 재정의합니다.

추가 속성은 허용되지 않습니다.

PublishArtifactParams

임의의 파일을 요청이 지정한 이름과 태그로 레지스트리에 게시합니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
filestring아니요게시할 파일로, 워크스페이스 루트 기준 상대 경로입니다.
namestring아니요게시에 사용할 리포지토리 이름입니다.
tagstring아니요게시에 사용할 태그입니다.
mediaTypestring아니요게시된 바이트에 기록할 미디어 타입입니다.
registrystring아니요게시할 대상 레지스트리입니다. 없으면 구성된 기본값을 사용합니다.
dryRun불리언아니요실제로 게시하지 않고 게시 시 반영될 내용을 보고할지 여부입니다.

추가 속성은 허용되지 않습니다.

SignArtifactsParams

이미 게시된 내용에 서명합니다. 서명은 이미 가져간 사용자로부터 회수할 수 없습니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
referencesstring[]아니요서명할 게시된 참조입니다.
fulcioUrlstring아니요서명 인증서를 발급받을 인증 기관입니다.
rekorUrlstring아니요서명을 기록할 투명성 로그입니다.
timestampUrlstring아니요연서명에 사용할 타임스탬프 기관입니다.
identityTokenstring아니요서명에 사용할 신원 토큰으로, 터미널에서 얻는 대신 호출자가 제공합니다.
jobsinteger아니요한 번에 서명하는 참조의 수입니다. 생략하면 하나씩 차례로 서명합니다. 각 참조는 단독으로 서명할 때와 정확히 같은 방식으로 서명되며, keyless인 경우 각자의 인증서와 각자의 투명성 로그 항목을 사용합니다. 응답은 참조가 주어진 순서를 유지합니다. 최솟값: 1.

추가 속성은 허용되지 않습니다.

DeprecateArtifactParams

게시된 버전을 사용 중단으로 표시하여, 해석 과정에서 이를 보고하거나 거부할 수 있게 합니다. 표시 자체도 게시되고 서명됩니다. 요청은 내용이 포함된 하나의 참조를 보내거나, 각 항목이 자신의 내용을 담은 배치 파일을 보냅니다. 둘 다 보내는 일은 없으며, 배치 파일과 함께 내용을 보내는 일도 없습니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
referencestring아니요표시할 게시된 참조입니다. from의 대안이며, 둘 다 담은 요청은 거부됩니다.
severityconst “warning” 또는 const “error” 또는 const “retracted”아니요마커의 강도로, 해석이 해당 버전을 보고할지 거부할지를 정합니다. reference와 함께 쓸 때는 필수이며, from과 함께 쓰면 거부됩니다. 그 배치 파일이 각 마커 자신의 강도를 담기 때문입니다. 허용되는 값: "warning" — 지원 중단됨. 두 권고 등급 중 약한 쪽이며, 버전을 선택할 때 여전히 선택됩니다. "error" — 지원 중단됨. 두 권고 등급 중 강한 쪽이며, 버전을 선택할 때 여전히 선택됩니다. "retracted" — 철회됨. 버전을 선택할 때 제외됩니다.
reasonstring아니요버전이 사용 중단된 이유입니다. reference와 함께 쓸 때는 필수이며, from과 함께 쓰면 거부됩니다. 그 배치 파일이 각 마커 자신의 사유를 담기 때문입니다.
replacementstring아니요대신 사용할 참조입니다. from과 함께 쓰면 거부됩니다. 그 배치 파일이 각 마커 자신의 대체 참조를 담기 때문입니다.
messagestring아니요표시를 만난 소비자에게 전달되는 내용입니다. from과 함께 쓰면 거부됩니다. 그 배치 파일이 각 표시 자신의 메시지를 담기 때문입니다.
fromstring아니요철회 항목으로 이루어진 배치 파일로, 워크스페이스 루트 기준 상대 경로로 지정하며 항목마다 하나의 마커를 붙입니다. 각 항목은 자신의 참조, 심각도, 사유를 담고, 선택적으로 대체 참조와 메시지를 담습니다. reference의 대안이며, 둘 다 담은 요청이나 이와 함께 심각도, 사유, 대체 참조 또는 메시지를 담은 요청은 거부됩니다.
fulcioUrlstring아니요서명 인증서를 발급받을 인증 기관입니다.
rekorUrlstring아니요서명을 기록할 투명성 로그입니다.
timestampUrlstring아니요연서명에 사용할 타임스탬프 기관입니다.
identityTokenstring아니요서명에 사용할 신원 토큰으로, 터미널에서 얻는 대신 호출자가 제공합니다.

추가 속성은 허용되지 않습니다.

ResolveParams

커서 아래에 있는 대상이 어디에 정의되어 있는지 응답합니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
uristring아니요커서가 위치한 문서입니다.
positionPosition아니요문서 안의 한 위치로, 줄과 그 줄 안의 문자 오프셋이며 둘 다 0부터 셉니다. 오프셋은 세션이 열릴 때 합의한 인코딩의 단위로 측정되며, 클라이언트가 다른 인코딩을 요청하지 않으면 UTF-16입니다.
releasestring아니요응답의 기준이 되는 Release로, 워크스페이스 루트에 대한 상대 경로입니다. 이 경우 정의는 워크스페이스 구성이 그 Release에 지정하는 카탈로그 디렉터리를 그 순서대로 거쳐 참조가 해석되는 문서입니다. 따라서 한 워크스페이스의 여러 변형이 Release마다 하나씩 선언하는 이름은 그 Release의 변형으로 이동합니다. 그 디렉터리들이 해당 엔터티를 선언하지 않으면 워크스페이스의 문서를 검색하되, Release가 읽지 않는 워크스페이스 카탈로그 디렉터리 아래의 문서는 제외합니다. 생략하면 워크스페이스의 문서를 먼저 검색하고, 어떤 문서도 그 이름을 선언하지 않을 때에만 워크스페이스 자체의 카탈로그 디렉터리를 검색합니다. Release 파일을 가리키지 않는 값은 거부됩니다.

추가 속성은 허용되지 않습니다.

FindReferencesParams

커서 아래에 있는 대상이 어디에서 참조되는지 응답합니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
uristring아니요커서가 위치한 문서입니다.
positionPosition아니요문서 안의 한 위치로, 줄과 그 줄 안의 문자 오프셋이며 둘 다 0부터 셉니다. 오프셋은 세션이 열릴 때 합의한 인코딩의 단위로 측정되며, 클라이언트가 다른 인코딩을 요청하지 않으면 UTF-16입니다.
releasestring아니요응답의 기준이 되는 Release로, 워크스페이스 루트에 대한 상대 경로입니다. 이 경우 Release가 읽지 않는 워크스페이스 카탈로그 디렉터리 아래의 문서에서 이루어진 참조는 보고되지 않으므로, 워크스페이스가 Release마다 하나씩 나란히 두는 변형들은 서로의 참조로 보고되지 않습니다. 생략하면 모든 워크스페이스 문서를 검색합니다. Release 파일을 가리키지 않는 값은 거부됩니다.

추가 속성은 허용되지 않습니다.

FindImplementationsParams

커서 아래에 있는 대상을 어떤 문서가 구현하는지 응답합니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
uristring아니요커서가 위치한 문서입니다.
positionPosition아니요문서 안의 한 위치로, 줄과 그 줄 안의 문자 오프셋이며 둘 다 0부터 셉니다. 오프셋은 세션이 열릴 때 합의한 인코딩의 단위로 측정되며, 클라이언트가 다른 인코딩을 요청하지 않으면 UTF-16입니다.
releasestring아니요응답의 기준이 되는 Release로, 워크스페이스 루트에 대한 상대 경로입니다. 이 경우 Release가 읽지 않는 워크스페이스 카탈로그 디렉터리 아래의 문서는 보고되지 않으므로, 다른 Release가 빌드에 사용하는 변형은 이 Release의 구현 목록에 포함되지 않습니다. 생략하면 모든 워크스페이스 문서를 검색합니다. Release 파일을 가리키지 않는 값은 거부됩니다.

추가 속성은 허용되지 않습니다.

HoverParams

커서 아래에 있는 대상에 대해 표시할 내용을 응답합니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
uristring아니요커서가 위치한 문서입니다.
positionPosition아니요문서 안의 한 위치로, 줄과 그 줄 안의 문자 오프셋이며 둘 다 0부터 셉니다. 오프셋은 세션이 열릴 때 합의한 인코딩의 단위로 측정되며, 클라이언트가 다른 인코딩을 요청하지 않으면 UTF-16입니다.
releasestring아니요응답의 기준이 되는 Release로, 워크스페이스 루트에 대한 상대 경로입니다. 이 경우 표시되는 엔터티는 워크스페이스 구성이 그 Release에 지정하는 카탈로그 디렉터리를 그 순서대로 거쳐 참조가 해석되는 엔터티입니다. 그 디렉터리들이 해당 엔터티를 선언하지 않으면 워크스페이스의 문서를 검색하되, Release가 읽지 않는 워크스페이스 카탈로그 디렉터리 아래의 문서는 제외합니다. 생략하면 워크스페이스의 문서를 먼저 검색하고, 어떤 문서도 그 이름을 선언하지 않을 때에만 워크스페이스 자체의 카탈로그 디렉터리를 검색합니다. Release 파일을 가리키지 않는 값은 거부됩니다.

추가 속성은 허용되지 않습니다.

CompletionParams

커서 위치에 작성할 수 있는 내용을 응답합니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
uristring아니요커서가 위치한 문서입니다.
positionPosition아니요문서 안의 한 위치로, 줄과 그 줄 안의 문자 오프셋이며 둘 다 0부터 셉니다. 오프셋은 세션이 열릴 때 합의한 인코딩의 단위로 측정되며, 클라이언트가 다른 인코딩을 요청하지 않으면 UTF-16입니다.
contextCompletionContext아니요클라이언트가 추적하는 경우, 요청을 일으킨 원인입니다.
releasestring아니요응답의 기준이 되는 Release로, 워크스페이스 루트에 대한 상대 경로입니다. 이 경우 제시되는 이름은 워크스페이스의 문서가 선언하는 이름에서 Release가 읽지 않는 워크스페이스 카탈로그 디렉터리 아래의 문서를 뺀 것과, 워크스페이스 구성이 그 Release에 지정하는 카탈로그 디렉터리가 선언하는 Components와 Features입니다. 생략하면 워크스페이스의 문서와 워크스페이스 자체의 카탈로그 디렉터리가 선언하는 Components와 Features입니다. Release 파일을 가리키지 않는 값은 거부됩니다.

추가 속성은 허용되지 않습니다.

CompletionContext

클라이언트가 추적하는 경우, 요청을 일으킨 원인입니다.

속성타입필수설명
triggerKindinteger아니요완성이 요청된 이유입니다.
triggerCharacterstring아니요문자로 인해 요청된 경우, 그 원인이 된 문자입니다.

추가 속성이 허용됩니다.

AttachCandidatesParams

엔터티의 레이블을 기준으로 판단하여 해당 엔터티에 어떤 Features를 부착할 수 있는지, 그리고 그래프 노드의 컴포넌트가 그리는 하나의 연결에 대해 그 연결의 소켓이 선언하는 각 슬롯을 어떤 것이 채울 수 있는지 답합니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
nodestring아니요후보를 판단할 기준이 되는 엔터티로, 이름으로 지정하며 워크스페이스 문서가 선언하는 내용에서 읽습니다.
graphNodestring아니요후보를 판단할 기준이 되는 그래프 노드로, 그 레이블은 빌드 자체가 적용 가능성을 평가할 때 사용하는 확정된 집합입니다. 이를 기준으로 계산된 답은 빌드가 실제로 수행할 내용을 나타냅니다.
releasestring아니요노드가 속한 그래프의 Release로, 워크스페이스 루트에 대한 상대 경로로 지정합니다. 이 경우 후보는 해당 Release의 관점에서 도출됩니다. 즉 워크스페이스 구성이 해당 Release에 부여하는 카탈로그 디렉터리가 선언하는 Features와, 워크스페이스의 카탈로그 디렉터리 중 해당 Release가 읽지 않는 디렉터리 아래의 문서를 제외한 워크스페이스 문서에서 도출되므로, 다른 Release용으로 유지되는 Feature는 이 Release 그래프의 노드에 결코 제시되지 않습니다.
labelsstring 맵아니요엔터티나 그래프 노드에서 읽는 대신 직접 판단 기준으로 사용할 레이블입니다.
connectionConnectionCoordinate아니요graphNode가 지정하는 노드의 컴포넌트가 그리는 하나의 연결로, 해당 노드와 함께 이 연결에 대해서도 답합니다. 이 경우 답에는 slots도 포함되며, 이는 연결의 소켓이 선언하는 각 슬롯과 그 슬롯을 채울 수 있는 Features이고, 채울 수 있는 슬롯이 없으면 noSlotReason이 포함됩니다. 연결은 컴파일된 그래프에만 존재하므로 이 값은 graphNode 및 release와 함께만 보내며, node나 labels와 함께 보내면 거부됩니다. 함께 있는 candidates는 그 의미를 유지하며, 노드 자체에 부착할 수 있는 Features를 나타냅니다. 이 값의 document는 허용되지만 이 답을 바꾸지 않습니다. 슬롯은 소켓의 것이고 후보는 Features의 것이므로, 부착이 어느 문서에 작성되든 동일합니다.

추가 속성은 허용되지 않습니다.

ConnectionCandidatesParams

엔터티의 소켓을 어떤 엔터티에 연결할 수 있는지 답합니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
nodestring아니요소켓에 대해 질의하는 대상 엔터티입니다.
socketstring아니요답할 대상인 하나의 소켓입니다. 생략하면 엔터티가 선언하는 모든 소켓에 대해 답합니다.

추가 속성은 허용되지 않습니다.

InsertionPointParams

이름이 지정된 컨테이너 아래의 새 항목이 문서의 어디에 들어가야 하는지 답하며, 항목을 작성하고 적용하는 일은 버퍼를 소유한 호출자에게 맡깁니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
filestring아니요답할 대상 문서입니다.
containerstring[]아니요문서 안에서 항목이 들어갈 컨테이너까지의 경로입니다.

추가 속성은 허용되지 않습니다.

AttachmentContainerParams

그래프 노드, 또는 그 컴포넌트가 그리는 하나의 연결에 대한 부착이 어느 문서의 어느 위치에 들어가야 하는지 답합니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
graphNodestring아니요부착의 대상인 그래프 노드입니다.
releasestring아니요노드가 속한 그래프의 Release로, 워크스페이스 루트에 대한 상대 경로로 지정합니다.
connectionConnectionCoordinate아니요부착이 노드가 아니라 연결에 대한 것일 때, 그래프 노드의 컴포넌트가 그리는 하나의 연결입니다. 이 경우 답은 이 값의 document 필드가 지정하는 문서에서 연결 자체의 features 컨테이너를 지정하며, 여기서는 이 필드가 필수입니다. Aggregate에서는 노드가 작성된 문서 안의 연결 항목이며, Release가 그린 연결은 Aggregate에 해당 항목이 없으므로 거부됩니다. Release에서는 노드에 대한 Release 자체 항목 아래의 에지별 항목이며, Release가 아직 그 연결에 대한 항목을 작성했는지와 관계없이 그렇고, Release가 노드에 대한 항목을 작성하지 않은 경우에는 거부됩니다. Feature가 그린 연결은 어느 문서에서든 거부되는데, 부착은 컴포넌트나 Release가 그린 연결에만 작성되기 때문입니다.

추가 속성은 허용되지 않습니다.

ConnectionAtPositionParams

Aggregate나 Release 안의 위치가 어느 연결의 항목 안에 속하는지 답합니다. 즉 후보 및 컨테이너 요청이 받는 형태의 그래프 노드와 연결을 답하거나, 그곳에 연결이 작성되지 않은 이유를 답합니다. 대상 항목은 부착이 작성되는 항목으로, 컴포넌트가 작성된 문서 안에서 연결의 별칭 아래에 컴포넌트가 연결을 그리는 항목과 Release가 작성하는 모든 에지별 항목이며, 각각 컴파일된 그래프가 기록한 위치에 있으므로 키가 연결인지 여부는 그 이름으로부터 판단되지 않습니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
filestring아니요위치가 속한 문서로, Release이거나 Release의 그래프가 컴포넌트가 작성된 곳으로 기록하는 문서, 즉 그 Aggregate 또는 해당 Aggregate가 가져오는 모듈의 문서입니다. 먼저 세션이 이 문서에 대해 보유한 내용에서 읽고, 없으면 디스크에서 읽습니다.
positionPosition아니요문서 안의 한 위치로, 줄과 그 줄 안의 문자 오프셋이며 둘 다 0부터 셉니다. 오프셋은 세션이 열릴 때 합의한 인코딩의 단위로 측정되며, 클라이언트가 다른 인코딩을 요청하지 않으면 UTF-16입니다.
releasestring아니요컴파일된 그래프가 연결을 기록하는 Release로, 워크스페이스 루트에 대한 상대 경로로 지정합니다. 그래프 노드와 연결은 컴파일된 그래프에만 존재하므로 Aggregate 안의 위치에 대해서도 필요합니다.

추가 속성은 허용되지 않습니다.

ConnectionCoordinate

그래프 노드의 component가 그리는 하나의 연결로, 연결이 거쳐 배선되는 소켓과 그 소켓 안에서 연결이 가지는 별칭, 그리고 연결에 대한 첨부가 작성되는 문서로 지정됩니다. 연결은 그 소켓이 선언하는 슬롯을 채우는 첨부를 가지며, 이 첨부는 Aggregate와 Release 중 어느 쪽에서든 작성할 수 있습니다.

속성타입필수설명
socketstring예연결이 거쳐 배선되는 의존성 소켓입니다.
aliasstring예연결이 그 소켓 안에서 가지는 이름입니다.
documentconst “aggregate” 또는 const “release”아니요연결에 대한 첨부가 작성되는 문서입니다. 이 집합은 닫혀 있으며, 집합 밖의 값은 거부됩니다. 허용되는 값: "aggregate" — Aggregate. 개발자가 연결의 항목에 첨부를 작성합니다. "release" — Release. 운영자가 해당 연결의 엣지별 항목에 첨부를 작성합니다.

추가 속성이 허용됩니다.

SetActiveReleaseParams

.aggrega 디렉터리에 마커를 기록하여 Release를 워크스페이스의 기본값으로 기록합니다. aggrega/activeRelease가 보고하는 선택은 구성의 작성용 Release 다음으로 이 마커를 읽습니다. 마커는 워크스페이스 안에만 기록되며 다른 곳에는 기록되지 않습니다. .aggrega 디렉터리나 마커가 워크스페이스 밖으로 이어지는 링크인 경우, 그 링크가 가리키는 곳이 아직 존재하는지와 관계없이 쓰기는 해당 링크를 명시하며 거부되고 아무것도 기록되지 않습니다. 응답은 마커가 기록된 후 aggrega/activeRelease가 제공하는 응답과 같으므로, 구성의 작성용 Release가 마커보다 우선하는 경우에는 다른 Release를 가리킵니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
releasestring아니요기록할 Release로, 워크스페이스 루트에 대한 상대 경로입니다. 절대 경로와 워크스페이스 밖으로 올라가는 경로는 거부됩니다. 링크를 통해 워크스페이스 밖으로 이어지는 경로도 워크스페이스 구성이 해당 Release를 지정하지 않는 한 거부됩니다.

추가 속성은 허용되지 않습니다.

EditDocumentParams

워크스페이스가 가진 문서에 범위가 한정된 편집 하나를 적용합니다. 하나의 컨테이너 아래에 항목 하나를 추가하거나, 스칼라 하나를 설정합니다. 구성된 문서는 해당 kind의 스키마에 대해 검사되며, 검사를 통과한 경우에만 디스크에 기록되므로 작성용 스키마가 거부하는 내용은 기록할 수 없습니다. 거부된 편집은 파일을 바이트 단위로 원래 상태 그대로 둡니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
filestring아니요편집할 문서입니다.
editconst “add-component” 또는 const “attach-feature” 또는 const “wire-edge” 또는 const “set-value”아니요적용할 편집입니다. 허용되는 값: "add-component" — components 컨테이너 아래에 컴포넌트 인스턴스를 추가합니다. name은 인스턴스 이름이고 value는 요청하는 Component입니다. "attach-feature" — 요청이 지정한 노드에 Feature를 연결합니다. name은 첨부의 인스턴스 이름이고 value는 요청하는 Feature입니다. "wire-edge" — 요청이 지정한 노드에서 socket 안에 의존성 연결을 배선합니다. name은 연결을 가리키는 별칭이고 value는 연결이 가리키는 노드입니다. "set-value" — 요청이 지정한 노드에 값 하나를 설정합니다. name은 값의 키이고 value는 스칼라입니다.
nodestring[]아니요편집 대상 항목까지 문서를 거쳐 가는 경로입니다.
socketstring아니요소켓을 배선하는 편집의 경우, 편집 대상인 소켓입니다.
namestring아니요편집이 기록하는 이름입니다.
valueany아니요편집이 기록하는 값으로, 편집이 취하는 형태를 따릅니다.
dryRun불리언아니요구성된 문서를 기록하는 대신 응답으로 돌려줄지 여부입니다.

추가 속성은 허용되지 않습니다.

ConfigInitParams

구성 문서를 초기 생성합니다. 레지스트리와 그 레지스트리에서 신뢰하는 ID는 머신 전역 도구이므로, 기본적으로 머신 전역 파일에 기록합니다. 지정된 레지스트리에 접속하여 그 레지스트리가 공시하는 신뢰 정책을 읽습니다. 아무것도 공시하지 않는 레지스트리는 그렇다고 보고되며 초기 생성은 계속 진행됩니다. 공식 허브에는 내장 기준선이, 그 밖의 레지스트리에는 정책 없음이 적용됩니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
registrystring아니요구성을 초기 생성할 대상 레지스트리입니다.
force불리언아니요이미 존재하는 구성 문서를 덮어쓸지 여부입니다.
global불리언아니요머신 전역 구성 파일에 씁니다. 이 메서드의 기본 동작입니다.
workspace불리언아니요머신 전역 구성 파일 대신 이 워크스페이스 자체의 구성 파일에 씁니다.
dryRun불리언아니요자체 문서 모델을 유지하는 클라이언트를 위해, 문서를 기록하는 대신 그 내용을 응답으로 돌려줄지 여부입니다.

추가 속성은 허용되지 않습니다.

ConfigCaptureParams

해석된 구성을 이 워크스페이스 자체의 문서에 고정하여 워크스페이스가 자기 완결적이 되도록 합니다. 항상 해당 워크스페이스의 파일에 기록하며, 그 밖의 어떤 곳에도 접근하지 않습니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
allPlugins불리언아니요워크스페이스 자체가 구성한 플러그인만이 아니라 연결된 모든 플러그인을 고정할지 여부입니다.

추가 속성은 허용되지 않습니다.

ImportParams

외부 소스 기술을 초안 작성 문서로 변환하고, 그 옆에 .aggrega-import.json을 씁니다. 이 파일은 가져오기가 쓴 내용의 기록으로, 주어진 대상(주어진 경우), 읽은 카탈로그 스냅샷(읽은 경우), 초안으로 작성된 각 파일, 초안으로 작성된 Aggregate 또는 Release의 모든 깊이에 있는 각 키를 담으며, 이후의 sync가 이를 읽습니다. 완전히 변환하지 못한 소스는 실패가 아니라 응답입니다. 생성된 초안은 기록되고, 검사 결과가 변환하지 못한 부분을 알려 줍니다. 단, sync에서는 예외로, 중단된 변환으로부터는 아무것도 쓰지 않습니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
sourcestring아니요변환할 파일 또는 디렉터리로, 절대 경로 또는 워크스페이스 루트 기준 상대 경로입니다. 이 값이 없는 요청은 거부됩니다. 워크스페이스 안이든 밖이든 있는 위치에서 읽히며, 디렉터리는 임포터가 선언한 파일 패턴이 선택하는 그 안의 파일들로 읽힙니다.
outputDirstring아니요초안을 쓸 워크스페이스 아래의 디렉터리로, 워크스페이스 루트 기준 상대 경로입니다. 절대 값이나, 쓰인 그대로 또는 링크를 통해 워크스페이스 밖으로 나가는 값은 거부됩니다. 생략하면 워크스페이스 루트 아래에 쓰며, 이는 터미널에서 대상을 지정하지 않고 같은 변환을 실행했을 때 쓰는 위치와 같습니다. 초안으로 작성된 모든 경로는 dryRun에서도 응답이 outputDir로 지정하는 디렉터리를 기준으로 한 상대 경로입니다.
formatstring아니요소스 형식입니다. 생략하면 변환이 이를 판별합니다.
targetstring아니요초안 옆에 manifest.yaml로 Manifest 초안을 작성할 대상인 provider 기능(예: compose 또는 helm, 즉 Recipe의 spec.capability가 바인딩하는 단어)입니다. 초안에 필요한 각 component 타입과 feature 타입은, 초안으로 작성된 Aggregate가 구성하는 카탈로그 Aggregate의 타입을 포함하여, 워크스페이스의 카탈로그가 그 타입에 대해 제공하는 해당 기능의 Recipe 또는 feature 레시피에 매핑됩니다. 하나만 있으면 그것이, 여러 개 있으면 그 타입의 이름을 딴 것이 선택됩니다. 하나도 없거나, 여러 개 있지만 그렇게 이름 붙은 것이 없는 타입은 매핑되지 않은 채 그 타입을 지명하는 경고 검사 결과와 함께 남습니다. 임포터가 직접 초안으로 작성한 매핑은 카탈로그가 해당 타입과 기능에 대해 그것을 제공하는 경우 유지되고, 그렇지 않으면 경고 검사 결과와 함께 제거됩니다. 초안으로 작성된 Release의 spec.manifest는 해당 Manifest로 설정됩니다. 카탈로그의 어떤 Recipe도 바인딩하지 않는 기능은 변환이 실행되기 전에 거부되며 아무것도 쓰이지 않습니다. 생략하면 Manifest 초안을 작성하지 않습니다. 단, sync에서는 이전 가져오기의 기록이 지정하는 대상에 대해 초안을 작성합니다. 대상을 지정한 sync는 그 대상에 대해 초안을 작성하며, 이후 기록이 그 대상을 지정합니다.
dryRun불리언아니요요청이 쓸 모든 파일을 쓰는 대신 그 내용으로 응답할지 여부입니다. 그 밖의 모든 동작은 쓰기와 같으므로, 쓰기에서 거부될 요청은 이 경우에도 거부됩니다. sync와 함께 쓰면 sync가 쓸 내용과 어긋날 모든 부분으로 응답합니다.
sync불리언아니요초안 전체를 쓰는 대신, 이전 가져오기가 outputDir 아래에 초안으로 작성한 내용을 소스에 맞게 갱신할지 여부입니다. 초안 옆의 기록이 나열하는 대로, 가져오기가 쓴 것만 변경됩니다. 소스가 변경하지 않은 부분은 편집 여부와 관계없이 디스크에 있는 그대로 유지됩니다. 소스가 변경하거나 삭제하거나 추가한 부분은, 디스크에 있는 것이 가져오기가 마지막으로 쓴 것일 때 새로 쓰이거나, 제거되거나(초안 파일은 통째로 삭제됨), 추가됩니다. 그 밖의 모든 것, 즉 작성자가 추가한 키(초안으로 작성된 Release가 작성자에게 남겨 두는 environment 포함)나 초안 키 바로 위에 쓰이지 않은 주석은 바이트 단위로 그대로 유지됩니다. 작성자가 편집하거나 추가한 것을 변경 또는 제거하거나, 작성자가 이미 쓴 부분에 부분을 추가하게 될 sync는 각 부분을 지명하며 거부되고, 어떤 기록에도 나열되지 않은 Aggregate에 대한 sync도 거부됩니다. 어느 경우든 아무것도 쓰이지 않습니다. 이 값이 없으면, 초안이 outputDir에 이미 있는 Aggregate 위에 쓰이게 될 요청은 dryRun에서도 거부됩니다.
upgrade불리언아니요작업 공간의 기본 레지스트리가 게시하는 최신 카탈로그 스냅샷을 가져와 그에 대해 가져오기를 수행하고, 이후 작업 공간이 보유한 스냅샷이나 초안 옆의 기록이 지정하는 스냅샷 대신 그것을 보관할지 여부입니다. 작업 공간이 카탈로그 폴더를 지정하면 아무것도 바꾸지 않으며, 오프라인에서는 거부됩니다.
answersstring아니요초안이 비워 두고 어떤 소스도 담을 수 없는 값을 읽어 오고 기록하는 답변 파일로, 워크스페이스 루트를 기준으로 한 상대 경로입니다. 절대 경로 값이나, 작성된 그대로 또는 링크를 통해 워크스페이스 밖으로 나가는 값은 거부됩니다. 이 파일은 초안으로 작성된 각 파일의 경로 아래에 해당 문서 내 키 경로와 그 답변을 담으며, 답변은 초안에 기록됩니다. 생략하면 초안 옆의 기록이 지정하는 파일을 읽고, 그렇지 않으면 소스 파일 옆이나 소스 디렉터리 안의 import-answers.yaml을 읽습니다. 시크릿의 답변은 시크릿의 출처, 즉 변수 이름, ${NAME} 또는 Kubernetes Secret의 이름을 지정하며, 그 밖의 것은 거부되고 아무것도 기록되지 않습니다. 아무것도 묻지 않습니다. 아직 필요한 각 값은 응답의 owed의 항목이자 초안 파일, 키, 그리고 그것이 무엇인지를 지명하는 경고 검사 결과가 되고, 그 답변은 answered로 보내지며, 초안이 기록되는 경우 마지막 검사 결과가 몇 개가 필요하고 어디에 있는지 알려 줍니다. 초안에 Release가 포함되어 있고, 필요한 값이 없으며, 변환이 완료된 경우에는 이어서 그 종속성을 풀하여 잠금 파일을 기록하며, 풀이 실패하면 그 이유를 알리는 검사 결과로 검사 결과를 마무리하고 초안은 기록된 상태로 남습니다. 오프라인에서는 아무것도 풀하지 않으며 실행할 풀을 지명하는 검사 결과가 나옵니다. 이 초안이 비워 두지 않는 키에 대한 답변은 파일에 유지되지만 적용되지 않으므로, 하나의 답변 파일로 모든 타깃에 대응할 수 있습니다.
answeredImportAnswered[]아니요응답의 owed가 나열한 값에 대한 답변으로, 각각 초안 파일과 owed가 지명한 대로의 키를 지명합니다. 각 답변은 터미널에서 입력한 답변과 똑같이 판정되고, 답변 파일에 유지되며, 초안에 기록됩니다. 시크릿의 답변은 시크릿의 출처, 즉 변수 이름, ${NAME} 또는 Kubernetes Secret의 이름을 지정하며, 그렇지 않은 답변은 유지되지도 기록되지도 않고, 그 값은 이유를 secretAdvice로 가진 채 아직 필요한 값으로 남습니다. 답변 파일이 이미 답한 값은 그 파일에서 답을 받습니다. 빈 답변이나, 초안에 필요하지 않은 값을 지명하는 답변은 적용되지 않습니다. outputDir에 이미 있는 Aggregate에 대해서는 sync가 아닌 요청이 거부되므로, 초안이 기록된 뒤 sync와 함께 보내십시오. 답변을 유지하지 않는 dryRun에서, 그리고 변환이 중단되어 아무것도 기록하지 않는 sync에서는 보낸 답변이 적용되지 않습니다.

추가 속성은 허용되지 않습니다.

ScaffoldEntityParams

엔티티 종류에 대한 시작용 문서의 초안을 작성하거나, 문서의 실행 가능한 예제 중 하나를 워크스페이스의 새 디렉터리에 기록하거나, 예제를 나열합니다. 초안 작성은 바이너리가 지닌 스키마 세트에서 골격을 도출하므로, 워크스페이스에서 아무것도 읽지 않고 아무것도 기록하지 않습니다. 응답은 텍스트이며, 그것을 어디에 둘지는 클라이언트가 정합니다. 예제 기록은 새 디렉터리만 기록하고 그 밖에는 아무것도 기록하지 않으며, 예제는 바이너리의 버전용으로 게시된 서명된 문서 번들에서, 또는 그것이 없으면 그 이전에 게시된 최신 번들에서 읽고, 이 번들은 보관하거나 읽기 전에 워크스페이스의 서명 정책에 따라 검증합니다. 검증되지 않는 번들은 거부되며, 오프라인에서는 이미 캐시된 사본만 읽습니다. 두 형식의 필드를 함께 보내는 요청(kind와 example 또는 list, list와 example, name과 example 또는 list, example 없는 dir)은 아무것도 읽기 전에 거부됩니다.

속성타입필수설명
workspaceRootstring아니요워크스페이스의 절대 경로입니다. 초안 작성은 이를 읽지 않습니다. 예제를 기록하거나 나열하려면 이것이 필요합니다. 워크스페이스의 구성이 문서를 어디에서 가져올지와 문서가 지녀야 할 서명을 결정하며, 예제는 워크스페이스 안에 기록됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
kindstring아니요초안을 작성할 엔터티 종류로, component, aggregate, release, recipe, featurerecipe와 같은 소문자 토큰으로 지정합니다. 이는 aggrega/getSchema가 해당 종류에 대해 나열하는 토큰입니다.
namestring아니요초안 문서에 쓸 이름입니다. kind와 함께만 보냅니다.
examplestring아니요기록할 실행 가능한 예제로, 예제 목록이 부여한 이름으로 지정합니다. kind 대신 보냅니다.
list불리언아니요아무것도 기록하지 않고, 문서가 게시하는 모든 실행 가능한 예제로 응답할지 여부입니다. example도 kind도 없이 보냅니다.
dirstring아니요예제를 기록할 새 디렉터리로, 워크스페이스 루트에 대한 상대 경로입니다. 없으면 그곳에 예제 이름을 딴 디렉터리에 기록합니다. 이 디렉터리는 아직 존재하지 않거나 비어 있어야 합니다. 무엇이든 담고 있는 디렉터리는 거부되고 그대로 남으며, 절대 값이나, 쓰인 그대로 또는 링크를 통해 워크스페이스 밖으로 나가는 값은 아무것도 읽기 전에 거부됩니다. example과 함께만 보냅니다.

추가 속성은 허용되지 않습니다.

LintParams

하나의 엔터티, Release의 클로저가 도달하는 모든 것, 또는 구성된 카탈로그 디렉터리 아래의 모든 것에 대해 카탈로그 게시 관례를 검사합니다. 어떤 모드에서도 아무것도 쓰이지 않습니다. 엔터티도 Release도 지정하지 않으면 카탈로그 전체를 검사합니다. 구성이 Release 자체의 카탈로그 디렉터리를 지정하지 않는 워크스페이스에서는 워크스페이스의 디렉터리에 대해 한 번 검사하고, workspace.releases 아래에 Releases를 지정하는 워크스페이스에서는 각 Release마다 그 Release가 읽는 디렉터리에 대해 한 번씩 검사하며, 모든 디렉터리를 한꺼번에 검사하지는 않습니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
entitystring아니요검사할 하나의 엔터티 문서입니다.
releasestring아니요클로저를 검사할 Release로, 워크스페이스 루트 기준 상대 경로입니다.
prePublish불리언아니요각 엔터티를 이전에 게시된 버전과 비교할지 여부로, 이 경우 구성된 레지스트리에 접근합니다.

추가 속성은 허용되지 않습니다.

PluginAddParams

워크스페이스가 구성하는 소켓에 플러그인을 연결합니다. 쿼리를 하나의 플러그인으로 해석하고 버전을 고정하기 위해 레지스트리에 접근합니다. 터미널이라면 사용자에게 받았을 유일한 결정, 즉 명령 확장 플러그인이 선언한 기능을 수락할지 여부는 여기서 필드로 전달되므로, 클라이언트가 자신을 구동하는 주체에게 묻고 이 인터페이스는 프롬프트를 기다리지 않습니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
typestring아니요플러그인이 연결될 소켓입니다.
querystring아니요하나의 플러그인으로 해석할 대상입니다.
capabilitystring아니요소켓이 여러 기능을 지니는 경우, 이 연결이 해당하는 기능입니다.
rolestring아니요연결이 실행되는 역할로, 연결이 내보낼 수 있는 것을 결정합니다.
global불리언아니요머신 전체 구성 파일에 씁니다.
workspace불리언아니요이 워크스페이스 자체의 구성 파일에 씁니다.
acceptCapabilities불리언아니요호출자가 명령 확장 플러그인이 선언한 기능을 수락하는지 여부입니다.
dryRun불리언아니요구성 문서를 쓰는 대신 그 내용으로 응답할지 여부입니다.

추가 속성은 허용되지 않습니다.

PluginRemoveParams

워크스페이스가 구성하는 소켓에서 플러그인을 분리합니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
typestring아니요플러그인이 연결되어 있는 소켓입니다.
querystring아니요제거할 연결입니다.
global불리언아니요머신 전체 구성 파일에 씁니다.
workspace불리언아니요이 워크스페이스 자체의 구성 파일에 씁니다.

추가 속성은 허용되지 않습니다.

PluginSyncParams

Plugin 엔티티의 머신 소유 레코드를 그 엔티티가 가리키는 모듈과 일치시킵니다. 해당 레코드를 다시 쓰고, 문서의 나머지 모든 바이트는 변경 없이 유지합니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
entitystring아니요일치시킬 Plugin 엔티티 문서입니다.
pluginstring아니요레코드를 읽어 올 플러그인 모듈입니다.

추가 속성은 허용되지 않습니다.

PluginGenCatalogParams

플러그인 자체가 선언한 메타데이터와 작성된 오버레이로부터 Plugin 카탈로그 문서를 생성합니다. 입력이 변경되지 않은 상태에서 다시 생성하면 바이트 단위로 동일한 문서가 만들어집니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
fromEmbedded불리언아니요바이너리가 이미 담고 있는 플러그인에서 메타데이터를 읽을지 여부입니다.
pluginstring아니요메타데이터를 읽어 올 플러그인 모듈입니다.
outputDirstring아니요문서를 쓸 워크스페이스 아래의 디렉터리입니다.
overlaystring아니요생성된 메타데이터 위에 내용이 병합되는 작성된 문서입니다.
dryRun불리언아니요문서를 쓰는 대신 그 내용으로 응답할지 여부입니다.

추가 속성은 허용되지 않습니다.

ExplainErrorParams

발견 사항이 담고 있던 코드를, 컴파일러가 해당 조건에 대해 선언하는 내용과 작성 시 수정 방법을 알려 주는 게시된 항목으로 확장합니다. 워크스페이스에 사본이 없으면 게시된 문서를 가져오며, 가져오지 못한 경우에도 바이너리가 선언하는 내용으로 응답하고 설명 문서가 없는 이유를 알려 줍니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
codestring아니요확장할 조건으로, 발견 사항이 담고 있던 코드 또는 그 짧은 코드로 지정합니다.

추가 속성은 허용되지 않습니다.

GetSchemaParams

종류의 스키마로 응답하거나, 종류를 지정하지 않은 경우 지정할 수 있는 종류로 응답합니다. 다른 곳에 설치된 사본이 아니라 실행 중인 바이너리에 대해 응답하므로, 워크스페이스가 필요 없으며 워크스페이스를 읽지도 않습니다.

속성타입필수설명
workspaceRootWorkspaceRootAccepted아니요워크스페이스의 절대 경로입니다. 이 메서드의 대상은 워크스페이스가 아니므로(바이너리 자체가 담고 있는 내용으로 답합니다), 이 필드는 허용되지만 읽히지 않습니다. 클라이언트가 어떤 메서드가 이 필드를 참조하는지 알 필요 없이 모든 요청에 일관되게 보낼 수 있도록 허용됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
kindstring아니요스키마로 응답할 종류입니다. 생략하면 대신 지정할 수 있는 종류로 응답합니다.

추가 속성은 허용되지 않습니다.

SkillsInstallParams

바이너리에 내장된 어시스턴트 스킬을 요청이 지정한 각 어시스턴트의 스킬 폴더에, 또는 아무것도 지정하지 않은 global 요청이라면 이 머신에서 발견된 각 어시스턴트의 스킬 폴더에 기록합니다. global이 없으면 요청이 지정한 워크스페이스 안에 있는 각 어시스턴트의 프로젝트 폴더에 기록하며, 그곳에 기록할 모든 경로는 해당 워크스페이스 안으로 제한됩니다. global이 있으면 홈 디렉터리 아래에 있는 각 어시스턴트의 사용자별 폴더에 기록합니다. 무엇이든 기록하기 전에 모든 대상을 확인하므로, 거부되면 모든 폴더가 그대로 유지됩니다.

속성타입필수설명
workspaceRootWorkspaceRootSubject예이 요청이 대상으로 하는 워크스페이스의 절대 경로입니다. 이는 요청의 대상입니다. 데몬은 메서드가 실행되기 전에 이를 해석하며, 이를 생략하거나 문자열이 아닌 형태로 쓴 요청은 거부됩니다.
workDoneTokenProgressToken아니요호출자가 진행 알림을 그 알림을 요청한 호출과 대응시키기 위해 생성하는 값입니다. 모든 알림에 변경 없이 되돌려지므로, 호출자는 이를 자신이 보낸 값과 비교할 수 있습니다. 모든 요청에서 허용되며, 진행 기능을 선언하지 않은 세션에서 이 값을 보내는 요청은 거부됩니다.
agentsstring[]아니요스킬을 설치할 어시스턴트로, 목록이 보고하는 식별자로 지정합니다. 아무것도 지정하지 않은 프로젝트 요청은 거부됩니다. 아무것도 지정하지 않은 global 요청은 이 머신에서 발견된 어시스턴트, 즉 구성 폴더가 홈 디렉터리에 있거나 명령이 PATH에 있는 각 어시스턴트에 스킬을 설치하며, 하나도 발견되지 않으면 아무것도 기록하지 않고 거부됩니다. 알려진 스킬 폴더가 없는 식별자는 이름을 밝혀 거부되며, 두 번 지정된 식별자는 한 번만 설치됩니다.
global불리언아니요워크스페이스의 프로젝트 폴더 대신, 어시스턴트가 모든 프로젝트에서 읽는 홈 디렉터리 아래의 사용자별 스킬 폴더에 기록합니다.

추가 속성은 허용되지 않습니다.

ServerCapabilities

클라이언트가 처리할 수 있다고 밝힌 내용에 맞춰 결정된, 이 세션에서 데몬이 수행할 내용입니다.

속성타입필수설명
positionEncodingstring예이 세션의 모든 위치가 표현되는 인코딩입니다.
workDoneProgress불리언아니요이 세션에서 데몬이 진행 알림을 보낼지 여부입니다. 클라이언트가 진행 알림을 받을 수 있다고 선언한 경우에만 존재합니다.

추가 속성은 허용되지 않습니다.

ClosureEntity

Release가 의존하는 하나의 엔터티로, 해석이 확정한 버전을 가집니다.

속성타입필수설명
uristring예엔터티가 해석되는 출처 참조입니다.
versionstring예확정된 버전입니다.
kindstring아니요엔터티 종류입니다.
sourcestring아니요이 항목을 생성한 실행이 엔터티를 가져온 위치로, aggrega pull --detail이 출력하는 것과 같은 단어로 표시됩니다. fetched-fresh(해당 실행 중 레지스트리에서 가져옴), cache-reuse(이미 캐시에 있던 사본을 가져오지 않고 재사용), local(카탈로그 디렉터리 등 로컬 파일 시스템에서 찾음), in-binary(컴파일러 바이너리 내부의 사본), external(Release 자체의 Aggregate 또는 Manifest로, 의존성 중 하나로 해석되지 않고 Release가 지정한 파일이나 항목에서 읽음. 실행이 레지스트리에서 가져온 Aggregate는 대신 fetched-fresh입니다) 중 하나입니다. 의존성 해석 보고서의 항목에는 존재하며, 이 경우 해당 실행이 이 머신에서 수행한 작업을 설명합니다. Release의 해석된 의존성 목록에는 없으며, 이 목록은 Release가 무엇에 의존하는지를 설명합니다. 잠금 파일은 출처를 기록하지 않습니다. 실행이 출처를 기록하지 않은 엔터티에서는 생략됩니다.

추가 속성은 허용되지 않습니다.

ToolchainCorePlugin

컴파일러 자체가 담고 있는 플러그인 하나와, 사용된 그 플러그인의 버전입니다.

속성타입필수설명
pluginstring예플러그인의 참조입니다.
versionstring예사용된 버전입니다.

추가 속성은 허용되지 않습니다.

ToolchainReport

해석된 컴파일러와 그 컴파일러가 담고 있는 플러그인입니다.

속성타입필수설명
compilerVersionstring예해석된 컴파일러 버전입니다.
corePluginsToolchainCorePlugin[]아니요컴파일러가 담고 있는 플러그인과 각각 사용된 버전입니다.

추가 속성은 허용되지 않습니다.

DependencyResolutionReport

의존성 해석이 고정하고 획득한 것입니다.

속성타입필수설명
lockfilestring예해석이 작성한 잠금 파일, 또는 검증이 비교 대상으로 삼은 잠금 파일입니다.
verified불리언아니요요청이 검증이었는지 여부입니다. 검증은 기록된 잠금 파일과 비교하며, 잠금 파일, 플러그인 신뢰 기록 또는 entity.lock을 작성하지 않습니다.
entitiesClosureEntity[] 또는 null예해석이 고정했거나 검증이 비교한 엔터티입니다.
librariesClosureEntity[] 또는 null예해석이 고정했거나 검증이 비교한 라이브러리입니다.
pluginsClosureEntity[] 또는 null예해석이 고정했거나 검증이 비교한 플러그인입니다.
sourceArtifactsinteger예획득한 소스 아티팩트의 수입니다.
trustedPluginsinteger예고정된 플러그인 중 검증된 서명을 가진 플러그인의 수입니다.
toolchainToolchainReport아니요해석된 컴파일러와 그 컴파일러가 담고 있는 플러그인입니다.
externalInputsinteger예렌더링이 소비하는 외부 입력 중 획득한 것의 수입니다.
incompleteExternalInputsstring아니요일부 외부 입력을 획득하지 못한 경우, 획득하지 못한 외부 입력입니다.

추가 속성은 허용되지 않습니다.

BuildNotice

빌드가 호출자에게 알리려는 사항 하나로, 문서에 대한 발견 사항도 실패도 아닙니다.

속성타입필수설명
classstring예알림의 종류입니다.
textstring예알림의 내용입니다.

추가 속성은 허용되지 않습니다.

CacheScope

캐시 응답이 미치는 범위입니다. 캐시 클래스 중 두 개는 머신의 모든 프로젝트가 공유하므로, 모든 캐시 응답은 자신이 다룬 클래스를 명시합니다. 그렇지 않으면 하나의 워크스페이스로 열린 세션이 그 워크스페이스에 대해서만 보고하는 것으로 읽힐 것입니다.

속성타입필수설명
machineWideClassesstring[] 또는 null예이 응답이 다룬 캐시 클래스 중 머신의 모든 프로젝트가 공유하는 것입니다.
workspaceRootstring예요청이 지정한 워크스페이스입니다.

추가 속성은 허용되지 않습니다.

CacheElement

캐시가 보관하는 항목 하나입니다.

속성타입필수설명
labelstring예항목이 무엇에 대한 것인지입니다.
sizeinteger예항목이 차지하는 바이트 수입니다.
sizeTextstring예같은 크기를 사람이 읽기 쉬운 형태로 쓴 것입니다.
digeststring아니요항목이 키로 사용하는 콘텐츠 다이제스트입니다(있는 경우).
notestring아니요항목에 대해 언급할 만한 기타 정보입니다.

추가 속성은 허용되지 않습니다.

CacheClass

데몬이 보고하는 캐시 하나입니다.

속성타입필수설명
namestring예어떤 캐시인지입니다.
reachstring예캐시가 이 워크스페이스에 속하는지, 머신 전체에서 공유되는지입니다.
prunable불리언예데몬이 이 캐시를 회수하는지 여부입니다.
elementsCacheElement[] 또는 null예캐시가 보관하는 내용입니다.

추가 속성은 허용되지 않습니다.

CacheProvenance

캐시된 아티팩트가 어떤 신원으로 획득되었는지, 그리고 얼마나 널리 공유되는지입니다.

속성타입필수설명
identitiesstring[] 또는 null예아티팩트가 귀속되는 신원입니다.
sharedByinteger아니요아티팩트를 공유하는 보유자의 수입니다.

추가 속성은 허용되지 않습니다.

CacheRemoval

회수 작업이 제거한 항목 하나, 또는 남겨 둔 항목 목록에서는 제거했을 항목 하나입니다.

속성타입필수설명
classstring예속한 캐시입니다.
labelstring예무엇인지입니다.
reachstring예그 캐시가 이 워크스페이스에 속하는지, 머신 전체에서 공유되는지입니다.
sizeinteger예차지하는 바이트 수, 또는 제거되기 전에 차지했던 바이트 수입니다.
sizeTextstring예같은 크기를 사람이 읽기 쉬운 형태로 쓴 것입니다.

추가 속성은 허용되지 않습니다.

CacheShortfall

회수 작업이 남겨 둔 것과 그것을 회수할 방법입니다. 예상보다 작은 수치를 읽은 호출자가 이유를 추측하지 않고 알 수 있도록 합니다.

속성타입필수설명
classstring예남겨진 것을 보관하는 캐시입니다.
countinteger예남겨진 항목의 수입니다.
sizeinteger예그 항목들이 차지하는 바이트 수입니다.
sizeTextstring예같은 크기를 사람이 읽기 쉬운 형태로 쓴 것입니다.
reachstring예그 캐시가 이 워크스페이스에 속하는지, 머신 전체에서 공유되는지입니다.
reclaimedBystring[] 또는 null예그 항목들을 회수할 방법입니다.

추가 속성은 허용되지 않습니다.

CacheCleared

비우기 작업이 비운 캐시 하나입니다.

속성타입필수설명
classstring예비워진 캐시입니다.
reachstring예이 워크스페이스에 속하는지, 머신 전체에서 공유되는지입니다.
sizeinteger예이 캐시에서 회수된 바이트 수입니다.
sizeTextstring예같은 크기를 사람이 읽기 쉬운 형태로 쓴 것입니다.
heldOpenFilesinteger예다른 프로세스가 열고 있어서 비우기 작업이 이 캐시에 남겨 둔 파일의 수입니다. 열린 파일의 제거를 거부하는 것은 Windows뿐이므로, 다른 모든 환경에서는 0입니다. 이후의 비우기 작업은 해당 프로세스가 파일 사용을 마친 뒤 이를 제거합니다.
heldOpenBytesinteger예그 파일들이 차지하는 바이트 수입니다. 이는 비우기 작업이 회수한 양인 size에 포함되지 않습니다.
heldOpenBytesTextstring예같은 수치를 사람이 읽기 쉬운 형태로 쓴 것입니다.

추가 속성은 허용되지 않습니다.

ConfigWriteScope

어떤 구성 문서가 작성되었고 그 범위가 어디까지인지입니다. 요청은 하나의 워크스페이스를 지정하므로, 아무 언급이 없는 응답은 그 워크스페이스에 대한 것으로 읽힐 것이며, 머신 전체에 대한 쓰기에서는 그렇게 읽는 것이 틀립니다.

속성타입필수설명
configFilestring예작성된 문서입니다.
machineWide불리언예그 문서가 머신의 모든 워크스페이스가 해석 시 거치는 문서인지 여부입니다.
workspaceRootstring예요청이 지정한 워크스페이스입니다.

추가 속성은 허용되지 않습니다.

PluginWriteScope

플러그인 변경이 어떤 구성 문서에 작성되었고 그 범위가 어디까지인지입니다. 명령 확장 소켓의 기본값은 머신 전체 문서이므로, 모든 응답은 어느 문서에 작성했는지 밝힙니다.

속성타입필수설명
configFilestring예작성된 문서입니다.
machineWide불리언예그 문서가 머신의 모든 워크스페이스가 해석 시 거치는 문서인지 여부입니다.
workspaceRootstring예요청이 지정한 워크스페이스입니다.

추가 속성은 허용되지 않습니다.

CredentialStoreScope

자격 증명 변경이 미치는 범위입니다. 저장소는 머신의 모든 프로젝트와 같은 레지스트리를 사용하는 다른 모든 도구가 공유하므로, 응답은 세션 범위로 추측되도록 두지 않고 이를 보고합니다.

속성타입필수설명
machineWide불리언예변경이 다룬 저장소가 머신 전체에서 공유되는지 여부입니다.
workspaceRootstring예요청이 지정한 워크스페이스입니다.

추가 속성은 허용되지 않습니다.

SkillFolderScope

스킬 설치가 미치는 범위입니다. 요청은 하나의 워크스페이스를 지정하므로, 아무것도 밝히지 않은 응답은 그 워크스페이스에 관한 것으로 읽힙니다. 그러나 어시스턴트가 모든 프로젝트에서 읽는 사용자별 폴더의 경우 그렇게 읽는 것은 잘못입니다.

속성타입필수설명
machineWide불리언예기록된 폴더가 어시스턴트가 머신의 모든 프로젝트에서 읽는, 홈 디렉터리 아래의 사용자별 폴더인지 여부입니다.
workspaceRootstring예요청이 지정한 워크스페이스입니다.

추가 속성은 허용되지 않습니다.

PublicationReach

게시가 어디까지 도달했는지를 나타냅니다. 이 응답은 이 머신을 완전히 넘어서 도달하므로(응답이 첨부하는 것은 해당 레지스트리의 모든 소비자가 해석하는 대상입니다), 각 응답은 접근한 모든 레지스트리와 호출이 그곳에 무언가를 첨부했는지 여부를 명시합니다.

속성타입필수설명
registriesstring[]예호출이 접근한 모든 레지스트리 호스트로, 각각 한 번씩, 호출이 처음 접근한 순서대로 나열됩니다. 단일 참조 호출은 하나를 명시하고, 드라이 런은 접근했을 대상을 명시합니다.
beyondThisMachine불리언예호출이 레지스트리가 이제 다른 사용자에게 제공하는 무언가(업로드된 콘텐츠, 서명, 게시 날짜 또는 지원 중단 표시)를 첨부했는지 여부입니다. 드라이 런에서는 false이며, 첨부했을 모든 것이 이미 존재함을 발견한 호출(완전한 버전에 대해 다시 실행된 게시, 또는 모든 참조가 이미 검증되는 서명을 지닌 서명 배치)에서도 false입니다.

추가 속성은 허용되지 않습니다.

WorkspaceEntityRef

종류와 이름으로 식별되는 하나의 엔터티와 그것을 선언하는 문서입니다.

속성타입필수설명
kindstring예엔터티 종류입니다.
namestring예엔터티 이름입니다.
filestring예엔터티를 선언하는 문서로, 워크스페이스 루트에 대한 상대 경로입니다.

추가 속성은 허용되지 않습니다.

SourcedEntityRef

하나의 엔터티와 그것을 읽어 온 위치입니다. 워크스페이스 문서는 워크스페이스 상대 경로를 보고하고, 구성된 카탈로그 디렉터리에서 해석된 엔터티는 빈 경로를 보고합니다. 그 엔터티가 가진 유일한 경로는 클라이언트에게 아무 의미가 없기 때문입니다. 출처는 둘 중 어느 쪽인지를 알려 주므로, 빈 경로가 아무도 채우지 않은 필드로 읽히지 않습니다.

속성타입필수설명
kindstring예엔터티 종류입니다.
namestring예엔터티 이름입니다.
filestring예엔터티를 선언하는 문서로, 워크스페이스 루트에 대한 상대 경로이며, 구성된 카탈로그 디렉터리에서 온 경우에는 비어 있습니다.
originstring예엔터티를 읽어 온 위치입니다.

추가 속성은 허용되지 않습니다.

SocketCandidacy

엔터티의 소켓 하나와 그 소켓에 연결할 수 있는 대상입니다.

속성타입필수설명
socketstring예소켓의 이름입니다.
declarationstring예소켓이 선언된 위치입니다.
selectorstring예대상이 충족해야 하는 레이블 셀렉터입니다.
required불리언예빌드가 진행되려면 소켓이 연결되어야 하는지 여부입니다.
targetsWorkspaceEntityRef[] 또는 null예이 소켓에 연결할 수 있는 엔터티입니다.

추가 속성은 허용되지 않습니다.

SlotCandidacy

연결의 소켓이 선언하는 슬롯 하나(소비하는 Component가 소켓에 선언한 그대로)와 해당 연결에서 그 슬롯을 채울 수 있는 Features입니다.

속성타입필수설명
slotstring예슬롯의 이름으로, 이 슬롯을 채우는 첨부가 연결의 features 아래에 기록되는 키입니다.
selectorstring예슬롯을 채우는 Feature가 자신의 레이블로 충족해야 하는 레이블 셀렉터입니다. 슬롯이 셀렉터를 선언하지 않으면 비어 있으며, 이 경우 모든 Feature를 허용합니다.
required불리언예빌드가 진행되려면 소켓을 통해 연결된 모든 연결이 이 슬롯을 채워야 하는지 여부입니다.
injectstring[]예슬롯이 이를 채우는 대상에 허용하는 전달 메커니즘으로, Component가 선언한 순서대로 나열됩니다. 선언하지 않으면 비어 있습니다.
sensitive불리언예슬롯을 채우는 대상이 비밀 자료를 다룬다고 슬롯이 선언하는지 여부입니다. 이는 슬롯을 채우는 첨부에 표시를 할 뿐이며 아무것도 거부하지 않습니다.
descriptionstring예Component가 설명하는 슬롯의 용도입니다. 아무 설명도 없으면 비어 있습니다.
candidatesSourcedEntityRef[]예이 연결에서 슬롯을 채울 수 있는 각 Feature입니다. 즉, 선언된 적용 범위를 그래프 노드의 레이블이 충족하고(노드가 지니는 모든 첨부가 이 조건을 따릅니다), 자신의 레이블이 슬롯의 셀렉터를 충족하는 Feature입니다. 적용 범위나 레이블을 셀렉터에 대해 읽을 수 없는 Feature는 제시되지 않습니다. 빌드가 이를 허용하지 않고 거부하기 때문입니다.

추가 속성은 허용되지 않습니다.

CatalogEntity

워크스페이스 인덱스가 보유한 엔터티 하나입니다.

속성타입필수설명
kindstring예엔터티 종류입니다.
namestring예엔터티 이름입니다.
apiVersionstring예문서가 선언하는 스키마 버전입니다.
descriptionstring예문서가 설명하는 엔터티의 용도입니다.
labelsmap of string 또는 null예문서가 선언하는 레이블입니다.
filestring예엔터티를 선언하는 문서로, 워크스페이스 루트에 대한 상대 경로입니다.
originstring예엔터티를 읽어 온 위치입니다.

추가 속성은 허용되지 않습니다.

CompletionItem

커서 위치에 작성할 수 있는 항목 하나입니다.

속성타입필수설명
labelstring예작성할 텍스트입니다.
kindinteger아니요항목의 종류로, 클라이언트가 아이콘을 선택할 수 있게 합니다.
detailstring아니요레이블 옆에 표시되는 짧은 수식어입니다.
documentationstring아니요항목에 대한 자세한 설명입니다.
sortTextstring아니요레이블과 다를 경우 정렬에 사용할 값입니다.

추가 속성은 허용되지 않습니다.

MarkupContent

표시할 텍스트와 그 마크업 방식입니다.

속성타입필수설명
kindstring예텍스트의 마크업 방식입니다.
valuestring예텍스트입니다.

추가 속성은 허용되지 않습니다.

EntityKindDescriptor

작성자가 문서로 작성하는 종류 하나로, 요청이 지정하는 토큰과 문서 자체가 선언하는 종류를 짝짓고, 어떤 작업이 그 종류의 문서를 받아들이는지 알려 줍니다.

속성타입필수설명
kindstring예요청이 지정하는 소문자 토큰입니다(예: component, featurerecipe).
documentKindstring예문서 자체의 헤더가 선언하는 종류입니다.
acceptedByEntityKindAcceptance예이 종류의 문서를 단독으로(경로로, 또는 검사의 경우 이름으로) 지정하고 다른 것은 함께 보내지 않았을 때 어떤 작업이 이를 받아들이는지를 나타냅니다. 해당 작업이 이 종류라는 이유로 문서를 거부하지 않으면 멤버는 true입니다. 받아들여진 문서라도 문서의 내용 때문에 거부될 수 있습니다.

추가 속성은 허용되지 않습니다.

EntityKindAcceptance

작성자가 작성하는 종류 하나에 대해, 그 종류의 문서를 단독으로 지정했을 때 각 작업이 이를 받아들이는지 여부입니다. 모든 항목에 모든 멤버가 존재하므로 false는 생략이 아니라 명시적인 진술입니다.

속성타입필수설명
singleEntityValidation불리언예aggrega validate의 단일 엔터티 범위(하나의 문서 경로를 지정한 명령)가 이 종류의 문서를 검사하는지 여부입니다. 이 범위가 거부하는 종류는 대신 전체 카탈로그 범위나 Release 범위에서 검사됩니다.
publication불리언예문서만 지정한 aggrega/publishEntity가 이 종류의 문서를 게시하는지 여부입니다. 게시 시 문서 옆에 지정된 실행 파일도 함께 바인딩하는 종류(Plugin)는 false입니다. 문서만 지정한 요청은 이 종류에 대해 거부되기 때문입니다. Manifest와 Release는 어느 쪽도 게시되지 않는 종류이므로 false입니다.
inspectionByName불리언예aggrega/entityDefinition이 이름을 이 종류의 엔터티로 해석하는지 여부입니다. 이름은 한 엔터티가 다른 엔터티를 참조하는 곳에 작성된 그대로 전송됩니다.

추가 속성은 허용되지 않습니다.

RegistryTrust

해석 시 레지스트리가 제공하는 것에 적용하는 신뢰 정책입니다.

속성타입필수설명
signaturesRequired불리언예이 레지스트리의 아티팩트가 검증된 서명을 지녀야 하는지 여부입니다.
verificationSkipped불리언아니요검증을 건너뛰고 있는지 여부입니다.
advisory불리언아니요검증 실패 시 중단하지 않고 보고할지 여부입니다.
anchorstring아니요서명을 검증하는 기준이 되는 신뢰 앵커입니다.
keylessIdentitiesinteger아니요이 레지스트리에 대해 신뢰하는 서명 ID의 수입니다.

추가 속성은 허용되지 않습니다.

Registry

구성된 레지스트리 하나입니다. 여기의 어떤 필드도 자격 증명 자료, 그 길이, 형태 또는 어떤 표현도 담지 않습니다. 보고되는 것은 존재 여부뿐이며, 이 덕분에 값을 이슈에 붙여 넣어도 안전합니다.

속성타입필수설명
hoststring예레지스트리 호스트로, 레지스트리의 식별자입니다.
namestring아니요호스트로 해석되는 친숙한 별칭으로, 구성된 경우에만 있습니다.
default불리언예레지스트리를 지정하지 않은 작업이 접근하는 레지스트리인지 여부입니다.
authStatestring예이 호스트의 자격 증명이 머신 전체 저장소에 존재하는지 여부입니다. 비어 있어도 보고되므로, 호출자는 ‘자격 증명이 없음’과 ‘목록 조회가 확인하지 않음’을 구별할 수 있습니다.
trustRegistryTrust예해석 시 레지스트리가 제공하는 것에 적용하는 신뢰 정책입니다.

추가 속성은 허용되지 않습니다.

TrustFetchOutcome

레지스트리가 공시한 신뢰 정책을 읽은 결과입니다. 각 결과는 의미가 서로 다르므로 구분해 둡니다. 공시된 정책을 채택했거나, 레지스트리가 아무것도 공시하지 않았거나(이는 실패가 아닙니다), 그 대신 내장 기준선을 고정했거나, 읽기를 시도하지 않았습니다. 아무것도 공시되지 않은 경우에는 레지스트리에 연결할 수 있었는지 여부를 함께 명시합니다.

속성타입필수설명
pinned불리언예공시된 정책을 채택했는지 여부입니다.
notAdvertised불리언아니요레지스트리에 요청했으나 정책을 공시하지 않았는지 여부이며, 이 경우 작업은 요청에 명시된 내용에 따라 진행됩니다. 오프라인 상태 때문에 요청하지 않은 레지스트리는 이렇게 보고되지 않습니다. 연결할 수 없었던 레지스트리도 정책이 돌아오지 않았으므로 이렇게 보고되며, unreachable을 함께 가집니다. 둘을 구분하려면 unreachable을 읽습니다.
unreachable불리언아니요공시된 정책을 요청했을 때 레지스트리에 연결할 수 없었는지 여부입니다. 이름이 확인되지 않았거나, 연결이 거부되거나 열리지 않았거나, 보안 연결을 수립할 수 없었던 경우입니다. 이 값은 reason이 아니라 실패 자체에서 판단하며, notAdvertised와 함께 나타나고, 실패가 레지스트리에 전혀 도달하지 못했음을 보여 주는 경우에만 설정됩니다. 응답한 레지스트리는 정책 없이 응답했든 실패로 응답했든 이 값을 비워 둡니다.
baseline불리언아니요공시된 정책을 채택하지 않아 내장 기준선을 고정했는지 여부이며, 공식 허브만 이를 가집니다. 허브에 요청했으나 아무것도 공시하지 않은 경우에는 notAdvertised와 함께 나타나고, 오프라인 상태 때문에 허브에 요청하지 않은 경우에는 단독으로 나타납니다.
skipped불리언아니요명시된 정책이 읽기를 대체했거나 요청이 읽기를 원하지 않아 읽기를 시도하지 않았는지 여부입니다.
identitiesinteger아니요공시된 정책에 포함된 서명 신원의 수입니다.
reasonstring아니요공시된 정책을 채택하지 않은 이유입니다. 레지스트리 엔드포인트의 동작 또는 요청을 막은 오프라인 거부를 나타냅니다.

추가 속성은 허용되지 않습니다.

SkippedRepo

인덱스 탐색이 건너뛴 저장소 하나와 그 이유입니다.

속성타입필수설명
repostring예건너뛴 저장소입니다.
reasonstring예건너뛴 이유입니다.

추가 속성은 허용되지 않습니다.

DeprecationNote

인덱스 탐색이 만난 지원 중단 표시 하나와 그 처리 결과입니다. 반영된 표시와 존재했지만 거부된 표시는 같은 방식으로 보고되므로, 여러 개를 기록한 일이 조용히 지나가는 동안 하나를 거부한 일만 드러나는 경우가 없습니다.

속성타입필수설명
repostring예표시가 붙은 저장소입니다.
versionstring예표시가 적용되는 버전입니다.
recorded불리언예표시 자체의 서명이 검증되어 인덱스가 이를 포함하는지 여부입니다.
severityconst “warning” 또는 const “error” 또는 const “retracted”아니요마커의 강도입니다. 허용되는 값: "warning" — 지원 중단됨. 두 권고 등급 중 약한 쪽이며, 버전을 선택할 때 여전히 선택됩니다. "error" — 지원 중단됨. 두 권고 등급 중 강한 쪽이며, 버전을 선택할 때 여전히 선택됩니다. "retracted" — 철회됨. 버전을 선택할 때 제외됩니다.
reasonstring아니요버전이 사용 중단된 이유입니다.

추가 속성은 허용되지 않습니다.

HostUpdate

인덱스 갱신이 레지스트리 하나에 대해 수행한 작업입니다.

속성타입필수설명
hoststring예갱신된 레지스트리 호스트입니다.
indexedinteger예기록된 레코드의 수입니다.
deprecationsExamined불리언예탐색이 지원 중단 표시를 찾아보았는지 여부입니다. “이 레지스트리는 표시를 게시하지 않았다”와 “이번 실행에는 판단할 근거가 없었다”는 서로 다른 사실이므로 개수와 별도로 둡니다.
deprecationsRecordedinteger예반영된 표시의 수입니다.
skippedSkippedRepo[] 또는 null예탐색이 건너뛴 저장소입니다.
deprecationsDeprecationNote[] 또는 null예탐색이 만난 표시입니다.
readsRetriedinteger예순회의 읽기 중 레지스트리가 거부하거나 도중에 끊어서 다시 요청된 읽기의 수로, 각 읽기는 몇 번의 시도가 필요했든, 이후 성공했든 아니든 한 번으로 계산하며, 없으면 0입니다. 읽기가 결국 모두 성공한 순회는 skipped 아래에 저장소를 나열하지 않으므로, 순회가 저장소 하나를 빠뜨리기에 얼마나 가까웠는지를 알려 주는 것은 이 수입니다. 최솟값: 0.
errorstring아니요이 호스트에서 실패한 내용입니다. 여러 호스트를 탐색할 때 호출자가 따로 대조하지 않아도 어느 호스트가 실패했는지 알 수 있습니다.
unreachable불리언아니요이 레지스트리에 연결할 수 없었는지 여부입니다. 이름이 확인되지 않았거나, 연결이 거부되거나 열리지 않았거나, 보안 연결을 수립할 수 없었던 경우입니다. 이 값은 error가 아니라 실패 자체에서 판단하며, error와 함께만 설정되고, 실패가 레지스트리에 전혀 도달하지 못했음을 보여 주는 경우에만 설정됩니다. 응답한 레지스트리는 무엇을 응답했든 이 값을 비워 둡니다.

추가 속성은 허용되지 않습니다.

PublishedVersion

인덱스가 참조 하나에 대해 보유한 버전 하나입니다. 인덱스를 빌드할 때 태그가 가리킨 manifest 다이제스트, 인덱스를 빌드할 때 적용된 신뢰 정책이 버전 자체의 서명을 검증한 경우 검증된 서명자, 그리고 기록이 있는 경우 버전이 게시된 시점과 그 출처를 담습니다. 서명이 없는 버전, 어떤 서명도 검증되지 않은 버전, 그리고 해당 정책이 공개 키나 신뢰하는 신원을 고정하지 않거나 서명 검증을 끈 경우에는 서명자가 없습니다. 이들은 모두 서명자를 지목할 근거가 되지 않으며, 서명자가 없다는 것은 그 이상을 의미하지 않습니다. 게시 시 날짜를 명시하지 않았고 해당 정책이 검증한 키리스 서명에도 날짜 기록이 없으면 게시 날짜가 없습니다.

속성타입필수설명
versionstring예태그가 지칭하는 버전입니다.
manifestDigeststring예인덱스를 빌드할 때 버전의 태그가 가리킨 manifest의 다이제스트입니다. 태그가 아니라 해당 manifest가 지칭하는 바이트로 버전을 가리킵니다.
signerVerifiedSignature아니요레지스트리의 신뢰 정책에 대해 검증된 서명입니다. 검증 방식, 검증된 서명자, 검증된 서명 번들의 다이제스트를 담습니다.
publishedAtstring아니요버전이 게시된 시점이며, 초 단위까지의 UTC RFC 3339 타임스탬프입니다. 출처는 publishedAtSource이며, 둘은 함께 존재하거나 함께 없습니다.
publishedAtSourceconst “transparency-log” 또는 const “publisher”아니요publishedAt의 출처로, 투명성 로그가 증명하는 시각을 게시자가 밝힌 시각으로 착각하지 않도록 합니다. 이 집합은 닫혀 있습니다. 허용되는 값: "transparency-log" — 투명성 로그가 해당 버전의 keyless 서명을 기록한 시각으로, 인덱스를 구축할 때 적용된 신뢰 정책이 그 시각에 대한 로그의 서명된 약속과 함께 검증한 것입니다. 게시 시점에 서명된 버전에서는 게시 시각이고, 나중에 서명된 버전에서는 그 서명이 만들어진 시각입니다. "publisher" — 게시물이 게시한 내용과 함께 밝힌 시각으로, 게시한 머신 자체의 시계에서 나온 것입니다. 이를 증명하는 것은 없습니다. 서명에 증명된 시각이 없는 경우, 즉 keyed 서명이거나 서명이 없는 경우 게시물이 이 시각을 밝힙니다. 여러 개가 첨부되어 있으면 가장 이른 것을 사용합니다.

추가 속성은 허용되지 않습니다.

VerifiedSignature

레지스트리의 신뢰 정책에 대해 검증된 서명입니다. 검증 방식, 검증된 서명자, 검증된 서명 번들의 다이제스트를 담습니다.

속성타입필수설명
bundleDigeststring예검증된 서명 번들의 다이제스트이며, sha256: 뒤에 소문자 16진수 64자가 붙는 형식입니다.
identitystring아니요서명이 검증된 서명자입니다. 키리스 서명의 경우 서명 인증서가 발급된 신원, 즉 주체 대체 이름(SAN)이고, 키 기반 서명의 경우 keyed:sha256: 뒤에 고정된 공개 키 PEM 텍스트의 SHA-256 소문자 16진수가 붙습니다.
issuerstring아니요키리스 서명의 서명 인증서에 기록된 OIDC 발급자입니다. 키 기반 서명에는 없습니다.
modeconst “keyless” 또는 const “keyed”예서명이 검증된 방식입니다. 이 집합은 닫혀 있습니다. 허용되는 값: "keyless" — 식별 정보와 발급자가 정책이 신뢰하는 것과 일치하고, 정책이 고정한 신뢰 루트 또는 고정된 것이 없으면 공익 Sigstore 루트로 체인되며, 서명이 투명성 로그에 기록된 서명 인증서에 대해 검증되었습니다. "keyed" — 정책이 고정한 공개 키에 대해 검증되었습니다.

추가 속성은 허용되지 않습니다.

RegistrySearchRecord

검색에 일치한 레코드 하나를 로컬 인덱스가 보유한 형태로 나타내고, 게시된 표시가 지원 중단한 버전을 덧붙입니다.

속성타입필수설명
uristring예레코드가 확인되는 참조입니다.
namestring예엔터티 이름입니다.
versionstring예레코드의 키가 되는 버전입니다.
versionsstring[]아니요인덱스가 이 참조에 대해 보유한 모든 버전입니다.
kindstring아니요엔터티 종류입니다.
descriptionstring아니요엔터티의 용도입니다.
categorystring아니요엔터티가 게시된 카테고리입니다.
labelsstring 맵아니요엔터티가 선언한 레이블입니다.
pluginTypestring아니요플러그인 레코드가 연결되는 소켓입니다.
capabilitiesstring[]아니요플러그인 레코드가 선언한 기능입니다.
manifestDigeststring아니요게시된 manifest의 다이제스트입니다.
listingDigeststring아니요레코드를 읽어 온 목록의 다이제스트입니다.
deprecationsobject[]아니요인덱스가 이 참조에 대해 보유한 지원 중단 표시이며, 각각 적용 버전과 검증된 표시 자체를 담습니다.
publishedPublishedVersion[]아니요인덱스가 이 참조에 대해 보유한 모든 버전이며, versions와 같은 순서입니다. 각각 인덱스를 빌드할 때 태그가 가리킨 manifest 다이제스트, 인덱스를 빌드할 때 적용된 신뢰 정책이 해당 버전 자체의 서명을 검증한 경우 검증된 서명자, 기록이 있는 경우 게시 날짜와 그 출처를 담습니다. 서명자 없이 기록된 버전은 해당 정책이 검증한 서명이 없다는 뜻이며, 그 이상은 아무것도 말하지 않습니다. 이를 기록하기 위해 레지스트리에서 manifest, 서명 첨부물, 게시 날짜 첨부물만 읽으며, 어떤 엔터티의 내용도 가져오지 않습니다.
retractedstring[]아니요게시된 표시가 지원 중단한 버전입니다.

추가 속성은 허용되지 않습니다.

RegistrySearchIndex

검색된 호스트 하나의 최신 상태입니다.

속성타입필수설명
hoststring예인덱스가 검색된 호스트입니다.
lastUpdatedstring아니요인덱스가 마지막으로 갱신된 시각입니다. 스냅샷에 시각이 없으면 0이 아니라 생략되므로, 호출자는 “기록되지 않음”과 epoch를 구별할 수 있습니다.

추가 속성은 허용되지 않습니다.

EffectiveConfigurationSetting

해석된 설정 하나와 그 설정을 가져온 문서입니다.

속성타입필수설명
fieldstring예설정입니다.
valuestring예해석된 값입니다.
sourcestring예값을 가져온 곳입니다.

추가 속성은 허용되지 않습니다.

ImportedFile

가져오기가 기록하는 파일 하나입니다. 초안 문서이거나, 가져오기가 기록한 내용의 기록입니다.

속성타입필수설명
pathstring예파일이 위치할 곳으로, 응답의 outputDir에 대한 상대 경로입니다.
contentstring예파일의 텍스트입니다.

추가 속성은 허용되지 않습니다.

ImportDrift

동기화가 소스에 맞춰 최신으로 갱신한 부분 하나, 또는 dryRun에서 갱신할 부분 하나입니다.

속성타입필수설명
changestring예부분이 달라진 방식입니다. 소스에 새로 생긴 부분은 added, 소스에서 빠진 부분은 removed, 소스에서 바뀐 부분은 changed입니다.
filestring예해당 부분이 들어 있는 초안 파일로, 응답의 outputDir에 대한 상대 경로입니다.
keystring[]예초안 Aggregate 또는 Release의 최상위에서 해당 부분까지 이어지는 키로, 키마다 항목 하나이므로 마침표를 포함한 키도 항목 하나로 유지됩니다. 부분이 파일 전체이면 비어 있습니다.

추가 속성은 허용되지 않습니다.

ImportOwed

초안이 아직 비워 두고 있으며, 어떤 소스도 제공할 수 없었고 어떤 답변도 제공하지 않은 하나의 값입니다.

속성타입필수설명
filestring예값이 들어 있는 초안 파일로, 응답의 outputDir을 기준으로 한 상대 경로입니다.
keystring[]예그 문서의 맨 위에서 값에 이르는 키로, 키마다 항목이 하나이므로 마침표가 포함된 키도 하나의 항목으로 남습니다. answered로 보낸 답변은 이 키로 값을 지명합니다.
questionstring예값이 무엇인지입니다. 스키마의 설명, 그것이 없으면 초안이 키 위에 작성하는 주석, 그것도 없으면 스키마가 받는다고 하는 것입니다.
sensitive불리언예값이 시크릿의 값인지 여부입니다. 시크릿의 답변은 시크릿의 출처를 지명하며 시크릿 자체는 결코 담지 않습니다.
secretAdvicestring아니요시크릿의 값에 있습니다. 터미널에서 답하는 사람에게 표시되는 문장으로 그 답변이 무엇이어야 하는지를 나타내거나, answered로 보낸 답변이 거부된 경우에는 거부된 이유를 나타냅니다.

추가 속성은 허용되지 않습니다.

ImportAnswered

응답의 owed가 나열한 값에 대한 하나의 답변입니다.

속성타입필수설명
filestring예값이 들어 있는 초안 파일로, owed가 지명한 대로입니다.
keystring[]예값에 이르는 키로, owed가 지명한 대로입니다.
answerstring예답변입니다. 빈 답변은 값을 아직 필요한 값으로 남깁니다.

추가 속성은 허용되지 않습니다.

ImportDiagnostic

변환이 변환하지 못한 항목 하나입니다. 이는 변환의 가장 유용한 출력이므로, 판정 하나로 줄이지 않고 전부 보고합니다.

속성타입필수설명
severitystring예심각도입니다.
messagestring예변환하지 못한 내용입니다.
codestring아니요조건에 인용 가능한 이름이 있는 경우 그 이름입니다.

추가 속성은 허용되지 않습니다.

ImportDecision

변환이 소스 노드 하나를 매핑한 방식입니다. 임포터가 검토한 카탈로그 Components, 선택한 것, 그 이유, 선택을 바꾸는 방법을 담습니다.

속성타입필수설명
sourceNodeDecisionSourceNode예매핑 결정의 대상인 소스 노드입니다.
candidatesImportCandidate[]아니요임포터가 노드에 대해 검토한 카탈로그 Components로, 각각 점수를 포함합니다. 검토한 것이 없으면 생략됩니다.
chosenDecisionChoice아니요임포터가 소스 노드에 대해 선택한 것입니다. 선택하지 않은 결정에서는 생략됩니다.
rationalestring아니요임포터가 그렇게 선택한 이유를 임포터 자신의 말로 적은 것입니다. 적은 것이 없으면 생략됩니다.
swapHintstring아니요선택을 다른 대안으로 바꾸는 방법을 임포터 자신의 말로 적은 것입니다. 적은 것이 없으면 생략됩니다.

추가 속성은 허용되지 않습니다.

DecisionSourceNode

매핑 결정의 대상인 소스 노드입니다.

속성타입필수설명
idstring예소스에서의 노드 식별자입니다.
typestring예소스가 부르는 노드의 타입입니다.
paramsSummarystring예결정 옆에 표시하기 위한 노드 매개변수 요약입니다.

추가 속성은 허용되지 않습니다.

ImportCandidate

임포터가 소스 노드에 대해 검토한 카탈로그 Component 하나입니다.

속성타입필수설명
componentNamestring예Component의 이름입니다.
scorenumber예임포터가 매긴 점수로 나타낸, Component가 노드와 일치하는 정도입니다.
tierstring예점수가 속하는 일치 등급입니다.
signalsCandidateSignals예임포터의 각 신호가 후보 점수에 기여한 정도입니다.

추가 속성은 허용되지 않습니다.

CandidateSignals

임포터의 각 신호가 후보 점수에 기여한 정도입니다.

속성타입필수설명
tablenumber예매핑 테이블 신호의 기여도입니다.
categorynumber예카테고리 신호의 기여도입니다.
domainLabelsnumber예도메인 레이블 신호의 기여도입니다.
shapenumber예형태 신호의 기여도입니다.
namenumber예이름 신호의 기여도입니다.

추가 속성은 허용되지 않습니다.

DecisionChoice

임포터가 소스 노드에 대해 선택한 것입니다. 선택하지 않은 결정에서는 생략됩니다.

속성타입필수설명
targetstring예선택된 Component의 이름입니다. 기존 카탈로그 Component이거나 노드를 위해 초안으로 작성된 것입니다.
modestring예선택이 기록되는 방식입니다. 기존 Component에 대한 참조이거나 새로 초안으로 작성된 것입니다.
tierstring예선택의 일치 등급입니다.

추가 속성은 허용되지 않습니다.

LintFileFindings

관례 검사가 문서 하나에서 찾은 결과입니다.

속성타입필수설명
filestring예문서입니다.
diagnosticsDiagnostic[] 또는 null예문서 안의 검사 결과입니다.

추가 속성은 허용되지 않습니다.

PluginRetractionExclusion

사용 가능했지만 선택되지 않은 버전 하나입니다.

속성타입필수설명
versionstring예건너뛴 버전입니다.
reasonstring아니요건너뛴 이유입니다.

추가 속성은 허용되지 않습니다.

PluginRetractionProvenance

무엇이 지원 중단되었는지에 대한 정보의 출처입니다.

속성타입필수설명
sourcestring예조회한 대상입니다.
lastUpdatedstring아니요그 대상이 마지막으로 갱신된 시각입니다.

추가 속성은 허용되지 않습니다.

PluginRetraction

지원 중단 마커가 어떤 플러그인 버전이 고정되었는지에 영향을 준 방식입니다.

속성타입필수설명
referencestring예버전들이 속한 참조입니다.
selectedstring아니요고정된 버전입니다.
excludedPluginRetractionExclusion[]아니요사용 가능했지만 건너뛴 버전들입니다.
unscreenedstring아니요마커와 대조하여 검사할 수 없었던 것과 그 이유입니다.
provenancePluginRetractionProvenance아니요무엇이 지원 중단되었는지에 대한 정보의 출처입니다.

추가 속성은 허용되지 않습니다.

PluginGeneratedDocument

생성 작업이 만든 카탈로그 문서 하나입니다.

속성타입필수설명
pathstring예문서가 위치할 곳으로, 워크스페이스 루트에 대한 상대 경로입니다.
contentstring예문서의 텍스트입니다.

추가 속성은 허용되지 않습니다.

PluginCommandFlag

플러그인이 제공하는 명령에 선언하는 플래그 하나입니다.

속성타입필수설명
namestring예플래그의 긴 이름입니다.
shorthandstring아니요플래그에 한 글자 별칭이 있는 경우 그 별칭입니다.
descriptionstring아니요플래그의 한 줄 도움말입니다.
typestring아니요플래그 값의 타입입니다.
defaultstring아니요플래그를 전달하지 않았을 때 사용되는 값입니다.

추가 속성은 허용되지 않습니다.

PluginCLICommand

플러그인이 제공하는 최상위 명령 동사 하나입니다.

속성타입필수설명
namestring예명령 동사입니다.
descriptionstring아니요명령의 한 줄 도움말입니다.
flagsPluginCommandFlag[]아니요명령의 플래그로, 선언된 순서를 따릅니다.

추가 속성은 허용되지 않습니다.

ConfigCapturedAttachment

고정(freeze) 작업이 이 워크스페이스 자체의 구성에 기록한 어태치먼트 하나입니다.

속성타입필수설명
uristring아니요어태치먼트가 해석되는 출처 참조입니다.
capabilitystring아니요어태치먼트가 대상으로 하는 기능입니다.
functionstring아니요어태치먼트가 디스패치되는 익스포트입니다.
rolestring아니요연결이 실행되는 역할로, 연결이 내보낼 수 있는 것을 결정합니다.

추가 속성은 허용되지 않습니다.

ConfigCapturedSocket

고정 작업이 기록한 소켓 하나와, 그 소켓에 고정한 어태치먼트들입니다.

속성타입필수설명
socketstring예소켓입니다.
fieldstring예소켓이 기록되는 구성 필드입니다.
attachmentsConfigCapturedAttachment[] 또는 null예소켓에 고정된 어태치먼트들입니다.

추가 속성은 허용되지 않습니다.

ExplainErrorEntry

어떤 조건에 대한 작성 측 수정 방법을 알려 주는, 게시된 문단 하나입니다.

속성타입필수설명
headingstring예문단의 제목입니다.
bodystring예문단입니다.

추가 속성은 허용되지 않습니다.

SignedArtifact

서명 작업이 포함한 게시된 아티팩트 하나입니다.

속성타입필수설명
referencestring예서명된 참조입니다.
digeststring예서명된 대상의 다이제스트입니다.

추가 속성은 허용되지 않습니다.

DeprecationMarked

지원 중단 작업이 표시한 게시된 버전 하나입니다.

속성타입필수설명
referencestring예표시된 참조입니다.
severityconst “warning” 또는 const “error” 또는 const “retracted”예마커의 강도입니다. 허용되는 값: "warning" — 지원 중단됨. 두 권고 등급 중 약한 쪽이며, 버전을 선택할 때 여전히 선택됩니다. "error" — 지원 중단됨. 두 권고 등급 중 강한 쪽이며, 버전을 선택할 때 여전히 선택됩니다. "retracted" — 철회됨. 버전을 선택할 때 제외됩니다.
issuedOnstring예마커가 발행된 시각입니다.
digeststring예게시된 마커의 다이제스트입니다.

추가 속성은 허용되지 않습니다.

InitializeResult

세션이 이 클라이언트에 대해 확정한 내용과, 그것이 어느 구성 계층에서 결정되었는지입니다.

속성타입필수설명
capabilitiesServerCapabilities예클라이언트가 처리할 수 있다고 밝힌 내용에 맞춰 결정된, 이 세션에서 데몬이 수행할 내용입니다.
workspaceRootstring예세션이 열린 워크스페이스입니다.
configSourcestring예세션이 설정을 결정한 구성 계층입니다.
workspaceMarkerstring아니요워크스페이스 루트를 식별한 파일입니다(그런 파일이 있는 경우).
versionstring예이 세션에 응답하는 바이너리의 버전으로, 해당 바이너리에 대해 aggrega version이 보고하는 값과 같습니다. 실행 중인 프로세스를 설명하므로, 데몬을 시작한 파일이 교체된 후에도 이 값은 실행 중인 버전을 가리키고, 파일에 물어보면 그 파일을 교체한 버전을 가리킵니다.

추가 속성은 허용되지 않습니다.

ValidateResult

검사에서 발견한 내용과 검사한 범위입니다.

속성타입필수설명
diagnosticsDiagnostic[] 또는 null예발견 사항입니다. 검사에서 아무것도 발견하지 못하면 빈 목록이 아니라 null입니다.
checkedstring아니요검사한 범위로, 문서 하나 또는 워크스페이스가 담고 있는 전체입니다.

추가 속성은 허용되지 않습니다.

InvalidateResult

데몬이 해당 문서에 대해 버릴 것을 보유하고 있었는지 여부입니다.

속성타입필수설명
invalidated불리언예무언가가 버려졌는지 여부입니다.

추가 속성은 허용되지 않습니다.

DiagnosticsResult

데몬이 해당 문서에 대해 이미 보유한 발견 사항입니다.

속성타입필수설명
diagnosticsDiagnostic[] 또는 null예발견 사항입니다. 없으면 빈 목록이 아니라 null입니다.

추가 속성은 허용되지 않습니다.

IrGraphResult

Release가 컴파일되어 만들어지는 해석된 그래프입니다.

속성타입필수설명
graphany예그래프 문서입니다. 작성자가 민감하다고 선언한 값은 요청이 unredacted로 요청하지 않는 한 제외되며, 그 밖의 모든 것은 컴파일러가 출력한 그대로 전달됩니다. 문서 자체의 형태는 그래프의 공개된 계약이며 여기서 다시 설명하지 않습니다.

추가 속성은 허용되지 않습니다.

BuildResult

빌드가 기록한 내용입니다.

속성타입필수설명
outputDirectorystring예아티팩트가 기록된 디렉터리입니다.
filesstring[] 또는 null예기록된 아티팩트로, 출력 디렉터리에 대한 상대 경로입니다.
noticesBuildNotice[]아니요빌드가 호출자에게 알리려는 것 중 발견 사항도 실패도 아닌 모든 것입니다.
dependencyResolutionDependencyResolutionReport아니요의존성 해석이 고정하고 획득한 것입니다.

추가 속성은 허용되지 않습니다.

BuildPreviewResult

빌드가 기록했을 내용입니다. 아무것도 기록되지 않았으므로 지정할 출력 디렉터리가 없습니다.

속성타입필수설명
filesstring[] 또는 null예기록했다면 생성되었을 아티팩트입니다.
noticesBuildNotice[]아니요컴파일이 호출자에게 알리려는 것 중 발견 사항도 실패도 아닌 모든 것입니다.

추가 속성은 허용되지 않습니다.

EntityDefinitionResult

엔터티 이름이 해석되는 대상과 그것을 정의하는 문서입니다. 레지스트리 참조에서 읽은 응답에는 published가 포함되며, 카탈로그가 이름으로 해석한 응답에는 절대 포함되지 않습니다.

속성타입필수설명
kindstring예엔터티 종류입니다.
namestring예엔터티 이름입니다.
versionstring예해석된 버전입니다.
descriptionstring아니요문서가 설명하는 엔터티의 용도입니다.
publishScopestring아니요엔터티가 공개된 범위입니다.
filestring예엔터티를 정의하는 문서입니다.
authoredLengthinteger예작성된 문서의 바이트 수로, 클라이언트가 작성된 문서와 그 문서를 해석해 렌더링한 결과를 구별할 수 있게 합니다.
definitionstring예정의의 텍스트입니다.
publishedPublishedArtifact아니요레지스트리 참조가 읽은 내용으로, 좌표, 엔터티를 담은 방식, 그리고 읽을 때 거친 manifest입니다. 이 항목이 있는 곳에는 모든 필드가 있습니다.

추가 속성은 허용되지 않습니다.

PublishedArtifact

레지스트리 참조가 읽은 내용으로, 좌표, 엔터티를 담은 방식, 그리고 읽을 때 거친 manifest입니다. 이 항목이 있는 곳에는 모든 필드가 있습니다.

속성타입필수설명
referencestring예읽은 레지스트리 참조입니다.
archive불리언예좌표의 바이트가 엔터티 문서를 풀어낸 아카이브였는지 여부입니다. 좌표가 엔터티 문서 자체를 담고 있었다면 false입니다.
mediaTypestring예manifest가 선언하는 아티팩트 타입입니다.
manifestDigeststring예엔터티를 읽을 때 거친 manifest의 다이제스트로, 같은 바이트를 정확히 다시 읽으려면 @ 뒤에 지정하는 값입니다.

추가 속성은 허용되지 않습니다.

ReleaseClosureResult

Release가 의존하는 모든 것으로, 해석이 도달한 그대로입니다. 여기서 파생된 그래프가 아니라 클로저를 보고하며, 이는 같은 Release에 대한 다른 문서입니다.

속성타입필수설명
releasestring예검사한 Release입니다.
aggregatestring예이 Release가 배포하는 Aggregate입니다.
manifeststring예이 Release가 해석에 사용하는 Manifest입니다.
environmentstring예이 Release가 지정하는 환경입니다.
entitiesClosureEntity[] 또는 null예클로저가 도달하는 엔터티입니다.
librariesClosureEntity[] 또는 null예클로저가 도달하는 라이브러리입니다.
pluginsClosureEntity[] 또는 null예클로저가 도달하는 플러그인입니다.
mappingDiagnosticsstring[] 또는 null예Manifest의 매핑을 해석하면서 보고된 내용입니다.
deprecationsstring[] 또는 null예클로저가 만난 지원 중단 표시입니다.

추가 속성은 허용되지 않습니다.

ResolveDependenciesResult

의존성 해석이 고정하고 획득한 것과, 호출자에게 알리려는 모든 것입니다. 보고서 자체의 필드는 하위 멤버 아래에 중첩되지 않고 이 응답에 직접 포함됩니다.

속성타입필수설명
lockfilestring예해석이 작성한 잠금 파일, 또는 검증이 비교 대상으로 삼은 잠금 파일입니다.
verified불리언아니요요청이 검증이었는지 여부입니다. 검증은 기록된 잠금 파일과 비교하며, 잠금 파일, 플러그인 신뢰 기록 또는 entity.lock을 작성하지 않습니다.
entitiesClosureEntity[] 또는 null예해석이 고정했거나 검증이 비교한 엔터티입니다.
librariesClosureEntity[] 또는 null예해석이 고정했거나 검증이 비교한 라이브러리입니다.
pluginsClosureEntity[] 또는 null예해석이 고정했거나 검증이 비교한 플러그인입니다.
sourceArtifactsinteger예획득한 소스 아티팩트의 수입니다.
trustedPluginsinteger예고정된 플러그인 중 검증된 서명을 가진 플러그인의 수입니다.
toolchainToolchainReport아니요해석된 컴파일러와 그 컴파일러가 담고 있는 플러그인입니다.
externalInputsinteger예렌더링이 소비하는 외부 입력 중 획득한 것의 수입니다.
incompleteExternalInputsstring아니요일부 외부 입력을 획득하지 못한 경우, 획득하지 못한 외부 입력입니다.
noticesstring[]아니요해석이 호출자에게 알리려는 모든 것입니다.

추가 속성은 허용되지 않습니다.

PinResult

고정 단계가 엔터티 옆의 잠금에 수행한 작업, 또는 시험 실행에서 수행할 작업입니다. aggrega/pin에 대한 응답이며, 이 단계를 실행한 게시는 이를 pin으로 포함합니다.

속성타입필수설명
entitystring예단계가 읽은 엔터티 문서로, 워크스페이스 루트에 대한 상대 경로입니다.
kindstring예문서가 선언한 엔터티의 종류입니다.
namestring예문서가 선언한 엔터티의 이름입니다.
pinnable불리언예이 종류의 엔터티가 잠금이 고정을 기록하는 대상을 읽는지 여부로, Recipe와 FeatureRecipe가 이에 해당합니다. false이면 엔터티 옆의 어떤 것도 변경되지 않았으며, changed는 false이고 lock, removed, pins, content는 없습니다.
lockstring아니요단계가 기록했거나 기록할 잠금으로, 워크스페이스 루트에 대한 상대 경로입니다.
changed불리언예잠금이 변경되었는지, 또는 시험 실행에서 변경될지 여부입니다. 잠금이 엔터티에 필요한 모든 고정을 이미 기록하고 있어 바이트 단위로 동일하게 남았다면 false입니다.
removed불리언아니요변경이 제거인지 여부입니다. 엔터티가 잠금이 고정을 기록하는 대상을 아무것도 읽지 않으므로 옆에 잠금이 남지 않습니다.
dryRun불리언아니요이 응답이 단계가 수행한 작업이 아니라 수행할 작업을 보고하는지 여부입니다.
pinsPinClassCount[]아니요단계 이후, 또는 시험 실행 이후 잠금이 보유하는 클래스별 고정 수입니다. 고정이 없는 클래스를 포함하여 잠금이 보유할 수 있는 모든 클래스가 나열됩니다.
contentstring아니요시험 실행이 기록할 잠금입니다. 잠금이 그대로 남거나 제거되는 경우와, 시험 실행이 아닌 모든 응답에서는 없습니다.

추가 속성은 허용되지 않습니다.

PinClassCount

잠금이 보유하는 한 클래스의 고정 수입니다.

속성타입필수설명
classstring예고정의 클래스로, 누락된 고정을 지적하는 거부 메시지가 사용하는 표현입니다. 예: remote source 또는 imported file.
pinsinteger예잠금이 보유하는 해당 클래스의 고정 수입니다.

추가 속성은 허용되지 않습니다.

CacheStatusResult

이 작업 공간을 지원하는 캐시가 보유한 내용입니다.

속성타입필수설명
classesCacheClass[] 또는 null예각 캐시와 그 캐시가 보유한 내용입니다.
provenanceCacheProvenance[] 또는 null예캐시된 아티팩트를 어떤 ID로 획득했는지입니다.
totalCountinteger예캐시가 보유한 항목의 총수입니다.
totalSizeinteger예캐시가 차지하는 총 바이트 수입니다.
totalSizeTextstring예같은 총계를 사람이 읽기 쉬운 형식으로 쓴 값입니다.
scopeCacheScope예캐시 응답이 미치는 범위입니다. 캐시 클래스 중 두 개는 머신의 모든 프로젝트가 공유하므로, 모든 캐시 응답은 자신이 다룬 클래스를 명시합니다. 그렇지 않으면 하나의 워크스페이스로 열린 세션이 그 워크스페이스에 대해서만 보고하는 것으로 읽힐 것입니다.

추가 속성은 허용되지 않습니다.

CachePruneResult

회수 작업이 제거한 것, 유지한 것, 회수하지 못한 것입니다.

속성타입필수설명
removedCacheRemoval[] 또는 null예제거된 항목입니다.
heldOpenCacheRemoval[] 또는 null예정리 작업이 제거하려 했지만 다른 프로세스가 열어 두고 있어 그대로 둔 항목입니다. 열린 파일의 제거를 거부하는 것은 Windows뿐이므로 다른 모든 환경에서는 비어 있습니다. 이 항목은 제거된 것으로도 유지된 것으로도 세지 않으며, 그 바이트는 회수된 것으로 계산되지 않고, 이후의 정리 작업이 이를 회수합니다. 디렉터리인 항목은 그 안에서 열려 있지 않던 파일을 이미 잃었을 수 있습니다.
retainedCountinteger예유지된 항목 수입니다.
reclaimedBytesinteger예회수된 바이트 수입니다.
reclaimedBytesTextstring예같은 수치를 사람이 읽기 쉬운 형태로 쓴 것입니다.
unattributedCountinteger예어떤 보유자도 소유를 주장하지 않는 항목 수입니다.
unattributedSizeinteger예그 항목들이 차지하는 바이트 수입니다.
unattributedSizeTextstring예같은 수치를 사람이 읽기 쉬운 형태로 쓴 것입니다.
notPruneEligibleCacheShortfall[] 또는 null예남겨진 것과 그것을 회수할 방법입니다.
scopeCacheScope예캐시 응답이 미치는 범위입니다. 캐시 클래스 중 두 개는 머신의 모든 프로젝트가 공유하므로, 모든 캐시 응답은 자신이 다룬 클래스를 명시합니다. 그렇지 않으면 하나의 워크스페이스로 열린 세션이 그 워크스페이스에 대해서만 보고하는 것으로 읽힐 것입니다.

추가 속성은 허용되지 않습니다.

CacheEvictResult

지정한 크기까지 회수하면서 제거한 것과 남은 것입니다.

속성타입필수설명
withinCapBefore불리언예보유한 내용이 이미 지정한 크기 이하여서 제거할 필요가 없었는지 여부입니다.
removedCacheRemoval[] 또는 null예제거된 항목입니다.
heldOpenCacheRemoval[] 또는 null예회수 작업이 제거하려 했지만 다른 프로세스가 열어 두고 있어 그대로 둔 항목입니다. 이 경우 회수 작업은 대신 그다음으로 오래된 항목으로 넘어갔습니다. 열린 파일의 제거를 거부하는 것은 Windows뿐이므로 다른 모든 환경에서는 비어 있습니다. 이 항목은 여전히 남은 바이트에 포함되며, 이후의 회수 작업이 이를 제거할 수 있습니다.
totalBeforeinteger예이전에 보유하던 바이트 수입니다.
totalBeforeTextstring예같은 수치를 사람이 읽기 쉬운 형태로 쓴 것입니다.
reclaimedBytesinteger예회수된 바이트 수입니다.
reclaimedBytesTextstring예같은 수치를 사람이 읽기 쉬운 형태로 쓴 것입니다.
remainingBytesinteger예남은 바이트 수입니다.
remainingBytesTextstring예같은 수치를 사람이 읽기 쉬운 형태로 쓴 것입니다.
capBytesinteger예회수 목표로 삼은 크기(바이트)입니다.
capBytesTextstring예같은 크기를 사람이 읽기 쉬운 형태로 쓴 것입니다.
scopeCacheScope예캐시 응답이 미치는 범위입니다. 캐시 클래스 중 두 개는 머신의 모든 프로젝트가 공유하므로, 모든 캐시 응답은 자신이 다룬 클래스를 명시합니다. 그렇지 않으면 하나의 워크스페이스로 열린 세션이 그 워크스페이스에 대해서만 보고하는 것으로 읽힐 것입니다.

추가 속성은 허용되지 않습니다.

CacheClearResult

캐시를 비우면서 회수한 것입니다.

속성타입필수설명
clearedCacheCleared[] 또는 null예비워진 각 캐시입니다.
reclaimedBytesinteger예회수된 바이트 수입니다.
reclaimedBytesTextstring예같은 수치를 사람이 읽기 쉬운 형태로 쓴 것입니다.
scopeCacheScope예캐시 응답이 미치는 범위입니다. 캐시 클래스 중 두 개는 머신의 모든 프로젝트가 공유하므로, 모든 캐시 응답은 자신이 다룬 클래스를 명시합니다. 그렇지 않으면 하나의 워크스페이스로 열린 세션이 그 워크스페이스에 대해서만 보고하는 것으로 읽힐 것입니다.

추가 속성은 허용되지 않습니다.

RegistryListResult

이 작업 공간이 해석에 사용하는 레지스트리입니다.

속성타입필수설명
registriesRegistry[] 또는 null예구성된 각 레지스트리입니다.
credentialStateIsMachineWide불리언예각 레지스트리에 대해 보고된 자격 증명 존재 여부가 작업 공간이 아니라 머신 전체에 해당하는 사실인지 여부입니다. 세션 범위의 응답이 더 넓은 범위를 부정하는 것으로 읽히지 않도록 보고됩니다.

추가 속성은 허용되지 않습니다.

SearchResult

로컬 레지스트리 인덱스가 검색에 대해 제공한 결과입니다.

속성타입필수설명
recordsRegistrySearchRecord[] 또는 null예일치한 레코드입니다.
indexesRegistrySearchIndex[] 또는 null예검색한 각 호스트와 그 인덱스가 마지막으로 갱신된 시점입니다.
missingIndexHostsstring[] 또는 null예검색할 로컬 인덱스가 없는 구성된 호스트입니다. 결과가 적은 이유를 추론에 맡기지 않고 설명하기 위해 제공됩니다.
stale불리언예검색한 인덱스 중 갱신할 만큼 오래된 것이 있는지 여부입니다.
registriesConfigured불리언예레지스트리가 하나라도 구성되어 있는지 여부로, ‘일치한 것이 없음’과 ‘검색한 것이 없음’을 구별합니다.

추가 속성은 허용되지 않습니다.

RegistryAddResult

레지스트리를 등록하면서 무엇을 어디에 썼는지, 그리고 레지스트리 자체에서 무엇을 읽었는지입니다.

속성타입필수설명
hoststring예항목의 키가 되는 호스트로, 요청에 사용된 표기와 항상 같지는 않습니다.
scopeConfigWriteScope예어떤 구성 문서가 작성되었고 그 범위가 어디까지인지입니다. 요청은 하나의 워크스페이스를 지정하므로, 아무 언급이 없는 응답은 그 워크스페이스에 대한 것으로 읽힐 것이며, 머신 전체에 대한 쓰기에서는 그렇게 읽는 것이 틀립니다.
trustTrustFetchOutcome예레지스트리가 공시한 신뢰 정책을 읽은 결과입니다. 각 결과는 의미가 서로 다르므로 구분해 둡니다. 공시된 정책을 채택했거나, 레지스트리가 아무것도 공시하지 않았거나(이는 실패가 아닙니다), 그 대신 내장 기준선을 고정했거나, 읽기를 시도하지 않았습니다. 아무것도 공시되지 않은 경우에는 레지스트리에 연결할 수 있었는지 여부를 함께 명시합니다.

추가 속성은 허용되지 않습니다.

RegistryRemoveResult

레지스트리를 제거하면서 무엇을 어디에 썼는지입니다.

속성타입필수설명
hoststring예항목이 제거된 호스트입니다.
scopeConfigWriteScope예어떤 구성 문서가 작성되었고 그 범위가 어디까지인지입니다. 요청은 하나의 워크스페이스를 지정하므로, 아무 언급이 없는 응답은 그 워크스페이스에 대한 것으로 읽힐 것이며, 머신 전체에 대한 쓰기에서는 그렇게 읽는 것이 틀립니다.

추가 속성은 허용되지 않습니다.

RegistryUpdateResult

로컬 인덱스 갱신이 호스트별로 수행한 작업입니다.

속성타입필수설명
hostsHostUpdate[] 또는 null예갱신이 각 호스트에 대해 수행한 작업입니다.
failedstring[] 또는 null예갱신을 완료하지 못한 호스트입니다.
indexRootstring예인덱스가 기록된 디렉터리입니다.
registriesConfigured불리언예레지스트리가 하나라도 구성되어 있는지 여부입니다.
reachedRegistries불리언예이 응답에서는 항상 true입니다. 레지스트리 목록 조회와 검색은 구성과 로컬 인덱스에서 응답하지만, 인덱스 갱신은 레지스트리 자체에 접속합니다. 특정 레지스트리에 실제로 연결되었는지는 hosts의 해당 항목에 unreachable로 표시됩니다.

추가 속성은 허용되지 않습니다.

LogoutResult

어떤 저장된 자격 증명이 제거되었는지와 저장소가 미치는 범위입니다.

속성타입필수설명
registrystring예자격 증명이 제거된 레지스트리입니다.
scopeCredentialStoreScope예자격 증명 변경이 미치는 범위입니다. 저장소는 머신의 모든 프로젝트와 같은 레지스트리를 사용하는 다른 모든 도구가 공유하므로, 응답은 세션 범위로 추측되도록 두지 않고 이를 보고합니다.

추가 속성은 허용되지 않습니다.

PublishEntityResult

엔티티를 게시하여 무엇이 어디에 놓였는지입니다. pin 단계를 먼저 실행한 게시는 그 단계가 한 일도 pin으로 함께 담으며, 이 단계가 실행되지 않은 경우에는 없습니다.

속성타입필수설명
referencestring예엔티티가 게시된 참조입니다.
tagstring예게시된 태그입니다.
kindstring예게시된 엔티티 종류입니다.
mediaTypestring예게시된 바이트에 대해 기록된 미디어 타입입니다.
sizeinteger예게시된 바이트 수입니다.
sizeTextstring예같은 크기를 사람이 읽기 쉬운 형태로 쓴 것입니다.
pluginSizeinteger아니요Plugin 엔티티와 함께 게시된 플러그인 모듈이 차지하는 바이트 수입니다.
pluginSizeTextstring아니요같은 크기를 사람이 읽기 쉬운 형태로 쓴 것입니다.
digeststring예게시된 내용의 다이제스트입니다. 드라이 런에서는 같은 내용을 게시했을 때 놓일 다이제스트로, 내용만으로 계산되며 aggrega push --dry-run이 출력하는 값입니다.
signed불리언예이 게시가 서명을 첨부했는지 여부입니다. 게시 전에 만든 서명이거나, 이미 게시된 버전의 경우 그 버전에 없던 서명입니다.
alreadyPublished불리언예같은 바이트가 이미 있어서 내용이 업로드되지 않았는지 여부입니다. 그 게시에 아직 없던 것만 옆에 첨부되었습니다. 즉 게시 날짜와, 이 게시가 서명하는 경우 그 서명입니다. 서명이 첨부되었는지는 signed가 알려 줍니다.
dryRun불리언예게시가 실제로 한 일이 아니라 게시했다면 놓였을 것을 보고하는지 여부입니다.
reachPublicationReach예게시가 어디까지 도달했는지를 나타냅니다. 이 응답은 이 머신을 완전히 넘어서 도달하므로(응답이 첨부하는 것은 해당 레지스트리의 모든 소비자가 해석하는 대상입니다), 각 응답은 접근한 모든 레지스트리와 호출이 그곳에 무언가를 첨부했는지 여부를 명시합니다.
pinPinResult아니요고정 단계가 엔터티 옆의 잠금에 수행한 작업, 또는 시험 실행에서 수행할 작업입니다. aggrega/pin에 대한 응답이며, 이 단계를 실행한 게시는 이를 pin으로 포함합니다.
wholeDirectorySourcestring아니요작성된 그대로의 엔티티 로컬 소스로, 템플릿으로 작성된 경우에 있습니다. 이러한 소스는 Release가 템플릿을 채운 뒤에야 디렉터리를 가리키므로, 게시에는 엔티티가 지정한 파일만이 아니라 엔티티 디렉터리의 모든 파일이 담깁니다. 그 파일들만 담는 경우에는 없습니다.
windowsUnusableEntriesstring[]아니요게시된 아카이브의 항목 중 경로에 Windows가 작성된 그대로 가질 수 없는 부분이 있는 항목입니다. 즉 CON, AUX, NUL처럼 Windows가 장치용으로 예약한 이름(대소문자나 뒤따르는 확장자와 무관)이거나, 마침표나 공백으로 끝나는 부분입니다. 엔티티 문서 자체의 파일 이름이 먼저 오고, 그다음 문서가 담는 파일이 옵니다. Windows의 워크스페이스는 이들의 압축 해제를 거부하므로 해당 버전을 사용할 수 없습니다. 게시는 이들이 없을 때와 똑같이 진행되거나 중단됩니다. 해당 항목이 없으면 없으며, 문서만으로 게시된 엔티티도 여기에 포함됩니다.

추가 속성은 허용되지 않습니다.

PublishArtifactResult

파일을 게시하여 무엇이 어디에 놓였는지입니다.

속성타입필수설명
referencestring예파일이 게시된 참조입니다.
tagstring예게시된 태그입니다.
mediaTypestring예게시된 바이트에 대해 기록된 미디어 타입입니다.
sizeinteger예게시된 바이트 수입니다.
sizeTextstring예같은 크기를 사람이 읽기 쉬운 형태로 쓴 것입니다.
digeststring예게시된 내용의 다이제스트입니다.
alreadyPublished불리언예같은 바이트가 이미 있어서 내용이 업로드되지 않았는지 여부입니다. 게시 날짜는 아티팩트에 없던 경우에만 옆에 첨부되었습니다.
dryRun불리언예게시가 실제로 한 일이 아니라 게시했다면 놓였을 것을 보고하는지 여부입니다.
reachPublicationReach예게시가 어디까지 도달했는지를 나타냅니다. 이 응답은 이 머신을 완전히 넘어서 도달하므로(응답이 첨부하는 것은 해당 레지스트리의 모든 소비자가 해석하는 대상입니다), 각 응답은 접근한 모든 레지스트리와 호출이 그곳에 무언가를 첨부했는지 여부를 명시합니다.

추가 속성은 허용되지 않습니다.

SignArtifactsResult

무엇이 서명되었고 서명이 어디에 놓였는지입니다.

속성타입필수설명
signedSignedArtifact[] 또는 null예서명된 각 참조입니다.
reachPublicationReach예게시가 어디까지 도달했는지를 나타냅니다. 이 응답은 이 머신을 완전히 넘어서 도달하므로(응답이 첨부하는 것은 해당 레지스트리의 모든 소비자가 해석하는 대상입니다), 각 응답은 접근한 모든 레지스트리와 호출이 그곳에 무언가를 첨부했는지 여부를 명시합니다.

추가 속성은 허용되지 않습니다.

DeprecateArtifactResult

무엇이 사용 중단으로 표시되었고 표시가 어디에 놓였는지입니다.

속성타입필수설명
markedDeprecationMarked[] 또는 null예표시된 각 버전입니다.
reachPublicationReach예게시가 어디까지 도달했는지를 나타냅니다. 이 응답은 이 머신을 완전히 넘어서 도달하므로(응답이 첨부하는 것은 해당 레지스트리의 모든 소비자가 해석하는 대상입니다), 각 응답은 접근한 모든 레지스트리와 호출이 그곳에 무언가를 첨부했는지 여부를 명시합니다.

추가 속성은 허용되지 않습니다.

ResolveResult

커서 아래에 있는 것이 정의된 위치입니다.

속성타입필수설명
locationnull 또는 Location예정의된 위치입니다. 커서 아래의 어떤 것도 정의로 해석되지 않으면 null입니다.

추가 속성은 허용되지 않습니다.

FindReferencesResult

커서 아래에 있는 것이 참조되는 위치입니다.

속성타입필수설명
locationsLocation[] 또는 null예참조되는 각 위치입니다.

추가 속성은 허용되지 않습니다.

FindImplementationsResult

커서 아래에 있는 것을 구현하는 문서입니다.

속성타입필수설명
locationsLocation[] 또는 null예구현되는 각 위치입니다.

추가 속성은 허용되지 않습니다.

HoverResult

커서 아래에 있는 것에 대해 표시할 내용입니다.

속성타입필수설명
contentsnull 또는 MarkupContent예표시할 내용입니다. 커서 아래에 있는 것에 대해 말할 것이 없으면 null입니다.

추가 속성은 허용되지 않습니다.

CompletionResult

커서 위치에 작성할 수 있는 것입니다.

속성타입필수설명
itemsCompletionItem[] 또는 null예작성할 수 있는 각 항목입니다.

추가 속성은 허용되지 않습니다.

CatalogIndexResult

워크스페이스 인덱스가 보유한 모든 엔터티와, 워크스페이스 밖의 디렉터리 및 파일로 이어지는 링크 중 인덱스를 위해 읽히지 않은 링크입니다.

속성타입필수설명
entitiesCatalogEntity[] 또는 null예각 엔터티입니다.
unreadLinkedDirsstring[]예워크스페이스 루트 아래에서 루트 밖의 디렉터리로 이어지는 각 링크로, 링크 자체가 위치한 곳을 기준으로 루트에 대한 상대 경로로 명명되며 워크스페이스가 탐색되는 순서를 따릅니다. 루트 밖의 디렉터리는 탐색되지 않으므로 이러한 링크 뒤에 있는 문서는 워크스페이스 자체의 것으로 entities에 포함되지 않으며, 엔터티를 나열하는 클라이언트는 그 이유를 알려 줄 수 있습니다. 명명되지 않는 것: 루트 안의 디렉터리로 이어지는 링크(실제로 위치한 곳에서 탐색되거나 제외됨), 위치나 이름 또는 .gitignore로 인해 디렉터리가 제외될 위치에 있는 링크, 아무 곳으로도 이어지지 않거나 순환하여 해석할 수 없는 링크, 그리고 Release 기준으로 제공된 응답에서 다른 Releases만 읽는 카탈로그 디렉터리 아래의 링크입니다. 워크스페이스에 해당 링크가 없으면 비어 있습니다.
unreadLinkedFilesstring[]예워크스페이스 루트 아래에서 YAML 파일처럼 이름이 붙은(자체 이름이 .yaml 또는 .yml로 끝나는) 링크 중 루트 밖의 파일로 이어지는 각 링크로, 링크 자체가 위치한 곳을 기준으로 루트에 대한 상대 경로로 명명되며 워크스페이스가 탐색되는 순서를 따릅니다. 그러한 파일은 무엇을 선언하든 인덱스를 위해 읽히지 않으므로, 그 파일이 선언하는 엔터티는 워크스페이스 자체의 것으로 entities에 포함되지 않으며, 엔터티를 나열하는 클라이언트는 그 이유를 알려 줄 수 있습니다. 워크스페이스 밖의 엔터티는 구성된 카탈로그 디렉터리를 통해 읽힙니다. 명명되지 않는 것: 워크스페이스 구성이 build.authoring_release 또는 workspace.releases의 키로서 Release로 지정하고 실제로 Release를 선언하는 파일로 이어지는 링크(링크 자체의 위치에서 읽히고 entities에 나열됨), 루트 안의 파일로 이어지는 링크(링크 자체의 위치에서 읽힘), .gitignore가 제외하는 링크 또는 탐색이 제외하는 디렉터리 안의 링크, 파일로 이어지지 않는 링크(디렉터리로 이어지는 경우 루트 밖으로 이어지면 unreadLinkedDirs가 명명함, 아무 곳으로도 이어지지 않거나 순환하는 경우 포함), 그리고 Release 기준으로 제공된 응답에서 다른 Releases만 읽는 카탈로그 디렉터리 아래의 링크입니다. 워크스페이스 밖으로 이어지는 링크인 워크스페이스 구성 파일, 즉 자체 .aggrega-config.yaml 또는 그 옆의 CI 소유 오버레이는 탐색이 그것을 만났는지와 관계없이 탐색이 명명한 링크 뒤에 명명됩니다. 이 경우 워크스페이스의 구성은 전혀 읽히지 않고, 이 응답은 아무것도 구성되지 않은 상태로 읽은 워크스페이스 자체의 인덱스이므로 카탈로그 디렉터리는 읽히지 않으며, 구성이 결정하는 모든 요청(Release 기준의 인덱스 포함)은 해당 워크스페이스에 대해 읽기 보류 조건과 함께 거부됩니다. 워크스페이스에 해당 링크가 없으면 비어 있습니다.

추가 속성은 허용되지 않습니다.

AttachCandidatesResult

엔터티에 연결할 수 있는 Features와 판단 기준이 된 레이블, 그리고 요청이 연결을 지정한 경우 그 소켓이 선언하는 슬롯과 각 슬롯을 채울 수 있는 Features입니다.

속성타입필수설명
nodestring예후보를 판단한 대상 엔터티입니다.
nodeLabelsmap of string 또는 null예판단의 기준이 된 레이블입니다.
labelSourcestring예사용된 레이블 집합이며, 이는 표면적인 차이가 아닙니다. 문서에 선언된 레이블은 소스를 읽어서 볼 수 있는 것이고, 그래프 노드의 레이블은 빌드 자체가 판단 기준으로 삼는 최종 집합입니다. 후자를 기준으로 계산된 응답은 빌드가 수행할 동작에 대한 진술입니다.
candidatesSourcedEntityRef[] 또는 null예연결할 수 있는 각 Feature입니다.
slotsSlotCandidacy[]아니요요청이 연결을 지정한 경우에만 존재합니다. 연결의 소켓이 선언하는 각 슬롯이 Component가 선언한 순서대로, 그 슬롯을 채울 수 있는 Features와 함께 담깁니다. 연결에서 채울 수 있는 슬롯이 없으면 비어 있으며, 이때 noSlotReason이 그 이유를 알려 줍니다. 클라이언트는 빈 목록을 어떤 Feature도 일치하지 않은 슬롯으로 받아들이지 말고 이 값을 읽어야 합니다.
noSlotReasonconst “feature-created-connection” 또는 const “ad-hoc-socket” 또는 const “no-slot-declared”아니요요청이 연결을 지정했고 그 연결에서 채울 수 있는 슬롯이 없는 경우에만 존재하며, 그곳에 아무것도 연결할 수 없는 이유입니다. 소켓이 슬롯을 선언한 경우에는 항상 없습니다. 이 집합은 닫혀 있습니다. 허용되는 값: "feature-created-connection" — Feature가 연결을 그렸으며, 첨부는 컴포넌트나 Release가 그리는 연결에만 작성됩니다. "ad-hoc-socket" — 소켓이 Component가 선언하지 않은 것이므로, 연결이 채울 슬롯을 선언하지 않습니다. "no-slot-declared" — Component가 소켓을 선언하지만 그 위에 슬롯을 선언하지 않습니다.

추가 속성은 허용되지 않습니다.

ConnectionCandidatesResult

엔터티의 각 소켓이 연결될 수 있는 엔터티입니다.

속성타입필수설명
nodestring예이 소켓들을 가진 엔터티입니다.
adHocSocketsAccepted불리언예엔터티 자체 정의가 미리 선언하지 않은 소켓도 작성할 수 있는지 여부입니다.
socketsSocketCandidacy[] 또는 null예각 소켓과 그 소켓에 연결할 수 있는 것입니다.

추가 속성은 허용되지 않습니다.

InsertionPointResult

지정된 컨테이너 아래의 새 항목이 문서의 어디에 들어가야 하는지, 그리고 클라이언트가 그곳에 항목을 작성하는 데 필요한 정보입니다. 즉 삽입 지점 자체, 텍스트를 줄 바꿈으로 시작해야 하는지 여부, 아직 없는 컨테이너 키, 각 줄의 들여쓰기입니다.

속성타입필수설명
filestring예문서입니다.
containerstring[] 또는 null예문서를 거쳐 컨테이너에 이르는 경로입니다.
positionEncodingstring예이 응답의 위치를 표현하는 인코딩입니다.
positionPosition예문서 안의 한 위치로, 줄과 그 줄 안의 문자 오프셋이며 둘 다 0부터 셉니다. 오프셋은 세션이 열릴 때 합의한 인코딩의 단위로 측정되며, 클라이언트가 다른 인코딩을 요청하지 않으면 UTF-16입니다.
precededByLineBreak불리언예해당 위치에 작성하는 텍스트가 줄 바꿈으로 시작해야 하는지 여부로, 위치가 문서에 이미 있는 줄의 끝에 있기 때문입니다. 문서에 항목이 뒤따를 내용이 전혀 없는 경우에만 false입니다.
missingContainerKeysstring[] 또는 null예문서에 아직 없는 컨테이너 경로의 세그먼트로, 가장 바깥쪽부터 나열됩니다. 항목이 가장 안쪽 세그먼트 안에 들어가려면 먼저 각 세그먼트를 앞의 것보다 한 단계 더 들여쓴 별도의 키로 작성해야 합니다. 경로 전체가 이미 있으면 null입니다.
entryIndentinteger예항목 자체의 첫 줄이 시작되는 열로, 줄의 시작부터 공백 수로 셉니다.
indentStepinteger예중첩 수준마다 추가로 들여쓰는 양입니다.
indentStepMeasured불리언예들여쓰기 단계가 이 문서 자체의 중첩에서 측정되었는지 여부입니다. false이면 문서에 측정할 중첩이 없어 단계가 대체값이므로, 자체 값을 적용하려는 클라이언트는 그렇게 해도 됨을 알 수 있습니다.
entryShapeconst “mapping” 또는 const “sequence” 또는 const “unknown”예컨테이너가 항목을 담는 형태로, 항목 자체의 텍스트를 구성하는 방식을 결정합니다. 문서에 이미 있는 컨테이너에서 읽어 내며, 컨테이너의 이름으로 추론하지 않습니다. 이 집합은 닫혀 있습니다. 허용되는 값: "mapping" — 컨테이너가 블록 매핑이므로, 여기에 추가되는 항목은 키와 그 값입니다. "sequence" — 컨테이너가 블록 시퀀스이므로, 여기에 추가되는 항목은 대시와 그 값입니다. "unknown" — 문서에 컨테이너가 없거나 컨테이너가 비어 있으므로, 항목이 어떤 형태를 취할지는 클라이언트가 결정합니다.

추가 속성은 허용되지 않습니다.

AttachmentContainerResult

그래프 노드 또는 요청이 지정한 연결에 대한 첨부가 들어가야 하는 문서와 그 문서 안의 위치입니다.

속성타입필수설명
nodestring예부착의 대상인 그래프 노드입니다.
filestring예첨부가 들어가야 하는 문서입니다.
containerstring[] 또는 null예해당 문서를 거쳐 첨부가 들어갈 위치에 이르는 경로입니다.

추가 속성은 허용되지 않습니다.

ConnectionAtPositionResult

위치가 속한 항목의 연결, 또는 연결이 보고되지 않은 이유입니다. 정확히 한쪽만 존재합니다. graphNode와 connection이 함께 있거나, noConnectionReason만 있습니다. 항목 안의 어느 위치든(별칭, 대상, 첨부 위 포함) 그 항목 안에 있는 것으로 보며, 항목이 중첩된 경우 가장 안쪽 항목에 속합니다. 소켓 자체의 키 위, 즉 그 아래 작성된 항목들보다 위에 있는 위치는 어느 항목에도 속하지 않습니다.

속성타입필수설명
graphNodestring아니요연결을 그리는 component를 가진 노드의 id로, 컴파일된 그래프가 사용하는 키입니다. 후보 및 컨테이너 요청이 graphNode로 받는 값입니다.
connectionConnectionCoordinate아니요소켓과 별칭으로 식별되는 연결이며, document는 위치를 읽은 문서를 가리킵니다. 후보 및 컨테이너 요청이 connection으로 받는 값입니다.
noConnectionReasonconst “no-connection-entry” 또는 const “feature-created-connection” 또는 const “unknown-connection”아니요연결이 보고되지 않는 경우에만 존재하며, 그 이유를 나타냅니다. 이 집합은 닫혀 있습니다. 허용되는 값: "no-connection-entry" — 위치가 첨부가 작성되는 어떤 항목 위에도 있지 않습니다. 컴포넌트가 별칭 아래에 작성하여 연결을 그리는 항목도, Release의 엣지별 항목도 아닙니다. 대상 목록으로 작성된 연결과 Feature 자체 블록이 그리는 연결에는 그러한 항목이 없습니다. "feature-created-connection" — 위치가 Feature가 그린 연결에 대해 Release가 작성한 항목 위에 있으며, 첨부는 컴포넌트나 Release가 그리는 연결에만 작성됩니다. "unknown-connection" — 위치가 컴파일된 그래프에 없는 연결에 대해 Release가 작성한 항목 위에 있습니다.

추가 속성은 허용되지 않습니다.

ReleaseCandidatesResult

워크스페이스가 보유한 Releases와, 그 Releases를 위해 읽히지 않은 채 워크스페이스 밖의 디렉터리와 파일로 이어지는 링크입니다.

속성타입필수설명
releasesstring[] 또는 null예각 Release 문서입니다.
lockfilesstring 맵예나열된 각 Release의 lockfile로, 나열된 그대로의 Release를 키로 합니다. 각각은 pull이 해당 Release를 위해 쓰고 build가 읽는 파일이므로, 클라이언트는 그 위치를 직접 알아내는 대신 여기서 읽습니다. 워크스페이스에 Release가 없으면 비어 있습니다.
unreadLinkedDirsstring[]예워크스페이스 루트 아래에서 루트 밖의 디렉터리로 이어지는 각 링크로, 링크 자체가 있는 위치를 기준으로 루트에 대한 상대 경로로 이름이 지정되며 워크스페이스를 탐색하는 순서를 따릅니다. 루트 밖의 디렉터리는 탐색되지 않으므로, 이러한 링크를 통해서만 도달하는 Release는 releases에 포함되지 않으며, Releases를 제시하는 클라이언트는 그 이유를 알려 줄 수 있습니다. 포함되지 않는 것: 루트 안의 디렉터리로 이어지는 링크(실제 위치에서 탐색되거나 제외됨), 디렉터리가 그 위치나 이름 때문에 제외될 곳에 있는 링크, 그리고 아무 데도 이어지지 않거나 순환하여 해석할 수 없는 링크입니다. 워크스페이스에 해당 링크가 없으면 비어 있습니다.
unreadLinkedFilesstring[]예워크스페이스 루트 아래에서 YAML 파일처럼 이름이 지정되어(자신의 이름이 .yaml 또는 .yml로 끝남) 루트 밖의 파일로 이어지는 각 링크로, 링크 자체가 있는 위치를 기준으로 루트에 대한 상대 경로로 이름이 지정되며 워크스페이스를 탐색하는 순서를 따릅니다. 그러한 파일은 읽히지 않으므로, 이러한 링크를 통해서만 도달하는 Release는 releases에 포함되지 않으며, Releases를 제시하는 클라이언트는 그 이유를 알려 줄 수 있습니다. 파일이 Release인지는 읽지 않고는 알 수 없으므로, 그러한 링크는 파일 내용과 관계없이 모두 포함됩니다. 포함되지 않는 것: 워크스페이스 구성이 build.authoring_release로 또는 workspace.releases의 키로 Release라고 지정한 파일로 이어지는 링크(읽혀서 링크 자체의 위치에서 releases에 나열됨), 루트 안의 파일로 이어지는 링크(읽힘), 탐색에서 제외되는 디렉터리 안의 링크, 그리고 파일이 아닌 곳, 즉 디렉터리(루트 밖으로 이어지면 unreadLinkedDirs가 지정함)나 아무 데도 아닌 곳으로 이어지거나 순환하는 링크입니다. 워크스페이스 밖으로 이어지는 링크인 워크스페이스 구성 파일, 즉 워크스페이스 자체의 .aggrega-config.yaml 또는 그 옆의 CI 소유 오버레이는 탐색이 그것을 만났는지와 관계없이 탐색이 지정한 링크들 뒤에 포함됩니다. 이 경우 워크스페이스의 구성은 전혀 읽히지 않고, 이 응답은 아무것도 구성되지 않은 상태로 읽히므로 구성이 링크를 통해 지정한 Release는 나열되지 않으며, 구성이 결정하는 모든 요청은 해당 워크스페이스에 대해 읽기 보류의 조건과 함께 거부됩니다. 워크스페이스에 해당 링크가 없으면 비어 있습니다.

추가 속성은 허용되지 않습니다.

ActiveReleaseResult

클라이언트가 기본적으로 작업해야 할 Release입니다. 어떤 Release도 가리키지 않는 워크스페이스는 실패가 아니라 일반적인 상태이므로, 오류로 발생시키는 대신 선택이 어떻게 시도되었는지에 대한 설명과 함께 여기서 보고됩니다.

속성타입필수설명
releasestring예결정된 Release이며, 결정된 것이 없으면 비어 있습니다.
lockfilestring아니요결정된 Release의 lockfile로, pull이 그 Release를 위해 쓰고 build가 읽는 파일입니다. 결정된 Release가 없으면 없습니다.
reasonstring아니요Release가 결정되지 않은 이유입니다.
tracestring아니요선택의 각 단계와 그 단계에서 찾은 것으로, 호출자가 어느 단계가 선택을 결정했을지 알 수 있게 합니다.

추가 속성은 허용되지 않습니다.

EditDocumentResult

편집이 무엇을 어디에 썼는지입니다. 쓰기 후에는 데몬이 읽어 둔 문서 내용이 버려지므로, 그 문서에 대한 다음 응답은 편집이 만들어 낸 바이트로부터 계산됩니다.

속성타입필수설명
filestring예편집된 문서입니다.
editstring예적용된 편집입니다.
containerstring[] 또는 null예문서 안에서 편집이 적용된 위치까지의 경로입니다.
createdContainersstring[] 또는 null예편집이 도중에 만들어야 했던 컨테이너입니다.
writtenstring[] 또는 null예쓰인 문서입니다.
contentstring예결과를 쓰지 않고 보여 달라고 요청한 경우의 구성된 문서입니다.

추가 속성은 허용되지 않습니다.

EffectiveConfigurationResult

워크스페이스가 해석한 구성과, 각 설정이 어느 문서에서 왔는지입니다.

속성타입필수설명
layersstring[] 또는 null예병합된 구성 문서로, 병합된 순서를 따릅니다.
settingsEffectiveConfigurationSetting[] 또는 null예해석된 각 설정과 그 출처입니다.

추가 속성은 허용되지 않습니다.

ConfigInitResult

구성 초기 생성이 무엇을 어디에 썼는지, 그리고 레지스트리에서 무엇을 읽었는지입니다.

속성타입필수설명
hoststring예구성이 생성된 대상 레지스트리입니다.
scopeConfigWriteScope예어떤 구성 문서가 작성되었고 그 범위가 어디까지인지입니다. 요청은 하나의 워크스페이스를 지정하므로, 아무 언급이 없는 응답은 그 워크스페이스에 대한 것으로 읽힐 것이며, 머신 전체에 대한 쓰기에서는 그렇게 읽는 것이 틀립니다.
trustTrustFetchOutcome예레지스트리가 공시한 신뢰 정책을 읽은 결과입니다. 각 결과는 의미가 서로 다르므로 구분해 둡니다. 공시된 정책을 채택했거나, 레지스트리가 아무것도 공시하지 않았거나(이는 실패가 아닙니다), 그 대신 내장 기준선을 고정했거나, 읽기를 시도하지 않았습니다. 아무것도 공시되지 않은 경우에는 레지스트리에 연결할 수 있었는지 여부를 함께 명시합니다.
written불리언예문서가 쓰였는지, 아니면 호출자가 배치하도록 돌려주었는지 여부입니다.
existed불리언아니요문서가 이미 있어서 새 문서를 만드는 대신 레지스트리 항목을 그 문서에 병합했을 때 존재하며 true입니다. force를 보낸 요청만 기존 문서 위에서 진행하므로, 그렇지 않은 요청에 대한 모든 응답에는 없습니다.
contentstring아니요문서를 쓰지 않고 보여 달라고 요청한 경우의 문서 텍스트입니다.

추가 속성은 허용되지 않습니다.

ConfigCaptureResult

해석된 구성을 고정하면서 이 워크스페이스 자체의 문서에 쓴 내용입니다.

속성타입필수설명
configFilestring예쓰인 문서입니다. 목적이 하나의 워크스페이스를 자체 완결적으로 만드는 것이므로 항상 이 워크스페이스 자체의 문서입니다.
workspaceRootstring예요청이 지정한 워크스페이스입니다.
captured불리언예고정된 것이 있는지 여부입니다.
socketsConfigCapturedSocket[] 또는 null예고정된 각 소켓과 그 attachment입니다.
catalogDirsstring[] 또는 null예고정된 카탈로그 디렉터리입니다.

추가 속성은 허용되지 않습니다.

ImportResult

외부 소스 변환이 만들어 낸 것과 변환하지 못한 것입니다.

속성타입필수설명
formatstring예변환된 소스 형식입니다.
outputDirstring예응답의 모든 경로가 기준으로 삼는 디렉터리이자 파일이 쓰인 디렉터리입니다.
writtenstring[] 또는 null예디스크에 기록된 각 파일로, 쓰인 순서대로 초안들, 그다음 import가 쓴 내용의 기록입니다. sync에서는 sync가 변경한 초안과, 변경된 경우의 기록만 포함됩니다. dryRun에서는 비어 있습니다.
filesImportedFile[] 또는 null예요청이 쓰는 각 파일과 그 텍스트로, dryRun 여부와 관계없이 모든 초안, 그다음 import가 쓴 내용의 기록입니다. sync에서는 sync가 변경하는 각 초안과 새 텍스트, 그다음 기록도 변경되는 경우의 기록이므로, 이미 일치하는 sync는 빈 목록을 응답합니다.
driftImportDrift[]예sync가 소스에 맞게 갱신한(dryRun에서는 갱신할) 각 부분으로, 초안이 지정하는 순서를 따릅니다. sync가 삭제하는 초안 파일도 그중 하나이며, 키 없이 제거된 것으로 나타납니다. sync가 아닌 요청, 이미 일치하는 sync, 그리고 변환이 중단되어 아무것도 쓰지 않는 sync에서는 빈 목록입니다.
diagnosticsImportDiagnostic[] 또는 null예변환하지 못한 내용입니다.
decisionsImportDecision[]예importer가 각 소스 노드를 어떻게 매핑했는지로, importer의 순서대로 보고된 그대로입니다. 변환이 어디서 추측했는지 알려 주는 정보입니다. 두 전달 방식 모두에서, 그리고 변환이 중단되었는지와 관계없이 포함되며, 아무것도 보고하지 않는 importer에서는 빈 목록입니다.
owedImportOwed[]아니요초안이 아직 비워 두고 있으며 어떤 소스도 제공할 수 없었고 어떤 답변도 제공하지 않은 각 값으로, 초안이 작성되는 순서를 따릅니다 — 경고 결과가 지목하는 값입니다. 모든 응답에 포함되며, 초안에 빠진 것이 없으면 빈 목록입니다.
halted불리언예변환이 발견 사항과 함께 완료되지 않고 중단되었는지 여부입니다.

추가 속성은 허용되지 않습니다.

ScaffoldEntityResult

초안으로 작성된 시작용 문서, 실행 가능한 예제 목록, 또는 기록된 예제입니다. 각 형식은 자신의 필드로 응답하며 다른 필드는 생략합니다.

속성타입필수설명
kindstring아니요초안으로 작성된 엔티티 종류입니다. 초안 작성 시 존재합니다.
skeletonstring아니요초안 문서의 텍스트입니다. 초안 작성 시 존재합니다.
examplesScaffoldExample[]아니요문서가 게시하는 모든 실행 가능한 예제로, 각각 한 번씩 이름 순으로 나열됩니다. 예제를 하나라도 찾은 목록 요청에 존재합니다.
examplestring아니요기록된 예제입니다. 기록 시 존재합니다.
dirstring아니요예제가 기록된 디렉터리로, 워크스페이스 루트에 대한 상대 경로이며, 요청이 지정한 대로이거나, 지정하지 않은 경우 예제의 이름입니다. 기록 시 존재합니다.
filesstring[]아니요기록된 각 파일로, dir에 대한 상대 경로이자 슬래시로 구분되며, 문서에 담긴 순서대로 나열됩니다. 기록 시 존재합니다.
nextstring[]아니요예제 페이지가 그 예제를 빌드하기 위해 제시하는 명령으로, 페이지에 쓰인 그대로 한 줄씩, 주석을 포함합니다. 즉 그 Build 제목 아래의 첫 번째 셸 블록입니다. 페이지가 제시하지 않으면 존재하지 않습니다.
versionstring아니요예제를 읽어 온 문서의 버전으로, 바이너리용으로 게시된 것이 있으면 바이너리 자체의 버전이고, 없으면 그 이전에 게시된 최신 버전입니다. 기록 시 존재합니다.

추가 속성은 허용되지 않습니다.

ScaffoldExample

문서가 게시하는 실행 가능한 예제 하나입니다.

속성타입필수설명
namestring예예제의 이름으로, 요청은 이 예제를 기록하기 위해 이를 example로 보냅니다.
levelstring예예제 페이지가 그 예제에 대해 선언하는 수준입니다.
summarystring예예제 페이지의 첫 문장입니다.

추가 속성은 허용되지 않습니다.

LintResult

관례 검사가 찾아낸 내용으로, 심각도별로 집계되고 문서별로 나열됩니다. 각 Release마다 한 번씩 실행된 전체 카탈로그 검사는 passes도 함께 담으며, 이때 집계와 files는 모든 패스를 합쳐 다룹니다.

속성타입필수설명
entitystring아니요요청이 엔터티 하나를 지정한 경우, 검사된 그 엔터티입니다.
releasestring아니요요청이 Release 하나를 지정한 경우, 클로저가 검사된 그 Release입니다.
checkedinteger예검사된 문서 수입니다. 검사가 각 Release마다 한 번씩 실행된 경우에는 패스 전체의 합계이며, 두 패스가 읽은 문서는 각 패스에서 따로 집계됩니다.
findingsinteger예전체 발견 사항 수입니다.
errorsinteger예그중 오류의 수입니다.
warningsinteger예그중 경고의 수입니다.
infosinteger예그중 정보성 항목의 수입니다.
filesLintFileFindings[] 또는 null예문서별 발견 사항입니다.
halted불리언예검사가 발견 사항과 함께 완료되지 않고 중단되었는지 여부입니다.
passesLintPass[] 또는 null아니요한 번에 한 패스씩 본 전체 카탈로그 검사로, 워크스페이스가 workspace.releases 아래에 Releases를 지정하여 검사가 각 Release마다 한 번씩 실행된 경우에만 존재합니다. 각 패스는 그 발견 사항이 어느 Releases에 대해 발견되었는지 알려 줍니다. 아무것도 지정하지 않아 자체 디렉터리에 대해 한 번 검사되는 워크스페이스와, 엔터티 하나 또는 Release의 클로저에 대한 검사에서는 없습니다.

추가 속성은 허용되지 않습니다.

LintPass

Releases에 각자의 카탈로그 디렉터리를 부여하는 워크스페이스에서 실행된 전체 카탈로그 관례 검사의 한 패스로, 실행 대상인 Releases, 읽은 디렉터리, 그리고 그곳에서 찾아낸 내용을 담습니다.

속성타입필수설명
releasesstring[] 또는 null예패스가 실행된 대상 Releases로, 각각 워크스페이스 루트에 대한 상대 경로입니다. 같은 카탈로그 디렉터리를 읽는 Releases는 하나의 패스를 공유합니다.
catalogDirsstring[] 또는 null예패스가 읽은 카탈로그 디렉터리로, 검색되는 순서대로 나열되며 워크스페이스 루트 안에 있는 경우 각각 루트에 대한 상대 경로입니다. 해당 Releases가 카탈로그 디렉터리를 하나도 읽지 않으면 비어 있으며, 이때 패스는 아무것도 검사하지 않았고 다른 패스를 하나도 실패시키지 않았습니다.
checkedinteger예패스가 검사한 문서 수입니다.
findingsinteger예패스가 찾아낸 발견 사항 수입니다.
errorsinteger예그중 오류의 수입니다.
warningsinteger예그중 경고의 수입니다.
infosinteger예그중 정보성 항목의 수입니다.
filesLintFileFindings[] 또는 null예패스의 문서별 발견 사항입니다.

추가 속성은 허용되지 않습니다.

PluginAddResult

플러그인 연결이 무엇을 어디에 기록했고 어떤 버전을 고정했는지를 나타냅니다.

속성타입필수설명
typestring예플러그인이 연결된 소켓입니다.
identitystring아니요연결이 해석된 식별자입니다.
uristring아니요어태치먼트가 해석되는 출처 참조입니다.
capabilitystring아니요어태치먼트가 대상으로 하는 기능입니다.
referencestring아니요버전을 포함한 고정된 참조입니다.
scopePluginWriteScope예플러그인 변경이 어떤 구성 문서에 작성되었고 그 범위가 어디까지인지입니다. 명령 확장 소켓의 기본값은 머신 전체 문서이므로, 모든 응답은 어느 문서에 작성했는지 밝힙니다.
written불리언예구성 문서가 기록되었는지, 아니면 호출자가 배치하도록 돌려주었는지 여부입니다.
contentstring아니요기록하는 대신 보여 주기를 요청한 요청에 대한 구성 문서의 텍스트입니다.
retractionPluginRetraction아니요지원 중단 마커가 어떤 플러그인 버전이 고정되었는지에 영향을 준 방식입니다.
withdrawn불리언아니요쿼리가 고정된 버전을 지정했고 이 워크스페이스가 신뢰하는 철회 선언이 그 버전을 철회한 경우 true입니다. 지정된 버전은 지정하는 것 자체가 재정의이므로 그대로 고정됩니다. 그 밖의 경우에는 없으며, 없다고 해서 해당 버전이 철회되지 않았다는 뜻은 아닙니다. 지정된 버전의 철회 마커를 읽을 수 없었던 경우 retraction.unscreened가 그 이유를 알려 주며, 버전을 지정하지 않으면 게시된 최신 버전이 선택되고 retraction이 그 선택에 대해 철회 검사가 내린 결론을 보고합니다.

추가 속성은 허용되지 않습니다.

PluginRemoveResult

플러그인 분리가 무엇을 어디에 기록했는지를 나타냅니다.

속성타입필수설명
typestring예플러그인이 연결된 소켓입니다.
querystring예제거된 연결입니다.
scopePluginWriteScope예플러그인 변경이 어떤 구성 문서에 작성되었고 그 범위가 어디까지인지입니다. 명령 확장 소켓의 기본값은 머신 전체 문서이므로, 모든 응답은 어느 문서에 작성했는지 밝힙니다.

추가 속성은 허용되지 않습니다.

PluginSyncResult

Plugin 엔터티의 기계 소유 레코드를 해당 모듈과 맞추는 작업이 무엇을 변경했는지를 나타냅니다.

속성타입필수설명
entitystring예맞춰진 Plugin 엔터티 문서입니다.
hostFunctionsstring[] 또는 null예모듈이 필요하다고 선언한 호스트 함수입니다.
commandsPluginCLICommand[] 또는 null예모듈이 제공하는 명령입니다.
changed불리언예문서에서 실제로 바뀐 것이 있는지 여부입니다.

추가 속성은 허용되지 않습니다.

PluginGenCatalogResult

생성 작업이 만들어 낸 카탈로그 문서입니다.

속성타입필수설명
documentsPluginGeneratedDocument[]아니요생성된 각 문서와 그 텍스트입니다.
noticesstring아니요생성 작업이 호출자에게 알리고자 하는 모든 내용입니다.
dryRun불리언예문서가 기록되지 않고 돌려주어졌는지 여부입니다.

추가 속성은 허용되지 않습니다.

ExplainErrorResult

컴파일러가 조건에 대해 선언하는 내용과, 작성 시 수정 방법을 알려 주는 게시된 문단입니다.

속성타입필수설명
shortCodestring예조건의 짧은 코드입니다.
codestring예조건의 설명적 이름입니다.
messagestring예조건이 발생할 때 출력하는 내용입니다.
entriesExplainErrorEntry[]아니요수정 방법을 알려 주는 게시된 문단입니다.
referencestring예조건이 설명된 게시 주소입니다.
notestring아니요게시된 문단을 가져올 수 없었던 경우, 그것이 없는 이유입니다. 바이너리 자체가 선언하는 내용은 여전히 응답됩니다.

추가 속성은 허용되지 않습니다.

GetSchemaResult

한 종류의 스키마, 또는 요청이 아무것도 지정하지 않은 경우 지정할 수 있는 종류 목록입니다. 두 범위는 두 메서드가 아닌 하나의 응답에 담기는데, “무엇을 지정할 수 있는가”와 “그중 작성자가 문서를 작성하는 것은 무엇인가”는 범위만 다른 같은 질문이며, 응답이 둘이면 서로 일치하도록 유지해야 하기 때문입니다.

속성타입필수설명
kindstring아니요스키마가 대상으로 하는 종류입니다.
schemaany아니요바이너리가 보유한 그대로 전달되는 스키마 자체입니다.
kindsstring[]아니요이 바이너리가 응답하는 모든 토큰입니다.
entityKindsEntityKindDescriptor[]아니요작성자가 문서를 작성하는 더 좁은 집합으로, 각 항목은 요청이 지정하는 토큰과 문서 자체의 헤더가 선언하는 종류를 짝지어 줍니다.

추가 속성은 허용되지 않습니다.

SkillsInstallResult

어시스턴트 스킬 설치가 무엇을 어디에 기록했는지입니다.

속성타입필수설명
skillstring예기록된 스킬입니다.
installedSkillsInstalledFolder[]예기록된 각 스킬 폴더로, 요청이 어시스턴트를 지정한 순서를 따릅니다. 하나의 공유 폴더를 읽는 어시스턴트들은 항목 하나를 공유하는데, 스킬이 그곳에 한 번만 기록되기 때문입니다.
scopeSkillFolderScope예스킬 설치가 미치는 범위입니다. 요청은 하나의 워크스페이스를 지정하므로, 아무것도 밝히지 않은 응답은 그 워크스페이스에 관한 것으로 읽힙니다. 그러나 어시스턴트가 모든 프로젝트에서 읽는 사용자별 폴더의 경우 그렇게 읽는 것은 잘못입니다.

추가 속성은 허용되지 않습니다.

SkillsInstalledFolder

설치가 기록한 스킬 폴더 하나입니다.

속성타입필수설명
agentsstring[]예이 폴더를 읽는 지정된 어시스턴트의 식별자로, 요청이 지정한 순서를 따릅니다.
folderstring예스킬의 폴더로, 절대 경로입니다.
replaced불리언예기록된 모든 스킬 사본에 포함되는 주석 줄을 가진 사본(이전 설치가 기록한 것이거나 게시된 스킬 저장소에서 가져온 것)이 그곳에 있었고 교체되었는지 여부입니다. 그 줄이 없는 파일이 그곳에 있으면 교체되지 않고 거부됩니다.

추가 속성은 허용되지 않습니다.

SkillsListResult

바이너리에 포함된 스킬과, 설치가 그 스킬을 기록할 수 있는 모든 어시스턴트입니다. 아무것도 기록하지 않으며 어디에도 접근하지 않습니다.

속성타입필수설명
skillsSkillsListedSkill[]예바이너리에 포함된 각 스킬로, 고정된 순서를 따릅니다.
agentsSkillsListedAgent[]예설치가 스킬 폴더를 알고 있는 각 어시스턴트로, 식별자 순으로 정렬됩니다.

추가 속성은 허용되지 않습니다.

SkillsListedSkill

바이너리에 포함된 스킬 하나입니다.

속성타입필수설명
namestring예스킬의 이름으로, 설치가 기록하는 폴더의 이름이기도 합니다.
descriptionstring예어시스턴트가 스킬을 사용하는 시점으로, 스킬 자체가 선언한 대로입니다.

추가 속성은 허용되지 않습니다.

SkillsListedAgent

설치가 스킬을 기록할 수 있는 어시스턴트 하나와, 그 어시스턴트가 스킬을 읽는 두 폴더입니다.

속성타입필수설명
idstring예요청이 어시스턴트를 지정할 때 쓰는 식별자입니다.
namestring예어시스턴트 자체의 이름입니다.
projectFolderstring예어시스턴트가 프로젝트의 스킬을 읽는 폴더로, 프로젝트 루트에 대한 상대 경로이며 슬래시로 구분됩니다. 프로젝트 설치는 요청이 지정한 워크스페이스에서 이 폴더 안에 스킬의 폴더를 기록합니다.
userFolderstring예어시스턴트가 모든 프로젝트에서 사용자 자신의 스킬을 읽는 폴더로, 홈 디렉터리에 대한 상대 경로이며 슬래시로 구분됩니다. global이 있는 설치는 이 폴더 안에 스킬의 폴더를 기록합니다.

추가 속성은 허용되지 않습니다.