Перейти до вмісту
AggregaAggrega
Обрати мову: Українська
Цю сторінку перекладено машинним способом. Читати оригінал англійською.

Схема протоколу обміну фонового демона Aggrega

Згенерований довідник. Не редагуйте вручну — згенеруйте повторно з опублікованої JSON Schema.

Ідентифікатор схеми: https://aggrega.ai/schemas/serve-wire-v1beta1.schema.json

Форми повідомлень, якими обмінюються з фоновим демоном компілятора, запущеним командою aggrega serve. Клієнт відкриває сеанс із цим демоном за допомогою рукостискання, і саме сеанс визначає межі налаштувань і робочого простору, для яких було відкрито розмову; демон — це процес, який відповідає на запит, надсилає сповіщення й зберігає те, що прочитав. Протокол — це JSON-RPC 2.0 через стандартний вхід і вихід, де кожне повідомлення обрамлене заголовком Content-Length; цей документ описує тіла повідомлень, а не обрамлення чи транспорт. Тіло є одним із чотирьох варіантів: запит, який надсилає клієнт, сповіщення, яке надсилає клієнт, сповіщення, яке надсилає демон, або відповідь, яку демон повертає на запит. Три властивості цього інтерфейсу визначають, як записано наведені нижче форми. По-перше, кожен запит допускає два поля понад ті, що оголошує його власний метод, — workspaceRoot, що називає робочий простір, з яким працює запит, і workDoneToken, створене викликачем значення, під яким повідомляється про перебіг виконання, — тож обидва поля присутні тут у кожному об’єкті параметрів запиту, зокрема у трьох методах, предметом яких не є робочий простір: aggrega/getSchema і aggrega/scaffoldEntity приймають workspaceRoot, але ігнорують його, а aggrega/initialize читає його як робочий простір, який оголошує сеанс. По-друге, демон відхиляє об’єкт параметрів запиту, що містить поле, якого метод не приймає, і називає те, що він приймає, тому кожен об’єкт параметрів тут закритий на верхньому рівні; вкладений об’єкт усередині запиту не закритий, оскільки перевірка читає лише імена зовнішніх полів. По-третє, результат складає демон, а не надає викликач, тому об’єкти результатів закриті на кожному рівні, форма якого фіксована, і відкриті лише там, де значення є непрозорим JSON, який демон передає далі, не читаючи. Один наслідок кодування демона видно в обміні, і його описано, а не приховано: колекція, яку демон не позначає як необов’язкову, видається як null, коли демон не має значення для звіту, і як порожня колекція, коли значення, про яке він звітує, порожнє, тому скрізь, де це стосується, допускаються обидві форми.

Одна з наведених нижче форм

  • Request
  • ClientNotification
  • DaemonNotification
  • SuccessResponse
  • ErrorResponse

Визначення

ProtocolVersion

Версія JSON-RPC, яку містить кожне повідомлення. Підтримується лише 2.0.

Тип: const "2.0"

Константа: "2.0"

RequestId

Ідентифікатор запиту, заданий викликачем, який повертається у відповіді на цей запит. Повідомлення без ідентифікатора є сповіщенням, і на нього ніколи не відповідають.

Тип: string or number

ProgressToken

Значення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.

Тип: string or number

WorkspaceRootSubject

Абсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.

Тип: string

WorkspaceRootAccepted

Абсолютний шлях до робочого простору. Предметом цього методу не є робочий простір — він відповідає на основі того, що містить сам двійковий файл, — тож поле приймається, але не читається. Його допущено, бо клієнт може однаково надсилати його в кожному запиті, не знаючи, які методи його використовують.

Тип: string

RequestMethod

Усі методи, які може називати запит. Набір закритий: на запит, що називає щось інше, надходить відповідь із помилкою «метод не знайдено».

Тип: string (enum)

Допустимі значення: "aggrega/activeRelease", "aggrega/attachCandidates", "aggrega/attachmentContainer", "aggrega/build", "aggrega/buildPreview", "aggrega/cacheClear", "aggrega/cacheEvict", "aggrega/cachePrune", "aggrega/cacheStatus", "aggrega/catalogIndex", "aggrega/completion", "aggrega/configCapture", "aggrega/configInit", "aggrega/connectionAtPosition", "aggrega/connectionCandidates", "aggrega/deprecateArtifact", "aggrega/diagnostics", "aggrega/editDocument", "aggrega/effectiveConfiguration", "aggrega/entityDefinition", "aggrega/explainError", "aggrega/findImplementations", "aggrega/findReferences", "aggrega/getSchema", "aggrega/hover", "aggrega/import", "aggrega/initialize", "aggrega/insertionPoint", "aggrega/invalidate", "aggrega/irGraph", "aggrega/lint", "aggrega/logout", "aggrega/pin", "aggrega/pluginAdd", "aggrega/pluginGenCatalog", "aggrega/pluginRemove", "aggrega/pluginSync", "aggrega/publishArtifact", "aggrega/publishEntity", "aggrega/registryAdd", "aggrega/registryList", "aggrega/registryRemove", "aggrega/registryUpdate", "aggrega/releaseCandidates", "aggrega/releaseClosure", "aggrega/resolve", "aggrega/resolveDependencies", "aggrega/scaffoldEntity", "aggrega/search", "aggrega/setActiveRelease", "aggrega/signArtifacts", "aggrega/skillsInstall", "aggrega/skillsList", "aggrega/validate"

ClientNotificationMethod

Усі методи, які може називати сповіщення клієнта. Набір закритий, і на жодне зі сповіщень не відповідають.

Тип: string (enum)

Допустимі значення: "$/cancelRequest", "aggrega/shutdown"

DaemonNotificationMethod

Усі методи, які може називати сповіщення, що надсилає демон. Набір закритий.

Тип: string (enum)

Допустимі значення: "$/progress", "aggrega/publishDiagnostics"

Request

Запит, який надсилає клієнт і на який відповідає демон. Метод визначає, що запитується; об’єкт params містить власні поля цього методу та два поля, які допускає кожен метод. Запит, що повністю пропускає params, вважається запитом, у якому всі поля відсутні.

ВластивістьТипОбов’язковаОпис
jsonrpcProtocolVersionтакВерсія JSON-RPC, яку містить кожне повідомлення. Підтримується лише 2.0.
idRequestIdтакІдентифікатор запиту, заданий викликачем, який повертається у відповіді на цей запит. Повідомлення без ідентифікатора є сповіщенням, і на нього ніколи не відповідають.
methodRequestMethodтакУсі методи, які може називати запит. Набір закритий: на запит, що називає щось інше, надходить відповідь із помилкою «метод не знайдено».
paramsobjectні

Додаткові властивості не дозволені.

params для кожного method:

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

ClientNotification

Сповіщення, яке надсилає клієнт. Воно не містить ідентифікатора, і на нього ніколи не відповідають.

ВластивістьТипОбов’язковаОпис
jsonrpcProtocolVersionтакВерсія JSON-RPC, яку містить кожне повідомлення. Підтримується лише 2.0.
methodClientNotificationMethodтакУсі методи, які може називати сповіщення клієнта. Набір закритий, і на жодне зі сповіщень не відповідають.
paramsobjectні

Додаткові властивості не дозволені.

params для кожного method:

methodparamsОбов’язкова
"$/cancelRequest"CancelRequestParamsтак
"aggrega/shutdown"ShutdownParamsні

DaemonNotification

Сповіщення, яке надсилає демон. Воно не містить ідентифікатора, і на нього ніколи не відповідають.

ВластивістьТипОбов’язковаОпис
jsonrpcProtocolVersionтакВерсія JSON-RPC, яку містить кожне повідомлення. Підтримується лише 2.0.
methodDaemonNotificationMethodтакУсі методи, які може називати сповіщення, що надсилає демон. Набір закритий.
paramsobjectтак

Додаткові властивості не дозволені.

params для кожного method:

methodparamsОбов’язкова
"$/progress"ProgressParamsтак
"aggrega/publishDiagnostics"PublishDiagnosticsParamsтак

CancelRequestParams

Просить демона облишити запит, що вже виконується, називаючи його за ідентифікатором, який містив запит. Для запиту, що вже завершився або ніколи не надсилався, просто нічого скасовувати.

ВластивістьТипОбов’язковаОпис
idRequestIdтакІдентифікатор запиту, заданий викликачем, який повертається у відповіді на цей запит. Повідомлення без ідентифікатора є сповіщенням, і на нього ніколи не відповідають.

Додаткові властивості не дозволені.

ShutdownParams

Просить демона припинити приймати роботу й завершити вже взяту. Сповіщення не містить полів і зазвичай надсилається взагалі без об’єкта params. Друге таке сповіщення облишає роботу, що ще виконується, замість того щоб чекати на неї.

Цей об’єкт не оголошує фіксованих властивостей і не дозволяє жодних.

ProgressParams

Одне повідомлення про хід роботи, що надсилається лише для запиту, який створив токен прогресу в сеансі, що оголосив можливість їх отримувати.

ВластивістьТипОбов’язковаОпис
tokenProgressTokenтакЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
valueProgressBegin або ProgressReport або ProgressEndтакСаме повідомлення. Одне початкове повідомлення, потім будь-яка кількість рядків, потім одне завершальне повідомлення.

Додаткові властивості не дозволені.

ProgressBegin

Відкриває повідомлення про хід роботи, описуючи, що почалося, у термінах самої операції.

ВластивістьТипОбов’язковаОпис
kindconst “begin”такПозначає це корисне навантаження як початок повідомлення. Константа: "begin"
titlestringтакЩо почалося.

Додаткові властивості не дозволені.

ProgressReport

Один рядок власного звіту операції про себе. Він не містить частки виконання: операції, що звітують тут, обробляють набір, розмір якого невідомий на початку роботи, тож частку довелося б вигадувати.

ВластивістьТипОбов’язковаОпис
kindconst “report”такПозначає це корисне навантаження як один рядок відкритого повідомлення. Константа: "report"
messagestringтакОдин рядок власного виводу операції без пробілів на початку й у кінці.

Додаткові властивості не дозволені.

ProgressEnd

Закриває повідомлення. Воно не містить нічого, крім виду, бо результат передається у відповіді, на яку викликач уже чекає.

ВластивістьТипОбов’язковаОпис
kindconst “end”такПозначає це корисне навантаження як завершення повідомлення. Константа: "end"

Додаткові властивості не дозволені.

PublishDiagnosticsParams

Результати перевірки для одного файлу, які демон надсилає, коли валідація отримала їх для документа, відмінного від названого в запиті.

ВластивістьТипОбов’язковаОпис
filestringтакФайл, якого стосуються результати перевірки.
diagnosticsDiagnostic[] або nullтакРезультати перевірки в порядку їх отримання.

Додаткові властивості не дозволені.

SuccessResponse

Відповідь на успішний запит, що містить ідентифікатор запиту, на який вона відповідає. Відповідь не містить методу, тож форма результату визначається запитом, якому належить ідентифікатор, а не чимось у самій відповіді.

ВластивістьТипОбов’язковаОпис
jsonrpcProtocolVersionтакВерсія JSON-RPC, яку містить кожне повідомлення. Підтримується лише 2.0.
idRequestIdтакІдентифікатор запиту, заданий викликачем, який повертається у відповіді на цей запит. Повідомлення без ідентифікатора є сповіщенням, і на нього ніколи не відповідають.
resultInitializeResult або ValidateResult або InvalidateResult або DiagnosticsResult або IrGraphResult або BuildResult або BuildPreviewResult або EntityDefinitionResult або ReleaseClosureResult або ResolveDependenciesResult або PinResult або CacheStatusResult або CachePruneResult або CacheEvictResult або CacheClearResult або RegistryListResult або SearchResult або RegistryAddResult або RegistryRemoveResult або RegistryUpdateResult або LogoutResult або PublishEntityResult або PublishArtifactResult або SignArtifactsResult або DeprecateArtifactResult або ResolveResult або FindReferencesResult або FindImplementationsResult або HoverResult або CompletionResult або CatalogIndexResult або AttachCandidatesResult або ConnectionCandidatesResult або InsertionPointResult або AttachmentContainerResult або ConnectionAtPositionResult або ReleaseCandidatesResult або ActiveReleaseResult або EditDocumentResult або EffectiveConfigurationResult або ConfigInitResult або ConfigCaptureResult або ImportResult або ScaffoldEntityResult або LintResult або PluginAddResult або PluginRemoveResult або PluginSyncResult або PluginGenCatalogResult або ExplainErrorResult або GetSchemaResult або SkillsInstallResult або SkillsListResultтакВідповідь у формі, яку повертає запитаний метод.

Додаткові властивості не дозволені.

ErrorResponse

Відповідь на запит, який було відхилено або який завершився помилкою; містить ідентифікатор запиту, на який вона відповідає.

ВластивістьТипОбов’язковаОпис
jsonrpcProtocolVersionтакВерсія JSON-RPC, яку містить кожне повідомлення. Підтримується лише 2.0.
idRequestIdтакІдентифікатор запиту, заданий викликачем, який повертається у відповіді на цей запит. Повідомлення без ідентифікатора є сповіщенням, і на нього ніколи не відповідають.
errorErrorObjectтакЩо пішло не так: код, за яким клієнт може розгалужувати логіку, повідомлення, написане для читання людиною, і — якщо умова їх має — артефакти та позиція у вихідному коді, на які посилається повідомлення.

Додаткові властивості не дозволені.

ErrorObject

Що пішло не так: код, за яким клієнт може розгалужувати логіку, повідомлення, написане для читання людиною, і — якщо умова їх має — артефакти та позиція у вихідному коді, на які посилається повідомлення.

ВластивістьТипОбов’язковаОпис
codeErrorCodeтакУмова, про яку повідомляє відповідь. Від’ємні коди — власний зарезервований набір протоколу; чотирицифрові коди — умови, які породжує цей демон, і кожна з них називає стан, на який клієнт може відреагувати. Набір закритий.
messagestringтакЩо пішло не так, звичайним текстом. Це те саме формулювання, яке має та сама умова на кожній іншій поверхні, що про неї повідомляє.
dataErrorDataніАртефакти та позиція у вихідному коді, на які посилається повідомлення, передані структуровано, щоб клієнтові не доводилося видобувати їх із тексту. Кожне поле необов’язкове, і умова заповнює лише те, що має під рукою; жодне поле не замінює інше, тож клієнт дізнається, що отримав, із поля, яке прочитав, а не з коду поруч із ним.

Додаткові властивості не дозволені.

ErrorCode

Умова, про яку повідомляє відповідь. Від’ємні коди — власний зарезервований набір протоколу; чотирицифрові коди — умови, які породжує цей демон, і кожна з них називає стан, на який клієнт може відреагувати. Набір закритий.

Тип: const -32700 or const -32600 or const -32601 or const -32602 or const -32603 or const 1001 or const 1003 or const 1004 or const 1005 or const 1006

Допустимі значення:

  • -32700 — Повідомлення не вдалося розібрати як JSON.
  • -32600 — Повідомлення розібрано, але воно не є коректно сформованим запитом.
  • -32601 — Методу з такою назвою не існує.
  • -32602 — Параметри запиту неприйнятні: поле, якого метод не приймає, поле неправильного типу або значення, яке метод відхиляє.
  • -32603 — Демон зазнав збою під час виконання роботи.
  • 1001 — Демон не має прочитаного подання файла й не створює його. Клієнт ініціює його, запитавши валідацію, а потім повторює спробу.
  • 1003 — Lock-файл для Release, названого в запиті, відсутній, а операції він потрібен.
  • 1004 — Сутність, названу в запиті, не вдалося розв’язати ні з каталогу, ні з Release, названого в запиті.
  • 1005 — Демон завершує роботу й відхиляє нові завдання. Клієнт не повторює спробу з тим самим демоном.
  • 1006 — Валідація файла зараз виконується й не завершилася в межах часу, який дозволив запит, що очікує. Клієнт чекає й запитує знову, нічого не надсилаючи тим часом.

ErrorData

Артефакти та позиція у вихідному коді, на які посилається повідомлення, передані структуровано, щоб клієнтові не доводилося видобувати їх із тексту. Кожне поле необов’язкове, і умова заповнює лише те, що має під рукою; жодне поле не замінює інше, тож клієнт дізнається, що отримав, із поля, яке прочитав, а не з коду поруч із ним.

ВластивістьТипОбов’язковаОпис
filestringніВихідний документ, у якому поля позиції вказують місце, — документ, що перевіряється, або сутність Release, завантаження якої не вдалося.
lineintegerніРядок, на який посилається умова, з відліком від одиниці.
columnintegerніСтовпець, на який посилається умова, з відліком від одиниці.
end_lineintegerніРядок, наступний за кінцем токена, на який посилається умова. Відсутній, якщо кінець токена неможливо відновити; у такому разі клієнт відображає позицію як точку.
end_columnintegerніСтовпець, наступний за кінцем токена, на який посилається умова.
releasestringніСутність Release, на яку посилається умова, записана так, як її назвав запит, щоб клієнт міг скласти виправлення, не збираючи її заново.
lockfilestringніLock-файл, якого стосується умова в межах lock-файлу: шлях, за яким його шукали й не знайшли або не змогли прочитати.
unreachableбулеваніЧи є відмова реєстром, який назвав запит і до якого не вдалося дістатися: його ім’я не розв’язалося, з’єднання з ним було відхилено або не вдалося відкрити, чи не вдалося встановити з ним захищене з’єднання. Визначається з самої помилки, а не з повідомлення, і встановлюється лише там, де помилка показує, що реєстру так і не було досягнуто. Відхилене оновлення індексу, що називає один реєстр, містить його; реєстр, який відповів, хоч би що він відповів, залишає його відсутнім.
codestringніОписова назва умови, яку називає відмова, стабільна між випусками: те саме значення, яке діагностика, що повідомляє про цю умову, має у власному коді. Саме за нею клієнт розгалужує логіку, а не за повідомленням чи числовим кодом поруч, який називає стан запиту й лишається тим самим для кожної умови. Присутня саме тоді, коли відмова називає зареєстровану умову, і відсутня, коли не називає жодної.
shortCodestringніКороткий код умови — літера E і чотири цифри: форма, яку читач цитує й шукає, і та, що відкриває повідомлення відмови, яка називає умову. Присутній саме тоді, коли присутній code.

Додаткові властивості не дозволені.

Diagnostic

Одна знахідка щодо одного документа: де вона, наскільки вона серйозна, що вона повідомляє, і код для цитування, що називає умову, про яку вона повідомляє.

ВластивістьТипОбов’язковаОпис
lineintegerтакРядок, якого стосується знахідка, з відліком від одиниці.
columnintegerтакСтовпець, якого стосується знахідка, з відліком від одиниці.
severityconst “error” або const “warning” або const “info”такНаскільки серйозна знахідка. Допустимі значення: "error" — Знахідка є помилкою. Знахідка плагіна з серйозністю halt повідомляється на цьому рівні. "warning" — Знахідка повідомляється і не є помилкою. Знахідка плагіна з серйозністю warn повідомляється на цьому рівні. "info" — Знахідка є інформацією, як і знахідка плагіна з серйозністю info.
messagestringтакЩо повідомляє знахідка, звичайним текстом.
codestringніОписова назва умови, стабільна між випусками; її можна цитувати в придушенні.
shortCodestringніКороткий код умови — форма, що відкриває діагностику, яка зупиняє роботу.
codeDescriptionCodeDescriptionніДе пояснено умову, яку називає знахідка.
classificationstringніЯк було отримано знахідку, якщо умова це розрізняє.
suggeststringніНаписання, яке пропонує знахідка, якщо умова може його назвати, — наприклад, для майже правильного ідентифікатора.
keyPathstringніШлях у документі до ключа, якого стосується знахідка.
sourcestringтакЩо породило знахідку.
end_lineintegerніРядок, наступний за кінцем токена, якого стосується знахідка, щоб клієнт міг відобразити весь токен, а не один символ. Відсутній для токена, що охоплює кілька рядків.
end_columnintegerніСтовпець, наступний за кінцем токена, якого стосується знахідка.

Додаткові властивості не дозволені.

CodeDescription

Де пояснено умову, яку називає знахідка.

ВластивістьТипОбов’язковаОпис
hrefstringтакОпублікована адреса, за якою пояснено умову.

Додаткові властивості не дозволені.

Position

