Aggrega バックグラウンドデーモンのワイヤープロトコルスキーマ
自動生成されたリファレンスです。手動で編集しないでください。公開されている JSON Schema から再生成してください。
スキーマ ID: https://aggrega.ai/schemas/serve-wire-v1beta1.schema.json
aggrega serve で起動したバックグラウンドのコンパイラデーモンとやり取りされるメッセージの形です。クライアントはハンドシェイクによってそのデーモン上でセッションを開きます。セッションは、会話を開いた際の設定とワークスペースのスコープを定めるものです。デーモンは、リクエストに応答し、通知を送信し、読み込んだ内容を保持するプロセスです。プロトコルは標準入出力上の JSON-RPC 2.0 で、各メッセージは Content-Length ヘッダーでフレーミングされます。このドキュメントはメッセージ本体を説明するもので、フレーミングとトランスポートは説明しません。本体は次の 4 つのいずれかです。クライアントが送信するリクエスト、クライアントが送信する通知、デーモンが送信する通知、またはデーモンがリクエストに対して返すレスポンスです。以下の形の書き方は、このインターフェースの 3 つの性質によって決まります。第一に、すべてのリクエストは、そのメソッド自身が宣言するフィールドに加えて 2 つのフィールドを受け付けます。リクエストが対象とするワークスペースを示す workspaceRoot と、呼び出し側が生成し、進捗の報告に使われる値である workDoneToken です。そのため、ここではこの両方がすべてのリクエストの params オブジェクトに現れます。対象がワークスペースではない 3 つのメソッドも同様です。aggrega/getSchema と aggrega/scaffoldEntity は workspaceRoot を受け付けても無視し、aggrega/initialize はそれをセッションが宣言するワークスペースとして読み取ります。第二に、デーモンは、メソッドが受け付けないフィールドを含むリクエストの params オブジェクトを拒否し、受け付けるフィールドを示します。そのため、ここでのすべての params オブジェクトはトップレベルで閉じています。リクエスト内のネストされたオブジェクトは閉じていません。このチェックは最も外側のフィールド名しか読まないためです。第三に、結果は呼び出し側が渡すものではなくデーモンが組み立てるものです。そのため、結果オブジェクトは形が固定されたすべての階層で閉じており、デーモンが読まずにそのまま運ぶ不透明な JSON の値である箇所でのみ開いています。デーモンのエンコーディングによる帰結の一つはワイヤー上に現れるもので、整理して隠すのではなくそのまま説明します。デーモンが省略可能と指定していないコレクションは、報告する値がない場合は null として、報告する値が空の場合は空のコレクションとして出力されます。そのため、これが当てはまる箇所ではどちらの形も受け付けられます。
次のいずれかの形
RequestClientNotificationDaemonNotificationSuccessResponseErrorResponse
定義
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
クライアントが送信し、デーモンが応答するリクエストです。method は何を求めているかを示し、params オブジェクトはそのメソッド固有のフィールドに加えて、すべてのメソッドが受け付ける 2 つのフィールドを持ちます。params をまったく省略したリクエストは、すべてのフィールドが存在しないものとして読み取られます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
jsonrpc | ProtocolVersion | はい | すべてのメッセージが持つ JSON-RPC のバージョンです。2.0 のみに対応します。 |
id | RequestId | はい | 呼び出し側がリクエストに付ける識別子で、そのリクエストに応答するレスポンスにそのまま返されます。識別子を持たないメッセージは通知であり、応答されることはありません。 |
method | RequestMethod | はい | リクエストが指定できるすべてのメソッドです。この集合は閉じています。それ以外を指定したリクエストには method-not-found エラーが返されます。 |
params | object | いいえ |
追加のプロパティは許可されません。
各 method の params:
method | params | 必須 |
|---|---|---|
"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
クライアントが送信する通知です。識別子を持たず、応答されることはありません。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
jsonrpc | ProtocolVersion | はい | すべてのメッセージが持つ JSON-RPC のバージョンです。2.0 のみに対応します。 |
method | ClientNotificationMethod | はい | クライアントの通知が指定できるすべてのメソッドです。この集合は閉じており、いずれの通知にも応答はありません。 |
params | object | いいえ |
追加のプロパティは許可されません。
各 method の params:
method | params | 必須 |
|---|---|---|
"$/cancelRequest" | CancelRequestParams | はい |
"aggrega/shutdown" | ShutdownParams | いいえ |
DaemonNotification
デーモンが送信する通知です。識別子を持たず、応答されることはありません。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
jsonrpc | ProtocolVersion | はい | すべてのメッセージが持つ JSON-RPC のバージョンです。2.0 のみに対応します。 |
method | DaemonNotificationMethod | はい | デーモンが送信する通知が指定できるすべてのメソッドです。この集合は閉じています。 |
params | object | はい |
追加のプロパティは許可されません。
各 method の params:
method | params | 必須 |
|---|---|---|
"$/progress" | ProgressParams | はい |
"aggrega/publishDiagnostics" | PublishDiagnosticsParams | はい |
CancelRequestParams
すでに処理中のリクエストを、そのリクエストが持っていた識別子で指定して、破棄するようデーモンに求めます。すでに完了したリクエストや送信されていないリクエストは、取り消す対象がないものとして何も通知されずに扱われます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
id | RequestId | はい | 呼び出し側がリクエストに付ける識別子で、そのリクエストに応答するレスポンスにそのまま返されます。識別子を持たないメッセージは通知であり、応答されることはありません。 |
追加のプロパティは許可されません。
ShutdownParams
新たな作業の受け付けを停止し、すでに引き受けた作業を完了するようデーモンに求めます。この通知はフィールドを持たず、通知自体は通常 params オブジェクトなしで送信されます。2 回目の通知を送ると、処理中の作業を待たずに破棄します。
このオブジェクトは固定のプロパティを宣言せず、いかなるプロパティも許可しません。
ProgressParams
処理中の作業についての 1 件の報告です。進捗を受信できると宣言したセッションで、進捗トークンを生成したリクエストに対してのみ送信されます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
token | ProgressToken | はい | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
value | ProgressBegin or ProgressReport or ProgressEnd | はい | 報告そのものです。1 件の開始報告、任意の数の行、1 件の終了報告の順に続きます。 |
追加のプロパティは許可されません。
ProgressBegin
報告を開始し、何が始まったかを操作自体が使う用語で示します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
kind | const “begin” | はい | このペイロードが報告の開始であることを示します。定数: "begin" |
title | string | はい | 何が始まったか。 |
追加のプロパティは許可されません。
ProgressReport
操作自身による経過説明の 1 行です。割合は持ちません。ここで報告する操作は、作業開始時に大きさがわからない集合を処理するため、割合は作り出すしかないからです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
kind | const “report” | はい | このペイロードが開始済みの報告の 1 行であることを示します。定数: "report" |
message | string | はい | 操作自身の出力の 1 行で、前後の空白は取り除かれています。 |
追加のプロパティは許可されません。
ProgressEnd
報告を終了します。種類以外は何も持ちません。結果は、呼び出し側がすでに待っているレスポンスで伝えられるためです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
kind | const “end” | はい | このペイロードが報告の終了であることを示します。定数: "end" |
追加のプロパティは許可されません。
PublishDiagnosticsParams
1 つのファイルについての検出結果です。検証によって、リクエストが指定したドキュメント以外のドキュメントについて検出結果が生じたときに、デーモンからプッシュされます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
file | string | はい | 検出結果の対象となるファイル。 |
diagnostics | Diagnostic[] or null | はい | 検出結果。生成された順に並びます。 |
追加のプロパティは許可されません。
SuccessResponse
成功したリクエストへの応答で、応答先のリクエストの識別子を持ちます。レスポンスは method を持たないため、どの結果の形が適用されるかは、レスポンス自体の内容ではなく、識別子が属するリクエストによって決まります。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
jsonrpc | ProtocolVersion | はい | すべてのメッセージが持つ JSON-RPC のバージョンです。2.0 のみに対応します。 |
id | RequestId | はい | 呼び出し側がリクエストに付ける識別子で、そのリクエストに応答するレスポンスにそのまま返されます。識別子を持たないメッセージは通知であり、応答されることはありません。 |
result | InitializeResult or ValidateResult or InvalidateResult or DiagnosticsResult or IrGraphResult or BuildResult or BuildPreviewResult or EntityDefinitionResult or ReleaseClosureResult or ResolveDependenciesResult or PinResult or CacheStatusResult or CachePruneResult or CacheEvictResult or CacheClearResult or RegistryListResult or SearchResult or RegistryAddResult or RegistryRemoveResult or RegistryUpdateResult or LogoutResult or PublishEntityResult or PublishArtifactResult or SignArtifactsResult or DeprecateArtifactResult or ResolveResult or FindReferencesResult or FindImplementationsResult or HoverResult or CompletionResult or CatalogIndexResult or AttachCandidatesResult or ConnectionCandidatesResult or InsertionPointResult or AttachmentContainerResult or ConnectionAtPositionResult or ReleaseCandidatesResult or ActiveReleaseResult or EditDocumentResult or EffectiveConfigurationResult or ConfigInitResult or ConfigCaptureResult or ImportResult or ScaffoldEntityResult or LintResult or PluginAddResult or PluginRemoveResult or PluginSyncResult or PluginGenCatalogResult or ExplainErrorResult or GetSchemaResult or SkillsInstallResult or SkillsListResult | はい | 応答。要求されたメソッドが返す形で返されます。 |
追加のプロパティは許可されません。
ErrorResponse
拒否または失敗したリクエストへの応答で、応答対象のリクエストの識別子を持ちます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
jsonrpc | ProtocolVersion | はい | すべてのメッセージが持つ JSON-RPC のバージョンです。2.0 のみに対応します。 |
id | RequestId | はい | 呼び出し側がリクエストに付ける識別子で、そのリクエストに応答するレスポンスにそのまま返されます。識別子を持たないメッセージは通知であり、応答されることはありません。 |
error | ErrorObject | はい | 何が問題だったか。クライアントが分岐に使えるコード、人が読むためのメッセージ、そして条件に該当するものがある場合は、メッセージが参照するアーティファクトとソース位置です。 |
追加のプロパティは許可されません。
ErrorObject
何が問題だったか。クライアントが分岐に使えるコード、人が読むためのメッセージ、そして条件に該当するものがある場合は、メッセージが参照するアーティファクトとソース位置です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
code | ErrorCode | はい | 応答が報告する条件です。負のコードはプロトコル自体の予約セットです。4 桁のコードはこのデーモンが発生させる条件で、それぞれクライアントが対処できる状態を示します。このセットは閉じています。 |
message | string | はい | 何が問題だったかを文章で示します。同じ条件を報告する他のすべての場所で、その条件が持つ文言と同じです。 |
data | ErrorData | いいえ | メッセージが参照するアーティファクトとソース位置で、クライアントが文章から読み取り直す必要がないよう構造化して格納されます。すべてのフィールドは省略可能で、条件は手元にあるものだけを設定します。どのフィールドも他のフィールドの代わりにはならないため、クライアントは受け取った内容を、隣のコードからではなく読み取ったフィールドから知ります。 |
追加のプロパティは許可されません。
ErrorCode
応答が報告する条件です。負のコードはプロトコル自体の予約セットです。4 桁のコードはこのデーモンが発生させる条件で、それぞれクライアントが対処できる状態を示します。このセットは閉じています。
種類: 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— デーモンはそのファイルの読み取り結果を保持しておらず、生成もしていません。クライアントは検証を要求して読み取り結果を用意させ、その後再試行します。1003— リクエストが指定した Release のロックファイルが存在せず、操作にはそれが必要です。1004— リクエストが指定したエンティティを、カタログからもリクエストが指定した Release からも解決できませんでした。1005— デーモンはシャットダウン中で、新しい処理を拒否しています。クライアントは同じデーモンに対して再試行しません。1006— そのファイルの検証が現在実行中で、待機中のリクエストが許容した時間内に完了しませんでした。クライアントは待機してから再度要求し、その間は何も送信しません。
ErrorData
メッセージが参照するアーティファクトとソース位置で、クライアントが文章から読み取り直す必要がないよう構造化して格納されます。すべてのフィールドは省略可能で、条件は手元にあるものだけを設定します。どのフィールドも他のフィールドの代わりにはならないため、クライアントは受け取った内容を、隣のコードからではなく読み取ったフィールドから知ります。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
file | string | いいえ | 位置フィールドが指し示すソースドキュメントです。検査対象のドキュメント、または読み込みに失敗した Release です。 |
line | integer | いいえ | 条件が参照する行で、1 から数えます。 |
column | integer | いいえ | 条件が参照する列で、1 から数えます。 |
end_line | integer | いいえ | 条件が参照するトークンの終端の 1 つ後の行です。トークンの終端を復元できない場合は存在せず、その場合クライアントは位置を点として表示します。 |
end_column | integer | いいえ | 条件が参照するトークンの終端の 1 つ後の列です。 |
release | string | いいえ | 条件が参照する Release で、リクエストが指定したとおりの表記です。クライアントはこれを組み立て直さずに対処方法を構成できます。 |
lockfile | string | いいえ | ロックファイルを対象とする条件が扱うロックファイルです。探したが見つからなかった、または読み取れなかったパスです。 |
unreachable | 真偽値 | いいえ | 拒否が、リクエストで指定されたレジストリに到達できなかったことによるものかどうかを示します。名前が解決できなかった、接続が拒否されたか開けなかった、またはセキュアな接続を確立できなかった場合です。メッセージからではなく失敗そのものから判定され、失敗がレジストリに一度も到達しなかったことを示す場合にのみ設定されます。1 つのレジストリを指定したインデックス更新が拒否された場合はこれを持ちます。応答したレジストリは、応答内容にかかわらずこれを設定しません。 |
code | string | いいえ | 拒否が示す条件の説明的な名前で、リリース間で安定しています。その条件を報告する診断が自身のコードに持つ値と同じです。クライアントは、メッセージや隣の数値コードではなくこれに基づいて分岐します。数値コードはリクエストの状態を示し、どの条件でも変わりません。拒否が登録済みの条件を示す場合にのみ存在し、示さない場合は存在しません。 |
shortCode | string | いいえ | 条件の短いコードで、文字 E と 4 桁の数字からなります。読者が引用して調べる形式であり、条件を示す拒否のメッセージの先頭に置かれる形式です。code が存在する場合にのみ存在します。 |
追加のプロパティは許可されません。
Diagnostic
1 つのドキュメントに関する 1 つの検出結果です。場所、重大度、内容、そして報告する条件を示す引用可能なコードを持ちます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
line | integer | はい | 検出結果が対象とする行で、1 から数えます。 |
column | integer | はい | 検出結果が対象とする列で、1 から数えます。 |
severity | const “error” or const “warning” or const “info” | はい | 検出結果の重大度です。使用できる値: "error" — 検出結果は不具合です。halt 重大度のプラグインの検出結果はこの段階で報告されます。"warning" — 検出結果は報告されますが、不具合ではありません。warn 重大度のプラグインの検出結果はこの段階で報告されます。"info" — 検出結果は情報であり、info 重大度のプラグインの検出結果がこれに当たります。 |
message | string | はい | 検出結果の内容を文章で示します。 |
code | string | いいえ | 条件の説明的な名前で、リリース間で安定しており、抑制に引用できます。 |
shortCode | string | いいえ | 条件の短いコードで、停止を伴う診断の先頭に置かれる形式です。 |
codeDescription | CodeDescription | いいえ | 検出結果が示す条件の説明がある場所です。 |
classification | string | いいえ | 条件がそれを区別する場合の、検出結果に至った経緯です。 |
suggest | string | いいえ | 条件が提示できる場合の、検出結果が提案する表記です。たとえば識別子のタイプミスなどです。 |
keyPath | string | いいえ | 検出結果が対象とするキーまでのドキュメント内のパスです。 |
source | string | はい | 検出結果を生成したものです。 |
end_line | integer | いいえ | 検出結果が対象とするトークンの終端の 1 つ後の行で、クライアントは 1 文字ではなくトークン全体を表示できます。複数行にまたがるトークンでは存在しません。 |
end_column | integer | いいえ | 検出結果が対象とするトークンの終端の 1 つ後の列です。 |
追加のプロパティは許可されません。
CodeDescription
検出結果が示す条件の説明がある場所です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
href | string | はい | 条件の説明が公開されているアドレスです。 |
追加のプロパティは許可されません。
Position
ドキュメント内の位置です。行とその行内の文字オフセットで、どちらも 0 から数えます。オフセットは、セッションを開いたときに取り決めたエンコーディングの単位で測られ、クライアントが別のものを要求しない限り UTF-16 です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
line | integer | はい | 行で、0 から数えます。 |
character | integer | はい | 行内のオフセットで、0 から数え、セッションで取り決めたエンコーディングの単位で表します。 |
追加のプロパティは許可されません。
Range
ドキュメント内の 2 つの位置の間の範囲です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
start | Position | はい | ドキュメント内の位置です。行とその行内の文字オフセットで、どちらも 0 から数えます。オフセットは、セッションを開いたときに取り決めたエンコーディングの単位で測られ、クライアントが別のものを要求しない限り UTF-16 です。 |
end | Position | はい | ドキュメント内の位置です。行とその行内の文字オフセットで、どちらも 0 から数えます。オフセットは、セッションを開いたときに取り決めたエンコーディングの単位で測られ、クライアントが別のものを要求しない限り UTF-16 です。 |
追加のプロパティは許可されません。
Location
名前付きドキュメント内の範囲です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
uri | string | はい | 範囲が含まれるドキュメントで、URI で指定します。 |
range | Range | はい | ドキュメント内の 2 つの位置の間の範囲です。 |
追加のプロパティは許可されません。
WorkspaceAndProgressParams
独自のフィールドを宣言しないメソッドの params オブジェクトです。それでも、すべてのリクエストが受け付ける 2 つのフィールド、つまり対象のワークスペースと進捗トークンは受け付けます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
追加のプロパティは許可されません。
InitializeParams
ワークスペースに対するセッションを開き、クライアントが扱える内容を示します。これは workspaceRoot が対象ではなく宣言となる唯一のメソッドです。省略、空文字列、パスはそれぞれ異なる意味を持ち、パスなしで開かれたセッションは、クライアントがまだワークスペースを指定していないセッションです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
capabilities | ClientCapabilities | いいえ | クライアントが扱える内容です。記載のないものはサポートされないものとして扱われます。未知のメンバーは拒否されずに無視されるため、クライアントはこのデーモンがまだ読み取らない機能を示すこともできます。 |
workspaceRoot | string | いいえ | 開くワークスペースの絶対パスです。省略した場合、セッションはワークスペースを持ちません。空文字列はクライアントが指定したパスであり、何も送らない場合とは異なります。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
追加のプロパティは許可されません。
ClientCapabilities
クライアントが扱える内容です。記載のないものはサポートされないものとして扱われます。未知のメンバーは拒否されずに無視されるため、クライアントはこのデーモンがまだ読み取らない機能を示すこともできます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
general | object | いいえ | 特定の種類の応答に結び付かない機能です。 |
window | object | いいえ | 処理の実行中にクライアントが表示できる内容に関する機能です。 |
追加のプロパティは許可されます。
ClientCapabilities.general
特定の種類の応答に結び付かない機能です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
positionEncodings | string[] | いいえ | クライアントが読み取れる位置エンコーディングです。優先度の高い順に並べます。 |
追加のプロパティは許可されます。
ClientCapabilities.window
処理の実行中にクライアントが表示できる内容に関する機能です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workDoneProgress | 真偽値 | いいえ | クライアントが進捗通知を受け取れるかどうかです。これを宣言していないセッションで進捗トークンを発行するリクエストは拒否されます。 |
追加のプロパティは許可されます。
ValidateParams
ワークスペース、またはその中の 1 つのドキュメントを検査し、検出結果を返します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
file | string | いいえ | 検査するドキュメントです。省略した場合、ワークスペースが保持する内容を検査します。 |
content | string | いいえ | クライアントが現在保持しているドキュメントのテキストで、保存されていないバッファを検査するためのものです。省略した場合、ディスク上のバイトを読み取ります。 |
release | string | いいえ | 検査の基準とする Release で、ワークスペースルートからの相対パスで指定します。 |
追加のプロパティは許可されません。
InvalidateParams
デーモンが読み取り結果を保持しているドキュメントが変更されたことを伝え、そのドキュメントに関する次の応答が新しいバイトから計算されるようにします。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
file | string | いいえ | 変更されたドキュメントです。 |
granularity | string | いいえ | デーモンが保持している内容のうち、破棄する範囲です。file は指定されたドキュメントについて保持している内容のみを破棄します。workspace はデフォルトであり、他の値もすべてこれとして解釈され、ワークスペース全体について保持している内容も破棄します。 |
追加のプロパティは許可されません。
DiagnosticsParams
デーモンがドキュメントについてすでに保持している検出結果を、再検査せずに返します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
file | string | いいえ | 報告対象のドキュメントです。デーモンがその読み取り結果をすでに保持している必要があります。 |
追加のプロパティは許可されません。
IrGraphParams
Release のコンパイル結果である解決済みグラフを、レンダリングせずに返します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
release | string | いいえ | 解決する Release で、ワークスペースルートからの相対パスで指定します。絶対パスは拒否されます。 |
unredacted | 真偽値 | いいえ | 作成者が機密として宣言した値を平文で返すかどうかです。省略または false の場合、コマンドラインのグラフ出力と同様に、それらの値はそれぞれグラフから伏せられ、その理由を示すマーカーが代わりに置かれます。true の場合、それらの値を含め、Release のコンパイル結果どおりのグラフを返します。 |
追加のプロパティは許可されません。
BuildParams
Release をコンパイルし、レンダリングされた成果物をワークスペースに書き込みます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
release | string | いいえ | ビルドする Release で、ワークスペースルートからの相対パスで指定します。絶対パスは拒否されます。 |
outputParent | string | いいえ | 出力ディレクトリを作成する親ディレクトリで、ワークスペースルートからの相対パスで指定します。成果物はその下の出力ディレクトリに、何も指定しない場合にワークスペースルートの下に配置されるのと同じ構成で置かれます。つまり、これは出力ディレクトリの親を指定するものであり、出力ディレクトリそのものを指定するものではありません。省略または空の場合、aggrega build がどこから実行されても同様に、出力ディレクトリはワークスペースルートの下に書き込まれます。絶対パス、またはワークスペースの外に出るパスは拒否されます。 |
autoPull | 真偽値 | いいえ | 先に Release の依存関係を解決するかどうかです。指定すると設定済みのレジストリにアクセスし、ロックファイルを書き込みます。指定しない場合、ビルドはどのレジストリにもアクセスしません。 |
policyInput | string | いいえ | 各ガバナンスロールがそこにアタッチされたプラグインに渡すペイロードを、成果物と並べて書き込むディレクトリで、ワークスペースルートからの相対パスで指定します。aggrega build --policy-input が書き込むのと同じ名前のファイルで、ビルドが完了しても停止しても書き込まれます。応答の通知には、書き込まれたファイルの数と、ファイルが書き込まれなかった各ロールが示されます。リクエストが失敗した場合、書き込まれたファイルはディスク上に残りますが、その内訳は返信に含まれません。エラーには拒否の内容のみが含まれます。省略した場合は何も書き込みません。絶対パス、またはワークスペースの外に出るパスは拒否されます。 |
追加のプロパティは許可されません。
BuildPreviewParams
Release をコンパイルし、成果物を書き込んだ場合に生成される内容を、成果物を一つも書き込まずに報告します。書き込みを行うビルドが受け取る依存関係解決のフィールドは受け付けません。何も書き込まないリクエストはロックファイルを埋められないためです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
release | string | いいえ | コンパイルする Release で、ワークスペースルートからの相対パスで指定します。 |
autoPull | 真偽値 | いいえ | ワイヤ上では受け付けられますが、メソッドによって拒否されます。このリクエストは何も書き込まないため、ロックファイルを埋めつつその性質を保つことはできません。 |
policyInput | string | いいえ | 各ガバナンスロールがそこにアタッチされたプラグインに渡すペイロードを書き込むディレクトリで、ワークスペースルートからの相対パスで指定します。aggrega build --dry-run --policy-input が書き込むのと同じ名前のファイルです。指定した場合、これらのファイルがこのリクエストが書き込む唯一のものであり、出力ディレクトリとロックファイルには手を付けません。応答の通知には、書き込まれたファイルの数と、ファイルが書き込まれなかった各ロールが示されます。リクエストが失敗した場合、書き込まれたファイルはディスク上に残りますが、その内訳は返信に含まれません。エラーには拒否の内容のみが含まれます。絶対パス、またはワークスペースの外に出るパスは拒否されます。 |
追加のプロパティは許可されません。
EntityDefinitionParams
1 つのエンティティ名の解決先と、それを定義するドキュメントの場所を返します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
name | string | いいえ | 名前で指定する解決対象のエンティティです。または、その座標で公開されたエンティティを読み取るためのレジストリ参照 oci://<host>/<repository>:<tag>(:<tag> の代わりに @<digest> も可)です。 |
release | string | いいえ | 名前の解決の基準とする Release で、ワークスペースルートからの相対パスで指定します。この場合、名前はワークスペース設定がその Release に与えるカタログディレクトリを通じて解決されます。そのため、1 つのワークスペース内で Release ごとに 1 つずつ複数のバリアントが宣言している名前は、その Release がビルドに使うバリアントに解決され、解決できない名前は workspace.releases 配下のその Release のエントリを示す説明とともに拒否されます。省略した場合、名前はワークスペース自身のカタログディレクトリで解決されます。レジストリ参照は Release を取らず、Release とともに指定すると拒否されます。Release ファイルを指さない値も同様に拒否されます。 |
追加のプロパティは許可されません。
CatalogIndexParams
ワークスペースが保持するエンティティ、つまりそのドキュメントが宣言するすべてのエンティティと、そのカタログディレクトリが宣言する Features を返します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
release | string | いいえ | エンティティの一覧の基準とする Release で、ワークスペースルートからの相対パスで指定します。この場合、Features はワークスペース設定がその Release に与えるカタログディレクトリが宣言するものとなり、他の Releases だけが読み取るカタログディレクトリ配下のドキュメントは除外されます。そのため、1 つのエンティティのバリアントを Release ごとに並べて保持するワークスペースは、その Release がビルドに使うバリアントで一覧されます。省略した場合、一覧はワークスペース自身のものです。Release ファイルを指さない値は拒否されます。 |
追加のプロパティは許可されません。
ReleaseClosureParams
Release が依存するすべてのものを、解決が到達したとおりに返します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
release | string | いいえ | 調べる Release で、ワークスペースルートからの相対パスで指定します。 |
追加のプロパティは許可されません。
ResolveDependenciesParams
Release の依存関係を解決し、それらをロックファイルに固定して、そのレンダリングが使用する外部入力を取得します。設定済みのレジストリにアクセスし、書き込みを行います。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
release | string | いいえ | 解決する Release で、ワークスペースルートからの相対パスで指定します。 |
upgrade | 真偽値 | いいえ | ロックファイルがすでに固定している内容に従わず、宣言された範囲内で再解決するかどうかです。 |
targets | string[] | いいえ | 再解決する参照です。残りは固定されたまま維持されます。空の場合はすべてを解決します。 |
verify | 真偽値 | いいえ | 記録済みのロックファイルを書き込む代わりに、ロックファイルなしでこのリクエストが行う解決(そのリクエストが従う固定に従います)と比較するかどうかです。検証ではロックファイル、プラグインの信頼レコード、entity.lock のいずれも書き込みません。コンテンツキャッシュは、その解決が読み取り・格納するのと同様に読み取られ、格納されます。差異がある場合、およびロックファイルがない場合、リクエストは失敗します。upgrade、targets、pinSources とは、pinSources の値にかかわらず併用できません。これらのいずれかを併せて送信したリクエストは、何かが解決される前に不正なパラメーターとして拒否されます。 |
pinSources | 真偽値 | いいえ | 入力に必要な固定をロックが記録していないものがあった場合にリクエストを拒否する代わりに、Release がワークスペースのカタログディレクトリからビルドする Recipes と FeatureRecipes に対して aggrega/pin が実行する固定ステップを実行し、それぞれの横に entity.lock を書き込むかどうかです。省略した場合はワークスペースの pin_sources_at_pull に従います。いずれの値を指定しても、このリクエストではその設定より優先されます。 |
追加のプロパティは許可されません。
PinParams
Recipe または FeatureRecipe の隣にある entity.lock に、そのエンティティが自身のドキュメントの外から読み込むすべての入力のコンテンツピンを記録します。Release は指定しません。エンティティが識別情報を完全に書き出している入力は、そのエンティティを使用するすべての Release に対して 1 つのアーティファクトを指すため、ピン留めに Release が提供するものは何も必要ありません。エンティティのソースが指定するホストにアクセスし、エンティティの隣に書き込みます。エンティティのドキュメント自体が書き込まれることはありません。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
entity | string | いいえ | ピン留めするエンティティのドキュメントです。ワークスペースルートからの相対パスで指定します。 |
dryRun | 真偽値 | いいえ | ステップが書き込むはずのロックを、書き込まずに応答として返すかどうかです。入力は引き続き解決されるため、コンテンツキャッシュは引き続き埋められます。 |
追加のプロパティは許可されません。
CacheEvictParams
残りがリクエストで指定したサイズに収まるまで、キャッシュされたコンテンツを回収します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
maxSize | string | いいえ | 回収後に収めるサイズです。人が書くような形式で指定します (例: 500MB)。 |
追加のプロパティは許可されません。
SearchParams
設定済みのレジストリのローカルインデックスが提供するものを検索します。ディスク上に既にあるインデックスを読み込み、どのレジストリにも接続しません。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
query | string | いいえ | レコードの名前と説明に対して照合するテキストです。 |
kinds | string[] | いいえ | 残すエンティティの種類です。空の場合はすべての種類を残します。 |
selector | string | いいえ | 残すレコードが満たす必要のあるラベルセレクタです。 |
capabilities | string[] | いいえ | 残すプラグインレコードが宣言している必要のある機能です。 |
pluginType | string | いいえ | 残すプラグインの種類です。 |
registry | string | いいえ | 検索対象とする 1 つのレジストリホストです。省略した場合は、設定済みのすべてのホストを検索します。 |
limit | integer | いいえ | 応答として返すレコードの最大数です。 |
includeRetracted | 真偽値 | いいえ | 公開されたマーカーによって非推奨とされたバージョンを残すかどうかです。 |
追加のプロパティは許可されません。
RegistryAddParams
レジストリと、そのレジストリが提供するものに解決時に適用される信頼ポリシーを登録します。リクエストで別途指定しない限り、マシン全体の設定ファイルに書き込むため、マシン上のすべてのワークスペースがこのエントリを通じて解決します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
host | string | いいえ | 登録するレジストリホストです。 |
name | string | いいえ | ホストに解決されるわかりやすいエイリアスです。 |
identities | string[] | いいえ | このレジストリが提供するものに対して信頼される署名 ID です。 |
keyPath | string | いいえ | 信頼する公開鍵のパスです。キーレス ID ではなく公開鍵で署名されたレジストリに使用します。 |
trustedRoot | string | いいえ | 署名の検証に使用するトラストアンカーのパスです。 |
requireSignatures | 真偽値 | いいえ | このレジストリからのアーティファクトが検証済みの署名を持つ必要があるかどうかです。省略した場合は何も指定せず、解決済みのデフォルトをそのまま維持します。 |
advisory | 真偽値 | いいえ | 検証の失敗を、停止せずに報告するかどうかです。 |
fetchTrust | 真偽値 | いいえ | レジストリが公開している信頼ポリシーを読み込んでピン留めするかどうかです。省略した場合は何も指定せず、解決済みのデフォルトをそのまま維持します。 |
global | 真偽値 | いいえ | マシン全体の設定ファイルに書き込みます。これはこのメソッド自体のデフォルトです。 |
workspace | 真偽値 | いいえ | マシン全体の設定ファイルではなく、このワークスペース自身の設定ファイルに書き込みます。 |
追加のプロパティは許可されません。
RegistryRemoveParams
登録済みのレジストリを削除します。リクエストで別途指定しない限り、マシン全体の設定ファイルに書き込みます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
registry | string | いいえ | 削除するレジストリです。ホストまたはエイリアスで指定します。 |
global | 真偽値 | いいえ | マシン全体の設定ファイルに書き込みます。これはこのメソッド自体のデフォルトです。 |
workspace | 真偽値 | いいえ | マシン全体の設定ファイルではなく、このワークスペース自身の設定ファイルに書き込みます。 |
追加のプロパティは許可されません。
RegistryUpdateParams
検索が読み込むローカルインデックスを、レジストリにアクセスして更新します。書き込まれるのは、このワークスペース自身に設定されたキャッシュディレクトリ配下のインデックスです。どの環境由来のソースも持たない認証情報を必要とするレジストリは、入力を求めることなく、その認証情報を明示して拒否されます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
registry | string | いいえ | 更新する 1 つのレジストリです。省略した場合は、設定済みのすべてのホストを更新します。 |
upgrade | 真偽値 | いいえ | 既存の内容に追加するのではなく、インデックスを再構築するかどうかです。 |
追加のプロパティは許可されません。
LogoutParams
保存されたレジストリの認証情報を削除します。このストアはマシン上のすべてのプロジェクトで共有されており、応答でもその旨が示されます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
registry | string | いいえ | 保存された認証情報を削除する対象のレジストリです。 |
追加のプロパティは許可されません。
PublishEntityParams
エンティティをレジストリに公開します。公開されたものは、そのレジストリのすべての利用者が解決するものとなり、公開済みのバージョンは、すでに取得した相手から取り消すことはできません。入力を求められることはありません。ID は、リクエストで指定されたものか、環境がすでに持っているものから解決されます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
entity | string | いいえ | 公開するエンティティのドキュメントです。ワークスペースのルートからの相対パスで指定します。 |
registry | string | いいえ | 公開先のレジストリです。省略した場合は、設定されたデフォルトが使われます。 |
dryRun | 真偽値 | いいえ | 実際には公開せずに、公開した場合に何が配置されるかを報告するかどうかです。 |
sign | 真偽値 | いいえ | 公開するものに署名するかどうかです。省略した場合は何も指定せず、解決されたデフォルトがそのまま適用されます。 |
plugin | string | いいえ | Plugin エンティティとともに公開するプラグインモジュールです。 |
fulcioUrl | string | いいえ | 署名用証明書の取得元となる認証局です。 |
rekorUrl | string | いいえ | 署名を記録する透明性ログです。 |
timestampUrl | string | いいえ | 副署に使うタイムスタンプ局です。 |
identityToken | string | いいえ | 署名に使う ID トークンです。ターミナルで取得するのではなく、呼び出し側が指定します。 |
pinSources | 真偽値 | いいえ | エンティティをバンドルする前に、aggrega/pin が実行するピン留めのステップをエンティティに対して実行するかどうかです。これにより、このステップがエンティティの横に書き込む entity.lock が公開物に含まれます。このステップはエンティティを判定するすべての拒否より前に実行され、dryRun の下では書き込むはずのロックを報告するだけで何も書き込みません。省略した場合はワークスペースの pin_sources_at_push に従います。どちらの値を指定しても、このリクエストについてはその設定より優先されます。 |
追加のプロパティは許可されません。
PublishArtifactParams
任意のファイルを、リクエストで指定した名前とタグでレジストリに公開します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
file | string | いいえ | 公開するファイルです。ワークスペースのルートからの相対パスで指定します。 |
name | string | いいえ | 公開先のリポジトリ名です。 |
tag | string | いいえ | 公開時のタグです。 |
mediaType | string | いいえ | 公開するバイト列に記録するメディアタイプです。 |
registry | string | いいえ | 公開先のレジストリです。省略した場合は、設定されたデフォルトが使われます。 |
dryRun | 真偽値 | いいえ | 実際には公開せずに、公開した場合に何が配置されるかを報告するかどうかです。 |
追加のプロパティは許可されません。
SignArtifactsParams
すでに公開されているものに署名します。署名は、すでに取得した相手から取り消すことはできません。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
references | string[] | いいえ | 署名する公開済みの参照です。 |
fulcioUrl | string | いいえ | 署名用証明書の取得元となる認証局です。 |
rekorUrl | string | いいえ | 署名を記録する透明性ログです。 |
timestampUrl | string | いいえ | 副署に使うタイムスタンプ局です。 |
identityToken | string | いいえ | 署名に使う ID トークンです。ターミナルで取得するのではなく、呼び出し側が指定します。 |
jobs | integer | いいえ | 同時に署名する参照の数です。省略した場合は一つずつ順に署名します。各参照は、単独で署名する場合とまったく同じように署名されます。キーレスの場合は、それぞれ独自の証明書と独自の透明性ログエントリを使います。応答は参照が与えられた順序を保ちます。最小値: 1。 |
追加のプロパティは許可されません。
DeprecateArtifactParams
公開済みのバージョンを非推奨としてマークし、解決時にそれを報告または拒否できるようにします。マーカー自体も公開され、署名されます。リクエストは、内容を伴う 1 つの参照か、各エントリーが自身の内容を持つバッチファイルのどちらかを送ります。両方を送ることはなく、バッチファイルと並べて内容を送ることもありません。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
reference | string | いいえ | マークする公開済みの参照です。from の代わりとなるもので、両方を含むリクエストは拒否されます。 |
severity | const “warning” or const “error” or const “retracted” | いいえ | マーカーの強さで、解決がそのバージョンを報告するか拒否するかを決めます。reference と併用する場合は必須です。from と並べると拒否されます。そのバッチファイルが各マーカー自身の強さを持つためです。使用できる値: "warning" — 非推奨。2 つの勧告段階のうち弱いほうで、バージョンを選ぶ際には引き続き選択されます。"error" — 非推奨。2 つの勧告段階のうち強いほうで、バージョンを選ぶ際には引き続き選択されます。"retracted" — 撤回済み。バージョンを選ぶ際に除外されます。 |
reason | string | いいえ | バージョンが非推奨とされる理由です。reference と併用する場合は必須です。from と並べると拒否されます。そのバッチファイルが各マーカー自身の理由を持つためです。 |
replacement | string | いいえ | 代わりに使用する参照です。from と並べると拒否されます。そのバッチファイルが各マーカー自身の代替参照を持つためです。 |
message | string | いいえ | マーカーに遭遇した利用者に伝えられる内容です。from と並べると拒否されます。そのバッチファイルが各マーカー自身のメッセージを持つためです。 |
from | string | いいえ | 取り下げエントリーのバッチファイルで、ワークスペースルートからの相対パスで指定し、エントリーごとに 1 つのマーカーを付けます。各エントリーは自身の参照、重大度、理由を持ち、任意で代替参照とメッセージを持ちます。reference の代わりとなるもので、両方を含むリクエスト、またはこれと並べて重大度、理由、代替参照、メッセージのいずれかを含むリクエストは拒否されます。 |
fulcioUrl | string | いいえ | 署名用証明書の取得元となる認証局です。 |
rekorUrl | string | いいえ | 署名を記録する透明性ログです。 |
timestampUrl | string | いいえ | 副署に使うタイムスタンプ局です。 |
identityToken | string | いいえ | 署名に使う ID トークンです。ターミナルで取得するのではなく、呼び出し側が指定します。 |
追加のプロパティは許可されません。
ResolveParams
カーソル位置にあるものがどこで定義されているかを返します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
uri | string | いいえ | カーソルがあるドキュメントです。 |
position | Position | いいえ | ドキュメント内の位置です。行とその行内の文字オフセットで、どちらも 0 から数えます。オフセットは、セッションを開いたときに取り決めたエンコーディングの単位で測られ、クライアントが別のものを要求しない限り UTF-16 です。 |
release | string | いいえ | 回答の基準とする Release で、ワークスペースルートからの相対パスで指定します。この場合、定義は、ワークスペース設定がその Release に与えるカタログディレクトリをその順序でたどって参照が解決されるドキュメントになります。そのため、1 つのワークスペース内で複数のバリアントが Release ごとに 1 つずつ宣言している名前は、その Release のバリアントに解決されます。それらのディレクトリにそのようなエンティティが宣言されていない場合は、ワークスペースのドキュメントが検索されますが、その Release が読み込まないワークスペースのカタログディレクトリ配下のものは除外されます。省略した場合は、まずワークスペースのドキュメントが検索され、どのドキュメントもその名前を宣言していない場合にのみワークスペース自身のカタログディレクトリが検索されます。Release ファイルを指定していない値は拒否されます。 |
追加のプロパティは許可されません。
FindReferencesParams
カーソル位置にあるものがどこで参照されているかを返します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
uri | string | いいえ | カーソルがあるドキュメントです。 |
position | Position | いいえ | ドキュメント内の位置です。行とその行内の文字オフセットで、どちらも 0 から数えます。オフセットは、セッションを開いたときに取り決めたエンコーディングの単位で測られ、クライアントが別のものを要求しない限り UTF-16 です。 |
release | string | いいえ | 回答の基準とする Release で、ワークスペースルートからの相対パスで指定します。この場合、その Release が読み込まないワークスペースのカタログディレクトリ配下のドキュメント内の参照は報告されません。そのため、ワークスペースが Release ごとに 1 つずつ並べて保持しているバリアントが、互いの参照として報告されることはありません。省略した場合は、ワークスペースのすべてのドキュメントが検索されます。Release ファイルを指定していない値は拒否されます。 |
追加のプロパティは許可されません。
FindImplementationsParams
カーソル位置にあるものをどのドキュメントが実装しているかを返します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
uri | string | いいえ | カーソルがあるドキュメントです。 |
position | Position | いいえ | ドキュメント内の位置です。行とその行内の文字オフセットで、どちらも 0 から数えます。オフセットは、セッションを開いたときに取り決めたエンコーディングの単位で測られ、クライアントが別のものを要求しない限り UTF-16 です。 |
release | string | いいえ | 回答の基準とする Release で、ワークスペースルートからの相対パスで指定します。この場合、その Release が読み込まないワークスペースのカタログディレクトリ配下のドキュメントは報告されません。そのため、別の Release がビルドに使うバリアントが、この Release のものとして列挙されることはありません。省略した場合は、ワークスペースのすべてのドキュメントが検索されます。Release ファイルを指定していない値は拒否されます。 |
追加のプロパティは許可されません。
HoverParams
カーソル位置にあるものについて表示する内容を返します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
uri | string | いいえ | カーソルがあるドキュメントです。 |
position | Position | いいえ | ドキュメント内の位置です。行とその行内の文字オフセットで、どちらも 0 から数えます。オフセットは、セッションを開いたときに取り決めたエンコーディングの単位で測られ、クライアントが別のものを要求しない限り UTF-16 です。 |
release | string | いいえ | 回答の基準とする Release で、ワークスペースルートからの相対パスで指定します。この場合、表示されるエンティティは、ワークスペース設定がその Release に与えるカタログディレクトリをその順序でたどって参照が解決されるエンティティになります。それらのディレクトリにそのようなエンティティが宣言されていない場合は、ワークスペースのドキュメントが検索されますが、その Release が読み込まないワークスペースのカタログディレクトリ配下のものは除外されます。省略した場合は、まずワークスペースのドキュメントが検索され、どのドキュメントもその名前を宣言していない場合にのみワークスペース自身のカタログディレクトリが検索されます。Release ファイルを指定していない値は拒否されます。 |
追加のプロパティは許可されません。
CompletionParams
カーソル位置に記述できるものを返します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
uri | string | いいえ | カーソルがあるドキュメントです。 |
position | Position | いいえ | ドキュメント内の位置です。行とその行内の文字オフセットで、どちらも 0 から数えます。オフセットは、セッションを開いたときに取り決めたエンコーディングの単位で測られ、クライアントが別のものを要求しない限り UTF-16 です。 |
context | CompletionContext | いいえ | クライアントが追跡している場合の、リクエストのきっかけです。 |
release | string | いいえ | 回答の基準とする Release で、ワークスペースルートからの相対パスで指定します。この場合、提示される名前は、ワークスペースのドキュメントが宣言する名前から、その Release が読み込まないワークスペースのカタログディレクトリ配下のドキュメントを除いたものに、ワークスペース設定がその Release に与えるカタログディレクトリが宣言する Components と Features を加えたものです。省略した場合は、ワークスペースのドキュメントと、ワークスペース自身のカタログディレクトリが宣言する Components と Features です。Release ファイルを指定していない値は拒否されます。 |
追加のプロパティは許可されません。
CompletionContext
クライアントが追跡している場合の、リクエストのきっかけです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
triggerKind | integer | いいえ | 補完が要求された理由です。 |
triggerCharacter | string | いいえ | 文字がきっかけとなった場合の、その文字です。 |
追加のプロパティは許可されます。
AttachCandidatesParams
エンティティにどの Features をアタッチできるかを、そのエンティティのラベルに照らして判定して回答します。また、グラフノードの component が引く 1 つの接続について、その接続のソケットが宣言する各スロットをどれが埋められるかも回答します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
node | string | いいえ | 候補の判定対象となるエンティティです。名前で指定し、ワークスペースのドキュメントが宣言する内容から読み取ります。 |
graphNode | string | いいえ | 候補の判定対象となるグラフノードです。そのラベルは、ビルド自体が適用可能性の評価に使う確定済みのセットです。これに基づいて計算された回答は、ビルドが実際に行う内容を示します。 |
release | string | いいえ | ノードが属するグラフを持つ Release で、ワークスペースルートからの相対パスで指定します。候補はその Release の観点で選ばれます。すなわち、ワークスペース設定がその Release に与えるカタログディレクトリが宣言する Features と、ワークスペースのドキュメントのうち、その Release が読まないワークスペースのカタログディレクトリ配下のものを除いたものです。そのため、別の Release 用に保持されている Feature が、この Release のグラフのノードに対して提示されることはありません。 |
labels | string のマップ | いいえ | エンティティやグラフノードから読み取る代わりに、直接判定に使うラベルです。 |
connection | ConnectionCoordinate | いいえ | graphNode が指すノードの component が引く 1 つの接続で、そのノードに加えてこの接続についても回答させるものです。このとき回答には slots も含まれます。これは接続のソケットが宣言する各スロットと、それを埋められる Features の組であり、どのスロットも埋められない場合は noSlotReason が含まれます。接続はコンパイル済みのグラフ上にのみ存在するため、これは graphNode および release と一緒にのみ送信されます。node や labels と一緒に送信すると拒否されます。これと並ぶ candidates の意味は変わらず、ノード自体にアタッチできる Features を表します。その document は受け付けられますが、この回答は変わりません。スロットはソケットのものであり、候補は Features のものであるため、アタッチメントがどのドキュメントに書かれても同じです。 |
追加のプロパティは許可されません。
ConnectionCandidatesParams
エンティティ上のソケットをどのエンティティに接続できるかを回答します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
node | string | いいえ | ソケットについて問い合わせる対象のエンティティです。 |
socket | string | いいえ | 回答対象とする 1 つのソケットです。省略すると、エンティティが宣言するすべてのソケットについて回答します。 |
追加のプロパティは許可されません。
InsertionPointParams
名前付きコンテナの下に新しいエントリをドキュメント内のどこに置くべきかを回答します。エントリの作成と適用は、バッファを所有する呼び出し側に任せます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
file | string | いいえ | 回答対象のドキュメントです。 |
container | string[] | いいえ | エントリを置くコンテナまでの、ドキュメント内のパスです。 |
追加のプロパティは許可されません。
AttachmentContainerParams
グラフノード、またはその component が引く 1 つの接続に対するアタッチメントを、どのドキュメントのどこに置くべきかを回答します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
graphNode | string | いいえ | アタッチメントの対象となるグラフノードです。 |
release | string | いいえ | ノードが属するグラフを持つ Release で、ワークスペースルートからの相対パスで指定します。 |
connection | ConnectionCoordinate | いいえ | グラフノードの component が引く 1 つの接続で、アタッチメントがノードではなくその接続を対象とする場合に指定します。このとき回答は、その document フィールドが指すドキュメント内の、接続自身の features コンテナを示します。ここではこのフィールドが必須です。Aggregate では、ノードが記述されたドキュメント内の接続のエントリを指し、Release が引いた接続については Aggregate にエントリがないため拒否されます。Release では、そのノードに対する Release 自身のエントリの下にあるエッジ単位のエントリを指し、Release がその接続のエントリをまだ書いているかどうかは問いません。Release がそのノードのエントリを書いていない場合は拒否されます。アタッチメントは component または Release が引く接続にのみ書かれるため、Feature が引いた接続はどちらのドキュメントでも拒否されます。 |
追加のプロパティは許可されません。
ConnectionAtPositionParams
Aggregate または Release 内の位置が、どの接続のエントリの中にあるかを回答します。回答は、候補判定やコンテナのリクエストが受け取る形式でのグラフノードと接続、またはそこに接続が書かれていない理由です。対象のエントリはアタッチメントが書かれるものです。すなわち、component が接続を引くエントリ (component が記述されたドキュメント内で、接続のエイリアスの下にあるもの) と、Release が書くすべてのエッジ単位のエントリであり、それぞれコンパイル済みのグラフが記録する位置にあります。そのため、キーが接続かどうかを、その名前から判断することはありません。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
file | string | いいえ | 位置を含むドキュメントです。Release、または Release のグラフが components の記述元として記録するドキュメント、つまりその Aggregate や、その Aggregate がインポートするモジュールのドキュメントです。まずセッションが保持する内容から読み取り、なければディスクから読み取ります。 |
position | Position | いいえ | ドキュメント内の位置です。行とその行内の文字オフセットで、どちらも 0 から数えます。オフセットは、セッションを開いたときに取り決めたエンコーディングの単位で測られ、クライアントが別のものを要求しない限り UTF-16 です。 |
release | string | いいえ | 接続を記録するコンパイル済みグラフを持つ Release で、ワークスペースルートからの相対パスで指定します。グラフノードと接続はコンパイル済みのグラフ上にのみ存在するため、Aggregate 内の位置に対しても必須です。 |
追加のプロパティは許可されません。
ConnectionCoordinate
グラフノードのコンポーネントが描く 1 つの接続で、それが配線されるソケットと、そのソケット内で持つエイリアス、およびその接続へのアタッチメントが書かれるドキュメントによって指定されます。接続は、そのソケットが宣言するスロットを満たすアタッチメントを持ち、Aggregate と Release のどちらでもそれらを書くことができます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
socket | string | はい | 接続が配線される依存関係ソケットです。 |
alias | string | はい | 接続がそのソケット内で持つ名前です。 |
document | const “aggregate” または const “release” | いいえ | 接続へのアタッチメントが書かれるドキュメントです。値の集合は閉じており、それ以外の値は拒否されます。使用できる値: "aggregate" — Aggregate。開発者が接続のエントリにアタッチメントを書きます。"release" — Release。オペレーターが接続のエッジごとのエントリにアタッチメントを書きます。 |
追加のプロパティは許可されます。
SetActiveReleaseParams
.aggrega ディレクトリにマーカーを書き込むことで、Release をワークスペースのデフォルトとして記録します。aggrega/activeRelease が報告する選択は、設定のオーサリング Release の次にこのマーカーを読み取ります。マーカーはワークスペース内にのみ書き込まれます。.aggrega ディレクトリまたはマーカーがワークスペースの外へ通じるリンクである場合は、リンク先がまだ存在するかどうかにかかわらず、そのリンクを示して書き込みは拒否され、何も書き込まれません。応答は、マーカーが書き込まれた後に aggrega/activeRelease が返すものと同じであるため、設定のオーサリング Release がマーカーより優先される場合は、別の Release を示します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
release | string | いいえ | 記録する Release で、ワークスペースルートからの相対パスで指定します。絶対パスと、ワークスペースの外へ出るパスは拒否されます。リンクを通じてワークスペースの外へ通じるパスも、ワークスペース設定がその Release を指定していない限り拒否されます。 |
追加のプロパティは許可されません。
EditDocumentParams
ワークスペースが持つドキュメントに、範囲の限られた 1 つの編集を適用します。1 つのコンテナの下への 1 つのエントリの追加、または 1 つのスカラーの設定です。組み立てられたドキュメントはその種類のスキーマに照らして検査され、それに合格した場合にのみディスクに書き込まれるため、オーサリングスキーマが拒否する内容は書き込めません。拒否された編集では、ファイルはバイト単位で元のまま残ります。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
file | string | いいえ | 編集するドキュメントです。 |
edit | const “add-component” or const “attach-feature” or const “wire-edge” or const “set-value” | いいえ | 適用する編集です。使用できる値: "add-component" — components コンテナの下にコンポーネントインスタンスを追加します。name はインスタンス名、value は要求する Component です。"attach-feature" — リクエストが指定したノードに Feature をアタッチします。name はアタッチメントのインスタンス名、value は要求する Feature です。"wire-edge" — リクエストが指定したノードから、socket 内で依存関係の接続を配線します。name は接続をアドレス指定するエイリアス、value は接続先のノードです。"set-value" — リクエストが指定したノードに値を 1 つ設定します。name は値のキー、value はスカラーです。 |
node | string[] | いいえ | ドキュメント内の、編集対象エントリへのパスです。 |
socket | string | いいえ | ソケットを配線する編集の場合に、その編集の対象となるソケットです。 |
name | string | いいえ | 編集が書き込む名前です。 |
value | any | いいえ | 編集が書き込む値で、編集がとる形をそのままとります。 |
dryRun | 真偽値 | いいえ | 書き込む代わりに、組み立てられたドキュメントで応答するかどうかです。 |
追加のプロパティは許可されません。
ConfigInitParams
設定ドキュメントを初期作成します。レジストリとそこで信頼されるアイデンティティはマシン全体のツールであるため、デフォルトではマシン全体のファイルに書き込みます。指定されたレジストリにアクセスして、それが公開する信頼ポリシーを読み取ります。何も公開していないレジストリはその旨が報告されたうえで初期作成が続行され、公式ハブには組み込みのベースラインが、それ以外のレジストリにはポリシーなしが適用されます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
registry | string | いいえ | 設定を初期作成する対象のレジストリです。 |
force | 真偽値 | いいえ | 既に存在する設定ドキュメントを上書きするかどうかです。 |
global | 真偽値 | いいえ | マシン全体の設定ファイルに書き込みます。これはこのメソッド自体のデフォルトです。 |
workspace | 真偽値 | いいえ | マシン全体の設定ファイルではなく、このワークスペース自身の設定ファイルに書き込みます。 |
dryRun | 真偽値 | いいえ | 独自のドキュメントモデルを持つクライアントのために、書き込む代わりにドキュメントの内容で応答するかどうかです。 |
追加のプロパティは許可されません。
ConfigCaptureParams
解決済みの設定をこのワークスペース自身のドキュメントに固定し、ワークスペースを自己完結させます。常にそのワークスペースのファイルに書き込み、その外部には一切アクセスしません。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
allPlugins | 真偽値 | いいえ | ワークスペース自体が設定したプラグインだけでなく、アタッチされているすべてのプラグインを固定するかどうかです。 |
追加のプロパティは許可されません。
ImportParams
外部のソース記述をオーサリング用のドラフトドキュメントに変換し、その隣に .aggrega-import.json を書き込みます。これはインポートが書き込んだ内容の記録で、与えられたターゲット(与えられた場合)、読み取ったカタログスナップショット(読み取った場合)、ドラフトされた各ファイル、ドラフトされた Aggregate または Release のあらゆる深さの各キーを含み、後の sync がこれを読み取ります。完全には変換できなかったソースは失敗ではなく応答として扱われます。生成できたドラフトは書き込まれ、変換できなかった内容は findings が示します。ただし sync の場合は例外で、停止した変換からは何も書き込みません。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
source | string | いいえ | 変換するファイルまたはディレクトリで、絶対パスまたはワークスペースルートからの相対パスで指定します。指定のないリクエストは拒否されます。ワークスペースの内外を問わずその場所で読み取られ、ディレクトリの場合は、インポーターが宣言したファイルパターンが選択するファイルが読み取られます。 |
outputDir | string | いいえ | ドラフトを書き込むワークスペース配下のディレクトリで、ワークスペースルートからの相対パスで指定します。絶対値や、記述どおりまたはリンクを経由してワークスペースの外に出る値は拒否されます。省略した場合はワークスペースルートの下に書き込まれ、これは出力先を指定せずに端末で同じ変換を実行した場合の書き込み先と同じです。ドラフトされたすべてのパスは、dryRun の場合も含め、応答が outputDir として示すディレクトリからの相対パスです。 |
format | string | いいえ | ソースの形式です。省略した場合は変換処理が判定します。 |
target | string | いいえ | compose や helm などの provider の機能(Recipe の spec.capability が結び付く語)で、ドラフトの隣に manifest.yaml として Manifest をドラフトする対象です。ドラフトが必要とする各 component の型と feature の型は、ドラフトされた Aggregate が構成するカタログの Aggregate の型も含めて、ワークスペースのカタログがその型に対して提供するその機能の Recipe または feature 用レシピにマッピングされます。対象は、1 つしかなければそれ、複数あれば型の名前が付いたものです。該当するものがない型や、複数あってもそのように名付けられたものがない型はマッピングされずに残り、その型を示す警告の finding が出されます。インポーターが自らドラフトしたマッピングは、カタログがその型と機能に対してそれを提供している場合は保持され、そうでない場合は警告の finding とともに破棄されます。ドラフトされた Release の spec.manifest にはその Manifest が設定されます。カタログ内のどの Recipe も結び付いていない機能は変換の実行前に拒否され、何も書き込まれません。省略した場合は Manifest をドラフトしません。ただし sync の場合は例外で、以前のインポートの記録が示すターゲットに対してドラフトします。ターゲットを指定した sync はそのターゲットに対してドラフトし、その後は記録がそのターゲットを示します。 |
dryRun | 真偽値 | いいえ | リクエストが書き込むはずのすべてのファイルを書き込まずに、その内容を応答するかどうかです。それ以外の動作はすべて書き込み時と同じであるため、書き込みで拒否されるリクエストはこの場合も拒否されます。sync と併用すると、sync が書き込む内容と、ずれが生じるすべての部分を応答します。 |
sync | 真偽値 | いいえ | ドラフト全体を書き込むのではなく、以前のインポートが outputDir の下にドラフトした内容をソースに合わせて最新の状態にするかどうかです。変更されるのは、ドラフトの隣の記録に列挙された、インポートが書き込んだものだけです。ソースが変更しなかった部分は、編集されているかどうかにかかわらずディスク上のまま残ります。ソースが変更、削除、追加した部分は、ディスク上の内容がインポートが最後に書き込んだものである場合に、新たに書き込まれるか、削除されるか(ドラフトされたファイルはまるごと削除されます)、追加されます。それ以外のもの、つまり作成者が追加したキー(ドラフトされた Release が作成者のために残す environment を含みます)や、ドラフトされたキーの直上に書かれていないコメントは、バイト単位でそのまま残ります。作成者が編集または追加したものを変更・削除する sync や、作成者がすでに書いた箇所に部分を追加する sync は、各部分を示して拒否されます。どの記録にも列挙されていない Aggregate に対する sync も同様に拒否されます。いずれの場合も何も書き込まれません。これを指定しない場合、outputDir にすでにある Aggregate の上にドラフトを書き込むことになるリクエストは、dryRun の場合も含めて拒否されます。 |
upgrade | 真偽値 | いいえ | ワークスペースのデフォルトレジストリが公開する最新のカタログスナップショットを取得してそれに対してインポートし、以後はワークスペースが保持するスナップショット、またはドラフトの隣にある記録が指定するスナップショットの代わりにそれを保持するかどうか。ワークスペースがカタログフォルダを指定している場合は何も変わらず、オフラインでは拒否されます。 |
answers | string | いいえ | ドラフトが空のまま残し、どのソースも保持できない値の読み取り元かつ書き込み先となる回答ファイルで、ワークスペースのルートからの相対パスです。絶対パスの値や、記述どおりに、またはリンクを通じてワークスペースの外に出る値は拒否されます。このファイルは、ドラフトされた各ファイルのパスの下に、そのドキュメント内のキーのパスとその回答を保持し、回答はドラフトに書き込まれます。省略した場合は、ドラフトの隣にある記録が示すファイルを読み、それがなければソースファイルの隣またはソースディレクトリ内の import-answers.yaml を読みます。シークレットの回答はそのシークレットの出どころ(変数名、${NAME}、または Kubernetes Secret の名前)を示し、それ以外は拒否されて何も書き込まれません。問い合わせは一切行われません。まだ必要な各値は、応答の owed のエントリであり、ドラフトされたファイル、キー、およびそれが何であるかを示す警告の finding でもあり、その回答は answered として送信されます。ドラフトが書き込まれる場合は、最後の finding がいくつ必要でどこにあるかを示します。ドラフトに Release が含まれ、必要な値が残っておらず、変換が完了した場合は、その後その依存関係がプルされてロックファイルが書き込まれます。プルが失敗した場合は、理由を示す finding で findings が締めくくられ、ドラフトは書き込まれた状態になります。オフラインでは何もプルされず、実行すべきプルを示す finding が出されます。これらのドラフトが空のまま残さないキーに対する回答はファイル内に保持されて適用されないため、1 つの回答ファイルですべてのターゲットに対応できます。 |
answered | ImportAnswered[] | いいえ | 応答の owed が列挙した値に対する回答で、それぞれがドラフトされたファイルと、owed が示したとおりのキーを示します。各回答は、ターミナルで入力された回答とまったく同じように判定され、回答ファイルに保持され、ドラフトに書き込まれます。シークレットの回答はそのシークレットの出どころ(変数名、${NAME}、または Kubernetes Secret の名前)を示し、そうでない回答は保持も書き込みもされず、その値は理由を secretAdvice として未回答のまま残ります。回答ファイルがすでに回答している値は、そのファイルから回答されます。空の回答や、ドラフトに必要のない値を示す回答は適用されません。outputDir にすでにある Aggregate に対しては sync でないリクエストが拒否されるため、ドラフトが書き込まれた後に sync とともに送信してください。回答を保持しない dryRun の下や、変換が停止して何も書き込まない sync の下では、送信された回答は適用されません。 |
追加のプロパティは許可されません。
ScaffoldEntityParams
エンティティ種別のスターター用ドキュメントをドラフトするか、ドキュメントの実行可能な例の 1 つをワークスペースの新しいディレクトリに書き込むか、それらを一覧表示します。ドラフト作成では、バイナリが持つスキーマセットからスケルトンを導出するため、ワークスペースから何も読み取らず、何も書き込みません。応答はテキストであり、その行き先はクライアントが決めます。例の書き込みでは新しいディレクトリだけを書き込み、それ以外には何も書き込みません。例は、バイナリのバージョン向けに公開された署名付きドキュメントバンドル、またはそれがない場合はそれより前に公開された最新のバンドルから読み取られ、そのバンドルは保持または読み取りの前にワークスペースの署名ポリシーに照らして検証されます。検証に通らないバンドルは拒否され、オフラインではすでにキャッシュされたコピーだけが読み取られます。2 つの形式のフィールドを同時に送るリクエスト(kind と example または list、list と example、name と example または list、example を伴わない dir)は、何かを読み取る前に拒否されます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | string | いいえ | ワークスペースの絶対パスです。ドラフト作成ではこれを読み取りません。例の書き込みや一覧表示にはこれが必要です。ワークスペースの設定が、ドキュメントの取得元と、ドキュメントが持つべき署名を決定し、例はワークスペース内に書き込まれます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
kind | string | いいえ | ドラフトするエンティティの種類で、component、aggregate、release、recipe、featurerecipe など、小文字のトークンで指定します。これは aggrega/getSchema がその種類に対して列挙するトークンです。 |
name | string | いいえ | ドラフトされるドキュメントに書き込む名前です。kind と一緒にのみ送信します。 |
example | string | いいえ | 書き込む実行可能な例で、例の一覧で付けられている名前で指定します。kind の代わりに送信します。 |
list | 真偽値 | いいえ | ドキュメントが公開しているすべての実行可能な例を、何も書き込まずに返すかどうかです。example も kind も付けずに送信します。 |
dir | string | いいえ | 例を書き込む新しいディレクトリで、ワークスペースのルートからの相対パスです。省略した場合は、そこに例の名前を付けたディレクトリに書き込みます。ディレクトリはまだ存在していないか、空である必要があります。何かを含むディレクトリは拒否されてそのまま残され、絶対パスの値や、書かれたとおりに、またはリンクを経由してワークスペースの外に出る値は、何かを読み取る前に拒否されます。example と一緒にのみ送信します。 |
追加のプロパティは許可されません。
LintParams
カタログの公開に関する慣例を、1 つのエンティティ、Release のクロージャが到達するすべてのもの、または設定されたカタログディレクトリ配下のすべてのものに対して検査します。どのモードでも何も書き込まれません。エンティティも Release も指定しない場合はカタログ全体を検査します。設定が独自の Release カタログディレクトリを持たないワークスペースでは、ワークスペースのディレクトリに対して 1 回検査します。workspace.releases の下で Releases を指定しているワークスペースでは、各 Release についてその Release が読み取るディレクトリに対して 1 回ずつ検査し、すべてをまとめて検査することはありません。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
entity | string | いいえ | 検査する 1 つのエンティティドキュメントです。 |
release | string | いいえ | クロージャを検査する Release で、ワークスペースルートからの相対パスで指定します。 |
prePublish | 真偽値 | いいえ | 各エンティティを以前に公開されたバージョンと比較するかどうかです。比較の際は設定されたレジストリにアクセスします。 |
追加のプロパティは許可されません。
PluginAddParams
ワークスペースが設定するソケットにプラグインをアタッチします。クエリを 1 つのプラグインに解決し、バージョンを固定するためにレジストリにアクセスします。ターミナルであれば取得する唯一の判断、つまりコマンド拡張プラグインが宣言する機能を受け入れるかどうかは、ここではフィールドとして渡されます。そのため、クライアントは自身を操作している者に確認し、このインターフェースがプロンプトを待つことはありません。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
type | string | いいえ | プラグインをアタッチするソケットです。 |
query | string | いいえ | 1 つのプラグインに解決する対象です。 |
capability | string | いいえ | ソケットが複数の機能を持つ場合の、このアタッチメントの対象となる機能です。 |
role | string | いいえ | アタッチメントが実行されるロールです。これにより出力できる内容が決まります。 |
global | 真偽値 | いいえ | マシン全体の設定ファイルに書き込みます。 |
workspace | 真偽値 | いいえ | このワークスペース自身の設定ファイルに書き込みます。 |
acceptCapabilities | 真偽値 | いいえ | コマンド拡張プラグインが宣言する機能を呼び出し側が受け入れるかどうかです。 |
dryRun | 真偽値 | いいえ | 設定ドキュメントを書き込む代わりに、その内容を応答として返すかどうかです。 |
追加のプロパティは許可されません。
PluginRemoveParams
ワークスペースが設定するソケットからプラグインをデタッチします。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
type | string | いいえ | プラグインがアタッチされているソケットです。 |
query | string | いいえ | 削除するアタッチメントです。 |
global | 真偽値 | いいえ | マシン全体の設定ファイルに書き込みます。 |
workspace | 真偽値 | いいえ | このワークスペース自身の設定ファイルに書き込みます。 |
追加のプロパティは許可されません。
PluginSyncParams
Plugin エンティティのマシン管理のレコードを、それが指すモジュールと一致させます。これらのレコードを書き換え、ドキュメントのそれ以外のバイトはすべて変更せずに保持します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
entity | string | いいえ | 一致させる Plugin エンティティのドキュメントです。 |
plugin | string | いいえ | レコードを読み取るプラグインモジュールです。 |
追加のプロパティは許可されません。
PluginGenCatalogParams
プラグイン自身が宣言するメタデータと、作成されたオーバーレイから Plugin カタログドキュメントを生成します。入力が変わらなければ、再生成してもバイト単位で同一のドキュメントが生成されます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
fromEmbedded | 真偽値 | いいえ | バイナリがすでに持つプラグインからメタデータを読み取るかどうかです。 |
plugin | string | いいえ | メタデータを読み取るプラグインモジュールです。 |
outputDir | string | いいえ | ドキュメントを書き込む、ワークスペース配下のディレクトリです。 |
overlay | string | いいえ | 生成されたメタデータの上に内容がマージされる、作成済みのドキュメントです。 |
dryRun | 真偽値 | いいえ | ドキュメントを書き込む代わりに、その内容を応答として返すかどうかです。 |
追加のプロパティは許可されません。
ExplainErrorParams
検出結果が持つコードを、その状態についてコンパイラが宣言する内容と、作成上の修正方法を説明する公開エントリに展開します。ワークスペースにコピーがない場合は公開ドキュメントを取得します。取得できない場合でも、バイナリが宣言する内容は応答し、説明文がない理由を示します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
code | string | いいえ | 展開する状態です。検出結果が持つコード、またはその短縮コードで指定します。 |
追加のプロパティは許可されません。
GetSchemaParams
種類のスキーマを応答として返します。種類が指定されていない場合は、指定可能な種類を返します。他の場所にインストールされたコピーではなく実行中のバイナリについて応答するため、ワークスペースを必要とせず、読み取りもしません。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootAccepted | いいえ | ワークスペースの絶対パスです。このメソッドの対象はワークスペースではなく、バイナリ自体が持つ内容から応答するため、このフィールドは受け付けられますが読み取られません。どのメソッドがこれを参照するかを知らなくても、クライアントがすべてのリクエストで一様に送信できるように受け付けられています。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
kind | string | いいえ | スキーマを返す対象の種類です。省略した場合は、代わりに指定可能な種類を返します。 |
追加のプロパティは許可されません。
SkillsInstallParams
バイナリに組み込まれたアシスタント用スキルを、リクエストが指定した各アシスタントのスキルフォルダに、またはアシスタントを 1 つも指定しない global リクエストの場合は、このマシン上で見つかった各アシスタントのスキルフォルダに書き込みます。global を指定しない場合は、リクエストが指定したワークスペース内の各アシスタントのプロジェクトフォルダに書き込み、そこに書き込むすべてのパスはそのワークスペース内に制限されます。global を指定した場合は、ホームディレクトリ以下の各アシスタントのユーザーごとのフォルダに書き込みます。何かを書き込む前にすべての書き込み先が確認されるため、拒否された場合はすべてのフォルダが元のまま残ります。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | はい | このリクエストが対象とするワークスペースの絶対パスです。これはリクエストの対象そのものです。デーモンはメソッドの実行前にこれを解決し、これを省略したリクエストや文字列以外で指定したリクエストは拒否されます。 |
workDoneToken | ProgressToken | いいえ | 進捗通知を、それを要求した呼び出しと対応付けるために呼び出し側が生成する値です。すべての通知に変更されずにそのまま返されるため、呼び出し側は送信した値と比較できます。すべてのリクエストで受け付けられますが、進捗の機能を宣言していないセッションでこれを送信したリクエストは拒否されます。 |
agents | string[] | いいえ | スキルをインストールするアシスタントで、一覧が報告する識別子で指定します。何も指定しないプロジェクトリクエストは拒否されます。何も指定しない global リクエストは、このマシン上で見つかったアシスタント、つまり設定フォルダがホームディレクトリにあるか、コマンドが PATH 上にある各アシスタントにスキルをインストールし、1 つも見つからない場合は何も書き込まずに拒否されます。スキルフォルダが不明な識別子は名前を示して拒否され、2 回指定された識別子は 1 回だけインストールされます。 |
global | 真偽値 | いいえ | ワークスペース内のプロジェクトフォルダではなく、ホームディレクトリ以下にある各アシスタントのユーザーごとのスキルフォルダに書き込みます。アシスタントはこのフォルダをすべてのプロジェクトで読み取ります。 |
追加のプロパティは許可されません。
ServerCapabilities
クライアントが処理できると示した内容に照らして決定された、このセッションでデーモンが行う内容です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
positionEncoding | string | はい | このセッションのすべての位置を表すエンコーディングです。 |
workDoneProgress | 真偽値 | いいえ | このセッションでデーモンが進捗通知を送信するかどうかです。クライアントが受信可能と宣言した場合にのみ存在します。 |
追加のプロパティは許可されません。
ClosureEntity
Release が依存する 1 つのエンティティを、解決で確定したバージョンで表します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
uri | string | はい | エンティティの解決元となる参照です。 |
version | string | はい | 確定したバージョンです。 |
kind | string | いいえ | エンティティの種類です。 |
source | string | いいえ | このエントリを生成した実行がエンティティをどこから取得したかを、aggrega pull --detail が表示するのと同じ語で示します。fetched-fresh(その実行中にレジストリから取得)、cache-reuse(キャッシュにすでにあるコピーを取得せずに再利用)、local(カタログディレクトリなど、ローカルのファイルシステム上で検出)、in-binary(コンパイラのバイナリ内のコピー)、external(Release 自体の Aggregate または Manifest で、依存関係の 1 つとして解決されるのではなく、Release が指定するファイルまたはエントリから読み取られたもの。実行がレジストリから取得した Aggregate は代わりに fetched-fresh になります)のいずれかです。依存関係解決のレポートのエントリに存在し、その実行がこのマシン上で何を行ったかを表します。Release の解決済み依存関係の一覧には存在せず、その一覧は Release が何に依存するかを表します。ロックファイルには取得元は記録されません。実行が取得元を記録しなかったエンティティでは省略されます。 |
追加のプロパティは許可されません。
ToolchainCorePlugin
コンパイラ自体が持つ 1 つのプラグインと、使用されたそのバージョンです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
plugin | string | はい | プラグインの参照です。 |
version | string | はい | 使用されたバージョンです。 |
追加のプロパティは許可されません。
ToolchainReport
解決を行ったコンパイラと、それが持つプラグインです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
compilerVersion | string | はい | 解決を行ったコンパイラのバージョンです。 |
corePlugins | ToolchainCorePlugin[] | いいえ | コンパイラが持つプラグインと、それぞれ使用されたバージョンです。 |
追加のプロパティは許可されません。
DependencyResolutionReport
依存関係の解決が固定し、取得したものです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
lockfile | string | はい | 解決が書き込んだロックファイル、または検証が比較したロックファイルです。 |
verified | 真偽値 | いいえ | リクエストが検証であったかどうかです。検証は記録済みのロックファイルと比較し、ロックファイル、プラグインの信頼記録、entity.lock のいずれも書き込みません。 |
entities | ClosureEntity[] or null | はい | 解決が固定した、または検証が比較したエンティティです。 |
libraries | ClosureEntity[] or null | はい | 解決が固定した、または検証が比較したライブラリです。 |
plugins | ClosureEntity[] or null | はい | 解決が固定した、または検証が比較したプラグインです。 |
sourceArtifacts | integer | はい | 取得されたソースアーティファクトの数です。 |
trustedPlugins | integer | はい | 固定されたプラグインのうち、検証済みの署名を持っていたものの数です。 |
toolchain | ToolchainReport | いいえ | 解決を行ったコンパイラと、それが持つプラグインです。 |
externalInputs | integer | はい | レンダリングが使用する外部入力のうち、取得されたものの数です。 |
incompleteExternalInputs | string | いいえ | 一部の外部入力を取得できなかった場合に、取得できなかった外部入力です。 |
追加のプロパティは許可されません。
BuildNotice
ビルドが呼び出し側に伝えたい 1 つの事項で、ドキュメントに関する検出結果でも失敗でもないものです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
class | string | はい | この通知の種類です。 |
text | string | はい | 通知の内容です。 |
追加のプロパティは許可されません。
CacheScope
キャッシュの応答が及ぶ範囲です。キャッシュクラスのうち 2 つはマシン上のすべてのプロジェクトで共有されるため、すべてのキャッシュの応答は、どのクラスに触れたかを示します。そうしなければ、1 つのワークスペースで開かれたセッションは、そのワークスペースについてのみ報告しているものと解釈されてしまいます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
machineWideClasses | string[] or null | はい | この応答が触れたキャッシュクラスのうち、マシン上のすべてのプロジェクトで共有されるものです。 |
workspaceRoot | string | はい | リクエストが指定したワークスペースです。 |
追加のプロパティは許可されません。
CacheElement
キャッシュが保持する 1 つの項目です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
label | string | はい | エントリの対象です。 |
size | integer | はい | 占有しているバイト数です。 |
sizeText | string | はい | 同じサイズを人が読みやすい形式で表したものです。 |
digest | string | いいえ | エントリのキーとなるコンテンツダイジェストです(存在する場合)。 |
note | string | いいえ | エントリについてのその他の補足事項です。 |
追加のプロパティは許可されません。
CacheClass
デーモンが報告する 1 つのキャッシュです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
name | string | はい | どのキャッシュであるかです。 |
reach | string | はい | キャッシュがこのワークスペースに属するか、マシン全体で共有されるかです。 |
prunable | 真偽値 | はい | このキャッシュの回収をデーモンが行うかどうかです。 |
elements | CacheElement[] or null | はい | キャッシュが保持する内容です。 |
追加のプロパティは許可されません。
CacheProvenance
キャッシュされたアーティファクトがどの ID のもとで取得されたか、およびどの程度広く共有されているかです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
identities | string[] or null | はい | アーティファクトが帰属する ID です。 |
sharedBy | integer | いいえ | アーティファクトを共有している保持者の数です。 |
追加のプロパティは許可されません。
CacheRemoval
回収によって削除された 1 つの項目です。または、残された項目の一覧においては、削除されるはずだった 1 つの項目です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
class | string | はい | 属しているキャッシュです。 |
label | string | はい | その項目が何であるかです。 |
reach | string | はい | そのキャッシュがこのワークスペースに属するか、マシン全体で共有されるかです。 |
size | integer | はい | 占有しているバイト数、または削除される前に占有していたバイト数です。 |
sizeText | string | はい | 同じサイズを人が読みやすい形式で表したものです。 |
追加のプロパティは許可されません。
CacheShortfall
回収で残されたものと、それを回収する方法です。これにより、予想より小さな数値を読んだ呼び出し側は、推測するのではなくその理由を知ることができます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
class | string | はい | 残されたものを保持しているキャッシュです。 |
count | integer | はい | 残されたエントリの数です。 |
size | integer | はい | それらが占有しているバイト数です。 |
sizeText | string | はい | 同じサイズを人が読みやすい形式で表したものです。 |
reach | string | はい | そのキャッシュがこのワークスペースに属するか、マシン全体で共有されるかです。 |
reclaimedBy | string[] or null | はい | それらを回収する方法です。 |
追加のプロパティは許可されません。
CacheCleared
クリアによって空にされた 1 つのキャッシュです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
class | string | はい | 空にされたキャッシュです。 |
reach | string | はい | このワークスペースに属するか、マシン全体で共有されるかです。 |
size | integer | はい | そこから回収されたバイト数です。 |
sizeText | string | はい | 同じサイズを人が読みやすい形式で表したものです。 |
heldOpenFiles | integer | はい | 別のプロセスが開いていたために、クリアがこのキャッシュに残したファイルの数です。開いているファイルの削除を拒否するのは Windows のみのため、それ以外の環境ではこの値は 0 です。後のクリアで、そのプロセスがファイルの使用を終えた時点で削除されます。 |
heldOpenBytes | integer | はい | それらのファイルが占有しているバイト数です。クリアが回収した量である size には含まれません。 |
heldOpenBytesText | string | はい | 同じ数値を人が読みやすい形式で表したものです。 |
追加のプロパティは許可されません。
ConfigWriteScope
どの設定ドキュメントが書き込まれ、それがどこまで及ぶかです。リクエストは 1 つのワークスペースを指定するため、何も示さない応答はそのワークスペースについてのものと解釈されますが、マシン全体への書き込みではその解釈は誤りです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
configFile | string | はい | 書き込まれたドキュメントです。 |
machineWide | 真偽値 | はい | そのドキュメントが、マシン上のすべてのワークスペースが解決に用いるドキュメントであるかどうかです。 |
workspaceRoot | string | はい | リクエストが指定したワークスペースです。 |
追加のプロパティは許可されません。
PluginWriteScope
プラグインの変更がどの設定ドキュメントに書き込まれ、それがどこまで及ぶかです。コマンド拡張ソケット自体のデフォルトはマシン全体のドキュメントであるため、すべての応答はどちらに書き込んだかを示します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
configFile | string | はい | 書き込まれたドキュメントです。 |
machineWide | 真偽値 | はい | そのドキュメントが、マシン上のすべてのワークスペースが解決に用いるドキュメントであるかどうかです。 |
workspaceRoot | string | はい | リクエストが指定したワークスペースです。 |
追加のプロパティは許可されません。
CredentialStoreScope
認証情報の変更が及ぶ範囲です。ストアはマシン上のすべてのプロジェクトと、同じレジストリにアクセスする他のすべてのツールで共有されるため、応答はセッション単位であるという解釈を推測に委ねるのではなく、そのことを報告します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
machineWide | 真偽値 | はい | 変更が触れたストアがマシン全体で共有されているかどうかです。 |
workspaceRoot | string | はい | リクエストが指定したワークスペースです。 |
追加のプロパティは許可されません。
SkillFolderScope
スキルのインストールが及ぶ範囲です。リクエストは 1 つのワークスペースを指定するため、何も述べない応答はそのワークスペースについてのものと解釈されます。しかし、アシスタントがすべてのプロジェクトで読み取るユーザーごとのフォルダの場合、その解釈は誤りです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
machineWide | 真偽値 | はい | 書き込まれたフォルダが、ホームディレクトリ以下のユーザーごとのフォルダであるかどうかです。アシスタントはこれをマシン上のすべてのプロジェクトで読み取ります。 |
workspaceRoot | string | はい | リクエストが指定したワークスペースです。 |
追加のプロパティは許可されません。
PublicationReach
公開がどこまで及んだかを示します。これらの応答はこのマシンの外にまで完全に及びます。応答が付加するものは、そのレジストリのすべての利用者が解決するものになるためです。そのため、各応答はアドレスしたすべてのレジストリと、その呼び出しがそこに何かを付加したかどうかを示します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
registries | string[] | はい | 呼び出しがアドレスしたすべてのレジストリホストです。各ホストは一度だけ、呼び出しが最初にアドレスした順に示されます。単一参照の呼び出しは 1 つを示し、ドライランはアドレスしたはずの宛先を示します。 |
beyondThisMachine | 真偽値 | はい | 呼び出しが、レジストリが現在他者に提供するもの (アップロードされたコンテンツ、署名、公開日、非推奨マーカー) を何か付加したかどうかです。ドライランの場合、および付加するはずだったものがすべて既に存在していた呼び出しの場合は false です。たとえば、完全なバージョンに対して再度実行された公開や、すべての参照が既に検証可能な署名を持っていた署名バッチです。 |
追加のプロパティは許可されません。
WorkspaceEntityRef
種類と名前で示される 1 つのエンティティと、それを宣言するドキュメントです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
kind | string | はい | エンティティの種類です。 |
name | string | はい | エンティティ名です。 |
file | string | はい | それを宣言するドキュメントです。ワークスペースルートからの相対パスで示されます。 |
追加のプロパティは許可されません。
SourcedEntityRef
1 つのエンティティと、その読み込み元です。ワークスペースのドキュメントはワークスペース相対パスを報告します。設定されたカタログディレクトリから解決されたエンティティは空のパスを報告します。それが持つ唯一のパスはクライアントにとって意味を持たないためです。空のパスが誰も埋めなかったフィールドとして読まれないよう、origin がそのどちらであるかを示します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
kind | string | はい | エンティティの種類です。 |
name | string | はい | エンティティ名です。 |
file | string | はい | それを宣言するドキュメントです。ワークスペースルートからの相対パスで示され、設定されたカタログディレクトリから来た場合は空です。 |
origin | string | はい | エンティティの読み込み元です。 |
追加のプロパティは許可されません。
SocketCandidacy
エンティティ上の 1 つのソケットと、そこに接続できるものです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
socket | string | はい | ソケットの名前です。 |
declaration | string | はい | ソケットが宣言されている場所です。 |
selector | string | はい | ターゲットが満たす必要のあるラベルセレクターです。 |
required | 真偽値 | はい | ビルドを続行するためにソケットの接続が必要かどうかです。 |
targets | WorkspaceEntityRef[] or null | はい | そこに接続できるエンティティです。 |
追加のプロパティは許可されません。
SlotCandidacy
接続のソケットが宣言する 1 つのスロット (利用側の Component がソケット上で宣言するとおりのもの) と、その接続でそれを埋めることができる Features です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
slot | string | はい | スロットの名前です。これは、それを埋めるアタッチメントが接続の features の下に記述されるキーです。 |
selector | string | はい | スロットを埋める Feature が自身のラベルで満たす必要のあるラベルセレクターです。スロットが何も宣言しない場合は空で、その場合はどの Feature も受け入れます。 |
required | 真偽値 | はい | ビルドを続行するために、ソケットを介して接続されるすべての接続がスロットを埋める必要があるかどうかです。 |
inject | string[] | はい | スロットを埋めるものに対してスロットが許可する配信メカニズムです。Component が宣言した順に並びます。何も宣言されていない場合は空です。 |
sensitive | 真偽値 | はい | スロットを埋めるものが機密情報を扱うとスロットが宣言しているかどうかです。これはスロットを埋めるアタッチメントに印を付けるだけで、何も拒否しません。 |
description | string | はい | Component が述べるスロットの用途です。何も述べていない場合は空です。 |
candidates | SourcedEntityRef[] | はい | この接続でスロットを埋めることができる各 Feature です。宣言された適用条件をグラフノードのラベルが満たし (ノードが持つすべてのアタッチメントはこの条件に従います)、かつ自身のラベルがスロットのセレクターを満たすものです。適用条件またはラベルをセレクターに照らして読み取れない Feature は提示されません。ビルドはそれを受け入れずに拒否するためです。 |
追加のプロパティは許可されません。
CatalogEntity
ワークスペースインデックスが保持する 1 つのエンティティです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
kind | string | はい | エンティティの種類です。 |
name | string | はい | エンティティ名です。 |
apiVersion | string | はい | ドキュメントが宣言するスキーマバージョンです。 |
description | string | はい | ドキュメントが述べるエンティティの用途です。 |
labels | map of string or null | はい | ドキュメントが宣言するラベルです。 |
file | string | はい | それを宣言するドキュメントです。ワークスペースルートからの相対パスで示されます。 |
origin | string | はい | エンティティの読み込み元です。 |
追加のプロパティは許可されません。
CompletionItem
カーソル位置に記述できる 1 つの候補です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
label | string | はい | 記述するテキストです。 |
kind | integer | いいえ | 候補の種類です。クライアントがアイコンを選択できるようにします。 |
detail | string | いいえ | ラベルの横に表示される短い補足です。 |
documentation | string | いいえ | 候補の詳しい説明です。 |
sortText | string | いいえ | 並べ替えに使う値です。ラベルと異なる場合に指定されます。 |
追加のプロパティは許可されません。
MarkupContent
表示するテキストと、そのマークアップ方法です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
kind | string | はい | テキストのマークアップ方法です。 |
value | string | はい | テキストです。 |
追加のプロパティは許可されません。
EntityKindDescriptor
作成者がドキュメントを記述する 1 つの種類です。リクエストが指定するトークンとドキュメント自身が宣言する種類を対応付け、どの操作がその種類のドキュメントを受け入れるかを示します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
kind | string | はい | リクエストが指定する小文字のトークンです。例: component、featurerecipe。 |
documentKind | string | はい | ドキュメント自身のヘッダーが宣言する種類です。 |
acceptedBy | EntityKindAcceptance | はい | この種類のドキュメントを単独で (パスで、または検査の場合は名前で) 指定し、他に何も一緒に送らない場合に、どの操作がそれを受け入れるかです。メンバーが true であるのは、その操作がこの種類であることを理由にドキュメントを拒否しない場合です。受け入れられたドキュメントでも、その内容によって拒否されることがあります。 |
追加のプロパティは許可されません。
EntityKindAcceptance
作成者が記述する 1 つの種類について、その種類のドキュメントを単独で指定した場合に各操作がそれを受け入れるかどうかです。すべてのメンバーがすべてのエントリに存在するため、false は省略ではなく明示的な表明です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
singleEntityValidation | 真偽値 | はい | aggrega validate の単一エンティティスコープ (1 つのドキュメントのパスを与えたコマンド) がこの種類のドキュメントを検査するかどうかです。拒否される種類は、代わりにカタログ全体スコープまたは Release スコープで検査されます。 |
publication | 真偽値 | はい | ドキュメントのみを指定した aggrega/publishEntity がこの種類のドキュメントを公開するかどうかです。公開時にドキュメントと一緒に指定された実行ファイルも結び付ける種類 (Plugin) は false です。ドキュメントのみを指定したリクエストはその種類では拒否されるためです。Manifest と Release は、どちらの種類も公開されないため false です。 |
inspectionByName | 真偽値 | はい | aggrega/entityDefinition が名前をこの種類のエンティティに解決するかどうかです。名前は、あるエンティティが別のエンティティを参照する箇所に記述されているとおりに送られます。 |
追加のプロパティは許可されません。
RegistryTrust
レジストリが提供するものに対して解決が適用する信頼ポリシーです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
signaturesRequired | 真偽値 | はい | このレジストリからのアーティファクトが検証済みの署名を持つ必要があるかどうかです。 |
verificationSkipped | 真偽値 | いいえ | 検証がスキップされているかどうかです。 |
advisory | 真偽値 | いいえ | 検証の失敗を、停止せずに報告するかどうかです。 |
anchor | string | いいえ | 署名の検証に使われるトラストアンカーです。 |
keylessIdentities | integer | いいえ | このレジストリについて信頼されている署名 ID の数です。 |
追加のプロパティは許可されません。
Registry
設定された 1 つのレジストリです。ここにあるフィールドはいずれも、認証情報そのもの、その長さ、形式、またはその表現を一切含みません。報告されるのは存在の有無だけであり、そのためこの値は issue に貼り付けても安全です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
host | string | はい | レジストリホストです。これがレジストリの識別子です。 |
name | string | いいえ | ホストに解決される分かりやすいエイリアスです。設定されている場合に指定されます。 |
default | 真偽値 | はい | レジストリを指定しない操作がアドレスするレジストリかどうかです。 |
authState | string | はい | このホストの認証情報がマシン全体のストアに存在するかどうかです。空の場合でも報告されるため、呼び出し側は「認証情報が存在しない」と「一覧が確認しなかった」を区別できます。 |
trust | RegistryTrust | はい | レジストリが提供するものに対して解決が適用する信頼ポリシーです。 |
追加のプロパティは許可されません。
TrustFetchOutcome
レジストリが公開する信頼ポリシーの読み取りがどうなったかを示します。各結果は意味が異なるため区別して保持されます。公開されたポリシーが採用された、レジストリが何も公開していなかった(これは失敗ではありません)、代わりに組み込みのベースラインが固定された、または読み取りが試みられなかった、のいずれかです。何も公開されていなかった場合は、レジストリにそもそも到達できたかどうかがその横に示されます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
pinned | 真偽値 | はい | 公開されたポリシーが採用されたかどうか。 |
notAdvertised | 真偽値 | いいえ | レジストリに問い合わせたもののポリシーが公開されていなかったかどうか。この場合、操作はリクエストで指定された内容に基づいて続行されます。オフライン設定により問い合わせが行われなかったレジストリは、この形では報告されません。到達できなかったレジストリも、ポリシーが返されなかったためこの形で報告され、その横に unreachable が付きます。両者を区別するには unreachable を読んでください。 |
unreachable | 真偽値 | いいえ | 公開されたポリシーを問い合わせた際にレジストリに到達できなかったかどうか。名前が解決されなかった、接続が拒否されたか開けなかった、または安全な接続を確立できなかった場合です。これは reason からではなく失敗そのものから読み取られ、notAdvertised と並んで示され、レジストリに一度も到達しなかったことを失敗が示す場合にのみ設定されます。応答したレジストリは、ポリシーなしの応答であれ失敗の応答であれ、これを設定しません。 |
baseline | 真偽値 | いいえ | 公開されたポリシーが採用されなかったために組み込みのベースラインが固定されたかどうか。これを持つのは公式ハブのみです。ハブに問い合わせて何も公開されていなかった場合は notAdvertised と並んで示され、オフライン設定によりハブへの問い合わせが行われなかった場合は単独で示されます。 |
skipped | 真偽値 | いいえ | 読み取りが試みられなかったかどうか。指定されたポリシーが優先されたか、リクエストが読み取りを求めなかった場合です。 |
identities | integer | いいえ | 公開されたポリシーが含んでいた署名 ID の数。 |
reason | string | いいえ | 公開されたポリシーが採用されなかった理由。レジストリのエンドポイントがどう応答したか、または問い合わせを妨げたオフラインによる拒否です。 |
追加のプロパティは許可されません。
SkippedRepo
インデックスの走査でスキップされた 1 つのリポジトリと、その理由。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
repo | string | はい | スキップされたリポジトリ。 |
reason | string | はい | スキップされた理由。 |
追加のプロパティは許可されません。
DeprecationNote
インデックスの走査で見つかった 1 つの非推奨マーカーと、その扱い。受け入れられたマーカーと、存在したものの却下されたマーカーは同等に報告されます。そのため、多数の記録が黙って行われる一方で 1 つの却下だけが目立つ、ということはありません。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
repo | string | はい | マーカーが付いているリポジトリ。 |
version | string | はい | マーカーが対象とするバージョン。 |
recorded | 真偽値 | はい | マーカー自身の署名が検証され、そのためインデックスがそれを保持しているかどうか。 |
severity | const “warning” or const “error” or const “retracted” | いいえ | マーカーの強さです。使用できる値: "warning" — 非推奨。2 つの勧告段階のうち弱いほうで、バージョンを選ぶ際には引き続き選択されます。"error" — 非推奨。2 つの勧告段階のうち強いほうで、バージョンを選ぶ際には引き続き選択されます。"retracted" — 撤回済み。バージョンを選ぶ際に除外されます。 |
reason | string | いいえ | そのバージョンが非推奨である理由です。 |
追加のプロパティは許可されません。
HostUpdate
インデックスの更新が 1 つのレジストリに対して行ったこと。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
host | string | はい | 更新されたレジストリホスト。 |
indexed | integer | はい | 書き込まれたレコードの数。 |
deprecationsExamined | 真偽値 | はい | 走査がそもそも非推奨マーカーを探したかどうか。「このレジストリは何も公開していない」と「この実行には判断の根拠がなかった」は異なる事実であるため、件数とは別になっています。 |
deprecationsRecorded | integer | はい | 受け入れられたマーカーの数。 |
skipped | SkippedRepo[] or null | はい | 走査でスキップされたリポジトリ。 |
deprecations | DeprecationNote[] or null | はい | 走査で見つかったマーカー。 |
readsRetried | integer | はい | 走査の読み取りのうち、レジストリが拒否した、または途中で切断したために再度要求されたものの数です。各読み取りは、何回の試行を要したか、その後成功したかどうかにかかわらず 1 回として数え、該当がない場合はゼロです。読み取りが最終的にすべて成功した走査は skipped の下にリポジトリを列挙しないため、走査がリポジトリを取りこぼすところにどれだけ近づいたかを示すのはこの数です。最小値:0。 |
error | string | いいえ | このホストで失敗した内容。これにより、複数のホストにわたる走査で、呼び出し側が何も突き合わせることなく、どのホストが失敗したかが報告されます。 |
unreachable | 真偽値 | いいえ | このレジストリに到達できなかったかどうか。名前が解決されなかった、接続が拒否されたか開けなかった、または安全な接続を確立できなかった場合です。これは error からではなく失敗そのものから読み取られ、error と並んでのみ、かつレジストリに一度も到達しなかったことを失敗が示す場合にのみ設定されます。応答したレジストリは、応答内容にかかわらず、これを設定しません。 |
追加のプロパティは許可されません。
PublishedVersion
インデックスがある参照について保持する 1 つのバージョン。インデックスの構築時にそのタグが解決されたマニフェストのダイジェスト、インデックスの構築時の信頼ポリシーがそのバージョン自身の署名を検証した場合は検証された署名者、そして何らかの記録がある場合は公開日時とその出典を含みます。署名者は、署名のないバージョン、どの署名も検証されなかったバージョン、およびそのポリシーが公開鍵も信頼された ID も固定していないか署名検証を無効にしている場合には存在しません。これらはいずれも署名者を示す根拠にはならず、署名者がないことはそれ以上の意味を持ちません。公開日時は、公開時に日時が指定されず、そのポリシーが検証したキーレス署名にも記録がない場合に存在しません。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
version | string | はい | タグが示すバージョン。 |
manifestDigest | string | はい | インデックスの構築時にバージョンのタグが解決されたマニフェストのダイジェスト。タグではなく、それが示すバイト列によってバージョンを指定します。 |
signer | VerifiedSignature | いいえ | レジストリの信頼ポリシーに対して検証された署名。検証方法、検証された署名者、および検証された署名バンドルのダイジェストを含みます。 |
publishedAt | string | いいえ | バージョンが公開された日時。UTC で秒単位までの RFC 3339 タイムスタンプです。その出典は publishedAtSource で、両者は常に揃って存在するか、どちらも存在しないかのいずれかです。 |
publishedAtSource | const “transparency-log” または const “publisher” | いいえ | publishedAt の出所です。透明性ログが証明する時刻を、公開者が述べる時刻と取り違えないようにするためのものです。値の集合は閉じています。使用できる値: "transparency-log" — 透明性ログがそのバージョンのキーレス署名を記録した時刻で、インデックス構築時の信頼ポリシーが、その時刻に対するログの署名付きの約束とともに検証したものです。公開時に署名されたバージョンでは公開時刻であり、後から署名されたバージョンではその署名が作成された時刻です。"publisher" — 公開物が公開内容とともに述べた時刻で、公開したマシン自身の時計によるものです。これを証明するものはありません。署名に証明された時刻が含まれない場合、つまりキー付き署名の場合や署名がない場合に、公開物がこの時刻を述べます。複数添付されている場合は、最も早いものが採用されます。 |
追加のプロパティは許可されません。
VerifiedSignature
レジストリの信頼ポリシーに対して検証された署名。検証方法、検証された署名者、および検証された署名バンドルのダイジェストを含みます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
bundleDigest | string | はい | 検証された署名バンドルのダイジェスト。sha256: の後に小文字の 16 進数 64 文字が続く形式です。 |
identity | string | いいえ | 署名が検証された署名者。キーレス署名の場合は、署名証明書の発行対象である ID(サブジェクト代替名)です。鍵付き署名の場合は、keyed:sha256: の後に、固定された公開鍵の PEM テキストの SHA-256 を小文字の 16 進数で続けたものです。 |
issuer | string | いいえ | キーレス署名の場合に署名証明書に記録された OIDC 発行者。鍵付き署名には存在しません。 |
mode | const “keyless” または const “keyed” | はい | 署名がどのように検証されたかです。値の集合は閉じています。使用できる値: "keyless" — 識別情報と発行者がポリシーの信頼するものと一致し、ポリシーが固定するトラストルート、または固定されていない場合は公益の Sigstore ルートへチェーンし、その署名が透明性ログに記録されている署名証明書に対して検証されました。"keyed" — ポリシーが固定する公開鍵に対して検証されました。 |
追加のプロパティは許可されません。
RegistrySearchRecord
検索で一致した 1 つのレコード(ローカルインデックスが保持する形)と、そのバージョンのうち公開されたマーカーにより非推奨とされたもの。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
uri | string | はい | レコードの解決元となる参照。 |
name | string | はい | エンティティ名です。 |
version | string | はい | レコードのキーとなるバージョン。 |
versions | string[] | いいえ | インデックスがこの参照について保持するすべてのバージョン。 |
kind | string | いいえ | エンティティの種類です。 |
description | string | いいえ | エンティティの用途。 |
category | string | いいえ | エンティティが公開されているカテゴリ。 |
labels | string のマップ | いいえ | エンティティが宣言するラベル。 |
pluginType | string | いいえ | プラグインのレコードがアタッチされるソケット。 |
capabilities | string[] | いいえ | プラグインのレコードが宣言する機能。 |
manifestDigest | string | いいえ | 公開されたマニフェストのダイジェスト。 |
listingDigest | string | いいえ | レコードの読み取り元となった一覧のダイジェスト。 |
deprecations | object[] | いいえ | インデックスがこの参照について保持する非推奨マーカー。それぞれ対象のバージョンと検証済みのマーカー自体を含みます。 |
published | PublishedVersion[] | いいえ | インデックスがこの参照について保持するすべてのバージョン。versions と同じ順序で、それぞれに、インデックスの構築時にタグが解決されたマニフェストのダイジェスト、インデックスの構築時の信頼ポリシーがそのバージョン自身の署名を検証した場合は検証済みの署名者、何らかの記録がある場合は公開日時とその出典を含みます。署名者なしで記録されたバージョンは、そのポリシーが検証した署名を持たず、それ以上のことは示されません。これを記録するためにレジストリから読み取られるのは、マニフェスト、署名アタッチメント、公開日時アタッチメントのみで、エンティティの内容は取得されません。 |
retracted | string[] | いいえ | 公開されたマーカーにより非推奨とされたバージョン。 |
追加のプロパティは許可されません。
RegistrySearchIndex
検索した 1 つのホストの鮮度です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
host | string | はい | インデックスが検索されたホストです。 |
lastUpdated | string | いいえ | インデックスが最後に更新された日時です。スナップショットに時刻がない場合はゼロではなく省略されるため、呼び出し側は「記録なし」とエポックを区別できます。 |
追加のプロパティは許可されません。
EffectiveConfigurationSetting
解決された 1 つの設定と、その設定の由来となったドキュメントです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
field | string | はい | 設定です。 |
value | string | はい | 解決された値です。 |
source | string | はい | 値の由来です。 |
追加のプロパティは許可されません。
ImportedFile
インポートが書き込む 1 つのファイルです。ドラフトのドキュメント、またはインポートが書き込んだ内容の記録です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
path | string | はい | ファイルの配置先で、応答の outputDir からの相対パスです。 |
content | string | はい | ファイルのテキストです。 |
追加のプロパティは許可されません。
ImportDrift
同期がソースに合わせて更新した、または dryRun のもとで更新するはずの 1 つの部分です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
change | string | はい | 部分のずれ方です。ソースに追加された部分は added、削除された部分は removed、変更された部分は changed です。 |
file | string | はい | その部分を含むドラフトのファイルで、応答の outputDir からの相対パスです。 |
key | string[] | はい | ドラフトの Aggregate または Release の最上位からその部分に至るキーで、キーごとに 1 エントリです。そのためピリオドを含むキーも 1 エントリのままです。部分がファイル全体の場合は空です。 |
追加のプロパティは許可されません。
ImportOwed
ドラフトがまだ空のまま残している値のうち、どのソースも提供できず、どの回答も提供しなかった 1 つの値です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
file | string | はい | 値があるドラフトされたファイルで、応答の outputDir からの相対パスです。 |
key | string[] | はい | そのドキュメントの先頭から値に至るキーで、キーごとに 1 エントリです。そのため、ピリオドを含むキーも 1 つのエントリのままです。answered として送信される回答は、これらのキーで値を示します。 |
question | string | はい | 値が何であるか。そのスキーマの説明、それがなければドラフトがそのキーの上に書くコメント、それもなければそのスキーマが受け付けるとするものです。 |
sensitive | 真偽値 | はい | 値がシークレットのものかどうか。シークレットの回答はその出どころを示し、シークレットそのものを保持することはありません。 |
secretAdvice | string | いいえ | シークレットの値に存在します。その回答がどうあるべきかを、ターミナルで回答する人に示される文で表します。あるいは、answered としてその値に送信された回答が拒否された場合は、拒否された理由を示します。 |
追加のプロパティは許可されません。
ImportAnswered
応答の owed が列挙した値に対する 1 つの回答です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
file | string | はい | 値があるドラフトされたファイルで、owed が示すとおりです。 |
key | string[] | はい | 値に至るキーで、owed が示すとおりです。 |
answer | string | はい | 回答です。空の回答では値は未回答のまま残ります。 |
追加のプロパティは許可されません。
ImportDiagnostic
変換で変換できなかった 1 つの事項です。これは変換の最も有用な出力であるため、判定に縮約せず完全に報告されます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
severity | string | はい | 重大度です。 |
message | string | はい | 変換できなかった内容です。 |
code | string | いいえ | その状態の引用可能な名前がある場合は、その名前です。 |
追加のプロパティは許可されません。
ImportDecision
変換が 1 つのソースノードをどうマッピングしたかです。インポーターが検討したカタログの Components、選択したもの、その理由、および選択の差し替え方法です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
sourceNode | DecisionSourceNode | はい | マッピングの決定の対象となるソースノードです。 |
candidates | ImportCandidate[] | いいえ | インポーターがそのノードについて検討したカタログの Components で、それぞれにスコアが付きます。何も検討しなかった場合は省略されます。 |
chosen | DecisionChoice | いいえ | インポーターがソースノードについて選択したものです。選択を行わなかった決定では省略されます。 |
rationale | string | いいえ | インポーターがその選択をした理由で、インポーター自身の言葉によるものです。何も書かれなかった場合は省略されます。 |
swapHint | string | いいえ | 選択を代替に差し替える方法で、インポーター自身の言葉によるものです。何も書かれなかった場合は省略されます。 |
追加のプロパティは許可されません。
DecisionSourceNode
マッピングの決定の対象となるソースノードです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
id | string | はい | ソースにおけるノードの識別子です。 |
type | string | はい | ソースが付けた名前でのノードの型です。 |
paramsSummary | string | はい | 決定の横に表示するための、ノードのパラメーターの要約です。 |
追加のプロパティは許可されません。
ImportCandidate
インポーターがソースノードについて検討したカタログの 1 つの Component です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
componentName | string | はい | Component の名前です。 |
score | 数値 | はい | インポーターが採点した、Component がノードにどれだけ一致するかです。 |
tier | string | はい | スコアが該当する一致の段階です。 |
signals | CandidateSignals | はい | インポーターの各シグナルが候補のスコアに寄与した分です。 |
追加のプロパティは許可されません。
CandidateSignals
インポーターの各シグナルが候補のスコアに寄与した分です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
table | 数値 | はい | マッピングテーブルのシグナルの寄与分です。 |
category | 数値 | はい | カテゴリのシグナルの寄与分です。 |
domainLabels | 数値 | はい | ドメインラベルのシグナルの寄与分です。 |
shape | 数値 | はい | 形状のシグナルの寄与分です。 |
name | 数値 | はい | 名前のシグナルの寄与分です。 |
追加のプロパティは許可されません。
DecisionChoice
インポーターがソースノードについて選択したものです。選択を行わなかった決定では省略されます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
target | string | はい | 選択された Component の名前です。既存のカタログの Component、またはそのノード用にドラフトされたものです。 |
mode | string | はい | 選択の書き方です。既存の Component への参照として、または新たにドラフトされたものとして書かれます。 |
tier | string | はい | 選択の一致の段階です。 |
追加のプロパティは許可されません。
LintFileFindings
慣例のチェックが 1 つのドキュメントで検出した内容です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
file | string | はい | ドキュメントです。 |
diagnostics | Diagnostic[] or null | はい | そのドキュメント内の検出結果です。 |
追加のプロパティは許可されません。
PluginRetractionExclusion
利用可能だったが選択されなかった 1 つのバージョンです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
version | string | はい | 見送られたバージョンです。 |
reason | string | いいえ | スキップされた理由。 |
追加のプロパティは許可されません。
PluginRetractionProvenance
何が非推奨であるかという情報の出所です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
source | string | はい | 参照されたものです。 |
lastUpdated | string | いいえ | それが最後に更新された日時です。 |
追加のプロパティは許可されません。
PluginRetraction
非推奨マーカーが、どのプラグインバージョンが固定されるかにどう影響したかです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
reference | string | はい | バージョンが属する参照です。 |
selected | string | いいえ | 固定されたバージョンです。 |
excluded | PluginRetractionExclusion[] | いいえ | 利用可能だったが見送られたバージョンです。 |
unscreened | string | いいえ | マーカーと照合できなかった内容とその理由です。 |
provenance | PluginRetractionProvenance | いいえ | 何が非推奨であるかという情報の出所です。 |
追加のプロパティは許可されません。
PluginGeneratedDocument
生成によって作成された 1 つのカタログドキュメントです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
path | string | はい | ドキュメントの配置先で、ワークスペースルートからの相対パスです。 |
content | string | はい | ドキュメントのテキストです。 |
追加のプロパティは許可されません。
PluginCommandFlag
プラグインが提供するコマンドに宣言する 1 つのフラグです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
name | string | はい | フラグの長い名前です。 |
shorthand | string | いいえ | フラグの 1 文字のエイリアスがある場合は、そのエイリアスです。 |
description | string | いいえ | フラグの 1 行のヘルプテキストです。 |
type | string | いいえ | フラグの値の型です。 |
default | string | いいえ | フラグが渡されないときに使われる値です。 |
追加のプロパティは許可されません。
PluginCLICommand
プラグインが提供する 1 つのトップレベルのコマンド動詞です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
name | string | はい | コマンド動詞です。 |
description | string | いいえ | コマンドの 1 行のヘルプテキストです。 |
flags | PluginCommandFlag[] | いいえ | コマンドのフラグで、宣言順です。 |
追加のプロパティは許可されません。
ConfigCapturedAttachment
フリーズがこのワークスペース自身の設定に書き込んだ 1 つのアタッチメントです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
uri | string | いいえ | アタッチメントの解決元となる参照です。 |
capability | string | いいえ | アタッチメントの対象となるケイパビリティです。 |
function | string | いいえ | アタッチメントのディスパッチ先となるエクスポートです。 |
role | string | いいえ | アタッチメントが実行されるロールです。これにより出力できる内容が決まります。 |
追加のプロパティは許可されません。
ConfigCapturedSocket
フリーズが書き込んだ 1 つのソケットと、そこにフリーズしたアタッチメントです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
socket | string | はい | ソケットです。 |
field | string | はい | ソケットが書き込まれる設定フィールドです。 |
attachments | ConfigCapturedAttachment[] or null | はい | そのソケットにフリーズされたアタッチメントです。 |
追加のプロパティは許可されません。
ExplainErrorEntry
ある状態に対するオーサリング上の修正方法を説明する、公開された 1 つの文章です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
heading | string | はい | 文章の見出しです。 |
body | string | はい | 文章です。 |
追加のプロパティは許可されません。
SignedArtifact
署名の対象となった 1 つの公開済みアーティファクトです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
reference | string | はい | 署名された参照です。 |
digest | string | はい | 署名された内容のダイジェストです。 |
追加のプロパティは許可されません。
DeprecationMarked
非推奨化によってマークされた 1 つの公開済みバージョンです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
reference | string | はい | マークされた参照です。 |
severity | const “warning” or const “error” or const “retracted” | はい | マーカーの強さです。使用できる値: "warning" — 非推奨。2 つの勧告段階のうち弱いほうで、バージョンを選ぶ際には引き続き選択されます。"error" — 非推奨。2 つの勧告段階のうち強いほうで、バージョンを選ぶ際には引き続き選択されます。"retracted" — 撤回済み。バージョンを選ぶ際に除外されます。 |
issuedOn | string | はい | マーカーが発行された日時です。 |
digest | string | はい | 公開されたマーカーのダイジェストです。 |
追加のプロパティは許可されません。
InitializeResult
このクライアントに対してセッションが確定した内容と、それがどの設定レイヤーから解決されたか。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
capabilities | ServerCapabilities | はい | クライアントが処理できると示した内容に照らして決定された、このセッションでデーモンが行う内容です。 |
workspaceRoot | string | はい | セッションが開かれたワークスペース。 |
configSource | string | はい | セッションが設定を解決した設定レイヤー。 |
workspaceMarker | string | いいえ | ワークスペースルートを特定したファイル(存在する場合)。 |
version | string | はい | このセッションに応答しているバイナリのバージョンです。そのバイナリに対して aggrega version が報告する値と同じです。実行中のプロセスを表すため、デーモンの起動元ファイルが置き換えられた後も、この値は実行中のバージョンを示し、ファイルに問い合わせると置き換え後のバージョンが示されます。 |
追加のプロパティは許可されません。
ValidateResult
検査で見つかったものと、検査した範囲。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
diagnostics | Diagnostic[] or null | はい | 検出結果です。検査で何も見つからなかった場合は、空のリストではなく null になります。 |
checked | string | いいえ | 検査した範囲です。1 つのドキュメント、またはワークスペースが保持するもの全体です。 |
追加のプロパティは許可されません。
InvalidateResult
デーモンがそのドキュメントについて破棄すべきものを保持していたかどうか。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
invalidated | 真偽値 | はい | 何かが破棄されたかどうか。 |
追加のプロパティは許可されません。
DiagnosticsResult
デーモンがそのドキュメントについてすでに保持している検出結果。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
diagnostics | Diagnostic[] or null | はい | 検出結果です。何もない場合は、空のリストではなく null になります。 |
追加のプロパティは許可されません。
IrGraphResult
Release のコンパイル結果である解決済みグラフ。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
graph | any | はい | グラフドキュメントです。作成者が機密と宣言した値は、リクエストが unredacted で要求しない限り除外されます。それ以外はすべてコンパイラが出力したとおりに渡されます。その形状はグラフの公開された契約であり、ここでは再掲しません。 |
追加のプロパティは許可されません。
BuildResult
ビルドが書き出したもの。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
outputDirectory | string | はい | 成果物が書き出されたディレクトリ。 |
files | string[] or null | はい | 書き出された成果物(出力ディレクトリからの相対パス)。 |
notices | BuildNotice[] | いいえ | 検出結果でも失敗でもないが、ビルドが呼び出し元に知らせたい事柄。 |
dependencyResolution | DependencyResolutionReport | いいえ | 依存関係の解決が固定し、取得したものです。 |
追加のプロパティは許可されません。
BuildPreviewResult
ビルドが書き出したはずのもの。何も書き出されていないため、示すべき出力ディレクトリはありません。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
files | string[] or null | はい | 書き出しを行った場合に生成されたはずの成果物。 |
notices | BuildNotice[] | いいえ | 検出結果でも失敗でもないが、コンパイルが呼び出し元に知らせたい事柄。 |
追加のプロパティは許可されません。
EntityDefinitionResult
エンティティ名の解決先と、それを定義するドキュメント。レジストリ参照から読み取った応答には published が含まれ、カタログが名前で解決した応答には決して含まれません。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
kind | string | はい | エンティティの種類です。 |
name | string | はい | エンティティ名です。 |
version | string | はい | 解決されたバージョン。 |
description | string | いいえ | ドキュメントが述べるエンティティの用途です。 |
publishScope | string | いいえ | エンティティの公開範囲。 |
file | string | はい | それを定義するドキュメント。 |
authoredLength | integer | はい | 作成されたドキュメントのバイト数です。クライアントは、作成されたドキュメントとその解決済みレンダリングを区別できます。 |
definition | string | はい | 定義のテキスト。 |
published | PublishedArtifact | いいえ | レジストリ参照が読み取ったもの。座標、それがエンティティをどのように保持していたか、そして読み取りに使われたマニフェストです。これが存在する場合、すべてのフィールドが存在します。 |
追加のプロパティは許可されません。
PublishedArtifact
レジストリ参照が読み取ったもの。座標、それがエンティティをどのように保持していたか、そして読み取りに使われたマニフェストです。これが存在する場合、すべてのフィールドが存在します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
reference | string | はい | 読み取られたレジストリ参照。 |
archive | 真偽値 | はい | 座標のバイト列が、エンティティドキュメントを展開する元のアーカイブだったかどうか。座標がエンティティドキュメントそのものを保持していた場合は false です。 |
mediaType | string | はい | マニフェストが宣言する成果物の種類。 |
manifestDigest | string | はい | エンティティの読み取りに使われたマニフェストのダイジェストです。同じバイト列を正確に再度読み取るには、この値を @ の後に指定します。 |
追加のプロパティは許可されません。
ReleaseClosureResult
Release が依存するすべてのもの(解決が到達した範囲)。そこから導かれるグラフではなくクロージャを報告します。同じ Release についての別のドキュメントです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
release | string | はい | 検査された Release。 |
aggregate | string | はい | それがデプロイする Aggregate。 |
manifest | string | はい | それが解決に使う Manifest。 |
environment | string | はい | それが指定する環境。 |
entities | ClosureEntity[] or null | はい | クロージャが到達するエンティティ。 |
libraries | ClosureEntity[] or null | はい | クロージャが到達するライブラリ。 |
plugins | ClosureEntity[] or null | はい | クロージャが到達するプラグイン。 |
mappingDiagnostics | string[] or null | はい | Manifest のマッピングの解決で報告された内容。 |
deprecations | string[] or null | はい | クロージャが遭遇した非推奨マーカー。 |
追加のプロパティは許可されません。
ResolveDependenciesResult
依存関係の解決が固定し取得したものと、呼び出し元に知らせたい事柄。レポート自体のフィールドは、この応答のメンバーの下に入れ子にされず、この応答に直接含まれます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
lockfile | string | はい | 解決が書き込んだロックファイル、または検証が比較したロックファイルです。 |
verified | 真偽値 | いいえ | リクエストが検証であったかどうかです。検証は記録済みのロックファイルと比較し、ロックファイル、プラグインの信頼記録、entity.lock のいずれも書き込みません。 |
entities | ClosureEntity[] or null | はい | 解決が固定した、または検証が比較したエンティティです。 |
libraries | ClosureEntity[] or null | はい | 解決が固定した、または検証が比較したライブラリです。 |
plugins | ClosureEntity[] or null | はい | 解決が固定した、または検証が比較したプラグインです。 |
sourceArtifacts | integer | はい | 取得されたソースアーティファクトの数です。 |
trustedPlugins | integer | はい | 固定されたプラグインのうち、検証済みの署名を持っていたものの数です。 |
toolchain | ToolchainReport | いいえ | 解決を行ったコンパイラと、それが持つプラグインです。 |
externalInputs | integer | はい | レンダリングが使用する外部入力のうち、取得されたものの数です。 |
incompleteExternalInputs | string | いいえ | 一部の外部入力を取得できなかった場合に、取得できなかった外部入力です。 |
notices | string[] | いいえ | 解決が呼び出し元に知らせたい事柄。 |
追加のプロパティは許可されません。
PinResult
ピン留めステップがエンティティの隣のロックに対して行ったこと、またはドライランで行うはずのこと。aggrega/pin への応答であり、このステップを実行した公開はこれを pin として含みます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
entity | string | はい | ステップが読み取ったエンティティドキュメント(ワークスペースルートからの相対パス)。 |
kind | string | はい | ドキュメントが宣言するエンティティの種類。 |
name | string | はい | ドキュメントが宣言するエンティティの名前。 |
pinnable | 真偽値 | はい | この種類のエンティティが、ロックがピンを記録する対象を読み取るかどうか。Recipe と FeatureRecipe は読み取ります。false の場合、エンティティの隣には何も変更が加えられず、changed は false で、lock、removed、pins、content は存在しません。 |
lock | string | いいえ | ステップが書き出した、または書き出すはずのロック(ワークスペースルートからの相対パス)。 |
changed | 真偽値 | はい | ロックが変化したか、ドライランで変化するはずかどうか。ロックがエンティティに必要なすべてのピンをすでに記録しており、バイト単位で同一のまま残された場合は false です。 |
removed | 真偽値 | いいえ | 変化が削除かどうか。エンティティはロックがピンを記録する対象を何も読み取らないため、その隣にロックは残りません。 |
dryRun | 真偽値 | いいえ | これが、ステップが行ったことではなく行うはずのことを報告しているかどうか。 |
pins | PinClassCount[] | いいえ | ステップ後、またはドライラン後にロックが保持するクラスごとのピン数。ロックが保持し得るすべてのクラスが、ピンのないクラスも含めて列挙されます。 |
content | string | いいえ | ドライランが書き出すはずのロック。ロックがそのまま残されるか削除される場合、およびドライランでないすべての応答では存在しません。 |
追加のプロパティは許可されません。
PinClassCount
ロックが保持する 1 つのクラスのピン数。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
class | string | はい | ピンのクラスです。欠落しているピンを示す拒否メッセージが使う言葉で表されます。たとえば remote source や imported file です。 |
pins | integer | はい | ロックが保持するそのクラスのピン数。 |
追加のプロパティは許可されません。
CacheStatusResult
このワークスペースに対応するキャッシュが保持している内容です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
classes | CacheClass[] or null | はい | 各キャッシュとその保持内容です。 |
provenance | CacheProvenance[] or null | はい | キャッシュされた成果物がどの ID で取得されたかを示します。 |
totalCount | integer | はい | キャッシュが保持するエントリの合計数です。 |
totalSize | integer | はい | それらが占めるバイト数の合計です。 |
totalSizeText | string | はい | 同じ合計を人が読みやすい形式で表したものです。 |
scope | CacheScope | はい | キャッシュの応答が及ぶ範囲です。キャッシュクラスのうち 2 つはマシン上のすべてのプロジェクトで共有されるため、すべてのキャッシュの応答は、どのクラスに触れたかを示します。そうしなければ、1 つのワークスペースで開かれたセッションは、そのワークスペースについてのみ報告しているものと解釈されてしまいます。 |
追加のプロパティは許可されません。
CachePruneResult
回収処理で削除したもの、保持したもの、回収できなかったものです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
removed | CacheRemoval[] or null | はい | 削除されたものです。 |
heldOpen | CacheRemoval[] or null | はい | prune で削除されるはずだったものの、別のプロセスが開いていたためそのまま残されたものです。開いているファイルの削除を拒否するのは Windows のみのため、他の環境ではこれは空です。これらのエントリは削除にも保持にも数えられず、そのバイトも回収済みとしては数えられません。後の prune で回収されます。ディレクトリであるエントリでは、開かれていなかった中のファイルがすでに失われている場合があります。 |
retainedCount | integer | はい | 保持されたエントリの数です。 |
reclaimedBytes | integer | はい | 回収されたバイト数です。 |
reclaimedBytesText | string | はい | 同じ数値を人が読みやすい形式で表したものです。 |
unattributedCount | integer | はい | どの保持者も要求していないエントリの数です。 |
unattributedSize | integer | はい | それらが占めるバイト数です。 |
unattributedSizeText | string | はい | 同じ数値を人が読みやすい形式で表したものです。 |
notPruneEligible | CacheShortfall[] or null | はい | 残されたものと、それを回収する方法です。 |
scope | CacheScope | はい | キャッシュの応答が及ぶ範囲です。キャッシュクラスのうち 2 つはマシン上のすべてのプロジェクトで共有されるため、すべてのキャッシュの応答は、どのクラスに触れたかを示します。そうしなければ、1 つのワークスペースで開かれたセッションは、そのワークスペースについてのみ報告しているものと解釈されてしまいます。 |
追加のプロパティは許可されません。
CacheEvictResult
指定サイズまで回収した際に削除したものと、残っているものです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
withinCapBefore | 真偽値 | はい | 保持内容がすでにサイズ内に収まっていて、削除が不要だったかどうかです。 |
removed | CacheRemoval[] or null | はい | 削除されたものです。 |
heldOpen | CacheRemoval[] or null | はい | 回収処理で削除されるはずだったものの、別のプロセスが開いていたためそのまま残されたものです。その場合は次に古いエントリに進みました。開いているファイルの削除を拒否するのは Windows のみのため、他の環境ではこれは空です。これらのエントリは残りのバイト数に引き続き数えられ、後の回収処理で削除できます。 |
totalBefore | integer | はい | 回収前に保持されていたバイト数です。 |
totalBeforeText | string | はい | 同じ数値を人が読みやすい形式で表したものです。 |
reclaimedBytes | integer | はい | 回収されたバイト数です。 |
reclaimedBytesText | string | はい | 同じ数値を人が読みやすい形式で表したものです。 |
remainingBytes | integer | はい | 残っているバイト数です。 |
remainingBytesText | string | はい | 同じ数値を人が読みやすい形式で表したものです。 |
capBytes | integer | はい | 回収の目標としたサイズ(バイト単位)です。 |
capBytesText | string | はい | 同じサイズを人が読みやすい形式で表したものです。 |
scope | CacheScope | はい | キャッシュの応答が及ぶ範囲です。キャッシュクラスのうち 2 つはマシン上のすべてのプロジェクトで共有されるため、すべてのキャッシュの応答は、どのクラスに触れたかを示します。そうしなければ、1 つのワークスペースで開かれたセッションは、そのワークスペースについてのみ報告しているものと解釈されてしまいます。 |
追加のプロパティは許可されません。
CacheClearResult
キャッシュを空にして回収したものです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
cleared | CacheCleared[] or null | はい | 空にされた各キャッシュです。 |
reclaimedBytes | integer | はい | 回収されたバイト数です。 |
reclaimedBytesText | string | はい | 同じ数値を人が読みやすい形式で表したものです。 |
scope | CacheScope | はい | キャッシュの応答が及ぶ範囲です。キャッシュクラスのうち 2 つはマシン上のすべてのプロジェクトで共有されるため、すべてのキャッシュの応答は、どのクラスに触れたかを示します。そうしなければ、1 つのワークスペースで開かれたセッションは、そのワークスペースについてのみ報告しているものと解釈されてしまいます。 |
追加のプロパティは許可されません。
RegistryListResult
このワークスペースが解決に使用するレジストリです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
registries | Registry[] or null | はい | 設定済みの各レジストリです。 |
credentialStateIsMachineWide | 真偽値 | はい | 各レジストリについて報告される認証情報の有無が、ワークスペース単位ではなくマシン全体の事実であるかどうかです。セッション単位の応答が、より広い範囲を否定していると読まれないように報告されます。 |
追加のプロパティは許可されません。
SearchResult
検索に対してローカルのレジストリインデックスが提示したものです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
records | RegistrySearchRecord[] or null | はい | 一致したレコードです。 |
indexes | RegistrySearchIndex[] or null | はい | 検索された各ホストと、そのインデックスが最後に更新された日時です。 |
missingIndexHosts | string[] or null | はい | 検索対象のローカルインデックスがない設定済みホストです。これにより、結果が少ない理由が推測に任されず説明されます。 |
stale | 真偽値 | はい | 検索したインデックスのいずれかが、更新する価値があるほど古いかどうかです。 |
registriesConfigured | 真偽値 | はい | そもそもレジストリが設定されているかどうかです。これにより「何も一致しなかった」と「何も検索されなかった」が区別されます。 |
追加のプロパティは許可されません。
RegistryAddResult
レジストリの登録で何をどこに書き込み、レジストリ自体から何を読み取ったかです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
host | string | はい | エントリのキーとなるホストです。リクエストで使われた表記と同じとは限りません。 |
scope | ConfigWriteScope | はい | どの設定ドキュメントが書き込まれ、それがどこまで及ぶかです。リクエストは 1 つのワークスペースを指定するため、何も示さない応答はそのワークスペースについてのものと解釈されますが、マシン全体への書き込みではその解釈は誤りです。 |
trust | TrustFetchOutcome | はい | レジストリが公開する信頼ポリシーの読み取りがどうなったかを示します。各結果は意味が異なるため区別して保持されます。公開されたポリシーが採用された、レジストリが何も公開していなかった(これは失敗ではありません)、代わりに組み込みのベースラインが固定された、または読み取りが試みられなかった、のいずれかです。何も公開されていなかった場合は、レジストリにそもそも到達できたかどうかがその横に示されます。 |
追加のプロパティは許可されません。
RegistryRemoveResult
レジストリの削除で何をどこに書き込んだかです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
host | string | はい | エントリが削除されたホストです。 |
scope | ConfigWriteScope | はい | どの設定ドキュメントが書き込まれ、それがどこまで及ぶかです。リクエストは 1 つのワークスペースを指定するため、何も示さない応答はそのワークスペースについてのものと解釈されますが、マシン全体への書き込みではその解釈は誤りです。 |
追加のプロパティは許可されません。
RegistryUpdateResult
ローカルインデックスの更新がホストごとに何を行ったかです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
hosts | HostUpdate[] or null | はい | 更新が各ホストに対して行ったことです。 |
failed | string[] or null | はい | 更新を完了できなかったホストです。 |
indexRoot | string | はい | インデックスが書き込まれたディレクトリです。 |
registriesConfigured | 真偽値 | はい | そもそもレジストリが設定されているかどうかです。 |
reachedRegistries | 真偽値 | はい | この応答では常に true です。インデックスの更新はレジストリ自体にアクセスしますが、一覧表示と検索は設定とローカルインデックスから応答します。特定のレジストリに実際に到達できたかどうかは、hosts 内のそのエントリの unreachable で示されます。 |
追加のプロパティは許可されません。
LogoutResult
どの保存済み認証情報が削除されたかと、ストアの影響範囲です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
registry | string | はい | 認証情報が削除されたレジストリです。 |
scope | CredentialStoreScope | はい | 認証情報の変更が及ぶ範囲です。ストアはマシン上のすべてのプロジェクトと、同じレジストリにアクセスする他のすべてのツールで共有されるため、応答はセッション単位であるという解釈を推測に委ねるのではなく、そのことを報告します。 |
追加のプロパティは許可されません。
PublishEntityResult
エンティティの公開によって何がどこに配置されたか。先に pin ステップを実行した公開は、そのステップが行ったことも pin として保持します。ステップが実行されなかった場合は存在しません。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
reference | string | はい | エンティティが公開された参照。 |
tag | string | はい | 公開されたタグ。 |
kind | string | はい | 公開されたエンティティの種類。 |
mediaType | string | はい | 公開されたバイト列に記録されたメディアタイプ。 |
size | integer | はい | 公開されたバイト数。 |
sizeText | string | はい | 同じサイズを人が読みやすい形式で表したものです。 |
pluginSize | integer | いいえ | Plugin エンティティとともに公開されたプラグインモジュールが占めるバイト数。 |
pluginSizeText | string | いいえ | 同じサイズを人が読みやすい形式で表したものです。 |
digest | string | はい | 公開されたもののダイジェスト。ドライランでは、同じ内容の公開が配置するはずのダイジェストを内容のみから計算したもので、aggrega push --dry-run が出力するものです。 |
signed | 真偽値 | はい | この公開が署名を添付したかどうか。公開前に作成した署名、またはすでに公開済みのバージョンではそのバージョンに欠けていた署名です。 |
alreadyPublished | 真偽値 | はい | 同じバイト列がすでに存在し、内容がアップロードされなかったかどうか。その公開にまだ欠けていたものだけがその横に添付されました。公開日と、この公開が署名する場合はその署名です。署名が添付されたかどうかは signed が示します。 |
dryRun | 真偽値 | はい | これが公開の実際の結果ではなく、公開した場合に配置されたはずのものを報告しているかどうか。 |
reach | PublicationReach | はい | 公開がどこまで及んだかを示します。これらの応答はこのマシンの外にまで完全に及びます。応答が付加するものは、そのレジストリのすべての利用者が解決するものになるためです。そのため、各応答はアドレスしたすべてのレジストリと、その呼び出しがそこに何かを付加したかどうかを示します。 |
pin | PinResult | いいえ | ピン留めステップがエンティティの隣のロックに対して行ったこと、またはドライランで行うはずのこと。aggrega/pin への応答であり、このステップを実行した公開はこれを pin として含みます。 |
wholeDirectorySource | string | いいえ | 記述されたままのエンティティのローカルソースで、テンプレートとして書かれている場合に存在します。このようなソースは Release がテンプレートを埋めて初めてディレクトリを指定するため、公開にはエンティティが指定するファイルだけでなく、エンティティのディレクトリ内のすべてのファイルが含まれます。指定されたファイルのみを含む場合は存在しません。 |
windowsUnusableEntries | string[] | いいえ | 公開されたアーカイブのエントリのうち、パスに Windows がそのままでは保持できない部分を含むもの。CON、AUX、NUL など、大文字小文字や後続の拡張子にかかわらず Windows がデバイス用に予約している名前、またはピリオドかスペースで終わる部分です。エンティティドキュメント自身のファイル名が先頭で、その後に含まれるファイルが続きます。Windows 上のワークスペースはこれらの展開を拒否するため、そのバージョンを使用できません。公開は、これらがない場合とまったく同じように続行または停止します。該当がない場合は存在せず、これにはドキュメントのみとして公開されたエンティティも含まれます。 |
追加のプロパティは許可されません。
PublishArtifactResult
ファイルの公開によって何がどこに配置されたか。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
reference | string | はい | ファイルが公開された参照。 |
tag | string | はい | 公開されたタグ。 |
mediaType | string | はい | 公開されたバイト列に記録されたメディアタイプ。 |
size | integer | はい | 公開されたバイト数。 |
sizeText | string | はい | 同じサイズを人が読みやすい形式で表したものです。 |
digest | string | はい | 公開されたもののダイジェスト。 |
alreadyPublished | 真偽値 | はい | 同じバイト列がすでに存在し、内容がアップロードされなかったかどうか。公開日は、アーティファクトに欠けていた場合にのみその横に添付されました。 |
dryRun | 真偽値 | はい | これが公開の実際の結果ではなく、公開した場合に配置されたはずのものを報告しているかどうか。 |
reach | PublicationReach | はい | 公開がどこまで及んだかを示します。これらの応答はこのマシンの外にまで完全に及びます。応答が付加するものは、そのレジストリのすべての利用者が解決するものになるためです。そのため、各応答はアドレスしたすべてのレジストリと、その呼び出しがそこに何かを付加したかどうかを示します。 |
追加のプロパティは許可されません。
SignArtifactsResult
何が署名され、署名がどこに配置されたか。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
signed | SignedArtifact[] or null | はい | 署名された各参照。 |
reach | PublicationReach | はい | 公開がどこまで及んだかを示します。これらの応答はこのマシンの外にまで完全に及びます。応答が付加するものは、そのレジストリのすべての利用者が解決するものになるためです。そのため、各応答はアドレスしたすべてのレジストリと、その呼び出しがそこに何かを付加したかどうかを示します。 |
追加のプロパティは許可されません。
DeprecateArtifactResult
何が非推奨としてマークされ、マーカーがどこに配置されたか。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
marked | DeprecationMarked[] or null | はい | マークされた各バージョン。 |
reach | PublicationReach | はい | 公開がどこまで及んだかを示します。これらの応答はこのマシンの外にまで完全に及びます。応答が付加するものは、そのレジストリのすべての利用者が解決するものになるためです。そのため、各応答はアドレスしたすべてのレジストリと、その呼び出しがそこに何かを付加したかどうかを示します。 |
追加のプロパティは許可されません。
ResolveResult
カーソル位置にあるものが定義されている場所。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
location | null or Location | はい | 定義されている場所。カーソル位置に定義へ解決されるものがない場合は null です。 |
追加のプロパティは許可されません。
FindReferencesResult
カーソル位置にあるものが参照されている場所。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
locations | Location[] or null | はい | 参照されている各箇所。 |
追加のプロパティは許可されません。
FindImplementationsResult
カーソル位置にあるものを実装しているドキュメント。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
locations | Location[] or null | はい | 実装されている各箇所。 |
追加のプロパティは許可されません。
HoverResult
カーソル位置にあるものについて表示する内容。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
contents | null or MarkupContent | はい | 表示する内容。カーソル位置にあるものについて示すことがない場合は null です。 |
追加のプロパティは許可されません。
CompletionResult
カーソル位置に記述できるもの。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
items | CompletionItem[] or null | はい | 記述できる各項目。 |
追加のプロパティは許可されません。
CatalogIndexResult
ワークスペースのインデックスが保持するすべてのエンティティと、そのために読み込まれなかった、ワークスペース外のディレクトリやファイルへ通じるリンクです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
entities | CatalogEntity[] or null | はい | 各エンティティです。 |
unreadLinkedDirs | string[] | はい | ワークスペースルート配下にあり、ルート外のディレクトリへ通じる各リンクです。リンク自体が置かれている場所でルートからの相対パスで示し、ワークスペースを検索する順に並べます。ルート外のディレクトリは検索されないため、これらのリンクの先にあるドキュメントはワークスペース自身のものとして entities に含まれず、エンティティを一覧表示するクライアントはその理由を示せます。示されないもの: ルート内のディレクトリへのリンク(実際に置かれている場所で検索され、または除外されます)、置かれている場所、名前、または .gitignore によってディレクトリが除外される場所にあるリンク、行き先がない、またはループするために解決できないリンク、そして Release の観点で与えられる回答では、他の Releases だけが読み込むカタログディレクトリ配下のリンクです。ワークスペースにそのようなリンクがない場合は空です。 |
unreadLinkedFiles | string[] | はい | ワークスペースルート配下にあり、YAML ファイルのように名付けられ(自身の名前が .yaml または .yml で終わる)、ルート外のファイルへ通じる各リンクです。リンク自体が置かれている場所でルートからの相対パスで示し、ワークスペースを検索する順に並べます。そのようなファイルは、何を宣言していてもインデックスのために読み込まれないため、それが宣言するエンティティはワークスペース自身のものとして entities に含まれず、エンティティを一覧表示するクライアントはその理由を示せます。ワークスペース外のエンティティは、設定されたカタログディレクトリを通じて読み込まれます。示されないもの: ワークスペース設定が Release として(build.authoring_release として、または workspace.releases のキーとして)指定し、実際に Release を宣言しているファイルへのリンク(リンク自身の場所で読み込まれ、entities に含まれます)、ルート内のファイルへのリンク(リンク自身の場所で読み込まれます)、.gitignore が除外するリンク、または検索が除外するディレクトリ内のリンク、ファイルに通じないリンク(ディレクトリへ通じるもの(ルート外へ通じる場合は unreadLinkedDirs が示します)、行き先がないもの、ループするもの)、そして Release の観点で与えられる回答では、他の Releases だけが読み込むカタログディレクトリ配下のリンクです。ワークスペース外へ通じるリンクであるワークスペース設定ファイル(自身の .aggrega-config.yaml、またはその横にある CI 管理のオーバーレイ)は、検索がそれに出会ったかどうかにかかわらず、検索が示したリンクの後に示されます。その場合、ワークスペースの設定はまったく読み込まれず、この回答は何も設定されていない状態で読み込んだワークスペース自身のインデックスとなるため、カタログディレクトリは読み込まれません。また、設定が決定するすべてのリクエスト(Release の観点でのインデックスを含む)は、そのワークスペースについて読み込み保留の条件とともに拒否されます。ワークスペースにそのようなリンクがない場合は空です。 |
追加のプロパティは許可されません。
AttachCandidatesResult
エンティティにアタッチできる Features と、その判定の基準となったラベルです。また、リクエストが接続を指定した場合は、そのソケットが宣言するスロットと、それぞれを埋められる Features です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
node | string | はい | 候補の判定対象となったエンティティです。 |
nodeLabels | map of string or null | はい | 判定の基準となったラベルです。 |
labelSource | string | はい | どのラベルセットが使われたかです。これは表面的な違いではありません。ドキュメントが宣言したラベルはソースを読んで分かるものであり、グラフノードのラベルはビルド自体が判定に使う確定済みのセットです。後者に基づいて計算された回答は、ビルドが何を行うかについての記述です。 |
candidates | SourcedEntityRef[] or null | はい | アタッチできる各 Feature です。 |
slots | SlotCandidacy[] | いいえ | リクエストが接続を指定した場合にのみ存在します。接続のソケットが宣言する各スロットを、Component が宣言する順に、それを埋められる Features とともに示します。接続上で埋められるスロットがない場合は空で、そのときは noSlotReason が理由を示します。クライアントは空のリストを、どの Feature にも一致しなかったスロットとみなさず、これを読みます。 |
noSlotReason | const “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
エンティティ上の各ソケットを、どのエンティティに接続できるかです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
node | string | はい | これらのソケットを持つエンティティです。 |
adHocSocketsAccepted | 真偽値 | はい | エンティティ自身の定義が事前に宣言していないソケットを、それでも記述できるかどうかです。 |
sockets | SocketCandidacy[] or null | はい | 各ソケットと、それに接続できるものです。 |
追加のプロパティは許可されません。
InsertionPointResult
指定されたコンテナ配下の新しいエントリがドキュメント内のどこに属するか、およびクライアントがそこに書き込むために必要なものです。挿入位置そのもの、テキストを改行で始める必要があるかどうか、まだ存在しないコンテナのキー、そして各行のインデントです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
file | string | はい | ドキュメントです。 |
container | string[] or null | はい | ドキュメント内のコンテナまでのパスです。 |
positionEncoding | string | はい | この回答の位置が表現されているエンコーディングです。 |
position | Position | はい | ドキュメント内の位置です。行とその行内の文字オフセットで、どちらも 0 から数えます。オフセットは、セッションを開いたときに取り決めたエンコーディングの単位で測られ、クライアントが別のものを要求しない限り UTF-16 です。 |
precededByLineBreak | 真偽値 | はい | その位置に書き込むテキストを改行で始める必要があるかどうかです。位置がドキュメントにすでにある行の末尾にあるためです。ドキュメントにエントリが続くべきものが何もない場合にのみ false になります。 |
missingContainerKeys | string[] or null | はい | ドキュメントにまだ存在しないコンテナパスのセグメントで、最も外側のものが先です。エントリを最も内側のものの中に置く前に、それぞれを独自のキーとして、前のものより 1 段深くインデントして書き込む必要があります。パス全体がすでに存在する場合は null です。 |
entryIndent | integer | はい | エントリ自身の最初の行が始まる列で、行頭からのスペース数で数えます。 |
indentStep | integer | はい | ネストの各レベルがどれだけ深くインデントされるかです。 |
indentStepMeasured | 真偽値 | はい | インデント幅がこのドキュメント自身のネストから測定されたかどうかです。false の場合、ドキュメントには測定できるネストがなく、幅はフォールバックであるため、独自の幅を適用したいクライアントはそうしてよいことが分かります。 |
entryShape | const “mapping” または const “sequence” または const “unknown” | はい | コンテナがエントリを保持する形で、これによってエントリ自身のテキストの組み立て方が決まります。ドキュメントにすでにあるコンテナから読み取られ、コンテナの名前から推測されることはありません。値のセットは閉じています。使用できる値: "mapping" — コンテナはブロックマッピングであり、そこに追加されるエントリはキーとその値です。"sequence" — コンテナはブロックシーケンスであり、そこに追加されるエントリはダッシュとその値です。"unknown" — ドキュメントにコンテナがないか、コンテナが空であるため、エントリがどの形を取るかはクライアントが決めます。 |
追加のプロパティは許可されません。
AttachmentContainerResult
グラフノード上、またはリクエストが指定した接続上のアタッチメントが、どのドキュメントのどこに属するかです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
node | string | はい | アタッチメントの対象となるグラフノードです。 |
file | string | はい | アタッチメントが属するドキュメントです。 |
container | string[] or null | はい | そのドキュメント内で、アタッチメントが属する場所までのパスです。 |
追加のプロパティは許可されません。
ConnectionAtPositionResult
位置がそのエントリ内にある接続、または接続が報告されない理由です。どちらか一方だけが存在します。graphNode と connection の組か、noConnectionReason 単独です。エントリ内のどこか(エイリアス、ターゲット、アタッチメント)にある位置はそのエントリ内にあり、エントリがネストしている場合は最も内側のものに属します。ソケット自身のキー上、つまりその配下に書かれたエントリより上にある位置は、どのエントリ内にもありません。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
graphNode | string | いいえ | 接続を引くコンポーネントを持つノードの ID で、コンパイル済みグラフがキーとして使う形です。候補リクエストとコンテナリクエストが graphNode として受け取る値です。 |
connection | ConnectionCoordinate | いいえ | ソケットとエイリアスで示した接続で、document は位置が読み取られたドキュメントを示します。候補リクエストとコンテナリクエストが connection として受け取る値です。 |
noConnectionReason | const “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 | string[] or null | はい | 各 Release ドキュメントです。 |
lockfiles | string のマップ | はい | 一覧の各 Release のロックファイルで、一覧に記載されたとおりの Release をキーとします。それぞれ、pull がその Release のために書き込み、ビルドが読み込むファイルです。そのため、クライアントは場所を自ら導き出すのではなく、ここから読み取ります。ワークスペースが Release を保持しない場合は空です。 |
unreadLinkedDirs | string[] | はい | ワークスペースルート配下にあり、ルートの外のディレクトリへ通じる各リンクで、リンク自体が置かれている場所をルートからの相対パスで示し、ワークスペースを検索する順序で並べます。ルートの外のディレクトリは検索されないため、これらのリンクのいずれかを通じてのみ到達する Release は releases に含まれず、Releases を提示するクライアントはその理由を示せます。次のものは記載されません。ルート内のディレクトリへのリンク(実際に置かれている場所で検索されるか、除外されます)、置かれている場所または名前によってディレクトリが除外される場所にあるリンク、および、どこにも通じていない、またはループしているために解決できないリンクです。ワークスペースにそのようなリンクがない場合は空です。 |
unreadLinkedFiles | string[] | はい | ワークスペースルート配下にあり、YAML ファイルのような名前(名前が .yaml または .yml で終わる)を持ち、ルートの外のファイルへ通じる各リンクで、リンク自体が置かれている場所をルートからの相対パスで示し、ワークスペースを検索する順序で並べます。そのようなファイルは読み込まれないため、これらのリンクのいずれかを通じてのみ到達する Release は releases に含まれず、Releases を提示するクライアントはその理由を示せます。ファイルが Release かどうかは読み込まなければわからないため、そのようなリンクはファイルの内容にかかわらずそれぞれ記載されます。次のものは記載されません。ワークスペース設定が build.authoring_release として、または workspace.releases のキーとして Release に指定しているファイルへのリンク(読み込まれ、リンク自身の場所で releases に記載されます)、ルート内のファイルへのリンク(読み込まれます)、検索が除外するディレクトリ内のリンク、および、どのファイルにも通じていないリンク(ディレクトリへ通じるもの。これはルートの外へ通じる場合に unreadLinkedDirs が記載します。またはどこにも通じていないもの、ループしているもの)です。ワークスペースの外へ通じるリンクであるワークスペース設定ファイル、すなわちワークスペース自身の .aggrega-config.yaml またはその隣にある CI 所有のオーバーレイは、検索がそれに出会ったかどうかにかかわらず、検索が記載したリンクの後に記載されます。この場合、ワークスペースの設定はまったく読み込まれず、この回答は何も設定されていない状態で読み込まれたものとなるため、設定がリンクを通じて指定する Release は記載されず、設定が決定するすべてのリクエストは、そのワークスペースについて読み込み保留の条件とともに拒否されます。ワークスペースにそのようなリンクがない場合は空です。 |
追加のプロパティは許可されません。
ActiveReleaseResult
クライアントがデフォルトで対象とすべき Release です。ワークスペースがどの Release も指していないのは失敗ではなく通常の状態であるため、エラーとして発生させるのではなく、選択がどのように試みられたかの説明とともにここで報告されます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
release | string | はい | 決定された Release です。決定されなかった場合は空です。 |
lockfile | string | いいえ | 決定された Release のロックファイルで、pull がその Release のために書き込み、ビルドが読み込むファイルです。Release が決定されなかった場合は存在しません。 |
reason | string | いいえ | Release が決定されなかった理由です。 |
trace | string | いいえ | 選択の各ステップとその結果です。呼び出し側は、どのステップで決定されたはずかを確認できます。 |
追加のプロパティは許可されません。
EditDocumentResult
編集が何をどこに書き込んだかです。書き込み後、デーモンが保持していたそのドキュメントの読み取り結果は破棄されるため、そのドキュメントに関する次の回答は編集が生成したバイト列から計算されます。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
file | string | はい | 編集されたドキュメントです。 |
edit | string | はい | 適用された編集です。 |
container | string[] or null | はい | ドキュメント内で編集が行われた場所までのパスです。 |
createdContainers | string[] or null | はい | 編集が途中で作成する必要があったコンテナです。 |
written | string[] or null | はい | 書き込まれたドキュメントです。 |
content | string | はい | 結果を書き込むのではなく表示するよう求めたリクエストに対する、組み立てられたドキュメントです。 |
追加のプロパティは許可されません。
EffectiveConfigurationResult
ワークスペースが解決した設定と、各設定がどのドキュメントから来たかです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
layers | string[] or null | はい | マージされた設定ドキュメントで、マージされた順序で並びます。 |
settings | EffectiveConfigurationSetting[] or null | はい | 解決された各設定とその出所です。 |
追加のプロパティは許可されません。
ConfigInitResult
設定の初期化が何をどこに書き込み、レジストリから何を読み込んだかです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
host | string | はい | 設定の初期化の対象となったレジストリです。 |
scope | ConfigWriteScope | はい | どの設定ドキュメントが書き込まれ、それがどこまで及ぶかです。リクエストは 1 つのワークスペースを指定するため、何も示さない応答はそのワークスペースについてのものと解釈されますが、マシン全体への書き込みではその解釈は誤りです。 |
trust | TrustFetchOutcome | はい | レジストリが公開する信頼ポリシーの読み取りがどうなったかを示します。各結果は意味が異なるため区別して保持されます。公開されたポリシーが採用された、レジストリが何も公開していなかった(これは失敗ではありません)、代わりに組み込みのベースラインが固定された、または読み取りが試みられなかった、のいずれかです。何も公開されていなかった場合は、レジストリにそもそも到達できたかどうかがその横に示されます。 |
written | 真偽値 | はい | ドキュメントが書き込まれたか、それとも呼び出し側が配置するために返されたかです。 |
existed | 真偽値 | いいえ | ドキュメントがすでに存在し、新しいドキュメントを作成するのではなくレジストリのエントリがそこにマージされた場合に、存在して true になります。既存のドキュメントに対して処理を進めるのは force を送信したリクエストだけであるため、送信しなかったリクエストへの回答には存在しません。 |
content | string | いいえ | 書き込むのではなく表示するよう求めたリクエストに対する、ドキュメントのテキストです。 |
追加のプロパティは許可されません。
ConfigCaptureResult
解決された設定の固定化が、このワークスペース自身のドキュメントに何を書き込んだかです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
configFile | string | はい | 書き込まれたドキュメントです。目的全体が 1 つのワークスペースを自己完結させることであるため、常にこのワークスペース自身のものです。 |
workspaceRoot | string | はい | リクエストが指定したワークスペースです。 |
captured | 真偽値 | はい | 何かが固定化されたかどうかです。 |
sockets | ConfigCapturedSocket[] or null | はい | 固定化された各ソケットとそのアタッチメントです。 |
catalogDirs | string[] or null | はい | 固定化されたカタログディレクトリです。 |
追加のプロパティは許可されません。
ImportResult
外部ソースの変換が何を生成し、何を変換できなかったかです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
format | string | はい | 変換されたソース形式です。 |
outputDir | string | はい | 回答内のすべてのパスの基準となるディレクトリで、ファイルが書き込まれたディレクトリでもあります。 |
written | string[] or null | はい | ディスクに書き込まれた各ファイルで、書き込まれた順序で並びます。ドラフト、次にインポートが書き込んだ内容の記録です。sync の場合は、sync が変更したドラフトと、変更があった場合の記録のみです。dryRun の場合は空です。 |
files | ImportedFile[] or null | はい | リクエストが書き込む各ファイルとそのテキストで、dryRun の有無にかかわらず含まれます。すべてのドラフト、次にインポートが書き込んだ内容の記録です。sync の場合は、sync が変更する各ドラフトとその新しいテキスト、次に記録も変更される場合はその記録です。そのため、同期済みの sync は空のリストを返します。 |
drift | ImportDrift[] | はい | sync がソースに合わせて更新した(dryRun の場合は更新するはずの)各部分で、ドラフトが記載する順序で並びます。sync が削除するドラフトファイルもその 1 つで、キーなしで削除されたものとして扱われます。sync ではないリクエスト、同期済みの sync、および変換が停止して何も書き込まない sync では空のリストです。 |
diagnostics | ImportDiagnostic[] or null | はい | 変換できなかった内容です。 |
decisions | ImportDecision[] | はい | インポーターが各ソースノードをどのようにマッピングしたかで、インポーターの順序で、報告されたとおりに並びます。変換がどこで推測したかを示すものです。どちらの出力方法でも、変換が停止したかどうかにかかわらず含まれ、何も報告しないインポーターでは空のリストです。 |
owed | ImportOwed[] | いいえ | 草稿がまだ空のまま残している値のうち、どのソースからも供給できず、どの回答からも供給されなかった各値を、草稿が書き出される順に示します — 警告の検出結果が挙げる値です。すべての応答がこれを含み、草稿に不足がない場合は空のリストになります。 |
halted | 真偽値 | はい | 変換が検出結果とともに完了したのではなく、停止したかどうかです。 |
追加のプロパティは許可されません。
ScaffoldEntityResult
ドラフトされたスターター用ドキュメント、実行可能な例の一覧、または書き込まれた例です。各形式はそれぞれ自身のフィールドで応答し、他のフィールドは含めません。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
kind | string | いいえ | ドラフトが作成されたエンティティ種別です。ドラフト時に含まれます。 |
skeleton | string | いいえ | ドラフトとして作成されたドキュメントのテキストです。ドラフト時に含まれます。 |
examples | ScaffoldExample[] | いいえ | ドキュメントが公開しているすべての実行可能な例で、それぞれ 1 回ずつ、名前順に並びます。1 つ以上見つかった一覧表示で含まれます。 |
example | string | いいえ | 書き込まれた例です。書き込み時に含まれます。 |
dir | string | いいえ | 例が書き込まれたディレクトリで、ワークスペースのルートからの相対パスです。リクエストが指定したとおりの名前、または指定がない場合は例の名前になります。書き込み時に含まれます。 |
files | string[] | いいえ | 書き込まれた各ファイルで、dir からの相対パスをスラッシュ区切りで表し、ドキュメントが持つ順序で並びます。書き込み時に含まれます。 |
next | string[] | いいえ | 例のページがその例のビルド用に示しているコマンドで、ページに書かれているとおり 1 行ずつ、コメントも含みます。つまり、その Build 見出しの下にある最初のシェルブロックです。ページが何も示していない場合は含まれません。 |
version | string | いいえ | 例の読み取り元となったドキュメントのバージョンです。バイナリ向けに公開されたものがあればバイナリ自身のバージョン、なければそれより前に公開された最新のバージョンです。書き込み時に含まれます。 |
追加のプロパティは許可されません。
ScaffoldExample
ドキュメントが公開している実行可能な例の 1 つです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
name | string | はい | 例の名前で、リクエストはその例を書き込むためにこれを example として送信します。 |
level | string | はい | 例のページがその例に対して宣言しているレベルです。 |
summary | string | はい | 例のページの最初の文です。 |
追加のプロパティは許可されません。
LintResult
慣例チェックで見つかった内容を、重大度別に集計し、ドキュメントごとに一覧にしたものです。Release ごとに 1 回ずつ実行されたカタログ全体のチェックは passes も持ち、その場合、件数と files はすべてのパスをまとめて対象とします。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
entity | string | いいえ | リクエストが 1 つのエンティティを指定した場合の、チェックされたそのエンティティです。 |
release | string | いいえ | リクエストが Release を指定した場合の、クロージャがチェックされた Release です。 |
checked | integer | はい | チェックされたドキュメントの数です。チェックが Release ごとに 1 回ずつ実行された場合は、パス全体の合計です。2 つのパスが読んだドキュメントは、それぞれで数えられます。 |
findings | integer | はい | 検出結果の総数です。 |
errors | integer | はい | そのうちエラーの数です。 |
warnings | integer | はい | そのうち警告の数です。 |
infos | integer | はい | そのうち情報の数です。 |
files | LintFileFindings[] or null | はい | ドキュメントごとの検出結果です。 |
halted | 真偽値 | はい | チェックが検出結果を伴って完了せずに停止したかどうかです。 |
passes | LintPass[] or null | いいえ | カタログ全体のチェックを 1 パスずつ示したものです。ワークスペースが workspace.releases の下で Releases を指定しているために、Release ごとに 1 回ずつ実行された場合にのみ存在します。各パスは、その検出結果がどの Releases について見つかったかを示します。何も指定していないワークスペース(自身のディレクトリに対して 1 回チェックされます)の場合と、1 つのエンティティまたは Release のクロージャのチェックの場合には存在しません。 |
追加のプロパティは許可されません。
LintPass
Releases に独自のカタログディレクトリを与えるワークスペースにおける、カタログ全体の慣例チェックの 1 パスです。実行対象の Releases、読み込んだディレクトリ、そこで見つかった内容を示します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
releases | string[] or null | はい | パスの実行対象となった Releases で、それぞれワークスペースルートからの相対パスです。同じカタログディレクトリを読む Releases は 1 つのパスを共有します。 |
catalogDirs | string[] or null | はい | パスが読んだカタログディレクトリで、検索される順に並びます。ワークスペースルート内にあるものはルートからの相対パスです。その Releases がカタログディレクトリを読まない場合は空で、パスは何もチェックせず、他のいずれも失敗させていません。 |
checked | integer | はい | パスがチェックしたドキュメントの数です。 |
findings | integer | はい | パスが見つけた検出結果の数です。 |
errors | integer | はい | そのうちエラーの数です。 |
warnings | integer | はい | そのうち警告の数です。 |
infos | integer | はい | そのうち情報の数です。 |
files | LintFileFindings[] or null | はい | パスの検出結果をドキュメントごとに示したものです。 |
追加のプロパティは許可されません。
PluginAddResult
プラグインのアタッチが何をどこに書き込み、どのバージョンを固定したかです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
type | string | はい | プラグインがアタッチされたソケットです。 |
identity | string | いいえ | アタッチメントが解決されたアイデンティティです。 |
uri | string | いいえ | アタッチメントの解決元となる参照です。 |
capability | string | いいえ | アタッチメントの対象となるケイパビリティです。 |
reference | string | いいえ | バージョンを含む、固定された参照です。 |
scope | PluginWriteScope | はい | プラグインの変更がどの設定ドキュメントに書き込まれ、それがどこまで及ぶかです。コマンド拡張ソケット自体のデフォルトはマシン全体のドキュメントであるため、すべての応答はどちらに書き込んだかを示します。 |
written | 真偽値 | はい | 設定ドキュメントが書き込まれたか、それとも呼び出し元が配置できるよう返されたかです。 |
content | string | いいえ | 書き込まずに表示するよう求めたリクエストに対する、設定ドキュメントのテキストです。 |
retraction | PluginRetraction | いいえ | 非推奨マーカーが、どのプラグインバージョンが固定されるかにどう影響したかです。 |
withdrawn | 真偽値 | いいえ | クエリが固定されたバージョンを指定し、かつこのワークスペースが信頼する撤回がそのバージョンを取り下げている場合に true です。指定されたバージョンは、指定すること自体が上書き指定であるため、そのまま固定されます。それ以外の場合は存在しませんが、存在しないことはそのバージョンが取り下げられていないことを意味しません。指定されたバージョンの取り下げマーカーを読み取れなかった場合は retraction.unscreened がその理由を示し、バージョンが指定されていない場合は最新の公開バージョンが選ばれ、その選択について取り下げチェックが下した結論を retraction が報告します。 |
追加のプロパティは許可されません。
PluginRemoveResult
プラグインのデタッチが何をどこに書き込んだかです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
type | string | はい | プラグインがアタッチされたソケットです。 |
query | string | はい | 削除されたアタッチメントです。 |
scope | PluginWriteScope | はい | プラグインの変更がどの設定ドキュメントに書き込まれ、それがどこまで及ぶかです。コマンド拡張ソケット自体のデフォルトはマシン全体のドキュメントであるため、すべての応答はどちらに書き込んだかを示します。 |
追加のプロパティは許可されません。
PluginSyncResult
Plugin エンティティの機械管理レコードをそのモジュールに合わせた結果、何が変わったかです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
entity | string | はい | 合わせられた Plugin エンティティドキュメントです。 |
hostFunctions | string[] or null | はい | モジュールが必要と宣言しているホスト関数です。 |
commands | PluginCLICommand[] or null | はい | モジュールが提供するコマンドです。 |
changed | 真偽値 | はい | ドキュメント内で実際に何かが変わったかどうかです。 |
追加のプロパティは許可されません。
PluginGenCatalogResult
生成によって作られたカタログドキュメントです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
documents | PluginGeneratedDocument[] | いいえ | 生成された各ドキュメントとそのテキストです。 |
notices | string | いいえ | 生成が呼び出し元に伝えたい事項です。 |
dryRun | 真偽値 | はい | ドキュメントが書き込まれずに返されたかどうかです。 |
追加のプロパティは許可されません。
ExplainErrorResult
ある条件についてコンパイラが宣言している内容と、作成時の修正方法を説明する公開済みの記述です。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
shortCode | string | はい | 条件の短いコードです。 |
code | string | はい | 条件の説明的な名前です。 |
message | string | はい | 条件が発生したときに表示する内容です。 |
entries | ExplainErrorEntry[] | いいえ | 修正方法を説明する公開済みの記述です。 |
reference | string | はい | 条件の説明が公開されているアドレスです。 |
note | string | いいえ | 公開済みの記述を取得できなかった場合の、それが欠けている理由です。バイナリ自体が宣言している内容は引き続き返されます。 |
追加のプロパティは許可されません。
GetSchemaResult
種類のスキーマ、またはリクエストが何も指定しなかった場合は指定可能な種類です。2 つの範囲は 2 つのメソッドではなく 1 つの応答で扱われます。「何を指定できるか」と「そのうち作成者がドキュメントを書くのはどれか」は 2 つの範囲における同じ質問であり、応答が 2 つあれば互いの整合性を保つ必要が生じるためです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
kind | string | いいえ | スキーマの対象となる種類です。 |
schema | any | いいえ | バイナリが保持しているとおりに渡されるスキーマそのものです。 |
kinds | string[] | いいえ | このバイナリが応答するすべてのトークンです。 |
entityKinds | EntityKindDescriptor[] | いいえ | 作成者がドキュメントを書く、より狭い集合です。それぞれ、リクエストが指定するトークンと、ドキュメント自身のヘッダーが宣言する種類を対にしています。 |
追加のプロパティは許可されません。
SkillsInstallResult
アシスタント用スキルのインストールが何をどこに書き込んだかです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
skill | string | はい | 書き込まれたスキルです。 |
installed | SkillsInstalledFolder[] | はい | 書き込まれた各スキルフォルダで、リクエストがアシスタントを指定した順に並びます。1 つの共有フォルダを読み取るアシスタントは 1 つのエントリを共有します。スキルはそこに 1 回だけ書き込まれるためです。 |
scope | SkillFolderScope | はい | スキルのインストールが及ぶ範囲です。リクエストは 1 つのワークスペースを指定するため、何も述べない応答はそのワークスペースについてのものと解釈されます。しかし、アシスタントがすべてのプロジェクトで読み取るユーザーごとのフォルダの場合、その解釈は誤りです。 |
追加のプロパティは許可されません。
SkillsInstalledFolder
インストールが書き込んだ 1 つのスキルフォルダです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
agents | string[] | はい | このフォルダを読み取る、指定されたアシスタントの識別子で、リクエストが指定した順に並びます。 |
folder | string | はい | スキルのフォルダで、絶対パスで示します。 |
replaced | 真偽値 | はい | 書き込まれたスキルのすべてのコピーが持つコメント行を含むコピー(以前のインストールが書き込んだもの、または公開されたスキルリポジトリから取得したもの)がそこにあり、置き換えられたかどうかです。その行を含まないファイルがそこにある場合は、置き換えられずに拒否されます。 |
追加のプロパティは許可されません。
SkillsListResult
バイナリに同梱されたスキルと、インストールがそれらを書き込めるすべてのアシスタントです。何も書き込まず、どこにもアクセスしません。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
skills | SkillsListedSkill[] | はい | バイナリに同梱された各スキルで、固定の順序で並びます。 |
agents | SkillsListedAgent[] | はい | インストールがスキルフォルダを把握している各アシスタントで、識別子順に並びます。 |
追加のプロパティは許可されません。
SkillsListedSkill
バイナリに同梱された 1 つのスキルです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
name | string | はい | スキルの名前で、インストールが書き込むフォルダの名前でもあります。 |
description | string | はい | アシスタントがスキルを使う場面で、スキル自身が宣言するものです。 |
追加のプロパティは許可されません。
SkillsListedAgent
インストールがスキルを書き込める 1 つのアシスタントと、それがスキルを読み取る 2 つのフォルダです。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
id | string | はい | リクエストがアシスタントを指定するための識別子です。 |
name | string | はい | アシスタント自身の名前です。 |
projectFolder | string | はい | アシスタントがプロジェクトのスキルを読み取るフォルダで、プロジェクトのルートからの相対パスをスラッシュ区切りで示します。プロジェクトへのインストールは、リクエストが指定したワークスペース内で、この中にスキルのフォルダを書き込みます。 |
userFolder | string | はい | アシスタントがすべてのプロジェクトでユーザー自身のスキルを読み取るフォルダで、ホームディレクトリからの相対パスをスラッシュ区切りで示します。global を指定したインストールは、この中にスキルのフォルダを書き込みます。 |
追加のプロパティは許可されません。