Схема протокола обмена фонового демона Aggrega
Сгенерированный справочник. Не редактируйте вручную — сгенерируйте заново из опубликованной JSON Schema.
Идентификатор схемы: https://aggrega.ai/schemas/serve-wire-v1beta1.schema.json
Формы сообщений, которыми обмениваются с фоновым демоном компилятора, запущенным командой aggrega serve. Клиент открывает сеанс поверх этого демона с помощью рукопожатия, и именно сеанс задаёт область действия настроек и рабочего пространства, для которых был открыт диалог; демон — это процесс, который отвечает на запрос, отправляет уведомление и хранит прочитанное. Протокол — JSON-RPC 2.0 поверх стандартного ввода и вывода, каждое сообщение обрамляется заголовком Content-Length; этот документ описывает тела сообщений, но не обрамление и не транспорт. Тело сообщения — одно из четырёх: запрос, отправляемый клиентом, уведомление, отправляемое клиентом, уведомление, отправляемое демоном, или ответ, который демон возвращает на запрос. Три свойства этого интерфейса определяют, как записаны приведённые ниже формы. Во-первых, каждый запрос допускает два поля сверх объявленных его собственным методом — workspaceRoot, указывающее рабочее пространство, с которым работает запрос, и workDoneToken, создаваемое вызывающей стороной значение, под которым сообщается о ходе выполнения, — поэтому оба присутствуют здесь в каждом объекте params запроса, включая три метода, предметом которых не является рабочее пространство: aggrega/getSchema и aggrega/scaffoldEntity принимают workspaceRoot, но игнорируют его, а aggrega/initialize читает его как рабочее пространство, которое объявляет сеанс. Во-вторых, демон отклоняет объект params запроса, содержащий поле, которое метод не принимает, и называет то, что он принимает, поэтому каждый объект params здесь закрыт на верхнем уровне; вложенный объект внутри запроса не закрыт, поскольку проверка читает только имена полей самого внешнего уровня. В-третьих, результат составляется демоном, а не предоставляется вызывающей стороной, поэтому объекты результатов закрыты на каждом уровне с фиксированной формой и открыты только там, где значение — непрозрачный JSON, который демон передаёт, не читая. Одно следствие кодирования демона видно в протоколе и описано, а не скрыто: коллекция, которую демон не помечает как необязательную, выдаётся как null, когда у неё нет значения для сообщения, и как пустая коллекция, когда сообщаемое значение пусто, поэтому везде, где это применимо, допускаются обе формы.
Одна из следующих форм
RequestClientNotificationDaemonNotificationSuccessResponseErrorResponse
Определения
ProtocolVersion
Версия JSON-RPC, которую несёт каждое сообщение. Поддерживается только 2.0.
Тип: const "2.0"
Константа: "2.0"
RequestId
Идентификатор запроса, заданный вызывающей стороной и возвращаемый в ответе на этот запрос. Сообщение без идентификатора является уведомлением, и ответ на него никогда не отправляется.
Тип: string or number
ProgressToken
Значение, которое создаёт вызывающая сторона, чтобы сопоставлять уведомления о ходе выполнения с вызовом, который их запросил. Оно возвращается в каждом уведомлении без изменений, поэтому вызывающая сторона может сравнить его с отправленным значением. Оно принимается в любом запросе, а запрос, отправивший его в сеансе, где не была объявлена возможность получать уведомления о ходе выполнения, отклоняется.
Тип: string or number
WorkspaceRootSubject
Абсолютный путь к рабочему пространству, над которым выполняется запрос. Это субъект запроса: демон разрешает его до выполнения метода, а запрос, в котором он опущен или записан не как строка, отклоняется.
Тип: string
WorkspaceRootAccepted
Абсолютный путь к рабочему пространству. Субъект этого метода — не рабочее пространство: он отвечает на основе того, что содержит сам исполняемый файл, поэтому поле принимается, но не читается. Оно допускается, чтобы клиент мог единообразно отправлять его в каждом запросе, не зная, какие методы его используют.
Тип: string
RequestMethod
Все методы, которые может указывать запрос. Набор закрыт: на запрос с любым другим методом возвращается ошибка «метод не найден».
Тип: string (enum)
Допустимые значения: "aggrega/activeRelease", "aggrega/attachCandidates", "aggrega/attachmentContainer", "aggrega/build", "aggrega/buildPreview", "aggrega/cacheClear", "aggrega/cacheEvict", "aggrega/cachePrune", "aggrega/cacheStatus", "aggrega/catalogIndex", "aggrega/completion", "aggrega/configCapture", "aggrega/configInit", "aggrega/connectionAtPosition", "aggrega/connectionCandidates", "aggrega/deprecateArtifact", "aggrega/diagnostics", "aggrega/editDocument", "aggrega/effectiveConfiguration", "aggrega/entityDefinition", "aggrega/explainError", "aggrega/findImplementations", "aggrega/findReferences", "aggrega/getSchema", "aggrega/hover", "aggrega/import", "aggrega/initialize", "aggrega/insertionPoint", "aggrega/invalidate", "aggrega/irGraph", "aggrega/lint", "aggrega/logout", "aggrega/pin", "aggrega/pluginAdd", "aggrega/pluginGenCatalog", "aggrega/pluginRemove", "aggrega/pluginSync", "aggrega/publishArtifact", "aggrega/publishEntity", "aggrega/registryAdd", "aggrega/registryList", "aggrega/registryRemove", "aggrega/registryUpdate", "aggrega/releaseCandidates", "aggrega/releaseClosure", "aggrega/resolve", "aggrega/resolveDependencies", "aggrega/scaffoldEntity", "aggrega/search", "aggrega/setActiveRelease", "aggrega/signArtifacts", "aggrega/skillsInstall", "aggrega/skillsList", "aggrega/validate"
ClientNotificationMethod
Все методы, которые может указывать уведомление клиента. Набор закрыт, и ни на одно из уведомлений ответ не отправляется.
Тип: string (enum)
Допустимые значения: "$/cancelRequest", "aggrega/shutdown"
DaemonNotificationMethod
Все методы, которые может указывать уведомление, отправляемое демоном. Набор закрыт.
Тип: string (enum)
Допустимые значения: "$/progress", "aggrega/publishDiagnostics"
Request
Запрос, который отправляет клиент и на который отвечает демон. Метод указывает, что запрашивается; объект params содержит собственные поля этого метода и два поля, допускаемые любым методом. Запрос, в котором params полностью опущен, читается как запрос, все поля которого отсутствуют.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
jsonrpc | ProtocolVersion | да | Версия JSON-RPC, которую несёт каждое сообщение. Поддерживается только 2.0. |
id | RequestId | да | Идентификатор запроса, заданный вызывающей стороной и возвращаемый в ответе на этот запрос. Сообщение без идентификатора является уведомлением, и ответ на него никогда не отправляется. |
method | RequestMethod | да | Все методы, которые может указывать запрос. Набор закрыт: на запрос с любым другим методом возвращается ошибка «метод не найден». |
params | object | нет |
Дополнительные свойства не допускаются.
params для каждого method:
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 | нет |
Дополнительные свойства не допускаются.
params для каждого method:
method | params | Обязательно |
|---|---|---|
"$/cancelRequest" | CancelRequestParams | да |
"aggrega/shutdown" | ShutdownParams | нет |
DaemonNotification
Уведомление, отправляемое демоном. Оно не содержит идентификатора, и ответ на него никогда не отправляется.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
jsonrpc | ProtocolVersion | да | Версия JSON-RPC, которую несёт каждое сообщение. Поддерживается только 2.0. |
method | DaemonNotificationMethod | да | Все методы, которые может указывать уведомление, отправляемое демоном. Набор закрыт. |
params | object | да |
Дополнительные свойства не допускаются.
params для каждого method:
method | params | Обязательно |
|---|---|---|
"$/progress" | ProgressParams | да |
"aggrega/publishDiagnostics" | PublishDiagnosticsParams | да |
CancelRequestParams
Просит демон прервать уже выполняющийся запрос, указывая его по идентификатору, который нёс этот запрос. Если запрос уже завершён или никогда не отправлялся, отменять нечего, и это происходит без сообщений.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
id | RequestId | да | Идентификатор запроса, заданный вызывающей стороной и возвращаемый в ответе на этот запрос. Сообщение без идентификатора является уведомлением, и ответ на него никогда не отправляется. |
Дополнительные свойства не допускаются.
ShutdownParams
Просит демон прекратить приём работы и завершить уже принятую. Уведомление не содержит полей и обычно отправляется вовсе без объекта params. Повторное уведомление прерывает ещё выполняющуюся работу, не дожидаясь её завершения.
Этот объект не объявляет фиксированных свойств и не допускает никаких.
ProgressParams
Одно сообщение о ходе выполнения работы; отправляется только для запроса, создавшего токен хода выполнения, в сеансе, где объявлено, что такие сообщения могут приниматься.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
token | ProgressToken | да | Значение, которое создаёт вызывающая сторона, чтобы сопоставлять уведомления о ходе выполнения с вызовом, который их запросил. Оно возвращается в каждом уведомлении без изменений, поэтому вызывающая сторона может сравнить его с отправленным значением. Оно принимается в любом запросе, а запрос, отправивший его в сеансе, где не была объявлена возможность получать уведомления о ходе выполнения, отклоняется. |
value | ProgressBegin или ProgressReport или ProgressEnd | да | Само сообщение. Одно открывающее сообщение, затем любое число строк, затем одно закрывающее сообщение. |
Дополнительные свойства не допускаются.
ProgressBegin
Открывает отчёт и сообщает, что началось, в терминах самой операции.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
kind | const “begin” | да | Помечает эти данные как начало отчёта. Константа: "begin" |
title | string | да | Что началось. |
Дополнительные свойства не допускаются.
ProgressReport
Одна строка собственного отчёта операции о себе. Доля выполнения не передаётся: операции, которые сообщают здесь о ходе работы, обрабатывают набор, размер которого неизвестен в момент начала, поэтому долю пришлось бы выдумывать.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
kind | const “report” | да | Помечает эти данные как одну строку открытого отчёта. Константа: "report" |
message | string | да | Одна строка собственного вывода операции без начальных и конечных пробельных символов. |
Дополнительные свойства не допускаются.
ProgressEnd
Закрывает отчёт. Не содержит ничего, кроме вида, поскольку результат передаётся в ответе, которого вызывающая сторона уже ожидает.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
kind | const “end” | да | Помечает эти данные как закрытие отчёта. Константа: "end" |
Дополнительные свойства не допускаются.
PublishDiagnosticsParams
Результаты проверки для одного файла, которые демон отправляет сам, когда проверка выдала их для документа, отличного от указанного в запросе.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
file | string | да | Файл, к которому относятся результаты. |
diagnostics | Diagnostic[] или null | да | Результаты в порядке их получения. |
Дополнительные свойства не допускаются.
SuccessResponse
Ответ на успешно выполненный запрос, содержащий идентификатор запроса, на который он отвечает. Ответ не содержит метода, поэтому применимая форма результата определяется запросом, которому принадлежит идентификатор, а не чем-либо в самом ответе.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
jsonrpc | ProtocolVersion | да | Версия JSON-RPC, которую несёт каждое сообщение. Поддерживается только 2.0. |
id | RequestId | да | Идентификатор запроса, заданный вызывающей стороной и возвращаемый в ответе на этот запрос. Сообщение без идентификатора является уведомлением, и ответ на него никогда не отправляется. |
result | InitializeResult или ValidateResult или InvalidateResult или DiagnosticsResult или IrGraphResult или BuildResult или BuildPreviewResult или EntityDefinitionResult или ReleaseClosureResult или ResolveDependenciesResult или PinResult или CacheStatusResult или CachePruneResult или CacheEvictResult или CacheClearResult или RegistryListResult или SearchResult или RegistryAddResult или RegistryRemoveResult или RegistryUpdateResult или LogoutResult или PublishEntityResult или PublishArtifactResult или SignArtifactsResult или DeprecateArtifactResult или ResolveResult или FindReferencesResult или FindImplementationsResult или HoverResult или CompletionResult или CatalogIndexResult или AttachCandidatesResult или ConnectionCandidatesResult или InsertionPointResult или AttachmentContainerResult или ConnectionAtPositionResult или ReleaseCandidatesResult или ActiveReleaseResult или EditDocumentResult или EffectiveConfigurationResult или ConfigInitResult или ConfigCaptureResult или ImportResult или ScaffoldEntityResult или LintResult или PluginAddResult или PluginRemoveResult или PluginSyncResult или PluginGenCatalogResult или ExplainErrorResult или GetSchemaResult или SkillsInstallResult или SkillsListResult | да | Ответ в той форме, которую возвращает запрошенный метод. |
Дополнительные свойства не допускаются.
ErrorResponse
Ответ на запрос, который был отклонён или завершился сбоем; содержит идентификатор запроса, на который отвечает.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
jsonrpc | ProtocolVersion | да | Версия JSON-RPC, которую несёт каждое сообщение. Поддерживается только 2.0. |
id | RequestId | да | Идентификатор запроса, заданный вызывающей стороной и возвращаемый в ответе на этот запрос. Сообщение без идентификатора является уведомлением, и ответ на него никогда не отправляется. |
error | ErrorObject | да | Что пошло не так: код, по которому клиент может ветвиться, сообщение, написанное для чтения человеком, и — если у условия они есть — артефакты и позиция в исходнике, на которые ссылается сообщение. |
Дополнительные свойства не допускаются.
ErrorObject
Что пошло не так: код, по которому клиент может ветвиться, сообщение, написанное для чтения человеком, и — если у условия они есть — артефакты и позиция в исходнике, на которые ссылается сообщение.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
code | ErrorCode | да | Условие, о котором сообщает ответ. Отрицательные коды — собственный зарезервированный набор протокола; четырёхзначные коды — условия, которые выдаёт этот демон, и каждый называет состояние, на которое клиент может отреагировать. Набор закрыт. |
message | string | да | Что пошло не так, в виде текста. Это та же формулировка, с которой то же условие выводится во всех остальных местах, где о нём сообщается. |
data | ErrorData | нет | Артефакты и позиция в исходнике, на которые ссылается сообщение, переданные в структурированном виде, чтобы клиенту не приходилось извлекать их из текста. Каждое поле необязательно, и условие заполняет только то, что у него есть; ни одно поле не заменяет другое, поэтому клиент узнаёт, что он получил, из прочитанного поля, а не из кода рядом с ним. |
Дополнительные свойства не допускаются.
ErrorCode
Условие, о котором сообщает ответ. Отрицательные коды — собственный зарезервированный набор протокола; четырёхзначные коды — условия, которые выдаёт этот демон, и каждый называет состояние, на которое клиент может отреагировать. Набор закрыт.
Тип: const -32700 or const -32600 or const -32601 or const -32602 or const -32603 or const 1001 or const 1003 or const 1004 or const 1005 or const 1006
Допустимые значения:
-32700— Сообщение не удалось разобрать как JSON.-32600— Сообщение разобрано, но не является корректно сформированным запросом.-32601— Метода с таким именем не существует.-32602— Параметры запроса недопустимы: поле, которое метод не принимает, поле неверного типа или значение, которое метод отклоняет.-32603— Демон завершился с ошибкой при выполнении работы.1001— У демона нет прочитанного представления файла, и он его не создаёт. Клиент инициирует его, запросив проверку, а затем повторяет попытку.1003— Lock-файл для Release, указанного в запросе, отсутствует, а операции он нужен.1004— Сущность, указанную в запросе, не удалось разрешить ни из каталога, ни из Release, указанного в запросе.1005— Демон завершает работу и отклоняет новые задания. Клиент не повторяет попытку с тем же демоном.1006— Проверка файла сейчас выполняется и не завершилась в пределах времени, отведённого ожидающим запросом. Клиент ждёт и запрашивает снова, ничего не отправляя в промежутке.
ErrorData
Артефакты и позиция в исходнике, на которые ссылается сообщение, переданные в структурированном виде, чтобы клиенту не приходилось извлекать их из текста. Каждое поле необязательно, и условие заполняет только то, что у него есть; ни одно поле не заменяет другое, поэтому клиент узнаёт, что он получил, из прочитанного поля, а не из кода рядом с ним.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
file | string | нет | Исходный документ, в котором поля позиции указывают место, — проверяемый документ или Release, загрузка которого не удалась. |
line | integer | нет | Строка, к которой относится условие, с отсчётом от единицы. |
column | integer | нет | Столбец, к которому относится условие, с отсчётом от единицы. |
end_line | integer | нет | Строка сразу за концом токена, к которому относится условие. Отсутствует, если конец токена невозможно восстановить; в этом случае клиент отображает позицию как точку. |
end_column | integer | нет | Столбец сразу за концом токена, к которому относится условие. |
release | string | нет | Release, к которому относится условие, записанный так, как его назвал запрос, чтобы клиент мог составить способ исправления, не собирая его заново. |
lockfile | string | нет | Lock-файл, к которому относится условие уровня lock-файла: путь, который искали и не нашли или не смогли прочитать. |
unreachable | логическая | нет | Является ли отказ недоступностью реестра, указанного в запросе: его имя не разрешилось, соединение с ним было отклонено или не могло быть открыто либо не удалось установить с ним защищённое соединение. Значение определяется по самому сбою, а не по сообщению, и задаётся только там, где сбой показывает, что до реестра так и не удалось достучаться. Отклонённое обновление индекса, указывающее один реестр, содержит его; реестр, который ответил, что бы он ни ответил, оставляет его отсутствующим. |
code | string | нет | Описательное имя условия, которое называет отказ, стабильное между выпусками: то же значение, которое диагностика, сообщающая об этом условии, несёт в собственном коде. Именно по нему клиент ветвится, а не по сообщению или числовому коду рядом, который называет состояние запроса и остаётся одинаковым для любого условия. Присутствует ровно тогда, когда отказ называет зарегистрированное условие, и отсутствует, когда не называет никакого. |
shortCode | string | нет | Короткий код условия — буква E и четыре цифры: форма, которую читатель цитирует и ищет, и та, с которой начинается сообщение отказа, называющего условие. Присутствует ровно тогда, когда присутствует code. |
Дополнительные свойства не допускаются.
Diagnostic
Одна находка об одном документе: где она, насколько она серьёзна, что она сообщает и цитируемый код, называющий условие, о котором она сообщает.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
line | integer | да | Строка, к которой относится находка, с отсчётом от единицы. |
column | integer | да | Столбец, к которому относится находка, с отсчётом от единицы. |
severity | const “error” или const “warning” или 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 | нет | Строка сразу за концом токена, к которому относится находка, чтобы клиент мог отобразить весь токен, а не один символ. Отсутствует для токена, занимающего несколько строк. |
end_column | integer | нет | Столбец сразу за концом токена, к которому относится находка. |
Дополнительные свойства не допускаются.
CodeDescription
Где объясняется условие, которое называет находка.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
href | string | да | Опубликованный адрес, по которому объясняется условие. |
Дополнительные свойства не допускаются.
Position
Место в документе: строка и смещение символа в ней, оба с отсчётом от нуля. Смещение измеряется в единицах кодировки, согласованной сеансом при открытии, — это UTF-16, если клиент не запросил другую.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
line | integer | да | Строка с отсчётом от нуля. |
character | integer | да | Смещение внутри строки с отсчётом от нуля, в единицах кодировки, согласованной сеансом. |
Дополнительные свойства не допускаются.
Range
Диапазон между двумя местами в документе.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
start | Position | да | Место в документе: строка и смещение символа в ней, оба с отсчётом от нуля. Смещение измеряется в единицах кодировки, согласованной сеансом при открытии, — это UTF-16, если клиент не запросил другую. |
end | Position | да | Место в документе: строка и смещение символа в ней, оба с отсчётом от нуля. Смещение измеряется в единицах кодировки, согласованной сеансом при открытии, — это UTF-16, если клиент не запросил другую. |
Дополнительные свойства не допускаются.
Location
Диапазон в указанном документе.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
uri | string | да | Документ, в котором находится диапазон, заданный как URI. |
range | Range | да | Диапазон между двумя местами в документе. |
Дополнительные свойства не допускаются.
WorkspaceAndProgressParams
Объект params метода, который не объявляет собственных полей. Он всё равно допускает два поля, которые допускает любой запрос: рабочее пространство, с которым работает запрос, и токен прогресса.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
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
Проверяет рабочее пространство или один документ в нём и возвращает найденные замечания.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
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. Если это запрошено, выполняется обращение к настроенным реестрам и записывается lock-файл; если нет, сборка не обращается ни к одному реестру. |
policyInput | string | нет | Каталог, в который рядом с артефактами записываются полезные данные, которые каждая роль управления передаёт прикреплённому к ней плагину, в виде пути относительно корня рабочего пространства — файлы, которые записывает aggrega build --policy-input, с теми же именами, записываемые независимо от того, завершилась сборка или остановилась. Уведомления ответа сообщают, сколько файлов записано, и называют каждую роль, для которой файл не записан. Если запрос завершается неудачей, записанные файлы остаются на диске, а этот отчёт в ответ не входит: ошибка несёт только отказ. Если поле отсутствует, ничего не записывается. Абсолютный путь или путь, выходящий за пределы рабочего пространства, отклоняется. |
Дополнительные свойства не допускаются.
BuildPreviewParams
Компилирует Release и сообщает, что дала бы запись артефактов, не записывая ни одного из них. Поле разрешения зависимостей, которое принимает записывающая сборка, отклоняется, потому что запрос, который ничего не записывает, не может заполнить lock-файл.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | да | Абсолютный путь к рабочему пространству, над которым выполняется запрос. Это субъект запроса: демон разрешает его до выполнения метода, а запрос, в котором он опущен или записан не как строка, отклоняется. |
workDoneToken | ProgressToken | нет | Значение, которое создаёт вызывающая сторона, чтобы сопоставлять уведомления о ходе выполнения с вызовом, который их запросил. Оно возвращается в каждом уведомлении без изменений, поэтому вызывающая сторона может сравнить его с отправленным значением. Оно принимается в любом запросе, а запрос, отправивший его в сеансе, где не была объявлена возможность получать уведомления о ходе выполнения, отклоняется. |
release | string | нет | Release для компиляции в виде пути относительно корня рабочего пространства. |
autoPull | логическая | нет | Принимается протоколом и отклоняется методом: этот запрос ничего не записывает, поэтому не может заполнить lock-файл и при этом оставаться тем, чем он себя объявляет. |
policyInput | string | нет | Каталог, в который записываются полезные данные, которые каждая роль управления передаёт прикреплённому к ней плагину, в виде пути относительно корня рабочего пространства — файлы, которые записывает aggrega build --dry-run --policy-input, с теми же именами. Если поле передано, эти файлы — единственное, что записывает этот запрос; выходной каталог и lock-файл остаются нетронутыми. Уведомления ответа сообщают, сколько файлов записано, и называют каждую роль, для которой файл не записан. Если запрос завершается неудачей, записанные файлы остаются на диске, а этот отчёт в ответ не входит: ошибка несёт только отказ. Абсолютный путь или путь, выходящий за пределы рабочего пространства, отклоняется. |
Дополнительные свойства не допускаются.
EntityDefinitionParams
Возвращает, во что разрешается одно имя сущности и где находится определяющий её документ.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | да | Абсолютный путь к рабочему пространству, над которым выполняется запрос. Это субъект запроса: демон разрешает его до выполнения метода, а запрос, в котором он опущен или записан не как строка, отклоняется. |
workDoneToken | ProgressToken | нет | Значение, которое создаёт вызывающая сторона, чтобы сопоставлять уведомления о ходе выполнения с вызовом, который их запросил. Оно возвращается в каждом уведомлении без изменений, поэтому вызывающая сторона может сравнить его с отправленным значением. Оно принимается в любом запросе, а запрос, отправивший его в сеансе, где не была объявлена возможность получать уведомления о ходе выполнения, отклоняется. |
name | string | нет | Сущность для разрешения, по имени — или ссылка на реестр, oci://<host>/<repository>:<tag> либо @<digest> вместо :<tag>, чтобы прочитать сущность, опубликованную по этой координате. |
release | string | нет | Release, в контексте которого разрешается имя, в виде пути относительно корня рабочего пространства. В этом случае имя разрешается через каталоги, которые конфигурация рабочего пространства назначает этому Release, поэтому имя, объявленное в одном рабочем пространстве несколькими вариантами, по одному на Release, разрешается в вариант, с которым собирается этот Release, а неразрешённое имя отклоняется с пояснением, указывающим запись этого Release в workspace.releases. Если поле отсутствует, имя разрешается по собственным каталогам рабочего пространства. Ссылка на реестр не принимает Release и с ним отклоняется, как и значение, не указывающее ни на один файл Release. |
Дополнительные свойства не допускаются.
CatalogIndexParams
Возвращает сущности, которые содержит рабочее пространство: все сущности, объявленные в его документах, и сущности Features, объявленные в его каталогах.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | да | Абсолютный путь к рабочему пространству, над которым выполняется запрос. Это субъект запроса: демон разрешает его до выполнения метода, а запрос, в котором он опущен или записан не как строка, отклоняется. |
workDoneToken | ProgressToken | нет | Значение, которое создаёт вызывающая сторона, чтобы сопоставлять уведомления о ходе выполнения с вызовом, который их запросил. Оно возвращается в каждом уведомлении без изменений, поэтому вызывающая сторона может сравнить его с отправленным значением. Оно принимается в любом запросе, а запрос, отправивший его в сеансе, где не была объявлена возможность получать уведомления о ходе выполнения, отклоняется. |
release | string | нет | Release, в контексте которого перечисляются сущности, в виде пути относительно корня рабочего пространства. В этом случае Features — это те, что объявлены в каталогах, которые конфигурация рабочего пространства назначает этому Release, а документ в каталоге, который читают только другие Releases, пропускается, поэтому рабочее пространство, хранящее варианты одной сущности рядом, по одному на Release, перечисляется с вариантом, с которым собирается этот Release. Если поле отсутствует, перечисляется собственное содержимое рабочего пространства. Значение, не указывающее ни на один файл Release, отклоняется. |
Дополнительные свойства не допускаются.
ReleaseClosureParams
Возвращает всё, от чего зависит Release, в том виде, в каком это достигнуто при разрешении.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | да | Абсолютный путь к рабочему пространству, над которым выполняется запрос. Это субъект запроса: демон разрешает его до выполнения метода, а запрос, в котором он опущен или записан не как строка, отклоняется. |
workDoneToken | ProgressToken | нет | Значение, которое создаёт вызывающая сторона, чтобы сопоставлять уведомления о ходе выполнения с вызовом, который их запросил. Оно возвращается в каждом уведомлении без изменений, поэтому вызывающая сторона может сравнить его с отправленным значением. Оно принимается в любом запросе, а запрос, отправивший его в сеансе, где не была объявлена возможность получать уведомления о ходе выполнения, отклоняется. |
release | string | нет | Release для проверки в виде пути относительно корня рабочего пространства. |
Дополнительные свойства не допускаются.
ResolveDependenciesParams
Разрешает зависимости Release, закрепляя их в lock-файле и получая внешние входные данные, которые потребляет его рендеринг. Обращается к настроенным реестрам и выполняет запись.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | да | Абсолютный путь к рабочему пространству, над которым выполняется запрос. Это субъект запроса: демон разрешает его до выполнения метода, а запрос, в котором он опущен или записан не как строка, отклоняется. |
workDoneToken | ProgressToken | нет | Значение, которое создаёт вызывающая сторона, чтобы сопоставлять уведомления о ходе выполнения с вызовом, который их запросил. Оно возвращается в каждом уведомлении без изменений, поэтому вызывающая сторона может сравнить его с отправленным значением. Оно принимается в любом запросе, а запрос, отправивший его в сеансе, где не была объявлена возможность получать уведомления о ходе выполнения, отклоняется. |
release | string | нет | Release для разрешения в виде пути относительно корня рабочего пространства. |
upgrade | логическая | нет | Следует ли заново разрешить зависимости в пределах объявленных диапазонов, а не соблюдать то, что уже закреплено в lock-файле. |
targets | string[] | нет | Ссылки для повторного разрешения; остальные остаются закреплёнными как есть. Пустой список разрешает всё. |
verify | логическая | нет | Следует ли сравнить записанный lock-файл с разрешением, которое этот запрос выполнил бы без него, соблюдая те же закрепления, вместо того чтобы записывать его. Проверка не записывает ни lock-файл, ни запись доверия плагинам, ни entity.lock; кэш содержимого читается и заполняется так же, как при таком разрешении. Расхождение, а также отсутствие lock-файла, приводят к ошибке запроса. Нельзя сочетать с upgrade, targets или pinSources, каким бы ни было значение pinSources: запрос, передающий одно из них вместе с этим полем, отклоняется как запрос с недопустимыми параметрами до какого-либо разрешения. |
pinSources | логическая | нет | Следует ли выполнить шаг закрепления, который выполняет aggrega/pin, для сущностей Recipes и FeatureRecipes, которые Release собирает из каталогов рабочего пространства, записывая entity.lock рядом с каждой, вместо того чтобы отклонять запрос из-за сущности, в lock которой не записано закрепление, нужное входным данным. Если поле отсутствует, действует параметр рабочего пространства pin_sources_at_pull; любое значение переопределяет этот параметр для данного запроса. |
Дополнительные свойства не допускаются.
PinParams
Записывает в entity.lock рядом с сущностью Recipe или FeatureRecipe закрепление содержимого для каждого входа, который сущность читает извне собственного документа. Сущность Release не указывается: вход, идентичность которого сущность записывает полностью, обозначает один артефакт для каждой сущности Release, использующей эту сущность, поэтому для его закрепления не требуется ничего, что предоставляет Release. Запрос обращается к хостам, которые называют источники сущности, и выполняет запись рядом с сущностью; сам документ сущности никогда не записывается.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | да | Абсолютный путь к рабочему пространству, над которым выполняется запрос. Это субъект запроса: демон разрешает его до выполнения метода, а запрос, в котором он опущен или записан не как строка, отклоняется. |
workDoneToken | ProgressToken | нет | Значение, которое создаёт вызывающая сторона, чтобы сопоставлять уведомления о ходе выполнения с вызовом, который их запросил. Оно возвращается в каждом уведомлении без изменений, поэтому вызывающая сторона может сравнить его с отправленным значением. Оно принимается в любом запросе, а запрос, отправивший его в сеансе, где не была объявлена возможность получать уведомления о ходе выполнения, отклоняется. |
entity | string | нет | Документ сущности для закрепления в виде пути относительно корня рабочего пространства. |
dryRun | логическая | нет | Вернуть ли в ответе lock-файл, который записал бы этот шаг, вместо его записи. Входы всё равно разрешаются, поэтому кеш содержимого всё равно заполняется. |
Дополнительные свойства не допускаются.
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 | нет | Единственный хост реестра для поиска. При отсутствии поиск выполняется по всем настроенным хостам. |
limit | integer | нет | Максимальное число записей в ответе. |
includeRetracted | логическая | нет | Оставлять ли версии, объявленные устаревшими опубликованным маркером. |
Дополнительные свойства не допускаются.
RegistryAddParams
Регистрирует реестр и политику доверия, которую разрешение применяет к тому, что он предоставляет. Записывает общемашинный файл конфигурации, если запрос не требует иного, поэтому каждое рабочее пространство на машине выполняет разрешение через эту запись.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | да | Абсолютный путь к рабочему пространству, над которым выполняется запрос. Это субъект запроса: демон разрешает его до выполнения метода, а запрос, в котором он опущен или записан не как строка, отклоняется. |
workDoneToken | ProgressToken | нет | Значение, которое создаёт вызывающая сторона, чтобы сопоставлять уведомления о ходе выполнения с вызовом, который их запросил. Оно возвращается в каждом уведомлении без изменений, поэтому вызывающая сторона может сравнить его с отправленным значением. Оно принимается в любом запросе, а запрос, отправивший его в сеансе, где не была объявлена возможность получать уведомления о ходе выполнения, отклоняется. |
host | string | нет | Хост реестра для регистрации. |
name | string | нет | Удобный псевдоним, который разрешается в хост. |
identities | string[] | нет | Идентичности подписи, которым доверяют для того, что предоставляет этот реестр. |
keyPath | string | нет | Путь к открытому ключу, которому следует доверять, для реестра, подписанного ключом, а не бесключевой идентичностью. |
trustedRoot | string | нет | Путь к якорю доверия, по которому проверяются подписи. |
requireSignatures | логическая | нет | Должен ли артефакт из этого реестра иметь проверенную подпись. При отсутствии ничего не утверждается, и разрешённое значение по умолчанию остаётся в силе. |
advisory | логическая | нет | Сообщать ли о неудачной проверке вместо остановки. |
fetchTrust | логическая | нет | Прочитать ли политику доверия, которую объявляет реестр, и закрепить её. При отсутствии ничего не утверждается, и разрешённое значение по умолчанию остаётся в силе. |
global | логическая | нет | Записать общемашинный файл конфигурации; это собственное поведение метода по умолчанию. |
workspace | логическая | нет | Записать собственный файл конфигурации этого рабочего пространства вместо общемашинного. |
Дополнительные свойства не допускаются.
RegistryRemoveParams
Удаляет зарегистрированный реестр. Записывает общемашинный файл конфигурации, если запрос не требует иного.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | да | Абсолютный путь к рабочему пространству, над которым выполняется запрос. Это субъект запроса: демон разрешает его до выполнения метода, а запрос, в котором он опущен или записан не как строка, отклоняется. |
workDoneToken | ProgressToken | нет | Значение, которое создаёт вызывающая сторона, чтобы сопоставлять уведомления о ходе выполнения с вызовом, который их запросил. Оно возвращается в каждом уведомлении без изменений, поэтому вызывающая сторона может сравнить его с отправленным значением. Оно принимается в любом запросе, а запрос, отправивший его в сеансе, где не была объявлена возможность получать уведомления о ходе выполнения, отклоняется. |
registry | string | нет | Реестр для удаления, по хосту или по псевдониму. |
global | логическая | нет | Записать общемашинный файл конфигурации; это собственное поведение метода по умолчанию. |
workspace | логическая | нет | Записать собственный файл конфигурации этого рабочего пространства вместо общемашинного. |
Дополнительные свойства не допускаются.
RegistryUpdateParams
Обновляет локальный индекс, который читает поиск, обращаясь для этого к реестру. Записывается индекс в собственном настроенном каталоге кеша этого рабочего пространства. Если реестру нужны учётные данные, которых нет ни в одном окружающем источнике, запрос отклоняется с указанием этих учётных данных, а не запрашивает их.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | да | Абсолютный путь к рабочему пространству, над которым выполняется запрос. Это субъект запроса: демон разрешает его до выполнения метода, а запрос, в котором он опущен или записан не как строка, отклоняется. |
workDoneToken | ProgressToken | нет | Значение, которое создаёт вызывающая сторона, чтобы сопоставлять уведомления о ходе выполнения с вызовом, который их запросил. Оно возвращается в каждом уведомлении без изменений, поэтому вызывающая сторона может сравнить его с отправленным значением. Оно принимается в любом запросе, а запрос, отправивший его в сеансе, где не была объявлена возможность получать уведомления о ходе выполнения, отклоняется. |
registry | string | нет | Единственный реестр для обновления. При отсутствии обновляются все настроенные хосты. |
upgrade | логическая | нет | Перестроить ли индекс вместо добавления к тому, что в нём уже есть. |
Дополнительные свойства не допускаются.
LogoutParams
Удаляет сохранённые учётные данные реестра. Хранилище общее для всех проектов на машине, и ответ сообщает об этом.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | да | Абсолютный путь к рабочему пространству, над которым выполняется запрос. Это субъект запроса: демон разрешает его до выполнения метода, а запрос, в котором он опущен или записан не как строка, отклоняется. |
workDoneToken | ProgressToken | нет | Значение, которое создаёт вызывающая сторона, чтобы сопоставлять уведомления о ходе выполнения с вызовом, который их запросил. Оно возвращается в каждом уведомлении без изменений, поэтому вызывающая сторона может сравнить его с отправленным значением. Оно принимается в любом запросе, а запрос, отправивший его в сеансе, где не была объявлена возможность получать уведомления о ходе выполнения, отклоняется. |
registry | string | нет | Реестр, сохранённые учётные данные которого нужно удалить. |
Дополнительные свойства не допускаются.
PublishEntityParams
Публикует сущность в реестр. То, что она помещает в реестр, разрешают все потребители этого реестра, и опубликованную версию нельзя отозвать у тех, кто уже её получил. Ничего не запрашивается интерактивно: удостоверение определяется из того, что передано в запросе, или из того, что уже есть в окружении.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | да | Абсолютный путь к рабочему пространству, над которым выполняется запрос. Это субъект запроса: демон разрешает его до выполнения метода, а запрос, в котором он опущен или записан не как строка, отклоняется. |
workDoneToken | ProgressToken | нет | Значение, которое создаёт вызывающая сторона, чтобы сопоставлять уведомления о ходе выполнения с вызовом, который их запросил. Оно возвращается в каждом уведомлении без изменений, поэтому вызывающая сторона может сравнить его с отправленным значением. Оно принимается в любом запросе, а запрос, отправивший его в сеансе, где не была объявлена возможность получать уведомления о ходе выполнения, отклоняется. |
entity | string | нет | Публикуемый документ сущности в виде пути относительно корня рабочего пространства. |
registry | string | нет | Реестр, в который выполняется публикация. Если не задан, используется настроенный реестр по умолчанию. |
dryRun | логическая | нет | Сообщить ли, что поместила бы публикация, не помещая этого. |
sign | логическая | нет | Подписывать ли публикуемое. Если не задано, ничего не указывается и остаётся разрешённое значение по умолчанию. |
plugin | string | нет | Модуль плагина, публикуемый вместе с сущностью Plugin. |
fulcioUrl | string | нет | Центр сертификации, у которого нужно получить сертификат подписи. |
rekorUrl | string | нет | Журнал прозрачности, в который записывается подпись. |
timestampUrl | string | нет | Служба меток времени для заверяющей подписи. |
identityToken | string | нет | Токен удостоверения для подписи, передаваемый вызывающей стороной, а не получаемый в терминале. |
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 | нет | Токен удостоверения для подписи, передаваемый вызывающей стороной, а не получаемый в терминале. |
jobs | integer | нет | Сколько ссылок подписывается одновременно. Если поле отсутствует, ссылки подписываются одна за другой. Каждая ссылка всё равно подписывается в точности так, как была бы подписана по отдельности — при бесключевой подписи со своим сертификатом и своей записью в журнале прозрачности, — а ответ сохраняет порядок, в котором были переданы ссылки. Минимум: 1. |
Дополнительные свойства не допускаются.
DeprecateArtifactParams
Помечает опубликованную версию как устаревшую, чтобы при разрешении о ней можно было сообщить или отклонить её. Сам маркер тоже публикуется и подписывается. Запрос передаёт либо одну ссылку с её содержимым, либо пакетный файл, записи которого несут собственное содержимое, — но никогда и то и другое и никогда содержимое рядом с пакетным файлом.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | да | Абсолютный путь к рабочему пространству, над которым выполняется запрос. Это субъект запроса: демон разрешает его до выполнения метода, а запрос, в котором он опущен или записан не как строка, отклоняется. |
workDoneToken | ProgressToken | нет | Значение, которое создаёт вызывающая сторона, чтобы сопоставлять уведомления о ходе выполнения с вызовом, который их запросил. Оно возвращается в каждом уведомлении без изменений, поэтому вызывающая сторона может сравнить его с отправленным значением. Оно принимается в любом запросе, а запрос, отправивший его в сеансе, где не была объявлена возможность получать уведомления о ходе выполнения, отклоняется. |
reference | string | нет | Опубликованная ссылка, которую нужно пометить. Альтернатива from: запрос, содержащий оба, отклоняется. |
severity | const “warning” или const “error” или const “retracted” | нет | Насколько сильно действует маркер — сообщает ли разрешение о версии или отклоняет её. Обязательно вместе с reference; отклоняется рядом с from, пакетный файл которого несёт собственное значение для каждого маркера. Допустимые значения: "warning" — Устарела, на более мягком из двух рекомендательных уровней: по-прежнему выбирается при выборе версии. "error" — Устарела, на более строгом из двух рекомендательных уровней: по-прежнему выбирается при выборе версии. "retracted" — Отозвана: исключается при выборе версии. |
reason | string | нет | Причина, по которой версия устарела. Обязательно вместе с reference; отклоняется рядом с from, пакетный файл которого несёт собственное значение для каждого маркера. |
replacement | string | нет | Ссылка, которую следует использовать вместо этой. Отклоняется рядом с from, пакетный файл которого несёт собственное значение для каждого маркера. |
message | string | нет | Что сообщается потребителю, встретившему маркер. Отклоняется рядом с from, пакетный файл которого несёт собственное значение для каждого маркера. |
from | string | нет | Пакетный файл записей об отзыве в виде пути относительно корня рабочего пространства, прикрепляющий по одному маркеру на запись. Каждая запись несёт собственные ссылку, уровень серьёзности и причину, а также, необязательно, замену и сообщение. Альтернатива reference: запрос, содержащий оба либо содержащий рядом с ним уровень серьёзности, причину, замену или сообщение, отклоняется. |
fulcioUrl | string | нет | Центр сертификации, у которого нужно получить сертификат подписи. |
rekorUrl | string | нет | Журнал прозрачности, в который записывается подпись. |
timestampUrl | string | нет | Служба меток времени для заверяющей подписи. |
identityToken | string | нет | Токен удостоверения для подписи, передаваемый вызывающей стороной, а не получаемый в терминале. |
Дополнительные свойства не допускаются.
ResolveParams
Отвечает, где определён элемент под курсором.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | да | Абсолютный путь к рабочему пространству, над которым выполняется запрос. Это субъект запроса: демон разрешает его до выполнения метода, а запрос, в котором он опущен или записан не как строка, отклоняется. |
workDoneToken | ProgressToken | нет | Значение, которое создаёт вызывающая сторона, чтобы сопоставлять уведомления о ходе выполнения с вызовом, который их запросил. Оно возвращается в каждом уведомлении без изменений, поэтому вызывающая сторона может сравнить его с отправленным значением. Оно принимается в любом запросе, а запрос, отправивший его в сеансе, где не была объявлена возможность получать уведомления о ходе выполнения, отклоняется. |
uri | string | нет | Документ, в котором находится курсор. |
position | Position | нет | Место в документе: строка и смещение символа в ней, оба с отсчётом от нуля. Смещение измеряется в единицах кодировки, согласованной сеансом при открытии, — это UTF-16, если клиент не запросил другую. |
release | string | нет | Сущность Release, в терминах которой даётся ответ, в виде пути относительно корня рабочего пространства. Тогда определением считается документ, в который разрешается ссылка через каталоги, заданные этой сущности Release в конфигурации рабочего пространства, в указанном порядке, так что имя, которое объявляют несколько вариантов в одном рабочем пространстве, по одному на каждую сущность Release, ведёт к варианту этой сущности Release; если в этих каталогах такой сущности нет, поиск ведётся по документам рабочего пространства, исключая документы в тех каталогах рабочего пространства, которые эта сущность Release не читает. Если значение не задано, сначала просматриваются документы рабочего пространства, а собственные каталоги рабочего пространства — только если ни один документ не объявляет это имя. Значение, не указывающее на файл Release, отклоняется. |
Дополнительные свойства не допускаются.
FindReferencesParams
Отвечает, где упоминается элемент под курсором.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | да | Абсолютный путь к рабочему пространству, над которым выполняется запрос. Это субъект запроса: демон разрешает его до выполнения метода, а запрос, в котором он опущен или записан не как строка, отклоняется. |
workDoneToken | ProgressToken | нет | Значение, которое создаёт вызывающая сторона, чтобы сопоставлять уведомления о ходе выполнения с вызовом, который их запросил. Оно возвращается в каждом уведомлении без изменений, поэтому вызывающая сторона может сравнить его с отправленным значением. Оно принимается в любом запросе, а запрос, отправивший его в сеансе, где не была объявлена возможность получать уведомления о ходе выполнения, отклоняется. |
uri | string | нет | Документ, в котором находится курсор. |
position | Position | нет | Место в документе: строка и смещение символа в ней, оба с отсчётом от нуля. Смещение измеряется в единицах кодировки, согласованной сеансом при открытии, — это UTF-16, если клиент не запросил другую. |
release | string | нет | Сущность Release, в терминах которой даётся ответ, в виде пути относительно корня рабочего пространства. Тогда ссылка из документа в одном из каталогов рабочего пространства, которые эта сущность Release не читает, не сообщается, так что варианты, которые рабочее пространство хранит рядом, по одному на каждую сущность Release, никогда не сообщаются как ссылки друг на друга. Если значение не задано, просматриваются все документы рабочего пространства. Значение, не указывающее на файл Release, отклоняется. |
Дополнительные свойства не допускаются.
FindImplementationsParams
Отвечает, какие документы реализуют элемент под курсором.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | да | Абсолютный путь к рабочему пространству, над которым выполняется запрос. Это субъект запроса: демон разрешает его до выполнения метода, а запрос, в котором он опущен или записан не как строка, отклоняется. |
workDoneToken | ProgressToken | нет | Значение, которое создаёт вызывающая сторона, чтобы сопоставлять уведомления о ходе выполнения с вызовом, который их запросил. Оно возвращается в каждом уведомлении без изменений, поэтому вызывающая сторона может сравнить его с отправленным значением. Оно принимается в любом запросе, а запрос, отправивший его в сеансе, где не была объявлена возможность получать уведомления о ходе выполнения, отклоняется. |
uri | string | нет | Документ, в котором находится курсор. |
position | Position | нет | Место в документе: строка и смещение символа в ней, оба с отсчётом от нуля. Смещение измеряется в единицах кодировки, согласованной сеансом при открытии, — это UTF-16, если клиент не запросил другую. |
release | string | нет | Сущность Release, в терминах которой даётся ответ, в виде пути относительно корня рабочего пространства. Тогда документ в одном из каталогов рабочего пространства, которые эта сущность Release не читает, не сообщается, так что вариант, с которым собирается другая сущность Release, никогда не попадает в список для этой. Если значение не задано, просматриваются все документы рабочего пространства. Значение, не указывающее на файл Release, отклоняется. |
Дополнительные свойства не допускаются.
HoverParams
Отвечает, что показать об элементе под курсором.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | да | Абсолютный путь к рабочему пространству, над которым выполняется запрос. Это субъект запроса: демон разрешает его до выполнения метода, а запрос, в котором он опущен или записан не как строка, отклоняется. |
workDoneToken | ProgressToken | нет | Значение, которое создаёт вызывающая сторона, чтобы сопоставлять уведомления о ходе выполнения с вызовом, который их запросил. Оно возвращается в каждом уведомлении без изменений, поэтому вызывающая сторона может сравнить его с отправленным значением. Оно принимается в любом запросе, а запрос, отправивший его в сеансе, где не была объявлена возможность получать уведомления о ходе выполнения, отклоняется. |
uri | string | нет | Документ, в котором находится курсор. |
position | Position | нет | Место в документе: строка и смещение символа в ней, оба с отсчётом от нуля. Смещение измеряется в единицах кодировки, согласованной сеансом при открытии, — это UTF-16, если клиент не запросил другую. |
release | string | нет | Сущность Release, в терминах которой даётся ответ, в виде пути относительно корня рабочего пространства. Тогда показывается сущность, в которую разрешается ссылка через каталоги, заданные этой сущности Release в конфигурации рабочего пространства, в указанном порядке; если в этих каталогах такой сущности нет, поиск ведётся по документам рабочего пространства, исключая документы в тех каталогах рабочего пространства, которые эта сущность Release не читает. Если значение не задано, сначала просматриваются документы рабочего пространства, а собственные каталоги рабочего пространства — только если ни один документ не объявляет это имя. Значение, не указывающее на файл Release, отклоняется. |
Дополнительные свойства не допускаются.
CompletionParams
Отвечает, что можно написать в позиции курсора.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | да | Абсолютный путь к рабочему пространству, над которым выполняется запрос. Это субъект запроса: демон разрешает его до выполнения метода, а запрос, в котором он опущен или записан не как строка, отклоняется. |
workDoneToken | ProgressToken | нет | Значение, которое создаёт вызывающая сторона, чтобы сопоставлять уведомления о ходе выполнения с вызовом, который их запросил. Оно возвращается в каждом уведомлении без изменений, поэтому вызывающая сторона может сравнить его с отправленным значением. Оно принимается в любом запросе, а запрос, отправивший его в сеансе, где не была объявлена возможность получать уведомления о ходе выполнения, отклоняется. |
uri | string | нет | Документ, в котором находится курсор. |
position | Position | нет | Место в документе: строка и смещение символа в ней, оба с отсчётом от нуля. Смещение измеряется в единицах кодировки, согласованной сеансом при открытии, — это UTF-16, если клиент не запросил другую. |
context | CompletionContext | нет | Причина запроса, если клиент её отслеживает. |
release | string | нет | Сущность Release, в терминах которой даётся ответ, в виде пути относительно корня рабочего пространства. Тогда предлагаются имена, которые объявляют документы рабочего пространства, за вычетом документов в тех каталогах рабочего пространства, которые эта сущность Release не читает, вместе с сущностями Components и Features, объявленными в каталогах, заданных этой сущности Release в конфигурации рабочего пространства. Если значение не задано, это документы рабочего пространства и сущности Components и Features, объявленные в его собственных каталогах. Значение, не указывающее на файл Release, отклоняется. |
Дополнительные свойства не допускаются.
CompletionContext
Причина запроса, если клиент её отслеживает.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
triggerKind | integer | нет | Почему было запрошено автодополнение. |
triggerCharacter | string | нет | Символ, вызвавший запрос, если его вызвал символ. |
Дополнительные свойства допускаются.
AttachCandidatesParams
Отвечает, какие Features можно присоединить к сущности, с учётом меток этой сущности, а для одного соединения, которое рисует компонент узла графа, — какие из них могут заполнить каждый слот, объявленный сокетом этого соединения.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | да | Абсолютный путь к рабочему пространству, над которым выполняется запрос. Это субъект запроса: демон разрешает его до выполнения метода, а запрос, в котором он опущен или записан не как строка, отклоняется. |
workDoneToken | ProgressToken | нет | Значение, которое создаёт вызывающая сторона, чтобы сопоставлять уведомления о ходе выполнения с вызовом, который их запросил. Оно возвращается в каждом уведомлении без изменений, поэтому вызывающая сторона может сравнить его с отправленным значением. Оно принимается в любом запросе, а запрос, отправивший его в сеансе, где не была объявлена возможность получать уведомления о ходе выполнения, отклоняется. |
node | string | нет | Сущность, относительно которой оцениваются кандидаты, по имени; читается из того, что объявляют документы рабочего пространства. |
graphNode | string | нет | Узел графа, относительно которого оцениваются кандидаты; его метки — окончательный набор, по которому сама сборка оценивает применимость. Ответ, вычисленный по нему, говорит, что сделает сборка. |
release | string | нет | Сущность Release, графу которой принадлежит узел, в виде пути относительно корня рабочего пространства. Тогда кандидаты берутся в терминах этой сущности Release: Features, объявленные каталогами, которые конфигурация рабочего пространства назначает этой сущности Release, и документы рабочего пространства, за исключением находящихся в тех каталогах рабочего пространства, которые эта сущность Release не читает, так что Feature, предназначенная для другой сущности Release, никогда не предлагается для узла графа этой. |
labels | map of string | нет | Метки для непосредственной оценки вместо их чтения из сущности или узла графа. |
connection | ConnectionCoordinate | нет | Одно соединение, которое рисует компонент узла, названного в graphNode, — для ответа также и по нему, помимо самого узла: тогда ответ содержит ещё и slots — каждый слот, объявленный сокетом соединения, с Features, которые могут его заполнить, — или noSlotReason, если ни один слот заполнить нельзя. Передаётся только вместе с graphNode и release, поскольку соединение существует только в скомпилированном графе; при передаче с node или labels запрос отклоняется. Кандидаты рядом с ним сохраняют своё значение: Features, которые можно присоединить к самому узлу. Его document принимается и не меняет этот ответ: слоты определяются сокетом, а кандидаты — сущностями Features, независимо от того, в каком документе записано присоединение. |
Дополнительные свойства не допускаются.
ConnectionCandidatesParams
Отвечает, к каким сущностям можно подключить сокет сущности.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | да | Абсолютный путь к рабочему пространству, над которым выполняется запрос. Это субъект запроса: демон разрешает его до выполнения метода, а запрос, в котором он опущен или записан не как строка, отклоняется. |
workDoneToken | ProgressToken | нет | Значение, которое создаёт вызывающая сторона, чтобы сопоставлять уведомления о ходе выполнения с вызовом, который их запросил. Оно возвращается в каждом уведомлении без изменений, поэтому вызывающая сторона может сравнить его с отправленным значением. Оно принимается в любом запросе, а запрос, отправивший его в сеансе, где не была объявлена возможность получать уведомления о ходе выполнения, отклоняется. |
node | string | нет | Сущность, о сокетах которой идёт запрос. |
socket | string | нет | Единственный сокет, по которому нужен ответ. Если не указан, ответ даётся по каждому сокету, который объявляет сущность. |
Дополнительные свойства не допускаются.
InsertionPointParams
Отвечает, где в документе должна находиться новая запись в указанном контейнере; составление и применение записи остаётся за вызывающей стороной, которой принадлежит буфер.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | да | Абсолютный путь к рабочему пространству, над которым выполняется запрос. Это субъект запроса: демон разрешает его до выполнения метода, а запрос, в котором он опущен или записан не как строка, отклоняется. |
workDoneToken | ProgressToken | нет | Значение, которое создаёт вызывающая сторона, чтобы сопоставлять уведомления о ходе выполнения с вызовом, который их запросил. Оно возвращается в каждом уведомлении без изменений, поэтому вызывающая сторона может сравнить его с отправленным значением. Оно принимается в любом запросе, а запрос, отправивший его в сеансе, где не была объявлена возможность получать уведомления о ходе выполнения, отклоняется. |
file | string | нет | Документ, о котором нужен ответ. |
container | string[] | нет | Путь по документу к контейнеру, в котором должна находиться запись. |
Дополнительные свойства не допускаются.
AttachmentContainerParams
Отвечает, в каком документе и в каком месте этого документа должно находиться присоединение к узлу графа или к одному из соединений, которые рисует его компонент.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | да | Абсолютный путь к рабочему пространству, над которым выполняется запрос. Это субъект запроса: демон разрешает его до выполнения метода, а запрос, в котором он опущен или записан не как строка, отклоняется. |
workDoneToken | ProgressToken | нет | Значение, которое создаёт вызывающая сторона, чтобы сопоставлять уведомления о ходе выполнения с вызовом, который их запросил. Оно возвращается в каждом уведомлении без изменений, поэтому вызывающая сторона может сравнить его с отправленным значением. Оно принимается в любом запросе, а запрос, отправивший его в сеансе, где не была объявлена возможность получать уведомления о ходе выполнения, отклоняется. |
graphNode | string | нет | Узел графа, для которого предназначено присоединение. |
release | string | нет | Сущность Release, графу которой принадлежит узел, в виде пути относительно корня рабочего пространства. |
connection | ConnectionCoordinate | нет | Одно соединение, которое рисует компонент узла графа, если присоединение предназначено для этого соединения, а не для узла: тогда ответ называет собственный контейнер features соединения в документе, который указан в его поле document; здесь это поле обязательно. В Aggregate это запись соединения в документе, в котором был написан узел; запрос отклоняется для соединения, нарисованного сущностью Release, поскольку в Aggregate нет записи для него. В Release это запись для ребра внутри собственной записи Release для узла, независимо от того, пишет ли Release уже такую запись для этого соединения; запрос отклоняется, если Release не пишет записи для узла. Соединение, нарисованное сущностью Feature, отклоняется в обоих документах, поскольку присоединение записывается только на соединении, которое рисует компонент или Release. |
Дополнительные свойства не допускаются.
ConnectionAtPositionParams
Отвечает, внутрь записи какого соединения попадает позиция в Aggregate или Release: узел графа и соединение — в тех терминах, в которых их принимают запросы кандидатов и контейнера, — или почему в этом месте не записано соединение. Записи — это те, в которых записывается присоединение: запись, которой компонент рисует соединение, под псевдонимом соединения, в документе, где был написан компонент, и каждая запись для ребра, которую пишет Release, — каждая там, где её фиксирует скомпилированный граф, так что является ли ключ соединением, никогда не определяется по его названию.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | да | Абсолютный путь к рабочему пространству, над которым выполняется запрос. Это субъект запроса: демон разрешает его до выполнения метода, а запрос, в котором он опущен или записан не как строка, отклоняется. |
workDoneToken | ProgressToken | нет | Значение, которое создаёт вызывающая сторона, чтобы сопоставлять уведомления о ходе выполнения с вызовом, который их запросил. Оно возвращается в каждом уведомлении без изменений, поэтому вызывающая сторона может сравнить его с отправленным значением. Оно принимается в любом запросе, а запрос, отправивший его в сеансе, где не была объявлена возможность получать уведомления о ходе выполнения, отклоняется. |
file | string | нет | Документ, в котором находится позиция: Release или документ, в котором, согласно графу Release, написаны компоненты, — его Aggregate или документ модуля, который импортирует этот Aggregate. Он читается сначала из того, что хранит для него сеанс, а иначе — с диска. |
position | Position | нет | Место в документе: строка и смещение символа в ней, оба с отсчётом от нуля. Смещение измеряется в единицах кодировки, согласованной сеансом при открытии, — это UTF-16, если клиент не запросил другую. |
release | string | нет | Сущность Release, скомпилированный граф которой фиксирует соединения, в виде пути относительно корня рабочего пространства. Она обязательна и для позиции в Aggregate, поскольку узел графа и соединение существуют только в скомпилированном графе. |
Дополнительные свойства не допускаются.
ConnectionCoordinate
Одно соединение, которое проводит компонент узла графа, адресуемое сокетом, через который оно подключено, и псевдонимом, который оно носит в этом сокете, а также документом, в котором записывается прикрепление к нему. Соединение несёт прикрепления, заполняющие слоты, объявленные его сокетом, и записывать их может как Aggregate, так и Release.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
socket | string | да | Сокет зависимости, через который подключено соединение. |
alias | string | да | Имя, которое соединение носит в своём сокете. |
document | const “aggregate” или const “release” | нет | Документ, в котором записывается прикрепление к соединению. Набор значений закрыт, и значение вне его отклоняется. Допустимые значения: "aggregate" — Aggregate, где разработчик записывает прикрепление в записи соединения. "release" — Release, где оператор записывает прикрепление в записи для отдельного ребра этого соединения. |
Дополнительные свойства допускаются.
SetActiveReleaseParams
Записывает Release как используемый по умолчанию в рабочем пространстве, создавая маркер в каталоге .aggrega: выбор, о котором сообщает aggrega/activeRelease, читает этот маркер после авторского Release из конфигурации. Маркер записывается только внутри рабочего пространства: если каталог .aggrega или маркер является ссылкой, ведущей за пределы рабочего пространства, независимо от того, существует ли уже место, куда она ведёт, запись отклоняется с указанием ссылки, и ничего не записывается. Ответ совпадает с тем, что даёт aggrega/activeRelease после записи маркера, поэтому он называет другой Release, если авторский Release из конфигурации имеет приоритет над маркером.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | да | Абсолютный путь к рабочему пространству, над которым выполняется запрос. Это субъект запроса: демон разрешает его до выполнения метода, а запрос, в котором он опущен или записан не как строка, отклоняется. |
workDoneToken | ProgressToken | нет | Значение, которое создаёт вызывающая сторона, чтобы сопоставлять уведомления о ходе выполнения с вызовом, который их запросил. Оно возвращается в каждом уведомлении без изменений, поэтому вызывающая сторона может сравнить его с отправленным значением. Оно принимается в любом запросе, а запрос, отправивший его в сеансе, где не была объявлена возможность получать уведомления о ходе выполнения, отклоняется. |
release | string | нет | Записываемый Release в виде пути относительно корня рабочего пространства. Абсолютный путь и путь, выходящий за пределы рабочего пространства, отклоняются; так же отклоняется путь, ведущий за его пределы через ссылку, если только конфигурация рабочего пространства не называет этот Release. |
Дополнительные свойства не допускаются.
EditDocumentParams
Применяет одну ограниченную правку к документу рабочего пространства: добавление одной записи в один контейнер или установку одного скалярного значения. Составленный документ проверяется по схеме своего вида и попадает на диск, только если проверка пройдена, поэтому так нельзя записать то, что отклоняет авторская схема. Отклонённая правка оставляет файл побайтово неизменным.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | да | Абсолютный путь к рабочему пространству, над которым выполняется запрос. Это субъект запроса: демон разрешает его до выполнения метода, а запрос, в котором он опущен или записан не как строка, отклоняется. |
workDoneToken | ProgressToken | нет | Значение, которое создаёт вызывающая сторона, чтобы сопоставлять уведомления о ходе выполнения с вызовом, который их запросил. Оно возвращается в каждом уведомлении без изменений, поэтому вызывающая сторона может сравнить его с отправленным значением. Оно принимается в любом запросе, а запрос, отправивший его в сеансе, где не была объявлена возможность получать уведомления о ходе выполнения, отклоняется. |
file | string | нет | Редактируемый документ. |
edit | const “add-component” или const “attach-feature” или const “wire-edge” или const “set-value” | нет | Какую правку применить. Допустимые значения: "add-component" — Добавляет экземпляр компонента в контейнер components: name — имя экземпляра, value — запрашиваемый им Component. "attach-feature" — Прикрепляет Feature к узлу, указанному в запросе: name — имя экземпляра прикрепления, value — запрашиваемый им Feature. "wire-edge" — Подключает соединение зависимости от узла, указанного в запросе, внутри socket: name — псевдоним, по которому адресуется соединение, value — узел, на который оно указывает. "set-value" — Задаёт одно значение на узле, указанном в запросе: name — ключ значения, value — скаляр. |
node | string[] | нет | Путь по документу к редактируемой записи. |
socket | string | нет | Сокет, к которому относится правка, если правка подключает сокет. |
name | string | нет | Имя, которое записывает правка. |
value | любой | нет | Значение, которое записывает правка, в той форме, какую принимает правка. |
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, который ничего не записывает из остановившегося преобразования.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | да | Абсолютный путь к рабочему пространству, над которым выполняется запрос. Это субъект запроса: демон разрешает его до выполнения метода, а запрос, в котором он опущен или записан не как строка, отклоняется. |
workDoneToken | ProgressToken | нет | Значение, которое создаёт вызывающая сторона, чтобы сопоставлять уведомления о ходе выполнения с вызовом, который их запросил. Оно возвращается в каждом уведомлении без изменений, поэтому вызывающая сторона может сравнить его с отправленным значением. Оно принимается в любом запросе, а запрос, отправивший его в сеансе, где не была объявлена возможность получать уведомления о ходе выполнения, отклоняется. |
source | string | нет | Файл или каталог для преобразования — абсолютный путь или путь относительно корня рабочего пространства; запрос без него отклоняется. Он читается там, где находится, внутри рабочего пространства или нет, а из каталога читаются те его файлы, которые отбирают объявленные импортёром шаблоны файлов. |
outputDir | string | нет | Каталог в рабочем пространстве, в который записываются черновики, относительно корня рабочего пространства; абсолютное значение или значение, ведущее за пределы рабочего пространства напрямую или через ссылку, отклоняется. При отсутствии запись идёт под корень рабочего пространства — туда же, куда пишет то же преобразование, запущенное в терминале без указания места назначения. Каждый черновой путь задаётся относительно каталога, который ответ называет в outputDir, в том числе при dryRun. |
format | string | нет | Формат источника. При отсутствии его определяет преобразование. |
target | string | нет | Возможность поставщика, например compose или helm, — слово, к которому привязывается spec.capability сущности Recipe, — для которой рядом с черновиками составляется черновик Manifest в виде manifest.yaml: каждый тип компонента и тип функции, нужные черновикам, включая типы каталожной сущности Aggregate, которую компонует черновая, сопоставляется с сущностью Recipe или рецептом функции этой возможности, который каталог рабочего пространства предлагает для него, — единственным имеющимся или, среди нескольких, тем, что назван по типу; тип без таковых или с несколькими, ни один из которых так не назван, остаётся несопоставленным с предупреждающей находкой, называющей его; сопоставление, которое импортёр составил сам, сохраняется там, где каталог предлагает его для этого типа и этой возможности, а иначе отбрасывается с предупреждающей находкой; а spec.manifest черновой сущности Release указывает на этот Manifest. Возможность, к которой не привязана ни одна сущность Recipe в каталоге, отклоняется до запуска преобразования, и ничего не записывается. При отсутствии Manifest не составляется, кроме режима sync, который составляет черновик для цели, названной в записи предыдущего импорта; синхронизация с указанной целью составляет черновик для неё, и тогда запись называет её. |
dryRun | логическая | нет | Ответить ли содержимым каждого файла, который записал бы запрос, вместо записи. Всё остальное поведение совпадает с записью, поэтому запрос, который запись отклонила бы, отклоняется и в этом режиме; вместе с sync ответ содержит то, что записала бы синхронизация, и каждую часть, которая разошлась бы. |
sync | логическая | нет | Привести ли то, что предыдущий импорт записал в черновиках под outputDir, в соответствие с источником вместо записи черновика целиком. Меняется только то, что записал импорт, как это перечисляет запись рядом с черновиками: часть, которую источник не тронул, остаётся на диске как есть, отредактированная или нет; часть, которую источник изменил, удалил или добавил, записывается заново, удаляется (черновой файл удаляется целиком) или добавляется, если на диске то, что импорт записал последним; а всё остальное — ключ, добавленный автором, в том числе окружение, которое черновая сущность Release оставляет автору, — или комментарий, записанный не непосредственно над черновым ключом, остаётся байт в байт. Синхронизация, которая изменила бы или удалила то, что автор отредактировал или добавил, либо добавила бы часть там, где автор уже её написал, отклоняется с указанием каждой части; так же отклоняется синхронизация поверх сущности Aggregate, которой нет ни в одной записи; в обоих случаях ничего не записывается. Без этого флага запрос, черновики которого были бы записаны поверх сущности Aggregate, уже находящейся в outputDir, отклоняется, в том числе при dryRun. |
upgrade | логическая | нет | Следует ли загрузить новейший снимок каталога, который публикует реестр по умолчанию рабочего пространства, и импортировать относительно него, с этого момента храня его вместо того, который хранит рабочее пространство, или того, который называет запись рядом с черновиками; ничего не меняет, если рабочее пространство называет папку каталога, и отклоняется в автономном режиме. |
answers | string | нет | Файл ответов, из которого считываются и в который записываются значения, оставляемые черновиками пустыми и которые не может содержать ни один источник, относительно корня рабочего пространства; абсолютное значение или значение, ведущее за пределы рабочего пространства как записано или через ссылку, отклоняется. Он содержит под путём каждого чернового файла путь ключа внутри этого документа и ответ для него, а ответы записываются в черновики. При отсутствии считывается файл, названный в записи рядом с черновиками, а иначе import-answers.yaml рядом с исходным файлом или внутри исходного каталога. Ответ для секрета называет, откуда берётся секрет, — имя переменной, ${NAME} или имя Kubernetes Secret, — а всё остальное отклоняется, и ничего не записывается. Ничего не запрашивается: каждое ещё не предоставленное значение — это запись в owed ответа и предупреждающая находка, называющая черновой файл, ключ и то, чем он является, ответ на него отправляется как answered, а там, где черновики записываются, последняя находка сообщает, сколько значений недостаёт и где. Когда черновики включают сущность Release, ничего не недостаёт и преобразование завершилось, затем загружаются её зависимости с записью её lock-файла, а неудачная загрузка завершает находки объяснением причины, при этом черновики записаны; в офлайн-режиме ничего не загружается, и находка называет загрузку, которую следует выполнить. Ответ для ключа, который эти черновики не оставляют пустым, сохраняется в файле и не применяется, так что один файл ответов служит для любой цели. |
answered | ImportAnswered[] | нет | Ответы для значений, перечисленных в owed ответа, каждый из которых называет черновой файл и ключи так, как их назвало owed. Каждый оценивается, сохраняется в файле ответов и записывается в черновики в точности как ответ, введённый в терминале: ответ для секрета называет, откуда берётся секрет, — имя переменной, ${NAME} или имя Kubernetes Secret, — а ответ, который этого не делает, не сохраняется и не записывается, и его значение остаётся непредоставленным с причиной в качестве его secretAdvice. Значение, на которое файл ответов уже отвечает, получает ответ из файла; пустой ответ или ответ, называющий значение, которого черновикам не недостаёт, не применяется. Отправляйте его с sync после того, как черновики записаны, поскольку запрос, не являющийся sync, отклоняется для сущности Aggregate, которая уже есть в outputDir. В режиме dryRun, который не сохраняет ни одного ответа, и при sync, преобразование которого остановилось и который ничего не записывает, ни один отправленный ответ не применяется. |
Дополнительные свойства не допускаются.
ScaffoldEntityParams
Создаёт черновик начального документа для вида сущности, либо записывает один из запускаемых примеров документации в новый каталог рабочего пространства, либо перечисляет их. При создании черновика каркас выводится из набора схем, который содержит бинарный файл, поэтому из рабочего пространства ничего не читается и ничего не записывается — ответ представляет собой текст, а куда он попадёт, решает клиент. Запись примера записывает новый каталог и ничего больше, а примеры читаются из подписанного пакета документации, опубликованного для версии бинарного файла, или, если такого нет, из самого нового, опубликованного до неё, и пакет проверяется по политике подписей рабочего пространства, прежде чем будет сохранён или прочитан: пакет, не прошедший проверку, отклоняется, а в автономном режиме читается только уже кэшированная копия. Запрос, отправляющий поля двух форм вместе — kind с example или list, list с example, name с example или list, dir без example, — отклоняется до того, как что-либо будет прочитано.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
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
Проверяет соглашения о публикации в каталоге для одной сущности, для всего, что достигает замыкание сущности Release, или для всего в настроенных каталогах. Ни в одном режиме ничего не записывается. Если не указаны ни сущность, ни Release, проверяется весь каталог: в рабочем пространстве, конфигурация которого не задаёт собственных каталогов для Release, — один раз по каталогам рабочего пространства; в рабочем пространстве, которое называет Releases в workspace.releases, — один раз для каждой сущности Release по каталогам, которые она читает, и никогда по всем сразу.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | да | Абсолютный путь к рабочему пространству, над которым выполняется запрос. Это субъект запроса: демон разрешает его до выполнения метода, а запрос, в котором он опущен или записан не как строка, отклоняется. |
workDoneToken | ProgressToken | нет | Значение, которое создаёт вызывающая сторона, чтобы сопоставлять уведомления о ходе выполнения с вызовом, который их запросил. Оно возвращается в каждом уведомлении без изменений, поэтому вызывающая сторона может сравнить его с отправленным значением. Оно принимается в любом запросе, а запрос, отправивший его в сеансе, где не была объявлена возможность получать уведомления о ходе выполнения, отклоняется. |
entity | string | нет | Единственный документ сущности для проверки. |
release | string | нет | Сущность Release, замыкание которой проверяется, — путь относительно корня рабочего пространства. |
prePublish | логическая | нет | Сравнивать ли каждую сущность с её ранее опубликованной версией; для этого выполняется обращение к настроенным реестрам. |
Дополнительные свойства не допускаются.
PluginAddParams
Подключает плагин к сокету, который настроен в рабочем пространстве. Обращается к реестру, чтобы сопоставить запрос одному плагину и закрепить версию. Единственное решение, которое запросил бы терминал, — принятие объявленных возможностей плагина расширения команд, — передаётся здесь в виде поля, поэтому клиент спрашивает того, кто им управляет, и этот интерфейс никогда не ожидает ответа на запрос.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | да | Абсолютный путь к рабочему пространству, над которым выполняется запрос. Это субъект запроса: демон разрешает его до выполнения метода, а запрос, в котором он опущен или записан не как строка, отклоняется. |
workDoneToken | ProgressToken | нет | Значение, которое создаёт вызывающая сторона, чтобы сопоставлять уведомления о ходе выполнения с вызовом, который их запросил. Оно возвращается в каждом уведомлении без изменений, поэтому вызывающая сторона может сравнить его с отправленным значением. Оно принимается в любом запросе, а запрос, отправивший его в сеансе, где не была объявлена возможность получать уведомления о ходе выполнения, отклоняется. |
type | string | нет | Сокет, к которому подключается плагин. |
query | string | нет | Что сопоставить одному плагину. |
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
Записывает встроенный в бинарный файл навык ассистента в папку навыков каждого ассистента, указанного в запросе, или, для запроса global, не указывающего ни одного, — каждого ассистента, найденного на этой машине. Без global записывает в папку проекта каждого ассистента внутри рабочего пространства, указанного в запросе, и каждый путь, который он записал бы там, ограничен этим рабочим пространством; с global записывает в пользовательскую папку каждого ассистента в домашнем каталоге. Каждая цель проверяется до того, как что-либо записывается, поэтому при отказе все папки остаются такими, какими были.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | да | Абсолютный путь к рабочему пространству, над которым выполняется запрос. Это субъект запроса: демон разрешает его до выполнения метода, а запрос, в котором он опущен или записан не как строка, отклоняется. |
workDoneToken | ProgressToken | нет | Значение, которое создаёт вызывающая сторона, чтобы сопоставлять уведомления о ходе выполнения с вызовом, который их запросил. Оно возвращается в каждом уведомлении без изменений, поэтому вызывающая сторона может сравнить его с отправленным значением. Оно принимается в любом запросе, а запрос, отправивший его в сеансе, где не была объявлена возможность получать уведомления о ходе выполнения, отклоняется. |
agents | string[] | нет | Ассистенты, для которых устанавливается навык, по идентификаторам, которые сообщает список. Запрос уровня проекта, не указывающий ни одного, отклоняется. Запрос global, не указывающий ни одного, устанавливает навык для ассистентов, найденных на этой машине, — каждого, чья папка конфигурации находится в домашнем каталоге или чья команда есть в PATH, — и отклоняется без какой-либо записи, если ни один не найден. Идентификатор, для которого не известна папка навыков, отклоняется с указанием его имени, а идентификатор, указанный дважды, устанавливается один раз. |
global | логическая | нет | Записывать в пользовательскую папку навыков каждого ассистента в домашнем каталоге, которую он читает в каждом проекте, вместо его папки проекта в рабочем пространстве. |
Дополнительные свойства не допускаются.
ServerCapabilities
Что демон будет делать в этом сеансе, согласованное с тем, что, по словам клиента, он способен обработать.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
positionEncoding | string | да | Кодировка, в которой выражаются все позиции в этом сеансе. |
workDoneProgress | логическая | нет | Будет ли демон отправлять уведомления о ходе выполнения в этом сеансе. Присутствует, только если клиент объявил, что может их получать. |
Дополнительные свойства не допускаются.
ClosureEntity
Одна сущность, от которой зависит сущность Release, в версии, выбранной при разрешении.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
uri | string | да | Ссылка, по которой разрешается сущность. |
version | string | да | Выбранная версия. |
kind | string | нет | Вид сущности. |
source | string | нет | Откуда запуск, создавший эту запись, взял сущность, тем же словом, которое для неё выводит aggrega pull --detail: fetched-fresh (загружена из реестра во время этого запуска), cache-reuse (копия, уже находившаяся в кэше, использована повторно без загрузки), local (найдена в локальной файловой системе, например в каталоге), in-binary (копия внутри бинарного файла компилятора) или external (собственные Aggregate или Manifest сущности Release, прочитанные из файла или записи, которые указывает Release, а не разрешённые как одна из её зависимостей; Aggregate, загруженный запуском из реестра, вместо этого имеет значение fetched-fresh). Присутствует в записях отчёта о разрешении зависимостей, где описывает, что этот запуск сделал на данной машине, и отсутствует в списке разрешённых зависимостей сущности Release, который описывает, от чего зависит Release. Lock-файл не записывает источник. Опускается для сущности, источник которой запуск не записал. |
Дополнительные свойства не допускаются.
ToolchainCorePlugin
Один плагин, встроенный в сам компилятор, и использованная его версия.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
plugin | string | да | Ссылка на плагин. |
version | string | да | Использованная версия. |
Дополнительные свойства не допускаются.
ToolchainReport
Компилятор, выбранный при разрешении, и встроенные в него плагины.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
compilerVersion | string | да | Версия компилятора, выбранная при разрешении. |
corePlugins | ToolchainCorePlugin[] | нет | Встроенные в компилятор плагины с использованной версией каждого. |
Дополнительные свойства не допускаются.
DependencyResolutionReport
Что разрешение зависимостей закрепило и получило.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
lockfile | string | да | Lock-файл, записанный разрешением, или тот, с которым сравнивала проверка. |
verified | логическая | нет | Был ли запрос проверкой, которая сравнила записанный lock-файл и не записала ни lock-файл, ни запись доверия к плагинам, ни entity.lock. |
entities | ClosureEntity[] или null | да | Сущности, закреплённые разрешением или сравнённые проверкой. |
libraries | ClosureEntity[] или null | да | Библиотеки, закреплённые разрешением или сравнённые проверкой. |
plugins | ClosureEntity[] или null | да | Плагины, закреплённые разрешением или сравнённые проверкой. |
sourceArtifacts | integer | да | Сколько исходных артефактов получено. |
trustedPlugins | integer | да | Сколько закреплённых плагинов имели проверенную подпись. |
toolchain | ToolchainReport | нет | Компилятор, выбранный при разрешении, и встроенные в него плагины. |
externalInputs | integer | да | Сколько внешних входных данных, используемых рендерингом, получено. |
incompleteExternalInputs | string | нет | Какие внешние входные данные не удалось получить, если такие есть. |
Дополнительные свойства не допускаются.
BuildNotice
Одно сообщение сборки для вызывающей стороны, которое не является ни замечанием о документе, ни сбоем.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
class | string | да | Вид уведомления. |
text | string | да | Текст уведомления. |
Дополнительные свойства не допускаются.
CacheScope
Область действия ответа о кэше. Два класса кэша общие для всех проектов на машине, поэтому каждый ответ о кэше указывает, какие из них он затронул, — иначе сеанс, открытый для одного рабочего пространства, воспринимался бы как сообщающий только об этом рабочем пространстве.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
machineWideClasses | string[] или null | да | Затронутые этим ответом классы кэша, общие для всех проектов на машине. |
workspaceRoot | string | да | Рабочее пространство, указанное в запросе. |
Дополнительные свойства не допускаются.
CacheElement
Один элемент, хранящийся в кэше.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
label | string | да | К чему относится запись. |
size | integer | да | Сколько байт она занимает. |
sizeText | string | да | Тот же размер в удобочитаемом для человека виде. |
digest | string | нет | Дайджест содержимого, под которым хранится запись, если он есть. |
note | string | нет | Прочие сведения о записи. |
Дополнительные свойства не допускаются.
CacheClass
Один кэш, о котором сообщает демон.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
name | string | да | Какой это кэш. |
reach | string | да | Принадлежит ли кэш этому рабочему пространству или является общим для машины. |
prunable | логическая | да | Будет ли демон освобождать этот кэш. |
elements | CacheElement[] или null | да | Что хранится в кэше. |
Дополнительные свойства не допускаются.
CacheProvenance
Под какими идентификаторами был получен кэшированный артефакт и насколько широко он используется совместно.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
identities | string[] или null | да | Идентификаторы, к которым отнесён артефакт. |
sharedBy | integer | нет | Сколько владельцев совместно используют артефакт. |
Дополнительные свойства не допускаются.
CacheRemoval
Один элемент, удалённый при освобождении, или, в списке оставленного на месте, один элемент, который был бы удалён.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
class | string | да | К какому кэшу он относится. |
label | string | да | Что это за элемент. |
reach | string | да | Принадлежит ли этот кэш этому рабочему пространству или является общим для машины. |
size | integer | да | Сколько байт он занимает или занимал до удаления. |
sizeText | string | да | Тот же размер в удобочитаемом для человека виде. |
Дополнительные свойства не допускаются.
CacheShortfall
Что осталось после освобождения и что позволило бы это освободить, чтобы вызывающая сторона, увидев меньшее значение, чем ожидала, узнала причину, а не догадывалась о ней.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
class | string | да | В каком кэше находится оставшееся. |
count | integer | да | Сколько записей осталось. |
size | integer | да | Сколько байт они занимают. |
sizeText | string | да | Тот же размер в удобочитаемом для человека виде. |
reach | string | да | Принадлежит ли этот кэш этому рабочему пространству или является общим для машины. |
reclaimedBy | string[] или null | да | Что позволило бы их освободить. |
Дополнительные свойства не допускаются.
CacheCleared
Один кэш, опустошённый при очистке.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
class | string | да | Какой кэш опустошён. |
reach | string | да | Принадлежит ли он этому рабочему пространству или является общим для машины. |
size | integer | да | Сколько байт из него освобождено. |
sizeText | string | да | Тот же размер в удобочитаемом для человека виде. |
heldOpenFiles | integer | да | Сколько файлов очистка оставила в этом кэше, потому что их держал открытыми другой процесс. Отказывается удалять открытый файл только Windows, поэтому во всех остальных системах значение равно нулю. Последующая очистка удалит их, когда этот процесс закончит с ними работать. |
heldOpenBytes | integer | да | Сколько байт занимают эти файлы. Они не учитываются в size — объёме, освобождённом очисткой. |
heldOpenBytesText | string | да | То же значение в удобочитаемом для человека виде. |
Дополнительные свойства не допускаются.
ConfigWriteScope
Какой документ конфигурации был записан и какова область его действия. Запрос указывает одно рабочее пространство, поэтому ответ без этих сведений воспринимался бы как относящийся к этому рабочему пространству, а для записи на уровне всей машины такое прочтение неверно.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
configFile | string | да | Записанный документ. |
machineWide | логическая | да | Является ли этот документ тем, через который разрешаются все рабочие пространства на машине. |
workspaceRoot | string | да | Рабочее пространство, указанное в запросе. |
Дополнительные свойства не допускаются.
PluginWriteScope
В какой документ конфигурации записано изменение плагина и какова область его действия. По умолчанию сокет расширений команд использует документ уровня всей машины, поэтому каждый ответ указывает, какой документ он записал.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
configFile | string | да | Записанный документ. |
machineWide | логическая | да | Является ли этот документ тем, через который разрешаются все рабочие пространства на машине. |
workspaceRoot | string | да | Рабочее пространство, указанное в запросе. |
Дополнительные свойства не допускаются.
CredentialStoreScope
Область действия изменения учётных данных. Хранилище общее для всех проектов на машине и для всех других инструментов, обращающихся к тем же реестрам, поэтому ответ сообщает об этом, а не оставляет догадываться, будто изменение ограничено сеансом.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
machineWide | логическая | да | Является ли затронутое изменением хранилище общим для машины. |
workspaceRoot | string | да | Рабочее пространство, указанное в запросе. |
Дополнительные свойства не допускаются.
SkillFolderScope
Насколько далеко распространяется установка навыка. Запрос указывает одно рабочее пространство, поэтому ответ, ничего об этом не говорящий, был бы прочитан как относящийся к этому рабочему пространству — а для пользовательских папок, которые ассистент читает в каждом проекте, такое прочтение неверно.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
machineWide | логическая | да | Являются ли записанные папки пользовательскими папками в домашнем каталоге, которые ассистент читает в каждом проекте на машине. |
workspaceRoot | string | да | Рабочее пространство, указанное в запросе. |
Дополнительные свойства не допускаются.
PublicationReach
Насколько далеко распространилась публикация. Эти ответы выходят далеко за пределы этой машины — то, что они прикрепляют, разрешает каждый потребитель этого реестра, — поэтому каждый называет каждый реестр, к которому обращался, и то, прикрепил ли вызов там что-либо.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
registries | string[] | да | Каждый хост реестра, к которому обращался вызов, каждый указан один раз, в порядке первого обращения. Вызов с одной ссылкой называет один хост; пробный запуск называет место назначения, к которому он обратился бы. |
beyondThisMachine | логическая | да | Прикрепил ли вызов что-либо, что реестр теперь отдаёт другим: загруженное содержимое, подпись, дату публикации или маркер устаревания. Ложно при пробном запуске и для вызова, который обнаружил, что всё, что он прикрепил бы, уже на месте, — повторная публикация полной версии или пакет подписания, каждая ссылка которого уже имела проверяемую подпись. |
Дополнительные свойства не допускаются.
WorkspaceEntityRef
Одна сущность, по виду и имени, с документом, который её объявляет.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
kind | string | да | Вид сущности. |
name | string | да | Имя сущности. |
file | string | да | Документ, который её объявляет, в виде пути относительно корня рабочего пространства. |
Дополнительные свойства не допускаются.
SourcedEntityRef
Одна сущность с указанием того, откуда она прочитана. Документ рабочего пространства сообщает свой путь относительно рабочего пространства; сущность, разрешённая из настроенных каталогов, сообщает пустой путь, поскольку единственный её путь ничего не значил бы для клиента. Происхождение указывает, какой из двух случаев имеет место, чтобы пустой путь не был прочитан как незаполненное поле.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
kind | string | да | Вид сущности. |
name | string | да | Имя сущности. |
file | string | да | Документ, который её объявляет, в виде пути относительно корня рабочего пространства, или пустая строка, если сущность получена из настроенных каталогов. |
origin | string | да | Откуда прочитана сущность. |
Дополнительные свойства не допускаются.
SocketCandidacy
Один сокет сущности и то, что можно к нему подключить.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
socket | string | да | Имя сокета. |
declaration | string | да | Где объявлен сокет. |
selector | string | да | Селектор меток, которому должна удовлетворять цель. |
required | логическая | да | Должен ли сокет быть подключён, чтобы сборка могла продолжиться. |
targets | WorkspaceEntityRef[] или null | да | Сущности, которые можно к нему подключить. |
Дополнительные свойства не допускаются.
SlotCandidacy
Один слот, который объявляет сокет соединения, в том виде, в каком его объявляет на сокете потребляющая сущность Component, и сущности Features, которые могут заполнить его в этом соединении.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
slot | string | да | Имя слота — ключ, под которым заполняющее его прикрепление записывается в features соединения. |
selector | string | да | Селектор меток, которому должна удовлетворять своими метками сущность Feature, заполняющая слот. Пусто, если слот его не объявляет, что допускает любую сущность Feature. |
required | логическая | да | Должно ли каждое соединение, подключённое через сокет, заполнить слот, чтобы сборка могла продолжиться. |
inject | string[] | да | Механизмы доставки, которые слот допускает для заполняющего его содержимого, в порядке их объявления в сущности Component. Пусто, если она их не объявляет. |
sensitive | логическая | да | Объявляет ли слот, что заполняющее его содержимое работает с секретными данными. Это помечает заполняющее слот прикрепление и ничего не отклоняет. |
description | string | да | Назначение слота по словам сущности Component. Пусто, если она ничего не говорит. |
candidates | SourcedEntityRef[] | да | Каждая сущность Feature, которая может заполнить слот в этом соединении: та, объявленной применимости которой удовлетворяют метки узла графа (это требование распространяется на каждое прикрепление узла) и собственные метки которой удовлетворяют селектору слота. Сущность Feature, применимость или метки которой невозможно сопоставить с селектором, не предлагается, поскольку сборка её отклоняет, а не допускает. |
Дополнительные свойства не допускаются.
CatalogEntity
Одна сущность, содержащаяся в индексе рабочего пространства.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
kind | string | да | Вид сущности. |
name | string | да | Имя сущности. |
apiVersion | string | да | Версия схемы, которую объявляет документ. |
description | string | да | Назначение сущности согласно документу. |
labels | map of string или null | да | Метки, которые объявляет документ. |
file | string | да | Документ, который её объявляет, в виде пути относительно корня рабочего пространства. |
origin | string | да | Откуда прочитана сущность. |
Дополнительные свойства не допускаются.
CompletionItem
Один вариант того, что можно написать в позиции курсора.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
label | string | да | Текст для вставки. |
kind | integer | нет | Тип элемента, чтобы клиент мог выбрать для него значок. |
detail | string | нет | Краткое уточнение, отображаемое рядом с меткой. |
documentation | string | нет | Подробное описание элемента. |
sortText | string | нет | Значение для сортировки, если оно отличается от метки. |
Дополнительные свойства не допускаются.
MarkupContent
Текст для отображения и способ его разметки.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
kind | string | да | Способ разметки текста. |
value | string | да | Текст. |
Дополнительные свойства не допускаются.
EntityKindDescriptor
Один вид документа, который пишет автор: сопоставляет токен, указываемый в запросе, с видом, который объявляет сам документ, и указывает, какие операции принимают документ этого вида.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
kind | string | да | Токен в нижнем регистре, указываемый в запросе, например component или featurerecipe. |
documentKind | string | да | Вид, который объявляет собственный заголовок документа. |
acceptedBy | EntityKindAcceptance | да | Какие операции принимают документ этого вида, указанный сам по себе — по пути или, для инспекции, по имени — без чего-либо ещё. Член равен true, если операция не отклоняет документ из-за его вида; принятый документ всё же может быть отклонён из-за своего содержимого. |
Дополнительные свойства не допускаются.
EntityKindAcceptance
Для одного вида, который пишет автор: принимает ли каждая операция документ этого вида, указанный сам по себе. Каждый член присутствует в каждой записи, поэтому false — это утверждение, а не пропуск.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
singleEntityValidation | логическая | да | Проверяет ли документ этого вида область одной сущности команды aggrega validate — команда, которой передан путь одного документа. Вид, который она отклоняет, проверяется вместо этого областью всего каталога или областью Release. |
publication | логическая | да | Публикует ли aggrega/publishEntity, указывающий только документ, документ этого вида. Для вида, публикация которого также привязывает исполняемый файл, указанный рядом с документом, — Plugin — значение false, поскольку запрос, указывающий только документ, для него отклоняется; для Manifest и Release значение false, поскольку ни один из этих видов не публикуется. |
inspectionByName | логическая | да | Разрешает ли aggrega/entityDefinition имя в сущность этого вида, если имя передано так, как оно записывается там, где одна сущность ссылается на другую. |
Дополнительные свойства не допускаются.
RegistryTrust
Политика доверия, которую разрешение применяет к тому, что отдаёт реестр.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
signaturesRequired | логическая | да | Должен ли артефакт из этого реестра иметь проверенную подпись. |
verificationSkipped | логическая | нет | Пропускается ли проверка. |
advisory | логическая | нет | Сообщать ли о неудачной проверке вместо остановки. |
anchor | string | нет | Якорь доверия, относительно которого проверяются подписи. |
keylessIdentities | integer | нет | Сколько идентичностей подписи являются доверенными для этого реестра. |
Дополнительные свойства не допускаются.
Registry
Один настроенный реестр. Ни одно поле здесь не содержит учётных данных, их длины, формы или какого-либо их представления — сообщается только их наличие, и именно поэтому значение безопасно вставлять в issue.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
host | string | да | Хост реестра, который является его идентификатором. |
name | string | нет | Понятный псевдоним, который разрешается в хост, если он настроен. |
default | логическая | да | Является ли этот реестр тем, к которому обращается операция без указанного реестра. |
authState | string | да | Присутствуют ли учётные данные для этого хоста в общем для машины хранилище. Поле сообщается даже пустым, чтобы вызывающая сторона могла отличить «учётные данные отсутствуют» от «список их не проверял». |
trust | RegistryTrust | да | Политика доверия, которую разрешение применяет к тому, что отдаёт реестр. |
Дополнительные свойства не допускаются.
TrustFetchOutcome
Результат чтения политики доверия, которую объявляет реестр. Исходы разделены, потому что означают разное: объявленная политика принята; реестр ничего не объявил — и это не сбой; вместо неё закреплена встроенная базовая политика; или чтение не предпринималось. Если ничего не объявлено, рядом указывается, удалось ли вообще связаться с реестром.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
pinned | логическая | да | Принята ли объявленная политика. |
notAdvertised | логическая | нет | Был ли реестр опрошен и не объявил ли он политику; в этом случае операция продолжается с тем, что указано в запросе. Реестр, опросу которого помешал автономный режим, так никогда не отмечается. Недоступный реестр тоже отмечается так, поскольку политика от него не пришла, и рядом несёт unreachable; чтобы различить эти случаи, читайте unreachable. |
unreachable | логическая | нет | Был ли реестр недоступен при запросе объявленной политики: его имя не разрешилось, соединение с ним было отклонено или не открылось, либо не удалось установить защищённое соединение. Значение определяется по самому сбою, а не по reason, стоит рядом с notAdvertised и задаётся только там, где сбой показывает, что до реестра так и не удалось достучаться; если реестр ответил — без политики или со сбоем, — поле отсутствует. |
baseline | логическая | нет | Закреплена ли встроенная базовая политика, потому что объявленная политика не была принята; такая политика есть только у официального хаба. Стоит рядом с notAdvertised, если хаб был опрошен и ничего не объявил, и отдельно, если опросу хаба помешал автономный режим. |
skipped | логическая | нет | Не предпринималось ли чтение, потому что его заменила указанная политика или запрос его не требовал. |
identities | integer | нет | Сколько подписывающих удостоверений содержала объявленная политика. |
reason | string | нет | Почему объявленная политика не была принята: что сделала конечная точка реестра или какой отказ автономного режима помешал её опросить. |
Дополнительные свойства не допускаются.
SkippedRepo
Один репозиторий, пропущенный при обходе индекса, и причина.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
repo | string | да | Пропущенный репозиторий. |
reason | string | да | Почему он был пропущен. |
Дополнительные свойства не допускаются.
DeprecationNote
Один маркер устаревания, встреченный при обходе индекса, и что с ним было сделано. Учтённый маркер и маркер, который присутствовал, но был отклонён, сообщаются на равных, чтобы учёт многих не проходил незаметно, а отклонение одного не бросалось в глаза.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
repo | string | да | Репозиторий, на котором находится маркер. |
version | string | да | Версия, к которой относится маркер. |
recorded | логическая | да | Прошла ли проверку собственная подпись маркера и, следовательно, содержит ли его индекс. |
severity | const “warning” или const “error” или const “retracted” | нет | Насколько сильно действует маркер. Допустимые значения: "warning" — Устарела, на более мягком из двух рекомендательных уровней: по-прежнему выбирается при выборе версии. "error" — Устарела, на более строгом из двух рекомендательных уровней: по-прежнему выбирается при выборе версии. "retracted" — Отозвана: исключается при выборе версии. |
reason | string | нет | Причина, по которой версия устарела. |
Дополнительные свойства не допускаются.
HostUpdate
Что сделало обновление индекса для одного реестра.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
host | string | да | Хост реестра, который был обновлён. |
indexed | integer | да | Сколько записей было записано. |
deprecationsExamined | логическая | да | Искал ли обход маркеры устаревания вообще. Это поле отделено от счётчика, потому что «этот реестр не опубликовал ни одного» и «у этого запуска не было оснований судить о них» — разные факты. |
deprecationsRecorded | integer | да | Сколько маркеров было учтено. |
skipped | SkippedRepo[] или null | да | Репозитории, пропущенные при обходе. |
deprecations | DeprecationNote[] или null | да | Маркеры, встреченные при обходе. |
readsRetried | integer | да | Сколько чтений обхода реестр отклонил или оборвал по ходу так, что они были запрошены повторно; каждое чтение считается один раз, сколько бы попыток оно ни потребовало и независимо от того, завершилось ли оно затем успешно; ноль, если таких не было. Обход, все чтения которого в итоге завершились успешно, не перечисляет ни одного репозитория в skipped, поэтому именно этот счётчик показывает, насколько близко обход подошёл к тому, чтобы пропустить какой-либо. Минимум: 0. |
error | string | нет | Что не удалось для этого хоста, чтобы обход нескольких хостов сообщал, какие из них дали сбой, без сопоставления на стороне вызывающего. |
unreachable | логическая | нет | Был ли этот реестр недоступен: его имя не разрешилось, соединение с ним было отклонено или не открылось, либо не удалось установить защищённое соединение. Значение определяется по самому сбою, а не по error, задаётся только рядом с error и только там, где сбой показывает, что до реестра так и не удалось достучаться; если реестр ответил, что бы он ни ответил, поле отсутствует. |
Дополнительные свойства не допускаются.
PublishedVersion
Одна версия, которую индекс хранит для ссылки: дайджест манифеста, в который разрешился её тег при построении индекса; если политика доверия, под которой строился индекс, проверила собственную подпись версии, — подписант, которым она подтверждена; и, если что-либо это фиксирует, — когда версия была опубликована, вместе с источником этих сведений. Подписант отсутствует у версии без подписи, у версии, ни одна подпись которой не прошла проверку, и там, где эта политика не закрепляет ни открытый ключ, ни доверенное удостоверение или отключает проверку подписей. Ни один из этих случаев не даёт оснований называть подписанта, и его отсутствие больше ничего не означает. Дата публикации отсутствует, если публикация её не указала и ни одна бесключевая подпись, проверенная этой политикой, её не фиксирует.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
version | string | да | Версия в том виде, как её называет тег. |
manifestDigest | string | да | Дайджест манифеста, в который разрешился тег версии при построении индекса; он адресует версию по байтам, на которые она указывает, а не по тегу. |
signer | VerifiedSignature | нет | Подпись, прошедшая проверку по политике доверия реестра: как она проверена, каким подписантом подтверждена и дайджест прошедшего проверку пакета подписи. |
publishedAt | string | нет | Когда версия была опубликована, в виде метки времени RFC 3339 в UTC с точностью до секунды. Её источник указан в publishedAtSource, и оба поля присутствуют либо вместе, либо не присутствуют вовсе. |
publishedAtSource | const “transparency-log” или const “publisher” | нет | Откуда взято publishedAt, чтобы время, которое удостоверяет журнал прозрачности, никогда не принималось за время, которое заявляет издатель. Набор закрыт. Допустимые значения: "transparency-log" — Время, когда журнал прозрачности записал бесключевую подпись версии; политика доверия, по которой строился индекс, проверила его вместе с подписанным обещанием журнала об этом времени. Для версии, подписанной при публикации, это время публикации; для подписанной позже — время создания этой подписи. "publisher" — Время, которое публикация заявила рядом с опубликованным, по собственным часам публикующей машины. Ничто его не удостоверяет. Публикация заявляет его, когда её подпись не несёт удостоверенного времени: при подписи с ключом или при отсутствии подписи. Если прикреплено несколько, берётся самое раннее. |
Дополнительные свойства не допускаются.
VerifiedSignature
Подпись, прошедшая проверку по политике доверия реестра: как она проверена, каким подписантом подтверждена и дайджест прошедшего проверку пакета подписи.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
bundleDigest | string | да | Дайджест прошедшего проверку пакета подписи: sha256: и 64 шестнадцатеричных символа в нижнем регистре. |
identity | string | нет | Подписант, которым подтверждена подпись: для бесключевой подписи — удостоверение, на которое выдан подписывающий сертификат, то есть его альтернативное имя субъекта; для подписи с ключом — keyed:sha256: и шестнадцатеричный SHA-256 в нижнем регистре от PEM-текста закреплённого открытого ключа. |
issuer | string | нет | Издатель OIDC, записанный в подписывающем сертификате, для бесключевой подписи. Для подписи с ключом отсутствует. |
mode | const “keyless” или const “keyed” | да | Как была проверена подпись. Набор закрыт. Допустимые значения: "keyless" — По сертификату подписи, идентичность и издатель которого совпадают с доверенными политикой, который выстраивает цепочку до корня доверия, закреплённого политикой, или, если она его не закрепляет, до общедоступного корня Sigstore, и подпись которого записана в журнале прозрачности. "keyed" — По открытому ключу, закреплённому политикой. |
Дополнительные свойства не допускаются.
RegistrySearchRecord
Одна запись, найденная поиском, в том виде, в каком её хранит локальный индекс, а также какие из её версий объявлены устаревшими опубликованным маркером.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
uri | string | да | Ссылка, из которой разрешается запись. |
name | string | да | Имя сущности. |
version | string | да | Версия, по которой индексирована запись. |
versions | string[] | нет | Все версии, которые индекс хранит для этой ссылки. |
kind | string | нет | Вид сущности. |
description | string | нет | Назначение сущности. |
category | string | нет | Категория, в которой опубликована сущность. |
labels | map of string | нет | Метки, объявленные сущностью. |
pluginType | string | нет | Сокет, к которому подключается запись плагина. |
capabilities | string[] | нет | Возможности, объявленные записью плагина. |
manifestDigest | string | нет | Дайджест опубликованного манифеста. |
listingDigest | string | нет | Дайджест листинга, из которого прочитана запись. |
deprecations | object[] | нет | Маркеры устаревания, которые индекс содержит для этой ссылки, каждый с версией, к которой он относится, и самим проверенным маркером. |
published | PublishedVersion[] | нет | Все версии, которые индекс хранит для этой ссылки, в том же порядке, что и versions, каждая с дайджестом манифеста, в который разрешился её тег при построении индекса; с проверенным подписантом, если политика доверия, под которой строился индекс, проверила собственную подпись этой версии; и, если что-либо это фиксирует, с датой публикации и её источником. Версия, записанная без подписанта, не несёт подписи, проверенной этой политикой, и больше о ней ничего не сообщается. Для этого из реестра читаются только манифесты, вложения подписей и вложения дат публикации; содержимое сущностей не загружается. |
retracted | string[] | нет | Версии, объявленные устаревшими опубликованным маркером. |
Дополнительные свойства не допускаются.
RegistrySearchIndex
Актуальность одного хоста, по которому выполнялся поиск.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
host | string | да | Хост, по индексу которого выполнялся поиск. |
lastUpdated | string | нет | Когда индекс последний раз обновлялся. Если в снимке нет времени, поле отсутствует, а не равно нулю, чтобы вызывающая сторона могла отличить «не записано» от начала эпохи. |
Дополнительные свойства не допускаются.
EffectiveConfigurationSetting
Одна разрешённая настройка и документ, из которого она взята.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
field | string | да | Настройка. |
value | string | да | Разрешённое значение. |
source | string | да | Откуда взято значение. |
Дополнительные свойства не допускаются.
ImportedFile
Один файл, который записывает импорт: черновик документа или запись о том, что записал импорт.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
path | string | да | Расположение файла в виде пути относительно outputDir ответа. |
content | string | да | Текст файла. |
Дополнительные свойства не допускаются.
ImportDrift
Одна часть, которую синхронизация привела в соответствие с источником или привела бы при dryRun.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
change | string | да | Как разошлась часть: added — для части, появившейся в источнике; removed — для удалённой из него; changed — для изменённой в нём. |
file | string | да | Черновой файл, в котором находится часть, в виде пути относительно outputDir ответа. |
key | string[] | да | Ключи, ведущие к части от верхнего уровня черновика Aggregate или Release, по одному элементу на ключ, так что ключ с точкой остаётся одним элементом. Пусто, если часть — весь файл. |
Дополнительные свойства не допускаются.
ImportOwed
Значение, которое черновики всё ещё оставляют пустым, которое не смог предоставить ни один источник и не предоставил ни один ответ.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
file | string | да | Черновой файл, в котором находится значение, как путь относительно outputDir ответа. |
key | string[] | да | Ключи, ведущие к значению от начала этого документа, по одной записи на ключ, так что ключ, содержащий точку, остаётся одной записью. Ответ, отправленный как answered, называет значение этими ключами. |
question | string | да | Чем является значение: описание его схемы, иначе комментарий, который черновик записывает над его ключом, иначе то, что, согласно его схеме, оно принимает. |
sensitive | логическая | да | Является ли значение значением секрета, ответ для которого называет, откуда берётся секрет, и никогда не содержит сам секрет. |
secretAdvice | string | нет | Присутствует у значения секрета: каким должен быть ответ на него, в предложении, которое показывают человеку, отвечающему на него в терминале, — или, если ответ, отправленный для него как answered, был отклонён, почему он был отклонён. |
Дополнительные свойства не допускаются.
ImportAnswered
Один ответ для значения, перечисленного в owed ответа.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
file | string | да | Черновой файл, в котором находится значение, как его называет owed. |
key | string[] | да | Ключи, ведущие к значению, как их называет owed. |
answer | string | да | Ответ. Пустой ответ оставляет значение непредоставленным. |
Дополнительные свойства не допускаются.
ImportDiagnostic
Одно, что преобразование не смогло преобразовать. Это самый полезный результат преобразования, поэтому такие сведения сообщаются полностью, а не сводятся к вердикту.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
severity | string | да | Насколько это серьёзно. |
message | string | да | Что не удалось преобразовать. |
code | string | нет | Имя условия для цитирования, если оно есть. |
Дополнительные свойства не допускаются.
ImportDecision
Как преобразование сопоставило один узел источника: какие Components каталога рассматривал импортёр, какой выбрал, почему и как заменить выбор.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
sourceNode | DecisionSourceNode | да | Узел источника, к которому относится решение о сопоставлении. |
candidates | ImportCandidate[] | нет | Components каталога, которые импортёр рассматривал для узла, каждый со своей оценкой. Отсутствует, если он не рассматривал ни одного. |
chosen | DecisionChoice | нет | Что импортёр выбрал для узла источника. Отсутствует в решении, где выбор не был сделан. |
rationale | string | нет | Почему импортёр сделал этот выбор, его собственными словами. Отсутствует, если он ничего не написал. |
swapHint | string | нет | Как заменить выбор альтернативой, словами самого импортёра. Отсутствует, если он ничего не написал. |
Дополнительные свойства не допускаются.
DecisionSourceNode
Узел источника, к которому относится решение о сопоставлении.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
id | string | да | Идентификатор узла в источнике. |
type | string | да | Тип узла в том виде, как его называет источник. |
paramsSummary | string | да | Сводка параметров узла для показа рядом с решением. |
Дополнительные свойства не допускаются.
ImportCandidate
Одна сущность Component каталога, которую импортёр рассматривал для узла источника.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
componentName | string | да | Имя сущности Component. |
score | number | да | Насколько хорошо Component соответствует узлу по оценке импортёра. |
tier | string | да | Уровень соответствия, в который попадает оценка. |
signals | CandidateSignals | да | Вклад каждого из сигналов импортёра в оценку кандидата. |
Дополнительные свойства не допускаются.
CandidateSignals
Вклад каждого из сигналов импортёра в оценку кандидата.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
table | number | да | Вклад сигнала таблицы сопоставлений. |
category | number | да | Вклад сигнала категории. |
domainLabels | number | да | Вклад сигнала доменных меток. |
shape | number | да | Вклад сигнала формы. |
name | number | да | Вклад сигнала имени. |
Дополнительные свойства не допускаются.
DecisionChoice
Что импортёр выбрал для узла источника. Отсутствует в решении, где выбор не был сделан.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
target | string | да | Имя выбранной сущности Component: существующей Component каталога или созданной в черновике для узла. |
mode | string | да | Как записан выбор: как ссылка на существующую сущность Component или как новый черновик. |
tier | string | да | Уровень соответствия выбора. |
Дополнительные свойства не допускаются.
LintFileFindings
Что проверка соглашений обнаружила в одном документе.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
file | string | да | Документ. |
diagnostics | Diagnostic[] или null | да | Обнаруженное в нём. |
Дополнительные свойства не допускаются.
PluginRetractionExclusion
Одна версия, которая была доступна, но не выбрана.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
version | string | да | Пропущенная версия. |
reason | string | нет | Почему он был пропущен. |
Дополнительные свойства не допускаются.
PluginRetractionProvenance
Откуда получены сведения о том, что устарело.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
source | string | да | Что было использовано. |
lastUpdated | string | нет | Когда это последний раз обновлялось. |
Дополнительные свойства не допускаются.
PluginRetraction
Как маркер устаревания повлиял на то, какая версия плагина была закреплена.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
reference | string | да | Ссылка, к которой относятся версии. |
selected | string | нет | Закреплённая версия. |
excluded | PluginRetractionExclusion[] | нет | Версии, которые были доступны и пропущены. |
unscreened | string | нет | Что не удалось проверить по маркеру и почему. |
provenance | PluginRetractionProvenance | нет | Откуда получены сведения о том, что устарело. |
Дополнительные свойства не допускаются.
PluginGeneratedDocument
Один документ каталога, созданный генерацией.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
path | string | да | Расположение документа в виде пути относительно корня рабочего пространства. |
content | string | да | Текст документа. |
Дополнительные свойства не допускаются.
PluginCommandFlag
Один флаг, который плагин объявляет для предоставляемой им команды.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
name | string | да | Длинное имя флага. |
shorthand | string | нет | Односимвольный псевдоним флага, если он есть. |
description | string | нет | Однострочная справка по флагу. |
type | string | нет | Тип значения флага. |
default | string | нет | Значение, используемое, когда флаг не передан. |
Дополнительные свойства не допускаются.
PluginCLICommand
Одна команда верхнего уровня, которую предоставляет плагин.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
name | string | да | Глагол команды. |
description | string | нет | Однострочная справка по команде. |
flags | PluginCommandFlag[] | нет | Флаги команды в порядке объявления. |
Дополнительные свойства не допускаются.
ConfigCapturedAttachment
Одно подключение, которое фиксация записала в собственную конфигурацию этого рабочего пространства.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
uri | string | нет | Ссылка, из которой разрешается подключение. |
capability | string | нет | Возможность, для которой предназначено подключение. |
function | string | нет | Экспорт, которому передаётся подключение. |
role | string | нет | Роль, в которой работает подключение; она определяет, что оно может выдавать. |
Дополнительные свойства не допускаются.
ConfigCapturedSocket
Один сокет, записанный фиксацией, вместе с зафиксированными на нём подключениями.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
socket | string | да | Сокет. |
field | string | да | Поле конфигурации, под которым записан сокет. |
attachments | ConfigCapturedAttachment[] или null | да | Подключения, зафиксированные на нём. |
Дополнительные свойства не допускаются.
ExplainErrorEntry
Один опубликованный фрагмент, объясняющий, как исправить условие при написании.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
heading | string | да | Заголовок фрагмента. |
body | string | да | Фрагмент. |
Дополнительные свойства не допускаются.
SignedArtifact
Один опубликованный артефакт, охваченный подписанием.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
reference | string | да | Подписанная ссылка. |
digest | string | да | Дайджест подписанного. |
Дополнительные свойства не допускаются.
DeprecationMarked
Одна опубликованная версия, помеченная как устаревшая.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
reference | string | да | Помеченная ссылка. |
severity | const “warning” или const “error” или const “retracted” | да | Насколько сильно действует маркер. Допустимые значения: "warning" — Устарела, на более мягком из двух рекомендательных уровней: по-прежнему выбирается при выборе версии. "error" — Устарела, на более строгом из двух рекомендательных уровней: по-прежнему выбирается при выборе версии. "retracted" — Отозвана: исключается при выборе версии. |
issuedOn | string | да | Когда был выпущен маркер. |
digest | string | да | Дайджест опубликованного маркера. |
Дополнительные свойства не допускаются.
InitializeResult
О чём сеанс договорился с этим клиентом и из какого слоя конфигурации это было разрешено.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
capabilities | ServerCapabilities | да | Что демон будет делать в этом сеансе, согласованное с тем, что, по словам клиента, он способен обработать. |
workspaceRoot | string | да | Рабочее пространство, над которым открыт сеанс. |
configSource | string | да | Из какого слоя конфигурации сеанс разрешил свои настройки. |
workspaceMarker | string | нет | Файл, определивший корень рабочего пространства, если такой был. |
version | string | да | Версия исполняемого файла, обслуживающего этот сеанс: то же значение, которое aggrega version сообщает для этого файла. Она описывает запущенный процесс, поэтому после замены файла, из которого был запущен демон, здесь по-прежнему указана работающая версия, тогда как запрос к файлу укажет версию, которая его заменила. |
Дополнительные свойства не допускаются.
ValidateResult
Что обнаружила проверка и какой объём был проверен.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
diagnostics | Diagnostic[] или null | да | Найденные проблемы. Если проверка ничего не нашла, значение равно null, а не пустому списку. |
checked | string | нет | Какой объём был проверен — один документ или всё содержимое рабочего пространства. |
Дополнительные свойства не допускаются.
InvalidateResult
Хранил ли демон что-либо о документе, что нужно было сбросить.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
invalidated | логическая | да | Было ли что-либо сброшено. |
Дополнительные свойства не допускаются.
DiagnosticsResult
Найденные проблемы, которые демон уже хранит для документа.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
diagnostics | Diagnostic[] или null | да | Найденные проблемы. Если их нет, значение равно null, а не пустому списку. |
Дополнительные свойства не допускаются.
IrGraphResult
Разрешённый граф, в который компилируется Release.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
graph | любой | да | Документ графа. Значения, которые автор объявил чувствительными, в нём скрыты, если запрос не запросил их с помощью unredacted; всё остальное передаётся так, как его выдал компилятор. Его собственная структура — опубликованный контракт графа, и здесь она не повторяется. |
Дополнительные свойства не допускаются.
BuildResult
Что записала сборка.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
outputDirectory | string | да | Каталог, в который были записаны артефакты. |
files | string[] или null | да | Записанные артефакты в виде путей относительно выходного каталога. |
notices | BuildNotice[] | нет | Всё, что сборка хочет сообщить вызывающей стороне и что не является ни найденной проблемой, ни сбоем. |
dependencyResolution | DependencyResolutionReport | нет | Что разрешение зависимостей закрепило и получило. |
Дополнительные свойства не допускаются.
BuildPreviewResult
Что записала бы сборка. Ничего не было записано, поэтому выходного каталога, который можно было бы назвать, нет.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
files | string[] или 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[] или null | да | Сущности, которых достигает замыкание. |
libraries | ClosureEntity[] или null | да | Библиотеки, которых достигает замыкание. |
plugins | ClosureEntity[] или null | да | Плагины, которых достигает замыкание. |
mappingDiagnostics | string[] или null | да | Что сообщило разрешение сопоставлений Manifest. |
deprecations | string[] или null | да | Маркеры устаревания, встреченные замыканием. |
Дополнительные свойства не допускаются.
ResolveDependenciesResult
Что разрешение зависимостей закрепило и получило, а также всё, что оно хочет сообщить вызывающей стороне. Собственные поля отчёта находятся непосредственно в этом ответе, а не вложены в один из его членов.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
lockfile | string | да | Lock-файл, записанный разрешением, или тот, с которым сравнивала проверка. |
verified | логическая | нет | Был ли запрос проверкой, которая сравнила записанный lock-файл и не записала ни lock-файл, ни запись доверия к плагинам, ни entity.lock. |
entities | ClosureEntity[] или null | да | Сущности, закреплённые разрешением или сравнённые проверкой. |
libraries | ClosureEntity[] или null | да | Библиотеки, закреплённые разрешением или сравнённые проверкой. |
plugins | ClosureEntity[] или null | да | Плагины, закреплённые разрешением или сравнённые проверкой. |
sourceArtifacts | integer | да | Сколько исходных артефактов получено. |
trustedPlugins | integer | да | Сколько закреплённых плагинов имели проверенную подпись. |
toolchain | ToolchainReport | нет | Компилятор, выбранный при разрешении, и встроенные в него плагины. |
externalInputs | integer | да | Сколько внешних входных данных, используемых рендерингом, получено. |
incompleteExternalInputs | string | нет | Какие внешние входные данные не удалось получить, если такие есть. |
notices | string[] | нет | Всё, что разрешение хочет сообщить вызывающей стороне. |
Дополнительные свойства не допускаются.
PinResult
Что шаг закрепления сделал с lock-файлом рядом с сущностью или сделал бы при пробном запуске. Это ответ на aggrega/pin, и публикация, выполнившая этот шаг, содержит его как свой pin.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
entity | string | да | Документ сущности, прочитанный шагом, в виде пути относительно корня рабочего пространства. |
kind | string | да | Вид сущности, как его объявляет её документ. |
name | string | да | Имя сущности, как его объявляет её документ. |
pinnable | логическая | да | Читает ли сущность этого вида что-либо, для чего lock-файл записывает закрепление, как это делают Recipe и FeatureRecipe. Если значение false, ничего рядом с сущностью не затрагивалось, changed равно false, а lock, removed, pins и content отсутствуют. |
lock | string | нет | Lock-файл, который шаг записал или записал бы, в виде пути относительно корня рабочего пространства. |
changed | логическая | да | Изменился ли lock-файл или изменился бы при пробном запуске. False, если lock-файл уже содержал все закрепления, нужные сущности, и остался побайтово идентичным. |
removed | логическая | нет | Является ли изменение удалением: сущность не читает ничего, для чего lock-файл записывает закрепление, поэтому рядом с ней не остаётся lock-файла. |
dryRun | логическая | нет | Сообщает ли это, что шаг сделал бы, а не что он сделал. |
pins | PinClassCount[] | нет | Сколько закреплений каждого класса содержит lock-файл после шага или содержал бы после пробного запуска. Перечисляются все классы, которые может содержать lock-файл, включая классы без закреплений. |
content | string | нет | Lock-файл, который записал бы пробный запуск. Отсутствует, если lock-файл остался бы без изменений или был бы удалён, а также в любом ответе, который не относится к пробному запуску. |
Дополнительные свойства не допускаются.
PinClassCount
Сколько закреплений одного класса содержит lock-файл.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
class | string | да | Класс закрепления в тех словах, которые использует отказ, называющий отсутствующее закрепление, — например, remote source или imported file. |
pins | integer | да | Сколько закреплений этого класса содержит lock-файл. |
Дополнительные свойства не допускаются.
CacheStatusResult
Что содержат кэши, обслуживающие это рабочее пространство.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
classes | CacheClass[] или null | да | Каждый кэш и его содержимое. |
provenance | CacheProvenance[] или null | да | Под какими удостоверениями были получены кэшированные артефакты. |
totalCount | integer | да | Сколько всего записей содержат кэши. |
totalSize | integer | да | Сколько всего байт они занимают. |
totalSizeText | string | да | Тот же итог в удобном для человека виде. |
scope | CacheScope | да | Область действия ответа о кэше. Два класса кэша общие для всех проектов на машине, поэтому каждый ответ о кэше указывает, какие из них он затронул, — иначе сеанс, открытый для одного рабочего пространства, воспринимался бы как сообщающий только об этом рабочем пространстве. |
Дополнительные свойства не допускаются.
CachePruneResult
Что очистка удалила, что сохранила и что не смогла освободить.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
removed | CacheRemoval[] или null | да | Что было удалено. |
heldOpen | CacheRemoval[] или null | да | Что очистка удалила бы, но оставила на месте, потому что это было открыто другим процессом. Удалять открытый файл отказывается только Windows, поэтому на остальных системах этот список пуст. Эти записи не считаются ни удалёнными, ни сохранёнными, ни один их байт не учитывается как освобождённый, и их освобождает последующая очистка; запись, являющаяся каталогом, могла уже лишиться тех своих файлов, которые не были открыты. |
retainedCount | integer | да | Сколько записей сохранено. |
reclaimedBytes | integer | да | Сколько байт освобождено. |
reclaimedBytesText | string | да | То же значение в удобочитаемом для человека виде. |
unattributedCount | integer | да | Сколько записей не востребовано ни одним владельцем. |
unattributedSize | integer | да | Сколько байт они занимают. |
unattributedSizeText | string | да | То же значение в удобочитаемом для человека виде. |
notPruneEligible | CacheShortfall[] или null | да | Что осталось и что позволило бы это освободить. |
scope | CacheScope | да | Область действия ответа о кэше. Два класса кэша общие для всех проектов на машине, поэтому каждый ответ о кэше указывает, какие из них он затронул, — иначе сеанс, открытый для одного рабочего пространства, воспринимался бы как сообщающий только об этом рабочем пространстве. |
Дополнительные свойства не допускаются.
CacheEvictResult
Что удалило освобождение до заданного размера и что осталось.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
withinCapBefore | логическая | да | Укладывалось ли содержимое уже в заданный размер, так что ничего удалять не потребовалось. |
removed | CacheRemoval[] или null | да | Что было удалено. |
heldOpen | CacheRemoval[] или null | да | Что освобождение удалило бы, но оставило на месте, потому что это было открыто другим процессом; вместо этого оно перешло к следующей по давности записи. Удалять открытый файл отказывается только Windows, поэтому на остальных системах этот список пуст. Эти записи по-прежнему учитываются в оставшихся байтах, и последующее освобождение может их удалить. |
totalBefore | integer | да | Сколько байт было занято до этого. |
totalBeforeText | string | да | То же значение в удобочитаемом для человека виде. |
reclaimedBytes | integer | да | Сколько байт освобождено. |
reclaimedBytesText | string | да | То же значение в удобочитаемом для человека виде. |
remainingBytes | integer | да | Сколько байт осталось. |
remainingBytesText | string | да | То же значение в удобочитаемом для человека виде. |
capBytes | integer | да | Размер в байтах, до которого выполнялось освобождение. |
capBytesText | string | да | Тот же размер в удобочитаемом для человека виде. |
scope | CacheScope | да | Область действия ответа о кэше. Два класса кэша общие для всех проектов на машине, поэтому каждый ответ о кэше указывает, какие из них он затронул, — иначе сеанс, открытый для одного рабочего пространства, воспринимался бы как сообщающий только об этом рабочем пространстве. |
Дополнительные свойства не допускаются.
CacheClearResult
Что освободило опустошение кэшей.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
cleared | CacheCleared[] или null | да | Каждый опустошённый кэш. |
reclaimedBytes | integer | да | Сколько байт освобождено. |
reclaimedBytesText | string | да | То же значение в удобочитаемом для человека виде. |
scope | CacheScope | да | Область действия ответа о кэше. Два класса кэша общие для всех проектов на машине, поэтому каждый ответ о кэше указывает, какие из них он затронул, — иначе сеанс, открытый для одного рабочего пространства, воспринимался бы как сообщающий только об этом рабочем пространстве. |
Дополнительные свойства не допускаются.
RegistryListResult
Реестры, через которые выполняется разрешение в этом рабочем пространстве.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
registries | Registry[] или null | да | Каждый настроенный реестр. |
credentialStateIsMachineWide | логическая | да | Является ли указанное для каждого реестра наличие учётных данных фактом уровня всей машины, а не рабочего пространства. Это сообщается, чтобы ответ в рамках сеанса не воспринимался как отрицание более широкого охвата. |
Дополнительные свойства не допускаются.
SearchResult
Что локальные индексы реестров предложили по запросу поиска.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
records | RegistrySearchRecord[] или null | да | Совпавшие записи. |
indexes | RegistrySearchIndex[] или null | да | Каждый просмотренный хост и время последнего обновления его индекса. |
missingIndexHosts | string[] или null | да | Настроенные хосты без локального индекса для поиска — чтобы скудный ответ был объяснён, а не оставлен на догадки. |
stale | логическая | да | Устарел ли какой-либо из просмотренных индексов настолько, что его стоит обновить. |
registriesConfigured | логическая | да | Настроен ли вообще хоть один реестр; это отличает «ничего не совпало» от «поиск не выполнялся». |
Дополнительные свойства не допускаются.
RegistryAddResult
Что записала регистрация реестра, куда и что она прочитала из самого реестра.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
host | string | да | Хост, под которым хранится запись; его написание не всегда совпадает с использованным в запросе. |
scope | ConfigWriteScope | да | Какой документ конфигурации был записан и какова область его действия. Запрос указывает одно рабочее пространство, поэтому ответ без этих сведений воспринимался бы как относящийся к этому рабочему пространству, а для записи на уровне всей машины такое прочтение неверно. |
trust | TrustFetchOutcome | да | Результат чтения политики доверия, которую объявляет реестр. Исходы разделены, потому что означают разное: объявленная политика принята; реестр ничего не объявил — и это не сбой; вместо неё закреплена встроенная базовая политика; или чтение не предпринималось. Если ничего не объявлено, рядом указывается, удалось ли вообще связаться с реестром. |
Дополнительные свойства не допускаются.
RegistryRemoveResult
Что записало удаление реестра и куда.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
host | string | да | Хост, запись которого была удалена. |
scope | ConfigWriteScope | да | Какой документ конфигурации был записан и какова область его действия. Запрос указывает одно рабочее пространство, поэтому ответ без этих сведений воспринимался бы как относящийся к этому рабочему пространству, а для записи на уровне всей машины такое прочтение неверно. |
Дополнительные свойства не допускаются.
RegistryUpdateResult
Что сделало обновление локальных индексов для каждого хоста.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
hosts | HostUpdate[] или null | да | Что обновление сделало для каждого хоста. |
failed | string[] или null | да | Хосты, для которых обновление не удалось завершить. |
indexRoot | string | да | Каталог, в который были записаны индексы. |
registriesConfigured | логическая | да | Настроен ли вообще хоть один реестр. |
reachedRegistries | логическая | да | В этом ответе всегда true: обновление индексов обращается к самим реестрам, тогда как их перечисление и поиск отвечают на основе конфигурации и локального индекса. Был ли конкретный реестр действительно доступен, указывается в его собственной записи в hosts полем unreachable. |
Дополнительные свойства не допускаются.
LogoutResult
Какие сохранённые учётные данные были удалены и каков охват хранилища.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
registry | string | да | Реестр, учётные данные которого были удалены. |
scope | CredentialStoreScope | да | Область действия изменения учётных данных. Хранилище общее для всех проектов на машине и для всех других инструментов, обращающихся к тем же реестрам, поэтому ответ сообщает об этом, а не оставляет догадываться, будто изменение ограничено сеансом. |
Дополнительные свойства не допускаются.
PublishEntityResult
Что и куда поместила публикация сущности. Публикация, которая сначала выполнила шаг закрепления, также содержит результат этого шага в виде 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 | нет | Что шаг закрепления сделал с lock-файлом рядом с сущностью или сделал бы при пробном запуске. Это ответ на aggrega/pin, и публикация, выполнившая этот шаг, содержит его как свой pin. |
wholeDirectorySource | string | нет | Локальный источник сущности в авторском виде; присутствует, когда он записан как шаблон. Такой источник указывает свой каталог только после того, как Release заполнит шаблон, поэтому публикация содержит все файлы каталога сущности, а не только файлы, которые называет сущность. Отсутствует, если публикация содержит только эти файлы. |
windowsUnusableEntries | string[] | нет | Записи опубликованного архива, путь которых содержит часть, недопустимую в Windows в записанном виде, — имя, зарезервированное Windows для устройства, например CON, AUX или NUL, в любом регистре и с любым последующим расширением, или часть, оканчивающуюся точкой или пробелом: сначала собственное имя файла документа сущности, затем содержащиеся в нём файлы. Рабочее пространство в Windows отказывается их распаковывать и потому не может использовать эту версию; публикация продолжается или останавливается точно так же, как без них. Отсутствует, если таких нет, в том числе для сущности, опубликованной только своим документом. |
Дополнительные свойства не допускаются.
PublishArtifactResult
Что и куда поместила публикация файла.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
reference | string | да | Ссылка, под которой опубликован файл. |
tag | string | да | Тег, под которым выполнена публикация. |
mediaType | string | да | Тип носителя, записанный для опубликованных байтов. |
size | integer | да | Сколько байтов опубликовано. |
sizeText | string | да | Тот же размер в удобочитаемом для человека виде. |
digest | string | да | Дайджест опубликованного. |
alreadyPublished | логическая | да | Были ли те же байты уже на месте, так что содержимое не загружалось. Дата публикации прикреплена рядом только там, где у артефакта её не было. |
dryRun | логическая | да | Сообщает ли этот ответ о том, что поместила бы публикация, а не о том, что она сделала. |
reach | PublicationReach | да | Насколько далеко распространилась публикация. Эти ответы выходят далеко за пределы этой машины — то, что они прикрепляют, разрешает каждый потребитель этого реестра, — поэтому каждый называет каждый реестр, к которому обращался, и то, прикрепил ли вызов там что-либо. |
Дополнительные свойства не допускаются.
SignArtifactsResult
Что было подписано и куда помещены подписи.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
signed | SignedArtifact[] или null | да | Каждая подписанная ссылка. |
reach | PublicationReach | да | Насколько далеко распространилась публикация. Эти ответы выходят далеко за пределы этой машины — то, что они прикрепляют, разрешает каждый потребитель этого реестра, — поэтому каждый называет каждый реестр, к которому обращался, и то, прикрепил ли вызов там что-либо. |
Дополнительные свойства не допускаются.
DeprecateArtifactResult
Что помечено как устаревшее и куда помещены отметки.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
marked | DeprecationMarked[] или null | да | Каждая помеченная версия. |
reach | PublicationReach | да | Насколько далеко распространилась публикация. Эти ответы выходят далеко за пределы этой машины — то, что они прикрепляют, разрешает каждый потребитель этого реестра, — поэтому каждый называет каждый реестр, к которому обращался, и то, прикрепил ли вызов там что-либо. |
Дополнительные свойства не допускаются.
ResolveResult
Где определено то, что находится под курсором.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
location | null или Location | да | Где это определено. Равно null, если ничто под курсором не разрешается в определение. |
Дополнительные свойства не допускаются.
FindReferencesResult
Где упоминается то, что находится под курсором.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
locations | Location[] или null | да | Каждое место, где это упоминается. |
Дополнительные свойства не допускаются.
FindImplementationsResult
Какие документы реализуют то, что находится под курсором.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
locations | Location[] или null | да | Каждое место, где это реализовано. |
Дополнительные свойства не допускаются.
HoverResult
Что показать о том, что находится под курсором.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
contents | null или MarkupContent | да | Что показать. Равно null, если о том, что под курсором, сказать нечего. |
Дополнительные свойства не допускаются.
CompletionResult
Что можно написать в позиции курсора.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
items | CompletionItem[] или null | да | Каждый вариант, который можно написать. |
Дополнительные свойства не допускаются.
CatalogIndexResult
Все сущности, которые содержит индекс рабочего пространства, а также ссылки, ведущие за пределы рабочего пространства, на каталоги и на файлы, которые для него не читались.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
entities | CatalogEntity[] или null | да | Каждая сущность. |
unreadLinkedDirs | string[] | да | Каждая ссылка под корнем рабочего пространства, ведущая в каталог за его пределами, названная относительно корня по месту, где находится сама ссылка, в порядке поиска по рабочему пространству. Ни один каталог за пределами корня не просматривается, поэтому ни один документ за такой ссылкой не попадает в entities как собственный документ рабочего пространства, и клиент, выводящий список сущностей, может объяснить почему. Не указываются: ссылка на каталог внутри корня, который просматривается или исключается там, где он фактически находится; ссылка везде, где каталог был бы исключён — по своему расположению, по имени или по .gitignore; ссылка, которую нельзя разрешить, потому что она никуда не ведёт или ведёт по циклу; и, в ответе, данном в терминах сущности Release, ссылка под каталогом каталога, который читают только другие Releases. Пусто, если в рабочем пространстве таких нет. |
unreadLinkedFiles | string[] | да | Каждая ссылка под корнем рабочего пространства, названная как YAML-файл, то есть с собственным именем, оканчивающимся на .yaml или .yml, и ведущая к файлу за пределами корня, названная относительно корня по месту, где находится сама ссылка, в порядке поиска по рабочему пространству. Такой файл не читается для индекса, что бы он ни объявлял, поэтому объявленная в нём сущность не попадает в entities как собственная сущность рабочего пространства, и клиент, выводящий список сущностей, может объяснить почему; сущности за пределами рабочего пространства читаются через настроенные каталоги каталога. Не указываются: ссылка на файл, который конфигурация рабочего пространства называет как Release — как build.authoring_release или как ключ workspace.releases — и который объявляет его: такой файл читается и указывается в entities на месте самой ссылки; ссылка на файл внутри корня, который читается на месте самой ссылки; ссылка, которую исключает .gitignore, или ссылка внутри каталога, исключённого поиском; ссылка, не ведущая ни к какому файлу — ни в каталог (его указывает unreadLinkedDirs, если он ведёт за пределы корня), ни куда-либо вообще, или ведущая по циклу; и, в ответе, данном в терминах сущности Release, ссылка под каталогом каталога, который читают только другие Releases. Файл конфигурации рабочего пространства, являющийся ссылкой за пределы рабочего пространства, — его собственный .aggrega-config.yaml или находящееся рядом наложение, принадлежащее CI, — указывается независимо от того, встретил ли его поиск, после ссылок, найденных поиском: конфигурация рабочего пространства тогда не читается вовсе, этот ответ — собственный индекс рабочего пространства, прочитанный без какой-либо настройки, поэтому для него не читается ни один каталог каталога, и каждый запрос, который определяет конфигурация, включая индекс в терминах сущности Release, отклоняется для этого рабочего пространства с условием блокировки чтения. Пусто, если в рабочем пространстве таких нет. |
Дополнительные свойства не допускаются.
AttachCandidatesResult
Какие Features можно присоединить к сущности и метки, по которым они оценивались; а для соединения, названного в запросе, — слоты, которые объявляет его сокет, вместе с Features, которые могут заполнить каждый из них.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
node | string | да | Сущность, для которой оценивались кандидаты. |
nodeLabels | map of string или null | да | Метки, по которым выполнялась оценка. |
labelSource | string | да | Какой набор меток использовался, и это не косметическая деталь: объявленные метки документа — то, что видно при чтении исходного кода, а метки узла графа — окончательный набор, по которому оценивает сама сборка. Ответ, вычисленный по второму, — утверждение о том, что сделает сборка. |
candidates | SourcedEntityRef[] или 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[] или null | да | Каждый сокет и то, что можно к нему подключить. |
Дополнительные свойства не допускаются.
InsertionPointResult
Где в документе должна находиться новая запись под названным контейнером и что нужно клиенту, чтобы записать её туда: сама точка, должен ли текст начинаться с переноса строки, ещё отсутствующие ключи контейнера и отступ каждой строки.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
file | string | да | Документ. |
container | string[] или null | да | Путь по документу к контейнеру. |
positionEncoding | string | да | Кодировка, в которой выражены позиции в этом ответе. |
position | Position | да | Место в документе: строка и смещение символа в ней, оба с отсчётом от нуля. Смещение измеряется в единицах кодировки, согласованной сеансом при открытии, — это UTF-16, если клиент не запросил другую. |
precededByLineBreak | логическая | да | Должен ли текст, записываемый в позиции, начинаться с переноса строки, потому что позиция находится в конце строки, уже имеющейся в документе. Значение false только там, где в документе нет ничего, за чем следовала бы запись. |
missingContainerKeys | string[] или null | да | Сегменты пути контейнера, которых в документе ещё нет, начиная с внешнего. Каждый нужно записать отдельным ключом с отступом на один шаг больше предыдущего, прежде чем запись можно будет поместить во внутренний. Значение null, если весь путь уже есть. |
entryIndent | integer | да | Столбец, с которого начинается первая строка самой записи, в пробелах от начала строки. |
indentStep | integer | да | На сколько больше отступ каждого уровня вложенности. |
indentStepMeasured | логическая | да | Измерен ли шаг по собственной вложенности этого документа. Если значение false, в документе нет вложенности для измерения и шаг является резервным, поэтому клиент, предпочитающий задать собственный, знает, что может это сделать. |
entryShape | const “mapping” или const “sequence” или const “unknown” | да | Форма, в которой контейнер хранит свои записи; именно она определяет, как составляется текст самой записи. Она считывается с контейнера, уже имеющегося в документе, и никогда не выводится из его названия. Набор закрыт. Допустимые значения: "mapping" — Контейнер является блочным отображением, поэтому добавляемая в него запись — это ключ и его значение. "sequence" — Контейнер является блочной последовательностью, поэтому добавляемая в него запись — это дефис и его значение. "unknown" — В документе нет контейнера или он пуст, поэтому форму записи определяет клиент. |
Дополнительные свойства не допускаются.
AttachmentContainerResult
В каком документе и где в нём должно находиться присоединение к узлу графа или к соединению, названному в запросе.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
node | string | да | Узел графа, для которого предназначено присоединение. |
file | string | да | Документ, в котором должно находиться присоединение. |
container | string[] или null | да | Путь по этому документу к месту, где оно должно находиться. |
Дополнительные свойства не допускаются.
ConnectionAtPositionResult
Соединение, внутри записи которого находится позиция, или причина, по которой соединение не сообщается. Присутствует ровно одна половина: graphNode и connection вместе или только noConnectionReason. Позиция в любом месте записи — на её псевдониме, цели или присоединениях — находится внутри этой записи, а при вложенных записях — внутри самой внутренней; позиция на собственном ключе сокета, над записями, написанными под ним, не находится ни в одной.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
graphNode | string | нет | Идентификатор узла, компонент которого задаёт соединение, в том виде, в каком он является ключом в скомпилированном графе, — значение, которое запросы кандидатов и контейнера принимают как 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" — Позиция находится на записи Release для соединения, которое провёл Feature, а прикрепление записывается только на соединении, которое проводит компонент или Release. "unknown-connection" — Позиция находится на записи, которую Release пишет для соединения, отсутствующего в скомпилированном графе. |
Дополнительные свойства не допускаются.
ReleaseCandidatesResult
Сущности Releases, которые содержит рабочее пространство, и ссылки, ведущие из него к каталогам и файлам, которые для них не были прочитаны.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
releases | string[] или null | да | Каждый документ Release. |
lockfiles | map of string | да | Lock-файл каждой перечисленной сущности Release с ключом по сущности Release точно в том виде, в каком она перечислена. Каждый из них — это файл, который pull записывает для этой сущности Release и который читает сборка, поэтому клиент читает, где он находится, а не вычисляет это сам. Пусто, если рабочее пространство не содержит ни одной сущности Release. |
unreadLinkedDirs | string[] | да | Каждая ссылка внутри корня рабочего пространства, ведущая к каталогу вне его, названная относительно корня по месту, где находится сама ссылка, в порядке поиска по рабочему пространству. Ни один каталог вне корня не просматривается, поэтому сущность Release, достижимая только через одну из этих ссылок, отсутствует в releases, и клиент, предлагающий Releases, может объяснить почему. Не называются: ссылка на каталог внутри корня, который просматривается или исключается там, где он фактически находится; ссылка там, где каталог был бы исключён — по своему расположению или по имени; и ссылка, которую невозможно разрешить, потому что она никуда не ведёт или образует цикл. Пусто, если в рабочем пространстве таких нет. |
unreadLinkedFiles | string[] | да | Каждая ссылка внутри корня рабочего пространства, названная как YAML-файл — её собственное имя оканчивается на .yaml или .yml, — и ведущая к файлу вне корня, названная относительно корня по месту, где находится сама ссылка, в порядке поиска по рабочему пространству. Такой файл не читается, поэтому сущность Release, достижимая только через одну из этих ссылок, отсутствует в releases, и клиент, предлагающий Releases, может объяснить почему. Является ли файл сущностью Release, без его чтения неизвестно, поэтому каждая такая ссылка называется независимо от содержимого файла. Не называются: ссылка на файл, который конфигурация рабочего пространства называет сущностью Release — как build.authoring_release или как ключ workspace.releases, — который читается и перечисляется в releases по собственному месту ссылки; ссылка на файл внутри корня, который читается; ссылка внутри каталога, исключаемого поиском; и ссылка, не ведущая ни к какому файлу — ни к каталогу, который unreadLinkedDirs называет там, где он выходит за пределы корня, ни куда-либо вообще, либо образующая цикл. Файл конфигурации рабочего пространства, являющийся ссылкой, ведущей за пределы рабочего пространства, — его собственный .aggrega-config.yaml или принадлежащий CI оверлей рядом с ним, — называется независимо от того, встретил ли его поиск, после ссылок, названных поиском: конфигурация рабочего пространства тогда не читается вовсе, этот ответ читается без какой-либо конфигурации, поэтому ни одна сущность Release, которую конфигурация называет через ссылку, не перечисляется, и каждый запрос, решаемый конфигурацией, отклоняется для этого рабочего пространства с условием удержания чтения. Пусто, если в рабочем пространстве таких нет. |
Дополнительные свойства не допускаются.
ActiveReleaseResult
С какой сущностью Release клиенту следует работать по умолчанию. Рабочее пространство, не указывающее ни на одну сущность Release, — это обычное состояние, а не сбой, поэтому оно сообщается здесь вместе с описанием того, как была предпринята попытка выбора, а не выдаётся как ошибка.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
release | string | да | Выбранная сущность Release или пустое значение, если ни одна не выбрана. |
lockfile | string | нет | Lock-файл выбранной сущности Release: файл, который pull записывает для неё и который читает сборка. Отсутствует, если ни одна сущность Release не выбрана. |
reason | string | нет | Почему ни одна сущность Release не была выбрана. |
trace | string | нет | Каждый шаг выбора и его результат, чтобы вызывающая сторона видела, какой из них решил бы выбор. |
Дополнительные свойства не допускаются.
EditDocumentResult
Что записала правка и куда. После записи прочитанное демоном представление документа сбрасывается, поэтому следующий ответ о нём вычисляется по байтам, созданным правкой.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
file | string | да | Отредактированный документ. |
edit | string | да | Какая правка была применена. |
container | string[] или null | да | Путь по документу к месту, куда попала правка. |
createdContainers | string[] или null | да | Контейнеры, которые правке пришлось создать по пути. |
written | string[] или null | да | Записанные документы. |
content | string | да | Составленный документ — для запроса, который просил показать результат, а не записать его. |
Дополнительные свойства не допускаются.
EffectiveConfigurationResult
Конфигурация, разрешённая рабочим пространством, и документ, из которого взята каждая настройка.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
layers | string[] или null | да | Объединённые документы конфигурации в порядке объединения. |
settings | EffectiveConfigurationSetting[] или null | да | Каждая разрешённая настройка и её источник. |
Дополнительные свойства не допускаются.
ConfigInitResult
Что записало создание начальной конфигурации, куда и что оно прочитало из реестра.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
host | string | да | Реестр, для которого создана начальная конфигурация. |
scope | ConfigWriteScope | да | Какой документ конфигурации был записан и какова область его действия. Запрос указывает одно рабочее пространство, поэтому ответ без этих сведений воспринимался бы как относящийся к этому рабочему пространству, а для записи на уровне всей машины такое прочтение неверно. |
trust | TrustFetchOutcome | да | Результат чтения политики доверия, которую объявляет реестр. Исходы разделены, потому что означают разное: объявленная политика принята; реестр ничего не объявил — и это не сбой; вместо неё закреплена встроенная базовая политика; или чтение не предпринималось. Если ничего не объявлено, рядом указывается, удалось ли вообще связаться с реестром. |
written | логическая | да | Был ли документ записан, а не возвращён вызывающей стороне для размещения. |
existed | логическая | нет | Присутствует и равно true, если документ уже существовал, поэтому запись реестра была объединена с ним, а не создан новый документ. Поверх существующего документа выполняется только запрос, передающий force, поэтому в ответах на другие запросы это свойство отсутствует. |
content | string | нет | Текст документа — для запроса, который просил показать его, а не записать. |
Дополнительные свойства не допускаются.
ConfigCaptureResult
Что фиксация разрешённой конфигурации записала в собственный документ этого рабочего пространства.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
configFile | string | да | Записанный документ. Это всегда собственный документ этого рабочего пространства, поскольку вся цель — сделать одно рабочее пространство самодостаточным. |
workspaceRoot | string | да | Рабочее пространство, указанное в запросе. |
captured | логическая | да | Было ли что-либо зафиксировано. |
sockets | ConfigCapturedSocket[] или null | да | Каждый зафиксированный сокет с его вложениями. |
catalogDirs | string[] или null | да | Зафиксированные каталоги каталога. |
Дополнительные свойства не допускаются.
ImportResult
Что получено при преобразовании внешнего источника и что преобразовать не удалось.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
format | string | да | Преобразованный исходный формат. |
outputDir | string | да | Каталог, относительно которого заданы все пути в ответе и в который были записаны файлы. |
written | string[] или null | да | Каждый файл, записанный на диск, в порядке записи: черновики, затем запись о том, что записал импорт. При sync — только черновики, изменённые синхронизацией, и запись, если она изменилась. Пусто при dryRun. |
files | ImportedFile[] или null | да | Каждый файл, который записывает запрос, с его текстом, при dryRun и без него: каждый черновик, затем запись о том, что записал импорт. При sync — каждый черновик, изменяемый синхронизацией, с новым текстом, затем запись, если она тоже меняется, поэтому синхронизация без расхождений возвращает пустой список. |
drift | ImportDrift[] | да | Каждая часть, которую синхронизация привела в соответствие с источником (или привела бы при dryRun), в порядке, в котором их называет черновик; черновой файл, удаляемый синхронизацией, — одна из них, удалённая без ключей. Пустой список для запроса, не являющегося синхронизацией, для синхронизации без расхождений и для синхронизации, преобразование в которой остановилось и которая ничего не записывает. |
diagnostics | ImportDiagnostic[] или null | да | Что не удалось преобразовать. |
decisions | ImportDecision[] | да | Как импортёр сопоставил каждый исходный узел, в порядке импортёра и точно так, как он это сообщил: то, что показывает, где преобразование действовало наугад. Передаётся при обоих способах доставки и независимо от того, остановилось ли преобразование; пустой список для импортёра, который ничего не сообщает. |
owed | ImportOwed[] | нет | Каждое значение, которое черновики по-прежнему оставляют пустым и которое не смог предоставить ни один источник и не предоставил ни один ответ, в порядке записи черновиков — значения, которые называют находки уровня предупреждения. Каждый ответ содержит это поле, как пустой список, если в черновиках ничего не недостаёт. |
halted | логическая | да | Остановилось ли преобразование, а не завершилось с находками. |
Дополнительные свойства не допускаются.
ScaffoldEntityResult
Созданный черновик начального документа, список запускаемых примеров или записанный пример — каждая форма отвечает своими полями, а остальные отсутствуют.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
kind | string | нет | Вид сущности, для которого создан черновик. Присутствует при создании черновика. |
skeleton | string | нет | Текст созданного документа. Присутствует при создании черновика. |
examples | ScaffoldExample[] | нет | Каждый запускаемый пример, который публикует документация, по одному разу, в порядке имён. Присутствует при перечислении, которое что-либо нашло. |
example | string | нет | Пример, который был записан. Присутствует при записи. |
dir | string | нет | Каталог, в который был записан пример, относительно корня рабочего пространства, — так, как его назвал запрос, или, если запрос его не назвал, по имени примера. Присутствует при записи. |
files | string[] | нет | Каждый записанный файл, относительно dir и с разделителями-косыми чертами, в том порядке, в каком их содержит документация. Присутствует при записи. |
next | string[] | нет | Команды, которые страница примера приводит для его сборки, строка за строкой, как они записаны на странице, включая комментарии: первый блок оболочки под её заголовком Build. Отсутствует, если страница их не приводит. |
version | string | нет | Версия документации, из которой был прочитан пример: собственная версия бинарного файла, если для неё опубликована документация, иначе самая новая, опубликованная до неё. Присутствует при записи. |
Дополнительные свойства не допускаются.
ScaffoldExample
Один запускаемый пример, который публикует документация.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
name | string | да | Имя примера, которое запрос отправляет как example, чтобы записать его. |
level | string | да | Уровень, который страница примера объявляет для него. |
summary | string | да | Первое предложение страницы примера. |
Дополнительные свойства не допускаются.
LintResult
Что обнаружила проверка соглашений: счётчики по уровню серьёзности и список по документам. Проверка всего каталога, выполненная по одному разу для каждой сущности Release, также содержит passes; счётчики и files тогда охватывают все проходы вместе.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
entity | string | нет | Единственная проверенная сущность, если запрос её назвал. |
release | string | нет | Сущность Release, замыкание которой было проверено, если запрос её назвал. |
checked | integer | да | Сколько документов было проверено. Если проверка выполнялась по одному разу для каждой сущности Release — сумма по проходам: документ, прочитанный двумя проходами, учитывается в каждом. |
findings | integer | да | Общее число замечаний. |
errors | integer | да | Сколько из них ошибок. |
warnings | integer | да | Сколько из них предупреждений. |
infos | integer | да | Сколько из них информационных. |
files | LintFileFindings[] или null | да | Замечания по документам. |
halted | логическая | да | Была ли проверка прервана, а не завершена с замечаниями. |
passes | LintPass[] или null | нет | Проверка всего каталога по одному проходу за раз; присутствует, только если она выполнялась по одному разу для каждой сущности Release, поскольку рабочее пространство называет Releases в workspace.releases. Каждый проход указывает, для каких Releases найдены его замечания. Отсутствует для рабочего пространства, которое их не называет и проверяется один раз по собственным каталогам, а также для проверки одной сущности или замыкания сущности Release. |
Дополнительные свойства не допускаются.
LintPass
Один проход проверки соглашений по всему каталогу в рабочем пространстве, которое даёт своим Releases собственные каталоги: Releases, для которых он выполнялся, прочитанные им каталоги и то, что он в них обнаружил.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
releases | string[] или null | да | Releases, для которых выполнялся проход, каждая в виде пути относительно корня рабочего пространства. Releases, читающие одни и те же каталоги, используют один проход. |
catalogDirs | string[] или null | да | Каталоги, прочитанные проходом, в порядке поиска, каждый относительно корня рабочего пространства, если лежит внутри него. Пусто, если его Releases не читают ни одного каталога, так что проход ничего не проверил и не сделал неуспешным ни один из остальных. |
checked | integer | да | Сколько документов проверил проход. |
findings | integer | да | Сколько замечаний обнаружил проход. |
errors | integer | да | Сколько из них ошибок. |
warnings | integer | да | Сколько из них предупреждений. |
infos | integer | да | Сколько из них информационных. |
files | LintFileFindings[] или 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[] или null | да | Функции хоста, которые, по объявлению модуля, ему нужны. |
commands | PluginCLICommand[] или null | да | Команды, которые добавляет модуль. |
changed | логическая | да | Изменилось ли что-либо в документе на самом деле. |
Дополнительные свойства не допускаются.
PluginGenCatalogResult
Документы каталога, созданные генерацией.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
documents | PluginGeneratedDocument[] | нет | Каждый сгенерированный документ и его текст. |
notices | string | нет | Всё, что генерация хочет сообщить вызывающей стороне. |
dryRun | логическая | да | Были ли документы возвращены, а не записаны. |
Дополнительные свойства не допускаются.
ExplainErrorResult
Что компилятор объявляет об условии, и опубликованные фрагменты, объясняющие, как исправить исходные документы.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
shortCode | string | да | Краткий код условия. |
code | string | да | Описательное имя условия. |
message | string | да | Что сообщает условие при возникновении. |
entries | ExplainErrorEntry[] | нет | Опубликованные фрагменты, объясняющие исправление. |
reference | string | да | Опубликованный адрес, по которому объясняется условие. |
note | string | нет | Почему опубликованные фрагменты отсутствуют, если их не удалось получить. То, что объявляет сам исполняемый файл, всё равно возвращается. |
Дополнительные свойства не допускаются.
GetSchemaResult
Схема вида или — если запрос его не назвал — какие виды можно назвать. Оба охвата передаются в одном ответе, а не через два метода, потому что «что я могу назвать» и «для каких из них автор пишет документы» — один и тот же вопрос в двух охватах, и два ответа пришлось бы поддерживать согласованными.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
kind | string | нет | Вид, для которого предназначена схема. |
schema | любой | нет | Сама схема, передаваемая в том виде, в каком её хранит исполняемый файл. |
kinds | string[] | нет | Все токены, на которые отвечает этот исполняемый файл. |
entityKinds | EntityKindDescriptor[] | нет | Более узкий набор, для которого автор пишет документы; каждый элемент сопоставляет токен, называемый запросом, с видом, который объявляет заголовок самого документа. |
Дополнительные свойства не допускаются.
SkillsInstallResult
Что записала установка навыка ассистента и куда.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
skill | string | да | Навык, который был записан. |
installed | SkillsInstalledFolder[] | да | Каждая записанная папка навыков в том порядке, в котором запрос назвал ассистентов. Ассистенты, читающие одну общую папку, делят одну запись, поскольку навык записывается туда один раз. |
scope | SkillFolderScope | да | Насколько далеко распространяется установка навыка. Запрос указывает одно рабочее пространство, поэтому ответ, ничего об этом не говорящий, был бы прочитан как относящийся к этому рабочему пространству — а для пользовательских папок, которые ассистент читает в каждом проекте, такое прочтение неверно. |
Дополнительные свойства не допускаются.
SkillsInstalledFolder
Одна папка навыков, которую записала установка.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
agents | string[] | да | Идентификаторы названных ассистентов, которые читают эту папку, в том порядке, в котором их назвал запрос. |
folder | string | да | Папка навыка в виде абсолютного пути. |
replaced | логическая | да | Находилась ли там копия, содержащая строку комментария, которую несёт каждая записанная копия навыка, — записанная предыдущей установкой или взятая из опубликованного репозитория навыков, — и была ли она заменена. Файл без этой строки отклоняется, а не заменяется. |
Дополнительные свойства не допускаются.
SkillsListResult
Навыки, которые поставляются с бинарным файлом, и все ассистенты, для которых установка может их записать. Ничего не записывается, и ни к чему не происходит обращения.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
skills | SkillsListedSkill[] | да | Каждый навык, поставляемый с бинарным файлом, в фиксированном порядке. |
agents | SkillsListedAgent[] | да | Каждый ассистент, для которого установке известна папка навыков, упорядоченный по идентификатору. |
Дополнительные свойства не допускаются.
SkillsListedSkill
Один навык, поставляемый с бинарным файлом.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
name | string | да | Имя навыка, которое также является именем папки, которую записывает установка. |
description | string | да | Когда ассистент использует навык, как это объявляет сам навык. |
Дополнительные свойства не допускаются.
SkillsListedAgent
Один ассистент, для которого установка может записать навык, с двумя папками, из которых он читает навыки.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
id | string | да | Идентификатор, по которому запрос называет ассистента. |
name | string | да | Собственное имя ассистента. |
projectFolder | string | да | Папка относительно корня проекта, с разделителями-слешами, из которой ассистент читает навыки проекта. Установка в проект записывает в неё папку навыка в рабочем пространстве, указанном в запросе. |
userFolder | string | да | Папка относительно домашнего каталога, с разделителями-слешами, из которой ассистент в каждом проекте читает собственные навыки пользователя. Установка с global записывает в неё папку навыка. |
Дополнительные свойства не допускаются.