Місце в документі: рядок і зсув символу в ньому, обидва з відліком від нуля. Зсув вимірюється в одиницях кодування, узгодженого сеансом під час відкриття, — це UTF-16, якщо клієнт не запросив інше.

ВластивістьТипОбов’язковаОпис
lineintegerтакРядок, з відліком від нуля.
characterintegerтакЗсув у рядку, з відліком від нуля, в одиницях кодування, узгодженого сеансом.

Додаткові властивості не дозволені.

Range

Проміжок між двома місцями в документі.

ВластивістьТипОбов’язковаОпис
startPositionтакМісце в документі: рядок і зсув символу в ньому, обидва з відліком від нуля. Зсув вимірюється в одиницях кодування, узгодженого сеансом під час відкриття, — це UTF-16, якщо клієнт не запросив інше.
endPositionтакМісце в документі: рядок і зсув символу в ньому, обидва з відліком від нуля. Зсув вимірюється в одиницях кодування, узгодженого сеансом під час відкриття, — це UTF-16, якщо клієнт не запросив інше.

Додаткові властивості не дозволені.

Location

Проміжок в іменованому документі.

ВластивістьТипОбов’язковаОпис
uristringтакДокумент, у якому міститься проміжок, адресований як URI.
rangeRangeтакПроміжок між двома місцями в документі.

Додаткові властивості не дозволені.

WorkspaceAndProgressParams

Об’єкт params методу, який не оголошує власних полів. Він усе одно допускає два поля, які допускає кожен запит: робочий простір, з яким він працює, і токен прогресу.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.

Додаткові властивості не дозволені.

InitializeParams

Відкриває сеанс над робочим простором і повідомляє, що клієнт здатен обробляти. Це єдиний метод, у якому workspaceRoot є оголошенням, а не суб’єктом: відсутнє значення, порожній рядок і шлях — це три різні речі, а сеанс, відкритий без шляху, — це сеанс, який клієнт ще не спрямував на робочий простір.

ВластивістьТипОбов’язковаОпис
capabilitiesClientCapabilitiesніЩо клієнт здатен обробляти. Незазначене вважається непідтримуваним. Невідомі члени ігноруються, а не відхиляються, тож клієнт може зазначити можливість, яку цей демон ще не читає.
workspaceRootstringніАбсолютний шлях до робочого простору, який слід відкрити. Якщо його немає, сеанс залишається без робочого простору; порожній рядок — це шлях, який надав клієнт, і він не те саме, що відсутність шляху.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.

Додаткові властивості не дозволені.

ClientCapabilities

Що клієнт здатен обробляти. Незазначене вважається непідтримуваним. Невідомі члени ігноруються, а не відхиляються, тож клієнт може зазначити можливість, яку цей демон ще не читає.

ВластивістьТипОбов’язковаОпис
generalobjectніМожливості, не прив’язані до одного виду відповіді.
windowobjectніМожливості щодо того, що клієнт може показувати, поки триває робота.

Додаткові властивості дозволені.

ClientCapabilities.general

Можливості, не прив’язані до одного виду відповіді.

ВластивістьТипОбов’язковаОпис
positionEncodingsstring[]ніКодування позицій, які клієнт здатен читати, від найкращого.

Додаткові властивості дозволені.

ClientCapabilities.window

Можливості щодо того, що клієнт може показувати, поки триває робота.

ВластивістьТипОбов’язковаОпис
workDoneProgressбулеваніЧи може клієнт отримувати сповіщення про хід виконання. Запит, що створює токен ходу виконання в сеансі, який цього не оголосив, відхиляється.

Додаткові властивості дозволені.

ValidateParams

Перевіряє робочий простір або один документ у ньому й відповідає знахідками.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
filestringніДокумент, який слід перевірити. Якщо його немає, перевіряється все, що містить робочий простір.
contentstringніТекст документа в тому вигляді, у якому його зараз тримає клієнт, — для перевірки незбереженого буфера. Якщо його немає, читаються байти з диска.
releasestringніRelease, щодо якого виконується перевірка, як шлях відносно кореня робочого простору.

Додаткові властивості не дозволені.

InvalidateParams

Повідомляє демону, що документ, прочитаний ним, змінився, тож наступна відповідь щодо нього обчислюється з нових байтів.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
filestringніДокумент, що змінився.
granularitystringніЯку частину того, що зберігає демон, слід скинути: file скидає лише те, що зберігається для названого документа; workspace — значення за замовчуванням, і як воно читається будь-яке інше значення, — скидає також те, що зберігається для всього робочого простору.

Додаткові властивості не дозволені.

DiagnosticsParams

Відповідає знахідками, які демон уже має для документа, не перевіряючи його знову.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
filestringніДокумент, про який слід звітувати. Демон уже має містити прочитаний його вміст.

Додаткові властивості не дозволені.

IrGraphParams

Відповідає розв’язаним графом, у який компілюється Release, не рендерячи його.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
releasestringніRelease, який слід розв’язати, як шлях відносно кореня робочого простору. Абсолютний шлях відхиляється.
unredactedбулеваніЧи відповідати з відкритими значеннями, які автор оголосив чутливими. Якщо поле відсутнє або false, кожне з них вилучається з графа, а на його місці стоїть маркер із поясненням причини, так само як їх вилучає вивід графа в командному рядку; true відповідає графом у тому вигляді, у якому в нього компілюється Release, включно з цими значеннями.

Додаткові властивості не дозволені.

BuildParams

Компілює Release і записує відрендерені артефакти в робочий простір.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
releasestringніRelease, який слід зібрати, як шлях відносно кореня робочого простору. Абсолютний шлях відхиляється.
outputParentstringніКаталог, усередині якого створюється вихідний каталог, як шлях відносно кореня робочого простору. Артефакти потрапляють у вихідний каталог під ним і розміщуються так само, як під коренем робочого простору, коли нічого не вказано, — тож це поле називає батьківський каталог вихідного каталогу, а не сам вихідний каталог. Якщо поле відсутнє або порожнє, вихідний каталог записується під коренем робочого простору, як це робить aggrega build, звідки б її не запустили. Абсолютний шлях або шлях, що виходить за межі робочого простору, відхиляється.
autoPullбулеваніЧи спершу розв’язати залежності Release. Якщо цього запитано, збірка звертається до налаштованих реєстрів і записує lockfile; якщо ні, збірка не звертається до жодного реєстру.
policyInputstringніКаталог, у який поруч з артефактами записується корисне навантаження, яке кожна роль управління передає приєднаному там плагіну, у вигляді шляху відносно кореня робочого простору — файли, які записує aggrega build --policy-input, з тими самими назвами, записувані незалежно від того, завершилося збирання чи зупинилося. Сповіщення відповіді повідомляють, скільки файлів записано, і називають кожну роль, для якої файл не записано. Якщо запит завершується невдачею, записані файли залишаються на диску, а цей звіт до відповіді не входить: помилка містить лише відмову. Якщо поле відсутнє, нічого не записується. Абсолютний шлях або шлях, що виходить за межі робочого простору, відхиляється.

Додаткові властивості не дозволені.

BuildPreviewParams

Компілює Release і повідомляє, що дав би запис артефактів, не записуючи жодного з них. Не приймає поле розв’язання залежностей, яке приймає збірка із записом, бо запит, що нічого не записує, не може заповнити lock-файл.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
releasestringніRelease для компіляції, як шлях відносно кореня робочого простору.
autoPullбулеваніПриймається на рівні протоколу й відхиляється методом: цей запит нічого не записує, тож не може заповнити lock-файл і лишитися тим, чим він себе називає.
policyInputstringніКаталог, у який записується корисне навантаження, яке кожна роль управління передає приєднаному там плагіну, у вигляді шляху відносно кореня робочого простору — файли, які записує aggrega build --dry-run --policy-input, з тими самими назвами. Якщо поле передано, ці файли — єдине, що записує цей запит; вихідний каталог і lock-файл лишаються незмінними. Сповіщення відповіді повідомляють, скільки файлів записано, і називають кожну роль, для якої файл не записано. Якщо запит завершується невдачею, записані файли залишаються на диску, а цей звіт до відповіді не входить: помилка містить лише відмову. Абсолютний шлях або шлях, що виходить за межі робочого простору, відхиляється.

Додаткові властивості не дозволені.

EntityDefinitionParams

Відповідає тим, у що розв’язується одне ім’я сутності, і де лежить документ, що її визначає.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
namestringніСутність для розв’язання, за іменем — або посилання на реєстр, oci://<host>/<repository>:<tag> чи @<digest> замість :<tag>, щоб прочитати сутність, опубліковану за цією координатою.
releasestringніRelease, у термінах якого розв’язується ім’я, як шлях відносно кореня робочого простору. Тоді ім’я розв’язується через каталоги, які конфігурація робочого простору надає цьому Release, тож ім’я, яке оголошують кілька варіантів в одному робочому просторі, по одному на Release, розв’язується у варіант, з яким збирається цей Release, а ім’я, яке він не розв’язує, відхиляється з поясненням, що називає запис цього Release у workspace.releases. Якщо поле відсутнє, ім’я розв’язується через власні каталоги робочого простору. Посилання на реєстр не приймає Release і з ним відхиляється, як і значення, що не називає жодного файлу Release.

Додаткові властивості не дозволені.

CatalogIndexParams

Відповідає сутностями, які містить робочий простір: кожною сутністю, яку оголошують його документи, і Features, які оголошують його каталоги.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
releasestringніRelease, у термінах якого перелічуються сутності, як шлях відносно кореня робочого простору. Тоді Features — це ті, які оголошують каталоги, що їх конфігурація робочого простору надає цьому Release, а документ у каталозі, який читають лише інші Releases, пропускається, тож робочий простір, що тримає поруч варіанти однієї сутності, по одному на Release, перелічується з варіантом, з яким збирається цей Release. Якщо поле відсутнє, перелік є власним переліком робочого простору. Значення, що не називає жодного файлу Release, відхиляється.

Додаткові властивості не дозволені.

ReleaseClosureParams

Відповідає всім, від чого залежить Release, так, як до цього дійшло розв’язання.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
releasestringніRelease для перевірки, як шлях відносно кореня робочого простору.

Додаткові властивості не дозволені.

ResolveDependenciesParams

Розв’язує залежності Release, закріплюючи їх у lock-файлі й отримуючи зовнішні вхідні дані, які споживає його рендеринг. Звертається до налаштованих реєстрів і виконує запис.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
releasestringніRelease для розв’язання, як шлях відносно кореня робочого простору.
upgradeбулеваніЧи розв’язувати повторно в межах оголошених діапазонів замість дотримання того, що вже закріплено в lock-файлі.
targetsstring[]ніПосилання для повторного розв’язання; решта лишається закріпленою як є. Порожнє значення розв’язує все.
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. Запит звертається до хостів, які вказують джерела сутності, і записує поруч із сутністю; сам документ сутності ніколи не перезаписується.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
entitystringніДокумент сутності для закріплення, як шлях відносно кореня робочого простору.
dryRunбулеваніЧи повернути у відповіді блокування, яке записав би крок, замість того щоб записувати його. Вхідні елементи однаково розв’язуються, тож кеш вмісту однаково заповнюється.

Додаткові властивості не дозволені.

CacheEvictParams

Звільняє кешований вміст, доки залишок не вміститься в розмір, указаний у запиті.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
maxSizestringніРозмір, до якого слід звільнити кеш, записаний так, як його записує людина, — наприклад, 500MB.

Додаткові властивості не дозволені.

SearchParams

Шукає в тому, що пропонують локальні індекси налаштованих реєстрів. Зчитує індекс, уже наявний на диску, і не звертається до жодного реєстру.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
querystringніТекст для зіставлення з назвою та описом запису.
kindsstring[]ніВиди сутностей, які слід залишити. Порожнє значення залишає всі види.
selectorstringніСелектор міток, якому мають відповідати залишені записи.
capabilitiesstring[]ніМожливості, які має оголошувати залишений запис плагіна.
pluginTypestringніТип плагіна, який слід залишити.
registrystringніЄдиний хост реєстру для пошуку. За відсутності пошук виконується на всіх налаштованих хостах.
limitintegerніМаксимальна кількість записів у відповіді.
includeRetractedбулеваніЧи залишати версії, які опублікований маркер позначив як застарілі.

Додаткові властивості не дозволені.

RegistryAddParams

Реєструє реєстр і політику довіри, яку розв’язання застосовує до того, що він надає. Записує загальномашинний файл конфігурації, якщо запит не вимагає іншого, тож кожен робочий простір на машині розв’язує через цей запис.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
hoststringніХост реєстру, який слід зареєструвати.
namestringніЗручний псевдонім, що розв’язується в хост.
identitiesstring[]ніІдентичності підписування, яким довіряють щодо того, що надає цей реєстр.
keyPathstringніШлях до відкритого ключа, якому слід довіряти, для реєстру, підписаного ключем, а не безключовою ідентичністю.
trustedRootstringніШлях до якоря довіри, за яким перевіряються підписи.
requireSignaturesбулеваніЧи має артефакт із цього реєстру містити перевірений підпис. За відсутності нічого не вказується, і розв’язане типове значення залишається чинним.
advisoryбулеваніЧи повідомляти про невдалу перевірку замість зупинки.
fetchTrustбулеваніЧи зчитати політику довіри, яку оголошує реєстр, і закріпити її. За відсутності нічого не вказується, і розв’язане типове значення залишається чинним.
globalбулеваніЗаписати загальномашинний файл конфігурації, що є власною типовою поведінкою цього методу.
workspaceбулеваніЗаписати власний файл конфігурації цього робочого простору замість загальномашинного.

Додаткові властивості не дозволені.

RegistryRemoveParams

Вилучає зареєстрований реєстр. Записує загальномашинний файл конфігурації, якщо запит не вимагає іншого.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
registrystringніРеєстр, який слід вилучити, за хостом або за псевдонімом.
globalбулеваніЗаписати загальномашинний файл конфігурації, що є власною типовою поведінкою цього методу.
workspaceбулеваніЗаписати власний файл конфігурації цього робочого простору замість загальномашинного.

Додаткові властивості не дозволені.

RegistryUpdateParams

Оновлює локальний індекс, який зчитує пошук, звертаючись для цього до реєстру. Записується індекс у власному налаштованому каталозі кешу цього робочого простору. Реєстр, якому потрібні облікові дані, яких не містить жодне навколишнє джерело, відхиляється із зазначенням цих облікових даних, а не запитом на їх введення.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
registrystringніЄдиний реєстр для оновлення. За відсутності оновлюються всі налаштовані хости.
upgradeбулеваніЧи перебудувати індекс замість доповнення того, що він уже містить.

Додаткові властивості не дозволені.

LogoutParams

Видаляє збережені облікові дані реєстру. Сховище спільне для всіх проєктів на машині, і відповідь про це повідомляє.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
registrystringніРеєстр, збережені облікові дані якого слід видалити.

Додаткові властивості не дозволені.

PublishEntityParams

Публікує сутність у реєстрі. Те, що публікується, отримує кожен споживач цього реєстру під час розв’язання, і опубліковану версію неможливо відкликати в тих, хто вже її завантажив. Нічого не запитується інтерактивно: ідентичність визначається з того, що надав запит, або з того, що вже містить середовище.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
entitystringніДокумент сутності для публікації, як шлях відносно кореня робочого простору.
registrystringніРеєстр, у якому слід опублікувати. Якщо відсутнє, використовується налаштований типовий.
dryRunбулеваніЧи повідомити, що саме опублікувала б публікація, не публікуючи цього.
signбулеваніЧи підписувати те, що публікується. Якщо відсутнє, нічого не задає й залишає чинним розв’язане типове значення.
pluginstringніМодуль плагіна, який слід опублікувати разом із сутністю Plugin.
fulcioUrlstringніЦентр сертифікації, від якого слід отримати сертифікат для підпису.
rekorUrlstringніЖурнал прозорості, у якому слід записати підпис.
timestampUrlstringніСлужба позначок часу для контрпідпису.
identityTokenstringніТокен ідентичності для підпису, наданий викликачем, а не отриманий у терміналі.
pinSourcesбулеваніЧи виконати для сутності крок закріплення, який виконує aggrega/pin, перед її пакуванням, щоб entity.lock, який цей крок записує поруч із нею, увійшов до опублікованого. Крок виконується раніше за всі відмови, що оцінюють сутність, а за dryRun він повідомляє, який lock-файл записав би, і нічого не записує. Якщо відсутнє, діє pin_sources_at_push робочого простору; будь-яке значення перевизначає цей параметр для цього запиту.

Додаткові властивості не дозволені.

PublishArtifactParams

Публікує довільний файл у реєстрі під іменем і тегом, які задає запит.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
filestringніФайл для публікації, як шлях відносно кореня робочого простору.
namestringніІм’я репозиторію, під яким слід опублікувати.
tagstringніТег, під яким слід опублікувати.
mediaTypestringніТип медіа, який слід записати для опублікованих байтів.
registrystringніРеєстр, у якому слід опублікувати. Якщо відсутнє, використовується налаштований типовий.
dryRunбулеваніЧи повідомити, що саме опублікувала б публікація, не публікуючи цього.

Додаткові властивості не дозволені.

SignArtifactsParams

Підписує вже опубліковане. Підпис неможливо відкликати в тих, хто вже його завантажив.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
referencesstring[]ніОпубліковані посилання, які слід підписати.
fulcioUrlstringніЦентр сертифікації, від якого слід отримати сертифікат для підпису.
rekorUrlstringніЖурнал прозорості, у якому слід записати підпис.
timestampUrlstringніСлужба позначок часу для контрпідпису.
identityTokenstringніТокен ідентичності для підпису, наданий викликачем, а не отриманий у терміналі.
jobsintegerніСкільки посилань підписується одночасно. Якщо поле відсутнє, посилання підписуються одне за одним. Кожне посилання все одно підписується точно так, як було б підписане окремо, — у безключовому режимі з власним сертифікатом і власним записом у журналі прозорості, — а відповідь зберігає порядок, у якому було надано посилання. Мінімум: 1.

Додаткові властивості не дозволені.

DeprecateArtifactParams

Позначає опубліковану версію як застарілу, щоб розв’язання могло повідомити про неї або відхилити її. Сам маркер також публікується й підписується. Запит надсилає або одне посилання з його вмістом, або пакетний файл, записи якого містять власний, — ніколи обидва разом і ніколи вміст поряд із пакетним файлом.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
referencestringніОпубліковане посилання, яке слід позначити. Альтернатива from: запит, що містить обидва, відхиляється.
severityconst “warning” або const “error” або const “retracted”ніНаскільки сильно діє маркер — чи розв’язання повідомляє про версію, чи відхиляє її. Обов’язкове разом із reference; відхиляється поряд із from, пакетний файл якого містить власне значення для кожного маркера. Допустимі значення: "warning" — Застаріла, на м’якшому з двох рекомендаційних рівнів: і далі вибирається під час вибору версії. "error" — Застаріла, на суворішому з двох рекомендаційних рівнів: і далі вибирається під час вибору версії. "retracted" — Відкликана: виключається під час вибору версії.
reasonstringніПричина, з якої версія застаріла. Обов’язкове разом із reference; відхиляється поряд із from, пакетний файл якого містить власне значення для кожного маркера.
replacementstringніПосилання, яке слід використовувати натомість. Відхиляється поряд із from, пакетний файл якого містить власне значення для кожного маркера.
messagestringніЩо повідомляють споживачеві, який натрапляє на маркер. Відхиляється поряд із from, пакетний файл якого містить власне значення для кожного маркера.
fromstringніПакетний файл записів про відкликання у вигляді шляху відносно кореня робочого простору, що приєднує по одному маркеру на запис. Кожен запис містить власні посилання, рівень серйозності й причину, а також, за потреби, заміну й повідомлення. Альтернатива reference: запит, що містить обидва або містить поряд із ним рівень серйозності, причину, заміну чи повідомлення, відхиляється.
fulcioUrlstringніЦентр сертифікації, від якого слід отримати сертифікат для підпису.
rekorUrlstringніЖурнал прозорості, у якому слід записати підпис.
timestampUrlstringніСлужба позначок часу для контрпідпису.
identityTokenstringніТокен ідентичності для підпису, наданий викликачем, а не отриманий у терміналі.

Додаткові властивості не дозволені.

ResolveParams

