Lược đồ giao thức truyền tin của daemon nền Aggrega
Tài liệu tham khảo được sinh tự động. Không chỉnh sửa thủ công — hãy sinh lại từ JSON Schema đã xuất bản.
Id của lược đồ: https://aggrega.ai/schemas/serve-wire-v1beta1.schema.json
Các dạng thông điệp được trao đổi với một daemon trình biên dịch chạy nền do aggrega serve khởi động. Một client mở một phiên trên daemon đó bằng bước bắt tay, và chính phiên là thứ xác định phạm vi của các thiết lập và của workspace mà cuộc trao đổi được mở trên đó; daemon là tiến trình trả lời một yêu cầu, gửi một thông báo và giữ những gì nó đã đọc. Giao thức là JSON-RPC 2.0 qua đầu vào và đầu ra chuẩn, mỗi thông điệp được đóng khung bằng một header Content-Length; tài liệu này mô tả phần thân thông điệp, không mô tả cách đóng khung hay tầng truyền tải. Một phần thân là một trong bốn thứ: một yêu cầu do client gửi, một thông báo do client gửi, một thông báo do daemon gửi, hoặc phản hồi mà daemon trả về cho một yêu cầu. Ba đặc tính của bề mặt này quyết định cách các dạng bên dưới được viết. Thứ nhất, mọi yêu cầu đều chấp nhận hai trường ngoài những trường mà phương thức của nó khai báo — workspaceRoot, chỉ định workspace mà yêu cầu tác động lên, và workDoneToken, giá trị do bên gọi tạo ra mà tiến độ được báo cáo theo đó — nên cả hai xuất hiện trên mọi đối tượng params của yêu cầu ở đây, kể cả ba phương thức có đối tượng không phải là một workspace: aggrega/getSchema và aggrega/scaffoldEntity chấp nhận workspaceRoot nhưng bỏ qua nó, còn aggrega/initialize đọc nó như workspace mà phiên khai báo. Thứ hai, daemon từ chối một đối tượng params của yêu cầu có chứa trường mà phương thức không chấp nhận, đồng thời nêu rõ những gì nó chấp nhận, nên mọi đối tượng params ở đây đều đóng ở cấp trên cùng; một đối tượng lồng bên trong một yêu cầu thì không đóng, vì bước kiểm tra chỉ đọc các tên trường ở cấp ngoài cùng. Thứ ba, một kết quả do daemon tạo ra chứ không do bên gọi cung cấp, nên các đối tượng kết quả đóng ở mọi cấp có dạng cố định, và chỉ mở ở những nơi giá trị là JSON không trong suốt mà daemon chuyển tiếp mà không đọc. Một hệ quả của cách mã hóa của daemon hiển hiện trên đường truyền và được mô tả thay vì bị che đi: một tập hợp mà daemon không đánh dấu là tùy chọn được phát ra dưới dạng null khi nó không có giá trị nào để báo cáo và dưới dạng một tập hợp rỗng khi giá trị nó báo cáo là rỗng, nên cả hai dạng đều được chấp nhận ở bất cứ nơi nào điều đó áp dụng.
Một trong các dạng sau
RequestClientNotificationDaemonNotificationSuccessResponseErrorResponse
Định nghĩa
ProtocolVersion
Phiên bản JSON-RPC mà mọi thông điệp mang theo. Chỉ hỗ trợ 2.0.
Loại: const "2.0"
Hằng số: "2.0"
RequestId
Định danh mà bên gọi đặt cho một yêu cầu, được lặp lại trên phản hồi trả lời yêu cầu đó. Một thông điệp không mang định danh là một thông báo và không bao giờ được trả lời.
Loại: string or number
ProgressToken
Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối.
Loại: string or number
WorkspaceRootSubject
Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối.
Loại: string
WorkspaceRootAccepted
Đường dẫn tuyệt đối của một workspace. Chủ thể của phương thức này không phải là một workspace — nó trả lời từ những gì chính tệp nhị phân mang theo — nên trường này được chấp nhận nhưng không được đọc. Nó được cho phép vì client có thể gửi nó đồng loạt trên mọi yêu cầu mà không cần biết phương thức nào sử dụng nó.
Loại: string
RequestMethod
Mọi phương thức mà một yêu cầu có thể nêu. Tập hợp này là đóng: một yêu cầu nêu bất kỳ thứ gì khác sẽ được trả lời bằng lỗi method-not-found.
Loại: string (enum)
Giá trị được phép: "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
Mọi phương thức mà một thông báo của client có thể nêu. Tập hợp này là đóng, và không thông báo nào được trả lời.
Loại: string (enum)
Giá trị được phép: "$/cancelRequest", "aggrega/shutdown"
DaemonNotificationMethod
Mọi phương thức mà một thông báo do daemon gửi có thể nêu. Tập hợp này là đóng.
Loại: string (enum)
Giá trị được phép: "$/progress", "aggrega/publishDiagnostics"
Request
Một yêu cầu do client gửi và daemon trả lời. Phương thức nêu điều được yêu cầu; đối tượng params mang các trường riêng của phương thức đó cùng với hai trường mà mọi phương thức đều cho phép. Một yêu cầu bỏ qua hoàn toàn params được hiểu là một yêu cầu có tất cả các trường đều vắng mặt.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
jsonrpc | ProtocolVersion | có | Phiên bản JSON-RPC mà mọi thông điệp mang theo. Chỉ hỗ trợ 2.0. |
id | RequestId | có | Định danh mà bên gọi đặt cho một yêu cầu, được lặp lại trên phản hồi trả lời yêu cầu đó. Một thông điệp không mang định danh là một thông báo và không bao giờ được trả lời. |
method | RequestMethod | có | Mọi phương thức mà một yêu cầu có thể nêu. Tập hợp này là đóng: một yêu cầu nêu bất kỳ thứ gì khác sẽ được trả lời bằng lỗi method-not-found. |
params | object | không |
Không cho phép thuộc tính bổ sung.
params cho mỗi method:
method | params | Bắt buộc |
|---|---|---|
"aggrega/initialize" | InitializeParams | không |
"aggrega/validate" | ValidateParams | không |
"aggrega/invalidate" | InvalidateParams | không |
"aggrega/diagnostics" | DiagnosticsParams | không |
"aggrega/irGraph" | IrGraphParams | không |
"aggrega/build" | BuildParams | không |
"aggrega/buildPreview" | BuildPreviewParams | không |
"aggrega/entityDefinition" | EntityDefinitionParams | không |
"aggrega/releaseClosure" | ReleaseClosureParams | không |
"aggrega/resolveDependencies" | ResolveDependenciesParams | không |
"aggrega/pin" | PinParams | không |
"aggrega/cacheStatus" | WorkspaceAndProgressParams | không |
"aggrega/cachePrune" | WorkspaceAndProgressParams | không |
"aggrega/cacheEvict" | CacheEvictParams | không |
"aggrega/cacheClear" | WorkspaceAndProgressParams | không |
"aggrega/registryList" | WorkspaceAndProgressParams | không |
"aggrega/search" | SearchParams | không |
"aggrega/registryAdd" | RegistryAddParams | không |
"aggrega/registryRemove" | RegistryRemoveParams | không |
"aggrega/registryUpdate" | RegistryUpdateParams | không |
"aggrega/logout" | LogoutParams | không |
"aggrega/publishEntity" | PublishEntityParams | không |
"aggrega/publishArtifact" | PublishArtifactParams | không |
"aggrega/signArtifacts" | SignArtifactsParams | không |
"aggrega/deprecateArtifact" | DeprecateArtifactParams | không |
"aggrega/resolve" | ResolveParams | không |
"aggrega/findReferences" | FindReferencesParams | không |
"aggrega/findImplementations" | FindImplementationsParams | không |
"aggrega/hover" | HoverParams | không |
"aggrega/completion" | CompletionParams | không |
"aggrega/catalogIndex" | CatalogIndexParams | không |
"aggrega/attachCandidates" | AttachCandidatesParams | không |
"aggrega/connectionCandidates" | ConnectionCandidatesParams | không |
"aggrega/insertionPoint" | InsertionPointParams | không |
"aggrega/attachmentContainer" | AttachmentContainerParams | không |
"aggrega/connectionAtPosition" | ConnectionAtPositionParams | không |
"aggrega/releaseCandidates" | WorkspaceAndProgressParams | không |
"aggrega/activeRelease" | WorkspaceAndProgressParams | không |
"aggrega/setActiveRelease" | SetActiveReleaseParams | không |
"aggrega/editDocument" | EditDocumentParams | không |
"aggrega/effectiveConfiguration" | WorkspaceAndProgressParams | không |
"aggrega/configInit" | ConfigInitParams | không |
"aggrega/configCapture" | ConfigCaptureParams | không |
"aggrega/import" | ImportParams | không |
"aggrega/scaffoldEntity" | ScaffoldEntityParams | không |
"aggrega/lint" | LintParams | không |
"aggrega/pluginAdd" | PluginAddParams | không |
"aggrega/pluginRemove" | PluginRemoveParams | không |
"aggrega/pluginSync" | PluginSyncParams | không |
"aggrega/pluginGenCatalog" | PluginGenCatalogParams | không |
"aggrega/explainError" | ExplainErrorParams | không |
"aggrega/getSchema" | GetSchemaParams | không |
"aggrega/skillsInstall" | SkillsInstallParams | không |
"aggrega/skillsList" | WorkspaceAndProgressParams | không |
ClientNotification
Một thông báo do client gửi. Nó không mang định danh và không bao giờ được trả lời.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
jsonrpc | ProtocolVersion | có | Phiên bản JSON-RPC mà mọi thông điệp mang theo. Chỉ hỗ trợ 2.0. |
method | ClientNotificationMethod | có | Mọi phương thức mà một thông báo của client có thể nêu. Tập hợp này là đóng, và không thông báo nào được trả lời. |
params | object | không |
Không cho phép thuộc tính bổ sung.
params cho mỗi method:
method | params | Bắt buộc |
|---|---|---|
"$/cancelRequest" | CancelRequestParams | có |
"aggrega/shutdown" | ShutdownParams | không |
DaemonNotification
Một thông báo do daemon gửi. Nó không mang định danh và không bao giờ được trả lời.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
jsonrpc | ProtocolVersion | có | Phiên bản JSON-RPC mà mọi thông điệp mang theo. Chỉ hỗ trợ 2.0. |
method | DaemonNotificationMethod | có | Mọi phương thức mà một thông báo do daemon gửi có thể nêu. Tập hợp này là đóng. |
params | object | có |
Không cho phép thuộc tính bổ sung.
params cho mỗi method:
method | params | Bắt buộc |
|---|---|---|
"$/progress" | ProgressParams | có |
"aggrega/publishDiagnostics" | PublishDiagnosticsParams | có |
CancelRequestParams
Yêu cầu daemon từ bỏ một yêu cầu đang được xử lý, nêu nó bằng định danh mà yêu cầu đó mang theo. Một yêu cầu đã hoàn tất, hoặc chưa bao giờ được gửi, đơn giản là không có gì để hủy và không báo lỗi.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
id | RequestId | có | Định danh mà bên gọi đặt cho một yêu cầu, được lặp lại trên phản hồi trả lời yêu cầu đó. Một thông điệp không mang định danh là một thông báo và không bao giờ được trả lời. |
Không cho phép thuộc tính bổ sung.
ShutdownParams
Yêu cầu daemon ngừng nhận công việc và hoàn tất những gì đã nhận. Thông báo này không mang trường nào, và bản thân thông báo thường được gửi mà không có đối tượng params. Một thông báo thứ hai sẽ từ bỏ công việc đang xử lý thay vì chờ nó.
Đối tượng này không khai báo thuộc tính cố định nào và không cho phép thuộc tính nào.
ProgressParams
Một báo cáo về công việc đang tiến hành, chỉ được gửi cho một yêu cầu đã tạo progress token trong một phiên đã khai báo rằng nó có thể nhận chúng.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
token | ProgressToken | có | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
value | ProgressBegin hoặc ProgressReport hoặc ProgressEnd | có | Bản thân báo cáo. Một báo cáo mở đầu, sau đó là số dòng bất kỳ, rồi một báo cáo kết thúc. |
Không cho phép thuộc tính bổ sung.
ProgressBegin
Mở một báo cáo, cho biết điều gì đã bắt đầu theo cách diễn đạt của chính thao tác.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
kind | const “begin” | có | Đánh dấu payload này là phần mở đầu của một báo cáo. Hằng số: "begin" |
title | string | có | Điều gì đã bắt đầu. |
Không cho phép thuộc tính bổ sung.
ProgressReport
Một dòng trong phần tự thuật của chính thao tác. Nó không mang tỷ lệ: các thao tác báo cáo ở đây xử lý một tập hợp có kích thước không biết trước khi công việc bắt đầu, nên một tỷ lệ sẽ phải bịa ra.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
kind | const “report” | có | Đánh dấu payload này là một dòng của một báo cáo đang mở. Hằng số: "report" |
message | string | có | Một dòng đầu ra của chính thao tác, đã loại bỏ khoảng trắng bao quanh. |
Không cho phép thuộc tính bổ sung.
ProgressEnd
Đóng một báo cáo. Nó không mang gì ngoài loại, vì kết quả được truyền trên phản hồi mà bên gọi đang chờ.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
kind | const “end” | có | Đánh dấu payload này là phần kết thúc của một báo cáo. Hằng số: "end" |
Không cho phép thuộc tính bổ sung.
PublishDiagnosticsParams
Các phát hiện cho một tệp, được daemon đẩy đến khi một lần xác thực tạo ra chúng cho một tài liệu khác với tài liệu mà yêu cầu đã nêu.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
file | string | có | Tệp mà các phát hiện đề cập đến. |
diagnostics | Diagnostic[] hoặc null | có | Các phát hiện, theo thứ tự chúng được tạo ra. |
Không cho phép thuộc tính bổ sung.
SuccessResponse
Câu trả lời cho một yêu cầu đã thành công, mang định danh của yêu cầu mà nó trả lời. Một phản hồi không mang phương thức, nên dạng kết quả nào áp dụng được xác định bởi yêu cầu mà định danh thuộc về, chứ không phải bởi bất kỳ thứ gì trong chính phản hồi.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
jsonrpc | ProtocolVersion | có | Phiên bản JSON-RPC mà mọi thông điệp mang theo. Chỉ hỗ trợ 2.0. |
id | RequestId | có | Định danh mà bên gọi đặt cho một yêu cầu, được lặp lại trên phản hồi trả lời yêu cầu đó. Một thông điệp không mang định danh là một thông báo và không bao giờ được trả lời. |
result | InitializeResult hoặc ValidateResult hoặc InvalidateResult hoặc DiagnosticsResult hoặc IrGraphResult hoặc BuildResult hoặc BuildPreviewResult hoặc EntityDefinitionResult hoặc ReleaseClosureResult hoặc ResolveDependenciesResult hoặc PinResult hoặc CacheStatusResult hoặc CachePruneResult hoặc CacheEvictResult hoặc CacheClearResult hoặc RegistryListResult hoặc SearchResult hoặc RegistryAddResult hoặc RegistryRemoveResult hoặc RegistryUpdateResult hoặc LogoutResult hoặc PublishEntityResult hoặc PublishArtifactResult hoặc SignArtifactsResult hoặc DeprecateArtifactResult hoặc ResolveResult hoặc FindReferencesResult hoặc FindImplementationsResult hoặc HoverResult hoặc CompletionResult hoặc CatalogIndexResult hoặc AttachCandidatesResult hoặc ConnectionCandidatesResult hoặc InsertionPointResult hoặc AttachmentContainerResult hoặc ConnectionAtPositionResult hoặc ReleaseCandidatesResult hoặc ActiveReleaseResult hoặc EditDocumentResult hoặc EffectiveConfigurationResult hoặc ConfigInitResult hoặc ConfigCaptureResult hoặc ImportResult hoặc ScaffoldEntityResult hoặc LintResult hoặc PluginAddResult hoặc PluginRemoveResult hoặc PluginSyncResult hoặc PluginGenCatalogResult hoặc ExplainErrorResult hoặc GetSchemaResult hoặc SkillsInstallResult hoặc SkillsListResult | có | Câu trả lời, theo dạng mà phương thức được yêu cầu trả về. |
Không cho phép thuộc tính bổ sung.
ErrorResponse
Câu trả lời cho một yêu cầu đã bị từ chối hoặc thất bại, mang định danh của yêu cầu mà nó trả lời.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
jsonrpc | ProtocolVersion | có | Phiên bản JSON-RPC mà mọi thông điệp mang theo. Chỉ hỗ trợ 2.0. |
id | RequestId | có | Định danh mà bên gọi đặt cho một yêu cầu, được lặp lại trên phản hồi trả lời yêu cầu đó. Một thông điệp không mang định danh là một thông báo và không bao giờ được trả lời. |
error | ErrorObject | có | Điều gì đã sai: một mã mà client có thể dựa vào để rẽ nhánh, một thông điệp viết cho người đọc, và — khi tình trạng có — các artifact và vị trí nguồn mà thông điệp đề cập. |
Không cho phép thuộc tính bổ sung.
ErrorObject
Điều gì đã sai: một mã mà client có thể dựa vào để rẽ nhánh, một thông điệp viết cho người đọc, và — khi tình trạng có — các artifact và vị trí nguồn mà thông điệp đề cập.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
code | ErrorCode | có | Tình trạng mà câu trả lời báo cáo. Các mã âm là tập dành riêng của chính giao thức; các mã bốn chữ số là những tình trạng mà daemon này đưa ra, mỗi mã chỉ một trạng thái mà client có thể xử lý. Tập này là đóng. |
message | string | có | Điều gì đã sai, bằng văn xuôi. Đây là cùng cách diễn đạt mà cùng tình trạng đó mang trên mọi bề mặt khác báo cáo nó. |
data | ErrorData | không | Các artifact và vị trí nguồn mà thông điệp đề cập, được mang theo dạng có cấu trúc để client không cần đọc lại chúng từ văn xuôi. Mọi trường đều tùy chọn và một tình trạng chỉ điền những gì nó có trong tay; không trường nào thay thế cho trường khác, nên client biết mình nhận được gì từ trường nó đọc chứ không phải từ mã bên cạnh. |
Không cho phép thuộc tính bổ sung.
ErrorCode
Tình trạng mà câu trả lời báo cáo. Các mã âm là tập dành riêng của chính giao thức; các mã bốn chữ số là những tình trạng mà daemon này đưa ra, mỗi mã chỉ một trạng thái mà client có thể xử lý. Tập này là đóng.
Loại: 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
Giá trị được phép:
-32700— Không thể phân tích thông điệp dưới dạng JSON.-32600— Thông điệp đã được phân tích nhưng không phải là một yêu cầu đúng định dạng.-32601— Không tồn tại phương thức nào có tên đó.-32602— params mà yêu cầu mang theo không được chấp nhận: một trường mà phương thức không chấp nhận, một trường sai kiểu, hoặc một giá trị mà phương thức từ chối.-32603— Daemon đã thất bại trong khi thực hiện công việc.1001— Daemon không giữ bản đọc nào của tệp và cũng không đang tạo bản đọc nào. Client khởi tạo một bản đọc bằng cách yêu cầu một lần xác thực, rồi thử lại.1003— Lockfile cho Release mà yêu cầu nêu tên không tồn tại, và thao tác cần có nó.1004— Không thể phân giải thực thể mà yêu cầu nêu tên từ catalog hay từ Release mà yêu cầu nêu tên.1005— Daemon đang tắt và từ chối công việc mới. Client không thử lại với cùng daemon đó.1006— Một lần xác thực tệp hiện đang chạy và không hoàn tất trong khoảng thời gian mà yêu cầu đang chờ cho phép. Client chờ rồi hỏi lại, không gửi gì trong lúc đó.
ErrorData
Các artifact và vị trí nguồn mà thông điệp đề cập, được mang theo dạng có cấu trúc để client không cần đọc lại chúng từ văn xuôi. Mọi trường đều tùy chọn và một tình trạng chỉ điền những gì nó có trong tay; không trường nào thay thế cho trường khác, nên client biết mình nhận được gì từ trường nó đọc chứ không phải từ mã bên cạnh.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
file | string | không | Tài liệu nguồn mà các trường vị trí định vị — tài liệu đang được kiểm tra, hoặc Release mà việc tải đã thất bại. |
line | integer | không | Dòng mà tình trạng đề cập, đếm từ một. |
column | integer | không | Cột mà tình trạng đề cập, đếm từ một. |
end_line | integer | không | Dòng ngay sau điểm kết thúc của token mà tình trạng đề cập. Vắng mặt khi token không có điểm kết thúc khôi phục được, khi đó client hiển thị vị trí như một điểm. |
end_column | integer | không | Cột ngay sau điểm kết thúc của token mà tình trạng đề cập. |
release | string | không | Release mà tình trạng đề cập, viết theo cách yêu cầu đã gọi tên nó, để client có thể soạn cách khắc phục mà không phải ghép lại. |
lockfile | string | không | Lockfile mà một tình trạng phạm vi lockfile nói đến: đường dẫn đã được tìm mà không thấy, hoặc không thể đọc. |
unreachable | boolean | không | Liệu sự từ chối có phải là một registry mà yêu cầu đã nêu nhưng không thể truy cập: tên của nó không phân giải được, kết nối tới nó bị từ chối hoặc không thể mở, hoặc không thể thiết lập kết nối bảo mật tới nó. Giá trị này được đọc từ chính lỗi chứ không phải từ thông điệp, và chỉ được đặt khi lỗi cho thấy registry chưa bao giờ được truy cập. Một lần làm mới index bị từ chối nêu tên một registry sẽ mang nó; một registry đã trả lời, dù trả lời gì, sẽ để nó vắng mặt. |
code | string | không | Tên mô tả của tình trạng mà sự từ chối nêu ra, ổn định qua các bản phát hành: cùng giá trị mà một chẩn đoán báo cáo tình trạng đó mang trong mã của chính nó. Đây là thứ client dựa vào để rẽ nhánh, thay vì thông điệp hay mã số bên cạnh, vốn chỉ trạng thái của yêu cầu và giữ nguyên cho mọi tình trạng. Có mặt đúng khi sự từ chối nêu một tình trạng đã đăng ký, và vắng mặt khi không nêu tình trạng nào. |
shortCode | string | không | Mã ngắn của tình trạng, chữ E và bốn chữ số: dạng mà người đọc trích dẫn và tra cứu, và là dạng mở đầu thông điệp của một sự từ chối nêu một tình trạng. Có mặt đúng khi code có mặt. |
Không cho phép thuộc tính bổ sung.
Diagnostic
Một phát hiện về một tài liệu: nó ở đâu, nghiêm trọng đến mức nào, nó nói gì, và mã có thể trích dẫn chỉ tình trạng mà nó báo cáo.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
line | integer | có | Dòng mà phát hiện nói đến, đếm từ một. |
column | integer | có | Cột mà phát hiện nói đến, đếm từ một. |
severity | const “error” hoặc const “warning” hoặc const “info” | có | Mức độ nghiêm trọng của phát hiện. Giá trị được phép: "error" — Phát hiện là một lỗi. Một phát hiện của plugin có mức độ halt được báo cáo ở cấp này. "warning" — Phát hiện được báo cáo và không phải là lỗi. Một phát hiện của plugin có mức độ warn được báo cáo ở cấp này. "info" — Phát hiện mang tính thông tin, như một phát hiện của plugin có mức độ info. |
message | string | có | Nội dung của phát hiện, bằng văn xuôi. |
code | string | không | Tên mô tả của tình trạng, ổn định qua các bản phát hành và có thể trích dẫn trong một lệnh chặn (suppression). |
shortCode | string | không | Mã ngắn của tình trạng, dạng mở đầu một chẩn đoán gây dừng. |
codeDescription | CodeDescription | không | Nơi giải thích tình trạng mà phát hiện nêu ra. |
classification | string | không | Cách phát hiện được đưa ra, khi tình trạng có phân biệt điều đó. |
suggest | string | không | Cách viết mà phát hiện đề xuất, khi tình trạng có thể nêu một cách — chẳng hạn một định danh gần đúng. |
keyPath | string | không | Đường dẫn trong tài liệu tới khóa mà phát hiện nói đến. |
source | string | có | Thứ đã tạo ra phát hiện. |
end_line | integer | không | Dòng ngay sau điểm kết thúc của token mà phát hiện nói đến, để client có thể hiển thị toàn bộ token thay vì một ký tự. Vắng mặt với token trải dài nhiều dòng. |
end_column | integer | không | Cột ngay sau điểm kết thúc của token mà phát hiện nói đến. |
Không cho phép thuộc tính bổ sung.
CodeDescription
Nơi giải thích tình trạng mà phát hiện nêu ra.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
href | string | có | Địa chỉ đã công bố nơi tình trạng được giải thích. |
Không cho phép thuộc tính bổ sung.
Position
Một vị trí trong tài liệu: một dòng và một độ lệch ký tự trong dòng đó, cả hai đếm từ không. Độ lệch được đo theo đơn vị của bảng mã mà phiên đã thống nhất khi được mở, là UTF-16 trừ khi client yêu cầu bảng mã khác.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
line | integer | có | Dòng, đếm từ không. |
character | integer | có | Độ lệch trong dòng, đếm từ không, theo đơn vị của bảng mã mà phiên đã thống nhất. |
Không cho phép thuộc tính bổ sung.
Range
Một khoảng giữa hai vị trí trong tài liệu.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
start | Position | có | Một vị trí trong tài liệu: một dòng và một độ lệch ký tự trong dòng đó, cả hai đếm từ không. Độ lệch được đo theo đơn vị của bảng mã mà phiên đã thống nhất khi được mở, là UTF-16 trừ khi client yêu cầu bảng mã khác. |
end | Position | có | Một vị trí trong tài liệu: một dòng và một độ lệch ký tự trong dòng đó, cả hai đếm từ không. Độ lệch được đo theo đơn vị của bảng mã mà phiên đã thống nhất khi được mở, là UTF-16 trừ khi client yêu cầu bảng mã khác. |
Không cho phép thuộc tính bổ sung.
Location
Một khoảng trong một tài liệu được đặt tên.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
uri | string | có | Tài liệu chứa khoảng đó, được định địa chỉ bằng một URI. |
range | Range | có | Một khoảng giữa hai vị trí trong tài liệu. |
Không cho phép thuộc tính bổ sung.
WorkspaceAndProgressParams
Đối tượng params của một phương thức không khai báo trường riêng nào. Nó vẫn chấp nhận hai trường mà mọi yêu cầu đều chấp nhận: workspace mà nó tác động, và một progress token.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
Không cho phép thuộc tính bổ sung.
InitializeParams
Mở một phiên trên một workspace và nêu những gì client có thể xử lý. Đây là phương thức duy nhất mà trên đó workspaceRoot là một khai báo chứ không phải một chủ thể: vắng mặt, rỗng và một đường dẫn là ba điều khác nhau, và một phiên được mở mà không có đường dẫn là phiên mà client chưa trỏ tới một workspace nào.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
capabilities | ClientCapabilities | không | Những gì client có thể xử lý. Điều không được nêu được coi là không hỗ trợ. Các thành viên không xác định bị bỏ qua chứ không bị từ chối, nên client có thể nêu một khả năng mà daemon này chưa đọc. |
workspaceRoot | string | không | Đường dẫn tuyệt đối của workspace cần mở. Nếu vắng mặt, phiên sẽ không có workspace; một chuỗi rỗng là một đường dẫn do client cung cấp và không giống với việc không gửi gì. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
Không cho phép thuộc tính bổ sung.
ClientCapabilities
Những gì client có thể xử lý. Điều không được nêu được coi là không hỗ trợ. Các thành viên không xác định bị bỏ qua chứ không bị từ chối, nên client có thể nêu một khả năng mà daemon này chưa đọc.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
general | object | không | Các khả năng không gắn với một loại câu trả lời cụ thể. |
window | object | không | Các khả năng về những gì client có thể hiển thị trong khi công việc đang diễn ra. |
Cho phép thuộc tính bổ sung.
ClientCapabilities.general
Các khả năng không gắn với một loại câu trả lời cụ thể.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
positionEncodings | string[] | không | Các bảng mã vị trí mà client có thể đọc, theo thứ tự ưu tiên từ tốt nhất. |
Cho phép thuộc tính bổ sung.
ClientCapabilities.window
Các khả năng về những gì client có thể hiển thị trong khi công việc đang diễn ra.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workDoneProgress | boolean | không | Client có thể nhận thông báo tiến độ hay không. Một yêu cầu tạo progress token trong một phiên chưa khai báo điều này sẽ bị từ chối. |
Cho phép thuộc tính bổ sung.
ValidateParams
Kiểm tra workspace, hoặc một tài liệu trong đó, và trả lời bằng các phát hiện.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
file | string | không | Tài liệu cần kiểm tra. Nếu vắng mặt, kiểm tra những gì workspace chứa. |
content | string | không | Văn bản của tài liệu như client hiện đang giữ, để kiểm tra một buffer chưa được lưu. Nếu vắng mặt, đọc các byte trên đĩa. |
release | string | không | Release dùng để kiểm tra đối chiếu, dưới dạng đường dẫn tương đối so với thư mục gốc của workspace. |
Không cho phép thuộc tính bổ sung.
InvalidateParams
Báo cho daemon biết rằng một tài liệu mà nó đang giữ bản đọc đã thay đổi, để câu trả lời tiếp theo về tài liệu đó được tính từ các byte mới.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
file | string | không | Tài liệu đã thay đổi. |
granularity | string | không | Bao nhiêu phần trong những gì daemon giữ cần loại bỏ: file chỉ loại bỏ những gì nó giữ cho tài liệu được nêu tên; workspace, giá trị mặc định và là cách mọi giá trị khác được hiểu, loại bỏ thêm những gì nó giữ cho toàn bộ workspace. |
Không cho phép thuộc tính bổ sung.
DiagnosticsParams
Trả lời bằng các phát hiện mà daemon đã giữ cho một tài liệu, mà không kiểm tra lại.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
file | string | không | Tài liệu cần báo cáo. Daemon phải đã giữ một bản đọc của tài liệu đó. |
Không cho phép thuộc tính bổ sung.
IrGraphParams
Trả lời bằng đồ thị đã phân giải mà một Release biên dịch thành, mà không render nó.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
release | string | không | Release cần phân giải, dưới dạng đường dẫn tương đối so với thư mục gốc của workspace. Đường dẫn tuyệt đối sẽ bị từ chối. |
unredacted | boolean | không | Có trả lời bằng các giá trị mà tác giả đã khai báo là nhạy cảm ở dạng rõ hay không. Nếu vắng mặt hoặc false, mỗi giá trị đó bị giữ lại khỏi đồ thị và một dấu đánh dấu nêu lý do đứng thay vào chỗ của nó, như đầu ra đồ thị của dòng lệnh giữ lại chúng; true trả lời bằng đồ thị đúng như Release biên dịch thành, bao gồm cả các giá trị đó. |
Không cho phép thuộc tính bổ sung.
BuildParams
Biên dịch một Release và ghi các artifact đã render vào workspace.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
release | string | không | Release cần build, dưới dạng đường dẫn tương đối so với thư mục gốc của workspace. Đường dẫn tuyệt đối sẽ bị từ chối. |
outputParent | string | không | Thư mục mà bên trong đó thư mục đầu ra được tạo, dưới dạng đường dẫn tương đối so với thư mục gốc của workspace. Các artifact nằm trong thư mục đầu ra bên dưới nó, được bố trí như khi nằm bên dưới thư mục gốc của workspace lúc không có gì được chỉ định — vì vậy giá trị này chỉ định thư mục cha của thư mục đầu ra và không bao giờ là chính thư mục đầu ra. Nếu vắng mặt hoặc rỗng, thư mục đầu ra được ghi bên dưới thư mục gốc của workspace, như aggrega build làm bất kể được chạy từ đâu. Đường dẫn tuyệt đối, hoặc đường dẫn vượt ra ngoài workspace, sẽ bị từ chối. |
autoPull | boolean | không | Có phân giải các phụ thuộc của Release trước hay không. Yêu cầu điều này sẽ truy cập các registry đã cấu hình và ghi lockfile; nếu không yêu cầu, quá trình build không truy cập registry nào. |
policyInput | string | không | Thư mục để ghi, bên cạnh các artifact, payload mà mỗi vai trò quản trị trao cho một plugin được gắn ở đó, dưới dạng đường dẫn tương đối so với gốc workspace — các tệp mà aggrega build --policy-input ghi, với cùng tên, được ghi dù bản build hoàn tất hay dừng lại. Các thông báo của câu trả lời cho biết đã ghi bao nhiêu tệp và nêu tên từng vai trò không được ghi tệp nào. Với một yêu cầu thất bại, các tệp đã ghi vẫn nằm trên đĩa và phần tường trình đó không có trong phản hồi: lỗi chỉ mang lời từ chối. Khi vắng mặt, không ghi gì. Đường dẫn tuyệt đối, hoặc đường dẫn vượt ra ngoài workspace, bị từ chối. |
Không cho phép thuộc tính bổ sung.
BuildPreviewParams
Biên dịch một Release và báo cáo việc ghi các artifact sẽ tạo ra những gì, mà không ghi artifact nào. Nó từ chối trường phân giải phụ thuộc mà bản build có ghi nhận, vì một yêu cầu không ghi gì thì không thể điền một lockfile.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
release | string | không | Release cần biên dịch, dưới dạng đường dẫn tương đối so với thư mục gốc của workspace. |
autoPull | boolean | không | Được chấp nhận trên giao thức nhưng bị phương thức từ chối: yêu cầu này không ghi gì, nên nó không thể điền một lockfile mà vẫn đúng như những gì nó tự nhận. |
policyInput | string | không | Thư mục để ghi payload mà mỗi vai trò quản trị trao cho một plugin được gắn ở đó, dưới dạng đường dẫn tương đối so với gốc workspace — các tệp mà aggrega build --dry-run --policy-input ghi, với cùng tên. Khi được gửi, chúng là thứ duy nhất mà yêu cầu này ghi; thư mục đầu ra và lockfile được giữ nguyên. Các thông báo của câu trả lời cho biết đã ghi bao nhiêu tệp và nêu tên từng vai trò không được ghi tệp nào. Với một yêu cầu thất bại, các tệp đã ghi vẫn nằm trên đĩa và phần tường trình đó không có trong phản hồi: lỗi chỉ mang lời từ chối. Đường dẫn tuyệt đối, hoặc đường dẫn vượt ra ngoài workspace, bị từ chối. |
Không cho phép thuộc tính bổ sung.
EntityDefinitionParams
Trả lời bằng những gì một tên thực thể phân giải thành và nơi chứa tài liệu định nghĩa nó.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
name | string | không | Thực thể cần phân giải, theo tên — hoặc một tham chiếu registry, oci://<host>/<repository>:<tag> hoặc @<digest> thay cho :<tag>, để đọc thực thể được xuất bản tại tọa độ đó. |
release | string | không | Release mà theo đó tên được phân giải, dưới dạng đường dẫn tương đối so với thư mục gốc của workspace. Khi đó tên được phân giải qua các thư mục catalog mà cấu hình workspace cấp cho Release đó, nên một tên được nhiều biến thể trong cùng một workspace khai báo, mỗi Release một biến thể, sẽ phân giải thành biến thể mà Release đó dùng để build, và một tên mà nó không phân giải được sẽ bị từ chối kèm một giải trình nêu mục của Release đó trong workspace.releases. Nếu vắng mặt, tên được phân giải qua chính các thư mục catalog của workspace. Một tham chiếu registry không nhận Release nào và bị từ chối nếu kèm một Release, cũng như một giá trị không chỉ tới tệp Release nào. |
Không cho phép thuộc tính bổ sung.
CatalogIndexParams
Trả lời bằng các thực thể mà workspace chứa: mọi thực thể mà các tài liệu của nó khai báo, và các Features mà các thư mục catalog của nó khai báo.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
release | string | không | Release mà theo đó các thực thể được liệt kê, dưới dạng đường dẫn tương đối so với thư mục gốc của workspace. Khi đó các Features là những Features được khai báo bởi các thư mục catalog mà cấu hình workspace cấp cho Release đó, và một tài liệu nằm trong thư mục catalog chỉ các Releases khác đọc sẽ bị bỏ qua, nên một workspace giữ song song các biến thể của một thực thể, mỗi Release một biến thể, được liệt kê với biến thể mà Release đó dùng để build. Nếu vắng mặt, danh sách là của chính workspace. Một giá trị không chỉ tới tệp Release nào sẽ bị từ chối. |
Không cho phép thuộc tính bổ sung.
ReleaseClosureParams
Trả lời bằng mọi thứ mà một Release phụ thuộc vào, theo những gì quá trình phân giải đã đạt tới.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
release | string | không | Release cần kiểm tra, dưới dạng đường dẫn tương đối so với thư mục gốc của workspace. |
Không cho phép thuộc tính bổ sung.
ResolveDependenciesParams
Phân giải các phụ thuộc của một Release, ghim chúng trong lockfile và thu thập các đầu vào bên ngoài mà quá trình render của nó sử dụng. Nó truy cập các registry đã cấu hình và có ghi dữ liệu.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
release | string | không | Release cần phân giải, dưới dạng đường dẫn tương đối so với thư mục gốc của workspace. |
upgrade | boolean | không | Có phân giải lại trong phạm vi đã khai báo thay vì tuân theo những gì lockfile đã ghim hay không. |
targets | string[] | không | Các tham chiếu cần phân giải lại, giữ nguyên phần còn lại như đã ghim. Rỗng thì phân giải tất cả. |
verify | boolean | không | Có so sánh lockfile đã ghi với kết quả phân giải mà yêu cầu này sẽ thực hiện khi không có nó, tuân theo các ghim mà yêu cầu đó sẽ tuân theo, thay vì ghi nó hay không. Một lần verify không ghi lockfile, bản ghi tin cậy plugin hay entity.lock; bộ nhớ đệm nội dung được đọc và điền như quá trình phân giải đó sẽ đọc và điền. Sai lệch, và việc thiếu lockfile, làm yêu cầu thất bại. Không thể kết hợp với upgrade, targets hoặc pinSources, bất kể pinSources mang giá trị nào: một yêu cầu gửi kèm một trong số đó sẽ bị từ chối là tham số không hợp lệ trước khi bất cứ thứ gì được phân giải. |
pinSources | boolean | không | Có chạy bước ghim mà aggrega/pin chạy trên các Recipes và FeatureRecipes mà Release build từ các thư mục catalog của workspace, ghi entity.lock bên cạnh mỗi cái, thay vì từ chối yêu cầu vì một cái có lock không ghi nhận một ghim mà một đầu vào cần hay không. Nếu vắng mặt thì theo pin_sources_at_pull của workspace; giá trị nào cũng ghi đè thiết lập đó cho yêu cầu này. |
Không cho phép thuộc tính bổ sung.
PinParams
Ghi lại, trong entity.lock bên cạnh một Recipe hoặc FeatureRecipe, ghim nội dung cho mọi đầu vào mà thực thể đọc từ bên ngoài tài liệu của chính nó. Không có Release nào được nêu tên: một đầu vào mà thực thể viết đầy đủ danh tính sẽ chỉ định một artifact cho mọi Release sử dụng thực thể đó, nên không cần thứ gì do một Release cung cấp để ghim nó. Yêu cầu này kết nối tới các host mà nguồn của thực thể nêu tên và ghi bên cạnh thực thể; bản thân tài liệu thực thể không bao giờ bị ghi.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
entity | string | không | Tài liệu thực thể cần ghim, dưới dạng đường dẫn tương đối so với thư mục gốc của workspace. |
dryRun | boolean | không | Có trả lời bằng tệp khóa mà bước này sẽ ghi thay vì ghi nó hay không. Các đầu vào vẫn được phân giải, nên bộ nhớ đệm nội dung vẫn được lấp đầy. |
Không cho phép thuộc tính bổ sung.
CacheEvictParams
Thu hồi nội dung trong bộ nhớ đệm cho đến khi phần còn lại vừa dưới kích thước mà yêu cầu nêu ra.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
maxSize | string | không | Kích thước cần thu hồi xuống, viết theo cách một người thường viết — ví dụ 500MB. |
Không cho phép thuộc tính bổ sung.
SearchParams
Tìm kiếm những gì các chỉ mục cục bộ của các registry đã cấu hình cung cấp. Yêu cầu này đọc chỉ mục đã có trên đĩa và không liên hệ với registry nào.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
query | string | không | Văn bản để đối chiếu với tên và mô tả của một bản ghi. |
kinds | string[] | không | Các loại thực thể cần giữ lại. Để trống sẽ giữ mọi loại. |
selector | string | không | Bộ chọn nhãn mà các bản ghi được giữ lại phải thỏa mãn. |
capabilities | string[] | không | Các khả năng mà một bản ghi plugin được giữ lại phải khai báo. |
pluginType | string | không | Loại plugin cần giữ lại. |
registry | string | không | Host registry duy nhất cần tìm kiếm. Nếu vắng mặt, tìm kiếm trên mọi host đã cấu hình. |
limit | integer | không | Số bản ghi tối đa để trả lời. |
includeRetracted | boolean | không | Có giữ lại các phiên bản mà một dấu đánh dấu đã công bố đã đánh dấu là lỗi thời hay không. |
Không cho phép thuộc tính bổ sung.
RegistryAddParams
Đăng ký một registry và chính sách tin cậy mà quá trình phân giải áp dụng cho những gì nó cung cấp. Yêu cầu này ghi tệp cấu hình cho toàn máy trừ khi yêu cầu chỉ định khác, nên mọi workspace trên máy đều phân giải qua mục này.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
host | string | không | Host registry cần đăng ký. |
name | string | không | Một bí danh thân thiện được phân giải thành host. |
identities | string[] | không | Các danh tính ký được tin cậy cho những gì registry này cung cấp. |
keyPath | string | không | Đường dẫn của một khóa công khai cần tin cậy, dành cho registry được ký bằng khóa đó thay vì bằng danh tính không khóa. |
trustedRoot | string | không | Đường dẫn của neo tin cậy dùng để xác minh chữ ký. |
requireSignatures | boolean | không | Một artifact từ registry này có bắt buộc mang chữ ký đã xác minh hay không. Nếu vắng mặt, không nêu gì và giữ nguyên giá trị mặc định đã phân giải. |
advisory | boolean | không | Một lần xác minh thất bại có được báo cáo thay vì dừng lại hay không. |
fetchTrust | boolean | không | Có đọc chính sách tin cậy mà registry công bố và ghim nó hay không. Nếu vắng mặt, không nêu gì và giữ nguyên giá trị mặc định đã phân giải. |
global | boolean | không | Ghi tệp cấu hình cho toàn máy, đây là mặc định của chính phương thức này. |
workspace | boolean | không | Ghi tệp cấu hình riêng của workspace này thay vì tệp cho toàn máy. |
Không cho phép thuộc tính bổ sung.
RegistryRemoveParams
Xóa một registry đã đăng ký. Yêu cầu này ghi tệp cấu hình cho toàn máy trừ khi yêu cầu chỉ định khác.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
registry | string | không | Registry cần xóa, theo host hoặc theo bí danh. |
global | boolean | không | Ghi tệp cấu hình cho toàn máy, đây là mặc định của chính phương thức này. |
workspace | boolean | không | Ghi tệp cấu hình riêng của workspace này thay vì tệp cho toàn máy. |
Không cho phép thuộc tính bổ sung.
RegistryUpdateParams
Làm mới chỉ mục cục bộ mà một lần tìm kiếm đọc, bằng cách kết nối tới registry. Thứ nó ghi là chỉ mục nằm trong thư mục bộ nhớ đệm đã cấu hình của chính workspace này. Một registry cần thông tin xác thực mà không nguồn sẵn có nào mang theo sẽ bị từ chối kèm tên thông tin xác thực đó, thay vì nhắc người dùng nhập.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
registry | string | không | Registry duy nhất cần làm mới. Nếu vắng mặt, làm mới mọi host đã cấu hình. |
upgrade | boolean | không | Có xây dựng lại chỉ mục thay vì bổ sung vào những gì nó đã chứa hay không. |
Không cho phép thuộc tính bổ sung.
LogoutParams
Xóa một thông tin xác thực registry đã lưu. Kho lưu trữ được dùng chung bởi mọi dự án trên máy, và câu trả lời có nêu rõ điều đó.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
registry | string | không | Registry có thông tin xác thực đã lưu cần xóa. |
Không cho phép thuộc tính bổ sung.
PublishEntityParams
Xuất bản một thực thể lên registry. Những gì nó đưa lên là những gì mọi bên sử dụng registry đó sẽ phân giải, và một phiên bản đã xuất bản không thể thu hồi khỏi bất kỳ ai đã tải nó về. Không có gì được hỏi qua lời nhắc: danh tính được phân giải từ những gì yêu cầu cung cấp hoặc những gì môi trường đã có sẵn.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
entity | string | không | Tài liệu thực thể cần xuất bản, dưới dạng đường dẫn tương đối so với thư mục gốc của workspace. |
registry | string | không | Registry để xuất bản lên. Nếu vắng mặt, dùng giá trị mặc định đã cấu hình. |
dryRun | boolean | không | Có báo cáo những gì việc xuất bản sẽ đưa lên mà không thực sự đưa lên hay không. |
sign | boolean | không | Có ký những gì được xuất bản hay không. Nếu vắng mặt, không khẳng định gì và giữ nguyên giá trị mặc định đã phân giải. |
plugin | string | không | Module plugin cần xuất bản cùng với một thực thể Plugin. |
fulcioUrl | string | không | Tổ chức cấp chứng chỉ để lấy chứng chỉ ký. |
rekorUrl | string | không | Nhật ký minh bạch để ghi lại chữ ký. |
timestampUrl | string | không | Tổ chức cấp dấu thời gian để ký xác nhận kèm. |
identityToken | string | không | Token danh tính dùng để ký, do bên gọi cung cấp thay vì lấy tại terminal. |
pinSources | boolean | không | Có chạy bước ghim mà aggrega/pin chạy trên thực thể trước khi nó được đóng gói hay không, để entity.lock mà bước này ghi bên cạnh thực thể trở thành một phần của những gì được xuất bản. Bước này chạy trước mọi lần từ chối có đánh giá thực thể, và dưới dryRun nó báo cáo tệp khóa mà nó sẽ ghi và không ghi gì cả. Nếu vắng mặt, tuân theo pin_sources_at_push của workspace; giá trị nào cũng ghi đè thiết lập đó cho yêu cầu này. |
Không cho phép thuộc tính bổ sung.
PublishArtifactParams
Xuất bản một tệp bất kỳ lên registry dưới tên và tag mà yêu cầu chỉ định.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
file | string | không | Tệp cần xuất bản, dưới dạng đường dẫn tương đối so với thư mục gốc của workspace. |
name | string | không | Tên repository để xuất bản dưới đó. |
tag | string | không | Tag để xuất bản dưới đó. |
mediaType | string | không | Media type cần ghi nhận cho các byte được xuất bản. |
registry | string | không | Registry để xuất bản lên. Nếu vắng mặt, dùng giá trị mặc định đã cấu hình. |
dryRun | boolean | không | Có báo cáo những gì việc xuất bản sẽ đưa lên mà không thực sự đưa lên hay không. |
Không cho phép thuộc tính bổ sung.
SignArtifactsParams
Ký những gì đã được xuất bản. Một chữ ký không thể thu hồi khỏi bất kỳ ai đã tải nó về.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
references | string[] | không | Các tham chiếu đã xuất bản cần ký. |
fulcioUrl | string | không | Tổ chức cấp chứng chỉ để lấy chứng chỉ ký. |
rekorUrl | string | không | Nhật ký minh bạch để ghi lại chữ ký. |
timestampUrl | string | không | Tổ chức cấp dấu thời gian để ký xác nhận kèm. |
identityToken | string | không | Token danh tính dùng để ký, do bên gọi cung cấp thay vì lấy tại terminal. |
jobs | integer | không | Số tham chiếu được ký cùng lúc. Khi vắng mặt, ký lần lượt từng cái một. Mỗi tham chiếu vẫn được ký đúng như khi ký riêng lẻ — với keyless, bằng chứng chỉ riêng và mục nhật ký minh bạch riêng của nó — và câu trả lời giữ thứ tự mà các tham chiếu được đưa ra. Tối thiểu: 1. |
Không cho phép thuộc tính bổ sung.
DeprecateArtifactParams
Đánh dấu một phiên bản đã xuất bản là không còn được khuyến dùng, để quá trình phân giải có thể báo cáo hoặc từ chối nó. Bản thân dấu đánh dấu cũng được xuất bản và ký. Một yêu cầu gửi hoặc một tham chiếu kèm nội dung của nó, hoặc một tệp batch có các mục mang nội dung riêng — không bao giờ cả hai, và không bao giờ có nội dung bên cạnh tệp batch.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
reference | string | không | Tham chiếu đã xuất bản cần đánh dấu. Một phương án thay thế cho from: yêu cầu mang cả hai sẽ bị từ chối. |
severity | const “warning” hoặc const “error” hoặc const “retracted” | không | Mức độ mạnh của dấu hiệu — liệu việc phân giải báo cáo phiên bản đó hay từ chối nó. Bắt buộc khi có reference; bị từ chối khi đi cùng from, tham số có tệp batch mang giá trị riêng của từng dấu hiệu. Giá trị được phép: "warning" — Ngừng hỗ trợ, ở cấp nhẹ hơn trong hai cấp khuyến cáo: vẫn được chọn khi chọn một phiên bản. "error" — Ngừng hỗ trợ, ở cấp mạnh hơn trong hai cấp khuyến cáo: vẫn được chọn khi chọn một phiên bản. "retracted" — Thu hồi: bị loại trừ khi chọn một phiên bản. |
reason | string | không | Lý do phiên bản không còn được khuyến dùng. Bắt buộc khi có reference; bị từ chối khi đi cùng from, tham số có tệp batch mang giá trị riêng của từng dấu hiệu. |
replacement | string | không | Tham chiếu cần dùng thay thế. Bị từ chối khi đi cùng from, tham số có tệp batch mang giá trị riêng của từng dấu hiệu. |
message | string | không | Thông điệp được đưa ra cho bên sử dụng gặp dấu đánh dấu. Bị từ chối khi đi cùng from, tham số có tệp batch mang giá trị riêng của từng dấu đánh dấu. |
from | string | không | Một tệp batch gồm các mục thu hồi, ở dạng đường dẫn tương đối với thư mục gốc của workspace, gắn một dấu hiệu cho mỗi mục. Mỗi mục mang tham chiếu, mức độ nghiêm trọng và lý do riêng, và tùy chọn một bản thay thế và một thông điệp. Một phương án thay thế cho reference: yêu cầu mang cả hai, hoặc mang mức độ nghiêm trọng, lý do, bản thay thế hay thông điệp bên cạnh nó, sẽ bị từ chối. |
fulcioUrl | string | không | Tổ chức cấp chứng chỉ để lấy chứng chỉ ký. |
rekorUrl | string | không | Nhật ký minh bạch để ghi lại chữ ký. |
timestampUrl | string | không | Tổ chức cấp dấu thời gian để ký xác nhận kèm. |
identityToken | string | không | Token danh tính dùng để ký, do bên gọi cung cấp thay vì lấy tại terminal. |
Không cho phép thuộc tính bổ sung.
ResolveParams
Trả lời nơi định nghĩa của thứ nằm dưới con trỏ.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
uri | string | không | Tài liệu chứa con trỏ. |
position | Position | không | Một vị trí trong tài liệu: một dòng và một độ lệch ký tự trong dòng đó, cả hai đếm từ không. Độ lệch được đo theo đơn vị của bảng mã mà phiên đã thống nhất khi được mở, là UTF-16 trừ khi client yêu cầu bảng mã khác. |
release | string | không | Release dùng làm khung để trả lời, dưới dạng đường dẫn tương đối với thư mục gốc của workspace. Khi đó, định nghĩa là tài liệu mà tham chiếu phân giải tới thông qua các thư mục catalog mà cấu hình workspace cấp cho Release đó, theo đúng thứ tự đó, nên một tên mà nhiều biến thể trong cùng một workspace khai báo, mỗi biến thể cho một Release, sẽ dẫn tới biến thể của Release đó; nếu các thư mục đó không khai báo thực thể nào như vậy, các tài liệu của workspace sẽ được tìm kiếm, bỏ qua mọi tài liệu nằm dưới một thư mục catalog của workspace mà Release không đọc. Khi vắng mặt, các tài liệu của workspace được tìm kiếm trước, và các thư mục catalog riêng của workspace chỉ được tìm khi không tài liệu nào khai báo tên đó. Giá trị không chỉ tới tệp Release nào sẽ bị từ chối. |
Không cho phép thuộc tính bổ sung.
FindReferencesParams
Trả lời những nơi thứ nằm dưới con trỏ được tham chiếu tới.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
uri | string | không | Tài liệu chứa con trỏ. |
position | Position | không | Một vị trí trong tài liệu: một dòng và một độ lệch ký tự trong dòng đó, cả hai đếm từ không. Độ lệch được đo theo đơn vị của bảng mã mà phiên đã thống nhất khi được mở, là UTF-16 trừ khi client yêu cầu bảng mã khác. |
release | string | không | Release dùng làm khung để trả lời, dưới dạng đường dẫn tương đối với thư mục gốc của workspace. Khi đó, một tham chiếu nằm trong tài liệu dưới một thư mục catalog của workspace mà Release không đọc sẽ không được báo cáo, nên các biến thể mà workspace giữ song song, mỗi biến thể cho một Release, không bao giờ bị báo cáo là tham chiếu của nhau. Khi vắng mặt, mọi tài liệu của workspace đều được tìm kiếm. Giá trị không chỉ tới tệp Release nào sẽ bị từ chối. |
Không cho phép thuộc tính bổ sung.
FindImplementationsParams
Trả lời những tài liệu nào triển khai thứ nằm dưới con trỏ.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
uri | string | không | Tài liệu chứa con trỏ. |
position | Position | không | Một vị trí trong tài liệu: một dòng và một độ lệch ký tự trong dòng đó, cả hai đếm từ không. Độ lệch được đo theo đơn vị của bảng mã mà phiên đã thống nhất khi được mở, là UTF-16 trừ khi client yêu cầu bảng mã khác. |
release | string | không | Release dùng làm khung để trả lời, dưới dạng đường dẫn tương đối với thư mục gốc của workspace. Khi đó, tài liệu nằm dưới một thư mục catalog của workspace mà Release không đọc sẽ không được báo cáo, nên một biến thể mà Release khác dùng để build không bao giờ được liệt kê trong số các biến thể của Release này. Khi vắng mặt, mọi tài liệu của workspace đều được tìm kiếm. Giá trị không chỉ tới tệp Release nào sẽ bị từ chối. |
Không cho phép thuộc tính bổ sung.
HoverParams
Trả lời bằng nội dung cần hiển thị về thứ nằm dưới con trỏ.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
uri | string | không | Tài liệu chứa con trỏ. |
position | Position | không | Một vị trí trong tài liệu: một dòng và một độ lệch ký tự trong dòng đó, cả hai đếm từ không. Độ lệch được đo theo đơn vị của bảng mã mà phiên đã thống nhất khi được mở, là UTF-16 trừ khi client yêu cầu bảng mã khác. |
release | string | không | Release dùng làm khung để trả lời, dưới dạng đường dẫn tương đối với thư mục gốc của workspace. Khi đó, thực thể được hiển thị là thực thể mà tham chiếu phân giải tới thông qua các thư mục catalog mà cấu hình workspace cấp cho Release đó, theo đúng thứ tự đó; nếu các thư mục đó không khai báo thực thể nào như vậy, các tài liệu của workspace sẽ được tìm kiếm, bỏ qua mọi tài liệu nằm dưới một thư mục catalog của workspace mà Release không đọc. Khi vắng mặt, các tài liệu của workspace được tìm kiếm trước, và các thư mục catalog riêng của workspace chỉ được tìm khi không tài liệu nào khai báo tên đó. Giá trị không chỉ tới tệp Release nào sẽ bị từ chối. |
Không cho phép thuộc tính bổ sung.
CompletionParams
Trả lời bằng những gì có thể viết tại con trỏ.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
uri | string | không | Tài liệu chứa con trỏ. |
position | Position | không | Một vị trí trong tài liệu: một dòng và một độ lệch ký tự trong dòng đó, cả hai đếm từ không. Độ lệch được đo theo đơn vị của bảng mã mà phiên đã thống nhất khi được mở, là UTF-16 trừ khi client yêu cầu bảng mã khác. |
context | CompletionContext | không | Điều gì đã gây ra yêu cầu, khi client theo dõi điều đó. |
release | string | không | Release dùng làm khung để trả lời, dưới dạng đường dẫn tương đối với thư mục gốc của workspace. Khi đó, các tên được đề xuất là những tên mà các tài liệu của workspace khai báo, trừ các tài liệu nằm dưới một thư mục catalog của workspace mà Release không đọc, cùng với các Components và Features mà các thư mục catalog do cấu hình workspace cấp cho Release đó khai báo. Khi vắng mặt, đó là các tài liệu của workspace cùng các Components và Features mà các thư mục catalog riêng của nó khai báo. Giá trị không chỉ tới tệp Release nào sẽ bị từ chối. |
Không cho phép thuộc tính bổ sung.
CompletionContext
Điều gì đã gây ra yêu cầu, khi client theo dõi điều đó.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
triggerKind | integer | không | Lý do yêu cầu hoàn thành. |
triggerCharacter | string | không | Ký tự đã gây ra yêu cầu, nếu có ký tự như vậy. |
Cho phép thuộc tính bổ sung.
AttachCandidatesParams
Trả lời những Features nào có thể được gắn vào một thực thể, được đánh giá dựa trên các nhãn của thực thể đó, và, với một kết nối mà component của một nút đồ thị vẽ ra, những Features nào có thể lấp đầy từng slot mà socket của kết nối đó khai báo.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
node | string | không | Thực thể dùng để đánh giá các ứng viên, theo tên, được đọc từ những gì các tài liệu của workspace khai báo. |
graphNode | string | không | Nút đồ thị dùng để đánh giá các ứng viên, có các nhãn là tập đã hoàn tất mà chính quá trình build dùng để đánh giá khả năng áp dụng. Một câu trả lời được tính trên nút này cho biết quá trình build sẽ làm gì. |
release | string | không | Release mà đồ thị của nó chứa nút, dưới dạng đường dẫn tương đối so với thư mục gốc của workspace. Khi đó các ứng viên được lấy theo ngữ cảnh của Release đó: các Features được khai báo trong các thư mục catalog mà cấu hình workspace cấp cho Release đó, và các tài liệu của workspace trừ những tài liệu nằm trong một thư mục catalog của workspace mà Release không đọc, nên một Feature dành cho Release khác không bao giờ được đề xuất cho một nút thuộc đồ thị của Release này. |
labels | map của string | không | Các nhãn để đánh giá trực tiếp, thay cho việc đọc chúng từ một thực thể hoặc một nút đồ thị. |
connection | ConnectionCoordinate | không | Một kết nối do component của nút mà graphNode chỉ định vẽ ra, cần được trả lời cùng với nút đó: khi đó câu trả lời còn mang thêm slots, mỗi slot mà socket của kết nối khai báo cùng các Features có thể lấp đầy nó, hoặc noSlotReason khi không slot nào có thể được lấp đầy. Nó chỉ được gửi cùng graphNode và release, vì một kết nối chỉ tồn tại trên một đồ thị đã biên dịch; nếu gửi cùng node hoặc labels thì bị từ chối. Các ứng viên đi kèm giữ nguyên ý nghĩa, tức các Features có thể gắn vào chính nút đó. Trường document của nó được chấp nhận và không làm thay đổi câu trả lời này: các slot thuộc về socket và các ứng viên thuộc về các Features, như nhau bất kể một attachment được viết trong tài liệu nào. |
Không cho phép thuộc tính bổ sung.
ConnectionCandidatesParams
Trả lời một socket trên một thực thể có thể được nối tới những thực thể nào.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
node | string | không | Thực thể có các socket đang được hỏi đến. |
socket | string | không | Socket duy nhất cần trả lời. Nếu vắng mặt, câu trả lời áp dụng cho mọi socket mà thực thể khai báo. |
Không cho phép thuộc tính bổ sung.
InsertionPointParams
Trả lời vị trí trong một tài liệu nơi một mục mới thuộc một container được đặt tên nên nằm, để việc soạn và áp dụng mục đó cho bên gọi sở hữu buffer.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
file | string | không | Tài liệu cần trả lời. |
container | string[] | không | Đường dẫn trong tài liệu tới container mà mục thuộc về. |
Không cho phép thuộc tính bổ sung.
AttachmentContainerParams
Trả lời một attachment trên một nút đồ thị, hoặc trên một kết nối mà component của nút đó vẽ ra, thuộc về tài liệu nào và vị trí nào trong tài liệu đó.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
graphNode | string | không | Nút đồ thị mà attachment dành cho. |
release | string | không | Release mà đồ thị của nó chứa nút, dưới dạng đường dẫn tương đối so với thư mục gốc của workspace. |
connection | ConnectionCoordinate | không | Một kết nối mà component của nút đồ thị vẽ ra, khi attachment dành cho kết nối đó chứ không phải cho nút: khi đó câu trả lời chỉ ra container features riêng của kết nối trong tài liệu mà trường document của nó chỉ định, một trường bắt buộc ở đây. Trong Aggregate, đó là mục của kết nối trong tài liệu nơi nút được viết, bị từ chối với một kết nối do Release vẽ, vì Aggregate không có mục nào cho nó. Trong Release, đó là mục theo từng cạnh nằm dưới mục riêng của Release cho nút, dù Release đã viết mục đó cho kết nối hay chưa, bị từ chối khi Release không viết mục nào cho nút. Một kết nối do một Feature vẽ bị từ chối ở cả hai tài liệu, vì một attachment chỉ được viết trên một kết nối do một component hoặc Release vẽ. |
Không cho phép thuộc tính bổ sung.
ConnectionAtPositionParams
Trả lời một vị trí trong một Aggregate hoặc một Release nằm bên trong mục của kết nối nào: nút đồ thị và kết nối, theo cách mà các yêu cầu về ứng viên và container nhận chúng, hoặc lý do không có kết nối nào được viết ở đó. Các mục là những mục mà một attachment được viết trong đó — mục mà một component dùng để vẽ một kết nối, dưới alias của kết nối, trong tài liệu nơi component được viết, và mọi mục theo từng cạnh mà Release viết — mỗi mục ở nơi đồ thị đã biên dịch ghi nhận nó, nên việc một khóa có phải là kết nối hay không không bao giờ được suy ra từ tên của nó.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
file | string | không | Tài liệu chứa vị trí: Release, hoặc một tài liệu mà đồ thị của Release ghi nhận các component được viết trong đó — Aggregate của nó, hoặc tài liệu của một module mà Aggregate đó import. Nó được đọc trước tiên từ những gì phiên đang giữ cho nó, nếu không thì từ đĩa. |
position | Position | không | Một vị trí trong tài liệu: một dòng và một độ lệch ký tự trong dòng đó, cả hai đếm từ không. Độ lệch được đo theo đơn vị của bảng mã mà phiên đã thống nhất khi được mở, là UTF-16 trừ khi client yêu cầu bảng mã khác. |
release | string | không | Release mà đồ thị đã biên dịch của nó ghi nhận các kết nối, dưới dạng đường dẫn tương đối so với thư mục gốc của workspace. Nó cũng bắt buộc đối với một vị trí trong Aggregate, vì một nút đồ thị và một kết nối chỉ tồn tại trên một đồ thị đã biên dịch. |
Không cho phép thuộc tính bổ sung.
ConnectionCoordinate
Một kết nối mà component của một nút đồ thị vẽ ra, được xác định bởi socket mà nó được nối qua và bí danh mà nó mang trong socket đó, cùng với tài liệu mà một attachment trên nó được viết vào. Một kết nối mang các attachment lấp đầy các slot mà socket của nó khai báo, và Aggregate hoặc Release đều có thể viết chúng.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
socket | string | có | Socket phụ thuộc mà kết nối được nối qua. |
alias | string | có | Tên mà kết nối mang trong socket của nó. |
document | const “aggregate” hoặc const “release” | không | Tài liệu mà một attachment trên kết nối được viết vào. Tập giá trị là đóng, và một giá trị nằm ngoài tập đó bị từ chối. Giá trị được phép: "aggregate" — Aggregate, nơi nhà phát triển viết một attachment trên mục của kết nối. "release" — Release, nơi người vận hành viết một attachment trên mục theo cạnh của kết nối. |
Cho phép thuộc tính bổ sung.
SetActiveReleaseParams
Ghi nhận một Release làm mặc định của workspace bằng cách ghi một marker trong thư mục .aggrega: lựa chọn mà aggrega/activeRelease báo cáo đọc marker đó sau Release soạn thảo của cấu hình. Marker chỉ được ghi bên trong workspace và không ở đâu khác: khi thư mục .aggrega hoặc marker là một liên kết dẫn ra ngoài workspace, dù nơi nó dẫn tới đã tồn tại hay chưa, việc ghi bị từ chối kèm tên liên kết và không có gì được ghi. Câu trả lời là câu mà aggrega/activeRelease đưa ra sau khi marker được ghi, vì vậy nó nêu một Release khác khi Release soạn thảo của cấu hình được ưu tiên hơn marker.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
release | string | không | Release cần ghi nhận, dưới dạng đường dẫn tương đối so với gốc workspace. Một đường dẫn tuyệt đối, và một đường dẫn leo ra ngoài workspace, đều bị từ chối; một đường dẫn ra ngoài workspace qua một liên kết cũng vậy, trừ khi cấu hình workspace nêu tên Release đó. |
Không cho phép thuộc tính bổ sung.
EditDocumentParams
Áp dụng một chỉnh sửa có giới hạn lên một tài liệu mà workspace chứa: một mục được thêm dưới một container, hoặc một giá trị vô hướng được đặt. Tài liệu sau khi ghép được kiểm tra theo schema của loại của nó và chỉ được ghi xuống đĩa nếu vượt qua, vì vậy thao tác này không thể ghi những gì schema soạn thảo từ chối. Một chỉnh sửa bị từ chối giữ nguyên tệp từng byte như trước.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
file | string | không | Tài liệu cần chỉnh sửa. |
edit | const “add-component” hoặc const “attach-feature” hoặc const “wire-edge” hoặc const “set-value” | không | Chỉnh sửa nào sẽ được áp dụng. Giá trị được phép: "add-component" — Thêm một instance component dưới một container components: name là tên instance, value là Component mà nó yêu cầu. "attach-feature" — Gắn một Feature vào node mà yêu cầu nêu tên: name là tên instance của attachment, value là Feature mà nó yêu cầu. "wire-edge" — Nối một kết nối phụ thuộc từ node mà yêu cầu nêu tên, bên trong socket: name là bí danh dùng để định địa chỉ kết nối, value là node mà nó trỏ tới. "set-value" — Đặt một giá trị trên node mà yêu cầu nêu tên: name là khóa của giá trị, value là một giá trị vô hướng. |
node | string[] | không | Đường dẫn trong tài liệu tới mục đang được chỉnh sửa. |
socket | string | không | Socket mà chỉnh sửa liên quan, đối với một chỉnh sửa nối một socket. |
name | string | không | Tên mà chỉnh sửa ghi. |
value | any | không | Giá trị mà chỉnh sửa ghi, theo bất kỳ dạng nào mà chỉnh sửa nhận. |
dryRun | boolean | không | Có trả lời bằng tài liệu đã ghép thay vì ghi nó hay không. |
Không cho phép thuộc tính bổ sung.
ConfigInitParams
Khởi tạo một tài liệu cấu hình. Mặc định nó ghi tệp cấp toàn máy, vì một registry và các danh tính được tin cậy trên đó là công cụ cấp toàn máy. Nó truy cập registry được nêu tên để đọc chính sách tin cậy mà registry công bố; một registry không công bố gì được báo cáo như vậy và việc khởi tạo vẫn tiếp tục, dựa trên mức cơ sở tích hợp sẵn đối với hub chính thức và không có chính sách nào đối với mọi registry khác.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
registry | string | không | Registry cần khởi tạo cấu hình cho. |
force | boolean | không | Có ghi đè một tài liệu cấu hình đã tồn tại hay không. |
global | boolean | không | Ghi tệp cấu hình cho toàn máy, đây là mặc định của chính phương thức này. |
workspace | boolean | không | Ghi tệp cấu hình riêng của workspace này thay vì tệp cho toàn máy. |
dryRun | boolean | không | Có trả lời bằng nội dung của tài liệu thay vì ghi nó hay không, dành cho một client giữ mô hình tài liệu riêng. |
Không cho phép thuộc tính bổ sung.
ConfigCaptureParams
Cố định cấu hình đã phân giải vào tài liệu riêng của workspace này, để workspace tự chứa đầy đủ. Nó luôn ghi tệp của workspace đó và không truy cập gì bên ngoài.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
allPlugins | boolean | không | Có cố định mọi plugin được gắn thay vì chỉ những plugin mà chính workspace cấu hình hay không. |
Không cho phép thuộc tính bổ sung.
ImportParams
Chuyển đổi một mô tả nguồn ngoại lai thành các tài liệu soạn thảo nháp, và ghi bên cạnh chúng .aggrega-import.json, bản ghi về những gì lần nhập đã ghi — đích được chỉ định, nếu có, bản chụp catalog đã đọc, nếu có đọc, từng tệp nháp, và từng khóa của một Aggregate hoặc Release nháp ở mọi độ sâu — mà một lần đồng bộ sau đó sẽ đọc. Một nguồn không thể chuyển đổi hoàn toàn là một câu trả lời chứ không phải một lỗi: các bản nháp đã tạo ra vẫn được ghi và các phát hiện cho biết những gì không thể chuyển đổi — ngoại trừ khi đồng bộ, vốn không ghi gì từ một lần chuyển đổi đã dừng lại.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
source | string | không | Tệp hoặc thư mục cần chuyển đổi, dưới dạng đường dẫn tuyệt đối hoặc tương đối so với thư mục gốc của workspace; yêu cầu không có giá trị này sẽ bị từ chối. Nó được đọc tại chỗ, dù nằm trong workspace hay không, và một thư mục được đọc thành các tệp trong đó mà các mẫu tệp do trình nhập khai báo chọn ra. |
outputDir | string | không | Thư mục trong workspace để ghi các bản nháp vào, tương đối so với thư mục gốc của workspace; giá trị tuyệt đối, hoặc giá trị dẫn ra ngoài workspace theo cách viết hoặc qua một liên kết, sẽ bị từ chối. Khi vắng mặt, việc ghi diễn ra bên dưới thư mục gốc của workspace, nơi cùng lần chuyển đổi chạy tại terminal mà không chỉ định đích sẽ ghi. Mọi đường dẫn nháp đều tương đối so với thư mục mà câu trả lời gọi là outputDir, kể cả khi dùng dryRun. |
format | string | không | Định dạng nguồn. Khi vắng mặt, quá trình chuyển đổi sẽ tự xác định. |
target | string | không | Một khả năng của provider, chẳng hạn compose hoặc helm — từ mà spec.capability của một Recipe gắn với — để soạn nháp một Manifest bên cạnh các bản nháp, dưới tên manifest.yaml: mỗi loại component và loại feature mà các bản nháp cần, bao gồm cả các loại của một Aggregate trong catalog mà Aggregate nháp kết hợp, được ánh xạ tới Recipe hoặc công thức feature có khả năng đó mà catalog của workspace cung cấp cho nó — cái duy nhất hiện có, hoặc trong số nhiều cái thì cái được đặt tên theo loại đó; một loại không có cái nào, hoặc có nhiều cái nhưng không cái nào được đặt tên như vậy, sẽ không được ánh xạ, kèm một phát hiện cảnh báo nêu tên loại đó; một ánh xạ do chính importer soạn nháp được giữ lại khi catalog cung cấp nó cho loại và khả năng đó, và bị bỏ đi kèm một phát hiện cảnh báo trong trường hợp ngược lại; và spec.manifest của Release nháp được đặt là Manifest đó. Một khả năng mà không Recipe nào trong catalog gắn với sẽ bị từ chối trước khi chuyển đổi chạy, và không có gì được ghi. Khi vắng mặt, không soạn nháp Manifest nào, ngoại trừ khi đồng bộ, vốn soạn nháp cho đích mà bản ghi của lần nhập trước nêu tên; một lần đồng bộ chỉ định đích sẽ soạn nháp cho đích đó, và bản ghi khi ấy sẽ nêu tên nó. |
dryRun | boolean | không | Có trả lời bằng nội dung của mọi tệp mà yêu cầu sẽ ghi thay vì ghi chúng hay không. Mọi hành vi khác đều giống như khi ghi, nên một yêu cầu mà việc ghi sẽ từ chối thì cũng bị từ chối ở chế độ này; khi kết hợp với sync, nó trả lời bằng những gì lần đồng bộ sẽ ghi và mọi phần sẽ bị lệch. |
sync | boolean | không | Có cập nhật những gì một lần nhập trước đã soạn nháp bên dưới outputDir theo nguồn hay không, thay vì ghi toàn bộ bản nháp. Chỉ những gì lần nhập đã ghi mới thay đổi, theo danh sách trong bản ghi bên cạnh các bản nháp: một phần mà nguồn không đổi vẫn giữ nguyên như trên đĩa, dù đã được chỉnh sửa hay chưa; một phần mà nguồn đã thay đổi, bỏ đi hoặc thêm vào sẽ được ghi mới, xóa — một tệp nháp bị xóa toàn bộ — hoặc thêm vào, khi những gì trên đĩa là những gì lần nhập ghi gần nhất; và mọi thứ khác, một khóa do tác giả thêm vào — trong đó có environment mà một Release nháp để lại cho tác giả của nó — hoặc một chú thích không được viết ngay phía trên một khóa nháp, đều được giữ nguyên từng byte. Một lần đồng bộ sẽ thay đổi hoặc xóa những gì tác giả đã chỉnh sửa hoặc thêm vào, hoặc thêm một phần ở nơi tác giả đã viết sẵn, sẽ bị từ chối kèm tên từng phần, và một lần đồng bộ trên một Aggregate không có trong bản ghi nào cũng vậy; trong cả hai trường hợp không có gì được ghi. Nếu không bật tùy chọn này, một yêu cầu có bản nháp sẽ ghi đè lên một Aggregate đã có trong outputDir sẽ bị từ chối, kể cả khi dùng dryRun. |
upgrade | boolean | không | Có tải về bản chụp catalog mới nhất mà registry mặc định của workspace công bố và nhập dựa trên nó hay không, từ đó trở đi lưu giữ nó thay cho bản mà workspace đang giữ hoặc bản mà bản ghi bên cạnh các bản nháp chỉ định; tùy chọn này không thay đổi gì khi workspace chỉ định một thư mục catalog, và bị từ chối khi ngoại tuyến. |
answers | string | không | Tệp câu trả lời mà từ đó các giá trị do bản nháp để trống và không nguồn nào có thể chứa được đọc ra và ghi vào, tương đối với thư mục gốc của workspace; một giá trị tuyệt đối, hoặc một giá trị dẫn ra ngoài workspace theo cách viết hoặc qua một liên kết, sẽ bị từ chối. Tệp này chứa, dưới đường dẫn của mỗi tệp nháp, đường dẫn khóa bên trong tài liệu đó và câu trả lời của nó, và các câu trả lời được ghi vào bản nháp. Khi vắng mặt, tệp được đọc là tệp mà bản ghi bên cạnh các bản nháp nêu tên, hoặc nếu không thì import-answers.yaml bên cạnh tệp nguồn hoặc bên trong thư mục nguồn. Câu trả lời cho một secret nêu nơi secret đó đến từ — một tên biến, ${NAME}, hoặc tên của một Kubernetes Secret — và mọi thứ khác đều bị từ chối mà không ghi gì. Không có gì được hỏi: mỗi giá trị vẫn còn thiếu là một mục của owed trong câu trả lời và một phát hiện cảnh báo nêu tên tệp nháp, khóa và nó là gì, câu trả lời của nó được gửi dưới dạng answered, và khi các bản nháp được ghi, phát hiện cuối cùng cho biết còn thiếu bao nhiêu và ở đâu. Khi các bản nháp bao gồm một Release, không còn thiếu gì và quá trình chuyển đổi đã hoàn tất, các phụ thuộc của nó sau đó được kéo về, ghi lockfile của nó, và một lần kéo thất bại sẽ kết thúc các phát hiện bằng việc cho biết lý do, các bản nháp vẫn được ghi; khi ngoại tuyến không có gì được kéo về và một phát hiện nêu lần kéo cần chạy. Một câu trả lời cho một khóa mà các bản nháp này không để trống được giữ trong tệp và không được áp dụng, nên một tệp câu trả lời phục vụ mọi target. |
answered | ImportAnswered[] | không | Các câu trả lời cho những giá trị mà owed trong câu trả lời đã liệt kê, mỗi câu nêu tên tệp nháp và các khóa như owed đã nêu. Mỗi câu được đánh giá, giữ trong tệp câu trả lời và ghi vào bản nháp đúng như một câu trả lời được gõ tại terminal: câu trả lời cho một secret nêu nơi secret đó đến từ — một tên biến, ${NAME}, hoặc tên của một Kubernetes Secret — và câu nào không làm vậy thì không được giữ cũng không được ghi, giá trị của nó vẫn còn thiếu với lý do là secretAdvice của nó. Một giá trị mà tệp câu trả lời đã trả lời được trả lời từ tệp đó; một câu trả lời trống, hoặc một câu nêu tên một giá trị mà bản nháp không thiếu, không được áp dụng. Hãy gửi nó cùng sync sau khi các bản nháp đã được ghi, vì một yêu cầu không phải sync sẽ bị từ chối đối với một Aggregate đã có trong outputDir. Dưới dryRun, vốn không giữ câu trả lời nào, và dưới một sync mà quá trình chuyển đổi đã dừng, vốn không ghi gì, không câu trả lời nào được gửi được áp dụng. |
Không cho phép thuộc tính bổ sung.
ScaffoldEntityParams
Soạn nháp một tài liệu khởi đầu cho một loại thực thể, hoặc ghi một trong các ví dụ có thể chạy được của tài liệu vào một thư mục mới của workspace, hoặc liệt kê chúng. Việc soạn nháp suy ra khung từ bộ schema mà tệp nhị phân mang theo, nên không đọc gì từ workspace và không ghi gì — câu trả lời là văn bản, và nó đi đâu là do client quyết định. Ghi một ví dụ chỉ ghi thư mục mới và không gì khác, và các ví dụ được đọc từ gói tài liệu đã ký được công bố cho phiên bản của tệp nhị phân, hoặc gói mới nhất được công bố trước phiên bản đó nếu không có, và gói được xác minh theo chính sách chữ ký của workspace trước khi được giữ lại hoặc đọc: một gói không vượt qua xác minh sẽ bị từ chối, và khi ngoại tuyến chỉ một bản sao đã có trong bộ nhớ đệm được đọc. Một yêu cầu gửi cùng lúc các trường của hai dạng — kind với example hoặc list, list với example, name với example hoặc list, dir mà không có example — bị từ chối trước khi đọc bất cứ thứ gì.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | string | không | Đường dẫn tuyệt đối của workspace. Việc soạn nháp không đọc nó. Ghi hoặc liệt kê một ví dụ thì cần nó: cấu hình của workspace quyết định tài liệu được lấy từ đâu và phải mang những chữ ký nào, và ví dụ được ghi vào bên trong nó. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
kind | string | không | Loại thực thể cần soạn nháp, được gọi bằng token viết thường của nó, chẳng hạn component, aggregate, release, recipe hoặc featurerecipe — token mà aggrega/getSchema liệt kê cho nó. |
name | string | không | Tên cần ghi vào tài liệu nháp. Chỉ được gửi cùng với kind. |
example | string | không | Ví dụ có thể chạy được cần ghi, theo tên mà danh sách ví dụ đặt cho nó. Được gửi thay cho kind. |
list | boolean | không | Có trả lời bằng mọi ví dụ có thể chạy được mà tài liệu công bố hay không, mà không ghi gì. Được gửi mà không có example và không có kind. |
dir | string | không | Thư mục mới để ghi ví dụ vào, tương đối với thư mục gốc của workspace; nếu vắng mặt, ví dụ được ghi vào một thư mục đặt theo tên ví dụ tại đó. Thư mục này phải chưa tồn tại hoặc phải trống: một thư mục chứa bất cứ thứ gì sẽ bị từ chối và giữ nguyên, và một giá trị tuyệt đối, hoặc một giá trị dẫn ra ngoài workspace theo cách viết hoặc qua một liên kết, bị từ chối trước khi đọc bất cứ thứ gì. Chỉ được gửi cùng với example. |
Không cho phép thuộc tính bổ sung.
LintParams
Kiểm tra các quy ước xuất bản catalog trên một thực thể, trên mọi thứ mà closure của một Release vươn tới, hoặc trên mọi thứ bên dưới các thư mục catalog đã cấu hình. Không có gì được ghi ở bất kỳ chế độ nào. Không chỉ định thực thể lẫn Release thì sẽ kiểm tra toàn bộ catalog: trong một workspace mà cấu hình không cấp cho Release nào thư mục catalog riêng, kiểm tra một lần trên các thư mục của workspace; trong một workspace nêu tên các Releases dưới workspace.releases, kiểm tra một lần cho mỗi Release trên các thư mục mà Release đó đọc, không bao giờ kiểm tra tất cả cùng nhau.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
entity | string | không | Tài liệu thực thể duy nhất cần kiểm tra. |
release | string | không | Release có closure cần kiểm tra, dưới dạng đường dẫn tương đối so với thư mục gốc của workspace. |
prePublish | boolean | không | Có so sánh mỗi thực thể với phiên bản đã xuất bản trước đó của nó hay không; việc này sẽ truy cập các registry đã cấu hình. |
Không cho phép thuộc tính bổ sung.
PluginAddParams
Gắn một plugin vào một socket mà workspace cấu hình. Thao tác này truy cập một registry để phân giải truy vấn thành một plugin và ghim một phiên bản. Quyết định duy nhất mà một terminal sẽ hỏi — chấp nhận các capability mà một plugin mở rộng lệnh khai báo — được truyền đến dưới dạng một trường ở đây, nên client hỏi bất kỳ ai đang điều khiển nó và giao diện này không bao giờ chờ một lời nhắc.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
type | string | không | Socket mà plugin gắn vào. |
query | string | không | Nội dung cần phân giải thành một plugin. |
capability | string | không | Capability mà phần gắn kết dành cho, khi socket mang nhiều capability. |
role | string | không | Vai trò mà phần gắn kết chạy trong đó, vai trò này xác định những gì nó có thể phát ra. |
global | boolean | không | Ghi vào tệp cấu hình toàn máy. |
workspace | boolean | không | Ghi vào tệp cấu hình riêng của workspace này. |
acceptCapabilities | boolean | không | Bên gọi có chấp nhận các capability mà một plugin mở rộng lệnh khai báo hay không. |
dryRun | boolean | không | Có trả lời bằng nội dung của tài liệu cấu hình thay vì ghi nó hay không. |
Không cho phép thuộc tính bổ sung.
PluginRemoveParams
Tháo một plugin khỏi một socket mà workspace cấu hình.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
type | string | không | Socket mà plugin đang được gắn vào. |
query | string | không | Phần gắn kết cần gỡ bỏ. |
global | boolean | không | Ghi vào tệp cấu hình toàn máy. |
workspace | boolean | không | Ghi vào tệp cấu hình riêng của workspace này. |
Không cho phép thuộc tính bổ sung.
PluginSyncParams
Đồng bộ các bản ghi do máy quản lý của một thực thể Plugin với module mà nó trỏ tới. Thao tác này ghi lại các bản ghi đó và giữ nguyên mọi byte khác của tài liệu.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
entity | string | không | Tài liệu thực thể Plugin cần đồng bộ. |
plugin | string | không | Module plugin để đọc các bản ghi. |
Không cho phép thuộc tính bổ sung.
PluginGenCatalogParams
Tạo các tài liệu catalog Plugin từ metadata mà chính plugin khai báo cùng với một lớp phủ do tác giả viết. Tạo lại trên các đầu vào không đổi sẽ cho ra các tài liệu giống hệt nhau từng byte.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
fromEmbedded | boolean | không | Có đọc metadata từ các plugin mà binary đã mang sẵn hay không. |
plugin | string | không | Module plugin để đọc metadata. |
outputDir | string | không | Thư mục trong workspace để ghi các tài liệu vào. |
overlay | string | không | Tài liệu do tác giả viết, có nội dung được hợp nhất đè lên metadata được tạo. |
dryRun | boolean | không | Có trả lời bằng nội dung của các tài liệu thay vì ghi chúng hay không. |
Không cho phép thuộc tính bổ sung.
ExplainErrorParams
Mở rộng một mã mà một phát hiện mang theo thành những gì trình biên dịch khai báo về tình trạng đó và các mục đã xuất bản hướng dẫn cách sửa khi soạn thảo. Thao tác này tải tài liệu đã xuất bản khi workspace chưa có bản sao; nếu không tải được, nó vẫn trả lời những gì binary khai báo và cho biết vì sao thiếu phần văn bản.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
code | string | không | Tình trạng cần mở rộng, được gọi tên bằng mã mà một phát hiện mang theo hoặc mã ngắn của nó. |
Không cho phép thuộc tính bổ sung.
GetSchemaParams
Trả lời bằng schema của một kind, hoặc — khi không kind nào được nêu — bằng danh sách các kind có thể nêu. Nó trả lời cho binary đang chạy thay vì cho bất kỳ bản sao nào được cài ở nơi khác, nên không cần workspace và không đọc workspace nào.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootAccepted | không | Đường dẫn tuyệt đối của một workspace. Chủ thể của phương thức này không phải là một workspace — nó trả lời từ những gì chính tệp nhị phân mang theo — nên trường này được chấp nhận nhưng không được đọc. Nó được cho phép vì client có thể gửi nó đồng loạt trên mọi yêu cầu mà không cần biết phương thức nào sử dụng nó. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
kind | string | không | Kind cần trả về schema. Nếu vắng mặt, thay vào đó sẽ trả lời bằng các kind có thể nêu. |
Không cho phép thuộc tính bổ sung.
SkillsInstallParams
Ghi skill trợ lý được tích hợp sẵn trong tệp nhị phân vào thư mục skill của từng trợ lý mà yêu cầu nêu tên hoặc, với một yêu cầu global không nêu tên trợ lý nào, của từng trợ lý được tìm thấy trên máy này. Khi không có global, nó ghi vào thư mục dự án của từng trợ lý bên trong workspace mà yêu cầu nêu tên, và mọi đường dẫn nó sẽ ghi ở đó đều bị giới hạn trong workspace đó; khi có global, nó ghi vào thư mục theo người dùng của từng trợ lý dưới thư mục home. Mọi đích đều được kiểm tra trước khi ghi bất cứ thứ gì, nên một lần từ chối để mọi thư mục nguyên như cũ.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
workspaceRoot | WorkspaceRootSubject | có | Đường dẫn tuyệt đối của workspace mà yêu cầu này tác động. Đây là chủ thể của yêu cầu: daemon phân giải nó trước khi phương thức chạy, và một yêu cầu bỏ qua nó hoặc viết nó dưới dạng bất kỳ thứ gì khác ngoài một chuỗi sẽ bị từ chối. |
workDoneToken | ProgressToken | không | Một giá trị do bên gọi tạo ra để có thể khớp các thông báo tiến trình với lời gọi đã yêu cầu chúng. Giá trị này được gửi lại nguyên vẹn trên mọi thông báo, nên bên gọi có thể so sánh nó với giá trị đã gửi. Nó được chấp nhận trên mọi yêu cầu, và một yêu cầu gửi nó trong một phiên không khai báo khả năng tiến trình sẽ bị từ chối. |
agents | string[] | không | Các trợ lý cần cài skill, theo các định danh mà danh sách báo cáo. Một yêu cầu cấp dự án không nêu tên trợ lý nào bị từ chối. Một yêu cầu global không nêu tên trợ lý nào sẽ cài skill cho các trợ lý được tìm thấy trên máy này, tức từng trợ lý có thư mục cấu hình nằm trong thư mục home hoặc có lệnh nằm trên PATH, và bị từ chối mà không ghi gì nếu không tìm thấy trợ lý nào. Một định danh không có thư mục skill nào được biết tới bị từ chối, kèm theo tên, và một định danh được đưa ra hai lần chỉ được cài một lần. |
global | boolean | không | Ghi vào thư mục skill theo người dùng của từng trợ lý dưới thư mục home, thư mục mà trợ lý đọc trong mọi dự án, thay vì thư mục dự án của nó trong workspace. |
Không cho phép thuộc tính bổ sung.
ServerCapabilities
Những gì daemon sẽ làm trong phiên này, được thống nhất dựa trên những gì client cho biết nó có thể xử lý.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
positionEncoding | string | có | Bảng mã mà mọi vị trí trong phiên này được biểu diễn. |
workDoneProgress | boolean | không | Daemon có gửi thông báo tiến trình trong phiên này hay không. Chỉ có mặt khi client đã khai báo rằng nó có thể nhận chúng. |
Không cho phép thuộc tính bổ sung.
ClosureEntity
Một thực thể mà một Release phụ thuộc vào, ở phiên bản mà quá trình phân giải đã chốt.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
uri | string | có | Tham chiếu mà thực thể được phân giải từ đó. |
version | string | có | Phiên bản đã được chốt. |
kind | string | không | Loại thực thể. |
source | string | không | Nơi mà lần chạy tạo ra mục này đã lấy thực thể, bằng đúng từ mà aggrega pull --detail in ra cho nó: fetched-fresh (được tải từ một registry trong lần chạy đó), cache-reuse (một bản sao đã có trong bộ nhớ đệm, được tái sử dụng mà không cần tải), local (được tìm thấy trên hệ thống tệp cục bộ, chẳng hạn một thư mục catalog), in-binary (bản sao nằm trong tệp nhị phân của trình biên dịch), hoặc external (Aggregate hoặc Manifest của chính Release, được đọc từ tệp hoặc mục mà Release chỉ định thay vì được phân giải như một phụ thuộc của nó; một Aggregate mà lần chạy tải từ registry thì là fetched-fresh). Có mặt trong các mục của báo cáo phân giải phụ thuộc, nơi nó mô tả những gì lần chạy đó đã làm trên máy này, và vắng mặt trong danh sách các phụ thuộc đã phân giải của một Release, vốn mô tả những gì Release phụ thuộc vào. Lockfile không ghi lại nguồn. Bị bỏ qua đối với thực thể mà lần chạy không ghi lại nguồn. |
Không cho phép thuộc tính bổ sung.
ToolchainCorePlugin
Một plugin mà chính trình biên dịch mang theo, và phiên bản của nó đã được sử dụng.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
plugin | string | có | Tham chiếu của plugin. |
version | string | có | Phiên bản đã được sử dụng. |
Không cho phép thuộc tính bổ sung.
ToolchainReport
Trình biên dịch đã được phân giải, và các plugin mà nó mang theo.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
compilerVersion | string | có | Phiên bản trình biên dịch đã được phân giải. |
corePlugins | ToolchainCorePlugin[] | không | Các plugin mà trình biên dịch mang theo, cùng phiên bản đã dùng của từng plugin. |
Không cho phép thuộc tính bổ sung.
DependencyResolutionReport
Những gì một lần phân giải phụ thuộc đã ghim và thu nhận.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
lockfile | string | có | Lockfile mà lần phân giải đã ghi, hoặc lockfile mà một lần kiểm tra đã so sánh. |
verified | boolean | không | Yêu cầu có phải là một lần kiểm tra hay không; lần kiểm tra so sánh lockfile đã ghi và không ghi lockfile, bản ghi tin cậy plugin hay entity.lock nào. |
entities | ClosureEntity[] hoặc null | có | Các thực thể mà lần phân giải đã ghim, hoặc lần kiểm tra đã so sánh. |
libraries | ClosureEntity[] hoặc null | có | Các thư viện mà lần phân giải đã ghim, hoặc lần kiểm tra đã so sánh. |
plugins | ClosureEntity[] hoặc null | có | Các plugin mà lần phân giải đã ghim, hoặc lần kiểm tra đã so sánh. |
sourceArtifacts | integer | có | Số artifact nguồn đã được thu nhận. |
trustedPlugins | integer | có | Số plugin đã ghim mang chữ ký đã được xác minh. |
toolchain | ToolchainReport | không | Trình biên dịch đã được phân giải, và các plugin mà nó mang theo. |
externalInputs | integer | có | Số đầu vào bên ngoài mà quá trình render sử dụng đã được thu nhận. |
incompleteExternalInputs | string | không | Những đầu vào bên ngoài nào không thể thu nhận, khi có một số không thể thu nhận. |
Không cho phép thuộc tính bổ sung.
BuildNotice
Một điều mà bản build muốn bên gọi biết, không phải là phát hiện về một tài liệu cũng không phải là lỗi.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
class | string | có | Loại thông báo này. |
text | string | có | Nội dung của thông báo. |
Không cho phép thuộc tính bổ sung.
CacheScope
Phạm vi ảnh hưởng của một câu trả lời về bộ nhớ đệm. Hai trong số các lớp bộ nhớ đệm được dùng chung bởi mọi dự án trên máy, nên mọi câu trả lời về bộ nhớ đệm đều nêu rõ những lớp nào nó đã chạm tới — nếu không, một phiên mở trên một workspace sẽ bị hiểu là chỉ báo cáo về workspace đó.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
machineWideClasses | string[] hoặc null | có | Các lớp bộ nhớ đệm mà câu trả lời này đã chạm tới và được dùng chung giữa mọi dự án trên máy. |
workspaceRoot | string | có | Workspace mà yêu cầu đã chỉ định. |
Không cho phép thuộc tính bổ sung.
CacheElement
Một thứ mà bộ nhớ đệm lưu giữ.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
label | string | có | Mục này là của cái gì. |
size | integer | có | Số byte mà nó chiếm. |
sizeText | string | có | Cùng kích thước đó, viết theo cách con người đọc. |
digest | string | không | Digest nội dung dùng làm khóa cho mục, nếu có. |
note | string | không | Bất kỳ điều gì khác đáng nói về mục này. |
Không cho phép thuộc tính bổ sung.
CacheClass
Một bộ nhớ đệm mà daemon báo cáo.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
name | string | có | Đây là bộ nhớ đệm nào. |
reach | string | có | Bộ nhớ đệm thuộc về workspace này hay được dùng chung trên toàn máy. |
prunable | boolean | có | Daemon có thực hiện việc thu hồi bộ nhớ đệm này hay không. |
elements | CacheElement[] hoặc null | có | Những gì bộ nhớ đệm lưu giữ. |
Không cho phép thuộc tính bổ sung.
CacheProvenance
Một artifact trong bộ nhớ đệm đã được thu nhận dưới những danh tính nào, và được dùng chung rộng đến đâu.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
identities | string[] hoặc null | có | Các danh tính mà artifact được quy cho. |
sharedBy | integer | không | Số bên nắm giữ dùng chung artifact. |
Không cho phép thuộc tính bổ sung.
CacheRemoval
Một thứ mà một lần thu hồi đã xóa — hoặc, trong danh sách những gì nó để lại, một thứ mà nó lẽ ra đã xóa.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
class | string | có | Nó thuộc bộ nhớ đệm nào. |
label | string | có | Nó là gì. |
reach | string | có | Bộ nhớ đệm đó thuộc về workspace này hay được dùng chung trên toàn máy. |
size | integer | có | Số byte mà nó chiếm, hoặc đã chiếm trước khi bị xóa. |
sizeText | string | có | Cùng kích thước đó, viết theo cách con người đọc. |
Không cho phép thuộc tính bổ sung.
CacheShortfall
Những gì một lần thu hồi đã để lại, và điều gì sẽ thu hồi được nó, để bên gọi khi đọc thấy con số nhỏ hơn mong đợi biết được lý do thay vì phải suy đoán.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
class | string | có | Bộ nhớ đệm nào giữ những gì còn lại. |
count | integer | có | Số mục còn lại. |
size | integer | có | Số byte mà chúng chiếm. |
sizeText | string | có | Cùng kích thước đó, viết theo cách con người đọc. |
reach | string | có | Bộ nhớ đệm đó thuộc về workspace này hay được dùng chung trên toàn máy. |
reclaimedBy | string[] hoặc null | có | Điều gì sẽ thu hồi được chúng. |
Không cho phép thuộc tính bổ sung.
CacheCleared
Một bộ nhớ đệm mà một lần xóa sạch đã làm trống.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
class | string | có | Bộ nhớ đệm nào đã được làm trống. |
reach | string | có | Nó thuộc về workspace này hay được dùng chung trên toàn máy. |
size | integer | có | Số byte đã được thu hồi từ nó. |
sizeText | string | có | Cùng kích thước đó, viết theo cách con người đọc. |
heldOpenFiles | integer | có | Số tệp mà lần xóa sạch để lại trong bộ nhớ đệm này vì một tiến trình khác đang mở chúng. Chỉ Windows từ chối xóa tệp đang mở, nên ở mọi nơi khác giá trị này bằng không. Một lần xóa sạch sau sẽ xóa chúng khi tiến trình đó dùng xong. |
heldOpenBytes | integer | có | Số byte mà các tệp đó chiếm. Chúng không được tính vào size, là phần mà lần xóa sạch đã thu hồi. |
heldOpenBytesText | string | có | Cùng con số đó, viết theo cách con người đọc. |
Không cho phép thuộc tính bổ sung.
ConfigWriteScope
Tài liệu cấu hình nào đã được ghi và phạm vi ảnh hưởng của nó. Một yêu cầu chỉ định một workspace, nên một câu trả lời không nói gì sẽ bị hiểu là về workspace đó — và với một lần ghi trên toàn máy, cách hiểu đó là sai.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
configFile | string | có | Tài liệu đã được ghi. |
machineWide | boolean | có | Tài liệu đó có phải là tài liệu mà mọi workspace trên máy phân giải qua hay không. |
workspaceRoot | string | có | Workspace mà yêu cầu đã chỉ định. |
Không cho phép thuộc tính bổ sung.
PluginWriteScope
Một thay đổi plugin đã được ghi vào tài liệu cấu hình nào và phạm vi ảnh hưởng của nó. Mặc định của chính socket command-extension là tài liệu trên toàn máy, nên mọi câu trả lời đều nêu rõ nó đã ghi vào tài liệu nào.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
configFile | string | có | Tài liệu đã được ghi. |
machineWide | boolean | có | Tài liệu đó có phải là tài liệu mà mọi workspace trên máy phân giải qua hay không. |
workspaceRoot | string | có | Workspace mà yêu cầu đã chỉ định. |
Không cho phép thuộc tính bổ sung.
CredentialStoreScope
Phạm vi ảnh hưởng của một thay đổi thông tin xác thực. Kho lưu trữ được dùng chung bởi mọi dự án trên máy và bởi mọi công cụ khác làm việc với cùng các registry, nên câu trả lời báo cáo điều đó thay vì để người đọc tự suy ra rằng nó chỉ giới hạn trong phiên.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
machineWide | boolean | có | Kho lưu trữ mà thay đổi đã chạm tới có được dùng chung trên toàn máy hay không. |
workspaceRoot | string | có | Workspace mà yêu cầu đã chỉ định. |
Không cho phép thuộc tính bổ sung.
SkillFolderScope
Phạm vi mà một lần cài skill vươn tới. Một yêu cầu nêu tên một workspace, nên một câu trả lời không nói gì sẽ được hiểu là chỉ liên quan đến workspace đó — và với các thư mục theo người dùng, mà trợ lý đọc trong mọi dự án, cách hiểu đó là sai.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
machineWide | boolean | có | Liệu các thư mục được ghi có phải là các thư mục theo người dùng dưới thư mục home, mà trợ lý đọc trong mọi dự án trên máy, hay không. |
workspaceRoot | string | có | Workspace mà yêu cầu đã chỉ định. |
Không cho phép thuộc tính bổ sung.
PublicationReach
Phạm vi mà một lần xuất bản đã vươn tới. Các câu trả lời này vươn ra hoàn toàn ngoài máy này — những gì chúng gắn vào chính là những gì mọi bên sử dụng registry đó phân giải — nên mỗi câu trả lời nêu tên mọi registry mà nó đã gửi tới và liệu lệnh gọi có gắn gì vào đó hay không.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
registries | string[] | có | Mọi máy chủ registry mà lệnh gọi đã gửi tới, mỗi máy chủ được nêu một lần, theo thứ tự lệnh gọi gửi tới nó lần đầu. Một lệnh gọi với một tham chiếu duy nhất nêu một máy chủ; một lần chạy thử nêu đích mà nó lẽ ra đã gửi tới. |
beyondThisMachine | boolean | có | Liệu lệnh gọi có gắn thứ gì mà một registry hiện cung cấp cho người khác hay không: nội dung đã tải lên, một chữ ký, một ngày xuất bản hoặc một dấu đánh dấu ngừng hỗ trợ. Là false trong một lần chạy thử, và trong một lệnh gọi thấy mọi thứ nó lẽ ra sẽ gắn đều đã có sẵn — một lần xuất bản chạy lại trên một phiên bản đã hoàn chỉnh, hoặc một lô ký mà mọi tham chiếu đều đã mang một chữ ký xác minh được. |
Không cho phép thuộc tính bổ sung.
WorkspaceEntityRef
Một thực thể, theo loại và tên, cùng với tài liệu khai báo nó.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
kind | string | có | Loại thực thể. |
name | string | có | Tên thực thể. |
file | string | có | Tài liệu khai báo nó, dưới dạng đường dẫn tương đối so với thư mục gốc của workspace. |
Không cho phép thuộc tính bổ sung.
SourcedEntityRef
Một thực thể, cùng với nơi nó được đọc ra. Một tài liệu trong workspace báo cáo đường dẫn tương đối so với workspace; một thực thể được phân giải từ các thư mục catalog đã cấu hình báo cáo một đường dẫn rỗng, vì đường dẫn duy nhất nó có sẽ không có ý nghĩa gì với client. Nguồn gốc cho biết đó là trường hợp nào trong hai trường hợp, thay vì để một đường dẫn rỗng bị hiểu là một trường không ai điền.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
kind | string | có | Loại thực thể. |
name | string | có | Tên thực thể. |
file | string | có | Tài liệu khai báo nó, dưới dạng đường dẫn tương đối so với thư mục gốc của workspace, hoặc rỗng khi nó đến từ các thư mục catalog đã cấu hình. |
origin | string | có | Nơi thực thể được đọc ra. |
Không cho phép thuộc tính bổ sung.
SocketCandidacy
Một socket trên một thực thể, và những gì có thể được nối vào nó.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
socket | string | có | Tên của socket. |
declaration | string | có | Nơi socket được khai báo. |
selector | string | có | Bộ chọn nhãn mà một đích phải thỏa mãn. |
required | boolean | có | Liệu socket có phải được nối để bản build tiếp tục hay không. |
targets | WorkspaceEntityRef[] hoặc null | có | Các thực thể có thể được nối vào nó. |
Không cho phép thuộc tính bổ sung.
SlotCandidacy
Một slot mà socket của một kết nối khai báo, như Component tiêu thụ khai báo nó trên socket, và các Features có thể lấp đầy nó trên kết nối đó.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
slot | string | có | Tên của slot, cũng là khóa mà một attachment lấp đầy nó được ghi dưới đó trong features của kết nối. |
selector | string | có | Bộ chọn nhãn mà một Feature lấp đầy slot phải thỏa mãn bằng chính các nhãn của nó. Rỗng khi slot không khai báo bộ chọn nào, nghĩa là chấp nhận mọi Feature. |
required | boolean | có | Liệu mọi kết nối được nối qua socket có phải lấp đầy slot để bản build tiếp tục hay không. |
inject | string[] | có | Các cơ chế phân phối mà slot cho phép đối với thứ lấp đầy nó, theo thứ tự Component khai báo chúng. Rỗng khi nó không khai báo cơ chế nào. |
sensitive | boolean | có | Liệu slot có khai báo rằng thứ lấp đầy nó xử lý dữ liệu bí mật hay không. Nó đánh dấu attachment lấp đầy nó và không từ chối gì cả. |
description | string | có | Điều Component nói về mục đích của slot. Rỗng khi nó không nói gì. |
candidates | SourcedEntityRef[] | có | Mỗi Feature có thể lấp đầy slot trên kết nối này: một Feature có khả năng áp dụng đã khai báo được các nhãn của nút đồ thị thỏa mãn, điều mà mọi attachment nút mang đều phải tuân theo, và có các nhãn riêng thỏa mãn bộ chọn của slot. Một Feature có khả năng áp dụng hoặc nhãn không thể đọc được theo bộ chọn sẽ không được đề xuất, vì một bản build sẽ từ chối thay vì chấp nhận nó. |
Không cho phép thuộc tính bổ sung.
CatalogEntity
Một thực thể mà chỉ mục workspace lưu giữ.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
kind | string | có | Loại thực thể. |
name | string | có | Tên thực thể. |
apiVersion | string | có | Phiên bản schema mà tài liệu khai báo. |
description | string | có | Điều tài liệu nói về mục đích của thực thể. |
labels | map of string hoặc null | có | Các nhãn mà tài liệu khai báo. |
file | string | có | Tài liệu khai báo nó, dưới dạng đường dẫn tương đối so với thư mục gốc của workspace. |
origin | string | có | Nơi thực thể được đọc ra. |
Không cho phép thuộc tính bổ sung.
CompletionItem
Một thứ có thể được viết tại vị trí con trỏ.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
label | string | có | Văn bản cần viết. |
kind | integer | không | Nó thuộc loại gì, để client có thể chọn biểu tượng cho nó. |
detail | string | không | Một từ bổ nghĩa ngắn hiển thị bên cạnh nhãn. |
documentation | string | không | Mô tả chi tiết về thứ đó. |
sortText | string | không | Giá trị dùng để sắp xếp, khi nó khác với nhãn. |
Không cho phép thuộc tính bổ sung.
MarkupContent
Văn bản cần hiển thị, và cách nó được đánh dấu.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
kind | string | có | Cách văn bản được đánh dấu. |
value | string | có | Văn bản. |
Không cho phép thuộc tính bổ sung.
EntityKindDescriptor
Một loại mà tác giả viết tài liệu, ghép token mà một yêu cầu nêu với loại mà chính tài liệu khai báo, và cho biết những thao tác nào chấp nhận một tài liệu thuộc loại đó.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
kind | string | có | Token viết thường mà một yêu cầu nêu, chẳng hạn component hoặc featurerecipe. |
documentKind | string | có | Loại mà chính phần đầu của tài liệu khai báo. |
acceptedBy | EntityKindAcceptance | có | Những thao tác nào chấp nhận một tài liệu thuộc loại này khi được nêu riêng — theo đường dẫn, hoặc theo tên để kiểm tra — mà không gửi kèm gì khác. Một thành viên là true khi thao tác đó không từ chối một tài liệu vì nó thuộc loại này; một tài liệu được chấp nhận vẫn có thể bị từ chối vì nội dung của tài liệu. |
Không cho phép thuộc tính bổ sung.
EntityKindAcceptance
Với một loại mà tác giả viết, liệu mỗi thao tác có chấp nhận một tài liệu thuộc loại đó khi được nêu riêng hay không. Mọi thành viên đều có mặt trên mọi mục, nên false là một khẳng định chứ không phải một sự bỏ sót.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
singleEntityValidation | boolean | có | Liệu phạm vi một thực thể của aggrega validate — lệnh được cho đường dẫn của một tài liệu — có kiểm tra một tài liệu thuộc loại này hay không. Một loại mà nó từ chối sẽ được kiểm tra bởi phạm vi toàn catalog hoặc phạm vi Release. |
publication | boolean | có | Liệu aggrega/publishEntity khi chỉ nêu tài liệu có xuất bản một tài liệu thuộc loại này hay không. Một loại mà việc xuất bản còn ràng buộc một tệp thực thi được nêu bên cạnh tài liệu — một Plugin — là false, vì một yêu cầu chỉ nêu tài liệu sẽ bị từ chối đối với nó; một Manifest và một Release là false vì cả hai loại đều không được xuất bản. |
inspectionByName | boolean | có | Liệu aggrega/entityDefinition có phân giải một tên thành một thực thể thuộc loại này hay không, với tên được gửi đúng như cách nó được viết ở nơi một thực thể tham chiếu thực thể khác. |
Không cho phép thuộc tính bổ sung.
RegistryTrust
Chính sách tin cậy mà quá trình phân giải áp dụng cho những gì một registry cung cấp.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
signaturesRequired | boolean | có | Liệu một artifact từ registry này có phải mang một chữ ký đã được xác minh hay không. |
verificationSkipped | boolean | không | Liệu việc xác minh có đang bị bỏ qua hay không. |
advisory | boolean | không | Một lần xác minh thất bại có được báo cáo thay vì dừng lại hay không. |
anchor | string | không | Neo tin cậy dùng để xác minh chữ ký. |
keylessIdentities | integer | không | Số danh tính ký được tin cậy cho registry này. |
Không cho phép thuộc tính bổ sung.
Registry
Một registry đã được cấu hình. Không trường nào ở đây chứa dữ liệu thông tin xác thực, độ dài, hình dạng hay bất kỳ cách thể hiện nào của nó — chỉ sự hiện diện được báo cáo, và điều đó giúp giá trị này an toàn để dán vào một issue.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
host | string | có | Máy chủ registry, cũng là danh tính của nó. |
name | string | không | Bí danh thân thiện phân giải thành máy chủ, nếu có cấu hình. |
default | boolean | có | Liệu đây có phải là registry mà một thao tác không nêu registry nào sẽ gửi tới hay không. |
authState | string | có | Liệu một thông tin xác thực cho máy chủ này có hiện diện trong kho dùng chung toàn máy hay không. Nó được báo cáo ngay cả khi rỗng, để bên gọi có thể phân biệt “không có thông tin xác thực nào” với “danh sách đã không kiểm tra”. |
trust | RegistryTrust | có | Chính sách tin cậy mà quá trình phân giải áp dụng cho những gì một registry cung cấp. |
Không cho phép thuộc tính bổ sung.
TrustFetchOutcome
Kết quả của việc đọc chính sách tin cậy mà một registry công bố. Các kết quả được tách riêng vì chúng mang ý nghĩa khác nhau: chính sách được công bố đã được áp dụng, registry không công bố gì — điều này không phải là lỗi — đường cơ sở tích hợp sẵn đã được ghim thay thế, hoặc không có lần đọc nào được thực hiện. Khi không có gì được công bố, việc registry có thể truy cập được hay không sẽ được nêu kèm theo.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
pinned | boolean | có | Chính sách được công bố có được áp dụng hay không. |
notAdvertised | boolean | không | Registry có được hỏi và không công bố chính sách nào hay không, trong trường hợp đó thao tác tiếp tục dựa trên những gì yêu cầu đã nêu. Một registry mà chế độ ngoại tuyến ngăn không cho hỏi sẽ không bao giờ được báo cáo theo cách này. Một registry không thể truy cập cũng được báo cáo theo cách này, vì không có chính sách nào được trả về từ nó, và mang unreachable kèm theo; hãy đọc unreachable để phân biệt hai trường hợp. |
unreachable | boolean | không | Registry có không thể truy cập khi chính sách được công bố của nó được yêu cầu hay không: tên của nó không phân giải được, kết nối đến nó bị từ chối hoặc không thể mở, hoặc không thể thiết lập kết nối bảo mật đến nó. Giá trị này được đọc từ chính lỗi thay vì từ reason, nó đứng cạnh notAdvertised, và chỉ được đặt khi lỗi cho thấy registry chưa bao giờ được truy cập; một registry đã trả lời — không có chính sách, hoặc với một lỗi — sẽ để trống giá trị này. |
baseline | boolean | không | Đường cơ sở tích hợp sẵn có được ghim vì không có chính sách được công bố nào được áp dụng hay không, điều mà chỉ hub chính thức mang. Nó đứng cạnh notAdvertised khi hub được hỏi và không công bố gì, và đứng một mình khi chế độ ngoại tuyến ngăn không cho hỏi hub. |
skipped | boolean | không | Có phải không có lần đọc nào được thực hiện hay không, vì một chính sách đã nêu đã ghi đè nó hoặc yêu cầu không đòi hỏi lần đọc nào. |
identities | integer | không | Số danh tính ký mà chính sách được công bố mang. |
reason | string | không | Lý do chính sách được công bố không được áp dụng: điều mà endpoint của registry đã làm, hoặc sự từ chối ngoại tuyến đã ngăn không cho hỏi nó. |
Không cho phép thuộc tính bổ sung.
SkippedRepo
Một repository mà lượt duyệt chỉ mục đã bỏ qua, và lý do.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
repo | string | có | Repository đã bị bỏ qua. |
reason | string | có | Lý do nó bị bỏ qua. |
Không cho phép thuộc tính bổ sung.
DeprecationNote
Một dấu hiệu ngừng hỗ trợ mà lượt duyệt chỉ mục gặp, và cách nó xử lý dấu hiệu đó. Một dấu hiệu được chấp nhận và một dấu hiệu có mặt nhưng bị từ chối được báo cáo ngang nhau, để việc ghi nhận nhiều dấu hiệu không trôi qua trong im lặng trong khi việc từ chối một dấu hiệu lại tự thông báo.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
repo | string | có | Repository mà dấu hiệu nằm trên đó. |
version | string | có | Phiên bản mà dấu hiệu áp dụng. |
recorded | boolean | có | Chữ ký riêng của dấu hiệu có được xác minh hay không, và do đó chỉ mục có mang nó hay không. |
severity | const “warning” hoặc const “error” hoặc const “retracted” | không | Mức độ mạnh của dấu hiệu. Giá trị được phép: "warning" — Ngừng hỗ trợ, ở cấp nhẹ hơn trong hai cấp khuyến cáo: vẫn được chọn khi chọn một phiên bản. "error" — Ngừng hỗ trợ, ở cấp mạnh hơn trong hai cấp khuyến cáo: vẫn được chọn khi chọn một phiên bản. "retracted" — Thu hồi: bị loại trừ khi chọn một phiên bản. |
reason | string | không | Lý do phiên bản không còn được khuyến dùng. |
Không cho phép thuộc tính bổ sung.
HostUpdate
Những gì một lần làm mới chỉ mục đã làm cho một registry.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
host | string | có | Registry host đã được làm mới. |
indexed | integer | có | Số bản ghi đã được ghi. |
deprecationsExamined | boolean | có | Lượt duyệt có tìm kiếm dấu hiệu ngừng hỗ trợ hay không. Giá trị này tách biệt với số đếm vì “registry này không công bố dấu hiệu nào” và “lần chạy này không có cơ sở để đánh giá dấu hiệu nào” là hai sự thật khác nhau. |
deprecationsRecorded | integer | có | Số dấu hiệu đã được chấp nhận. |
skipped | SkippedRepo[] hoặc null | có | Các repository mà lượt duyệt đã bỏ qua. |
deprecations | DeprecationNote[] hoặc null | có | Các dấu hiệu mà lượt duyệt đã gặp. |
readsRetried | integer | có | Số lần đọc trong lượt duyệt mà registry đã từ chối hoặc làm rơi giữa chừng và được yêu cầu lại, mỗi lần đọc được tính một lần bất kể cần bao nhiêu lần thử và dù sau đó có thành công hay không; bằng không nếu không có lần nào. Một lượt duyệt có mọi lần đọc cuối cùng đều thành công sẽ không liệt kê kho lưu trữ nào dưới skipped, nên chính số đếm này cho biết lượt duyệt đã suýt bỏ sót một kho lưu trữ đến mức nào. Tối thiểu: 0. |
error | string | không | Điều gì đã thất bại với host này, để một lượt duyệt qua nhiều host báo cáo host nào thất bại mà bên gọi không cần đối chiếu gì. |
unreachable | boolean | không | Registry này có không thể truy cập hay không: tên của nó không phân giải được, kết nối đến nó bị từ chối hoặc không thể mở, hoặc không thể thiết lập kết nối bảo mật đến nó. Giá trị này được đọc từ chính lỗi thay vì từ error, chỉ được đặt cạnh error, và chỉ khi lỗi cho thấy registry chưa bao giờ được truy cập; một registry đã trả lời, bất kể trả lời gì, sẽ để trống giá trị này. |
Không cho phép thuộc tính bổ sung.
PublishedVersion
Một phiên bản mà chỉ mục lưu giữ cho một tham chiếu: digest của manifest mà tag của nó phân giải đến khi chỉ mục được xây dựng; khi chính sách tin cậy dùng để xây dựng chỉ mục đã xác minh chữ ký riêng của phiên bản, người ký mà nó được xác minh là; và, khi có nơi ghi nhận, thời điểm phiên bản được công bố, cùng nguồn cho biết điều đó. Người ký vắng mặt với phiên bản không có chữ ký, với phiên bản không có chữ ký nào được xác minh, và khi chính sách đó không ghim khóa công khai hay danh tính tin cậy nào hoặc tắt xác minh chữ ký. Không trường hợp nào trong số đó là cơ sở để nêu tên người ký, và sự vắng mặt của nó không nói gì thêm. Ngày công bố vắng mặt khi bản công bố không nêu ngày nào và không có chữ ký keyless nào được chính sách đó xác minh ghi nhận ngày đó.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
version | string | có | Phiên bản, theo tên mà tag của nó đặt. |
manifestDigest | string | có | Digest của manifest mà tag của phiên bản phân giải đến khi chỉ mục được xây dựng, dùng để định địa chỉ phiên bản theo các byte mà nó chỉ đến thay vì theo tag. |
signer | VerifiedSignature | không | Một chữ ký đã được xác minh theo chính sách tin cậy của một registry: cách nó được xác minh, người ký mà nó được xác minh là, và digest của gói chữ ký đã được xác minh. |
publishedAt | string | không | Thời điểm phiên bản được công bố, dưới dạng dấu thời gian RFC 3339 theo UTC, chính xác đến giây. Nguồn gốc của nó là publishedAtSource, và cả hai cùng có mặt hoặc cùng vắng mặt. |
publishedAtSource | const “transparency-log” hoặc const “publisher” | không | Nguồn gốc của publishedAt, để một thời điểm mà nhật ký minh bạch chứng thực không bao giờ bị nhầm với thời điểm mà bên xuất bản nêu. Tập giá trị là đóng. Giá trị được phép: "transparency-log" — Thời điểm một nhật ký minh bạch ghi lại chữ ký keyless của phiên bản, được chính sách tin cậy dùng khi xây dựng chỉ mục xác minh cùng với lời cam kết đã ký của nhật ký về thời điểm đó. Với một phiên bản được ký khi xuất bản, đó là thời điểm xuất bản; với phiên bản được ký sau đó, đó là thời điểm chữ ký được tạo. "publisher" — Thời điểm mà bản xuất bản nêu bên cạnh những gì nó xuất bản, theo đồng hồ của chính máy xuất bản. Không gì chứng thực nó. Một bản xuất bản nêu thời điểm này khi chữ ký của nó không mang thời điểm được chứng thực: một chữ ký có khóa, hoặc không có chữ ký. Khi có nhiều cái được gắn, cái sớm nhất được lấy. |
Không cho phép thuộc tính bổ sung.
VerifiedSignature
Một chữ ký đã được xác minh theo chính sách tin cậy của một registry: cách nó được xác minh, người ký mà nó được xác minh là, và digest của gói chữ ký đã được xác minh.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
bundleDigest | string | có | Digest của gói chữ ký đã được xác minh, dưới dạng sha256: theo sau là 64 ký tự hex viết thường. |
identity | string | không | Người ký mà chữ ký được xác minh là: với chữ ký keyless, danh tính mà chứng chỉ ký được cấp cho, tức là subject alternative name của nó; với chữ ký keyed, keyed:sha256: theo sau là SHA-256 dạng hex viết thường của văn bản PEM của khóa công khai được ghim. |
issuer | string | không | OIDC issuer được ghi trong chứng chỉ ký, đối với chữ ký keyless. Nó vắng mặt với chữ ký keyed. |
mode | const “keyless” hoặc const “keyed” | có | Cách chữ ký được xác minh. Tập giá trị là đóng. Giá trị được phép: "keyless" — Dựa trên một chứng chỉ ký có định danh và bên phát hành khớp với một mục mà chính sách tin cậy, được nối chuỗi tới gốc tin cậy mà chính sách ghim hoặc, nếu chính sách không ghim gốc nào, tới gốc Sigstore công ích, và có chữ ký được một nhật ký minh bạch ghi lại. "keyed" — Dựa trên khóa công khai mà chính sách ghim. |
Không cho phép thuộc tính bổ sung.
RegistrySearchRecord
Một bản ghi mà tìm kiếm khớp, như chỉ mục cục bộ lưu giữ, cùng với các phiên bản của nó đã bị một dấu hiệu được công bố đánh dấu ngừng hỗ trợ.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
uri | string | có | Tham chiếu mà bản ghi được phân giải từ đó. |
name | string | có | Tên thực thể. |
version | string | có | Phiên bản mà bản ghi được gán khóa. |
versions | string[] | không | Mọi phiên bản mà chỉ mục lưu giữ cho tham chiếu này. |
kind | string | không | Loại thực thể. |
description | string | không | Mục đích của thực thể. |
category | string | không | Danh mục mà thực thể được công bố trong đó. |
labels | map của string | không | Các nhãn mà thực thể khai báo. |
pluginType | string | không | Socket mà một bản ghi plugin gắn vào. |
capabilities | string[] | không | Các capability mà một bản ghi plugin khai báo. |
manifestDigest | string | không | Digest của manifest đã được công bố. |
listingDigest | string | không | Digest của danh sách mà bản ghi được đọc từ đó. |
deprecations | object[] | không | Các dấu hiệu ngừng hỗ trợ mà chỉ mục mang cho tham chiếu này, mỗi dấu hiệu kèm phiên bản mà nó áp dụng và chính dấu hiệu đã được xác minh. |
published | PublishedVersion[] | không | Mọi phiên bản mà chỉ mục lưu giữ cho tham chiếu này, theo cùng thứ tự với versions, mỗi phiên bản kèm digest của manifest mà tag của nó phân giải đến khi chỉ mục được xây dựng, người ký đã được xác minh khi chính sách tin cậy dùng để xây dựng chỉ mục đã xác minh chữ ký riêng của phiên bản đó, và khi có nơi ghi nhận, ngày công bố cùng nguồn của ngày đó. Một phiên bản được ghi nhận không có người ký thì không mang chữ ký nào được chính sách đó xác minh, và không có gì thêm được nói về nó. Chỉ manifest, các tệp đính kèm chữ ký và các tệp đính kèm ngày công bố được đọc từ registry để ghi nhận điều này; không có nội dung của thực thể nào được tải về. |
retracted | string[] | không | Các phiên bản đã bị một dấu hiệu được công bố đánh dấu ngừng hỗ trợ. |
Không cho phép thuộc tính bổ sung.
RegistrySearchIndex
Độ mới của một host đã được tìm kiếm.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
host | string | có | Host có chỉ mục đã được tìm kiếm. |
lastUpdated | string | không | Thời điểm chỉ mục được làm mới lần cuối. Trường này vắng mặt thay vì bằng không khi snapshot không mang thời gian, để bên gọi có thể phân biệt “không được ghi lại” với epoch. |
Không cho phép thuộc tính bổ sung.
EffectiveConfigurationSetting
Một thiết lập đã được phân giải, và tài liệu mà nó đến từ đó.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
field | string | có | Thiết lập. |
value | string | có | Giá trị đã được phân giải. |
source | string | có | Nơi giá trị đến từ đó. |
Không cho phép thuộc tính bổ sung.
ImportedFile
Một tệp mà một lần import ghi ra: một tài liệu nháp, hoặc bản ghi về những gì lần import đã ghi.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
path | string | có | Vị trí của tệp, dưới dạng đường dẫn tương đối so với outputDir của câu trả lời. |
content | string | có | Văn bản của tệp. |
Không cho phép thuộc tính bổ sung.
ImportDrift
Một phần mà một lần sync đã cập nhật theo nguồn, hoặc sẽ cập nhật khi dùng dryRun.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
change | string | có | Cách phần đó bị lệch: added, cho một phần mà nguồn có thêm; removed, cho một phần mà nguồn đã bỏ; hoặc changed, cho một phần mà nguồn đã thay đổi. |
file | string | có | Tệp nháp chứa phần đó, dưới dạng đường dẫn tương đối so với outputDir của câu trả lời. |
key | string[] | có | Các khóa dẫn đến phần đó từ đỉnh của một Aggregate hoặc Release nháp, mỗi khóa một mục, để một khóa chứa dấu chấm vẫn là một mục. Rỗng khi phần đó là toàn bộ tệp. |
Không cho phép thuộc tính bổ sung.
ImportOwed
Một giá trị mà các bản nháp vẫn để trống, không nguồn nào cung cấp được và không câu trả lời nào đã cung cấp.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
file | string | có | Tệp nháp chứa giá trị, dưới dạng đường dẫn tương đối với outputDir của câu trả lời. |
key | string[] | có | Các khóa dẫn tới giá trị từ đầu tài liệu đó, mỗi khóa một mục, nên một khóa chứa dấu chấm vẫn là một mục. Một câu trả lời được gửi dưới dạng answered nêu tên giá trị bằng các khóa này. |
question | string | có | Giá trị là gì: mô tả trong schema của nó, nếu không thì chú thích mà bản nháp viết phía trên khóa của nó, nếu không nữa thì những gì schema của nó nói rằng nó nhận. |
sensitive | boolean | có | Giá trị có phải của một secret hay không; câu trả lời của secret nêu nơi secret đến từ và không bao giờ chứa chính secret đó. |
secretAdvice | string | không | Có mặt trên giá trị của một secret: câu trả lời của nó phải là gì, trong câu được hiển thị cho người trả lời nó tại terminal — hoặc, khi câu trả lời gửi cho nó dưới dạng answered bị từ chối, lý do nó bị từ chối. |
Không cho phép thuộc tính bổ sung.
ImportAnswered
Một câu trả lời cho một giá trị mà owed trong câu trả lời đã liệt kê.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
file | string | có | Tệp nháp chứa giá trị, như owed nêu tên. |
key | string[] | có | Các khóa dẫn tới giá trị, như owed nêu tên. |
answer | string | có | Câu trả lời. Một câu trả lời trống để giá trị vẫn còn thiếu. |
Không cho phép thuộc tính bổ sung.
ImportDiagnostic
Một thứ mà một lần chuyển đổi không thể chuyển đổi. Đây là đầu ra hữu ích nhất của lần chuyển đổi, nên chúng được báo cáo đầy đủ thay vì rút gọn thành một kết luận.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
severity | string | có | Mức độ nghiêm trọng. |
message | string | có | Thứ không thể chuyển đổi. |
code | string | không | Tên có thể trích dẫn của điều kiện, nếu có. |
Không cho phép thuộc tính bổ sung.
ImportDecision
Cách một lần chuyển đổi ánh xạ một nút nguồn: các Components trong catalog mà importer đã cân nhắc, Component nó đã chọn, lý do, và cách hoán đổi lựa chọn.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
sourceNode | DecisionSourceNode | có | Nút nguồn mà một quyết định ánh xạ nói đến. |
candidates | ImportCandidate[] | không | Các Components trong catalog mà importer đã cân nhắc cho nút, mỗi cái kèm điểm số. Vắng mặt khi nó không cân nhắc cái nào. |
chosen | DecisionChoice | không | Những gì importer đã chọn cho một nút nguồn. Vắng mặt trong một quyết định mà nó không đưa ra lựa chọn. |
rationale | string | không | Lý do importer đưa ra lựa chọn, theo lời của chính nó. Vắng mặt khi nó không viết gì. |
swapHint | string | không | Cách hoán đổi lựa chọn sang một phương án khác, theo lời của chính importer. Vắng mặt khi nó không viết gì. |
Không cho phép thuộc tính bổ sung.
DecisionSourceNode
Nút nguồn mà một quyết định ánh xạ nói đến.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
id | string | có | Định danh của nút trong nguồn. |
type | string | có | Loại của nút, theo cách nguồn gọi tên. |
paramsSummary | string | có | Bản tóm tắt các tham số của nút, để hiển thị bên cạnh quyết định. |
Không cho phép thuộc tính bổ sung.
ImportCandidate
Một Component trong catalog mà importer đã cân nhắc cho một nút nguồn.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
componentName | string | có | Tên của Component. |
score | number | có | Mức độ Component khớp với nút, theo điểm importer đã chấm. |
tier | string | có | Bậc khớp mà điểm số rơi vào. |
signals | CandidateSignals | có | Mức đóng góp của từng tín hiệu của importer vào điểm số của một ứng viên. |
Không cho phép thuộc tính bổ sung.
CandidateSignals
Mức đóng góp của từng tín hiệu của importer vào điểm số của một ứng viên.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
table | number | có | Mức đóng góp của tín hiệu bảng ánh xạ. |
category | number | có | Mức đóng góp của tín hiệu danh mục. |
domainLabels | number | có | Mức đóng góp của tín hiệu nhãn miền. |
shape | number | có | Mức đóng góp của tín hiệu hình dạng. |
name | number | có | Mức đóng góp của tín hiệu tên. |
Không cho phép thuộc tính bổ sung.
DecisionChoice
Những gì importer đã chọn cho một nút nguồn. Vắng mặt trong một quyết định mà nó không đưa ra lựa chọn.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
target | string | có | Tên của Component được chọn: một Component có sẵn trong catalog, hoặc Component được soạn nháp cho nút. |
mode | string | có | Cách lựa chọn được ghi: dưới dạng tham chiếu đến một Component có sẵn, hoặc dưới dạng một Component mới soạn nháp. |
tier | string | có | Bậc khớp của lựa chọn. |
Không cho phép thuộc tính bổ sung.
LintFileFindings
Những gì một lần kiểm tra quy ước tìm thấy trong một tài liệu.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
file | string | có | Tài liệu. |
diagnostics | Diagnostic[] hoặc null | có | Các phát hiện trong đó. |
Không cho phép thuộc tính bổ sung.
PluginRetractionExclusion
Một phiên bản có sẵn nhưng không được chọn.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
version | string | có | Phiên bản đã bị bỏ qua. |
reason | string | không | Lý do nó bị bỏ qua. |
Không cho phép thuộc tính bổ sung.
PluginRetractionProvenance
Nguồn gốc của thông tin về những gì đã bị deprecated.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
source | string | có | Những gì đã được tham khảo. |
lastUpdated | string | không | Thời điểm nó được làm mới lần cuối. |
Không cho phép thuộc tính bổ sung.
PluginRetraction
Cách một dấu deprecation đã định hình phiên bản plugin nào được ghim.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
reference | string | có | Tham chiếu mà các phiên bản thuộc về. |
selected | string | không | Phiên bản đã được ghim. |
excluded | PluginRetractionExclusion[] | không | Các phiên bản có sẵn nhưng đã bị bỏ qua. |
unscreened | string | không | Những gì không thể sàng lọc theo một dấu, và lý do. |
provenance | PluginRetractionProvenance | không | Nguồn gốc của thông tin về những gì đã bị deprecated. |
Không cho phép thuộc tính bổ sung.
PluginGeneratedDocument
Một tài liệu catalog mà một lần sinh đã tạo ra.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
path | string | có | Vị trí của tài liệu, dưới dạng đường dẫn tương đối so với thư mục gốc của workspace. |
content | string | có | Văn bản của tài liệu. |
Không cho phép thuộc tính bổ sung.
PluginCommandFlag
Một cờ mà plugin khai báo trên một lệnh nó đóng góp.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
name | string | có | Tên dài của cờ. |
shorthand | string | không | Bí danh một ký tự của cờ, nếu có. |
description | string | không | Văn bản trợ giúp một dòng của cờ. |
type | string | không | Loại giá trị của cờ. |
default | string | không | Giá trị được dùng khi cờ không được truyền. |
Không cho phép thuộc tính bổ sung.
PluginCLICommand
Một động từ lệnh cấp cao nhất mà plugin đóng góp.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
name | string | có | Động từ lệnh. |
description | string | không | Văn bản trợ giúp một dòng của lệnh. |
flags | PluginCommandFlag[] | không | Các cờ của lệnh, theo thứ tự khai báo. |
Không cho phép thuộc tính bổ sung.
ConfigCapturedAttachment
Một attachment mà một lần freeze đã ghi vào cấu hình riêng của workspace này.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
uri | string | không | Tham chiếu mà attachment được phân giải từ đó. |
capability | string | không | Capability mà attachment phục vụ. |
function | string | không | Export mà attachment được điều phối tới. |
role | string | không | Vai trò mà phần gắn kết chạy trong đó, vai trò này xác định những gì nó có thể phát ra. |
Không cho phép thuộc tính bổ sung.
ConfigCapturedSocket
Một socket mà một lần freeze đã ghi, cùng các attachment nó đã freeze vào đó.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
socket | string | có | Socket. |
field | string | có | Trường cấu hình mà socket được ghi dưới đó. |
attachments | ConfigCapturedAttachment[] hoặc null | có | Các attachment đã được freeze vào nó. |
Không cho phép thuộc tính bổ sung.
ExplainErrorEntry
Một đoạn đã xuất bản hướng dẫn cách sửa khi soạn thảo cho một điều kiện.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
heading | string | có | Tiêu đề của đoạn. |
body | string | có | Đoạn văn. |
Không cho phép thuộc tính bổ sung.
SignedArtifact
Một artifact đã xuất bản mà một lần ký đã bao phủ.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
reference | string | có | Tham chiếu đã được ký. |
digest | string | có | Digest của những gì đã được ký. |
Không cho phép thuộc tính bổ sung.
DeprecationMarked
Một phiên bản đã xuất bản mà một lần deprecation đã đánh dấu.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
reference | string | có | Tham chiếu đã được đánh dấu. |
severity | const “warning” hoặc const “error” hoặc const “retracted” | có | Mức độ mạnh của dấu hiệu. Giá trị được phép: "warning" — Ngừng hỗ trợ, ở cấp nhẹ hơn trong hai cấp khuyến cáo: vẫn được chọn khi chọn một phiên bản. "error" — Ngừng hỗ trợ, ở cấp mạnh hơn trong hai cấp khuyến cáo: vẫn được chọn khi chọn một phiên bản. "retracted" — Thu hồi: bị loại trừ khi chọn một phiên bản. |
issuedOn | string | có | Thời điểm dấu được phát hành. |
digest | string | có | Digest của dấu đã được xuất bản. |
Không cho phép thuộc tính bổ sung.
InitializeResult
Những gì phiên đã thống nhất cho client này, và lớp cấu hình mà nó được phân giải từ đó.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
capabilities | ServerCapabilities | có | Những gì daemon sẽ làm trong phiên này, được thống nhất dựa trên những gì client cho biết nó có thể xử lý. |
workspaceRoot | string | có | Workspace mà phiên được mở trên đó. |
configSource | string | có | Lớp cấu hình mà phiên đã phân giải các thiết lập của mình từ đó. |
workspaceMarker | string | không | Tệp đã xác định gốc workspace, nếu có tệp như vậy. |
version | string | có | Phiên bản của tệp nhị phân đang trả lời phiên này: cùng giá trị mà aggrega version báo cáo cho tệp nhị phân đó. Nó mô tả tiến trình đang chạy, vì vậy khi tệp mà daemon được khởi động từ đó đã bị thay thế, giá trị này vẫn chỉ phiên bản đang chạy, trong khi hỏi tệp sẽ cho biết phiên bản đã thay thế nó. |
Không cho phép thuộc tính bổ sung.
ValidateResult
Những gì việc kiểm tra tìm thấy, và phạm vi đã được kiểm tra.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
diagnostics | Diagnostic[] hoặc null | có | Các phát hiện. Giá trị là null thay vì một danh sách rỗng khi việc kiểm tra không tìm thấy gì. |
checked | string | không | Phạm vi đã được kiểm tra — một tài liệu, hoặc những gì workspace chứa. |
Không cho phép thuộc tính bổ sung.
InvalidateResult
Daemon có đang giữ gì về tài liệu để loại bỏ hay không.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
invalidated | boolean | có | Có gì đã bị loại bỏ hay không. |
Không cho phép thuộc tính bổ sung.
DiagnosticsResult
Các phát hiện mà daemon đã giữ sẵn cho tài liệu.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
diagnostics | Diagnostic[] hoặc null | có | Các phát hiện. Giá trị là null thay vì một danh sách rỗng khi không có phát hiện nào. |
Không cho phép thuộc tính bổ sung.
IrGraphResult
Đồ thị đã phân giải mà một Release được biên dịch thành.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
graph | any | có | Tài liệu đồ thị. Các giá trị mà tác giả khai báo là nhạy cảm sẽ bị giữ lại khỏi nó, trừ khi yêu cầu đã đòi chúng bằng unredacted; mọi thứ khác được giữ nguyên như trình biên dịch đã xuất ra. Cấu trúc riêng của nó là hợp đồng đã công bố của đồ thị và không được nhắc lại ở đây. |
Không cho phép thuộc tính bổ sung.
BuildResult
Những gì một lần build đã ghi.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
outputDirectory | string | có | Thư mục mà các artifact đã được ghi vào. |
files | string[] hoặc null | có | Các artifact đã được ghi, dưới dạng đường dẫn tương đối so với thư mục đầu ra. |
notices | BuildNotice[] | không | Bất cứ điều gì lần build muốn bên gọi biết mà không phải là một phát hiện hay một lỗi. |
dependencyResolution | DependencyResolutionReport | không | Những gì một lần phân giải phụ thuộc đã ghim và thu nhận. |
Không cho phép thuộc tính bổ sung.
BuildPreviewResult
Những gì một lần build lẽ ra đã ghi. Không có gì được ghi, nên không có thư mục đầu ra nào để nêu.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
files | string[] hoặc null | có | Các artifact mà việc ghi lẽ ra đã tạo ra. |
notices | BuildNotice[] | không | Bất cứ điều gì lần biên dịch muốn bên gọi biết mà không phải là một phát hiện hay một lỗi. |
Không cho phép thuộc tính bổ sung.
EntityDefinitionResult
Một tên thực thể phân giải thành gì, và tài liệu định nghĩa nó. Một câu trả lời được đọc từ một tham chiếu registry mang published, còn một câu trả lời mà catalog phân giải theo tên thì không bao giờ mang.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
kind | string | có | Loại thực thể. |
name | string | có | Tên thực thể. |
version | string | có | Phiên bản đã được phân giải. |
description | string | không | Điều tài liệu nói về mục đích của thực thể. |
publishScope | string | không | Mức độ rộng mà thực thể được công bố. |
file | string | có | Tài liệu định nghĩa nó. |
authoredLength | integer | có | Số byte mà tài liệu do tác giả viết chứa, để client có thể phân biệt một tài liệu do tác giả viết với một bản kết xuất đã phân giải của nó. |
definition | string | có | Văn bản của định nghĩa. |
published | PublishedArtifact | không | Những gì một tham chiếu registry đã đọc: tọa độ, cách nó chứa thực thể, và manifest mà nó được đọc thông qua. Mọi trường đều có mặt ở bất cứ đâu có đối tượng này. |
Không cho phép thuộc tính bổ sung.
PublishedArtifact
Những gì một tham chiếu registry đã đọc: tọa độ, cách nó chứa thực thể, và manifest mà nó được đọc thông qua. Mọi trường đều có mặt ở bất cứ đâu có đối tượng này.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
reference | string | có | Tham chiếu registry đã được đọc. |
archive | boolean | có | Các byte của tọa độ có phải là một kho lưu trữ mà tài liệu thực thể được giải nén từ đó hay không. Là false khi tọa độ chứa chính tài liệu thực thể. |
mediaType | string | có | Loại artifact mà manifest khai báo. |
manifestDigest | string | có | Digest của manifest mà thực thể được đọc thông qua — giá trị cần nêu sau @ để đọc lại chính xác cùng các byte đó. |
Không cho phép thuộc tính bổ sung.
ReleaseClosureResult
Mọi thứ mà một Release phụ thuộc vào, theo những gì quá trình phân giải đạt tới. Nó báo cáo bao đóng thay vì đồ thị được suy ra từ đó: một tài liệu khác về cùng Release.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
release | string | có | Release đã được kiểm tra. |
aggregate | string | có | Aggregate mà nó triển khai. |
manifest | string | có | Manifest mà nó phân giải thông qua. |
environment | string | có | Môi trường mà nó nêu tên. |
entities | ClosureEntity[] hoặc null | có | Các thực thể mà bao đóng đạt tới. |
libraries | ClosureEntity[] hoặc null | có | Các thư viện mà bao đóng đạt tới. |
plugins | ClosureEntity[] hoặc null | có | Các plugin mà bao đóng đạt tới. |
mappingDiagnostics | string[] hoặc null | có | Những gì việc phân giải các ánh xạ của Manifest đã báo. |
deprecations | string[] hoặc null | có | Các dấu ngừng hỗ trợ mà bao đóng gặp phải. |
Không cho phép thuộc tính bổ sung.
ResolveDependenciesResult
Những gì một lần phân giải phụ thuộc đã ghim và thu thập, cùng bất cứ điều gì nó muốn bên gọi biết. Các trường riêng của báo cáo được đặt trực tiếp trên câu trả lời này thay vì lồng dưới một thành phần của nó.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
lockfile | string | có | Lockfile mà lần phân giải đã ghi, hoặc lockfile mà một lần kiểm tra đã so sánh. |
verified | boolean | không | Yêu cầu có phải là một lần kiểm tra hay không; lần kiểm tra so sánh lockfile đã ghi và không ghi lockfile, bản ghi tin cậy plugin hay entity.lock nào. |
entities | ClosureEntity[] hoặc null | có | Các thực thể mà lần phân giải đã ghim, hoặc lần kiểm tra đã so sánh. |
libraries | ClosureEntity[] hoặc null | có | Các thư viện mà lần phân giải đã ghim, hoặc lần kiểm tra đã so sánh. |
plugins | ClosureEntity[] hoặc null | có | Các plugin mà lần phân giải đã ghim, hoặc lần kiểm tra đã so sánh. |
sourceArtifacts | integer | có | Số artifact nguồn đã được thu nhận. |
trustedPlugins | integer | có | Số plugin đã ghim mang chữ ký đã được xác minh. |
toolchain | ToolchainReport | không | Trình biên dịch đã được phân giải, và các plugin mà nó mang theo. |
externalInputs | integer | có | Số đầu vào bên ngoài mà quá trình render sử dụng đã được thu nhận. |
incompleteExternalInputs | string | không | Những đầu vào bên ngoài nào không thể thu nhận, khi có một số không thể thu nhận. |
notices | string[] | không | Bất cứ điều gì lần phân giải muốn bên gọi biết. |
Không cho phép thuộc tính bổ sung.
PinResult
Những gì bước ghim đã làm với tệp khóa bên cạnh một thực thể, hoặc sẽ làm trong một lần chạy thử. Đây là câu trả lời cho aggrega/pin, và một lần công bố đã chạy bước này mang nó dưới dạng pin của mình.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
entity | string | có | Tài liệu thực thể mà bước này đã đọc, dưới dạng đường dẫn tương đối so với gốc workspace. |
kind | string | có | Loại của thực thể, như tài liệu của nó khai báo. |
name | string | có | Tên của thực thể, như tài liệu của nó khai báo. |
pinnable | boolean | có | Một thực thể thuộc loại này có đọc bất cứ thứ gì mà tệp khóa ghi lại một ghim cho nó hay không, điều mà một Recipe và một FeatureRecipe làm. Khi giá trị là false, không có gì bên cạnh thực thể bị động đến, changed là false, và lock, removed, pins và content vắng mặt. |
lock | string | không | Tệp khóa mà bước này đã ghi, hoặc sẽ ghi, dưới dạng đường dẫn tương đối so với gốc workspace. |
changed | boolean | có | Tệp khóa có thay đổi hay không, hoặc sẽ thay đổi trong một lần chạy thử. Là false khi tệp khóa đã ghi lại mọi ghim mà thực thể cần và được giữ nguyên từng byte. |
removed | boolean | không | Thay đổi có phải là một lần xóa hay không: thực thể không đọc gì mà tệp khóa ghi lại một ghim cho nó, nên không còn tệp khóa nào bên cạnh nó. |
dryRun | boolean | không | Đây có phải là báo cáo những gì bước này sẽ làm thay vì những gì nó đã làm hay không. |
pins | PinClassCount[] | không | Số ghim của mỗi lớp mà tệp khóa chứa sau bước này, hoặc sẽ chứa sau một lần chạy thử. Mọi lớp mà tệp khóa có thể chứa đều được liệt kê, kể cả lớp không có ghim nào. |
content | string | không | Tệp khóa mà một lần chạy thử sẽ ghi. Vắng mặt khi tệp khóa sẽ được giữ nguyên hoặc bị xóa, và trên mọi câu trả lời không phải là lần chạy thử. |
Không cho phép thuộc tính bổ sung.
PinClassCount
Số ghim của một lớp mà một tệp khóa chứa.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
class | string | có | Lớp của ghim, theo cách diễn đạt mà một thông báo từ chối nêu tên ghim bị thiếu sử dụng — chẳng hạn remote source hoặc imported file. |
pins | integer | có | Số ghim của lớp đó mà tệp khóa chứa. |
Không cho phép thuộc tính bổ sung.
CacheStatusResult
Những gì các bộ nhớ đệm phục vụ workspace này đang lưu giữ.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
classes | CacheClass[] hoặc null | có | Từng bộ nhớ đệm và những gì nó lưu giữ. |
provenance | CacheProvenance[] hoặc null | có | Các danh tính mà các artifact được lưu đệm đã được thu nhận theo đó. |
totalCount | integer | có | Tổng số mục mà các bộ nhớ đệm lưu giữ. |
totalSize | integer | có | Tổng số byte mà chúng chiếm. |
totalSizeText | string | có | Cùng tổng đó, được viết theo cách con người đọc. |
scope | CacheScope | có | Phạm vi ảnh hưởng của một câu trả lời về bộ nhớ đệm. Hai trong số các lớp bộ nhớ đệm được dùng chung bởi mọi dự án trên máy, nên mọi câu trả lời về bộ nhớ đệm đều nêu rõ những lớp nào nó đã chạm tới — nếu không, một phiên mở trên một workspace sẽ bị hiểu là chỉ báo cáo về workspace đó. |
Không cho phép thuộc tính bổ sung.
CachePruneResult
Những gì một lần thu hồi đã xóa, đã giữ lại và không thể thu hồi.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
removed | CacheRemoval[] hoặc null | có | Những gì đã bị xóa. |
heldOpen | CacheRemoval[] hoặc null | có | Những gì lần dọn dẹp lẽ ra đã xóa nhưng để nguyên vì một tiến trình khác đang mở nó. Chỉ Windows từ chối xóa một tệp đang mở, nên ở mọi nơi khác mục này rỗng. Các mục này không được tính là đã xóa cũng không được tính là đã giữ, không byte nào của chúng được tính là đã thu hồi, và một lần dọn dẹp sau sẽ thu hồi chúng; một mục là thư mục có thể đã mất các tệp bên trong không bị mở. |
retainedCount | integer | có | Số mục đã được giữ lại. |
reclaimedBytes | integer | có | Số byte đã được thu hồi. |
reclaimedBytesText | string | có | Cùng con số đó, viết theo cách con người đọc. |
unattributedCount | integer | có | Số mục không có bên nắm giữ nào nhận. |
unattributedSize | integer | có | Số byte mà các mục đó chiếm. |
unattributedSizeText | string | có | Cùng con số đó, viết theo cách con người đọc. |
notPruneEligible | CacheShortfall[] hoặc null | có | Những gì còn sót lại, và điều gì sẽ thu hồi nó. |
scope | CacheScope | có | Phạm vi ảnh hưởng của một câu trả lời về bộ nhớ đệm. Hai trong số các lớp bộ nhớ đệm được dùng chung bởi mọi dự án trên máy, nên mọi câu trả lời về bộ nhớ đệm đều nêu rõ những lớp nào nó đã chạm tới — nếu không, một phiên mở trên một workspace sẽ bị hiểu là chỉ báo cáo về workspace đó. |
Không cho phép thuộc tính bổ sung.
CacheEvictResult
Những gì việc thu hồi xuống một kích thước đã xóa, và những gì còn lại.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
withinCapBefore | boolean | có | Liệu những gì đang lưu giữ đã nằm dưới kích thước đó hay chưa, để không cần xóa gì. |
removed | CacheRemoval[] hoặc null | có | Những gì đã bị xóa. |
heldOpen | CacheRemoval[] hoặc null | có | Những gì việc thu hồi lẽ ra đã xóa nhưng để nguyên vì một tiến trình khác đang mở nó; thay vào đó nó chuyển sang mục cũ kế tiếp. Chỉ Windows từ chối xóa một tệp đang mở, nên ở mọi nơi khác mục này rỗng. Các mục này vẫn được tính vào số byte còn lại, và một lần thu hồi sau có thể xóa chúng. |
totalBefore | integer | có | Số byte được lưu giữ trước đó. |
totalBeforeText | string | có | Cùng con số đó, viết theo cách con người đọc. |
reclaimedBytes | integer | có | Số byte đã được thu hồi. |
reclaimedBytesText | string | có | Cùng con số đó, viết theo cách con người đọc. |
remainingBytes | integer | có | Số byte còn lại. |
remainingBytesText | string | có | Cùng con số đó, viết theo cách con người đọc. |
capBytes | integer | có | Kích thước đích của việc thu hồi, tính bằng byte. |
capBytesText | string | có | Cùng kích thước đó, viết theo cách con người đọc. |
scope | CacheScope | có | Phạm vi ảnh hưởng của một câu trả lời về bộ nhớ đệm. Hai trong số các lớp bộ nhớ đệm được dùng chung bởi mọi dự án trên máy, nên mọi câu trả lời về bộ nhớ đệm đều nêu rõ những lớp nào nó đã chạm tới — nếu không, một phiên mở trên một workspace sẽ bị hiểu là chỉ báo cáo về workspace đó. |
Không cho phép thuộc tính bổ sung.
CacheClearResult
Những gì việc làm trống các bộ nhớ đệm đã thu hồi.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
cleared | CacheCleared[] hoặc null | có | Từng bộ nhớ đệm đã được làm trống. |
reclaimedBytes | integer | có | Số byte đã được thu hồi. |
reclaimedBytesText | string | có | Cùng con số đó, viết theo cách con người đọc. |
scope | CacheScope | có | Phạm vi ảnh hưởng của một câu trả lời về bộ nhớ đệm. Hai trong số các lớp bộ nhớ đệm được dùng chung bởi mọi dự án trên máy, nên mọi câu trả lời về bộ nhớ đệm đều nêu rõ những lớp nào nó đã chạm tới — nếu không, một phiên mở trên một workspace sẽ bị hiểu là chỉ báo cáo về workspace đó. |
Không cho phép thuộc tính bổ sung.
RegistryListResult
Các registry mà workspace này phân giải qua.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
registries | Registry[] hoặc null | có | Từng registry đã được cấu hình. |
credentialStateIsMachineWide | boolean | có | Liệu sự hiện diện của thông tin xác thực được báo cáo cho mỗi registry có phải là một thực tế trên toàn máy thay vì của một workspace hay không. Nó được báo cáo để một câu trả lời trong phạm vi phiên không bị hiểu là phủ nhận phạm vi rộng hơn. |
Không cho phép thuộc tính bổ sung.
SearchResult
Những gì các chỉ mục registry cục bộ cung cấp cho lần tìm kiếm.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
records | RegistrySearchRecord[] hoặc null | có | Các bản ghi khớp. |
indexes | RegistrySearchIndex[] hoặc null | có | Từng host đã được tìm kiếm và thời điểm chỉ mục của nó được làm mới lần cuối. |
missingIndexHosts | string[] hoặc null | có | Các host đã cấu hình nhưng không có chỉ mục cục bộ để tìm kiếm, để một câu trả lời ngắn được giải thích thay vì phải tự suy ra. |
stale | boolean | có | Liệu có chỉ mục nào đã tìm kiếm đủ cũ để nên làm mới hay không. |
registriesConfigured | boolean | có | Liệu có registry nào được cấu hình hay không, điều này phân biệt “không có gì khớp” với “không có gì được tìm kiếm”. |
Không cho phép thuộc tính bổ sung.
RegistryAddResult
Những gì việc đăng ký một registry đã ghi, ghi ở đâu, và những gì nó đọc được từ chính registry đó.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
host | string | có | Host mà mục được lưu theo khóa đó, không phải lúc nào cũng là cách viết mà yêu cầu đã dùng. |
scope | ConfigWriteScope | có | Tài liệu cấu hình nào đã được ghi và phạm vi ảnh hưởng của nó. Một yêu cầu chỉ định một workspace, nên một câu trả lời không nói gì sẽ bị hiểu là về workspace đó — và với một lần ghi trên toàn máy, cách hiểu đó là sai. |
trust | TrustFetchOutcome | có | Kết quả của việc đọc chính sách tin cậy mà một registry công bố. Các kết quả được tách riêng vì chúng mang ý nghĩa khác nhau: chính sách được công bố đã được áp dụng, registry không công bố gì — điều này không phải là lỗi — đường cơ sở tích hợp sẵn đã được ghim thay thế, hoặc không có lần đọc nào được thực hiện. Khi không có gì được công bố, việc registry có thể truy cập được hay không sẽ được nêu kèm theo. |
Không cho phép thuộc tính bổ sung.
RegistryRemoveResult
Những gì việc xóa một registry đã ghi, và ghi ở đâu.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
host | string | có | Host có mục đã bị xóa. |
scope | ConfigWriteScope | có | Tài liệu cấu hình nào đã được ghi và phạm vi ảnh hưởng của nó. Một yêu cầu chỉ định một workspace, nên một câu trả lời không nói gì sẽ bị hiểu là về workspace đó — và với một lần ghi trên toàn máy, cách hiểu đó là sai. |
Không cho phép thuộc tính bổ sung.
RegistryUpdateResult
Những gì việc làm mới các chỉ mục cục bộ đã làm, theo từng host.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
hosts | HostUpdate[] hoặc null | có | Những gì lần làm mới đã làm cho mỗi host. |
failed | string[] hoặc null | có | Các host mà lần làm mới không thể hoàn tất. |
indexRoot | string | có | Thư mục mà các chỉ mục được ghi vào. |
registriesConfigured | boolean | có | Liệu có registry nào được cấu hình hay không. |
reachedRegistries | boolean | có | Luôn là true trên câu trả lời này: việc làm mới các chỉ mục đi ra tới chính các registry, trong khi việc liệt kê và tìm kiếm trả lời từ cấu hình và từ một chỉ mục cục bộ. Liệu một registry cụ thể có thực sự được tiếp cận hay không được nêu trên chính mục của nó trong hosts, bằng unreachable. |
Không cho phép thuộc tính bổ sung.
LogoutResult
Thông tin xác thực đã lưu nào đã bị xóa, và kho lưu trữ có phạm vi rộng đến đâu.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
registry | string | có | Registry có thông tin xác thực đã bị xóa. |
scope | CredentialStoreScope | có | Phạm vi ảnh hưởng của một thay đổi thông tin xác thực. Kho lưu trữ được dùng chung bởi mọi dự án trên máy và bởi mọi công cụ khác làm việc với cùng các registry, nên câu trả lời báo cáo điều đó thay vì để người đọc tự suy ra rằng nó chỉ giới hạn trong phiên. |
Không cho phép thuộc tính bổ sung.
PublishEntityResult
Những gì việc phát hành một thực thể đã tạo ra, và ở đâu. Một lần phát hành đã chạy bước pin trước cũng mang theo những gì bước đó đã làm, dưới dạng pin, vốn vắng mặt khi bước đó không chạy.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
reference | string | có | Tham chiếu mà thực thể được phát hành dưới đó. |
tag | string | có | Thẻ mà nó được phát hành dưới đó. |
kind | string | có | Loại thực thể đã được phát hành. |
mediaType | string | có | Loại phương tiện được ghi nhận cho các byte đã phát hành. |
size | integer | có | Số byte đã được phát hành. |
sizeText | string | có | Cùng kích thước đó, viết theo cách con người đọc. |
pluginSize | integer | không | Số byte mà module plugin được phát hành cùng một thực thể Plugin chiếm. |
pluginSizeText | string | không | Cùng kích thước đó, viết theo cách con người đọc. |
digest | string | có | Digest của những gì đã được phát hành. Khi chạy thử, đó là digest mà một lần phát hành cùng nội dung sẽ tạo ra, được tính chỉ từ nội dung: digest mà aggrega push --dry-run in ra. |
signed | boolean | có | Lần phát hành này có đính kèm chữ ký hay không: chữ ký nó tạo trước khi phát hành, hoặc, với một phiên bản đã được phát hành, chữ ký mà phiên bản đó còn thiếu. |
alreadyPublished | boolean | có | Các byte giống hệt đã có sẵn ở đó hay chưa, khi đó không có nội dung nào được tải lên. Chỉ những gì lần phát hành đó còn thiếu mới được đính kèm bên cạnh: ngày phát hành của nó và, khi lần phát hành này ký, chữ ký của nó; signed cho biết có chữ ký được đính kèm hay không. |
dryRun | boolean | có | Kết quả này báo cáo những gì việc phát hành lẽ ra sẽ tạo ra thay vì những gì nó đã làm hay không. |
reach | PublicationReach | có | Phạm vi mà một lần xuất bản đã vươn tới. Các câu trả lời này vươn ra hoàn toàn ngoài máy này — những gì chúng gắn vào chính là những gì mọi bên sử dụng registry đó phân giải — nên mỗi câu trả lời nêu tên mọi registry mà nó đã gửi tới và liệu lệnh gọi có gắn gì vào đó hay không. |
pin | PinResult | không | Những gì bước ghim đã làm với tệp khóa bên cạnh một thực thể, hoặc sẽ làm trong một lần chạy thử. Đây là câu trả lời cho aggrega/pin, và một lần công bố đã chạy bước này mang nó dưới dạng pin của mình. |
wholeDirectorySource | string | không | Nguồn cục bộ của thực thể như khi được soạn, có mặt khi nó được viết dưới dạng template. Một nguồn như vậy chỉ xác định thư mục của nó khi một Release điền vào template, nên lần phát hành mang theo mọi tệp trong thư mục của thực thể thay vì chỉ các tệp mà thực thể nêu tên. Vắng mặt khi nó chỉ mang theo các tệp đó. |
windowsUnusableEntries | string[] | không | Các mục của kho lưu trữ đã phát hành có đường dẫn chứa một phần mà Windows không thể lưu như đã viết — một tên Windows dành riêng cho thiết bị, chẳng hạn CON, AUX hoặc NUL, với bất kỳ kiểu chữ hoa thường nào và bất kể phần mở rộng theo sau, hoặc một phần kết thúc bằng dấu chấm hay dấu cách — tên tệp của chính tài liệu thực thể trước, sau đó là các tệp nó mang theo. Một workspace trên Windows từ chối giải nén chúng, nên không thể dùng phiên bản đó; lần phát hành vẫn tiếp tục hoặc dừng lại đúng như khi không có chúng. Vắng mặt khi không có mục nào, kể cả với một thực thể được phát hành chỉ gồm tài liệu của nó. |
Không cho phép thuộc tính bổ sung.
PublishArtifactResult
Những gì việc phát hành một tệp đã tạo ra, và ở đâu.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
reference | string | có | Tham chiếu mà tệp được phát hành dưới đó. |
tag | string | có | Thẻ mà nó được phát hành dưới đó. |
mediaType | string | có | Loại phương tiện được ghi nhận cho các byte đã phát hành. |
size | integer | có | Số byte đã được phát hành. |
sizeText | string | có | Cùng kích thước đó, viết theo cách con người đọc. |
digest | string | có | Digest của những gì đã được phát hành. |
alreadyPublished | boolean | có | Các byte giống hệt đã có sẵn ở đó hay chưa, khi đó không có nội dung nào được tải lên. Ngày phát hành chỉ được đính kèm bên cạnh khi artifact còn thiếu nó. |
dryRun | boolean | có | Kết quả này báo cáo những gì việc phát hành lẽ ra sẽ tạo ra thay vì những gì nó đã làm hay không. |
reach | PublicationReach | có | Phạm vi mà một lần xuất bản đã vươn tới. Các câu trả lời này vươn ra hoàn toàn ngoài máy này — những gì chúng gắn vào chính là những gì mọi bên sử dụng registry đó phân giải — nên mỗi câu trả lời nêu tên mọi registry mà nó đã gửi tới và liệu lệnh gọi có gắn gì vào đó hay không. |
Không cho phép thuộc tính bổ sung.
SignArtifactsResult
Những gì đã được ký, và các chữ ký được đặt ở đâu.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
signed | SignedArtifact[] hoặc null | có | Mỗi tham chiếu đã được ký. |
reach | PublicationReach | có | Phạm vi mà một lần xuất bản đã vươn tới. Các câu trả lời này vươn ra hoàn toàn ngoài máy này — những gì chúng gắn vào chính là những gì mọi bên sử dụng registry đó phân giải — nên mỗi câu trả lời nêu tên mọi registry mà nó đã gửi tới và liệu lệnh gọi có gắn gì vào đó hay không. |
Không cho phép thuộc tính bổ sung.
DeprecateArtifactResult
Những gì đã được đánh dấu ngừng hỗ trợ, và các dấu được đặt ở đâu.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
marked | DeprecationMarked[] hoặc null | có | Mỗi phiên bản đã được đánh dấu. |
reach | PublicationReach | có | Phạm vi mà một lần xuất bản đã vươn tới. Các câu trả lời này vươn ra hoàn toàn ngoài máy này — những gì chúng gắn vào chính là những gì mọi bên sử dụng registry đó phân giải — nên mỗi câu trả lời nêu tên mọi registry mà nó đã gửi tới và liệu lệnh gọi có gắn gì vào đó hay không. |
Không cho phép thuộc tính bổ sung.
ResolveResult
Nơi định nghĩa thứ nằm dưới con trỏ.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
location | null hoặc Location | có | Nơi nó được định nghĩa. Giá trị là null khi không có gì dưới con trỏ phân giải được tới một định nghĩa. |
Không cho phép thuộc tính bổ sung.
FindReferencesResult
Những nơi tham chiếu tới thứ nằm dưới con trỏ.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
locations | Location[] hoặc null | có | Mỗi nơi tham chiếu tới nó. |
Không cho phép thuộc tính bổ sung.
FindImplementationsResult
Những tài liệu nào triển khai thứ nằm dưới con trỏ.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
locations | Location[] hoặc null | có | Mỗi nơi nó được triển khai. |
Không cho phép thuộc tính bổ sung.
HoverResult
Những gì cần hiển thị về thứ nằm dưới con trỏ.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
contents | null hoặc MarkupContent | có | Những gì cần hiển thị. Giá trị là null khi không có gì để nói về thứ nằm dưới con trỏ. |
Không cho phép thuộc tính bổ sung.
CompletionResult
Những gì có thể được viết tại con trỏ.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
items | CompletionItem[] hoặc null | có | Mỗi thứ có thể được viết. |
Không cho phép thuộc tính bổ sung.
CatalogIndexResult
Mọi thực thể mà chỉ mục workspace chứa, cùng các liên kết dẫn ra ngoài workspace, tới thư mục và tới tệp, không được đọc cho chỉ mục đó.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
entities | CatalogEntity[] hoặc null | có | Từng thực thể. |
unreadLinkedDirs | string[] | có | Từng liên kết dưới thư mục gốc của workspace dẫn tới một thư mục bên ngoài nó, được đặt tên tương đối với thư mục gốc tại nơi chính liên kết nằm, theo thứ tự workspace được tìm kiếm. Không thư mục nào bên ngoài thư mục gốc được tìm kiếm, nên không tài liệu nào phía sau một trong các liên kết này nằm trong entities như của chính workspace, và một client liệt kê các thực thể có thể nói lý do. Không được nêu tên: liên kết tới một thư mục bên trong thư mục gốc, vốn được tìm kiếm, hoặc bị bỏ qua, tại nơi nó thực sự nằm; liên kết ở bất kỳ chỗ nào mà một thư mục sẽ bị bỏ qua, dù do vị trí, do tên hay do một .gitignore; liên kết không thể phân giải, vì nó không dẫn tới đâu hoặc tạo vòng lặp; và, trong một câu trả lời đưa ra theo các điều kiện của một Release, liên kết dưới một thư mục catalog mà chỉ các Releases khác đọc. Rỗng khi workspace không chứa liên kết nào như vậy. |
unreadLinkedFiles | string[] | có | Từng liên kết dưới thư mục gốc của workspace được đặt tên như một tệp YAML, tên của chính nó kết thúc bằng .yaml hoặc .yml, và dẫn tới một tệp bên ngoài thư mục gốc, được đặt tên tương đối với thư mục gốc tại nơi chính liên kết nằm, theo thứ tự workspace được tìm kiếm. Tệp như vậy không được đọc cho chỉ mục, dù nó khai báo gì, nên thực thể nó khai báo không nằm trong entities như của chính workspace, và một client liệt kê các thực thể có thể nói lý do; các thư mục catalog được cấu hình là cách đọc các thực thể bên ngoài workspace. Không được nêu tên: liên kết tới một tệp mà cấu hình workspace nêu tên là một Release, dưới dạng build.authoring_release hoặc một khóa của workspace.releases, và tệp đó khai báo một Release, vốn được đọc và liệt kê trong entities tại chính vị trí của liên kết; liên kết tới một tệp bên trong thư mục gốc, vốn được đọc tại chính vị trí của liên kết; liên kết bị một .gitignore bỏ qua, hoặc nằm trong một thư mục mà việc tìm kiếm bỏ qua; liên kết không dẫn tới tệp nào, dù dẫn tới một thư mục, mà unreadLinkedDirs nêu tên khi nó dẫn ra ngoài thư mục gốc, hay không dẫn tới đâu, hay tạo vòng lặp; và, trong một câu trả lời đưa ra theo các điều kiện của một Release, liên kết dưới một thư mục catalog mà chỉ các Releases khác đọc. Một tệp cấu hình workspace là liên kết dẫn ra ngoài workspace, tức .aggrega-config.yaml của chính nó hoặc lớp phủ do CI sở hữu bên cạnh nó, được nêu tên dù việc tìm kiếm có gặp nó hay không, sau các liên kết mà việc tìm kiếm nêu tên: khi đó cấu hình của workspace hoàn toàn không được đọc, câu trả lời này là chỉ mục riêng của workspace được đọc mà không có cấu hình nào, nên không thư mục catalog nào được đọc cho nó, và mọi yêu cầu mà cấu hình quyết định, kể cả một chỉ mục theo các điều kiện của một Release, đều bị từ chối cho workspace đó với điều kiện của việc giữ đọc. Rỗng khi workspace không chứa liên kết nào như vậy. |
Không cho phép thuộc tính bổ sung.
AttachCandidatesResult
Những Features nào có thể được gắn vào thực thể, và các nhãn mà chúng được đánh giá theo; và, với một kết nối mà yêu cầu nêu tên, các slot mà socket của nó khai báo cùng các Features có thể lấp đầy từng slot.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
node | string | có | Thực thể mà các ứng viên được đánh giá cho. |
nodeLabels | map of string hoặc null | có | Các nhãn mà việc đánh giá dựa theo. |
labelSource | string | có | Tập nhãn nào đã được dùng, điều này không chỉ mang tính hình thức: các nhãn được khai báo của một tài liệu là những gì việc đọc mã nguồn có thể thấy, còn nhãn của một nút đồ thị là tập đã hoàn tất mà chính bản build dùng để đánh giá. Một câu trả lời được tính trên tập thứ hai là một khẳng định về những gì bản build sẽ làm. |
candidates | SourcedEntityRef[] hoặc null | có | Từng Feature có thể được gắn. |
slots | SlotCandidacy[] | không | Chỉ có mặt khi yêu cầu nêu tên một kết nối: từng slot mà socket của kết nối khai báo, theo thứ tự Component khai báo chúng, cùng các Features có thể lấp đầy slot đó. Rỗng khi không slot nào có thể được lấp đầy trên kết nối, và khi đó noSlotReason cho biết lý do — điều mà một client đọc thay vì coi danh sách rỗng là các slot không có Feature nào khớp. |
noSlotReason | const “feature-created-connection” hoặc const “ad-hoc-socket” hoặc const “no-slot-declared” | không | Chỉ có mặt khi yêu cầu nêu tên một kết nối và không slot nào có thể được lấp đầy trên đó: lý do không gì có thể gắn vào đó. Vắng mặt ở bất cứ đâu socket khai báo một slot. Tập giá trị là đóng. Giá trị được phép: "feature-created-connection" — Một Feature đã vẽ kết nối, và một attachment chỉ được viết trên kết nối do một component hoặc Release vẽ. "ad-hoc-socket" — Socket không phải là socket mà Component khai báo, nên nó không khai báo slot nào để kết nối lấp đầy. "no-slot-declared" — Component khai báo socket nhưng không khai báo slot nào trên đó. |
Không cho phép thuộc tính bổ sung.
ConnectionCandidatesResult
Mỗi socket trên thực thể có thể được nối tới những thực thể nào.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
node | string | có | Thực thể sở hữu các socket này. |
adHocSocketsAccepted | boolean | có | Liệu một socket mà chính định nghĩa của thực thể không khai báo trước có vẫn được phép viết hay không. |
sockets | SocketCandidacy[] hoặc null | có | Từng socket và những gì có thể được nối vào nó. |
Không cho phép thuộc tính bổ sung.
InsertionPointResult
Vị trí trong tài liệu mà một mục mới dưới container được nêu tên thuộc về, và những gì một client cần để viết nó tại đó: chính vị trí đó, liệu văn bản có phải mở đầu bằng một dấu xuống dòng hay không, các khóa container vẫn còn thiếu, và mức thụt lề của mỗi dòng.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
file | string | có | Tài liệu. |
container | string[] hoặc null | có | Đường dẫn qua tài liệu tới container. |
positionEncoding | string | có | Bảng mã mà các vị trí trong câu trả lời này được biểu diễn theo. |
position | Position | có | Một vị trí trong tài liệu: một dòng và một độ lệch ký tự trong dòng đó, cả hai đếm từ không. Độ lệch được đo theo đơn vị của bảng mã mà phiên đã thống nhất khi được mở, là UTF-16 trừ khi client yêu cầu bảng mã khác. |
precededByLineBreak | boolean | có | Liệu văn bản được viết tại vị trí có phải bắt đầu bằng một dấu xuống dòng hay không, vì vị trí nằm ở cuối một dòng mà tài liệu đã có. Giá trị là false chỉ khi tài liệu không có gì để mục mới theo sau. |
missingContainerKeys | string[] hoặc null | có | Các phân đoạn của đường dẫn container mà tài liệu chưa có, phân đoạn ngoài cùng trước. Mỗi phân đoạn phải được viết thành một khóa riêng, thụt lề thêm một bậc so với khóa trước nó, trước khi mục có thể nằm bên trong khóa trong cùng. Giá trị là null khi toàn bộ đường dẫn đã có sẵn. |
entryIndent | integer | có | Cột mà dòng đầu tiên của chính mục bắt đầu, tính bằng số dấu cách từ đầu dòng. |
indentStep | integer | có | Mỗi cấp lồng nhau được thụt lề thêm bao nhiêu. |
indentStepMeasured | boolean | có | Liệu bước thụt lề có được đo từ cấu trúc lồng nhau của chính tài liệu này hay không. Khi giá trị là false, tài liệu không thể hiện cấu trúc lồng nhau nào để đo và bước thụt lề là giá trị dự phòng, nên một client muốn áp dụng bước của riêng mình biết rằng nó được tự do làm vậy. |
entryShape | const “mapping” hoặc const “sequence” hoặc const “unknown” | có | Dạng mà container chứa các mục của nó, điều quyết định cách văn bản của chính mục được soạn. Nó được đọc từ container mà tài liệu đã có và không bao giờ được suy ra từ tên của container. Tập giá trị là đóng. Giá trị được phép: "mapping" — Container là một block mapping, nên một mục được thêm vào là một khóa và giá trị của nó. "sequence" — Container là một block sequence, nên một mục được thêm vào là một dấu gạch ngang và giá trị của nó. "unknown" — Tài liệu không có container, hoặc có nhưng container rỗng, nên việc mục mang dạng nào là do client quyết định. |
Không cho phép thuộc tính bổ sung.
AttachmentContainerResult
Tài liệu nào, và vị trí nào trong đó, mà một attachment trên nút đồ thị, hoặc trên kết nối mà yêu cầu nêu tên, thuộc về.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
node | string | có | Nút đồ thị mà attachment dành cho. |
file | string | có | Tài liệu mà attachment thuộc về. |
container | string[] hoặc null | có | Đường dẫn qua tài liệu đó tới vị trí mà nó thuộc về. |
Không cho phép thuộc tính bổ sung.
ConnectionAtPositionResult
Kết nối có mục chứa vị trí, hoặc lý do không kết nối nào được báo cáo. Chính xác một nửa có mặt: graphNode và connection cùng nhau, hoặc chỉ noConnectionReason. Một vị trí ở bất kỳ đâu bên trong một mục — trên alias, target hay các attachment của nó — là nằm trong mục đó, mục trong cùng khi các mục lồng nhau; một vị trí trên chính khóa của một socket, phía trên các mục được viết dưới nó, không nằm trong mục nào.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
graphNode | string | không | id của nút có component vẽ kết nối, theo cách đồ thị đã biên dịch dùng làm khóa — giá trị mà các yêu cầu candidacy và container nhận làm graphNode. |
connection | ConnectionCoordinate | không | Kết nối, theo socket và alias của nó, với document nêu tên tài liệu mà vị trí được đọc trong đó — giá trị mà các yêu cầu candidacy và container nhận làm connection. |
noConnectionReason | const “no-connection-entry” hoặc const “feature-created-connection” hoặc const “unknown-connection” | không | Chỉ có mặt khi không có kết nối nào được báo cáo: lý do. Tập giá trị là đóng. Giá trị được phép: "no-connection-entry" — Vị trí không nằm trên mục nào mà một attachment được viết vào: không phải mục mà một component dùng để vẽ kết nối, viết dưới bí danh của kết nối, cũng không phải mục theo cạnh trong Release. Một kết nối được viết dưới dạng danh sách đích, và một kết nối do chính khối của một Feature vẽ, không có mục như vậy. "feature-created-connection" — Vị trí nằm trên mục của Release cho một kết nối mà một Feature đã vẽ, và một attachment chỉ được viết trên kết nối do một component hoặc Release vẽ. "unknown-connection" — Vị trí nằm trên một mục mà Release viết cho một kết nối không có trong đồ thị đã biên dịch. |
Không cho phép thuộc tính bổ sung.
ReleaseCandidatesResult
Các Releases mà workspace chứa, cùng các liên kết dẫn ra ngoài workspace, tới thư mục và tới tệp, không được đọc cho chúng.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
releases | string[] hoặc null | có | Mỗi tài liệu Release. |
lockfiles | map của string | có | Lockfile của mỗi Release được liệt kê, với khóa là Release đúng như cách nó được liệt kê. Mỗi lockfile là tệp mà một lần pull ghi cho Release đó và một lần build đọc, nên client đọc vị trí của nó thay vì tự suy ra. Rỗng khi workspace không chứa Release nào. |
unreadLinkedDirs | string[] | có | Mỗi liên kết bên dưới gốc workspace dẫn tới một thư mục bên ngoài gốc, được đặt tên tương đối với gốc tại nơi chính liên kết đó nằm, theo thứ tự workspace được tìm kiếm. Không thư mục nào bên ngoài gốc được tìm kiếm, nên một Release chỉ đến được qua một trong các liên kết này sẽ không có trong releases, và client đề xuất các Releases có thể giải thích lý do. Không được nêu: liên kết tới một thư mục bên trong gốc, vốn được tìm kiếm hoặc bỏ qua tại nơi nó thực sự nằm; liên kết ở bất kỳ chỗ nào mà một thư mục sẽ bị bỏ qua, dù do vị trí hay do tên của nó; và liên kết không thể phân giải, vì nó không dẫn tới đâu hoặc tạo thành vòng lặp. Rỗng khi workspace không chứa liên kết nào như vậy. |
unreadLinkedFiles | string[] | có | Mỗi liên kết bên dưới gốc workspace được đặt tên như một tệp YAML, tức tên của chính nó kết thúc bằng .yaml hoặc .yml, và dẫn tới một tệp bên ngoài gốc, được đặt tên tương đối với gốc tại nơi chính liên kết đó nằm, theo thứ tự workspace được tìm kiếm. Tệp như vậy không được đọc, nên một Release chỉ đến được qua một trong các liên kết này sẽ không có trong releases, và client đề xuất các Releases có thể giải thích lý do. Không đọc tệp thì không biết được nó có phải là một Release hay không, nên mỗi liên kết như vậy đều được nêu, bất kể tệp chứa gì. Không được nêu: liên kết tới một tệp mà cấu hình workspace nêu là một Release, dưới dạng build.authoring_release hoặc một khóa của workspace.releases, vốn được đọc và liệt kê trong releases tại chính vị trí của liên kết; liên kết tới một tệp bên trong gốc, vốn được đọc; liên kết nằm trong một thư mục mà quá trình tìm kiếm bỏ qua; và liên kết không dẫn tới tệp nào, dù là tới một thư mục, mà unreadLinkedDirs nêu khi nó dẫn ra ngoài gốc, hoặc không tới đâu, hoặc tạo thành vòng lặp. Một tệp cấu hình workspace là liên kết dẫn ra ngoài workspace, tức .aggrega-config.yaml của chính nó hoặc lớp phủ do CI sở hữu nằm cạnh nó, được nêu dù quá trình tìm kiếm có gặp nó hay không, sau các liên kết mà quá trình tìm kiếm đã nêu: khi đó cấu hình của workspace hoàn toàn không được đọc, câu trả lời này được đọc mà không có cấu hình nào, nên không Release nào mà cấu hình nêu qua một liên kết được liệt kê, và mọi yêu cầu do cấu hình quyết định đều bị từ chối cho workspace đó với điều kiện của lần giữ đọc. Rỗng khi workspace không chứa liên kết nào như vậy. |
Không cho phép thuộc tính bổ sung.
ActiveReleaseResult
Release mà client nên thao tác theo mặc định. Một workspace không trỏ tới Release nào là trạng thái bình thường chứ không phải lỗi, nên nó được báo cáo ở đây kèm mô tả cách lựa chọn đã được thử, thay vì được nêu thành một lỗi.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
release | string | có | Release đã được chọn, hoặc rỗng nếu không có Release nào được chọn. |
lockfile | string | không | Lockfile của Release đã được chọn: tệp mà một lần pull ghi cho nó và một lần build đọc. Không có khi không Release nào được chọn. |
reason | string | không | Lý do không Release nào được chọn. |
trace | string | không | Mỗi bước của việc lựa chọn và kết quả nó tìm thấy, để bên gọi có thể thấy bước nào lẽ ra đã quyết định được. |
Không cho phép thuộc tính bổ sung.
EditDocumentResult
Nội dung mà thao tác chỉnh sửa đã ghi, và ghi ở đâu. Sau một lần ghi, bản đọc tài liệu của daemon bị loại bỏ, nên câu trả lời tiếp theo về tài liệu đó được tính từ các byte mà thao tác chỉnh sửa tạo ra.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
file | string | có | Tài liệu đã được chỉnh sửa. |
edit | string | có | Thao tác chỉnh sửa nào đã được áp dụng. |
container | string[] hoặc null | có | Đường dẫn qua tài liệu tới nơi thao tác chỉnh sửa được đặt vào. |
createdContainers | string[] hoặc null | có | Các container mà thao tác chỉnh sửa phải tạo trên đường đi. |
written | string[] hoặc null | có | Các tài liệu đã được ghi. |
content | string | có | Tài liệu đã được soạn, dành cho yêu cầu muốn được xem kết quả thay vì ghi nó. |
Không cho phép thuộc tính bổ sung.
EffectiveConfigurationResult
Cấu hình mà workspace đã phân giải, và mỗi thiết lập đến từ tài liệu nào.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
layers | string[] hoặc null | có | Các tài liệu cấu hình đã được hợp nhất, theo thứ tự hợp nhất. |
settings | EffectiveConfigurationSetting[] hoặc null | có | Mỗi thiết lập đã phân giải và nguồn gốc của nó. |
Không cho phép thuộc tính bổ sung.
ConfigInitResult
Nội dung mà việc khởi tạo cấu hình đã ghi, ghi ở đâu, và những gì nó đọc từ registry.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
host | string | có | Registry mà cấu hình được khởi tạo cho. |
scope | ConfigWriteScope | có | Tài liệu cấu hình nào đã được ghi và phạm vi ảnh hưởng của nó. Một yêu cầu chỉ định một workspace, nên một câu trả lời không nói gì sẽ bị hiểu là về workspace đó — và với một lần ghi trên toàn máy, cách hiểu đó là sai. |
trust | TrustFetchOutcome | có | Kết quả của việc đọc chính sách tin cậy mà một registry công bố. Các kết quả được tách riêng vì chúng mang ý nghĩa khác nhau: chính sách được công bố đã được áp dụng, registry không công bố gì — điều này không phải là lỗi — đường cơ sở tích hợp sẵn đã được ghim thay thế, hoặc không có lần đọc nào được thực hiện. Khi không có gì được công bố, việc registry có thể truy cập được hay không sẽ được nêu kèm theo. |
written | boolean | có | Tài liệu đã được ghi hay được trả lại để bên gọi tự đặt. |
existed | boolean | không | Có mặt và là true khi tài liệu đã tồn tại, nên mục registry được hợp nhất vào đó thay vì tạo tài liệu mới. Chỉ yêu cầu gửi force mới tiếp tục trên một tài liệu hiện có, nên trường này không có trong mọi câu trả lời cho yêu cầu không gửi force. |
content | string | không | Văn bản của tài liệu, dành cho yêu cầu muốn được xem nó thay vì ghi nó. |
Không cho phép thuộc tính bổ sung.
ConfigCaptureResult
Nội dung mà việc cố định cấu hình đã phân giải đã ghi vào tài liệu riêng của workspace này.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
configFile | string | có | Tài liệu đã được ghi. Đó luôn là tài liệu riêng của workspace này, vì mục đích duy nhất là làm cho một workspace tự chứa đầy đủ. |
workspaceRoot | string | có | Workspace mà yêu cầu đã chỉ định. |
captured | boolean | có | Có gì được cố định hay không. |
sockets | ConfigCapturedSocket[] hoặc null | có | Mỗi socket đã được cố định, cùng các attachment của nó. |
catalogDirs | string[] hoặc null | có | Các thư mục catalog đã được cố định. |
Không cho phép thuộc tính bổ sung.
ImportResult
Kết quả của việc chuyển đổi một nguồn bên ngoài, và những gì không chuyển đổi được.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
format | string | có | Định dạng nguồn đã được chuyển đổi. |
outputDir | string | có | Thư mục mà mọi đường dẫn trong câu trả lời tương đối với nó, cũng là thư mục các tệp được ghi vào. |
written | string[] hoặc null | có | Mỗi tệp đã được ghi xuống đĩa, theo thứ tự ghi: các bản nháp, rồi bản ghi về những gì lần import đã ghi. Với sync, chỉ các bản nháp mà sync thay đổi và bản ghi nếu nó thay đổi. Rỗng với dryRun. |
files | ImportedFile[] hoặc null | có | Mỗi tệp mà yêu cầu ghi, kèm văn bản của nó, dù có dryRun hay không: mọi bản nháp, rồi bản ghi về những gì lần import đã ghi. Với sync, mỗi bản nháp mà sync thay đổi, kèm văn bản mới, rồi bản ghi nếu nó cũng thay đổi, nên một sync đã đồng bộ sẽ trả về danh sách rỗng. |
drift | ImportDrift[] | có | Mỗi phần mà một sync đã cập nhật theo nguồn, hoặc sẽ cập nhật với dryRun, theo thứ tự bản nháp nêu chúng; một tệp nháp mà sync xóa cũng là một trong số đó, bị xóa mà không có khóa nào. Danh sách rỗng với yêu cầu không phải sync, với sync đã đồng bộ, và với sync có quá trình chuyển đổi bị dừng, vốn không ghi gì. |
diagnostics | ImportDiagnostic[] hoặc null | có | Thứ không thể chuyển đổi. |
decisions | ImportDecision[] | có | Cách importer ánh xạ từng nút nguồn, theo thứ tự của importer và đúng như nó báo cáo: đây là thứ cho bạn biết quá trình chuyển đổi đã phỏng đoán ở đâu. Có mặt với cả hai cách phân phối và dù quá trình chuyển đổi có dừng hay không, và là danh sách rỗng với importer không báo cáo gì. |
owed | ImportOwed[] | không | Mỗi giá trị mà các bản nháp vẫn để trống, không nguồn nào có thể cung cấp và không câu trả lời nào đã cung cấp, theo thứ tự các bản nháp được ghi — các giá trị mà những phát hiện mức cảnh báo nêu tên. Mọi phản hồi đều mang trường này, là một danh sách rỗng khi các bản nháp không còn thiếu gì. |
halted | boolean | có | Quá trình chuyển đổi đã dừng hay đã hoàn tất kèm các phát hiện. |
Không cho phép thuộc tính bổ sung.
ScaffoldEntityResult
Tài liệu khởi đầu đã soạn nháp, danh sách các ví dụ có thể chạy được, hoặc ví dụ đã được ghi — mỗi dạng trả lời bằng các trường của riêng nó và để vắng các trường còn lại.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
kind | string | không | Loại thực thể đã được soạn nháp. Có mặt khi soạn nháp. |
skeleton | string | không | Văn bản của tài liệu đã soạn nháp. Có mặt khi soạn nháp. |
examples | ScaffoldExample[] | không | Mọi ví dụ có thể chạy được mà tài liệu công bố, mỗi ví dụ một lần, theo thứ tự tên. Có mặt trong một lần liệt kê có tìm thấy ví dụ nào đó. |
example | string | không | Ví dụ đã được ghi. Có mặt khi ghi. |
dir | string | không | Thư mục mà ví dụ đã được ghi vào, tương đối với thư mục gốc của workspace, theo tên mà yêu cầu đặt hoặc, nếu yêu cầu không đặt tên, theo tên của ví dụ. Có mặt khi ghi. |
files | string[] | không | Mỗi tệp đã được ghi, tương đối với dir và phân tách bằng dấu gạch chéo, theo thứ tự mà tài liệu chứa chúng. Có mặt khi ghi. |
next | string[] | không | Các lệnh mà trang của ví dụ đưa ra để build nó, từng dòng đúng như trang viết, kể cả chú thích: khối shell đầu tiên dưới tiêu đề Build của trang. Vắng mặt nếu trang không đưa ra lệnh nào. |
version | string | không | Phiên bản tài liệu mà ví dụ được đọc từ đó: phiên bản của chính tệp nhị phân nếu có tài liệu được công bố cho nó, nếu không thì phiên bản mới nhất được công bố trước nó. Có mặt khi ghi. |
Không cho phép thuộc tính bổ sung.
ScaffoldExample
Một ví dụ có thể chạy được mà tài liệu công bố.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
name | string | có | Tên của ví dụ, được yêu cầu gửi dưới dạng example để ghi ví dụ đó. |
level | string | có | Cấp độ mà trang của ví dụ khai báo cho nó. |
summary | string | có | Câu đầu tiên của trang ví dụ. |
Không cho phép thuộc tính bổ sung.
LintResult
Những gì lần kiểm tra quy ước tìm thấy, được đếm theo mức độ nghiêm trọng và liệt kê theo từng tài liệu. Một lần kiểm tra toàn bộ catalog chạy một lần cho mỗi Release cũng mang theo passes; khi đó các số đếm và files bao gồm tất cả các lượt cộng lại.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
entity | string | không | Thực thể duy nhất đã được kiểm tra, khi yêu cầu nêu tên một thực thể. |
release | string | không | Release có closure đã được kiểm tra, khi yêu cầu nêu tên một Release. |
checked | integer | có | Số tài liệu đã được kiểm tra. Khi lần kiểm tra chạy một lần cho mỗi Release, đây là tổng qua các lượt: một tài liệu được hai lượt đọc sẽ được đếm trong mỗi lượt. |
findings | integer | có | Tổng số phát hiện. |
errors | integer | có | Số phát hiện là lỗi. |
warnings | integer | có | Số phát hiện là cảnh báo. |
infos | integer | có | Số phát hiện mang tính thông tin. |
files | LintFileFindings[] hoặc null | có | Các phát hiện, theo từng tài liệu. |
halted | boolean | có | Lần kiểm tra có dừng lại thay vì hoàn tất với các phát hiện hay không. |
passes | LintPass[] hoặc null | không | Lần kiểm tra toàn bộ catalog theo từng lượt, chỉ có mặt khi nó chạy một lần cho mỗi Release vì workspace nêu tên các Releases dưới workspace.releases. Mỗi lượt cho biết các phát hiện của nó được tìm thấy cho những Releases nào. Vắng mặt đối với workspace không nêu tên Release nào, vốn được kiểm tra một lần trên các thư mục của chính nó, và đối với lần kiểm tra một thực thể hoặc closure của một Release. |
Không cho phép thuộc tính bổ sung.
LintPass
Một lượt của lần kiểm tra quy ước toàn bộ catalog trong một workspace cấp cho các Releases của nó những thư mục catalog riêng: các Releases mà lượt này được chạy cho, các thư mục nó đã đọc, và những gì nó tìm thấy ở đó.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
releases | string[] hoặc null | có | Các Releases mà lượt này được chạy cho, mỗi Release là một đường dẫn tương đối so với gốc workspace. Các Releases đọc cùng các thư mục catalog dùng chung một lượt. |
catalogDirs | string[] hoặc null | có | Các thư mục catalog mà lượt này đã đọc, theo thứ tự chúng được tìm kiếm, mỗi thư mục tương đối so với gốc workspace khi nó nằm bên trong gốc. Rỗng khi các Releases của lượt không đọc thư mục catalog nào, nên lượt này không kiểm tra gì và không làm thất bại lượt nào khác. |
checked | integer | có | Số tài liệu mà lượt này đã kiểm tra. |
findings | integer | có | Số phát hiện mà lượt này tìm thấy. |
errors | integer | có | Số phát hiện là lỗi. |
warnings | integer | có | Số phát hiện là cảnh báo. |
infos | integer | có | Số phát hiện mang tính thông tin. |
files | LintFileFindings[] hoặc null | có | Các phát hiện của lượt, theo từng tài liệu. |
Không cho phép thuộc tính bổ sung.
PluginAddResult
Những gì việc gắn một plugin đã ghi, ghi ở đâu, và phiên bản nào đã được ghim.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
type | string | có | Socket mà plugin được gắn vào. |
identity | string | không | Định danh mà attachment được phân giải thành. |
uri | string | không | Tham chiếu mà attachment được phân giải từ đó. |
capability | string | không | Capability mà attachment phục vụ. |
reference | string | không | Tham chiếu đã ghim, bao gồm cả phiên bản. |
scope | PluginWriteScope | có | Một thay đổi plugin đã được ghi vào tài liệu cấu hình nào và phạm vi ảnh hưởng của nó. Mặc định của chính socket command-extension là tài liệu trên toàn máy, nên mọi câu trả lời đều nêu rõ nó đã ghi vào tài liệu nào. |
written | boolean | có | Tài liệu cấu hình đã được ghi hay được trả lại để bên gọi tự đặt. |
content | string | không | Văn bản của tài liệu cấu hình, dành cho yêu cầu muốn được xem nó thay vì ghi nó. |
retraction | PluginRetraction | không | Cách một dấu deprecation đã định hình phiên bản plugin nào được ghim. |
withdrawn | boolean | không | Là true khi truy vấn đã nêu tên phiên bản được ghim và một tuyên bố thu hồi được workspace này tin cậy đã thu hồi phiên bản đó. Một phiên bản được nêu tên vẫn được ghim như thường, vì việc nêu tên nó chính là sự ghi đè. Vắng mặt trong các trường hợp khác, và sự vắng mặt không có nghĩa là phiên bản không bị thu hồi: khi không thể đọc được các dấu thu hồi của một phiên bản được nêu tên, retraction.unscreened cho biết lý do, và khi không nêu phiên bản nào, phiên bản được phát hành mới nhất sẽ được chọn và retraction báo cáo kết luận của việc kiểm tra thu hồi về lựa chọn đó. |
Không cho phép thuộc tính bổ sung.
PluginRemoveResult
Những gì việc tháo một plugin đã ghi, và ghi ở đâu.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
type | string | có | Socket mà plugin được gắn vào. |
query | string | có | Attachment nào đã bị gỡ bỏ. |
scope | PluginWriteScope | có | Một thay đổi plugin đã được ghi vào tài liệu cấu hình nào và phạm vi ảnh hưởng của nó. Mặc định của chính socket command-extension là tài liệu trên toàn máy, nên mọi câu trả lời đều nêu rõ nó đã ghi vào tài liệu nào. |
Không cho phép thuộc tính bổ sung.
PluginSyncResult
Những gì việc đồng bộ các bản ghi do máy quản lý của một thực thể Plugin với module của nó đã thay đổi.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
entity | string | có | Tài liệu thực thể Plugin đã được đồng bộ. |
hostFunctions | string[] hoặc null | có | Các host function mà module khai báo là cần. |
commands | PluginCLICommand[] hoặc null | có | Các lệnh mà module đóng góp. |
changed | boolean | có | Có gì trong tài liệu thực sự thay đổi hay không. |
Không cho phép thuộc tính bổ sung.
PluginGenCatalogResult
Các tài liệu catalog mà một lần sinh đã tạo ra.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
documents | PluginGeneratedDocument[] | không | Mỗi tài liệu được sinh ra và văn bản của nó. |
notices | string | không | Bất cứ điều gì lần sinh muốn bên gọi biết. |
dryRun | boolean | có | Các tài liệu được trả lại thay vì được ghi hay không. |
Không cho phép thuộc tính bổ sung.
ExplainErrorResult
Những gì trình biên dịch khai báo về một điều kiện, và các đoạn tài liệu đã xuất bản hướng dẫn cách sửa khi soạn thảo.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
shortCode | string | có | Mã ngắn của điều kiện. |
code | string | có | Tên mô tả của điều kiện. |
message | string | có | Nội dung điều kiện thông báo khi nó được phát sinh. |
entries | ExplainErrorEntry[] | không | Các đoạn tài liệu đã xuất bản hướng dẫn cách sửa. |
reference | string | có | Địa chỉ đã công bố nơi tình trạng được giải thích. |
note | string | không | Lý do các đoạn tài liệu đã xuất bản bị thiếu, khi không thể lấy được chúng. Những gì bản thân binary khai báo vẫn được trả lời. |
Không cho phép thuộc tính bổ sung.
GetSchemaResult
Schema của một kind, hoặc — khi yêu cầu không nêu tên kind nào — những kind nào có thể được nêu tên. Hai phạm vi đi chung một câu trả lời thay vì hai phương thức, vì “tôi có thể nêu tên những gì” và “trong số đó, tác giả viết tài liệu cho những cái nào” là cùng một câu hỏi ở hai phạm vi, và hai câu trả lời sẽ phải được giữ cho khớp nhau.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
kind | string | không | Kind mà schema dành cho. |
schema | any | không | Bản thân schema, được chuyển nguyên như binary lưu giữ. |
kinds | string[] | không | Mọi token mà binary này phản hồi. |
entityKinds | EntityKindDescriptor[] | không | Tập hẹp hơn mà tác giả viết tài liệu cho, mỗi mục ghép token mà một yêu cầu nêu tên với kind mà header của chính tài liệu khai báo. |
Không cho phép thuộc tính bổ sung.
SkillsInstallResult
Việc cài skill trợ lý đã ghi những gì, và ở đâu.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
skill | string | có | Skill đã được ghi. |
installed | SkillsInstalledFolder[] | có | Mỗi thư mục skill đã ghi, theo thứ tự mà yêu cầu nêu tên các trợ lý. Các trợ lý đọc chung một thư mục dùng chung một mục, vì skill được ghi vào đó một lần. |
scope | SkillFolderScope | có | Phạm vi mà một lần cài skill vươn tới. Một yêu cầu nêu tên một workspace, nên một câu trả lời không nói gì sẽ được hiểu là chỉ liên quan đến workspace đó — và với các thư mục theo người dùng, mà trợ lý đọc trong mọi dự án, cách hiểu đó là sai. |
Không cho phép thuộc tính bổ sung.
SkillsInstalledFolder
Một thư mục skill mà một lần cài đã ghi.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
agents | string[] | có | Định danh của các trợ lý được nêu tên đọc thư mục này, theo thứ tự mà yêu cầu nêu tên chúng. |
folder | string | có | Thư mục của skill, dưới dạng đường dẫn tuyệt đối. |
replaced | boolean | có | Liệu một bản sao mang dòng chú thích mà mọi bản sao đã ghi của skill đều mang — do một lần cài trước đó ghi, hoặc lấy từ kho skill đã xuất bản — đã có ở đó và đã được thay thế hay không. Một tệp ở đó không có dòng đó bị từ chối thay vì bị thay thế. |
Không cho phép thuộc tính bổ sung.
SkillsListResult
Các skill mà tệp nhị phân đi kèm và mọi trợ lý mà một lần cài có thể ghi chúng cho. Không ghi gì và không truy cập tới đâu.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
skills | SkillsListedSkill[] | có | Mỗi skill mà tệp nhị phân đi kèm, theo một thứ tự cố định. |
agents | SkillsListedAgent[] | có | Mỗi trợ lý mà một lần cài biết thư mục skill của nó, sắp xếp theo định danh. |
Không cho phép thuộc tính bổ sung.
SkillsListedSkill
Một skill mà tệp nhị phân đi kèm.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
name | string | có | Tên của skill, cũng là tên của thư mục mà một lần cài ghi. |
description | string | có | Khi nào một trợ lý dùng skill, theo như chính skill khai báo. |
Không cho phép thuộc tính bổ sung.
SkillsListedAgent
Một trợ lý mà một lần cài có thể ghi skill cho, cùng với hai thư mục mà nó đọc skill từ đó.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
id | string | có | Định danh mà một yêu cầu dùng để nêu tên trợ lý. |
name | string | có | Tên riêng của trợ lý. |
projectFolder | string | có | Thư mục, tương đối so với gốc của một dự án và phân tách bằng dấu gạch chéo, mà trợ lý đọc skill của dự án từ đó. Một lần cài cho dự án ghi thư mục của skill vào bên trong nó, trong workspace mà yêu cầu nêu tên. |
userFolder | string | có | Thư mục, tương đối so với thư mục home và phân tách bằng dấu gạch chéo, mà trợ lý đọc skill riêng của người dùng từ đó trong mọi dự án. Một lần cài có global ghi thư mục của skill vào bên trong nó. |
Không cho phép thuộc tính bổ sung.