Відповідає, де визначено те, що перебуває під курсором.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
uristringніДокумент, у якому перебуває курсор.
positionPositionніМісце в документі: рядок і зсув символу в ньому, обидва з відліком від нуля. Зсув вимірюється в одиницях кодування, узгодженого сеансом під час відкриття, — це UTF-16, якщо клієнт не запросив інше.
releasestringніRelease, у термінах якого слід відповідати, як шлях відносно кореня робочого простору. Тоді визначенням є документ, до якого посилання розв’язується через каталогові директорії, які конфігурація робочого простору надає цьому Release, у тому порядку, тож ім’я, яке оголошують кілька варіантів в одному робочому просторі, по одному на кожен Release, веде до варіанта цього Release; там, де ці директорії не оголошують такої сутності, пошук іде документами робочого простору, за винятком тих, що лежать в одній із каталогових директорій робочого простору, яку Release не читає. Якщо значення відсутнє, спершу пошук іде документами робочого простору, а власними каталоговими директоріями робочого простору — лише там, де жоден документ не оголошує цього імені. Значення, яке не вказує на жоден файл Release, відхиляється.

Додаткові властивості не дозволені.

FindReferencesParams

Відповідає, де є посилання на те, що перебуває під курсором.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
uristringніДокумент, у якому перебуває курсор.
positionPositionніМісце в документі: рядок і зсув символу в ньому, обидва з відліком від нуля. Зсув вимірюється в одиницях кодування, узгодженого сеансом під час відкриття, — це UTF-16, якщо клієнт не запросив інше.
releasestringніRelease, у термінах якого слід відповідати, як шлях відносно кореня робочого простору. Тоді посилання, зроблене в документі, що лежить в одній із каталогових директорій робочого простору, яку Release не читає, не повідомляється, тож варіанти, які робочий простір тримає поруч, по одному на кожен Release, ніколи не повідомляються як посилання один на одного. Якщо значення відсутнє, пошук іде всіма документами робочого простору. Значення, яке не вказує на жоден файл Release, відхиляється.

Додаткові властивості не дозволені.

FindImplementationsParams

Відповідає, які документи реалізують те, що перебуває під курсором.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
uristringніДокумент, у якому перебуває курсор.
positionPositionніМісце в документі: рядок і зсув символу в ньому, обидва з відліком від нуля. Зсув вимірюється в одиницях кодування, узгодженого сеансом під час відкриття, — це UTF-16, якщо клієнт не запросив інше.
releasestringніRelease, у термінах якого слід відповідати, як шлях відносно кореня робочого простору. Тоді документ, що лежить в одній із каталогових директорій робочого простору, яку Release не читає, не повідомляється, тож варіант, з яким збирається інший Release, ніколи не потрапляє до переліку варіантів цього Release. Якщо значення відсутнє, пошук іде всіма документами робочого простору. Значення, яке не вказує на жоден файл Release, відхиляється.

Додаткові властивості не дозволені.

HoverParams

Відповідає тим, що слід показати про те, що перебуває під курсором.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
uristringніДокумент, у якому перебуває курсор.
positionPositionніМісце в документі: рядок і зсув символу в ньому, обидва з відліком від нуля. Зсув вимірюється в одиницях кодування, узгодженого сеансом під час відкриття, — це UTF-16, якщо клієнт не запросив інше.
releasestringніRelease, у термінах якого слід відповідати, як шлях відносно кореня робочого простору. Тоді показується сутність, до якої посилання розв’язується через каталогові директорії, які конфігурація робочого простору надає цьому Release, у тому порядку; там, де ці директорії не оголошують такої сутності, пошук іде документами робочого простору, за винятком тих, що лежать в одній із каталогових директорій робочого простору, яку Release не читає. Якщо значення відсутнє, спершу пошук іде документами робочого простору, а власними каталоговими директоріями робочого простору — лише там, де жоден документ не оголошує цього імені. Значення, яке не вказує на жоден файл Release, відхиляється.

Додаткові властивості не дозволені.

CompletionParams

Відповідає тим, що можна написати в позиції курсора.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
uristringніДокумент, у якому перебуває курсор.
positionPositionніМісце в документі: рядок і зсув символу в ньому, обидва з відліком від нуля. Зсув вимірюється в одиницях кодування, узгодженого сеансом під час відкриття, — це UTF-16, якщо клієнт не запросив інше.
contextCompletionContextніЩо спричинило запит, якщо клієнт це відстежує.
releasestringніRelease, у термінах якого слід відповідати, як шлях відносно кореня робочого простору. Тоді пропонуються імена, які оголошують документи робочого простору, за винятком документів в одній із каталогових директорій робочого простору, яку Release не читає, разом із Components і Features, які оголошують каталогові директорії, що їх конфігурація робочого простору надає цьому Release. Якщо значення відсутнє, це імена з документів робочого простору та Components і Features, які оголошують його власні каталогові директорії. Значення, яке не вказує на жоден файл Release, відхиляється.

Додаткові властивості не дозволені.

CompletionContext

Що спричинило запит, якщо клієнт це відстежує.

ВластивістьТипОбов’язковаОпис
triggerKindintegerніЧому було запитано автодоповнення.
triggerCharacterstringніСимвол, який це спричинив, якщо це був символ.

Додаткові властивості дозволені.

AttachCandidatesParams

Відповідає, які Features можна приєднати до сутності, з оцінкою за мітками цієї сутності, а для одного з’єднання, яке малює компонент вузла графа, — які з них можуть заповнити кожен слот, оголошений сокетом цього з’єднання.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
nodestringніСутність, щодо якої оцінюються кандидати, за іменем, прочитана з того, що оголошують документи робочого простору.
graphNodestringніВузол графа, щодо якого оцінюються кандидати; його мітки — це остаточний набір, за яким сама збірка оцінює застосовність. Відповідь, обчислена за ним, показує, що зробить збірка.
releasestringніRelease, до графа якого належить вузол, як шлях відносно кореня робочого простору. Тоді кандидати добираються в термінах цього Release: Features, які оголошують каталогові директорії, що їх конфігурація робочого простору надає цьому Release, і документи робочого простору, за винятком тих, що лежать в одній із каталогових директорій робочого простору, яку цей Release не читає, тож Feature, що зберігається для іншого Release, ніколи не пропонується для вузла графа цього Release.
labelsmap of stringніМітки для безпосередньої оцінки замість читання їх із сутності чи вузла графа.
connectionConnectionCoordinateніОдне з’єднання, яке малює компонент вузла, названого в graphNode, для якого слід дати відповідь так само, як і для цього вузла: тоді відповідь також містить slots — кожен слот, оголошений сокетом з’єднання, разом із Features, що можуть його заповнити, або noSlotReason, якщо жоден слот заповнити не можна. Надсилається лише разом із graphNode і release, бо з’єднання існує лише в скомпільованому графі; надіслане разом із node або labels, воно відхиляється. Кандидати поруч із ним зберігають своє значення — Features, які можна приєднати до самого вузла. Його document приймається й не змінює цієї відповіді: слоти належать сокету, а кандидати — Features, однаково в якому документі записано приєднання.

Додаткові властивості не дозволені.

ConnectionCandidatesParams

Відповідає, з якими сутностями можна з’єднати сокет сутності.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
nodestringніСутність, про сокети якої йдеться.
socketstringніОдин сокет, для якого слід дати відповідь. Якщо відсутній, відповідь дається для кожного сокета, який оголошує сутність.

Додаткові властивості не дозволені.

InsertionPointParams

Відповідає, де в документі має бути новий запис під названим контейнером, залишаючи складання й застосування запису викликачеві, якому належить буфер.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
filestringніДокумент, про який слід дати відповідь.
containerstring[]ніШлях у документі до контейнера, під яким має бути запис.

Додаткові властивості не дозволені.

AttachmentContainerParams

Відповідає, у якому документі й у якому місці в ньому має бути приєднання до вузла графа або до одного з’єднання, яке малює його компонент.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
graphNodestringніВузол графа, для якого призначене приєднання.
releasestringніRelease, до графа якого належить вузол, як шлях відносно кореня робочого простору.
connectionConnectionCoordinateніОдне з’єднання, яке малює компонент вузла графа, коли приєднання призначене для цього з’єднання, а не для вузла: тоді відповідь називає власний контейнер features з’єднання в документі, який називає його поле document, тут обов’язкове. В Aggregate це запис з’єднання в документі, де було створено вузол; для з’єднання, яке намалював Release і для якого Aggregate не містить запису, запит відхиляється. У Release це запис для ребра під власним записом Release для вузла, незалежно від того, чи Release уже записує його для цього з’єднання; запит відхиляється, якщо Release не записує запису для вузла. З’єднання, яке намалювала Feature, відхиляється в обох документах, бо приєднання записується лише на з’єднанні, яке малює компонент або Release.

Додаткові властивості не дозволені.

ConnectionAtPositionParams

Відповідає, у запис якого з’єднання потрапляє позиція в Aggregate або Release: вузол графа й з’єднання в тих термінах, у яких їх приймають запити кандидатів і контейнера, або чому там не записано жодного з’єднання. Записи — це ті, у яких записується приєднання: запис, яким компонент малює з’єднання, під псевдонімом з’єднання, у документі, де було створено компонент, і кожен запис для ребра, який записує Release, — кожен там, де його фіксує скомпільований граф, тож те, чи є ключ з’єднанням, ніколи не визначається за його назвою.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
filestringніДокумент, у якому перебуває позиція: Release або документ, у якому, за записом графа Release, створено компоненти, — його Aggregate чи документ модуля, який імпортує цей Aggregate. Спершу він читається з того, що для нього зберігає сесія, а інакше — з диска.
positionPositionніМісце в документі: рядок і зсув символу в ньому, обидва з відліком від нуля. Зсув вимірюється в одиницях кодування, узгодженого сеансом під час відкриття, — це UTF-16, якщо клієнт не запросив інше.
releasestringніRelease, скомпільований граф якого фіксує з’єднання, як шлях відносно кореня робочого простору. Він обов’язковий і для позиції в Aggregate, бо вузол графа й з’єднання існують лише в скомпільованому графі.

Додаткові властивості не дозволені.

ConnectionCoordinate

Одне з’єднання, яке малює компонент вузла графа, адресоване сокетом, через який воно підключене, і псевдонімом, який воно має в цьому сокеті, а також документом, у якому записано прикріплення до нього. З’єднання несе прикріплення, що заповнюють слоти, оголошені його сокетом, і записувати їх може як Aggregate, так і Release.

ВластивістьТипОбов’язковаОпис
socketstringтакСокет залежності, через який підключене з’єднання.
aliasstringтакІм’я, яке з’єднання має в межах свого сокета.
documentconst “aggregate” або const “release”ніДокумент, у якому записано прикріплення до з’єднання. Набір значень закритий, і значення поза ним відхиляється. Допустимі значення: "aggregate" — Aggregate, де розробник записує прикріплення в записі з’єднання. "release" — Release, де оператор записує прикріплення в записі для окремого ребра цього з’єднання.

Додаткові властивості дозволені.

SetActiveReleaseParams

Записує Release як типовий для робочого простору, створюючи маркер у каталозі .aggrega: вибір, який повідомляє aggrega/activeRelease, читає цей маркер після авторського Release з конфігурації. Маркер записується лише всередині робочого простору: якщо каталог .aggrega або маркер є посиланням, що веде за межі робочого простору, — незалежно від того, чи існує вже місце, куди воно веде, — запис відхиляється із зазначенням посилання, і нічого не записується. Відповідь — та, яку дає aggrega/activeRelease після запису маркера, тож вона називає інший Release, якщо авторський Release з конфігурації має вищий пріоритет за маркер.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
releasestringніRelease, який слід записати, як шлях відносно кореня робочого простору. Абсолютний шлях і шлях, що виходить за межі робочого простору, відхиляються; так само відхиляється шлях, що виводить за його межі через посилання, якщо тільки конфігурація робочого простору не називає цей Release.

Додаткові властивості не дозволені.

EditDocumentParams

Застосовує одне обмежене редагування до документа робочого простору: додає один запис під одним контейнером або встановлює одне скалярне значення. Складений документ перевіряється за схемою свого типу і потрапляє на диск лише в разі успішної перевірки, тож цей метод не може записати те, що відхиляє авторська схема. Відхилене редагування залишає файл побайтово таким, яким він був.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
filestringніДокумент, який слід редагувати.
editconst “add-component” або const “attach-feature” або const “wire-edge” або const “set-value”ніЯке редагування застосувати. Допустимі значення: "add-component" — Додає екземпляр компонента в контейнер components: name — ім’я екземпляра, value — Component, який він запитує. "attach-feature" — Приєднує Feature до вузла, названого в запиті: name — ім’я екземпляра прикріплення, value — Feature, який воно запитує. "wire-edge" — Підключає з’єднання залежності від вузла, названого в запиті, усередині socket: name — псевдонім, за яким адресується з’єднання, value — вузол, на який воно вказує. "set-value" — Задає одне значення на вузлі, названому в запиті: name — ключ значення, value — скаляр.
nodestring[]ніШлях у документі до запису, що редагується.
socketstringніСокет, якого стосується редагування, для редагування, що його підключає.
namestringніІм’я, яке записує редагування.
valueanyніЗначення, яке записує редагування, у будь-якій формі, якої воно набуває.
dryRunбулеваніЧи повернути у відповіді складений документ замість його запису.

Додаткові властивості не дозволені.

ConfigInitParams

Створює початковий документ конфігурації. Типово записує загальномашинний файл, оскільки реєстр і ідентичності, яким у ньому довіряють, є загальномашинним інструментарієм. Звертається до названого реєстру, щоб прочитати політику довіри, яку той оголошує; реєстр, що нічого не оголошує, позначається як такий, і створення продовжується — з вбудованою базовою політикою для офіційного хабу і без жодної політики для будь-якого іншого реєстру.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
registrystringніРеєстр, для якого створюється конфігурація.
forceбулеваніЧи перезаписати документ конфігурації, що вже існує.
globalбулеваніЗаписати загальномашинний файл конфігурації, що є власною типовою поведінкою цього методу.
workspaceбулеваніЗаписати власний файл конфігурації цього робочого простору замість загальномашинного.
dryRunбулеваніЧи повернути у відповіді вміст документа замість його запису — для клієнта, що має власну модель документів.

Додаткові властивості не дозволені.

ConfigCaptureParams

Фіксує розв’язану конфігурацію у власному документі цього робочого простору, щоб робочий простір був самодостатнім. Завжди записує файл цього робочого простору і не звертається ні до чого поза ним.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
allPluginsбулеваніЧи зафіксувати кожен підключений плагін, а не лише ті, які налаштував сам робочий простір.

Додаткові властивості не дозволені.

ImportParams

Перетворює сторонній опис джерела на чернетки авторських документів і записує поруч із ними .aggrega-import.json — запис того, що записав імпорт: ціль, яку йому передали (якщо передали), знімок каталогу, який він прочитав (якщо прочитав), кожен чорновий файл і кожен ключ чорнової сутності Aggregate чи Release на будь-якій глибині, — який читає пізніша синхронізація. Джерело, яке не вдалося перетворити повністю, — це відповідь, а не збій: чернетки, які вдалося створити, записуються, а знахідки повідомляють, що не вдалося перетворити, — крім режиму синхронізації, який нічого не записує з перетворення, що зупинилося.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
sourcestringніФайл або каталог для перетворення — абсолютний шлях або шлях відносно кореня робочого простору; запит без нього відхиляється. Його читають там, де він є, у робочому просторі чи поза ним, а з каталогу читаються ті його файли, які вибирають оголошені шаблони файлів імпортера.
outputDirstringніКаталог у робочому просторі, куди записати чернетки, відносно кореня робочого простору; абсолютне значення або таке, що веде за межі робочого простору як написано чи через посилання, відхиляється. За відсутності запис відбувається в корені робочого простору — туди ж, куди записує те саме перетворення, запущене в терміналі без зазначення призначення. Кожен чорновий шлях відносний до каталогу, який відповідь називає як outputDir, і в режимі dryRun також.
formatstringніФормат джерела. За відсутності його визначає перетворення.
targetstringніМожливість провайдера, як-от compose чи helm, — слово, з яким зв’язується spec.capability сутності Recipe, — для якої поруч із чернетками створюється чернетка Manifest як manifest.yaml: кожен тип компонента й тип функції, потрібні чернеткам, зокрема типи каталожної сутності Aggregate, яку компонує чорнова, зіставляється з Recipe або рецептом функції цієї можливості, який каталог робочого простору пропонує для нього, — єдиним наявним або, серед кількох, тим, що названий за типом; тип без жодного або з кількома, жоден з яких так не названий, лишається незіставленим із попереджувальною знахідкою, що його називає; зіставлення, яке імпортер створив сам, зберігається там, де каталог пропонує його для цього типу й цієї можливості, а інакше відкидається з попереджувальною знахідкою; а spec.manifest чорнової сутності Release встановлюється на цей Manifest. Можливість, з якою не зв’язується жоден Recipe у каталозі, відхиляється до запуску перетворення, і нічого не записується. За відсутності Manifest не створюється, крім режиму синхронізації, який створює чернетку для цілі, названої в записі попереднього імпорту; синхронізація із зазначеною ціллю створює чернетку для неї, і тоді запис називає її.
dryRunбулеваніЧи відповісти вмістом кожного файлу, який записав би запит, замість його запису. Уся інша поведінка — як під час запису, тож запит, який запис відхилив би, відхиляється й тут; із синхронізацією відповідь містить те, що записала б синхронізація, і кожну частину, яка розійшлася б.
syncбулеваніЧи оновити те, що попередній імпорт створив у outputDir, відповідно до джерела, замість записувати чернетку повністю. Змінюється лише те, що записав імпорт, як його перелічує запис поруч із чернетками: частина, якої джерело не торкалося, лишається такою, як на диску, редагована чи ні; частина, яку джерело змінило, вилучило чи додало, записується наново, видаляється (чорновий файл — цілком) або додається, якщо на диску те, що імпорт записав востаннє; а все інше — ключ, доданий автором (серед них середовище, яке чорнова сутність Release лишає своєму автору), чи коментар, записаний не безпосередньо над чорновим ключем, — лишається байт у байт. Синхронізація, яка змінила б або видалила те, що автор відредагував чи додав, або додала б частину там, де автор уже її написав, відхиляється із зазначенням кожної частини; так само відхиляється синхронізація над сутністю Aggregate, якої не перелічує жоден запис; в обох випадках нічого не записується. Без цього запит, чернетки якого записалися б поверх сутності Aggregate, уже наявної в outputDir, відхиляється, і в режимі dryRun також.
upgradeбулеваніЧи завантажити найновіший знімок каталогу, який публікує типовий реєстр робочого простору, та імпортувати відносно нього, відтоді зберігаючи його замість того, що містить робочий простір, або того, який називає запис поруч із чернетками; нічого не змінює, якщо робочий простір називає теку каталогу, і відхиляється в автономному режимі.
answersstringніФайл відповідей, з якого зчитуються й до якого записуються значення, що їх чернетки залишають порожніми і яких не може містити жодне джерело, відносно кореня робочого простору; абсолютне значення або таке, що веде за межі робочого простору як записане чи через посилання, відхиляється. Він містить під шляхом кожного чорнового файлу шлях ключа в цьому документі та відповідь на нього, а відповіді записуються в чернетки. За відсутності зчитується файл, названий у записі поруч із чернетками, а інакше import-answers.yaml поруч із вихідним файлом або всередині вихідного каталогу. Відповідь для секрету називає, звідки береться секрет, — ім’я змінної, ${NAME} або ім’я Kubernetes Secret, — а будь-що інше відхиляється, і нічого не записується. Нічого не запитується: кожне ще не надане значення є записом в owed відповіді та попереджувальною знахідкою, що називає чорновий файл, ключ і те, чим він є, відповідь на нього надсилається як answered, а там, де чернетки записуються, остання знахідка повідомляє, скільки значень бракує і де. Коли чернетки містять сутність Release, нічого не бракує і перетворення завершилося, далі завантажуються її залежності із записом її lock-файлу, а невдале завантаження завершує знахідки поясненням причини, при цьому чернетки записано; в офлайн-режимі нічого не завантажується, і знахідка називає завантаження, яке слід виконати. Відповідь для ключа, який ці чернетки не залишають порожнім, зберігається у файлі й не застосовується, тож один файл відповідей слугує для кожної цілі.
answeredImportAnswered[]ніВідповіді для значень, перелічених в owed відповіді, кожна з яких називає чорновий файл і ключі так, як їх назвало owed. Кожну оцінюють, зберігають у файлі відповідей і записують у чернетки точнісінько так, як відповідь, введену в терміналі: відповідь для секрету називає, звідки береться секрет, — ім’я змінної, ${NAME} або ім’я Kubernetes Secret, — а та, що цього не робить, не зберігається й не записується, і її значення лишається ненаданим із причиною як його secretAdvice. Значення, на яке файл відповідей уже відповідає, отримує відповідь із файлу; порожня відповідь або така, що називає значення, якого чернеткам не бракує, не застосовується. Надсилайте її із sync після того, як чернетки записано, оскільки запит, що не є sync, відхиляється щодо сутності Aggregate, яка вже є в outputDir. У режимі dryRun, який не зберігає жодної відповіді, і в sync, перетворення якого зупинилося і який нічого не записує, жодна надіслана відповідь не застосовується.

Додаткові властивості не дозволені.

ScaffoldEntityParams

Створює чернетку початкового документа для виду сутності, або записує один із прикладів документації, які можна запустити, у новий каталог робочого простору, або перелічує їх. Створення чернетки виводить скелет із набору схем, який містить бінарний файл, тож із робочого простору нічого не зчитується й нічого не записується — відповідь є текстом, а куди він потрапить, вирішує клієнт. Запис прикладу записує новий каталог і нічого більше, а приклади зчитуються з підписаного пакета документації, опублікованого для версії бінарного файлу, або, якщо такого немає, з найновішого, опублікованого до неї, і пакет перевіряється за політикою підписів робочого простору, перш ніж його буде збережено чи зчитано: пакет, що не проходить перевірку, відхиляється, а в режимі офлайн зчитується лише вже кешована копія. Запит, що надсилає поля двох форм разом — kind з example або list, list з example, name з example або list, dir без example, — відхиляється до того, як щось буде зчитано.

ВластивістьТипОбов’язковаОпис
workspaceRootstringніАбсолютний шлях робочого простору. Створення чернетки його не зчитує. Запис або перелік прикладів потребує його: конфігурація робочого простору визначає, звідки отримується документація і які підписи вона мусить мати, а приклад записується всередині нього.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
kindstringніВид сутності для чернетки, названий його токеном у нижньому регістрі, як-от component, aggregate, release, recipe чи featurerecipe, — токеном, який aggrega/getSchema наводить для нього.
namestringніНазва, яку слід записати в чорновий документ. Надсилається лише разом із kind.
examplestringніПриклад, який можна запустити і який слід записати, за назвою, яку йому дає список прикладів. Надсилається замість kind.
listбулеваніЧи відповісти всіма прикладами, які можна запустити й які публікує документація, нічого не записуючи. Надсилається без example і без kind.
dirstringніНовий каталог, у який слід записати приклад, відносно кореня робочого простору; за відсутності приклад записується там у каталог, названий за прикладом. Каталог ще не повинен існувати або має бути порожнім: каталог, що щось містить, відхиляється й залишається як є, а абсолютне значення або таке, що веде за межі робочого простору як записане чи через посилання, відхиляється до того, як щось буде зчитано. Надсилається лише разом із example.

Додаткові властивості не дозволені.

LintParams

Перевіряє домовленості щодо публікації в каталозі для однієї сутності, для всього, чого досягає замикання сутності Release, або для всього в налаштованих каталогах. У жодному режимі нічого не записується. Якщо не зазначено ні сутності, ні Release, перевіряється весь каталог: у робочому просторі, конфігурація якого не задає власних каталогів для Release, — один раз за каталогами робочого простору; у робочому просторі, що називає Releases у workspace.releases, — один раз для кожного Release за каталогами, які читає цей Release, і ніколи за всіма разом.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
entitystringніЄдиний документ сутності для перевірки.
releasestringніRelease, замикання якого слід перевірити, як шлях відносно кореня робочого простору.
prePublishбулеваніЧи порівнювати кожну сутність із її раніше опублікованою версією, для чого звертаються до налаштованих реєстрів.

Додаткові властивості не дозволені.

PluginAddParams

Під’єднує плагін до сокета, який налаштовує робочий простір. Звертається до реєстру, щоб звести запит до одного плагіна й закріпити версію. Єдине рішення, яке отримав би термінал, — прийняття оголошених можливостей плагіна розширення команд, — надходить тут як поле, тож клієнт запитує того, хто ним керує, і цей інтерфейс ніколи не чекає на запит користувача.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
typestringніСокет, до якого під’єднується плагін.
querystringніЩо звести до одного плагіна.
capabilitystringніМожливість, для якої призначене під’єднання, якщо сокет має кілька.
rolestringніРоль, у якій працює під’єднання; вона визначає, що воно може видавати.
globalбулеваніЗаписати файл конфігурації для всієї машини.
workspaceбулеваніЗаписати власний файл конфігурації цього робочого простору.
acceptCapabilitiesбулеваніЧи приймає викликач можливості, які оголошує плагін розширення команд.
dryRunбулеваніЧи відповісти вмістом документа конфігурації замість його запису.

Додаткові властивості не дозволені.

PluginRemoveParams

Від’єднує плагін від сокета, який налаштовує робочий простір.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
typestringніСокет, до якого під’єднано плагін.
querystringніЯке під’єднання видалити.
globalбулеваніЗаписати файл конфігурації для всієї машини.
workspaceбулеваніЗаписати власний файл конфігурації цього робочого простору.

Додаткові властивості не дозволені.

PluginSyncParams

Узгоджує машинні записи сутності Plugin з модулем, на який вона вказує. Переписує ці записи, а кожен інший байт документа переносить без змін.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
entitystringніДокумент сутності Plugin, який треба узгодити.
pluginstringніМодуль плагіна, з якого читати записи.

Додаткові властивості не дозволені.

PluginGenCatalogParams

Генерує документи каталогу Plugin з власних оголошених метаданих плагіна та написаного автором накладення. Повторна генерація з незмінених вхідних даних дає побайтно ідентичні документи.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
fromEmbeddedбулеваніЧи читати метадані з плагінів, які вже містить бінарний файл.
pluginstringніМодуль плагіна, з якого читати метадані.
outputDirstringніКаталог у робочому просторі, у який записувати документи.
overlaystringніНаписаний автором документ, вміст якого накладається на згенеровані метадані.
dryRunбулеваніЧи відповісти вмістом документів замість їх запису.

Додаткові властивості не дозволені.

ExplainErrorParams

Розгортає код, який містила знахідка, у те, що компілятор оголошує про цю умову, і в опубліковані статті, що пояснюють, як виправити написане. Отримує опубліковану документацію, коли робочий простір не має її копії; якщо отримати її не вдається, усе одно відповідає тим, що оголошує бінарний файл, і пояснює, чому текст відсутній.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
codestringніУмова, яку треба розгорнути, названа або кодом, який містила знахідка, або її коротким кодом.

Додаткові властивості не дозволені.

GetSchemaParams

Відповідає схемою виду або — коли вид не названо — переліком видів, які можна назвати. Відповідає для запущеного бінарного файлу, а не для будь-якої копії, встановленої деінде, тож не потребує робочого простору й не читає його.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootAcceptedніАбсолютний шлях до робочого простору. Предметом цього методу не є робочий простір — він відповідає на основі того, що містить сам двійковий файл, — тож поле приймається, але не читається. Його допущено, бо клієнт може однаково надсилати його в кожному запиті, не знаючи, які методи його використовують.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
kindstringніВид, схемою якого відповісти. Якщо відсутній, натомість повертаються види, які можна назвати.

Додаткові властивості не дозволені.

SkillsInstallParams

Записує вбудовану в бінарний файл навичку асистента в теку навичок кожного асистента, названого в запиті, або, для запиту global, що не називає жодного, — кожного асистента, знайденого на цій машині. Без global записує в теку проєкту кожного асистента всередині робочого простору, названого в запиті, і кожен шлях, який він записав би там, обмежено цим робочим простором; із global записує в теку кожного асистента для окремого користувача в домашньому каталозі. Кожну ціль перевіряють до того, як щось буде записано, тож відмова залишає всі теки такими, якими вони були.

ВластивістьТипОбов’язковаОпис
workspaceRootWorkspaceRootSubjectтакАбсолютний шлях до робочого простору, з яким працює цей запит. Це предмет запиту: демон визначає його до виконання методу, а запит, що його пропускає або передає не як рядок, відхиляється.
workDoneTokenProgressTokenніЗначення, яке створює викликач, щоб зіставляти сповіщення про прогрес із викликом, що їх запросив. Воно повертається без змін у кожному сповіщенні, тож викликач може порівняти його з надісланим значенням. Воно приймається в кожному запиті, а запит, що надсилає його в сеансі, який не оголосив можливості отримувати прогрес, відхиляється.
agentsstring[]ніАсистенти, для яких слід установити навичку, за ідентифікаторами, які повідомляє список. Запит рівня проєкту, що не називає жодного, відхиляється. Запит global, що не називає жодного, встановлює навичку для асистентів, знайдених на цій машині, — кожного, чия тека конфігурації міститься в домашньому каталозі або чия команда є в PATH, — і відхиляється без жодного запису, якщо не знайдено жодного. Ідентифікатор, для якого не відома тека навичок, відхиляється із зазначенням його назви, а ідентифікатор, наданий двічі, встановлюється один раз.
globalбулеваніЗаписувати в теку навичок кожного асистента для окремого користувача в домашньому каталозі, яку він читає в кожному проєкті, замість його теки проєкту в робочому просторі.

Додаткові властивості не дозволені.

ServerCapabilities

Що демон робитиме в цьому сеансі, узгоджено з тим, що, за словами клієнта, він може обробити.

ВластивістьТипОбов’язковаОпис
positionEncodingstringтакКодування, у якому виражено кожну позицію в цьому сеансі.
workDoneProgressбулеваніЧи надсилатиме демон сповіщення про прогрес у цьому сеансі. Присутнє лише тоді, коли клієнт оголосив, що може їх отримувати.

Додаткові властивості не дозволені.

ClosureEntity

Одна сутність, від якої залежить сутність Release, у версії, на якій зупинилося розв’язання.

ВластивістьТипОбов’язковаОпис
uristringтакПосилання, з якого розв’язується сутність.
versionstringтакВерсія, на якій зупинилися.
kindstringніВид сутності.
sourcestringніЗвідки запуск, що створив цей запис, узяв сутність, тим самим словом, яке для неї виводить aggrega pull --detail: fetched-fresh (отримано з реєстру під час цього запуску), cache-reuse (копія, що вже є в кеші, використана повторно без отримання), local (знайдено в локальній файловій системі, наприклад у каталозі каталогу), in-binary (копія всередині бінарного файлу компілятора) або external (власна сутність Aggregate чи Manifest сутності Release, прочитана з файлу або запису, який називає Release, а не розв’язана як одна з її залежностей; сутність Aggregate, яку запуск отримав із реєстру, натомість має fetched-fresh). Присутнє в записах звіту про розв’язання залежностей, де описує, що цей запуск зробив на цій машині, і відсутнє в переліку розв’язаних залежностей сутності Release, який описує, від чого залежить Release. Lock-файл не записує джерела. Пропускається для сутності, джерело якої запуск не записав.

Додаткові властивості не дозволені.

ToolchainCorePlugin

Один плагін, який несе сам компілятор, і використана його версія.

ВластивістьТипОбов’язковаОпис
pluginstringтакПосилання на плагін.
versionstringтакВерсія, яку було використано.

Додаткові властивості не дозволені.

ToolchainReport

Компілятор, що виконав розв’язання, і плагіни, які він несе.

ВластивістьТипОбов’язковаОпис
compilerVersionstringтакВерсія компілятора, що виконав розв’язання.
corePluginsToolchainCorePlugin[]ніПлагіни, які несе компілятор, із використаною версією кожного.

Додаткові властивості не дозволені.

DependencyResolutionReport

Що розв’язання залежностей закріпило й отримало.

ВластивістьТипОбов’язковаОпис
lockfilestringтакLock-файл, який записало розв’язання, або той, з яким порівнювала перевірка.
verifiedбулеваніЧи був запит перевіркою, яка порівняла записаний lock-файл і не записала ні lock-файлу, ні запису довіри до плагінів, ні entity.lock.
entitiesClosureEntity[] або nullтакСутності, які закріпило розв’язання або порівняла перевірка.
librariesClosureEntity[] або nullтакБібліотеки, які закріпило розв’язання або порівняла перевірка.
pluginsClosureEntity[] або nullтакПлагіни, які закріпило розв’язання або порівняла перевірка.
sourceArtifactsintegerтакСкільки артефактів джерел було отримано.
trustedPluginsintegerтакСкільки із закріплених плагінів мали перевірений підпис.
toolchainToolchainReportніКомпілятор, що виконав розв’язання, і плагіни, які він несе.
externalInputsintegerтакСкільки зовнішніх вхідних даних, які споживає рендеринг, було отримано.
incompleteExternalInputsstringніЯкі зовнішні вхідні дані не вдалося отримати, якщо деякі не вдалося.

Додаткові властивості не дозволені.

BuildNotice

Одне повідомлення, про яке збірка хоче повідомити викликача і яке не є ні зауваженням щодо документа, ні збоєм.

ВластивістьТипОбов’язковаОпис
classstringтакЯкий це вид повідомлення.
textstringтакЩо каже повідомлення.

Додаткові властивості не дозволені.

CacheScope

Наскільки широко сягає відповідь щодо кешу. Два класи кешу спільні для всіх проєктів на машині, тому кожна відповідь щодо кешу називає, яких із них вона торкнулася, — інакше сеанс, відкритий над одним робочим простором, сприймався б як такий, що звітує лише про цей робочий простір.

ВластивістьТипОбов’язковаОпис
machineWideClassesstring[] або nullтакКласи кешу, яких торкнулася ця відповідь і які спільні для всіх проєктів на машині.
workspaceRootstringтакРобочий простір, який назвав запит.

Додаткові властивості не дозволені.

CacheElement

Один елемент, який зберігає кеш.

ВластивістьТипОбов’язковаОпис
labelstringтакЧого стосується запис.
sizeintegerтакСкільки байтів він займає.
sizeTextstringтакТой самий розмір у вигляді, зручному для читання людиною.
digeststringніДайджест вмісту, за яким зберігається запис, якщо він є.
notestringніУсе інше, що варто сказати про запис.

Додаткові властивості не дозволені.

CacheClass

Один кеш, про який звітує демон.

ВластивістьТипОбов’язковаОпис
namestringтакЯкий це кеш.
reachstringтакЧи належить кеш цьому робочому простору, чи є спільним для всієї машини.
prunableбулеватакЧи звільнятиме демон цей кеш.
elementsCacheElement[] або nullтакЩо зберігає кеш.

Додаткові властивості не дозволені.

CacheProvenance

Під якими ідентичностями було отримано кешований артефакт і наскільки широко він спільний.

ВластивістьТипОбов’язковаОпис
identitiesstring[] або nullтакІдентичності, яким приписано артефакт.
sharedByintegerніСкільки власників спільно використовують артефакт.

Додаткові властивості не дозволені.

CacheRemoval

Один елемент, який видалило звільнення, — або, у переліку того, що воно залишило, один елемент, який воно видалило б.

ВластивістьТипОбов’язковаОпис
classstringтакДо якого кешу він належить.
labelstringтакЩо це.
reachstringтакЧи належить цей кеш цьому робочому простору, чи є спільним для всієї машини.
sizeintegerтакСкільки байтів він займає або займав до видалення.
sizeTextstringтакТой самий розмір у вигляді, зручному для читання людиною.

Додаткові властивості не дозволені.

CacheShortfall

Що звільнення залишило і що могло б це звільнити, щоб викликач, який бачить менше число, ніж очікував, дізнався причину, а не здогадувався.

ВластивістьТипОбов’язковаОпис
classstringтакЯкий кеш містить те, що залишилося.
countintegerтакСкільки записів залишилося.
sizeintegerтакСкільки байтів вони займають.
sizeTextstringтакТой самий розмір у вигляді, зручному для читання людиною.
reachstringтакЧи належить цей кеш цьому робочому простору, чи є спільним для всієї машини.
reclaimedBystring[] або nullтакЩо могло б їх звільнити.

Додаткові властивості не дозволені.

CacheCleared

Один кеш, який спорожнило очищення.

ВластивістьТипОбов’язковаОпис
classstringтакЯкий кеш було спорожнено.
reachstringтакЧи належить він цьому робочому простору, чи є спільним для всієї машини.
sizeintegerтакСкільки байтів у ньому звільнено.
sizeTextstringтакТой самий розмір у вигляді, зручному для читання людиною.
heldOpenFilesintegerтакСкільки файлів очищення залишило в цьому кеші, бо їх тримав відкритими інший процес. Лише Windows відмовляється видаляти відкритий файл, тому в усіх інших системах це нуль. Пізніше очищення видалить їх, щойно той процес завершить роботу з ними.
heldOpenBytesintegerтакСкільки байтів займають ці файли. Вони не враховуються в розмірі, який відображає звільнене очищенням.
heldOpenBytesTextstringтакТе саме число у вигляді, зручному для читання людиною.

Додаткові властивості не дозволені.

ConfigWriteScope

Який документ конфігурації було записано і наскільки широко він сягає. Запит називає один робочий простір, тож відповідь, яка нічого не каже, сприймалася б як така, що стосується цього робочого простору, — а для запису на рівні всієї машини таке прочитання хибне.

ВластивістьТипОбов’язковаОпис
configFilestringтакДокумент, який було записано.
machineWideбулеватакЧи є цей документ тим, через який розв’язується кожен робочий простір на машині.
workspaceRootstringтакРобочий простір, який назвав запит.

Додаткові властивості не дозволені.

PluginWriteScope

У який документ конфігурації було записано зміну плагіна і наскільки широко він сягає. Типовим для сокета розширень команд є документ рівня всієї машини, тому кожна відповідь каже, який саме документ вона записала.

ВластивістьТипОбов’язковаОпис
configFilestringтакДокумент, який було записано.
machineWideбулеватакЧи є цей документ тим, через який розв’язується кожен робочий простір на машині.
workspaceRootstringтакРобочий простір, який назвав запит.

Додаткові властивості не дозволені.

CredentialStoreScope

Наскільки широко сягає зміна облікових даних. Сховище спільне для всіх проєктів на машині та для всіх інших інструментів, що звертаються до тих самих реєстрів, тому відповідь повідомляє про це, а не залишає домислювати, що зміна стосується лише сеансу.

ВластивістьТипОбов’язковаОпис
machineWideбулеватакЧи є сховище, якого торкнулася зміна, спільним для всієї машини.
workspaceRootstringтакРобочий простір, який назвав запит.

Додаткові властивості не дозволені.

SkillFolderScope

Наскільки далеко сягає встановлення навички. Запит називає один робочий простір, тож відповідь, яка нічого про це не каже, була б прочитана як така, що стосується цього робочого простору, — а для тек окремого користувача, які асистент читає в кожному проєкті, таке прочитання хибне.

ВластивістьТипОбов’язковаОпис
machineWideбулеватакЧи є записані теки теками окремого користувача в домашньому каталозі, які асистент читає в кожному проєкті на машині.
workspaceRootstringтакРобочий простір, який назвав запит.

Додаткові властивості не дозволені.

PublicationReach

Наскільки далеко сягнула публікація. Ці відповіді виходять повністю за межі цієї машини — те, що вони прикріплюють, отримує кожен споживач цього реєстру, — тож кожна з них називає кожен реєстр, до якого зверталася, і чи прикріпив виклик там щось.

ВластивістьТипОбов’язковаОпис
registriesstring[]такКожен хост реєстру, до якого звертався виклик, кожен названий один раз, у порядку першого звернення до нього. Виклик з одним посиланням називає один; пробний запуск називає призначення, до якого він звернувся б.
beyondThisMachineбулеватакЧи прикріпив виклик щось, що реєстр тепер надає іншим: завантажений вміст, підпис, дату публікації або позначку застарілості. False під час пробного запуску, а також для виклику, який виявив, що все, що він мав прикріпити, уже там є, — повторна публікація повної версії або пакет підписування, кожне посилання якого вже мало підпис, що проходить перевірку.

Додаткові властивості не дозволені.

WorkspaceEntityRef

Одна сутність, за видом і назвою, разом із документом, що її оголошує.

ВластивістьТипОбов’язковаОпис
kindstringтакВид сутності.
namestringтакНазва сутності.
filestringтакДокумент, що її оголошує, як шлях відносно кореня робочого простору.

Додаткові властивості не дозволені.

SourcedEntityRef

Одна сутність разом із тим, звідки її прочитано. Документ робочого простору повідомляє свій шлях відносно робочого простору; сутність, отримана з налаштованих каталогів, повідомляє порожній шлях, бо єдиний наявний у неї шлях нічого не означав би для клієнта. Походження вказує, який із двох випадків має місце, щоб порожній шлях не сприймався як поле, яке ніхто не заповнив.

ВластивістьТипОбов’язковаОпис
kindstringтакВид сутності.
namestringтакНазва сутності.
filestringтакДокумент, що її оголошує, як шлях відносно кореня робочого простору, або порожній, якщо вона походить із налаштованих каталогів.
originstringтакЗвідки прочитано сутність.

Додаткові властивості не дозволені.

SocketCandidacy

Один сокет сутності і те, що можна до нього під’єднати.

ВластивістьТипОбов’язковаОпис
socketstringтакНазва сокета.
declarationstringтакДе оголошено сокет.
selectorstringтакСелектор міток, якому має відповідати ціль.
requiredбулеватакЧи має сокет бути під’єднаним, щоб збірка могла продовжитися.
targetsWorkspaceEntityRef[] або nullтакСутності, які можна до нього під’єднати.

Додаткові властивості не дозволені.

SlotCandidacy

Один слот, який оголошує сокет з’єднання, так, як споживча сутність Component оголошує його в сокеті, і Features, що можуть заповнити його в цьому з’єднанні.

ВластивістьТипОбов’язковаОпис
slotstringтакНазва слота, тобто ключ, під яким прикріплення, що його заповнює, записується у features з’єднання.
selectorstringтакСелектор міток, якому має відповідати власними мітками сутність Feature, що заповнює слот. Порожній, якщо слот його не оголошує, — тоді допускається будь-яка Feature.
requiredбулеватакЧи має кожне з’єднання, під’єднане через сокет, заповнити слот, щоб збірка могла продовжитися.
injectstring[]такМеханізми доставки, які слот дозволяє для того, що його заповнює, у порядку, в якому їх оголошує Component. Порожній, якщо їх не оголошено.
sensitiveбулеватакЧи оголошує слот, що те, що його заповнює, працює із секретними даними. Це позначає прикріплення, яке його заповнює, і нічого не відхиляє.
descriptionstringтакДля чого, за словами Component, призначений слот. Порожній, якщо нічого не сказано.
candidatesSourcedEntityRef[]такКожна Feature, що може заповнити слот у цьому з’єднанні: та, оголошеній застосовності якої відповідають мітки вузла графа (цій вимозі підлягає кожне прикріплення вузла) і власні мітки якої відповідають селектору слота. Feature, застосовність або мітки якої неможливо прочитати щодо селектора, не пропонується, бо збірка її відхиляє, а не допускає.

Додаткові властивості не дозволені.

CatalogEntity

Одна сутність, яку містить індекс робочого простору.

ВластивістьТипОбов’язковаОпис
kindstringтакВид сутності.
namestringтакНазва сутності.
apiVersionstringтакВерсія схеми, яку оголошує документ.
descriptionstringтакДля чого, за словами документа, призначена сутність.
labelsmap of string або nullтакМітки, які оголошує документ.
filestringтакДокумент, що її оголошує, як шлях відносно кореня робочого простору.
originstringтакЗвідки прочитано сутність.

Додаткові властивості не дозволені.

CompletionItem

Один елемент, який можна написати в позиції курсора.

ВластивістьТипОбов’язковаОпис
labelstringтакТекст, який слід написати.
kindintegerніЩо це за елемент, щоб клієнт міг вибрати для нього значок.
detailstringніКороткий уточнювач, що показується поруч із міткою.
documentationstringніДокладний опис елемента.
sortTextstringніЗначення для сортування, якщо воно відрізняється від мітки.

Додаткові властивості не дозволені.

MarkupContent

Текст для показу і спосіб його розмітки.

ВластивістьТипОбов’язковаОпис
kindstringтакСпосіб розмітки тексту.
valuestringтакТекст.

Додаткові властивості не дозволені.

EntityKindDescriptor

Один вид документа, який пише автор: зіставляє токен, який називає запит, із видом, який оголошує сам документ, і вказує, які операції приймають документ цього виду.

ВластивістьТипОбов’язковаОпис
kindstringтакТокен у нижньому регістрі, який називає запит, як-от component чи featurerecipe.
documentKindstringтакВид, який оголошує власний заголовок документа.
acceptedByEntityKindAcceptanceтакЯкі операції приймають документ цього виду, названий окремо — за шляхом або, для перегляду, за назвою — без нічого іншого поруч. Член має значення true, якщо ця операція не відхиляє документ через його вид; прийнятий документ усе ще може бути відхилений через його зміст.

Додаткові властивості не дозволені.

EntityKindAcceptance

Для одного виду, який пише автор: чи приймає кожна операція документ цього виду, названий окремо. Кожен член присутній у кожному записі, тож false є твердженням, а не пропуском.

ВластивістьТипОбов’язковаОпис
singleEntityValidationбулеватакЧи перевіряє документ цього виду область однієї сутності команди aggrega validate — команда, якій передано шлях до одного документа. Вид, який вона відхиляє, натомість перевіряється областю всього каталогу або областю Release.
publicationбулеватакЧи публікує aggrega/publishEntity, що називає лише документ, документ цього виду. Вид, публікація якого також прив’язує виконуваний файл, названий поруч із документом, — Plugin — має значення false, бо запит, що називає лише документ, для нього відхиляється; Manifest і Release мають false, бо жоден із цих видів не публікується.
inspectionByNameбулеватакЧи розв’язує aggrega/entityDefinition назву в сутність цього виду, коли назву надіслано так, як її записано там, де одна сутність посилається на іншу.

Додаткові властивості не дозволені.

RegistryTrust

Політика довіри, яку розв’язання застосовує до того, що надає реєстр.

ВластивістьТипОбов’язковаОпис
signaturesRequiredбулеватакЧи повинен артефакт із цього реєстру мати перевірений підпис.
verificationSkippedбулеваніЧи пропускається перевірка.
advisoryбулеваніЧи повідомляти про невдалу перевірку замість зупинки.
anchorstringніЯкір довіри, щодо якого перевіряються підписи.
keylessIdentitiesintegerніСкільки ідентичностей підписувачів є довіреними для цього реєстру.

Додаткові властивості не дозволені.

Registry

Один налаштований реєстр. Жодне поле тут не містить облікових даних, їхньої довжини, форми чи будь-якого їх відображення — повідомляється лише їхня наявність, і саме це робить значення безпечним для вставлення в issue.

ВластивістьТипОбов’язковаОпис
hoststringтакХост реєстру, який є його ідентичністю.
namestringніЗручний псевдонім, що розв’язується в хост, якщо його налаштовано.
defaultбулеватакЧи є це реєстром, до якого звертається операція, коли реєстр не названо.
authStatestringтакЧи є облікові дані для цього хоста у сховищі на рівні машини. Повідомляється навіть тоді, коли порожнє, щоб викликач міг відрізнити «облікових даних немає» від «перелік не перевіряв».
trustRegistryTrustтакПолітика довіри, яку розв’язання застосовує до того, що надає реєстр.

Додаткові властивості не дозволені.

TrustFetchOutcome

Що дало читання оголошеної політики довіри реєстру. Результати розрізняються, бо означають різне: оголошену політику прийнято; реєстр нічого не оголосив — що не є збоєм; замість неї закріплено вбудовану базову політику; або читання не виконувалося. Якщо нічого не оголошено, поруч зазначено, чи вдалося взагалі зв’язатися з реєстром.

ВластивістьТипОбов’язковаОпис
pinnedбулеватакЧи прийнято оголошену політику.
notAdvertisedбулеваніЧи було зроблено запит до реєстру, і він не оголосив жодної політики; у такому разі операція продовжується на основі того, що зазначено в запиті. Реєстр, до якого не було зроблено запиту через офлайн-режим, так ніколи не позначається. Недосяжний реєстр також позначається так, оскільки від нього не надійшло жодної політики, і поруч має unreachable; щоб розрізнити ці випадки, перевіряйте unreachable.
unreachableбулеваніЧи був реєстр недосяжним під час запиту його оголошеної політики: його ім’я не розв’язалося, з’єднання з ним було відхилено або його не вдалося відкрити, або не вдалося встановити з ним захищене з’єднання. Це визначається з самого збою, а не з reason, стоїть поруч із notAdvertised і встановлюється лише тоді, коли збій показує, що до реєстру так і не вдалося дістатися; реєстр, який відповів — без політики чи зі збоєм, — залишає це поле відсутнім.
baselineбулеваніЧи закріплено вбудовану базову політику через те, що жодної оголошеної політики не прийнято; її має лише офіційний хаб. Стоїть поруч із notAdvertised, якщо до хабу було зроблено запит і він нічого не оголосив, і окремо, якщо офлайн-режим не дав зробити запит до хабу.
skippedбулеваніЧи читання не виконувалося, бо його перевизначила зазначена політика або запит його не вимагав.
identitiesintegerніСкільки ідентичностей підписувачів містила оголошена політика.
reasonstringніЧому оголошену політику не прийнято: що зробила кінцева точка реєстру або яка офлайн-відмова не дала зробити до нього запит.

Додаткові властивості не дозволені.

SkippedRepo

Один репозиторій, який обхід індексу пропустив, і причина.

ВластивістьТипОбов’язковаОпис
repostringтакРепозиторій, який було пропущено.
reasonstringтакЧому його пропущено.

Додаткові властивості не дозволені.

DeprecationNote

Одна позначка застарілості, яку зустрів обхід індексу, і що він із нею зробив. Позначка, яку враховано, і позначка, яка була наявна, але відхилена, звітуються однаково, щоб запис багатьох не минав непомітно, тоді як відхилення однієї привертало б увагу.

ВластивістьТипОбов’язковаОпис
repostringтакРепозиторій, на якому стоїть позначка.
versionstringтакВерсія, яку охоплює позначка.
recordedбулеватакЧи пройшов перевірку власний підпис позначки, і тому індекс її містить.
severityconst “warning” або const “error” або const “retracted”ніНаскільки сильно діє маркер. Допустимі значення: "warning" — Застаріла, на м’якшому з двох рекомендаційних рівнів: і далі вибирається під час вибору версії. "error" — Застаріла, на суворішому з двох рекомендаційних рівнів: і далі вибирається під час вибору версії. "retracted" — Відкликана: виключається під час вибору версії.
reasonstringніЧому версія застаріла.

Додаткові властивості не дозволені.

HostUpdate

Що оновлення індексу зробило для одного реєстру.

ВластивістьТипОбов’язковаОпис
hoststringтакХост реєстру, який було оновлено.
indexedintegerтакСкільки записів записано.
deprecationsExaminedбулеватакЧи обхід узагалі шукав позначки застарілості. Це окремо від лічильника, бо «цей реєстр не опублікував жодної» і «цей запуск не мав підстав судити про них» — різні факти.
deprecationsRecordedintegerтакСкільки позначок враховано.
skippedSkippedRepo[] або nullтакРепозиторії, які обхід пропустив.
deprecationsDeprecationNote[] або nullтакПозначки, які зустрів обхід.
readsRetriedintegerтакСкільки читань обходу реєстр відхилив або обірвав по дорозі так, що їх було запитано знову; кожне читання рахується один раз, хоч скільки спроб воно забрало і незалежно від того, чи вдалося воно потім; нуль, якщо таких не було. Обхід, усі читання якого зрештою вдалися, не перелічує жодного репозиторію в skipped, тож саме цей лічильник показує, наскільки близько обхід був до того, щоб пропустити якийсь. Мінімум: 0.
errorstringніЩо не вдалося для цього хоста, щоб обхід кількох хостів повідомляв, які з них зазнали збою, без потреби викликачу щось зіставляти.
unreachableбулеваніЧи був цей реєстр недосяжним: його ім’я не розв’язалося, з’єднання з ним було відхилено або його не вдалося відкрити, або не вдалося встановити з ним захищене з’єднання. Це визначається з самого збою, а не з error, встановлюється лише поруч із error і лише тоді, коли збій показує, що до реєстру так і не вдалося дістатися; реєстр, який відповів, хоч би що він відповів, залишає це поле відсутнім.

Додаткові властивості не дозволені.

PublishedVersion

Одна версія, яку індекс містить для посилання: дайджест маніфесту, до якого розв’язався її тег під час побудови індексу; якщо політика довіри, за якою будувався індекс, перевірила власний підпис версії, — підписувач, яким його підтверджено; і, якщо щось це фіксує, — коли версію опубліковано, разом із джерелом цих відомостей. Підписувач відсутній для версії без підпису, для версії, жоден підпис якої не пройшов перевірку, а також якщо ця політика не закріплює ні відкритого ключа, ні довіреної ідентичності або вимикає перевірку підписів. Жоден із цих випадків не є підставою називати підписувача, і його відсутність більше нічого не означає. Дата публікації відсутня, якщо публікація її не зазначила і жоден безключовий підпис, перевірений цією політикою, її не фіксує.

ВластивістьТипОбов’язковаОпис
versionstringтакВерсія, як її називає тег.
manifestDigeststringтакДайджест маніфесту, до якого розв’язався тег версії під час побудови індексу; він адресує версію за байтами, які вона позначає, а не за тегом.
signerVerifiedSignatureніПідпис, що пройшов перевірку за політикою довіри реєстру: як його перевірено, підписувач, яким його підтверджено, і дайджест пакета підпису, що пройшов перевірку.
publishedAtstringніКоли версію опубліковано, як позначка часу RFC 3339 в UTC з точністю до секунди. Її джерело — publishedAtSource, і обидва поля або присутні разом, або відсутні.
publishedAtSourceconst “transparency-log” або const “publisher”ніЗвідки взято publishedAt, щоб час, засвідчений журналом прозорості, ніколи не плутали з часом, який заявляє видавець. Набір закритий. Допустимі значення: "transparency-log" — Час, коли журнал прозорості записав безключовий підпис версії; політика довіри, за якою будувався індекс, перевірила його разом із підписаною обіцянкою журналу щодо цього часу. Для версії, підписаної під час публікації, це час публікації; для підписаної пізніше — час створення цього підпису. "publisher" — Час, який публікація заявила поруч із опублікованим, за власним годинником машини, що публікує. Ніщо його не засвідчує. Публікація заявляє його, коли її підпис не містить засвідченого часу: за підпису з ключем або за відсутності підпису. Якщо приєднано кілька, береться найраніший.

Додаткові властивості не дозволені.

VerifiedSignature

Підпис, що пройшов перевірку за політикою довіри реєстру: як його перевірено, підписувач, яким його підтверджено, і дайджест пакета підпису, що пройшов перевірку.

ВластивістьТипОбов’язковаОпис
bundleDigeststringтакДайджест пакета підпису, що пройшов перевірку, у вигляді sha256: і 64 шістнадцяткових символів у нижньому регістрі.
identitystringніПідписувач, яким підтверджено підпис: для безключового підпису — ідентичність, для якої видано сертифікат підпису, тобто його альтернативне ім’я суб’єкта; для підпису з ключем — keyed:sha256: і SHA-256 у шістнадцятковому записі в нижньому регістрі від PEM-тексту закріпленого відкритого ключа.
issuerstringніВидавець OIDC, записаний у сертифікаті підпису, для безключового підпису. Для підпису з ключем відсутній.
modeconst “keyless” або const “keyed”такЯк було перевірено підпис. Набір закритий. Допустимі значення: "keyless" — За сертифікатом підпису, ідентичність і видавець якого збігаються з тими, яким довіряє політика, який утворює ланцюжок до кореня довіри, закріпленого політикою, або, якщо вона його не закріплює, до загальнодоступного кореня Sigstore, і підпис якого записано в журналі прозорості. "keyed" — За відкритим ключем, закріпленим політикою.

Додаткові властивості не дозволені.

RegistrySearchRecord

Один запис, що відповідає пошуку, у тому вигляді, в якому його містить локальний індекс, а також які з його версій позначено застарілими опублікованою позначкою.

ВластивістьТипОбов’язковаОпис
uristringтакПосилання, з якого розв’язується запис.
namestringтакНазва сутності.
versionstringтакВерсія, за якою ключовано запис.
versionsstring[]ніУсі версії, які індекс містить для цього посилання.
kindstringніВид сутності.
descriptionstringніДля чого призначена сутність.
categorystringніКатегорія, у якій опубліковано сутність.
labelsmap of stringніМітки, які оголошує сутність.
pluginTypestringніСокет, до якого приєднується запис плагіна.
capabilitiesstring[]ніМожливості, які оголошує запис плагіна.
manifestDigeststringніДайджест опублікованого маніфесту.
listingDigeststringніДайджест переліку, з якого прочитано запис.
deprecationsobject[]ніПозначки застарілості, які індекс містить для цього посилання, кожна з версією, яку вона охоплює, і самою перевіреною позначкою.
publishedPublishedVersion[]ніУсі версії, які індекс містить для цього посилання, у тому самому порядку, що й versions, кожна з дайджестом маніфесту, до якого розв’язався її тег під час побудови індексу; якщо політика довіри, за якою будувався індекс, перевірила власний підпис цієї версії, — з перевіреним підписувачем; і, якщо щось це фіксує, — з датою публікації та джерелом цієї дати. Версія, записана без підписувача, не має підпису, перевіреного цією політикою, і більше про неї нічого не стверджується. Для цього з реєстру читаються лише маніфести, вкладення підписів і вкладення дат публікації; вміст жодної сутності не завантажується.
retractedstring[]ніВерсії, які опублікована позначка оголосила застарілими.

Додаткові властивості не дозволені.

RegistrySearchIndex

Актуальність одного хоста, у якому виконано пошук.

ВластивістьТипОбов’язковаОпис
hoststringтакХост, в індексі якого виконано пошук.
lastUpdatedstringніКоли індекс востаннє оновлено. Якщо знімок не містить часу, властивість відсутня, а не дорівнює нулю, тож викликач може відрізнити «не записано» від початку епохи.

Додаткові властивості не дозволені.

EffectiveConfigurationSetting

Одне розв’язане налаштування і документ, з якого воно походить.

ВластивістьТипОбов’язковаОпис
fieldstringтакНалаштування.
valuestringтакРозв’язане значення.
sourcestringтакЗвідки походить значення.

Додаткові властивості не дозволені.

ImportedFile

Один файл, який записує імпорт: чернетка документа або запис того, що імпорт записав.

ВластивістьТипОбов’язковаОпис
pathstringтакМісце файлу як шлях відносно outputDir відповіді.
contentstringтакТекст файлу.

Додаткові властивості не дозволені.

ImportDrift

Одна частина, яку синхронізація узгодила з джерелом або узгодила б у режимі dryRun.

ВластивістьТипОбов’язковаОпис
changestringтакЯк змінилася частина: added — для частини, що з’явилася в джерелі; removed — для частини, яку джерело вилучило; changed — для частини, яку воно змінило.
filestringтакЧернетковий файл, у якому міститься частина, як шлях відносно outputDir відповіді.
keystring[]такКлючі, що ведуть до частини від верхнього рівня чернеткової сутності Aggregate або Release, по одному елементу на ключ, тож ключ із крапкою лишається одним елементом. Порожньо, якщо частина — це весь файл.

Додаткові властивості не дозволені.

ImportOwed

Значення, яке чернетки досі залишають порожнім, якого не змогло надати жодне джерело і не надала жодна відповідь.

ВластивістьТипОбов’язковаОпис
filestringтакЧорновий файл, у якому міститься значення, як шлях відносно outputDir відповіді.
keystring[]такКлючі, що ведуть до значення від початку цього документа, по одному запису на ключ, тож ключ, що містить крапку, лишається одним записом. Відповідь, надіслана як answered, називає значення цими ключами.
questionstringтакЧим є значення: опис його схеми, інакше коментар, який чернетка записує над його ключем, інакше те, що, згідно з його схемою, воно приймає.
sensitiveбулеватакЧи є значення значенням секрету, відповідь для якого називає, звідки береться секрет, і ніколи не містить самого секрету.
secretAdvicestringніПрисутнє у значенні секрету: якою має бути відповідь на нього, у реченні, яке показують людині, що відповідає на нього в терміналі, — або, якщо відповідь, надіслану для нього як answered, відхилено, чому її відхилено.

Додаткові властивості не дозволені.

ImportAnswered

Одна відповідь для значення, переліченого в owed відповіді.

ВластивістьТипОбов’язковаОпис
filestringтакЧорновий файл, у якому міститься значення, як його називає owed.
keystring[]такКлючі, що ведуть до значення, як їх називає owed.
answerstringтакВідповідь. Порожня відповідь залишає значення ненаданим.

Додаткові властивості не дозволені.

ImportDiagnostic

Одне, що перетворення не змогло перетворити. Це найкорисніший результат перетворення, тому про них повідомляється повністю, а не зводиться до вердикту.

ВластивістьТипОбов’язковаОпис
severitystringтакНаскільки це серйозно.
messagestringтакЩо не вдалося перетворити.
codestringніНазва умови, яку можна цитувати, якщо вона є.

Додаткові властивості не дозволені.

ImportDecision

Як перетворення зіставило один вузол джерела: сутності Components каталогу, які розглядав імпортер, обрана з них, причина вибору і як цей вибір замінити.

ВластивістьТипОбов’язковаОпис
sourceNodeDecisionSourceNodeтакВузол джерела, якого стосується рішення про зіставлення.
candidatesImportCandidate[]ніСутності Components каталогу, які імпортер розглядав для вузла, кожна зі своєю оцінкою. Відсутня, якщо він не розглядав жодної.
chosenDecisionChoiceніЩо імпортер обрав для вузла джерела. Відсутнє в рішенні, де він нічого не обрав.
rationalestringніЧому імпортер зробив такий вибір, його власними словами. Відсутнє, якщо він нічого не написав.
swapHintstringніЯк замінити вибір на альтернативу, власними словами імпортера. Відсутнє, якщо він нічого не написав.

Додаткові властивості не дозволені.

DecisionSourceNode

Вузол джерела, якого стосується рішення про зіставлення.

ВластивістьТипОбов’язковаОпис
idstringтакІдентифікатор вузла в джерелі.
typestringтакТип вузла, як його називає джерело.
paramsSummarystringтакЗведення параметрів вузла для показу поруч із рішенням.

Додаткові властивості не дозволені.

ImportCandidate

Одна сутність Component каталогу, яку імпортер розглядав для вузла джерела.

ВластивістьТипОбов’язковаОпис
componentNamestringтакНазва сутності Component.
scorenumberтакНаскільки добре сутність Component відповідає вузлу, за оцінкою імпортера.
tierstringтакРівень відповідності, до якого належить оцінка.
signalsCandidateSignalsтакВнесок кожного із сигналів імпортера в оцінку кандидата.

Додаткові властивості не дозволені.

CandidateSignals

Внесок кожного із сигналів імпортера в оцінку кандидата.

ВластивістьТипОбов’язковаОпис
tablenumberтакВнесок сигналу таблиці зіставлень.
categorynumberтакВнесок сигналу категорії.
domainLabelsnumberтакВнесок сигналу міток домену.
shapenumberтакВнесок сигналу форми.
namenumberтакВнесок сигналу назви.

Додаткові властивості не дозволені.

DecisionChoice

Що імпортер обрав для вузла джерела. Відсутнє в рішенні, де він нічого не обрав.

ВластивістьТипОбов’язковаОпис
targetstringтакНазва обраної сутності Component: наявної сутності Component каталогу або створеної для вузла чернетки.
modestringтакЯк записано вибір: як посилання на наявну сутність Component або як нову чернетку.
tierstringтакРівень відповідності вибору.

Додаткові властивості не дозволені.

LintFileFindings

Що перевірка домовленостей виявила в одному документі.

ВластивістьТипОбов’язковаОпис
filestringтакДокумент.
diagnosticsDiagnostic[] або nullтакВиявлене в ньому.

Додаткові властивості не дозволені.

PluginRetractionExclusion

Одна версія, яка була доступна, але не була обрана.

ВластивістьТипОбов’язковаОпис
versionstringтакПропущена версія.
reasonstringніЧому його пропущено.

Додаткові властивості не дозволені.

PluginRetractionProvenance

Звідки походять відомості про те, що застаріло.

ВластивістьТипОбов’язковаОпис
sourcestringтакЩо було перевірено.
lastUpdatedstringніКоли це востаннє оновлено.

Додаткові властивості не дозволені.

PluginRetraction

Як маркер застарілості вплинув на те, яку версію плагіна закріплено.

ВластивістьТипОбов’язковаОпис
referencestringтакПосилання, до якого належать версії.
selectedstringніЗакріплена версія.
excludedPluginRetractionExclusion[]ніВерсії, які були доступні, але були пропущені.
unscreenedstringніЩо не вдалося перевірити за маркером і чому.
provenancePluginRetractionProvenanceніЗвідки походять відомості про те, що застаріло.

Додаткові властивості не дозволені.

PluginGeneratedDocument

Один документ каталогу, створений генерацією.

ВластивістьТипОбов’язковаОпис
pathstringтакМісце документа як шлях відносно кореня робочого простору.
contentstringтакТекст документа.

Додаткові властивості не дозволені.

PluginCommandFlag

Один прапорець, який плагін оголошує для доданої ним команди.

ВластивістьТипОбов’язковаОпис
namestringтакДовга назва прапорця.
shorthandstringніОдносимвольний псевдонім прапорця, якщо він є.
descriptionstringніОднорядковий текст довідки прапорця.
typestringніТип значення прапорця.
defaultstringніЗначення, що використовується, коли прапорець не передано.

Додаткові властивості не дозволені.

PluginCLICommand

Одне дієслово команди верхнього рівня, яке додає плагін.

ВластивістьТипОбов’язковаОпис
namestringтакДієслово команди.
descriptionstringніОднорядковий текст довідки команди.
flagsPluginCommandFlag[]ніПрапорці команди в порядку оголошення.

Додаткові властивості не дозволені.

ConfigCapturedAttachment

Одне прикріплення, яке фіксація записала у власну конфігурацію цього робочого простору.

ВластивістьТипОбов’язковаОпис
uristringніПосилання, з якого розв’язується прикріплення.
capabilitystringніМожливість, для якої призначене прикріплення.
functionstringніЕкспорт, до якого спрямовується прикріплення.
rolestringніРоль, у якій працює під’єднання; вона визначає, що воно може видавати.

Додаткові властивості не дозволені.

ConfigCapturedSocket

Один сокет, записаний фіксацією, із зафіксованими на ньому прикріпленнями.

ВластивістьТипОбов’язковаОпис
socketstringтакСокет.
fieldstringтакПоле конфігурації, під яким записано сокет.
attachmentsConfigCapturedAttachment[] або nullтакПрикріплення, зафіксовані на ньому.

Додаткові властивості не дозволені.

ExplainErrorEntry

Один опублікований фрагмент, що пояснює, як виправити умову під час написання.

ВластивістьТипОбов’язковаОпис
headingstringтакЗаголовок фрагмента.
bodystringтакФрагмент.

Додаткові властивості не дозволені.

SignedArtifact

Один опублікований артефакт, охоплений підписуванням.

ВластивістьТипОбов’язковаОпис
referencestringтакПідписане посилання.
digeststringтакДайджест підписаного.

Додаткові властивості не дозволені.

DeprecationMarked

Одна опублікована версія, позначена як застаріла.

ВластивістьТипОбов’язковаОпис
referencestringтакПозначене посилання.
severityconst “warning” або const “error” або const “retracted”такНаскільки сильно діє маркер. Допустимі значення: "warning" — Застаріла, на м’якшому з двох рекомендаційних рівнів: і далі вибирається під час вибору версії. "error" — Застаріла, на суворішому з двох рекомендаційних рівнів: і далі вибирається під час вибору версії. "retracted" — Відкликана: виключається під час вибору версії.
issuedOnstringтакКоли маркер видано.
digeststringтакДайджест опублікованого маркера.

Додаткові властивості не дозволені.

InitializeResult

Про що сесія домовилася для цього клієнта і з якого шару конфігурації вона це визначила.

ВластивістьТипОбов’язковаОпис
capabilitiesServerCapabilitiesтакЩо демон робитиме в цьому сеансі, узгоджено з тим, що, за словами клієнта, він може обробити.
workspaceRootstringтакРобочий простір, над яким відкрито сесію.
configSourcestringтакЗ якого шару конфігурації сесія визначила свої налаштування.
workspaceMarkerstringніФайл, що визначив корінь робочого простору, якщо такий був.
versionstringтакВерсія бінарного файлу, який обслуговує цю сесію: те саме значення, що aggrega version повідомляє для цього бінарного файлу. Воно описує запущений процес, тож після заміни файлу, з якого було запущено демон, тут і далі вказано версію, що працює, тоді як запит до файлу назве версію, яка її замінила.

Додаткові властивості не дозволені.

ValidateResult

Що знайшла перевірка і скільки було перевірено.

ВластивістьТипОбов’язковаОпис
diagnosticsDiagnostic[] або nullтакЗнахідки. Якщо перевірка нічого не знайшла, тут null, а не порожній список.
checkedstringніСкільки було перевірено — один документ або весь вміст робочого простору.

Додаткові властивості не дозволені.

InvalidateResult

Чи зберігав демон щось про документ, що слід було відкинути.

ВластивістьТипОбов’язковаОпис
invalidatedбулеватакЧи було щось відкинуто.

Додаткові властивості не дозволені.

DiagnosticsResult

Знахідки, які демон уже зберігає для документа.

ВластивістьТипОбов’язковаОпис
diagnosticsDiagnostic[] або nullтакЗнахідки. Якщо їх немає, тут null, а не порожній список.

Додаткові властивості не дозволені.

IrGraphResult

Розв’язаний граф, у який компілюється сутність Release.

ВластивістьТипОбов’язковаОпис
graphanyтакДокумент графа. Значення, які автор оголосив чутливими, у ньому приховано, якщо запит не попросив їх через unredacted; усе інше передається так, як його видав компілятор. Його власна форма — це опублікований контракт графа, і тут вона не повторюється.

Додаткові властивості не дозволені.

BuildResult

Що записала збірка.

ВластивістьТипОбов’язковаОпис
outputDirectorystringтакКаталог, у який записано артефакти.
filesstring[] або nullтакЗаписані артефакти як шляхи відносно вихідного каталогу.
noticesBuildNotice[]ніУсе, що збірка хоче повідомити викликачу і що не є ні знахідкою, ні збоєм.
dependencyResolutionDependencyResolutionReportніЩо розв’язання залежностей закріпило й отримало.

Додаткові властивості не дозволені.

BuildPreviewResult

Що записала б збірка. Нічого не записано, тож вихідного каталогу, який можна було б назвати, немає.

ВластивістьТипОбов’язковаОпис
filesstring[] або nullтакАртефакти, які створив би запис.
noticesBuildNotice[]ніУсе, що компіляція хоче повідомити викликачу і що не є ні знахідкою, ні збоєм.

Додаткові властивості не дозволені.

EntityDefinitionResult

На що розв’язується ім’я сутності і документ, який її визначає. Відповідь, прочитана з посилання на реєстр, містить published, а відповідь, яку каталог розв’язав за іменем, — ніколи.

ВластивістьТипОбов’язковаОпис
kindstringтакВид сутності.
namestringтакНазва сутності.
versionstringтакРозв’язана версія.
descriptionstringніДля чого, за словами документа, призначена сутність.
publishScopestringніНаскільки широко опубліковано сутність.
filestringтакДокумент, який її визначає.
authoredLengthintegerтакСкільки байтів містить авторський документ, щоб клієнт міг відрізнити авторський документ від його розв’язаного відображення.
definitionstringтакТекст визначення.
publishedPublishedArtifactніЩо прочитало посилання на реєстр: координата, як вона містила сутність, і маніфест, через який її прочитано. Усі поля присутні скрізь, де присутній цей об’єкт.

Додаткові властивості не дозволені.

PublishedArtifact

Що прочитало посилання на реєстр: координата, як вона містила сутність, і маніфест, через який її прочитано. Усі поля присутні скрізь, де присутній цей об’єкт.

ВластивістьТипОбов’язковаОпис
referencestringтакПрочитане посилання на реєстр.
archiveбулеватакЧи були байти координати архівом, з якого розпаковано документ сутності. False, якщо координата містила сам документ сутності.
mediaTypestringтакТип артефакту, який оголошує маніфест.
manifestDigeststringтакДайджест маніфесту, через який прочитано сутність, — значення, яке слід вказати після @, щоб точно прочитати ті самі байти знову.

Додаткові властивості не дозволені.

ReleaseClosureResult

Усе, від чого залежить сутність Release, у тому обсязі, якого досягло розв’язання. Повідомляється замикання, а не похідний від нього граф: це інший документ про ту саму сутність Release.

ВластивістьТипОбов’язковаОпис
releasestringтакПеревірена сутність Release.
aggregatestringтакСутність Aggregate, яку вона розгортає.
manifeststringтакСутність Manifest, через яку вона розв’язується.
environmentstringтакСередовище, яке вона називає.
entitiesClosureEntity[] або nullтакСутності, яких досягає замикання.
librariesClosureEntity[] або nullтакБібліотеки, яких досягає замикання.
pluginsClosureEntity[] або nullтакПлагіни, яких досягає замикання.
mappingDiagnosticsstring[] або nullтакЩо повідомило розв’язання зіставлень сутності Manifest.
deprecationsstring[] або nullтакПозначки застарілості, які зустріло замикання.

Додаткові властивості не дозволені.

ResolveDependenciesResult

Що закріпило й отримало розв’язання залежностей, а також усе, що воно хоче повідомити викликачу. Власні поля звіту містяться безпосередньо в цій відповіді, а не вкладені в один з її членів.

ВластивістьТипОбов’язковаОпис
lockfilestringтакLock-файл, який записало розв’язання, або той, з яким порівнювала перевірка.
verifiedбулеваніЧи був запит перевіркою, яка порівняла записаний lock-файл і не записала ні lock-файлу, ні запису довіри до плагінів, ні entity.lock.
entitiesClosureEntity[] або nullтакСутності, які закріпило розв’язання або порівняла перевірка.
librariesClosureEntity[] або nullтакБібліотеки, які закріпило розв’язання або порівняла перевірка.
pluginsClosureEntity[] або nullтакПлагіни, які закріпило розв’язання або порівняла перевірка.
sourceArtifactsintegerтакСкільки артефактів джерел було отримано.
trustedPluginsintegerтакСкільки із закріплених плагінів мали перевірений підпис.
toolchainToolchainReportніКомпілятор, що виконав розв’язання, і плагіни, які він несе.
externalInputsintegerтакСкільки зовнішніх вхідних даних, які споживає рендеринг, було отримано.
incompleteExternalInputsstringніЯкі зовнішні вхідні дані не вдалося отримати, якщо деякі не вдалося.
noticesstring[]ніУсе, що розв’язання хоче повідомити викликачу.

Додаткові властивості не дозволені.

PinResult

Що крок закріплення зробив із lock-файлом поруч із сутністю або зробив би під час пробного запуску. Це відповідь на aggrega/pin, і публікація, яка виконала цей крок, містить її як свій pin.

ВластивістьТипОбов’язковаОпис
entitystringтакДокумент сутності, який прочитав крок, як шлях відносно кореня робочого простору.
kindstringтакВид сутності, як його оголошує її документ.
namestringтакІм’я сутності, як його оголошує її документ.
pinnableбулеватакЧи читає сутність цього виду щось, для чого lock-файл записує закріплення, як це роблять сутності Recipe і FeatureRecipe. Якщо false, нічого поруч із сутністю не змінено, changed дорівнює false, а lock, removed, pins і content відсутні.
lockstringніLock-файл, який крок записав або записав би, як шлях відносно кореня робочого простору.
changedбулеватакЧи змінився lock-файл або змінився б під час пробного запуску. False, якщо lock-файл уже містив усі закріплення, потрібні сутності, і залишився побайтово ідентичним.
removedбулеваніЧи є зміна видаленням: сутність не читає нічого, для чого lock-файл записує закріплення, тож поруч із нею lock-файлу не залишається.
dryRunбулеваніЧи повідомляє це, що крок зробив би, а не що він зробив.
pinsPinClassCount[]ніСкільки закріплень кожного класу містить lock-файл після кроку або містив би після пробного запуску. Перелічено всі класи, які може містити lock-файл, зокрема клас без жодного закріплення.
contentstringніLock-файл, який записав би пробний запуск. Відсутній, якщо lock-файл залишився б без змін або був би видалений, а також у кожній відповіді, що не є пробним запуском.

Додаткові властивості не дозволені.

PinClassCount

Скільки закріплень одного класу містить lock-файл.

ВластивістьТипОбов’язковаОпис
classstringтакКлас закріплення словами, якими його називає відмова через відсутнє закріплення, — наприклад, remote source або imported file.
pinsintegerтакСкільки закріплень цього класу містить lock-файл.

Додаткові властивості не дозволені.

CacheStatusResult

Що зберігають кеші, які обслуговують цей робочий простір.

ВластивістьТипОбов’язковаОпис
classesCacheClass[] або nullтакКожен кеш і те, що він зберігає.
provenanceCacheProvenance[] або nullтакПід якими ідентичностями було отримано кешовані артефакти.
totalCountintegerтакСкільки всього записів зберігають кеші.
totalSizeintegerтакСкільки всього байтів вони займають.
totalSizeTextstringтакТой самий підсумок у формі, зручній для читання людиною.
scopeCacheScopeтакНаскільки широко сягає відповідь щодо кешу. Два класи кешу спільні для всіх проєктів на машині, тому кожна відповідь щодо кешу називає, яких із них вона торкнулася, — інакше сеанс, відкритий над одним робочим простором, сприймався б як такий, що звітує лише про цей робочий простір.

Додаткові властивості не дозволені.

CachePruneResult

Що очищення видалило, що залишило і чого не змогло звільнити.

ВластивістьТипОбов’язковаОпис
removedCacheRemoval[] або nullтакЩо було видалено.
heldOpenCacheRemoval[] або nullтакЩо очищення видалило б, але залишило на місці, бо інший процес тримав це відкритим. Лише Windows відмовляється видаляти відкритий файл, тож на інших системах цей список порожній. Ці записи не враховуються ні як видалені, ні як залишені, жоден їхній байт не враховується як звільнений, а наступне очищення їх звільнить; запис, що є каталогом, міг уже втратити ті свої файли, які не були відкриті.
retainedCountintegerтакСкільки записів було залишено.
reclaimedBytesintegerтакСкільки байтів було звільнено.
reclaimedBytesTextstringтакТе саме число у вигляді, зручному для читання людиною.
unattributedCountintegerтакСкільки записів не належить жодному власнику.
unattributedSizeintegerтакСкільки байтів вони займають.
unattributedSizeTextstringтакТе саме число у вигляді, зручному для читання людиною.
notPruneEligibleCacheShortfall[] або nullтакЩо залишилося і що могло б це звільнити.
scopeCacheScopeтакНаскільки широко сягає відповідь щодо кешу. Два класи кешу спільні для всіх проєктів на машині, тому кожна відповідь щодо кешу називає, яких із них вона торкнулася, — інакше сеанс, відкритий над одним робочим простором, сприймався б як такий, що звітує лише про цей робочий простір.

Додаткові властивості не дозволені.

CacheEvictResult

Що видалило звільнення місця до заданого розміру і що залишилося.

ВластивістьТипОбов’язковаОпис
withinCapBeforeбулеватакЧи вміст уже вкладався в заданий розмір, тож нічого не треба було видаляти.
removedCacheRemoval[] або nullтакЩо було видалено.
heldOpenCacheRemoval[] або nullтакЩо звільнення видалило б, але залишило на місці, бо інший процес тримав це відкритим; натомість воно перейшло до наступного найстарішого запису. Лише Windows відмовляється видаляти відкритий файл, тож на інших системах цей список порожній. Ці записи й далі враховуються в байтах, що залишилися, і наступне звільнення може їх видалити.
totalBeforeintegerтакСкільки байтів зберігалося до того.
totalBeforeTextstringтакТе саме число у вигляді, зручному для читання людиною.
reclaimedBytesintegerтакСкільки байтів було звільнено.
reclaimedBytesTextstringтакТе саме число у вигляді, зручному для читання людиною.
remainingBytesintegerтакСкільки байтів залишилося.
remainingBytesTextstringтакТе саме число у вигляді, зручному для читання людиною.
capBytesintegerтакРозмір, до якого звільнялося місце, у байтах.
capBytesTextstringтакТой самий розмір у вигляді, зручному для читання людиною.
scopeCacheScopeтакНаскільки широко сягає відповідь щодо кешу. Два класи кешу спільні для всіх проєктів на машині, тому кожна відповідь щодо кешу називає, яких із них вона торкнулася, — інакше сеанс, відкритий над одним робочим простором, сприймався б як такий, що звітує лише про цей робочий простір.

Додаткові властивості не дозволені.

CacheClearResult

Що звільнило спорожнення кешів.

ВластивістьТипОбов’язковаОпис
clearedCacheCleared[] або nullтакКожен кеш, який було спорожнено.
reclaimedBytesintegerтакСкільки байтів було звільнено.
reclaimedBytesTextstringтакТе саме число у вигляді, зручному для читання людиною.
scopeCacheScopeтакНаскільки широко сягає відповідь щодо кешу. Два класи кешу спільні для всіх проєктів на машині, тому кожна відповідь щодо кешу називає, яких із них вона торкнулася, — інакше сеанс, відкритий над одним робочим простором, сприймався б як такий, що звітує лише про цей робочий простір.

Додаткові властивості не дозволені.

RegistryListResult

Реєстри, через які розв’язується цей робочий простір.

ВластивістьТипОбов’язковаОпис
registriesRegistry[] або nullтакКожен налаштований реєстр.
credentialStateIsMachineWideбулеватакЧи наявність облікових даних, указана для кожного реєстру, є фактом для всієї машини, а не для робочого простору. Це повідомляється, щоб відповідь у межах сесії не сприймалася як заперечення ширшого охоплення.

Додаткові властивості не дозволені.

SearchResult

Що запропонували для пошуку локальні індекси реєстрів.

ВластивістьТипОбов’язковаОпис
recordsRegistrySearchRecord[] або nullтакЗаписи, що збіглися.
indexesRegistrySearchIndex[] або nullтакКожен хост, у якому виконано пошук, і коли його індекс востаннє оновлювався.
missingIndexHostsstring[] або nullтакНалаштовані хости без локального індексу для пошуку, щоб коротка відповідь була пояснена, а не залишалася для здогадів.
staleбулеватакЧи якийсь із переглянутих індексів досить старий, щоб його варто було оновити.
registriesConfiguredбулеватакЧи налаштовано взагалі хоч один реєстр, що відрізняє «нічого не збіглося» від «пошук не виконувався».

Додаткові властивості не дозволені.

RegistryAddResult

Що записала реєстрація реєстру, куди і що вона прочитала із самого реєстру.

ВластивістьТипОбов’язковаОпис
hoststringтакХост, під яким записано запис; його написання не завжди збігається з тим, що використано в запиті.
scopeConfigWriteScopeтакЯкий документ конфігурації було записано і наскільки широко він сягає. Запит називає один робочий простір, тож відповідь, яка нічого не каже, сприймалася б як така, що стосується цього робочого простору, — а для запису на рівні всієї машини таке прочитання хибне.
trustTrustFetchOutcomeтакЩо дало читання оголошеної політики довіри реєстру. Результати розрізняються, бо означають різне: оголошену політику прийнято; реєстр нічого не оголосив — що не є збоєм; замість неї закріплено вбудовану базову політику; або читання не виконувалося. Якщо нічого не оголошено, поруч зазначено, чи вдалося взагалі зв’язатися з реєстром.

Додаткові властивості не дозволені.

RegistryRemoveResult

Що записало видалення реєстру і куди.

ВластивістьТипОбов’язковаОпис
hoststringтакХост, запис якого було видалено.
scopeConfigWriteScopeтакЯкий документ конфігурації було записано і наскільки широко він сягає. Запит називає один робочий простір, тож відповідь, яка нічого не каже, сприймалася б як така, що стосується цього робочого простору, — а для запису на рівні всієї машини таке прочитання хибне.

Додаткові властивості не дозволені.

RegistryUpdateResult

Що зробило оновлення локальних індексів для кожного хоста.

ВластивістьТипОбов’язковаОпис
hostsHostUpdate[] або nullтакЩо оновлення зробило для кожного хоста.
failedstring[] або nullтакХости, для яких оновлення не вдалося завершити.
indexRootstringтакКаталог, у якому було записано індекси.
registriesConfiguredбулеватакЧи налаштовано взагалі хоч один реєстр.
reachedRegistriesбулеватакУ цій відповіді завжди true: оновлення індексів звертається до самих реєстрів, тоді як їх перелік і пошук відповідають із конфігурації та з локального індексу. Чи справді вдалося досягти певного реєстру, указано в його власному записі в hosts через unreachable.

Додаткові властивості не дозволені.

LogoutResult

Які збережені облікові дані було видалено і наскільки широко сягає сховище.

ВластивістьТипОбов’язковаОпис
registrystringтакРеєстр, облікові дані якого було видалено.
scopeCredentialStoreScopeтакНаскільки широко сягає зміна облікових даних. Сховище спільне для всіх проєктів на машині та для всіх інших інструментів, що звертаються до тих самих реєстрів, тому відповідь повідомляє про це, а не залишає домислювати, що зміна стосується лише сеансу.

Додаткові властивості не дозволені.

PublishEntityResult

Що і куди доставила публікація сутності. Публікація, яка спершу виконала крок закріплення, також містить те, що зробив цей крок, як pin; ця властивість відсутня, якщо крок не виконувався.

ВластивістьТипОбов’язковаОпис
referencestringтакПосилання, під яким опубліковано сутність.
tagstringтакТег, під яким її опубліковано.
kindstringтакВид сутності, яку опубліковано.
mediaTypestringтакМедіатип, записаний для опублікованих байтів.
sizeintegerтакСкільки байтів опубліковано.
sizeTextstringтакТой самий розмір у вигляді, зручному для читання людиною.
pluginSizeintegerніСкільки байтів займає модуль плагіна, опублікований разом із сутністю Plugin.
pluginSizeTextstringніТой самий розмір у вигляді, зручному для читання людиною.
digeststringтакДайджест опублікованого. Під час пробного запуску — дайджест, який отримала б публікація того самого вмісту, обчислений лише з вмісту: той, що виводить aggrega push --dry-run.
signedбулеватакЧи ця публікація приєднала підпис: той, що вона створила перед публікацією, або, для вже опублікованої версії, підпис, якого цій версії бракувало.
alreadyPublishedбулеватакЧи ті самі байти вже були там, тож вміст не завантажувався. Поряд було приєднано лише те, чого тій публікації ще бракувало: дату публікації і, якщо ця публікація підписує, підпис; signed вказує, чи було приєднано підпис.
dryRunбулеватакЧи повідомляє це про те, що доставила б публікація, а не про те, що вона зробила.
reachPublicationReachтакНаскільки далеко сягнула публікація. Ці відповіді виходять повністю за межі цієї машини — те, що вони прикріплюють, отримує кожен споживач цього реєстру, — тож кожна з них називає кожен реєстр, до якого зверталася, і чи прикріпив виклик там щось.
pinPinResultніЩо крок закріплення зробив із lock-файлом поруч із сутністю або зробив би під час пробного запуску. Це відповідь на aggrega/pin, і публікація, яка виконала цей крок, містить її як свій pin.
wholeDirectorySourcestringніЛокальне джерело сутності в авторському вигляді; присутнє, коли його записано як шаблон. Таке джерело називає свій каталог лише після того, як сутність Release заповнить шаблон, тому публікація містить усі файли з каталогу сутності, а не лише ті, які сутність називає. Відсутнє, коли публікація містить лише ці файли.
windowsUnusableEntriesstring[]ніЗаписи опублікованого архіву, шлях яких містить частину, яку Windows не може зберегти в записаному вигляді, — ім’я, яке Windows резервує для пристрою, як-от CON, AUX чи NUL, у будь-якому регістрі та з будь-яким розширенням, або частину, що закінчується крапкою чи пробілом, — спершу ім’я файлу самого документа сутності, потім файли, які він містить. Робочий простір у Windows відмовляється їх розпаковувати, тож не може використовувати цю версію; публікація триває або зупиняється так само, як і без них. Відсутні, якщо таких немає, зокрема для сутності, опублікованої лише як її документ.

Додаткові властивості не дозволені.

PublishArtifactResult

Що і куди доставила публікація файлу.

ВластивістьТипОбов’язковаОпис
referencestringтакПосилання, під яким опубліковано файл.
tagstringтакТег, під яким її опубліковано.
mediaTypestringтакМедіатип, записаний для опублікованих байтів.
sizeintegerтакСкільки байтів опубліковано.
sizeTextstringтакТой самий розмір у вигляді, зручному для читання людиною.
digeststringтакДайджест опублікованого.
alreadyPublishedбулеватакЧи ті самі байти вже були там, тож вміст не завантажувався. Дату публікації було приєднано поряд лише там, де артефакт її не мав.
dryRunбулеватакЧи повідомляє це про те, що доставила б публікація, а не про те, що вона зробила.
reachPublicationReachтакНаскільки далеко сягнула публікація. Ці відповіді виходять повністю за межі цієї машини — те, що вони прикріплюють, отримує кожен споживач цього реєстру, — тож кожна з них називає кожен реєстр, до якого зверталася, і чи прикріпив виклик там щось.

Додаткові властивості не дозволені.

SignArtifactsResult

Що було підписано і куди потрапили підписи.

ВластивістьТипОбов’язковаОпис
signedSignedArtifact[] або nullтакКожне підписане посилання.
reachPublicationReachтакНаскільки далеко сягнула публікація. Ці відповіді виходять повністю за межі цієї машини — те, що вони прикріплюють, отримує кожен споживач цього реєстру, — тож кожна з них називає кожен реєстр, до якого зверталася, і чи прикріпив виклик там щось.

Додаткові властивості не дозволені.

DeprecateArtifactResult

Що позначено як застаріле і куди потрапили позначки.

ВластивістьТипОбов’язковаОпис
markedDeprecationMarked[] або nullтакКожна позначена версія.
reachPublicationReachтакНаскільки далеко сягнула публікація. Ці відповіді виходять повністю за межі цієї машини — те, що вони прикріплюють, отримує кожен споживач цього реєстру, — тож кожна з них називає кожен реєстр, до якого зверталася, і чи прикріпив виклик там щось.

Додаткові властивості не дозволені.

ResolveResult

Де визначено те, що під курсором.

ВластивістьТипОбов’язковаОпис
locationnull або LocationтакДе це визначено. Значення null, якщо ніщо під курсором не розв’язується до визначення.

Додаткові властивості не дозволені.

FindReferencesResult

Де є посилання на те, що під курсором.

ВластивістьТипОбов’язковаОпис
locationsLocation[] або nullтакКожне місце, де на це посилаються.

Додаткові властивості не дозволені.

FindImplementationsResult

Які документи реалізують те, що під курсором.

ВластивістьТипОбов’язковаОпис
locationsLocation[] або nullтакКожне місце, де це реалізовано.

Додаткові властивості не дозволені.

HoverResult

Що показати про те, що під курсором.

ВластивістьТипОбов’язковаОпис
contentsnull або MarkupContentтакЩо показати. Значення null, якщо про те, що під курсором, нічого сказати.

Додаткові властивості не дозволені.

CompletionResult

Що можна записати в позиції курсора.

ВластивістьТипОбов’язковаОпис
itemsCompletionItem[] або nullтакКожен елемент, який можна записати.

Додаткові властивості не дозволені.

CatalogIndexResult

Кожна сутність, яку містить індекс робочого простору, а також посилання, що ведуть за межі робочого простору — до каталогів і до файлів, — які для нього не було прочитано.

ВластивістьТипОбов’язковаОпис
entitiesCatalogEntity[] або nullтакКожна сутність.
unreadLinkedDirsstring[]такКожне посилання під коренем робочого простору, що веде до каталогу за його межами, назване відносно кореня там, де розташоване саме посилання, у порядку пошуку в робочому просторі. Жоден каталог за межами кореня не переглядається, тож жоден документ за одним із цих посилань не потрапляє в entities як власний документ робочого простору, і клієнт, що показує сутності, може пояснити чому. Не називаються: посилання на каталог усередині кореня, який переглядається або пропускається там, де він фактично розташований; посилання будь-де, де каталог було б пропущено — через його розташування, ім’я чи .gitignore; посилання, яке неможливо розв’язати, бо воно веде в нікуди або по колу; і, у відповіді, наданій у термінах сутності Release, посилання в каталозі каталогу сутностей, який читають лише інші Releases. Порожній, якщо робочий простір таких не містить.
unreadLinkedFilesstring[]такКожне посилання під коренем робочого простору, назване як файл YAML — його власне ім’я закінчується на .yaml або .yml, — що веде до файлу за межами кореня, назване відносно кореня там, де розташоване саме посилання, у порядку пошуку в робочому просторі. Такий файл не читається для індексу, хоч би що він оголошував, тож оголошена в ньому сутність не потрапляє в entities як власна сутність робочого простору, і клієнт, що показує сутності, може пояснити чому; сутності поза робочим простором читаються через налаштовані каталоги каталогу сутностей. Не називаються: посилання на файл, який конфігурація робочого простору називає як Release — як build.authoring_release або як ключ у workspace.releases — і який її оголошує, бо його прочитано й наведено в entities у місці самого посилання; посилання на файл усередині кореня, який читається в місці самого посилання; посилання, яке пропускає .gitignore, або посилання всередині каталогу, який пошук пропускає; посилання, що не веде до жодного файлу — чи то до каталогу, який unreadLinkedDirs називає, якщо він веде за межі кореня, чи в нікуди, чи по колу; і, у відповіді, наданій у термінах сутності Release, посилання в каталозі каталогу сутностей, який читають лише інші Releases. Файл конфігурації робочого простору, що є посиланням за межі робочого простору — його власний .aggrega-config.yaml або накладка CI поруч із ним, — називається незалежно від того, чи натрапив на нього пошук, після посилань, названих пошуком: тоді конфігурація робочого простору не читається взагалі, ця відповідь є власним індексом робочого простору, прочитаним без жодних налаштувань, тож для неї не читається жоден каталог каталогу сутностей, а кожен запит, який визначає конфігурація, зокрема індекс у термінах сутності Release, для цього робочого простору відхиляється з умовою блокування читання. Порожній, якщо робочий простір таких не містить.

Додаткові властивості не дозволені.

AttachCandidatesResult

Які Features можна приєднати до сутності та мітки, за якими їх оцінювали; а для з’єднання, назване в запиті, — слоти, які оголошує його сокет, разом із Features, що можуть заповнити кожен із них.

ВластивістьТипОбов’язковаОпис
nodestringтакСутність, для якої оцінювали кандидатів.
nodeLabelsmap of string або nullтакМітки, за якими робилася оцінка.
labelSourcestringтакЯкий набір міток використано, і це не косметична деталь: оголошені мітки документа — це те, що видно під час читання джерела, тоді як мітки вузла графа — це остаточний набір, за яким оцінює сама збірка. Відповідь, обчислена за другим набором, є твердженням про те, що зробить збірка.
candidatesSourcedEntityRef[] або nullтакКожна сутність Feature, яку можна приєднати.
slotsSlotCandidacy[]ніПрисутня лише тоді, коли запит назвав з’єднання: кожен слот, який оголошує сокет з’єднання, у порядку, в якому їх оголошує Component, разом із Features, що можуть його заповнити. Порожня, коли на з’єднанні не можна заповнити жодного слота, і тоді noSlotReason пояснює чому — клієнт читає це, а не сприймає порожній список як слоти, яким не відповідала жодна Feature.
noSlotReasonconst “feature-created-connection” або const “ad-hoc-socket” або const “no-slot-declared”ніПрисутня лише тоді, коли запит назвав з’єднання і на ньому не можна заповнити жодного слота: чому туди нічого не можна приєднати. Відсутня скрізь, де сокет оголошує слот. Набір закритий. Допустимі значення: "feature-created-connection" — З’єднання провів Feature, а прикріплення записується лише на з’єднанні, яке проводить компонент або Release. "ad-hoc-socket" — Сокет не оголошено сутністю Component, тож він не оголошує слота, який могло б заповнити з’єднання. "no-slot-declared" — Сутність Component оголошує сокет і не оголошує на ньому жодного слота.

Додаткові властивості не дозволені.

ConnectionCandidatesResult

До яких сутностей можна під’єднати кожен сокет сутності.

ВластивістьТипОбов’язковаОпис
nodestringтакСутність, якій належать ці сокети.
adHocSocketsAcceptedбулеватакЧи можна все ж написати сокет, який власне визначення сутності не оголошує заздалегідь.
socketsSocketCandidacy[] або nullтакКожен сокет і те, що можна до нього під’єднати.

Додаткові властивості не дозволені.

InsertionPointResult

Де в документі має бути новий запис під названим контейнером і що потрібно клієнту, щоб записати його туди: сама точка, чи має текст починатися з розриву рядка, ключі контейнера, яких ще бракує, і відступ кожного рядка.

ВластивістьТипОбов’язковаОпис
filestringтакДокумент.
containerstring[] або nullтакШлях через документ до контейнера.
positionEncodingstringтакКодування, в якому виражено позиції в цій відповіді.
positionPositionтакМісце в документі: рядок і зсув символу в ньому, обидва з відліком від нуля. Зсув вимірюється в одиницях кодування, узгодженого сеансом під час відкриття, — це UTF-16, якщо клієнт не запросив інше.
precededByLineBreakбулеватакЧи має текст, записаний у цій позиції, починатися з розриву рядка, бо позиція стоїть у кінці рядка, який документ уже містить. Значення false лише тоді, коли в документі немає нічого, за чим мав би йти запис.
missingContainerKeysstring[] або nullтакСегменти шляху контейнера, яких документ ще не містить, починаючи від зовнішнього. Кожен слід записати як окремий ключ із відступом на один крок більшим, ніж у попереднього, перш ніж запис можна буде помістити в найвнутрішній. Значення null, якщо весь шлях уже є.
entryIndentintegerтакСтовпець, з якого починається перший рядок самого запису, у пробілах від початку рядка.
indentStepintegerтакНаскільки більший відступ кожного рівня вкладеності.
indentStepMeasuredбулеватакЧи було крок виміряно за власною вкладеністю цього документа. Якщо значення false, у документі немає вкладеності, яку можна виміряти, і крок є запасним значенням, тож клієнт, який волів би застосувати власний, знає, що може це зробити.
entryShapeconst “mapping” або const “sequence” або const “unknown”такФорма, у якій контейнер містить свої записи, — саме вона визначає, як складається текст запису. Її зчитують із контейнера, який документ уже містить, і ніколи не виводять із назви контейнера. Набір закритий. Допустимі значення: "mapping" — Контейнер є блоковим відображенням, тож запис, доданий до нього, — це ключ і його значення. "sequence" — Контейнер є блоковою послідовністю, тож запис, доданий до нього, — це дефіс і його значення. "unknown" — Документ не містить контейнера або містить його порожнім, тож форму запису визначає клієнт.

Додаткові властивості не дозволені.

AttachmentContainerResult

У якому документі та в якому місці в ньому має бути приєднання на вузлі графа або на з’єднанні, названому в запиті.

ВластивістьТипОбов’язковаОпис
nodestringтакВузол графа, для якого призначене приєднання.
filestringтакДокумент, у якому має бути приєднання.
containerstring[] або nullтакШлях через цей документ до місця, де воно має бути.

Додаткові властивості не дозволені.

ConnectionAtPositionResult

З’єднання, в межах запису якого опиняється позиція, або причина, чому жодного не повідомлено. Присутня рівно одна половина: graphNode разом із connection або лише noConnectionReason. Позиція будь-де всередині запису — на його псевдонімі, цілі чи приєднаннях — перебуває всередині цього запису, найвнутрішнього там, де записи вкладені; позиція на власному ключі сокета, над записаними під ним записами, не перебуває всередині жодного.

ВластивістьТипОбов’язковаОпис
graphNodestringніІдентифікатор вузла, компонент якого задає з’єднання, у тому вигляді, в якому його індексує скомпільований граф, — значення, яке запити кандидатів і контейнера приймають як graphNode.
connectionConnectionCoordinateніЗ’єднання за його сокетом і псевдонімом, де document називає документ, у якому було прочитано позицію, — значення, яке запити кандидатів і контейнера приймають як connection.
noConnectionReasonconst “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, які містить робочий простір, і посилання, що ведуть за його межі — на каталоги та на файли, — які для них не було прочитано.

ВластивістьТипОбов’язковаОпис
releasesstring[] або nullтакКожен документ Release.
lockfilesmap of stringтакLock-файл кожної переліченої сутності Release, з ключем — сутністю Release точно так, як її перелічено. Кожен із них — це файл, який pull записує для цієї сутності Release і який читає збірка, тож клієнт зчитує, де він розташований, а не обчислює це сам. Порожній, коли робочий простір не містить жодної сутності Release.
unreadLinkedDirsstring[]такКожне посилання під коренем робочого простору, що веде до каталогу за його межами, назване відносно кореня там, де розташоване саме посилання, у порядку пошуку в робочому просторі. Жоден каталог за межами кореня не переглядається, тож сутність Release, досяжна лише через одне з цих посилань, відсутня в releases, і клієнт, що пропонує Releases, може пояснити чому. Не названо: посилання на каталог усередині кореня, який переглядається або пропускається там, де він фактично розташований; посилання там, де каталог було б пропущено, чи через його розташування, чи через його назву; і посилання, яке неможливо розв’язати, бо воно веде в нікуди або по колу. Порожній, коли робочий простір їх не містить.
unreadLinkedFilesstring[]такКожне посилання під коренем робочого простору, назване як файл YAML (його власна назва закінчується на .yaml або .yml), що веде до файлу за межами кореня, назване відносно кореня там, де розташоване саме посилання, у порядку пошуку в робочому просторі. Такий файл не читається, тож сутність Release, досяжна лише через одне з цих посилань, відсутня в releases, і клієнт, що пропонує Releases, може пояснити чому. Чи є файл сутністю Release, невідомо без його читання, тож кожне таке посилання називається незалежно від вмісту файлу. Не названо: посилання на файл, який конфігурація робочого простору називає сутністю Release — як build.authoring_release або як ключ workspace.releases, — який читається й перелічується в releases на місці самого посилання; посилання на файл усередині кореня, який читається; посилання всередині каталогу, який пошук пропускає; і посилання, що не веде до жодного файлу — чи то до каталогу, який unreadLinkedDirs називає там, де він виводить за межі кореня, чи в нікуди, чи по колу. Файл конфігурації робочого простору, що є посиланням за межі робочого простору, — його власний .aggrega-config.yaml або належний CI оверлей поруч із ним, — називається незалежно від того, чи натрапив на нього пошук, після посилань, які назвав пошук: тоді конфігурація робочого простору не читається взагалі, ця відповідь читається без жодної конфігурації, тож жодна сутність Release, яку конфігурація називає через посилання, не перелічується, а кожен запит, який визначає конфігурація, відхиляється для цього робочого простору з умовою утримання читання. Порожній, коли робочий простір їх не містить.

Додаткові властивості не дозволені.

ActiveReleaseResult

З якою сутністю Release клієнту слід працювати типово. Робочий простір, що не вказує на жодну сутність Release, — це звичайний стан, а не збій, тож про нього повідомляється тут разом з описом того, як намагалися зробити вибір, а не як про помилку.

ВластивістьТипОбов’язковаОпис
releasestringтакСутність Release, на якій зупинилися, або порожньо, якщо такої немає.
lockfilestringніLock-файл сутності Release, на якій зупинилися: файл, який pull записує для неї і який читає збірка. Відсутній, якщо не зупинилися на жодній сутності Release.
reasonstringніЧому не зупинилися на жодній сутності Release.
tracestringніКожен крок вибору і що він знайшов, щоб викликач бачив, який із них визначив би вибір.

Додаткові властивості не дозволені.

EditDocumentResult

Що записало редагування і куди. Після запису прочитаний демоном стан документа відкидається, тож наступна відповідь щодо нього обчислюється з байтів, які створило редагування.

ВластивістьТипОбов’язковаОпис
filestringтакДокумент, який було відредаговано.
editstringтакЯке редагування було застосовано.
containerstring[] або nullтакШлях у документі до місця, куди потрапило редагування.
createdContainersstring[] або nullтакКонтейнери, які редагуванню довелося створити дорогою.
writtenstring[] або nullтакДокументи, які було записано.
contentstringтакСкладений документ — для запиту, який просив показати результат, а не записати його.

Додаткові властивості не дозволені.

EffectiveConfigurationResult

Конфігурація, яку визначив робочий простір, і з якого документа походить кожне налаштування.

ВластивістьТипОбов’язковаОпис
layersstring[] або nullтакДокументи конфігурації, які було об’єднано, у порядку об’єднання.
settingsEffectiveConfigurationSetting[] або nullтакКожне визначене налаштування і звідки воно походить.

Додаткові властивості не дозволені.

ConfigInitResult

Що записало початкове створення конфігурації, куди, і що воно прочитало з реєстру.

ВластивістьТипОбов’язковаОпис
hoststringтакРеєстр, для якого створено конфігурацію.
scopeConfigWriteScopeтакЯкий документ конфігурації було записано і наскільки широко він сягає. Запит називає один робочий простір, тож відповідь, яка нічого не каже, сприймалася б як така, що стосується цього робочого простору, — а для запису на рівні всієї машини таке прочитання хибне.
trustTrustFetchOutcomeтакЩо дало читання оголошеної політики довіри реєстру. Результати розрізняються, бо означають різне: оголошену політику прийнято; реєстр нічого не оголосив — що не є збоєм; замість неї закріплено вбудовану базову політику; або читання не виконувалося. Якщо нічого не оголошено, поруч зазначено, чи вдалося взагалі зв’язатися з реєстром.
writtenбулеватакЧи було документ записано, на відміну від повернення його викликачу для розміщення.
existedбулеваніПрисутній і має значення true, коли документ уже існував, тож запис реєстру було об’єднано з ним, а не створено новий документ. Лише запит, що надсилає force, виконується поверх наявного документа, тож у кожній відповіді на запит без нього це поле відсутнє.
contentstringніТекст документа — для запиту, який просив показати його, а не записати.

Додаткові властивості не дозволені.

ConfigCaptureResult

Що фіксація визначеної конфігурації записала у власний документ цього робочого простору.

ВластивістьТипОбов’язковаОпис
configFilestringтакДокумент, який було записано. Це завжди власний документ цього робочого простору, адже вся мета — зробити один робочий простір самодостатнім.
workspaceRootstringтакРобочий простір, який назвав запит.
capturedбулеватакЧи було щось зафіксовано.
socketsConfigCapturedSocket[] або nullтакКожен зафіксований сокет разом з його прикріпленнями.
catalogDirsstring[] або nullтакКаталоги каталогу, які було зафіксовано.

Додаткові властивості не дозволені.

ImportResult

Що створило перетворення стороннього джерела і чого воно не змогло перетворити.

ВластивістьТипОбов’язковаОпис
formatstringтакФормат джерела, який було перетворено.
outputDirstringтакКаталог, відносно якого задано кожен шлях у відповіді, і в який було записано файли.
writtenstring[] або nullтакКожен файл, що потрапив на диск, у порядку запису: чернетки, потім запис про те, що записав імпорт. За sync — лише чернетки, які змінила синхронізація, і запис, якщо він змінився. Порожній за dryRun.
filesImportedFile[] або nullтакКожен файл, який записує запит, з його текстом, як за dryRun, так і без нього: кожна чернетка, потім запис про те, що записав імпорт. За sync — кожна чернетка, яку змінює синхронізація, з новим текстом, потім запис, якщо змінюється і він, тож узгоджена синхронізація повертає порожній список.
driftImportDrift[]такКожна частина, яку синхронізація привела у відповідність із джерелом або привела б за dryRun, у порядку, в якому їх називає чернетка; створений файл, який синхронізація видаляє, — одна з них, видалена без ключів. Порожній список для запиту, що не є синхронізацією, для узгодженої синхронізації і для синхронізації, перетворення якої зупинилося, що нічого не записує.
diagnosticsImportDiagnostic[] або nullтакЩо не вдалося перетворити.
decisionsImportDecision[]такЯк імпортер відобразив кожен вузол джерела, у порядку імпортера і точно так, як він про це повідомив: саме це показує вам, де перетворення вгадувало. Передається за обох способів доставки і незалежно від того, чи зупинилося перетворення; порожній список для імпортера, який про це не повідомляє.
owedImportOwed[]ніКожне значення, яке чернетки досі залишають порожнім і якого не змогло надати жодне джерело та не надала жодна відповідь, у порядку запису чернеток — значення, які називають знахідки рівня попередження. Кожна відповідь містить це поле, як порожній список, якщо в чернетках нічого не бракує.
haltedбулеватакЧи зупинилося перетворення, а не завершилося зі знахідками.

Додаткові властивості не дозволені.

ScaffoldEntityResult

Створений чорновий початковий документ, список прикладів, які можна запустити, або записаний приклад — кожна форма відповідає власними полями, а інших не містить.

ВластивістьТипОбов’язковаОпис
kindstringніВид сутності, для якого створено чернетку. Присутній у разі чернетки.
skeletonstringніТекст створеного документа. Присутній у разі чернетки.
examplesScaffoldExample[]ніКожен приклад, який можна запустити і який публікує документація, по одному разу, у порядку назв. Присутній у разі переліку, який щось знайшов.
examplestringніПриклад, який було записано. Присутній у разі запису.
dirstringніКаталог, у який записано приклад, відносно кореня робочого простору — так, як його назвав запит, або, якщо запит його не назвав, як назва прикладу. Присутній у разі запису.
filesstring[]ніКожен записаний файл, відносно dir і з розділенням скісними рисками, у порядку, у якому їх містить документація. Присутній у разі запису.
nextstring[]ніКоманди, які сторінка прикладу наводить для його збирання, рядок за рядком, як їх записано на сторінці, разом із коментарями: перший блок оболонки під її заголовком Build. Відсутній, якщо сторінка їх не наводить.
versionstringніВерсія документації, з якої зчитано приклад: власна версія бінарного файлу, якщо для неї опубліковано документацію, інакше найновіша, опублікована до неї. Присутній у разі запису.

Додаткові властивості не дозволені.

ScaffoldExample

Один приклад, який можна запустити і який публікує документація.

ВластивістьТипОбов’язковаОпис
namestringтакНазва прикладу, яку запит надсилає як example, щоб записати його.
levelstringтакРівень, який сторінка прикладу оголошує для нього.
summarystringтакПерше речення сторінки прикладу.

Додаткові властивості не дозволені.

LintResult

Що знайшла перевірка домовленостей, з підрахунком за рівнем серйозності та переліком за документами. Перевірка всього каталогу, що виконувалася один раз для кожного Release, також містить passes; тоді лічильники та files охоплюють усі проходи разом.

ВластивістьТипОбов’язковаОпис
entitystringніЄдина сутність, яку було перевірено, якщо запит її назвав.
releasestringніRelease, замикання якого було перевірено, якщо запит його назвав.
checkedintegerтакСкільки документів було перевірено. Якщо перевірка виконувалася один раз для кожного Release — сума за всіма проходами: документ, який прочитали два проходи, враховано в кожному з них.
findingsintegerтакСкільки всього знахідок.
errorsintegerтакСкільки з них є помилками.
warningsintegerтакСкільки з них є попередженнями.
infosintegerтакСкільки з них є інформаційними.
filesLintFileFindings[] або nullтакЗнахідки за документами.
haltedбулеватакЧи перевірку було зупинено, а не завершено зі знахідками.
passesLintPass[] або nullніПеревірка всього каталогу по одному проходу; присутня лише тоді, коли вона виконувалася один раз для кожного Release, оскільки робочий простір називає Releases у workspace.releases. Кожен прохід зазначає, для яких Releases було знайдено його знахідки. Відсутня для робочого простору, що не називає жодного, який перевіряється один раз за його власними каталогами, а також для перевірки однієї сутності чи замикання Release.

Додаткові властивості не дозволені.

LintPass

Один прохід перевірки домовленостей усього каталогу в робочому просторі, який надає своїм Releases власні каталоги: Releases, для яких його виконано, каталоги, які він прочитав, і що він там знайшов.

ВластивістьТипОбов’язковаОпис
releasesstring[] або nullтакReleases, для яких виконано прохід, кожен як шлях відносно кореня робочого простору. Releases, що читають ті самі каталоги, мають спільний прохід.
catalogDirsstring[] або nullтакКаталоги, які прочитав прохід, у порядку пошуку, кожен відносно кореня робочого простору, якщо він лежить усередині нього. Порожній, якщо його Releases не читають жодного каталогу, тож прохід нічого не перевірив і не спричинив невдачі жодного з інших.
checkedintegerтакСкільки документів перевірив прохід.
findingsintegerтакСкільки знахідок виявив прохід.
errorsintegerтакСкільки з них є помилками.
warningsintegerтакСкільки з них є попередженнями.
infosintegerтакСкільки з них є інформаційними.
filesLintFileFindings[] або nullтакЗнахідки проходу за документами.

Додаткові властивості не дозволені.

PluginAddResult

Що записало під’єднання плагіна, куди і яку версію воно закріпило.

ВластивістьТипОбов’язковаОпис
typestringтакСокет, до якого під’єднано плагін.
identitystringніІдентичність, до якої розв’язалося під’єднання.
uristringніПосилання, з якого розв’язується прикріплення.
capabilitystringніМожливість, для якої призначене прикріплення.
referencestringніЗакріплене посилання разом із версією.
scopePluginWriteScopeтакУ який документ конфігурації було записано зміну плагіна і наскільки широко він сягає. Типовим для сокета розширень команд є документ рівня всієї машини, тому кожна відповідь каже, який саме документ вона записала.
writtenбулеватакЧи документ конфігурації було записано, а не повернуто викликачеві для розміщення.
contentstringніТекст документа конфігурації — для запиту, який просив показати його, а не записати.
retractionPluginRetractionніЯк маркер застарілості вплинув на те, яку версію плагіна закріплено.
withdrawnбулеваніМає значення true, якщо запит назвав закріплену версію, а оголошення про відкликання, якому довіряє цей робочий простір, відкликало цю версію. Названа версія однаково закріплюється, бо її називання і є перевизначенням. В іншому разі відсутнє, і відсутність не означає, що версію не відкликано: якщо позначки відкликання названої версії не вдалося прочитати, retraction.unscreened пояснює причину, а якщо версію не названо, обирається найновіша опублікована версія і retraction повідомляє, до якого висновку дійшла перевірка відкликання щодо цього вибору.

Додаткові властивості не дозволені.

PluginRemoveResult

Що записало від’єднання плагіна і куди.

ВластивістьТипОбов’язковаОпис
typestringтакСокет, до якого під’єднано плагін.
querystringтакЯке під’єднання було вилучено.
scopePluginWriteScopeтакУ який документ конфігурації було записано зміну плагіна і наскільки широко він сягає. Типовим для сокета розширень команд є документ рівня всієї машини, тому кожна відповідь каже, який саме документ вона записала.

Додаткові властивості не дозволені.

PluginSyncResult

Що змінило узгодження машинних записів сутності Plugin з її модулем.

ВластивістьТипОбов’язковаОпис
entitystringтакДокумент сутності Plugin, який було узгоджено.
hostFunctionsstring[] або nullтакФункції хоста, потрібні модулю, як він їх оголошує.
commandsPluginCLICommand[] або nullтакКоманди, які додає модуль.
changedбулеватакЧи щось у документі справді змінилося.

Додаткові властивості не дозволені.

PluginGenCatalogResult

Документи каталогу, створені генерацією.

ВластивістьТипОбов’язковаОпис
documentsPluginGeneratedDocument[]ніКожен згенерований документ і його текст.
noticesstringніУсе, що генерація хоче повідомити викликачеві.
dryRunбулеватакЧи документи було повернуто, а не записано.

Додаткові властивості не дозволені.

ExplainErrorResult

Що компілятор оголошує про умову, і опубліковані фрагменти, що пояснюють, як виправити авторський код.

ВластивістьТипОбов’язковаОпис
shortCodestringтакКороткий код умови.
codestringтакОписова назва умови.
messagestringтакЩо повідомляє умова, коли її піднято.
entriesExplainErrorEntry[]ніОпубліковані фрагменти, що пояснюють виправлення.
referencestringтакОпублікована адреса, за якою пояснено умову.
notestringніЧому опубліковані фрагменти відсутні, якщо їх не вдалося отримати. Те, що оголошує сам бінарний файл, усе одно повертається.

Додаткові властивості не дозволені.

GetSchemaResult

Схема виду або — якщо запит не назвав жодного — які види можна назвати. Обидві ширини передаються в одній відповіді, а не двома методами, бо «що я можу назвати» і «для яких із них автор пише документи» — це одне питання двох ширин, і дві відповіді довелося б підтримувати узгодженими.

ВластивістьТипОбов’язковаОпис
kindstringніВид, для якого призначена схема.
schemaanyніСама схема, передана так, як її містить бінарний файл.
kindsstring[]ніКожен токен, на який відповідає цей бінарний файл.
entityKindsEntityKindDescriptor[]ніВужчий набір, для якого автор пише документи; кожен елемент поєднує токен, який називає запит, з видом, який оголошує власний заголовок документа.

Додаткові властивості не дозволені.

SkillsInstallResult

Що записало встановлення навички асистента і куди.

ВластивістьТипОбов’язковаОпис
skillstringтакНавичка, яку було записано.
installedSkillsInstalledFolder[]такКожна записана тека навичок у порядку, в якому запит назвав асистентів. Асистенти, що читають одну спільну теку, ділять один запис, бо навичку записують туди один раз.
scopeSkillFolderScopeтакНаскільки далеко сягає встановлення навички. Запит називає один робочий простір, тож відповідь, яка нічого про це не каже, була б прочитана як така, що стосується цього робочого простору, — а для тек окремого користувача, які асистент читає в кожному проєкті, таке прочитання хибне.

Додаткові властивості не дозволені.

SkillsInstalledFolder

Одна тека навичок, яку записало встановлення.

ВластивістьТипОбов’язковаОпис
agentsstring[]такІдентифікатори названих асистентів, які читають цю теку, у порядку, в якому їх назвав запит.
folderstringтакТека навички у вигляді абсолютного шляху.
replacedбулеватакЧи була там копія з рядком коментаря, який містить кожна записана копія навички, — записана попереднім встановленням або взята з опублікованого репозиторію навичок, — і чи її замінено. Файл без цього рядка відхиляється, а не замінюється.

Додаткові властивості не дозволені.

SkillsListResult

Навички, які постачаються з бінарним файлом, і кожен асистент, для якого встановлення може їх записати. Нічого не записується, і ні до чого немає звернення.

ВластивістьТипОбов’язковаОпис
skillsSkillsListedSkill[]такКожна навичка, що постачається з бінарним файлом, у фіксованому порядку.
agentsSkillsListedAgent[]такКожен асистент, для якого встановленню відома тека навичок, упорядкований за ідентифікатором.

Додаткові властивості не дозволені.

SkillsListedSkill

Одна навичка, що постачається з бінарним файлом.

ВластивістьТипОбов’язковаОпис
namestringтакНазва навички, яка також є назвою теки, яку записує встановлення.
descriptionstringтакКоли асистент використовує навичку, як це оголошує сама навичка.

Додаткові властивості не дозволені.

SkillsListedAgent

Один асистент, для якого встановлення може записати навичку, із двома теками, з яких він читає навички.

ВластивістьТипОбов’язковаОпис
idstringтакІдентифікатор, за яким запит називає асистента.
namestringтакВласна назва асистента.
projectFolderstringтакТека відносно кореня проєкту, з розділенням скісними рисками, з якої асистент читає навички проєкту. Встановлення в проєкт записує в неї теку навички в робочому просторі, названому в запиті.
userFolderstringтакТека відносно домашнього каталогу, з розділенням скісними рисками, з якої асистент у кожному проєкті читає власні навички користувача. Встановлення з global записує в неї теку навички.

Додаткові властивості не дозволені.