Lewati ke konten
AggregaAggrega
Pilih Bahasa: Bahasa Indonesia
Halaman ini diterjemahkan oleh mesin. Baca versi asli dalam bahasa Inggris.

Skema protokol wire daemon latar belakang Aggrega

Referensi yang dihasilkan. Jangan diedit secara manual — hasilkan ulang dari JSON Schema yang dipublikasikan.

Id skema: https://aggrega.ai/schemas/serve-wire-v1beta1.schema.json

Bentuk-bentuk pesan yang dipertukarkan dengan daemon kompiler latar belakang yang dijalankan oleh aggrega serve. Klien membuka sesi pada daemon tersebut melalui handshake, dan sesi itulah yang menentukan cakupan pengaturan serta workspace tempat percakapan dibuka; daemon adalah proses yang menjawab permintaan, mengirim notifikasi, dan menyimpan apa yang telah dibacanya. Protokolnya adalah JSON-RPC 2.0 melalui input dan output standar, dengan setiap pesan dibingkai oleh header Content-Length; dokumen ini menjelaskan isi pesan, bukan pembingkaian maupun transportnya. Sebuah isi pesan adalah salah satu dari empat hal: permintaan yang dikirim klien, notifikasi yang dikirim klien, notifikasi yang dikirim daemon, atau respons yang dikembalikan daemon untuk suatu permintaan. Tiga sifat dari antarmuka ini menentukan cara penulisan bentuk-bentuk di bawah. Pertama, setiap permintaan menerima dua field di luar field yang dideklarasikan oleh metodenya sendiri — workspaceRoot, yang menyebutkan workspace yang menjadi sasaran permintaan, dan workDoneToken, nilai yang dibuat oleh pemanggil dan menjadi acuan pelaporan kemajuan — sehingga keduanya muncul pada setiap objek params permintaan di sini, termasuk tiga metode yang subjeknya bukan workspace: aggrega/getSchema dan aggrega/scaffoldEntity menerima workspaceRoot tetapi mengabaikannya, dan aggrega/initialize membacanya sebagai workspace yang dideklarasikan sesi. Kedua, daemon menolak objek params permintaan yang memuat field yang tidak diterima oleh metode tersebut, dengan menyebutkan field yang diterimanya, sehingga setiap objek params di sini tertutup pada tingkat teratasnya; objek bersarang di dalam permintaan tidak tertutup, karena pemeriksaan hanya membaca nama-nama field terluar. Ketiga, hasil disusun oleh daemon alih-alih disediakan oleh pemanggil, sehingga objek hasil tertutup pada setiap tingkat yang bentuknya tetap, dan hanya terbuka di tempat nilainya berupa JSON opak yang diteruskan daemon tanpa dibaca. Salah satu konsekuensi dari pengodean daemon terlihat pada wire dan dijelaskan alih-alih disembunyikan: koleksi yang tidak ditandai opsional oleh daemon dikeluarkan sebagai null ketika tidak ada nilai untuk dilaporkan dan sebagai koleksi kosong ketika nilai yang dilaporkannya kosong, sehingga kedua bentuk tersebut diterima di mana pun hal itu berlaku.

Salah satu dari bentuk berikut

  • Request
  • ClientNotification
  • DaemonNotification
  • SuccessResponse
  • ErrorResponse

Definisi

ProtocolVersion

Versi JSON-RPC yang dibawa setiap pesan. Hanya 2.0 yang digunakan.

Jenis: const "2.0"

Konstanta: "2.0"

RequestId

Pengenal yang diberikan pemanggil untuk sebuah permintaan, dipantulkan kembali pada respons yang menjawabnya. Pesan yang tidak membawa pengenal adalah notifikasi dan tidak pernah dijawab.

Jenis: string or number

ProgressToken

Nilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.

Jenis: string or number

WorkspaceRootSubject

Path absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.

Jenis: string

WorkspaceRootAccepted

Path absolut sebuah workspace. Subjek metode ini bukan workspace — metode ini menjawab dari apa yang dibawa oleh biner itu sendiri — sehingga field ini diterima tetapi tidak dibaca. Field ini diizinkan karena klien dapat mengirimkannya secara seragam pada setiap permintaan tanpa perlu mengetahui metode mana yang memakainya.

Jenis: string

RequestMethod

Setiap metode yang dapat disebut oleh sebuah permintaan. Himpunan ini tertutup: permintaan yang menyebut hal lain dijawab dengan galat method-not-found.

Jenis: string (enum)

Nilai yang diizinkan: "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

Setiap metode yang dapat disebut oleh notifikasi klien. Himpunan ini tertutup, dan tidak satu pun notifikasi dijawab.

Jenis: string (enum)

Nilai yang diizinkan: "$/cancelRequest", "aggrega/shutdown"

DaemonNotificationMethod

Setiap metode yang dapat disebut oleh notifikasi yang dikirim daemon. Himpunan ini tertutup.

Jenis: string (enum)

Nilai yang diizinkan: "$/progress", "aggrega/publishDiagnostics"

Request

Permintaan yang dikirim klien dan dijawab daemon. Metode menyebutkan apa yang diminta; objek params membawa field milik metode tersebut ditambah dua field yang diizinkan setiap metode. Permintaan yang sama sekali menghilangkan params dibaca sebagai permintaan yang semua field-nya tidak ada.

PropertiJenisWajibDeskripsi
jsonrpcProtocolVersionyaVersi JSON-RPC yang dibawa setiap pesan. Hanya 2.0 yang digunakan.
idRequestIdyaPengenal yang diberikan pemanggil untuk sebuah permintaan, dipantulkan kembali pada respons yang menjawabnya. Pesan yang tidak membawa pengenal adalah notifikasi dan tidak pernah dijawab.
methodRequestMethodyaSetiap metode yang dapat disebut oleh sebuah permintaan. Himpunan ini tertutup: permintaan yang menyebut hal lain dijawab dengan galat method-not-found.
paramsobjecttidak

Properti tambahan tidak diizinkan.

params untuk setiap method:

methodparamsWajib
"aggrega/initialize"InitializeParamstidak
"aggrega/validate"ValidateParamstidak
"aggrega/invalidate"InvalidateParamstidak
"aggrega/diagnostics"DiagnosticsParamstidak
"aggrega/irGraph"IrGraphParamstidak
"aggrega/build"BuildParamstidak
"aggrega/buildPreview"BuildPreviewParamstidak
"aggrega/entityDefinition"EntityDefinitionParamstidak
"aggrega/releaseClosure"ReleaseClosureParamstidak
"aggrega/resolveDependencies"ResolveDependenciesParamstidak
"aggrega/pin"PinParamstidak
"aggrega/cacheStatus"WorkspaceAndProgressParamstidak
"aggrega/cachePrune"WorkspaceAndProgressParamstidak
"aggrega/cacheEvict"CacheEvictParamstidak
"aggrega/cacheClear"WorkspaceAndProgressParamstidak
"aggrega/registryList"WorkspaceAndProgressParamstidak
"aggrega/search"SearchParamstidak
"aggrega/registryAdd"RegistryAddParamstidak
"aggrega/registryRemove"RegistryRemoveParamstidak
"aggrega/registryUpdate"RegistryUpdateParamstidak
"aggrega/logout"LogoutParamstidak
"aggrega/publishEntity"PublishEntityParamstidak
"aggrega/publishArtifact"PublishArtifactParamstidak
"aggrega/signArtifacts"SignArtifactsParamstidak
"aggrega/deprecateArtifact"DeprecateArtifactParamstidak
"aggrega/resolve"ResolveParamstidak
"aggrega/findReferences"FindReferencesParamstidak
"aggrega/findImplementations"FindImplementationsParamstidak
"aggrega/hover"HoverParamstidak
"aggrega/completion"CompletionParamstidak
"aggrega/catalogIndex"CatalogIndexParamstidak
"aggrega/attachCandidates"AttachCandidatesParamstidak
"aggrega/connectionCandidates"ConnectionCandidatesParamstidak
"aggrega/insertionPoint"InsertionPointParamstidak
"aggrega/attachmentContainer"AttachmentContainerParamstidak
"aggrega/connectionAtPosition"ConnectionAtPositionParamstidak
"aggrega/releaseCandidates"WorkspaceAndProgressParamstidak
"aggrega/activeRelease"WorkspaceAndProgressParamstidak
"aggrega/setActiveRelease"SetActiveReleaseParamstidak
"aggrega/editDocument"EditDocumentParamstidak
"aggrega/effectiveConfiguration"WorkspaceAndProgressParamstidak
"aggrega/configInit"ConfigInitParamstidak
"aggrega/configCapture"ConfigCaptureParamstidak
"aggrega/import"ImportParamstidak
"aggrega/scaffoldEntity"ScaffoldEntityParamstidak
"aggrega/lint"LintParamstidak
"aggrega/pluginAdd"PluginAddParamstidak
"aggrega/pluginRemove"PluginRemoveParamstidak
"aggrega/pluginSync"PluginSyncParamstidak
"aggrega/pluginGenCatalog"PluginGenCatalogParamstidak
"aggrega/explainError"ExplainErrorParamstidak
"aggrega/getSchema"GetSchemaParamstidak
"aggrega/skillsInstall"SkillsInstallParamstidak
"aggrega/skillsList"WorkspaceAndProgressParamstidak

ClientNotification

Notifikasi yang dikirim klien. Notifikasi ini tidak membawa pengenal dan tidak pernah dijawab.

PropertiJenisWajibDeskripsi
jsonrpcProtocolVersionyaVersi JSON-RPC yang dibawa setiap pesan. Hanya 2.0 yang digunakan.
methodClientNotificationMethodyaSetiap metode yang dapat disebut oleh notifikasi klien. Himpunan ini tertutup, dan tidak satu pun notifikasi dijawab.
paramsobjecttidak

Properti tambahan tidak diizinkan.

params untuk setiap method:

methodparamsWajib
"$/cancelRequest"CancelRequestParamsya
"aggrega/shutdown"ShutdownParamstidak

DaemonNotification

Notifikasi yang dikirim daemon. Notifikasi ini tidak membawa pengenal dan tidak pernah dijawab.

PropertiJenisWajibDeskripsi
jsonrpcProtocolVersionyaVersi JSON-RPC yang dibawa setiap pesan. Hanya 2.0 yang digunakan.
methodDaemonNotificationMethodyaSetiap metode yang dapat disebut oleh notifikasi yang dikirim daemon. Himpunan ini tertutup.
paramsobjectya

Properti tambahan tidak diizinkan.

params untuk setiap method:

methodparamsWajib
"$/progress"ProgressParamsya
"aggrega/publishDiagnostics"PublishDiagnosticsParamsya

CancelRequestParams

Meminta daemon membatalkan permintaan yang sedang berjalan, dengan menyebutnya melalui pengenal yang dibawa permintaan itu. Permintaan yang sudah selesai, atau tidak pernah dikirim, secara diam-diam dianggap tidak ada yang perlu dibatalkan.

PropertiJenisWajibDeskripsi
idRequestIdyaPengenal yang diberikan pemanggil untuk sebuah permintaan, dipantulkan kembali pada respons yang menjawabnya. Pesan yang tidak membawa pengenal adalah notifikasi dan tidak pernah dijawab.

Properti tambahan tidak diizinkan.

ShutdownParams

Meminta daemon berhenti menerima pekerjaan dan menyelesaikan pekerjaan yang sudah diterimanya. Notifikasi ini tidak membawa field, dan notifikasi itu sendiri biasanya dikirim tanpa objek params sama sekali. Notifikasi kedua membatalkan pekerjaan yang masih berjalan alih-alih menunggunya.

Objek ini tidak mendeklarasikan properti tetap dan tidak mengizinkan satu pun.

ProgressParams

Satu laporan pekerjaan yang sedang berlangsung, dikirim hanya untuk permintaan yang membuat token kemajuan dalam sesi yang mendeklarasikan bahwa sesi tersebut dapat menerimanya.

PropertiJenisWajibDeskripsi
tokenProgressTokenyaNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
valueProgressBegin atau ProgressReport atau ProgressEndyaLaporan itu sendiri. Satu laporan pembuka, lalu sejumlah baris berapa pun, lalu satu laporan penutup.

Properti tambahan tidak diizinkan.

ProgressBegin

Membuka laporan, dengan menyatakan apa yang telah dimulai dalam istilah yang digunakan operasi itu sendiri.

PropertiJenisWajibDeskripsi
kindconst “begin”yaMenandai payload ini sebagai pembuka laporan. Konstanta: "begin"
titlestringyaApa yang telah dimulai.

Properti tambahan tidak diizinkan.

ProgressReport

Satu baris dari uraian operasi tentang dirinya sendiri. Baris ini tidak membawa pecahan: operasi yang melapor di sini bekerja atas himpunan yang ukurannya tidak diketahui saat pekerjaan dimulai, sehingga pecahan harus dikarang.

PropertiJenisWajibDeskripsi
kindconst “report”yaMenandai payload ini sebagai satu baris dari laporan yang terbuka. Konstanta: "report"
messagestringyaSatu baris keluaran operasi itu sendiri, dengan spasi di sekelilingnya dihapus.

Properti tambahan tidak diizinkan.

ProgressEnd

Menutup laporan. Payload ini tidak membawa apa pun selain jenisnya, karena hasilnya dikirim pada respons yang sudah ditunggu pemanggil.

PropertiJenisWajibDeskripsi
kindconst “end”yaMenandai payload ini sebagai penutup laporan. Konstanta: "end"

Properti tambahan tidak diizinkan.

PublishDiagnosticsParams

Temuan untuk satu file, dikirim oleh daemon ketika validasi menghasilkannya untuk dokumen selain dokumen yang disebut permintaan.

PropertiJenisWajibDeskripsi
filestringyaFile yang menjadi pokok temuan.
diagnosticsDiagnostic[] atau nullyaTemuan, sesuai urutan dihasilkannya.

Properti tambahan tidak diizinkan.

SuccessResponse

Jawaban atas permintaan yang berhasil, membawa pengenal permintaan yang dijawabnya. Respons tidak membawa metode, sehingga bentuk hasil yang berlaku ditentukan oleh permintaan pemilik pengenal tersebut, bukan oleh apa pun di dalam respons itu sendiri.

PropertiJenisWajibDeskripsi
jsonrpcProtocolVersionyaVersi JSON-RPC yang dibawa setiap pesan. Hanya 2.0 yang digunakan.
idRequestIdyaPengenal yang diberikan pemanggil untuk sebuah permintaan, dipantulkan kembali pada respons yang menjawabnya. Pesan yang tidak membawa pengenal adalah notifikasi dan tidak pernah dijawab.
resultInitializeResult atau ValidateResult atau InvalidateResult atau DiagnosticsResult atau IrGraphResult atau BuildResult atau BuildPreviewResult atau EntityDefinitionResult atau ReleaseClosureResult atau ResolveDependenciesResult atau PinResult atau CacheStatusResult atau CachePruneResult atau CacheEvictResult atau CacheClearResult atau RegistryListResult atau SearchResult atau RegistryAddResult atau RegistryRemoveResult atau RegistryUpdateResult atau LogoutResult atau PublishEntityResult atau PublishArtifactResult atau SignArtifactsResult atau DeprecateArtifactResult atau ResolveResult atau FindReferencesResult atau FindImplementationsResult atau HoverResult atau CompletionResult atau CatalogIndexResult atau AttachCandidatesResult atau ConnectionCandidatesResult atau InsertionPointResult atau AttachmentContainerResult atau ConnectionAtPositionResult atau ReleaseCandidatesResult atau ActiveReleaseResult atau EditDocumentResult atau EffectiveConfigurationResult atau ConfigInitResult atau ConfigCaptureResult atau ImportResult atau ScaffoldEntityResult atau LintResult atau PluginAddResult atau PluginRemoveResult atau PluginSyncResult atau PluginGenCatalogResult atau ExplainErrorResult atau GetSchemaResult atau SkillsInstallResult atau SkillsListResultyaJawaban, dalam bentuk yang dikembalikan oleh metode yang diminta.

Properti tambahan tidak diizinkan.

ErrorResponse

Jawaban atas permintaan yang ditolak atau gagal, yang membawa pengenal permintaan yang dijawabnya.

PropertiJenisWajibDeskripsi
jsonrpcProtocolVersionyaVersi JSON-RPC yang dibawa setiap pesan. Hanya 2.0 yang digunakan.
idRequestIdyaPengenal yang diberikan pemanggil untuk sebuah permintaan, dipantulkan kembali pada respons yang menjawabnya. Pesan yang tidak membawa pengenal adalah notifikasi dan tidak pernah dijawab.
errorErrorObjectyaApa yang salah: kode yang dapat dijadikan dasar percabangan oleh klien, pesan yang ditulis untuk dibaca manusia, dan — jika kondisinya memilikinya — artefak serta posisi sumber yang dirujuk pesan tersebut.

Properti tambahan tidak diizinkan.

ErrorObject

Apa yang salah: kode yang dapat dijadikan dasar percabangan oleh klien, pesan yang ditulis untuk dibaca manusia, dan — jika kondisinya memilikinya — artefak serta posisi sumber yang dirujuk pesan tersebut.

PropertiJenisWajibDeskripsi
codeErrorCodeyaKondisi yang dilaporkan jawaban. Kode negatif adalah himpunan cadangan milik protokol itu sendiri; kode empat digit adalah kondisi yang dimunculkan daemon ini, masing-masing menamai keadaan yang dapat ditindaklanjuti klien. Himpunan ini tertutup.
messagestringyaApa yang salah, dalam bentuk prosa. Rumusannya sama dengan yang dibawa kondisi yang sama di setiap permukaan lain yang melaporkannya.
dataErrorDatatidakArtefak dan posisi sumber yang dirujuk pesan, dibawa secara terstruktur sehingga klien tidak perlu membacanya kembali dari prosa. Setiap bidang bersifat opsional dan suatu kondisi hanya mengisi apa yang dimilikinya; tidak ada bidang yang menggantikan bidang lain, sehingga klien mengetahui apa yang diterimanya dari bidang yang dibacanya, bukan dari kode di sampingnya.

Properti tambahan tidak diizinkan.

ErrorCode

Kondisi yang dilaporkan jawaban. Kode negatif adalah himpunan cadangan milik protokol itu sendiri; kode empat digit adalah kondisi yang dimunculkan daemon ini, masing-masing menamai keadaan yang dapat ditindaklanjuti klien. Himpunan ini tertutup.

Jenis: 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

Nilai yang diizinkan:

  • -32700 — Pesan tidak dapat di-parse sebagai JSON.
  • -32600 — Pesan berhasil di-parse tetapi bukan permintaan yang berbentuk benar.
  • -32601 — Tidak ada metode dengan nama tersebut.
  • -32602 — params yang dibawa permintaan tidak dapat diterima: field yang tidak diterima metode, field dengan tipe yang salah, atau nilai yang ditolak metode.
  • -32603 — Daemon gagal saat mengerjakan pekerjaan.
  • 1001 — Daemon tidak menyimpan hasil pembacaan berkas tersebut dan tidak sedang menghasilkannya. Klien memicunya dengan meminta validasi, lalu mencoba lagi.
  • 1003 — Lockfile untuk Release yang disebutkan permintaan tidak ada, dan operasi memerlukannya.
  • 1004 — Entitas yang disebutkan permintaan tidak dapat di-resolve dari katalog maupun dari Release yang disebutkan permintaan.
  • 1005 — Daemon sedang dimatikan dan menolak pekerjaan baru. Klien tidak mencoba lagi terhadap daemon yang sama.
  • 1006 — Validasi berkas sedang berjalan dan tidak selesai dalam batas waktu yang diizinkan oleh permintaan yang menunggu. Klien menunggu dan meminta lagi, tanpa mengirim apa pun selama itu.

ErrorData

Artefak dan posisi sumber yang dirujuk pesan, dibawa secara terstruktur sehingga klien tidak perlu membacanya kembali dari prosa. Setiap bidang bersifat opsional dan suatu kondisi hanya mengisi apa yang dimilikinya; tidak ada bidang yang menggantikan bidang lain, sehingga klien mengetahui apa yang diterimanya dari bidang yang dibacanya, bukan dari kode di sampingnya.

PropertiJenisWajibDeskripsi
filestringtidakDokumen sumber yang ditunjuk oleh bidang posisi — dokumen yang sedang diperiksa, atau Release yang gagal dimuat.
lineintegertidakBaris yang dirujuk kondisi, dihitung mulai dari satu.
columnintegertidakKolom yang dirujuk kondisi, dihitung mulai dari satu.
end_lineintegertidakBaris satu setelah akhir token yang dirujuk kondisi. Tidak ada jika akhir token tidak dapat dipulihkan; dalam hal itu klien menampilkan posisi sebagai satu titik.
end_columnintegertidakKolom satu setelah akhir token yang dirujuk kondisi.
releasestringtidakRelease yang dirujuk kondisi, ditulis sebagaimana permintaan menamainya, sehingga klien dapat menyusun perbaikannya tanpa merakitnya ulang.
lockfilestringtidakLockfile yang menjadi pokok kondisi berlingkup lockfile: path yang dicari dan tidak ditemukan, atau tidak dapat dibaca.
unreachablebooleantidakApakah penolakan berupa registry yang dinamai permintaan tetapi tidak dapat dijangkau: namanya tidak dapat di-resolve, koneksi ke sana ditolak atau tidak dapat dibuka, atau koneksi aman ke sana tidak dapat dibangun. Nilainya dibaca dari kegagalan itu sendiri, bukan dari pesan, dan hanya diisi jika kegagalan menunjukkan registry tidak pernah dijangkau. Penyegaran indeks yang ditolak yang menamai satu registry membawanya; registry yang menjawab, apa pun jawabannya, membiarkannya tidak ada.
codestringtidakNama deskriptif kondisi yang dinamai penolakan, stabil di seluruh rilis: nilai yang sama dengan yang dibawa diagnostik yang melaporkan kondisi tersebut dalam kodenya sendiri. Inilah yang dijadikan dasar percabangan oleh klien, bukan pesan atau kode numerik di sampingnya, yang menamai keadaan permintaan dan tetap sama untuk setiap kondisi. Ada tepat ketika penolakan menamai kondisi terdaftar, dan tidak ada ketika tidak menamai kondisi apa pun.
shortCodestringtidakKode pendek kondisi, huruf E dan empat digit: bentuk yang dikutip dan dicari pembaca, dan yang membuka pesan penolakan yang menamai suatu kondisi. Ada tepat ketika code ada.

Properti tambahan tidak diizinkan.

Diagnostic

Satu temuan tentang satu dokumen: di mana letaknya, seberapa serius, apa isinya, dan kode yang dapat dikutip yang menamai kondisi yang dilaporkannya.

PropertiJenisWajibDeskripsi
lineintegeryaBaris yang menjadi pokok temuan, dihitung mulai dari satu.
columnintegeryaKolom yang menjadi pokok temuan, dihitung mulai dari satu.
severityconst “error” atau const “warning” atau const “info”yaSeberapa serius temuan tersebut. Nilai yang diizinkan: "error" — Temuan merupakan kesalahan. Temuan plugin dengan tingkat keparahan halt dilaporkan pada tingkat ini. "warning" — Temuan dilaporkan dan bukan kesalahan. Temuan plugin dengan tingkat keparahan warn dilaporkan pada tingkat ini. "info" — Temuan bersifat informasi, sebagaimana temuan plugin dengan tingkat keparahan info.
messagestringyaIsi temuan, dalam bentuk prosa.
codestringtidakNama deskriptif kondisi, stabil di seluruh rilis dan dapat dikutip dalam supresi.
shortCodestringtidakKode pendek kondisi, bentuk yang membuka diagnostik yang menghentikan proses.
codeDescriptionCodeDescriptiontidakTempat kondisi yang dinamai temuan dijelaskan.
classificationstringtidakBagaimana temuan dicapai, jika kondisinya membedakan hal itu.
suggeststringtidakEjaan yang diusulkan temuan, jika kondisinya dapat menamainya — misalnya pengenal yang hampir cocok.
keyPathstringtidakPath di dalam dokumen menuju kunci yang menjadi pokok temuan.
sourcestringyaApa yang menghasilkan temuan.
end_lineintegertidakBaris satu setelah akhir token yang menjadi pokok temuan, sehingga klien dapat menampilkan seluruh token, bukan satu karakter saja. Tidak ada untuk token yang membentang beberapa baris.
end_columnintegertidakKolom satu setelah akhir token yang menjadi pokok temuan.

Properti tambahan tidak diizinkan.

CodeDescription

Tempat kondisi yang dinamai temuan dijelaskan.

PropertiJenisWajibDeskripsi
hrefstringyaAlamat terpublikasi tempat kondisi dijelaskan.

Properti tambahan tidak diizinkan.

Position

Suatu tempat dalam dokumen: baris dan offset karakter di dalamnya, keduanya dihitung mulai dari nol. Offset diukur dalam satuan encoding yang disepakati sesi saat dibuka, yaitu UTF-16 kecuali klien meminta yang lain.

PropertiJenisWajibDeskripsi
lineintegeryaBaris, dihitung mulai dari nol.
characterintegeryaOffset di dalam baris, dihitung mulai dari nol, dalam satuan encoding yang disepakati sesi.

Properti tambahan tidak diizinkan.

Range

Rentang di antara dua tempat dalam dokumen.

PropertiJenisWajibDeskripsi
startPositionyaSuatu tempat dalam dokumen: baris dan offset karakter di dalamnya, keduanya dihitung mulai dari nol. Offset diukur dalam satuan encoding yang disepakati sesi saat dibuka, yaitu UTF-16 kecuali klien meminta yang lain.
endPositionyaSuatu tempat dalam dokumen: baris dan offset karakter di dalamnya, keduanya dihitung mulai dari nol. Offset diukur dalam satuan encoding yang disepakati sesi saat dibuka, yaitu UTF-16 kecuali klien meminta yang lain.

Properti tambahan tidak diizinkan.

Location

Rentang dalam dokumen bernama.

PropertiJenisWajibDeskripsi
uristringyaDokumen tempat rentang berada, dialamatkan sebagai URI.
rangeRangeyaRentang di antara dua tempat dalam dokumen.

Properti tambahan tidak diizinkan.

WorkspaceAndProgressParams

Objek params dari metode yang tidak mendeklarasikan bidang sendiri. Objek ini tetap menerima dua bidang yang diterima setiap permintaan: workspace yang menjadi sasarannya, dan token progres.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.

Properti tambahan tidak diizinkan.

InitializeParams

Membuka sesi atas sebuah workspace dan menyatakan apa yang dapat ditangani klien. Ini adalah satu-satunya metode di mana workspaceRoot merupakan deklarasi, bukan subjek: tidak ada, kosong, dan sebuah path adalah tiga hal yang berbeda, dan sesi yang dibuka tanpa path adalah sesi yang belum diarahkan klien ke sebuah workspace.

PropertiJenisWajibDeskripsi
capabilitiesClientCapabilitiestidakApa yang dapat ditangani klien. Yang tidak dinyatakan dianggap tidak didukung. Anggota yang tidak dikenal diabaikan alih-alih ditolak, sehingga klien dapat menyatakan kapabilitas yang belum dibaca oleh daemon ini.
workspaceRootstringtidakPath absolut workspace yang akan dibuka. Jika tidak ada, sesi dibiarkan tanpa workspace; string kosong adalah path yang diberikan klien dan tidak sama dengan tidak mengirimkan apa pun.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.

Properti tambahan tidak diizinkan.

ClientCapabilities

Apa yang dapat ditangani klien. Yang tidak dinyatakan dianggap tidak didukung. Anggota yang tidak dikenal diabaikan alih-alih ditolak, sehingga klien dapat menyatakan kapabilitas yang belum dibaca oleh daemon ini.

PropertiJenisWajibDeskripsi
generalobjecttidakKapabilitas yang tidak terikat pada satu jenis jawaban.
windowobjecttidakKapabilitas mengenai apa yang dapat ditampilkan klien selama pekerjaan berlangsung.

Properti tambahan diizinkan.

ClientCapabilities.general

Kapabilitas yang tidak terikat pada satu jenis jawaban.

PropertiJenisWajibDeskripsi
positionEncodingsstring[]tidakEncoding posisi yang dapat dibaca klien, diurutkan dari yang terbaik.

Properti tambahan diizinkan.

ClientCapabilities.window

Kapabilitas mengenai apa yang dapat ditampilkan klien selama pekerjaan berlangsung.

PropertiJenisWajibDeskripsi
workDoneProgressbooleantidakApakah klien dapat menerima notifikasi progres. Permintaan yang membuat token progres dalam sesi yang tidak mendeklarasikan ini akan ditolak.

Properti tambahan diizinkan.

ValidateParams

Memeriksa workspace, atau satu dokumen di dalamnya, dan menjawab dengan temuan-temuannya.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
filestringtidakDokumen yang akan diperiksa. Jika tidak ada, yang diperiksa adalah isi workspace.
contentstringtidakTeks dokumen sebagaimana saat ini dipegang klien, untuk memeriksa buffer yang belum disimpan. Jika tidak ada, byte di disk yang dibaca.
releasestringtidakRelease yang menjadi acuan pemeriksaan, sebagai path relatif terhadap root workspace.

Properti tambahan tidak diizinkan.

InvalidateParams

Memberi tahu daemon bahwa dokumen yang hasil pembacaannya ia pegang telah berubah, sehingga jawaban berikutnya tentang dokumen itu dihitung dari byte yang baru.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
filestringtidakDokumen yang berubah.
granularitystringtidakSeberapa banyak dari yang disimpan daemon yang dibuang: file hanya membuang yang disimpannya untuk dokumen yang disebutkan; workspace, nilai default dan cara nilai lain apa pun dibaca, juga membuang yang disimpannya untuk seluruh workspace.

Properti tambahan tidak diizinkan.

DiagnosticsParams

Menjawab dengan temuan yang sudah dipegang daemon untuk sebuah dokumen, tanpa memeriksanya lagi.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
filestringtidakDokumen yang akan dilaporkan. Daemon harus sudah memegang hasil pembacaannya.

Properti tambahan tidak diizinkan.

IrGraphParams

Menjawab dengan graf terselesaikan yang menjadi hasil kompilasi sebuah Release, tanpa merendernya.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
releasestringtidakRelease yang akan diselesaikan, sebagai path relatif terhadap root workspace. Path absolut ditolak.
unredactedbooleantidakApakah akan menjawab dengan nilai-nilai yang dideklarasikan sensitif oleh penulis dalam bentuk terbuka. Jika tidak ada atau false, setiap nilai tersebut ditahan dari graf dan sebuah penanda yang menyebutkan alasannya menggantikan tempatnya, sebagaimana keluaran graf baris perintah menahannya; true menjawab dengan graf sebagaimana Release dikompilasi menjadi graf itu, termasuk nilai-nilai tersebut.

Properti tambahan tidak diizinkan.

BuildParams

Mengompilasi sebuah Release dan menulis artefak hasil render ke dalam workspace.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
releasestringtidakRelease yang akan di-build, sebagai path relatif terhadap root workspace. Path absolut ditolak.
outputParentstringtidakDirektori tempat direktori keluaran dibuat, sebagai path relatif terhadap root workspace. Artefak ditempatkan di direktori keluaran di bawahnya, dengan tata letak yang sama seperti di bawah root workspace ketika tidak ada yang disebutkan — jadi ini menyebutkan induk direktori keluaran dan tidak pernah direktori keluaran itu sendiri. Jika tidak ada, atau kosong, direktori keluaran ditulis di bawah root workspace, sebagaimana dilakukan aggrega build dari mana pun ia dijalankan. Path absolut, atau path yang keluar dari workspace, ditolak.
autoPullbooleantidakApakah dependensi Release diselesaikan terlebih dahulu. Jika diminta, registry yang dikonfigurasi akan dihubungi dan lockfile ditulis; jika tidak diminta, build tidak menghubungi registry apa pun.
policyInputstringtidakDirektori untuk menulis, di samping artefak, payload yang diserahkan setiap peran tata kelola kepada plugin yang dilampirkan di sana, sebagai path relatif terhadap root workspace — berkas yang ditulis oleh aggrega build --policy-input, dengan nama yang sama, yang ditulis baik build selesai maupun berhenti. Pemberitahuan dalam jawaban menyebutkan berapa banyak berkas yang ditulis dan menyebutkan setiap peran yang tidak ditulisi berkas. Pada permintaan yang gagal, berkas yang sudah ditulis tetap ada di disk dan rincian tersebut tidak ada dalam balasan: error hanya membawa penolakan. Jika tidak ada, tidak ada yang ditulis. Path absolut, atau path yang keluar dari workspace, ditolak.

Properti tambahan tidak diizinkan.

BuildPreviewParams

Mengompilasi sebuah Release dan melaporkan apa yang akan dihasilkan oleh penulisan artefak, tanpa menulis satu pun di antaranya. Permintaan ini menolak bidang resolusi dependensi yang diterima oleh build yang menulis, karena permintaan yang tidak menulis apa pun tidak dapat mengisi lockfile.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
releasestringtidakRelease yang akan dikompilasi, sebagai path relatif terhadap root workspace.
autoPullbooleantidakDiterima pada wire dan ditolak oleh metode: permintaan ini tidak menulis apa pun, sehingga tidak dapat mengisi lockfile dan tetap sesuai dengan apa yang dinyatakannya.
policyInputstringtidakDirektori untuk menulis payload yang diserahkan setiap peran tata kelola kepada plugin yang dilampirkan di sana, sebagai path relatif terhadap root workspace — berkas yang ditulis oleh aggrega build --dry-run --policy-input, dengan nama yang sama. Jika dikirim, berkas-berkas itulah satu-satunya yang ditulis permintaan ini; direktori output dan lockfile tidak disentuh. Pemberitahuan dalam jawaban menyebutkan berapa banyak berkas yang ditulis dan menyebutkan setiap peran yang tidak ditulisi berkas. Pada permintaan yang gagal, berkas yang sudah ditulis tetap ada di disk dan rincian tersebut tidak ada dalam balasan: error hanya membawa penolakan. Path absolut, atau path yang keluar dari workspace, ditolak.

Properti tambahan tidak diizinkan.

EntityDefinitionParams

Menjawab dengan hasil resolusi sebuah nama entitas dan lokasi dokumen yang mendefinisikannya.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
namestringtidakEntitas yang akan diresolusi, berdasarkan nama — atau referensi registry, oci://<host>/<repository>:<tag> atau @<digest> sebagai pengganti :<tag>, untuk membaca entitas yang dipublikasikan pada koordinat tersebut.
releasestringtidakRelease yang menjadi acuan resolusi nama, sebagai path relatif terhadap root workspace. Nama kemudian diresolusi melalui direktori katalog yang diberikan konfigurasi workspace kepada Release tersebut, sehingga nama yang dideklarasikan oleh beberapa varian dalam satu workspace, satu per Release, diresolusi ke varian yang digunakan Release tersebut untuk build, dan nama yang tidak dapat diresolusinya ditolak dengan keterangan yang menyebutkan entri Release tersebut di bawah workspace.releases. Jika tidak ada, nama diresolusi melalui direktori katalog milik workspace sendiri. Referensi registry tidak menerima Release dan ditolak jika disertai satu, demikian pula nilai yang tidak menunjuk berkas Release.

Properti tambahan tidak diizinkan.

CatalogIndexParams

Menjawab dengan entitas yang dimiliki workspace: setiap entitas yang dideklarasikan dokumennya, dan Features yang dideklarasikan direktori katalognya.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
releasestringtidakRelease yang menjadi acuan daftar entitas, sebagai path relatif terhadap root workspace. Features kemudian adalah yang dideklarasikan oleh direktori katalog yang diberikan konfigurasi workspace kepada Release tersebut, dan dokumen di bawah direktori katalog yang hanya dibaca oleh Releases lain tidak disertakan, sehingga workspace yang menyimpan varian-varian satu entitas berdampingan, satu per Release, didaftar dengan varian yang digunakan Release tersebut untuk build. Jika tidak ada, daftarnya adalah milik workspace sendiri. Nilai yang tidak menunjuk berkas Release ditolak.

Properti tambahan tidak diizinkan.

ReleaseClosureParams

Menjawab dengan semua hal yang menjadi dependensi sebuah Release, sebagaimana dicapai oleh resolusi.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
releasestringtidakRelease yang akan diperiksa, sebagai path relatif terhadap root workspace.

Properti tambahan tidak diizinkan.

ResolveDependenciesParams

Meresolusi dependensi sebuah Release, menyematkannya dalam lockfile dan memperoleh input eksternal yang dikonsumsi oleh render-nya. Permintaan ini menghubungi registry yang dikonfigurasi dan melakukan penulisan.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
releasestringtidakRelease yang akan diresolusi, sebagai path relatif terhadap root workspace.
upgradebooleantidakApakah akan meresolusi ulang dalam rentang yang dideklarasikan alih-alih mengikuti apa yang sudah disematkan lockfile.
targetsstring[]tidakReferensi yang akan diresolusi ulang, sementara sisanya tetap tersemat apa adanya. Kosong berarti meresolusi semuanya.
verifybooleantidakApakah akan membandingkan lockfile yang tercatat dengan resolusi yang akan dilakukan permintaan ini tanpanya, dengan mengikuti sematan yang akan diikuti permintaan tersebut, alih-alih menulisnya. Verifikasi tidak menulis lockfile, catatan kepercayaan plugin, maupun entity.lock; cache konten dibaca dan diisi sebagaimana resolusi tersebut akan membaca dan mengisinya. Penyimpangan, dan lockfile yang tidak ada, menggagalkan permintaan. Ini tidak dapat digabungkan dengan upgrade, targets atau pinSources, apa pun nilai yang dibawa pinSources: permintaan yang mengirim salah satunya bersama ini ditolak sebagai parameter tidak valid sebelum apa pun diresolusi.
pinSourcesbooleantidakApakah akan menjalankan langkah penyematan yang dijalankan aggrega/pin atas Recipes dan FeatureRecipes yang di-build oleh Release dari direktori katalog workspace, dengan menulis entity.lock di samping masing-masing, alih-alih menolak permintaan karena ada yang lock-nya tidak mencatat sematan yang dibutuhkan suatu input. Jika tidak ada, mengikuti pin_sources_at_pull milik workspace; nilai apa pun menimpa pengaturan tersebut untuk permintaan ini.

Properti tambahan tidak diizinkan.

PinParams

Mencatat, di dalam entity.lock di samping sebuah Recipe atau FeatureRecipe, pin konten untuk setiap input yang dibaca entitas dari luar dokumennya sendiri. Tidak ada Release yang disebutkan: input yang identitasnya ditulis lengkap oleh entitas menunjuk satu artefak untuk setiap Release yang menggunakan entitas tersebut, sehingga tidak ada yang perlu disediakan oleh sebuah Release untuk mem-pin-nya. Permintaan ini menjangkau host yang disebutkan oleh sumber entitas dan menulis di samping entitas; dokumen entitas itu sendiri tidak pernah ditulis.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
entitystringtidakDokumen entitas yang akan di-pin, sebagai path relatif terhadap root workspace.
dryRunbooleantidakApakah menjawab dengan lock yang akan ditulis oleh langkah ini alih-alih menulisnya. Input tetap di-resolve, sehingga cache konten tetap terisi.

Properti tambahan tidak diizinkan.

CacheEvictParams

Mengambil kembali ruang konten yang di-cache hingga sisanya muat di bawah ukuran yang disebutkan permintaan.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
maxSizestringtidakUkuran target pengambilan kembali, ditulis sebagaimana orang menuliskannya — misalnya 500MB.

Properti tambahan tidak diizinkan.

SearchParams

Mencari apa yang ditawarkan oleh indeks lokal registry yang dikonfigurasi. Permintaan ini membaca indeks yang sudah ada di disk dan tidak menghubungi registry mana pun.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
querystringtidakTeks yang dicocokkan dengan nama dan deskripsi sebuah rekaman.
kindsstring[]tidakJenis entitas yang dipertahankan. Kosong berarti mempertahankan semua jenis.
selectorstringtidakSelector label yang harus dipenuhi oleh rekaman yang dipertahankan.
capabilitiesstring[]tidakKapabilitas yang harus dideklarasikan oleh rekaman plugin yang dipertahankan.
pluginTypestringtidakJenis plugin yang dipertahankan.
registrystringtidakSatu host registry yang akan dicari. Jika tidak ada, semua host yang dikonfigurasi akan dicari.
limitintegertidakJumlah maksimum rekaman dalam jawaban.
includeRetractedbooleantidakApakah mempertahankan versi yang telah dinyatakan usang oleh penanda yang dipublikasikan.

Properti tambahan tidak diizinkan.

RegistryAddParams

Mendaftarkan sebuah registry beserta kebijakan kepercayaan yang diterapkan resolusi terhadap apa yang disajikannya. Permintaan ini menulis file konfigurasi tingkat mesin kecuali permintaan meminta lain, sehingga setiap workspace di mesin tersebut melakukan resolusi melalui entri itu.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
hoststringtidakHost registry yang akan didaftarkan.
namestringtidakAlias ramah yang mengarah ke host tersebut.
identitiesstring[]tidakIdentitas penandatanganan yang dipercaya untuk apa yang disajikan registry ini.
keyPathstringtidakPath kunci publik yang akan dipercaya, untuk registry yang ditandatangani dengan kunci alih-alih dengan identitas tanpa kunci.
trustedRootstringtidakPath trust anchor untuk memverifikasi tanda tangan.
requireSignaturesbooleantidakApakah artefak dari registry ini harus membawa tanda tangan yang terverifikasi. Jika tidak ada, tidak ada yang dinyatakan dan default hasil resolusi tetap berlaku.
advisorybooleantidakApakah verifikasi yang gagal dilaporkan alih-alih menghentikan proses.
fetchTrustbooleantidakApakah membaca kebijakan kepercayaan yang diiklankan registry dan mem-pin-nya. Jika tidak ada, tidak ada yang dinyatakan dan default hasil resolusi tetap berlaku.
globalbooleantidakMenulis file konfigurasi tingkat mesin, yang merupakan default metode ini.
workspacebooleantidakMenulis file konfigurasi milik workspace ini alih-alih file tingkat mesin.

Properti tambahan tidak diizinkan.

RegistryRemoveParams

Menghapus registry yang terdaftar. Permintaan ini menulis file konfigurasi tingkat mesin kecuali permintaan meminta lain.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
registrystringtidakRegistry yang akan dihapus, berdasarkan host atau alias.
globalbooleantidakMenulis file konfigurasi tingkat mesin, yang merupakan default metode ini.
workspacebooleantidakMenulis file konfigurasi milik workspace ini alih-alih file tingkat mesin.

Properti tambahan tidak diizinkan.

RegistryUpdateParams

Menyegarkan indeks lokal yang dibaca oleh pencarian, dengan menjangkau registry untuk melakukannya. Yang ditulisnya adalah indeks di bawah direktori cache yang dikonfigurasi milik workspace ini. Registry yang memerlukan kredensial yang tidak dibawa oleh sumber ambien mana pun ditolak dengan menyebutkan kredensial tersebut, alih-alih meminta kredensial itu.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
registrystringtidakSatu registry yang akan disegarkan. Jika tidak ada, semua host yang dikonfigurasi akan disegarkan.
upgradebooleantidakApakah membangun ulang indeks alih-alih menambahkan ke isi yang sudah ada.

Properti tambahan tidak diizinkan.

LogoutParams

Menghapus kredensial registri yang tersimpan. Penyimpanan tersebut digunakan bersama oleh setiap proyek di mesin, dan jawabannya menyatakan hal itu.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
registrystringtidakRegistri yang kredensial tersimpannya akan dihapus.

Properti tambahan tidak diizinkan.

PublishEntityParams

Menerbitkan entitas ke registri. Apa yang diterbitkannya adalah apa yang di-resolve oleh setiap konsumen registri tersebut, dan versi yang telah diterbitkan tidak dapat ditarik kembali dari siapa pun yang sudah mengambilnya. Tidak ada yang diminta secara interaktif: identitas di-resolve dari apa yang diberikan permintaan atau apa yang sudah tersedia di lingkungan.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
entitystringtidakDokumen entitas yang akan diterbitkan, sebagai path relatif terhadap root workspace.
registrystringtidakRegistri tujuan penerbitan. Jika tidak ada, default yang dikonfigurasi digunakan.
dryRunbooleantidakApakah akan melaporkan apa yang akan diterbitkan tanpa benar-benar menerbitkannya.
signbooleantidakApakah akan menandatangani apa yang diterbitkan. Jika tidak ada, tidak ada yang dinyatakan dan default yang telah di-resolve tetap berlaku.
pluginstringtidakModul plugin yang diterbitkan bersama entitas Plugin.
fulcioUrlstringtidakOtoritas sertifikat tempat memperoleh sertifikat penandatanganan.
rekorUrlstringtidakLog transparansi tempat mencatat tanda tangan.
timestampUrlstringtidakOtoritas stempel waktu yang digunakan untuk menandatangani bersama (countersign).
identityTokenstringtidakToken identitas untuk menandatangani, diberikan oleh pemanggil alih-alih diperoleh di terminal.
pinSourcesbooleantidakApakah akan menjalankan langkah pin yang dijalankan aggrega/pin pada entitas sebelum entitas dibundel, sehingga entity.lock yang ditulis langkah itu di sampingnya menjadi bagian dari apa yang diterbitkan. Langkah ini berjalan sebelum setiap penolakan yang menilai entitas, dan di bawah dryRun langkah ini melaporkan lock yang akan ditulisnya dan tidak menulis apa pun. Jika tidak ada, mengikuti pin_sources_at_push milik workspace; nilai mana pun menggantikan pengaturan tersebut untuk permintaan ini.

Properti tambahan tidak diizinkan.

PublishArtifactParams

Menerbitkan file sembarang ke registri dengan nama dan tag yang diberikan permintaan.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
filestringtidakFile yang akan diterbitkan, sebagai path relatif terhadap root workspace.
namestringtidakNama repositori tempat penerbitan.
tagstringtidakTag tempat penerbitan.
mediaTypestringtidakJenis media yang dicatat untuk byte yang diterbitkan.
registrystringtidakRegistri tujuan penerbitan. Jika tidak ada, default yang dikonfigurasi digunakan.
dryRunbooleantidakApakah akan melaporkan apa yang akan diterbitkan tanpa benar-benar menerbitkannya.

Properti tambahan tidak diizinkan.

SignArtifactsParams

Menandatangani apa yang sudah diterbitkan. Tanda tangan tidak dapat ditarik kembali dari siapa pun yang sudah mengambilnya.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
referencesstring[]tidakReferensi terbitan yang akan ditandatangani.
fulcioUrlstringtidakOtoritas sertifikat tempat memperoleh sertifikat penandatanganan.
rekorUrlstringtidakLog transparansi tempat mencatat tanda tangan.
timestampUrlstringtidakOtoritas stempel waktu yang digunakan untuk menandatangani bersama (countersign).
identityTokenstringtidakToken identitas untuk menandatangani, diberikan oleh pemanggil alih-alih diperoleh di terminal.
jobsintegertidakBerapa banyak referensi yang ditandatangani sekaligus. Jika tidak ada, ditandatangani satu per satu. Setiap referensi tetap ditandatangani persis seperti jika ditandatangani sendiri — jika keyless, dengan sertifikatnya sendiri dan entri log transparansinya sendiri — dan jawaban mempertahankan urutan referensi diberikan. Minimum: 1.

Properti tambahan tidak diizinkan.

DeprecateArtifactParams

Menandai versi yang telah diterbitkan sebagai usang, sehingga resolusi dapat melaporkan atau menolaknya. Penanda itu sendiri diterbitkan dan ditandatangani. Sebuah permintaan mengirimkan satu referensi beserta isinya, atau sebuah file batch yang entri-entrinya membawa isinya sendiri — tidak pernah keduanya, dan tidak pernah isi di samping file batch.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
referencestringtidakReferensi terbitan yang akan ditandai. Alternatif untuk from: permintaan yang membawa keduanya ditolak.
severityconst “warning” atau const “error” atau const “retracted”tidakSeberapa kuat penanda berbicara — apakah resolusi melaporkan versi tersebut atau menolaknya. Wajib bersama reference; ditolak di samping from, yang file batch-nya memuat nilai tersendiri untuk setiap penanda. Nilai yang diizinkan: "warning" — Di-deprecate, pada tingkat yang lebih ringan dari dua tingkat anjuran: tetap dipilih ketika versi dipilih. "error" — Di-deprecate, pada tingkat yang lebih kuat dari dua tingkat anjuran: tetap dipilih ketika versi dipilih. "retracted" — Ditarik: dikecualikan ketika versi dipilih.
reasonstringtidakAlasan versi tersebut usang. Wajib bersama reference; ditolak di samping from, yang file batch-nya memuat nilai tersendiri untuk setiap penanda.
replacementstringtidakReferensi yang digunakan sebagai gantinya. Ditolak di samping from, yang file batch-nya memuat nilai tersendiri untuk setiap penanda.
messagestringtidakApa yang disampaikan kepada konsumen yang menjumpai penanda. Ditolak di samping from, yang file batch-nya memuat nilai tersendiri untuk setiap penanda.
fromstringtidakFile batch berisi entri penarikan, sebagai path relatif terhadap root workspace, yang memasang satu penanda per entri. Setiap entri membawa referensi, tingkat keparahan, dan alasannya sendiri, serta secara opsional pengganti dan pesan. Alternatif untuk reference: permintaan yang membawa keduanya, atau yang membawa tingkat keparahan, alasan, pengganti, atau pesan di sampingnya, ditolak.
fulcioUrlstringtidakOtoritas sertifikat tempat memperoleh sertifikat penandatanganan.
rekorUrlstringtidakLog transparansi tempat mencatat tanda tangan.
timestampUrlstringtidakOtoritas stempel waktu yang digunakan untuk menandatangani bersama (countersign).
identityTokenstringtidakToken identitas untuk menandatangani, diberikan oleh pemanggil alih-alih diperoleh di terminal.

Properti tambahan tidak diizinkan.

ResolveParams

Menjawab di mana hal yang berada di bawah kursor didefinisikan.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
uristringtidakDokumen tempat kursor berada.
positionPositiontidakSuatu tempat dalam dokumen: baris dan offset karakter di dalamnya, keduanya dihitung mulai dari nol. Offset diukur dalam satuan encoding yang disepakati sesi saat dibuka, yaitu UTF-16 kecuali klien meminta yang lain.
releasestringtidakRelease yang menjadi acuan jawaban, sebagai path relatif terhadap root workspace. Definisinya kemudian adalah dokumen yang menjadi tujuan resolusi referensi melalui direktori katalog yang diberikan konfigurasi workspace kepada Release tersebut, sesuai urutannya, sehingga nama yang dideklarasikan oleh beberapa varian dalam satu workspace, satu per Release, mengarah ke varian milik Release tersebut; jika direktori tersebut tidak mendeklarasikan entitas semacam itu, dokumen-dokumen workspace yang dicari, tanpa menyertakan dokumen yang berada di bawah salah satu direktori katalog workspace yang tidak dibaca oleh Release tersebut. Jika tidak ada, dokumen-dokumen workspace dicari lebih dahulu, dan direktori katalog milik workspace sendiri hanya dicari jika tidak ada dokumen yang mendeklarasikan nama tersebut. Nilai yang tidak menyebut file Release apa pun ditolak.

Properti tambahan tidak diizinkan.

FindReferencesParams

Menjawab di mana hal yang berada di bawah kursor dirujuk.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
uristringtidakDokumen tempat kursor berada.
positionPositiontidakSuatu tempat dalam dokumen: baris dan offset karakter di dalamnya, keduanya dihitung mulai dari nol. Offset diukur dalam satuan encoding yang disepakati sesi saat dibuka, yaitu UTF-16 kecuali klien meminta yang lain.
releasestringtidakRelease yang menjadi acuan jawaban, sebagai path relatif terhadap root workspace. Referensi yang dibuat dalam dokumen di bawah salah satu direktori katalog workspace yang tidak dibaca oleh Release tersebut kemudian tidak dilaporkan, sehingga varian-varian yang disimpan berdampingan dalam satu workspace, satu per Release, tidak pernah dilaporkan sebagai referensi satu sama lain. Jika tidak ada, setiap dokumen workspace dicari. Nilai yang tidak menyebut file Release apa pun ditolak.

Properti tambahan tidak diizinkan.

FindImplementationsParams

Menjawab dokumen mana yang mengimplementasikan hal yang berada di bawah kursor.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
uristringtidakDokumen tempat kursor berada.
positionPositiontidakSuatu tempat dalam dokumen: baris dan offset karakter di dalamnya, keduanya dihitung mulai dari nol. Offset diukur dalam satuan encoding yang disepakati sesi saat dibuka, yaitu UTF-16 kecuali klien meminta yang lain.
releasestringtidakRelease yang menjadi acuan jawaban, sebagai path relatif terhadap root workspace. Dokumen di bawah salah satu direktori katalog workspace yang tidak dibaca oleh Release tersebut kemudian tidak dilaporkan, sehingga varian yang digunakan Release lain untuk build tidak pernah dicantumkan di antara varian milik Release ini. Jika tidak ada, setiap dokumen workspace dicari. Nilai yang tidak menyebut file Release apa pun ditolak.

Properti tambahan tidak diizinkan.

HoverParams

Menjawab dengan apa yang perlu ditampilkan tentang hal yang berada di bawah kursor.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
uristringtidakDokumen tempat kursor berada.
positionPositiontidakSuatu tempat dalam dokumen: baris dan offset karakter di dalamnya, keduanya dihitung mulai dari nol. Offset diukur dalam satuan encoding yang disepakati sesi saat dibuka, yaitu UTF-16 kecuali klien meminta yang lain.
releasestringtidakRelease yang menjadi acuan jawaban, sebagai path relatif terhadap root workspace. Entitas yang ditampilkan kemudian adalah entitas yang menjadi tujuan resolusi referensi melalui direktori katalog yang diberikan konfigurasi workspace kepada Release tersebut, sesuai urutannya; jika direktori tersebut tidak mendeklarasikan entitas semacam itu, dokumen-dokumen workspace yang dicari, tanpa menyertakan dokumen yang berada di bawah salah satu direktori katalog workspace yang tidak dibaca oleh Release tersebut. Jika tidak ada, dokumen-dokumen workspace dicari lebih dahulu, dan direktori katalog milik workspace sendiri hanya dicari jika tidak ada dokumen yang mendeklarasikan nama tersebut. Nilai yang tidak menyebut file Release apa pun ditolak.

Properti tambahan tidak diizinkan.

CompletionParams

Menjawab dengan apa yang dapat ditulis pada posisi kursor.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
uristringtidakDokumen tempat kursor berada.
positionPositiontidakSuatu tempat dalam dokumen: baris dan offset karakter di dalamnya, keduanya dihitung mulai dari nol. Offset diukur dalam satuan encoding yang disepakati sesi saat dibuka, yaitu UTF-16 kecuali klien meminta yang lain.
contextCompletionContexttidakApa yang memicu permintaan, jika klien melacaknya.
releasestringtidakRelease yang menjadi acuan jawaban, sebagai path relatif terhadap root workspace. Nama-nama yang ditawarkan kemudian adalah nama yang dideklarasikan dokumen-dokumen workspace, dikurangi dokumen di bawah salah satu direktori katalog workspace yang tidak dibaca oleh Release tersebut, bersama dengan Components dan Features yang dideklarasikan oleh direktori katalog yang diberikan konfigurasi workspace kepada Release tersebut. Jika tidak ada, nama-nama tersebut adalah dokumen-dokumen workspace serta Components dan Features yang dideklarasikan oleh direktori katalog milik workspace sendiri. Nilai yang tidak menyebut file Release apa pun ditolak.

Properti tambahan tidak diizinkan.

CompletionContext

Apa yang memicu permintaan, jika klien melacaknya.

PropertiJenisWajibDeskripsi
triggerKindintegertidakAlasan completion diminta.
triggerCharacterstringtidakKarakter yang memicunya, jika memang dipicu oleh karakter.

Properti tambahan diizinkan.

AttachCandidatesParams

Menjawab Features mana yang dapat dilampirkan ke suatu entitas, dinilai berdasarkan label entitas tersebut, dan, untuk satu koneksi yang ditarik oleh komponen suatu node graf, Features mana yang dapat mengisi setiap slot yang dideklarasikan oleh socket koneksi tersebut.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
nodestringtidakEntitas yang menjadi dasar penilaian kandidat, berdasarkan nama, dibaca dari apa yang dideklarasikan oleh dokumen workspace.
graphNodestringtidakNode graf yang menjadi dasar penilaian kandidat, yang labelnya merupakan himpunan final yang digunakan build itu sendiri untuk mengevaluasi penerapan. Jawaban yang dihitung atas node ini menyatakan apa yang akan dilakukan build.
releasestringtidakRelease yang grafnya memuat node tersebut, sebagai path relatif terhadap root workspace. Kandidat kemudian diambil dalam konteks Release tersebut: Features yang dideklarasikan oleh direktori katalog yang diberikan konfigurasi workspace kepada Release tersebut, serta dokumen workspace dikurangi dokumen apa pun di bawah salah satu direktori katalog workspace yang tidak dibaca oleh Release tersebut, sehingga Feature yang disimpan untuk Release lain tidak pernah ditawarkan untuk node pada graf Release ini.
labelsmap of stringtidakLabel yang langsung dijadikan dasar penilaian, sebagai pengganti pembacaan label dari entitas atau node graf.
connectionConnectionCoordinatetidakSatu koneksi yang ditarik oleh komponen dari node yang dinamai graphNode, untuk dijawab selain node tersebut: jawaban kemudian juga memuat slots, yaitu setiap slot yang dideklarasikan socket koneksi tersebut beserta Features yang dapat mengisinya, atau noSlotReason jika tidak ada slot yang dapat diisi. Nilai ini hanya dikirim bersama graphNode dan release, karena koneksi hanya ada pada graf yang telah dikompilasi; jika dikirim bersama node atau labels, permintaan ditolak. Kandidat di sampingnya tetap bermakna sama, yaitu Features yang dapat dilampirkan ke node itu sendiri. Dokumennya diterima dan tidak mengubah jawaban ini: slot adalah milik socket dan kandidat adalah milik Features, sama saja di dokumen mana pun lampiran ditulis.

Properti tambahan tidak diizinkan.

ConnectionCandidatesParams

Menjawab entitas mana saja yang dapat dihubungkan dengan socket pada suatu entitas.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
nodestringtidakEntitas yang socket-nya ditanyakan.
socketstringtidakSatu socket yang akan dijawab. Jika tidak ada, jawaban mencakup setiap socket yang dideklarasikan entitas tersebut.

Properti tambahan tidak diizinkan.

InsertionPointParams

Menjawab di bagian mana dalam suatu dokumen entri baru di bawah container bernama seharusnya ditempatkan, sementara penyusunan dan penerapan entri diserahkan kepada pemanggil yang memiliki buffer.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
filestringtidakDokumen yang ditanyakan.
containerstring[]tidakPath melalui dokumen menuju container tempat entri tersebut berada.

Properti tambahan tidak diizinkan.

AttachmentContainerParams

Menjawab di dokumen mana, dan di bagian mana di dalamnya, lampiran pada suatu node graf, atau pada satu koneksi yang ditarik komponennya, seharusnya berada.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
graphNodestringtidakNode graf yang menjadi tujuan lampiran.
releasestringtidakRelease yang grafnya memuat node tersebut, sebagai path relatif terhadap root workspace.
connectionConnectionCoordinatetidakSatu koneksi yang ditarik oleh komponen node graf, jika lampiran ditujukan untuk koneksi tersebut dan bukan untuk node: jawaban kemudian menyebutkan container features milik koneksi itu sendiri dalam dokumen yang disebutkan oleh field document-nya, field yang wajib di sini. Dalam Aggregate, itu adalah entri koneksi dalam dokumen tempat node ditulis, dan ditolak untuk koneksi yang ditarik oleh Release, yang tidak memiliki entri di Aggregate. Dalam Release, itu adalah entri per-edge di bawah entri milik Release sendiri untuk node tersebut, baik Release sudah menulis entri untuk koneksi itu maupun belum, dan ditolak jika Release tidak menulis entri untuk node tersebut. Koneksi yang ditarik oleh Feature ditolak di kedua dokumen, karena lampiran hanya ditulis pada koneksi yang ditarik oleh komponen atau oleh Release.

Properti tambahan tidak diizinkan.

ConnectionAtPositionParams

Menjawab entri koneksi mana yang memuat suatu posisi dalam Aggregate atau Release: node graf dan koneksinya, dalam bentuk yang diterima oleh permintaan kandidat dan container, atau alasan tidak ada koneksi yang ditulis di sana. Entri tersebut adalah entri tempat lampiran ditulis — entri yang digunakan komponen untuk menarik koneksi, di bawah alias koneksi, dalam dokumen tempat komponen ditulis, serta setiap entri per-edge yang ditulis Release — masing-masing di tempat yang dicatat oleh graf terkompilasi, sehingga apakah suatu kunci merupakan koneksi tidak pernah ditentukan dari namanya.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
filestringtidakDokumen tempat posisi berada: Release, atau dokumen yang dicatat oleh graf Release sebagai tempat komponen ditulis — Aggregate-nya, atau dokumen modul yang diimpor oleh Aggregate tersebut. Dokumen ini dibaca terlebih dahulu dari apa yang disimpan sesi untuknya, dan dari disk jika tidak ada.
positionPositiontidakSuatu tempat dalam dokumen: baris dan offset karakter di dalamnya, keduanya dihitung mulai dari nol. Offset diukur dalam satuan encoding yang disepakati sesi saat dibuka, yaitu UTF-16 kecuali klien meminta yang lain.
releasestringtidakRelease yang graf terkompilasinya mencatat koneksi, sebagai path relatif terhadap root workspace. Nilai ini juga wajib untuk posisi dalam Aggregate, karena node graf dan koneksi hanya ada pada graf yang telah dikompilasi.

Properti tambahan tidak diizinkan.

ConnectionCoordinate

Satu koneksi yang digambar oleh komponen sebuah node graf, dialamatkan melalui socket tempat koneksi itu dihubungkan dan alias yang dibawanya dalam socket tersebut, serta dokumen tempat lampiran pada koneksi itu ditulis. Sebuah koneksi membawa lampiran yang mengisi slot yang dideklarasikan socket-nya, dan Aggregate maupun Release dapat menuliskannya.

PropertiJenisWajibDeskripsi
socketstringyaSocket dependensi tempat koneksi dihubungkan.
aliasstringyaNama yang dibawa koneksi di dalam socket-nya.
documentconst “aggregate” atau const “release”tidakDokumen tempat lampiran pada koneksi ditulis. Himpunannya tertutup, dan nilai di luarnya ditolak. Nilai yang diizinkan: "aggregate" — Aggregate, tempat pengembang menulis lampiran pada entri koneksi. "release" — Release, tempat operator menulis lampiran pada entri per-edge untuk koneksi tersebut.

Properti tambahan diizinkan.

SetActiveReleaseParams

Mencatat sebuah Release sebagai default workspace dengan menulis penanda di direktori .aggrega: pilihan yang dilaporkan aggrega/activeRelease membaca penanda tersebut setelah Release authoring dari konfigurasi. Penanda ditulis di dalam workspace dan tidak di tempat lain: jika direktori .aggrega atau penanda tersebut berupa tautan yang mengarah ke luar workspace, baik tempat tujuannya sudah ada maupun belum, penulisan ditolak dengan menyebutkan tautan tersebut dan tidak ada yang ditulis. Jawabannya adalah jawaban yang diberikan aggrega/activeRelease setelah penanda ditulis, sehingga jawaban itu menyebutkan Release lain jika Release authoring dari konfigurasi lebih diutamakan daripada penanda.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
releasestringtidakRelease yang akan dicatat, sebagai path relatif terhadap root workspace. Path absolut, dan path yang naik keluar dari workspace, ditolak; demikian pula path yang mengarah keluar melalui tautan, kecuali konfigurasi workspace menyebutkan Release tersebut.

Properti tambahan tidak diizinkan.

EditDocumentParams

Menerapkan satu suntingan terbatas pada dokumen yang dibawa workspace: satu entri ditambahkan di bawah satu kontainer, atau satu skalar ditetapkan. Dokumen yang tersusun diperiksa terhadap skema jenisnya dan baru ditulis ke disk jika lolos, sehingga metode ini tidak dapat menulis apa yang ditolak skema authoring. Suntingan yang ditolak membiarkan berkas tetap sama persis byte demi byte.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
filestringtidakDokumen yang akan disunting.
editconst “add-component” atau const “attach-feature” atau const “wire-edge” atau const “set-value”tidakEdit mana yang diterapkan. Nilai yang diizinkan: "add-component" — Menambahkan instance komponen di bawah kontainer components: name adalah nama instance, value adalah Component yang dimintanya. "attach-feature" — Melampirkan Feature ke node yang disebutkan permintaan: name adalah nama instance lampiran, value adalah Feature yang dimintanya. "wire-edge" — Menyambungkan koneksi dependensi dari node yang disebutkan permintaan, di dalam socket: name adalah alias yang digunakan untuk mengalamatkan koneksi, value adalah node yang ditunjuknya. "set-value" — Menetapkan satu nilai pada node yang disebutkan permintaan: name adalah kunci nilai, value adalah skalar.
nodestring[]tidakPath melalui dokumen menuju entri yang sedang disunting.
socketstringtidakSocket yang menjadi pokok suntingan, untuk suntingan yang menghubungkannya.
namestringtidakNama yang ditulis oleh suntingan.
valueanytidakNilai yang ditulis oleh suntingan, dalam bentuk apa pun yang diambil suntingan tersebut.
dryRunbooleantidakApakah menjawab dengan dokumen yang tersusun alih-alih menuliskannya.

Properti tambahan tidak diizinkan.

ConfigInitParams

Membuat dokumen konfigurasi awal. Secara default metode ini menulis berkas tingkat mesin, karena registry dan identitas yang dipercaya padanya merupakan perangkat tingkat mesin. Metode ini menghubungi registry yang disebutkan untuk membaca kebijakan kepercayaan yang diumumkannya; registry yang tidak mengumumkan apa pun dilaporkan demikian dan pembuatan tetap berlanjut, dengan baseline bawaan untuk hub resmi dan tanpa kebijakan untuk registry lainnya.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
registrystringtidakRegistry yang konfigurasinya akan dibuat.
forcebooleantidakApakah menimpa dokumen konfigurasi yang sudah ada.
globalbooleantidakMenulis file konfigurasi tingkat mesin, yang merupakan default metode ini.
workspacebooleantidakMenulis file konfigurasi milik workspace ini alih-alih file tingkat mesin.
dryRunbooleantidakApakah menjawab dengan isi dokumen alih-alih menuliskannya, untuk klien yang memelihara model dokumennya sendiri.

Properti tambahan tidak diizinkan.

ConfigCaptureParams

Membekukan konfigurasi yang telah di-resolve ke dalam dokumen milik workspace ini sendiri, sehingga workspace menjadi mandiri. Metode ini selalu menulis berkas workspace tersebut dan tidak menghubungi apa pun di luarnya.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
allPluginsbooleantidakApakah membekukan setiap plugin yang terpasang alih-alih hanya plugin yang dikonfigurasi oleh workspace itu sendiri.

Properti tambahan tidak diizinkan.

ImportParams

Mengonversi deskripsi sumber asing menjadi dokumen penulisan draf, dan menulis di sampingnya .aggrega-import.json, catatan tentang apa yang ditulis oleh impor — target yang diberikan kepadanya, jika diberikan, snapshot katalog yang dibacanya, jika ada yang dibaca, setiap berkas draf, dan setiap kunci dari Aggregate atau Release draf pada setiap kedalaman — yang dibaca oleh sinkronisasi berikutnya. Sumber yang tidak dapat dikonversi sepenuhnya merupakan jawaban, bukan kegagalan: draf yang berhasil dihasilkan ditulis dan temuan menyebutkan apa yang tidak dapat dikonversi — kecuali di bawah sync, yang tidak menulis apa pun dari konversi yang terhenti.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
sourcestringtidakBerkas atau direktori yang akan dikonversi, sebagai path absolut atau path relatif terhadap root workspace; permintaan tanpa nilai ini ditolak. Nilai ini dibaca di tempatnya, di dalam workspace maupun tidak, dan direktori dibaca menjadi berkas-berkas di dalamnya yang dipilih oleh pola berkas yang dideklarasikan importer.
outputDirstringtidakDirektori di bawah workspace tempat draf ditulis, relatif terhadap root workspace; nilai absolut, atau nilai yang mengarah keluar dari workspace sebagaimana tertulis atau melalui tautan, ditolak. Jika tidak ada, penulisan dilakukan di bawah root workspace, tempat konversi yang sama yang dijalankan di terminal tanpa menyebut tujuan menulis. Setiap path draf relatif terhadap direktori yang disebut jawaban sebagai outputDir, termasuk di bawah dryRun.
formatstringtidakFormat sumber. Jika tidak ada, konversi yang menentukannya.
targetstringtidakKapabilitas provider, seperti compose atau helm — kata yang diikat oleh spec.capability sebuah Recipe — untuk membuat draf Manifest di samping draf-draf tersebut, sebagai manifest.yaml: setiap tipe component dan tipe feature yang dibutuhkan draf, termasuk tipe-tipe dari Aggregate katalog yang disusun oleh Aggregate draf, dipetakan ke Recipe atau resep feature dengan kapabilitas tersebut yang ditawarkan katalog workspace untuknya — satu-satunya yang ada, atau di antara beberapa, yang dinamai sesuai tipe tersebut — tipe yang tidak memilikinya, atau memiliki beberapa tetapi tidak ada yang dinamai demikian, dibiarkan tidak terpetakan dengan temuan peringatan yang menyebutkannya, pemetaan yang dibuat sendiri oleh importer dipertahankan jika katalog menawarkannya untuk tipe dan kapabilitas tersebut dan dibuang dengan temuan peringatan jika tidak, dan spec.manifest dari Release draf diatur ke Manifest tersebut. Kapabilitas yang tidak diikat oleh Recipe mana pun di katalog ditolak sebelum konversi berjalan, dan tidak ada yang ditulis. Jika tidak ada, tidak ada Manifest yang dibuat drafnya, kecuali di bawah sync, yang membuat draf untuk target yang disebut catatan impor sebelumnya; sync yang menyebut target membuat draf untuk target itu, dan catatan kemudian menyebutnya.
dryRunbooleantidakApakah akan menjawab dengan konten setiap berkas yang akan ditulis permintaan alih-alih menulisnya. Setiap perilaku lain sama dengan penulisan, sehingga permintaan yang akan ditolak oleh penulisan juga ditolak di bawahnya; dengan sync, jawabannya berisi apa yang akan ditulis sync dan setiap bagian yang akan menyimpang.
syncbooleantidakApakah akan memperbarui apa yang dibuat drafnya oleh impor sebelumnya di bawah outputDir agar sesuai dengan sumber, alih-alih menulis draf secara utuh. Hanya apa yang ditulis impor yang berubah, sebagaimana dicantumkan catatan di samping draf: bagian yang tidak diubah sumber tetap seperti di disk, diedit maupun tidak; bagian yang diubah, dihapus, atau ditambahkan oleh sumber ditulis ulang, dihapus — berkas draf dihapus seluruhnya — atau ditambahkan, jika yang ada di disk adalah apa yang terakhir ditulis impor; dan segala hal lainnya, kunci yang ditambahkan penulis — termasuk environment yang ditinggalkan Release draf untuk penulisnya — atau komentar yang tidak ditulis tepat di atas kunci draf, tetap byte demi byte. Sync yang akan mengubah atau menghapus apa yang diedit atau ditambahkan penulis, atau menambahkan bagian di tempat penulis sudah menulisnya, ditolak dengan menyebutkan setiap bagian, demikian pula sync atas Aggregate yang tidak tercantum dalam catatan mana pun; dalam kedua kasus tidak ada yang ditulis. Tanpanya, permintaan yang draf-drafnya akan ditulis menimpa Aggregate yang sudah ada di outputDir ditolak, termasuk di bawah dryRun.
upgradebooleantidakApakah akan mengambil snapshot katalog terbaru yang diterbitkan registry bawaan workspace dan mengimpor berdasarkan snapshot tersebut, serta menyimpannya sejak saat itu sebagai pengganti snapshot yang dimiliki workspace atau snapshot yang disebutkan oleh catatan di samping draf; tidak mengubah apa pun jika workspace menyebutkan folder katalog, dan ditolak saat offline.
answersstringtidakFile jawaban tempat nilai-nilai yang dibiarkan kosong oleh draf dan tidak dapat dimuat oleh sumber mana pun dibaca dan ditulis, relatif terhadap root workspace; nilai absolut, atau nilai yang mengarah ke luar workspace sebagaimana tertulis atau melalui tautan, ditolak. File ini memuat, di bawah path setiap file draf, path kunci di dalam dokumen tersebut beserta jawabannya, dan jawaban-jawaban itu ditulis ke dalam draf. Jika tidak ada, yang dibaca adalah file yang disebutkan oleh catatan di samping draf, atau jika tidak, import-answers.yaml di samping file sumber atau di dalam direktori sumber. Jawaban untuk sebuah secret menyebutkan asal secret tersebut — nama variabel, ${NAME}, atau nama sebuah Kubernetes Secret — dan apa pun selain itu ditolak tanpa ada yang ditulis. Tidak ada yang ditanyakan: setiap nilai yang masih terutang menjadi entri dalam owed jawaban dan temuan peringatan yang menyebutkan file draf, kuncinya, dan apa nilai itu, jawabannya dikirim sebagai answered, dan jika draf ditulis, temuan terakhir menyatakan berapa banyak yang masih terutang dan di mana. Jika draf mencakup Release, tidak ada yang terutang, dan konversi selesai, dependensinya kemudian di-pull sambil menulis lockfile-nya, dan pull yang gagal menutup temuan dengan menyebutkan alasannya, dengan draf tetap ditulis; dalam mode offline tidak ada yang di-pull dan sebuah temuan menyebutkan pull yang perlu dijalankan. Jawaban untuk kunci yang tidak dibiarkan kosong oleh draf ini tetap disimpan di file dan tidak diterapkan, sehingga satu file jawaban melayani setiap target.
answeredImportAnswered[]tidakJawaban untuk nilai-nilai yang didaftarkan oleh owed jawaban, masing-masing menyebutkan file draf dan kunci-kuncinya sebagaimana owed menyebutkannya. Setiap jawaban dinilai, disimpan di file jawaban, dan ditulis ke dalam draf persis seperti jawaban yang diketik di terminal: jawaban untuk sebuah secret menyebutkan asal secret tersebut — nama variabel, ${NAME}, atau nama sebuah Kubernetes Secret — dan jawaban yang tidak demikian tidak disimpan maupun ditulis, dan nilainya tetap terutang dengan alasannya sebagai secretAdvice-nya. Nilai yang sudah dijawab oleh file jawaban dijawab dari file tersebut; jawaban kosong, atau jawaban yang menyebutkan nilai yang tidak terutang oleh draf, tidak diterapkan. Kirimkan dengan sync setelah draf ditulis, karena permintaan yang bukan sync ditolak atas Aggregate yang sudah ada di outputDir. Di bawah dryRun, yang tidak menyimpan jawaban apa pun, dan di bawah sync yang konversinya berhenti, yang tidak menulis apa pun, tidak ada jawaban terkirim yang diterapkan.

Properti tambahan tidak diizinkan.

ScaffoldEntityParams

Membuat draf dokumen awal untuk sebuah jenis entitas, atau menulis salah satu contoh yang dapat dijalankan dari dokumentasi ke dalam direktori baru di workspace, atau mencantumkan daftarnya. Pembuatan draf menurunkan kerangka dari himpunan skema yang dibawa biner, sehingga tidak ada yang dibaca dari workspace dan tidak ada yang ditulis — jawabannya berupa teks, dan ke mana teks itu pergi ditentukan oleh klien. Menulis contoh hanya menulis direktori baru dan tidak ada yang lain, dan contoh dibaca dari bundel dokumentasi bertanda tangan yang dipublikasikan untuk versi biner, atau yang terbaru yang dipublikasikan sebelumnya jika tidak ada, yang diverifikasi terhadap kebijakan tanda tangan workspace sebelum disimpan atau dibaca: bundel yang tidak lolos verifikasi ditolak, dan saat offline hanya salinan yang sudah ada di cache yang dibaca. Permintaan yang mengirimkan field dari dua bentuk sekaligus — kind dengan example atau list, list dengan example, name dengan example atau list, dir tanpa example — ditolak sebelum apa pun dibaca.

PropertiJenisWajibDeskripsi
workspaceRootstringtidakPath absolut workspace. Pembuatan draf tidak membacanya. Menulis atau mencantumkan contoh memerlukannya: konfigurasi workspace menentukan dari mana dokumentasi diambil dan tanda tangan apa yang harus dibawanya, dan contoh ditulis di dalamnya.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
kindstringtidakJenis entitas yang akan dibuat drafnya, dinamai dengan token huruf kecilnya, seperti component, aggregate, release, recipe, atau featurerecipe — token yang dicantumkan aggrega/getSchema untuknya.
namestringtidakNama yang akan ditulis ke dalam dokumen draf. Hanya dikirim bersama kind.
examplestringtidakContoh yang dapat dijalankan yang akan ditulis, berdasarkan nama yang diberikan daftar contoh kepadanya. Dikirim sebagai pengganti kind.
listbooleantidakApakah akan menjawab dengan setiap contoh yang dapat dijalankan yang dipublikasikan dokumentasi, tanpa menulis apa pun. Dikirim tanpa example dan tanpa kind.
dirstringtidakDirektori baru tempat contoh akan ditulis, relatif terhadap root workspace; jika tidak ada, contoh ditulis ke direktori yang dinamai sesuai contoh di sana. Direktori tersebut belum boleh ada atau harus kosong: direktori yang berisi apa pun ditolak dan dibiarkan apa adanya, dan nilai absolut, atau nilai yang mengarah keluar dari workspace sebagaimana tertulis atau melalui tautan, ditolak sebelum apa pun dibaca. Hanya dikirim bersama example.

Properti tambahan tidak diizinkan.

LintParams

Memeriksa konvensi penerbitan katalog pada satu entitas, pada segala hal yang dijangkau closure sebuah Release, atau pada segala hal di bawah direktori katalog yang dikonfigurasi. Tidak ada yang ditulis dalam mode apa pun. Tanpa menyebut entitas maupun Release, seluruh katalog diperiksa: di workspace yang konfigurasinya tidak memberikan direktori katalog Release sendiri, sekali atas direktori workspace; di workspace yang menyebut Releases di bawah workspace.releases, sekali untuk setiap Release atas direktori yang dibaca Release tersebut, tidak pernah atas semuanya sekaligus.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
entitystringtidakSatu dokumen entitas yang akan diperiksa.
releasestringtidakRelease yang closure-nya akan diperiksa, sebagai path relatif terhadap root workspace.
prePublishbooleantidakApakah akan membandingkan setiap entitas dengan versi yang diterbitkan sebelumnya, yang menjangkau registry yang dikonfigurasi.

Properti tambahan tidak diizinkan.

PluginAddParams

Memasang plugin ke soket yang dikonfigurasi oleh workspace. Metode ini menghubungi registry untuk menyelesaikan kueri menjadi satu plugin dan menyematkan versinya. Satu-satunya keputusan yang akan diminta oleh terminal — menerima kapabilitas yang dideklarasikan oleh plugin ekstensi perintah — datang sebagai field di sini, sehingga klien bertanya kepada siapa pun yang mengendalikannya dan antarmuka ini tidak pernah menunggu prompt.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
typestringtidakSoket tempat plugin dipasang.
querystringtidakApa yang diselesaikan menjadi satu plugin.
capabilitystringtidakKapabilitas yang menjadi tujuan pemasangan, jika soket membawa beberapa kapabilitas.
rolestringtidakPeran tempat pemasangan dijalankan, yang menentukan apa yang boleh dihasilkannya.
globalbooleantidakTulis file konfigurasi tingkat mesin.
workspacebooleantidakTulis file konfigurasi milik workspace ini sendiri.
acceptCapabilitiesbooleantidakApakah pemanggil menerima kapabilitas yang dideklarasikan oleh plugin ekstensi perintah.
dryRunbooleantidakApakah akan menjawab dengan konten dokumen konfigurasi alih-alih menuliskannya.

Properti tambahan tidak diizinkan.

PluginRemoveParams

Melepas plugin dari soket yang dikonfigurasi oleh workspace.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
typestringtidakSoket tempat plugin terpasang.
querystringtidakPemasangan mana yang akan dihapus.
globalbooleantidakTulis file konfigurasi tingkat mesin.
workspacebooleantidakTulis file konfigurasi milik workspace ini sendiri.

Properti tambahan tidak diizinkan.

PluginSyncParams

Menyelaraskan catatan milik mesin pada entitas Plugin dengan modul yang dirujuknya. Metode ini menulis ulang catatan tersebut dan membawa setiap byte lain dari dokumen tanpa perubahan.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
entitystringtidakDokumen entitas Plugin yang akan diselaraskan.
pluginstringtidakModul plugin tempat catatan dibaca.

Properti tambahan tidak diizinkan.

PluginGenCatalogParams

Menghasilkan dokumen katalog Plugin dari metadata yang dideklarasikan sendiri oleh plugin ditambah overlay yang ditulis penulis. Pembuatan ulang atas input yang tidak berubah menghasilkan dokumen yang identik byte demi byte.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
fromEmbeddedbooleantidakApakah akan membaca metadata dari plugin yang sudah dibawa oleh biner.
pluginstringtidakModul plugin tempat metadata dibaca.
outputDirstringtidakDirektori di bawah workspace tempat dokumen ditulis.
overlaystringtidakDokumen yang ditulis penulis, yang kontennya digabungkan di atas metadata yang dihasilkan.
dryRunbooleantidakApakah akan menjawab dengan konten dokumen alih-alih menuliskannya.

Properti tambahan tidak diizinkan.

ExplainErrorParams

Menguraikan kode yang dibawa sebuah temuan menjadi apa yang dideklarasikan kompiler tentang kondisi tersebut beserta entri terpublikasi yang mengajarkan perbaikan penulisannya. Metode ini mengambil dokumentasi terpublikasi jika workspace tidak memiliki salinannya; jika tidak dapat diambil, metode ini tetap menjawab apa yang dideklarasikan biner, dan menyebutkan mengapa penjelasannya tidak ada.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
codestringtidakKondisi yang akan diuraikan, disebut dengan kode yang dibawa temuan atau kode pendeknya.

Properti tambahan tidak diizinkan.

GetSchemaParams

Menjawab dengan skema suatu jenis, atau — jika tidak ada jenis yang disebut — dengan jenis-jenis yang dapat disebut. Metode ini menjawab untuk biner yang sedang berjalan, bukan untuk salinan mana pun yang terpasang di tempat lain, sehingga tidak memerlukan workspace dan tidak membacanya.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootAcceptedtidakPath absolut sebuah workspace. Subjek metode ini bukan workspace — metode ini menjawab dari apa yang dibawa oleh biner itu sendiri — sehingga field ini diterima tetapi tidak dibaca. Field ini diizinkan karena klien dapat mengirimkannya secara seragam pada setiap permintaan tanpa perlu mengetahui metode mana yang memakainya.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
kindstringtidakJenis yang skemanya dijadikan jawaban. Jika tidak ada, yang dijawab adalah jenis-jenis yang dapat disebut.

Properti tambahan tidak diizinkan.

SkillsInstallParams

Menulis skill asisten yang tertanam dalam biner ke folder skill setiap asisten yang disebutkan permintaan atau, untuk permintaan global yang tidak menyebutkan satu pun, setiap asisten yang ditemukan di mesin ini. Tanpa global, permintaan ini menulis ke folder proyek setiap asisten di dalam workspace yang disebutkan permintaan, dan setiap path yang akan ditulisnya di sana dibatasi pada workspace tersebut; dengan global, permintaan ini menulis ke folder per pengguna setiap asisten di bawah direktori home. Setiap target diperiksa sebelum apa pun ditulis, sehingga penolakan membiarkan setiap folder seperti semula.

PropertiJenisWajibDeskripsi
workspaceRootWorkspaceRootSubjectyaPath absolut workspace yang menjadi sasaran permintaan ini. Path ini adalah subjek permintaan: daemon me-resolve-nya sebelum metode dijalankan, dan permintaan yang menghilangkannya atau menuliskannya sebagai apa pun selain string akan ditolak.
workDoneTokenProgressTokentidakNilai yang dibuat pemanggil agar dapat mencocokkan notifikasi kemajuan dengan panggilan yang memintanya. Nilai ini dipantulkan kembali tanpa diubah pada setiap notifikasi, sehingga pemanggil dapat membandingkannya dengan nilai yang dikirimnya. Nilai ini diterima pada setiap permintaan, dan permintaan yang mengirimkannya dalam sesi yang tidak mendeklarasikan kemampuan kemajuan akan ditolak.
agentsstring[]tidakAsisten yang akan dipasangi skill, berdasarkan pengidentifikasi yang dilaporkan daftar. Permintaan proyek yang tidak menyebutkan satu pun ditolak. Permintaan global yang tidak menyebutkan satu pun memasang skill untuk asisten yang ditemukan di mesin ini, yaitu setiap asisten yang folder konfigurasinya berada di direktori home atau yang perintahnya ada di PATH, dan ditolak tanpa menulis apa pun jika tidak ada yang ditemukan. Pengidentifikasi yang tidak diketahui folder skill-nya ditolak, dengan menyebutkan namanya, dan pengidentifikasi yang diberikan dua kali dipasang sekali.
globalbooleantidakMenulis ke folder skill per pengguna setiap asisten di bawah direktori home, yang dibacanya di setiap proyek, alih-alih ke folder proyeknya di workspace.

Properti tambahan tidak diizinkan.

ServerCapabilities

Apa yang akan dilakukan daemon dalam sesi ini, yang disepakati berdasarkan apa yang dinyatakan klien dapat ditanganinya.

PropertiJenisWajibDeskripsi
positionEncodingstringyaEncoding yang digunakan untuk menyatakan setiap posisi dalam sesi ini.
workDoneProgressbooleantidakApakah daemon akan mengirim notifikasi progres dalam sesi ini. Hanya ada jika klien menyatakan dapat menerimanya.

Properti tambahan tidak diizinkan.

ClosureEntity

Satu entitas yang menjadi dependensi sebuah Release, pada versi yang ditetapkan oleh resolusi.

PropertiJenisWajibDeskripsi
uristringyaReferensi tempat entitas diresolusi.
versionstringyaVersi yang ditetapkan.
kindstringtidakJenis entitas.
sourcestringtidakAsal entitas yang diambil oleh proses yang menghasilkan entri ini, dengan kata yang sama yang dicetak aggrega pull --detail untuknya: fetched-fresh (diambil dari registry selama proses tersebut), cache-reuse (salinan yang sudah ada di cache, digunakan kembali tanpa pengambilan), local (ditemukan di sistem berkas lokal, seperti direktori katalog), in-binary (salinan di dalam biner compiler), atau external (Aggregate atau Manifest milik Release itu sendiri, dibaca dari berkas atau entri yang disebut Release alih-alih diresolusi sebagai salah satu dependensinya; Aggregate yang diambil proses dari registry justru bernilai fetched-fresh). Ada pada entri laporan resolusi dependensi, tempat properti ini menjelaskan apa yang dilakukan proses tersebut di mesin ini, dan tidak ada pada daftar dependensi terresolusi sebuah Release, yang menjelaskan apa saja dependensi Release tersebut. Lockfile tidak mencatat sumber. Dihilangkan untuk entitas yang sumbernya tidak dicatat oleh proses.

Properti tambahan tidak diizinkan.

ToolchainCorePlugin

Satu plugin yang dibawa oleh compiler itu sendiri, beserta versinya yang digunakan.

PropertiJenisWajibDeskripsi
pluginstringyaReferensi plugin.
versionstringyaVersi yang digunakan.

Properti tambahan tidak diizinkan.

ToolchainReport

Compiler yang melakukan resolusi, beserta plugin yang dibawanya.

PropertiJenisWajibDeskripsi
compilerVersionstringyaVersi compiler yang melakukan resolusi.
corePluginsToolchainCorePlugin[]tidakPlugin yang dibawa compiler, beserta versi masing-masing yang digunakan.

Properti tambahan tidak diizinkan.

DependencyResolutionReport

Apa yang di-pin dan diperoleh oleh sebuah resolusi dependensi.

PropertiJenisWajibDeskripsi
lockfilestringyaLockfile yang ditulis resolusi, atau lockfile yang dibandingkan oleh verifikasi.
verifiedbooleantidakApakah permintaan berupa verifikasi, yang membandingkan lockfile tercatat dan tidak menulis lockfile, catatan kepercayaan plugin, maupun entity.lock.
entitiesClosureEntity[] atau nullyaEntitas yang di-pin oleh resolusi, atau dibandingkan oleh verifikasi.
librariesClosureEntity[] atau nullyaPustaka yang di-pin oleh resolusi, atau dibandingkan oleh verifikasi.
pluginsClosureEntity[] atau nullyaPlugin yang di-pin oleh resolusi, atau dibandingkan oleh verifikasi.
sourceArtifactsintegeryaJumlah artefak sumber yang diperoleh.
trustedPluginsintegeryaJumlah plugin yang di-pin yang membawa tanda tangan terverifikasi.
toolchainToolchainReporttidakCompiler yang melakukan resolusi, beserta plugin yang dibawanya.
externalInputsintegeryaJumlah input eksternal yang dikonsumsi render yang berhasil diperoleh.
incompleteExternalInputsstringtidakInput eksternal mana yang tidak dapat diperoleh, jika ada yang tidak dapat diperoleh.

Properti tambahan tidak diizinkan.

BuildNotice

Satu hal yang ingin diberitahukan build kepada pemanggil, yang bukan temuan tentang dokumen maupun kegagalan.

PropertiJenisWajibDeskripsi
classstringyaJenis pemberitahuan ini.
textstringyaIsi pemberitahuan.

Properti tambahan tidak diizinkan.

CacheScope

Seberapa jauh jangkauan sebuah jawaban cache. Dua kelas cache digunakan bersama oleh setiap proyek di mesin, sehingga setiap jawaban cache menyebutkan kelas mana yang disentuhnya — jika tidak, sesi yang dibuka atas satu workspace akan dibaca seolah hanya melaporkan tentang workspace tersebut.

PropertiJenisWajibDeskripsi
machineWideClassesstring[] atau nullyaKelas cache yang disentuh jawaban ini yang digunakan bersama oleh setiap proyek di mesin.
workspaceRootstringyaWorkspace yang disebut oleh permintaan.

Properti tambahan tidak diizinkan.

CacheElement

Satu hal yang disimpan cache.

PropertiJenisWajibDeskripsi
labelstringyaApa isi entri tersebut.
sizeintegeryaJumlah byte yang ditempatinya.
sizeTextstringyaUkuran yang sama, ditulis dalam bentuk yang mudah dibaca manusia.
digeststringtidakDigest konten yang menjadi kunci entri, jika ada.
notestringtidakKeterangan lain yang perlu disampaikan tentang entri tersebut.

Properti tambahan tidak diizinkan.

CacheClass

Satu cache yang dilaporkan oleh daemon.

PropertiJenisWajibDeskripsi
namestringyaCache yang dimaksud.
reachstringyaApakah cache milik workspace ini atau digunakan bersama di seluruh mesin.
prunablebooleanyaApakah pengambilan kembali ruang cache ini akan dilakukan oleh daemon.
elementsCacheElement[] atau nullyaApa yang disimpan cache.

Properti tambahan tidak diizinkan.

CacheProvenance

Identitas mana saja yang digunakan saat artefak dalam cache diperoleh, dan seberapa luas artefak itu digunakan bersama.

PropertiJenisWajibDeskripsi
identitiesstring[] atau nullyaIdentitas yang diatribusikan pada artefak.
sharedByintegertidakJumlah pemegang yang menggunakan artefak bersama.

Properti tambahan tidak diizinkan.

CacheRemoval

Satu hal yang dihapus oleh pengambilan kembali ruang — atau, dalam daftar hal yang dibiarkan di tempatnya, satu hal yang akan dihapusnya.

PropertiJenisWajibDeskripsi
classstringyaCache tempat hal itu berada.
labelstringyaHal yang dimaksud.
reachstringyaApakah cache tersebut milik workspace ini atau digunakan bersama di seluruh mesin.
sizeintegeryaJumlah byte yang ditempatinya, atau yang ditempatinya sebelum dihapus.
sizeTextstringyaUkuran yang sama, ditulis dalam bentuk yang mudah dibaca manusia.

Properti tambahan tidak diizinkan.

CacheShortfall

Apa yang ditinggalkan oleh pengambilan kembali ruang, dan apa yang dapat mengambilnya kembali, sehingga pemanggil yang membaca angka lebih kecil dari yang diharapkannya mengetahui alasannya alih-alih menduganya.

PropertiJenisWajibDeskripsi
classstringyaCache yang menyimpan hal yang ditinggalkan.
countintegeryaJumlah entri yang ditinggalkan.
sizeintegeryaJumlah byte yang ditempatinya.
sizeTextstringyaUkuran yang sama, ditulis dalam bentuk yang mudah dibaca manusia.
reachstringyaApakah cache tersebut milik workspace ini atau digunakan bersama di seluruh mesin.
reclaimedBystring[] atau nullyaApa yang dapat mengambilnya kembali.

Properti tambahan tidak diizinkan.

CacheCleared

Satu cache yang dikosongkan oleh pembersihan.

PropertiJenisWajibDeskripsi
classstringyaCache yang dikosongkan.
reachstringyaApakah cache milik workspace ini atau digunakan bersama di seluruh mesin.
sizeintegeryaJumlah byte yang diambil kembali darinya.
sizeTextstringyaUkuran yang sama, ditulis dalam bentuk yang mudah dibaca manusia.
heldOpenFilesintegeryaJumlah berkas yang ditinggalkan pembersihan di cache ini karena sedang dibuka oleh proses lain. Hanya Windows yang menolak menghapus berkas yang sedang terbuka, sehingga di sistem lain nilainya nol. Pembersihan berikutnya menghapusnya setelah proses tersebut selesai menggunakannya.
heldOpenBytesintegeryaJumlah byte yang ditempati berkas-berkas tersebut. Jumlah ini tidak dihitung dalam size, yang merupakan ruang yang diambil kembali oleh pembersihan.
heldOpenBytesTextstringyaAngka yang sama, ditulis dalam bentuk yang mudah dibaca manusia.

Properti tambahan tidak diizinkan.

ConfigWriteScope

Dokumen konfigurasi mana yang ditulis dan seberapa jauh jangkauannya. Sebuah permintaan menyebut satu workspace, sehingga jawaban yang tidak menyebutkan apa pun akan dibaca sebagai jawaban tentang workspace tersebut — dan untuk penulisan tingkat mesin, pembacaan itu keliru.

PropertiJenisWajibDeskripsi
configFilestringyaDokumen yang ditulis.
machineWidebooleanyaApakah dokumen tersebut adalah dokumen yang dilalui resolusi setiap workspace di mesin.
workspaceRootstringyaWorkspace yang disebut oleh permintaan.

Properti tambahan tidak diizinkan.

PluginWriteScope

Dokumen konfigurasi mana yang menjadi tempat penulisan perubahan plugin dan seberapa jauh jangkauannya. Default socket ekstensi perintah sendiri adalah dokumen tingkat mesin, sehingga setiap jawaban menyebutkan dokumen mana yang ditulisnya.

PropertiJenisWajibDeskripsi
configFilestringyaDokumen yang ditulis.
machineWidebooleanyaApakah dokumen tersebut adalah dokumen yang dilalui resolusi setiap workspace di mesin.
workspaceRootstringyaWorkspace yang disebut oleh permintaan.

Properti tambahan tidak diizinkan.

CredentialStoreScope

Seberapa jauh jangkauan perubahan kredensial. Penyimpanan digunakan bersama oleh setiap proyek di mesin dan oleh setiap alat lain yang mengakses registry yang sama, sehingga jawaban melaporkan hal itu alih-alih membiarkan pembacaan seolah terbatas pada sesi untuk diduga.

PropertiJenisWajibDeskripsi
machineWidebooleanyaApakah penyimpanan yang disentuh perubahan digunakan bersama di seluruh mesin.
workspaceRootstringyaWorkspace yang disebut oleh permintaan.

Properti tambahan tidak diizinkan.

SkillFolderScope

Seberapa jauh jangkauan pemasangan skill. Permintaan menyebutkan satu workspace, sehingga jawaban yang tidak menyatakan apa pun akan dibaca sebagai berkaitan dengan workspace tersebut — dan untuk folder per pengguna, yang dibaca asisten di setiap proyek, pembacaan itu keliru.

PropertiJenisWajibDeskripsi
machineWidebooleanyaApakah folder yang ditulis adalah folder per pengguna di bawah direktori home, yang dibaca asisten di setiap proyek pada mesin.
workspaceRootstringyaWorkspace yang disebut oleh permintaan.

Properti tambahan tidak diizinkan.

PublicationReach

Seberapa jauh sebuah publikasi menjangkau. Jawaban ini menjangkau sepenuhnya melampaui mesin ini — apa yang dilampirkannya adalah apa yang di-resolve oleh setiap konsumen registry tersebut — sehingga masing-masing menyebutkan setiap registry yang dituju dan apakah panggilan tersebut melampirkan sesuatu di sana.

PropertiJenisWajibDeskripsi
registriesstring[]yaSetiap host registry yang dituju panggilan, masing-masing disebut sekali, dalam urutan pertama kali panggilan menujunya. Panggilan dengan satu referensi menyebutkan satu; dry run menyebutkan tujuan yang akan dituju.
beyondThisMachinebooleanyaApakah panggilan melampirkan sesuatu yang kini disajikan registry kepada pihak lain: konten yang diunggah, tanda tangan, tanggal publikasi, atau penanda deprecation. Bernilai false pada dry run, dan pada panggilan yang mendapati semua yang akan dilampirkannya sudah ada — publikasi yang dijalankan ulang atas versi yang lengkap, atau batch penandatanganan yang setiap referensinya sudah membawa tanda tangan yang terverifikasi.

Properti tambahan tidak diizinkan.

WorkspaceEntityRef

Satu entitas, berdasarkan jenis dan nama, beserta dokumen yang mendeklarasikannya.

PropertiJenisWajibDeskripsi
kindstringyaJenis entitas.
namestringyaNama entitas.
filestringyaDokumen yang mendeklarasikannya, sebagai path relatif terhadap root workspace.

Properti tambahan tidak diizinkan.

SourcedEntityRef

Satu entitas, beserta tempat entitas itu dibaca. Dokumen workspace melaporkan path relatif terhadap workspace; entitas yang di-resolve dari direktori katalog yang dikonfigurasi melaporkan path kosong, karena satu-satunya path yang dimilikinya tidak bermakna bagi klien. Origin menyatakan yang mana di antara keduanya, alih-alih membiarkan path kosong dibaca sebagai field yang tidak diisi siapa pun.

PropertiJenisWajibDeskripsi
kindstringyaJenis entitas.
namestringyaNama entitas.
filestringyaDokumen yang mendeklarasikannya, sebagai path relatif terhadap root workspace, atau kosong jika berasal dari direktori katalog yang dikonfigurasi.
originstringyaTempat entitas dibaca.

Properti tambahan tidak diizinkan.

SocketCandidacy

Satu socket pada sebuah entitas, dan apa yang dapat dihubungkan ke dalamnya.

PropertiJenisWajibDeskripsi
socketstringyaNama socket.
declarationstringyaTempat socket dideklarasikan.
selectorstringyaLabel selector yang harus dipenuhi oleh target.
requiredbooleanyaApakah socket harus dihubungkan agar build dapat dilanjutkan.
targetsWorkspaceEntityRef[] atau nullyaEntitas yang dapat dihubungkan ke dalamnya.

Properti tambahan tidak diizinkan.

SlotCandidacy

Satu slot yang dideklarasikan socket sebuah koneksi, sebagaimana Component konsumen mendeklarasikannya pada socket, beserta Features yang dapat mengisinya pada koneksi tersebut.

PropertiJenisWajibDeskripsi
slotstringyaNama slot, yang merupakan kunci tempat attachment yang mengisinya ditulis dalam features koneksi.
selectorstringyaLabel selector yang harus dipenuhi oleh Feature yang mengisi slot dengan label miliknya sendiri. Kosong jika slot tidak mendeklarasikannya, yang menerima Feature apa pun.
requiredbooleanyaApakah setiap koneksi yang dihubungkan melalui socket harus mengisi slot agar build dapat dilanjutkan.
injectstring[]yaMekanisme pengiriman yang diizinkan slot untuk apa yang mengisinya, dalam urutan Component mendeklarasikannya. Kosong jika tidak ada yang dideklarasikan.
sensitivebooleanyaApakah slot mendeklarasikan bahwa apa yang mengisinya menangani materi rahasia. Ini menandai attachment yang mengisinya dan tidak menolak apa pun.
descriptionstringyaKegunaan slot menurut Component. Kosong jika Component tidak menyatakan apa pun.
candidatesSourcedEntityRef[]yaSetiap Feature yang dapat mengisi slot pada koneksi ini: Feature yang applicability yang dideklarasikannya dipenuhi oleh label node graph, yang menjadi ketentuan bagi setiap attachment yang dibawa node, dan yang label miliknya sendiri memenuhi selector slot. Feature yang applicability atau labelnya tidak dapat dibaca terhadap selector tidak ditawarkan, karena build akan menolaknya alih-alih menerimanya.

Properti tambahan tidak diizinkan.

CatalogEntity

Satu entitas yang dimuat indeks workspace.

PropertiJenisWajibDeskripsi
kindstringyaJenis entitas.
namestringyaNama entitas.
apiVersionstringyaVersi skema yang dideklarasikan dokumen.
descriptionstringyaKegunaan entitas menurut dokumen.
labelsmap of string atau nullyaLabel yang dideklarasikan dokumen.
filestringyaDokumen yang mendeklarasikannya, sebagai path relatif terhadap root workspace.
originstringyaTempat entitas dibaca.

Properti tambahan tidak diizinkan.

CompletionItem

Satu hal yang dapat ditulis pada posisi kursor.

PropertiJenisWajibDeskripsi
labelstringyaTeks yang akan ditulis.
kindintegertidakJenis hal tersebut, sehingga klien dapat memilih ikon untuknya.
detailstringtidakKeterangan singkat yang ditampilkan di samping label.
documentationstringtidakPenjelasan lengkap tentang hal tersebut.
sortTextstringtidakNilai untuk pengurutan, jika berbeda dari label.

Properti tambahan tidak diizinkan.

MarkupContent

Teks yang akan ditampilkan, dan cara markup-nya.

PropertiJenisWajibDeskripsi
kindstringyaCara markup teks.
valuestringyaTeksnya.

Properti tambahan tidak diizinkan.

EntityKindDescriptor

Satu jenis dokumen yang ditulis penulis, yang memasangkan token yang disebutkan permintaan dengan jenis yang dideklarasikan dokumen itu sendiri, serta menyatakan operasi mana yang menerima dokumen dengan jenis tersebut.

PropertiJenisWajibDeskripsi
kindstringyaToken huruf kecil yang disebutkan permintaan, seperti component atau featurerecipe.
documentKindstringyaJenis yang dideklarasikan header dokumen itu sendiri.
acceptedByEntityKindAcceptanceyaOperasi mana yang menerima dokumen dengan jenis ini yang disebutkan sendiri — berdasarkan path-nya, atau berdasarkan namanya untuk inspeksi — tanpa ada hal lain yang dikirim bersamanya. Sebuah anggota bernilai true jika operasi tersebut tidak menolak dokumen karena jenisnya; dokumen yang diterimanya tetap dapat ditolak karena isinya.

Properti tambahan tidak diizinkan.

EntityKindAcceptance

Untuk satu jenis yang ditulis penulis, apakah setiap operasi menerima dokumen dengan jenis tersebut yang disebutkan sendiri. Setiap anggota ada pada setiap entri, sehingga false merupakan pernyataan, bukan penghilangan.

PropertiJenisWajibDeskripsi
singleEntityValidationbooleanyaApakah cakupan entitas tunggal dari aggrega validate — perintah yang diberi path satu dokumen — memeriksa dokumen dengan jenis ini. Jenis yang ditolaknya diperiksa oleh cakupan seluruh katalog atau oleh cakupan Release.
publicationbooleanyaApakah aggrega/publishEntity yang hanya menyebutkan dokumen tersebut memublikasikan dokumen dengan jenis ini. Jenis yang publikasinya juga mengikat executable yang disebutkan di samping dokumen — sebuah Plugin — bernilai false, karena permintaan yang hanya menyebutkan dokumen ditolak untuknya; Manifest dan Release bernilai false karena kedua jenis itu tidak dipublikasikan.
inspectionByNamebooleanyaApakah aggrega/entityDefinition me-resolve sebuah nama menjadi entitas dengan jenis ini, dengan nama dikirim sebagaimana ditulis di tempat satu entitas mereferensikan entitas lain.

Properti tambahan tidak diizinkan.

RegistryTrust

Kebijakan kepercayaan yang diterapkan resolusi pada apa yang disajikan registry.

PropertiJenisWajibDeskripsi
signaturesRequiredbooleanyaApakah artefak dari registry ini harus membawa tanda tangan yang terverifikasi.
verificationSkippedbooleantidakApakah verifikasi sedang dilewati.
advisorybooleantidakApakah verifikasi yang gagal dilaporkan alih-alih menghentikan proses.
anchorstringtidakTrust anchor yang menjadi acuan verifikasi tanda tangan.
keylessIdentitiesintegertidakBerapa banyak identitas penandatangan yang dipercaya untuk registry ini.

Properti tambahan tidak diizinkan.

Registry

Satu registry yang dikonfigurasi. Tidak ada field di sini yang membawa materi kredensial, panjangnya, bentuknya, atau representasi apa pun darinya — keberadaan adalah satu-satunya hal yang dilaporkan, dan itulah yang membuat nilai ini aman untuk ditempelkan ke dalam sebuah issue.

PropertiJenisWajibDeskripsi
hoststringyaHost registry, yang merupakan identitasnya.
namestringtidakAlias ramah yang di-resolve ke host, jika dikonfigurasi.
defaultbooleanyaApakah ini registry yang dituju oleh operasi yang tidak menyebutkan registry.
authStatestringyaApakah kredensial untuk host ini ada di penyimpanan seluruh mesin. Nilai ini dilaporkan meskipun kosong, sehingga pemanggil dapat membedakan “tidak ada kredensial” dari “listing tidak memeriksanya”.
trustRegistryTrustyaKebijakan kepercayaan yang diterapkan resolusi pada apa yang disajikan registry.

Properti tambahan tidak diizinkan.

TrustFetchOutcome

Apa hasil pembacaan kebijakan kepercayaan yang diumumkan sebuah registry. Hasil-hasil ini dipisahkan karena maknanya berbeda: kebijakan yang diumumkan diambil, registry tidak mengumumkan apa pun — yang bukan merupakan kegagalan — baseline bawaan dipasang sebagai gantinya, atau tidak ada pembacaan yang dicoba. Jika tidak ada yang diumumkan, apakah registry dapat dijangkau sama sekali dinyatakan di sampingnya.

PropertiJenisWajibDeskripsi
pinnedbooleanyaApakah kebijakan yang diumumkan diambil.
notAdvertisedbooleantidakApakah registry ditanya dan tidak mengumumkan kebijakan, sehingga operasi berlanjut berdasarkan apa yang dinyatakan permintaan. Registry yang tidak ditanya karena postur offline tidak pernah dilaporkan dengan cara ini. Registry yang tidak dapat dijangkau juga dilaporkan dengan cara ini, karena tidak ada kebijakan yang kembali darinya, dan membawa unreachable di sampingnya; baca unreachable untuk membedakan keduanya.
unreachablebooleantidakApakah registry tidak dapat dijangkau saat kebijakan yang diumumkannya diminta: namanya tidak dapat di-resolve, koneksi ke sana ditolak atau tidak dapat dibuka, atau koneksi aman ke sana tidak dapat dibuat. Nilai ini dibaca dari kegagalan itu sendiri, bukan dari reason, berdiri di samping notAdvertised, dan hanya diatur jika kegagalan menunjukkan registry tidak pernah dijangkau; registry yang menjawab — tanpa kebijakan, atau dengan kegagalan — membiarkannya tidak ada.
baselinebooleantidakApakah baseline bawaan dipasang karena tidak ada kebijakan yang diumumkan yang diambil, yang hanya dimiliki hub resmi. Nilai ini berdiri di samping notAdvertised jika hub ditanya dan tidak mengumumkan apa pun, dan sendirian jika postur offline mencegah hub ditanya.
skippedbooleantidakApakah tidak ada pembacaan yang dicoba, karena kebijakan yang dinyatakan menggantikannya atau permintaan tidak memintanya.
identitiesintegertidakBerapa banyak identitas penandatangan yang dibawa kebijakan yang diumumkan.
reasonstringtidakMengapa kebijakan yang diumumkan tidak diambil: apa yang dilakukan endpoint registry, atau penolakan offline yang mencegahnya ditanya.

Properti tambahan tidak diizinkan.

SkippedRepo

Satu repositori yang dilewati oleh penelusuran indeks, beserta alasannya.

PropertiJenisWajibDeskripsi
repostringyaRepositori yang dilewati.
reasonstringyaMengapa dilewati.

Properti tambahan tidak diizinkan.

DeprecationNote

Satu penanda deprecation yang ditemui penelusuran indeks, dan apa yang dilakukannya terhadap penanda itu. Penanda yang dihormati dan penanda yang ada tetapi ditolak dilaporkan dengan kedudukan yang sama, sehingga mencatat banyak penanda tidak berlalu diam-diam sementara menolak satu penanda justru mencolok.

PropertiJenisWajibDeskripsi
repostringyaRepositori tempat penanda berada.
versionstringyaVersi yang dicakup penanda.
recordedbooleanyaApakah tanda tangan penanda itu sendiri terverifikasi, sehingga indeks membawanya.
severityconst “warning” atau const “error” atau const “retracted”tidakSeberapa kuat penanda berbicara. Nilai yang diizinkan: "warning" — Di-deprecate, pada tingkat yang lebih ringan dari dua tingkat anjuran: tetap dipilih ketika versi dipilih. "error" — Di-deprecate, pada tingkat yang lebih kuat dari dua tingkat anjuran: tetap dipilih ketika versi dipilih. "retracted" — Ditarik: dikecualikan ketika versi dipilih.
reasonstringtidakAlasan versi tersebut usang.

Properti tambahan tidak diizinkan.

HostUpdate

Apa yang dilakukan penyegaran indeks untuk satu registry.

PropertiJenisWajibDeskripsi
hoststringyaHost registry yang disegarkan.
indexedintegeryaBerapa banyak rekaman yang ditulis.
deprecationsExaminedbooleanyaApakah penelusuran mencari penanda deprecation sama sekali. Nilai ini terpisah dari hitungan karena “registry ini tidak menerbitkan satu pun” dan “proses ini tidak punya dasar untuk menilainya” adalah fakta yang berbeda.
deprecationsRecordedintegeryaBerapa banyak penanda yang dihormati.
skippedSkippedRepo[] atau nullyaRepositori yang dilewati penelusuran.
deprecationsDeprecationNote[] atau nullyaPenanda yang ditemui penelusuran.
readsRetriedintegeryaBerapa banyak pembacaan dalam penelusuran yang ditolak atau diputus di tengah jalan oleh registry dan diminta ulang, dengan setiap pembacaan dihitung sekali berapa pun percobaan yang dibutuhkan dan terlepas dari apakah kemudian berhasil; nol jika tidak ada. Penelusuran yang semua pembacaannya pada akhirnya berhasil tidak mencantumkan repositori apa pun di bawah skipped, sehingga hitungan inilah yang menunjukkan seberapa dekat penelusuran itu dengan melewatkan satu repositori. Minimum: 0.
errorstringtidakApa yang gagal untuk host ini, sehingga penelusuran atas beberapa host melaporkan mana yang gagal tanpa pemanggil perlu mengkorelasikan apa pun.
unreachablebooleantidakApakah registry ini tidak dapat dijangkau: namanya tidak dapat di-resolve, koneksi ke sana ditolak atau tidak dapat dibuka, atau koneksi aman ke sana tidak dapat dibuat. Nilai ini dibaca dari kegagalan itu sendiri, bukan dari error, hanya diatur di samping error, dan hanya jika kegagalan menunjukkan registry tidak pernah dijangkau; registry yang menjawab, apa pun jawabannya, membiarkannya tidak ada.

Properti tambahan tidak diizinkan.

PublishedVersion

Satu versi yang dimiliki indeks untuk sebuah referensi: digest manifest yang di-resolve dari tag-nya saat indeks dibangun; jika kebijakan kepercayaan yang digunakan saat indeks dibangun memverifikasi tanda tangan versi itu sendiri, penandatangan hasil verifikasinya; dan, jika ada yang mencatatnya, kapan versi itu diterbitkan, beserta sumber yang menyatakannya. Penandatangan tidak ada untuk versi tanpa tanda tangan, untuk versi yang tidak satu pun tanda tangannya terverifikasi, dan jika kebijakan itu tidak memasang kunci publik maupun identitas tepercaya atau menonaktifkan verifikasi tanda tangan. Tidak satu pun dari itu menjadi dasar untuk menyebut penandatangan, dan ketiadaannya tidak menyatakan apa pun lebih dari itu. Tanggal penerbitan tidak ada jika penerbitan tidak menyatakannya dan tidak ada tanda tangan keyless yang diverifikasi kebijakan itu yang mencatatnya.

PropertiJenisWajibDeskripsi
versionstringyaVersi, sebagaimana dinamai tag-nya.
manifestDigeststringyaDigest manifest yang di-resolve dari tag versi saat indeks dibangun, yang menunjuk versi berdasarkan byte yang dinamainya, bukan berdasarkan tag-nya.
signerVerifiedSignaturetidakTanda tangan yang terverifikasi terhadap kebijakan kepercayaan sebuah registry: bagaimana ia terverifikasi, penandatangan hasil verifikasinya, dan digest bundel tanda tangan yang terverifikasi.
publishedAtstringtidakKapan versi diterbitkan, sebagai stempel waktu RFC 3339 dalam UTC hingga detik. Asalnya adalah publishedAtSource, dan keduanya ada bersama-sama atau tidak sama sekali.
publishedAtSourceconst “transparency-log” atau const “publisher”tidakAsal publishedAt, agar waktu yang dibuktikan log transparansi tidak pernah dikira waktu yang dinyatakan penerbit. Himpunannya tertutup. Nilai yang diizinkan: "transparency-log" — Waktu log transparansi mencatat tanda tangan keyless versi tersebut, yang diverifikasi oleh kebijakan kepercayaan yang digunakan saat indeks dibangun bersama janji bertanda tangan log atas waktu tersebut. Untuk versi yang ditandatangani saat dipublikasikan, itulah waktu publikasinya; untuk versi yang ditandatangani kemudian, itulah waktu tanda tangan tersebut dibuat. "publisher" — Waktu yang dinyatakan publikasi di samping apa yang dipublikasikannya, dari jam mesin penerbit itu sendiri. Tidak ada yang membuktikannya. Publikasi menyatakannya ketika tanda tangannya tidak membawa waktu yang dibuktikan: tanda tangan berkunci, atau tanpa tanda tangan. Jika beberapa dilampirkan, yang paling awal diambil.

Properti tambahan tidak diizinkan.

VerifiedSignature

Tanda tangan yang terverifikasi terhadap kebijakan kepercayaan sebuah registry: bagaimana ia terverifikasi, penandatangan hasil verifikasinya, dan digest bundel tanda tangan yang terverifikasi.

PropertiJenisWajibDeskripsi
bundleDigeststringyaDigest bundel tanda tangan yang terverifikasi, sebagai sha256: diikuti 64 karakter heksadesimal huruf kecil.
identitystringtidakPenandatangan hasil verifikasi tanda tangan: untuk tanda tangan keyless, identitas yang menjadi tujuan penerbitan sertifikat penandatanganan, yaitu subject alternative name-nya; untuk tanda tangan keyed, keyed:sha256: diikuti SHA-256 heksadesimal huruf kecil dari teks PEM kunci publik yang dipasang.
issuerstringtidakPenerbit OIDC yang tercatat dalam sertifikat penandatanganan, untuk tanda tangan keyless. Tidak ada untuk tanda tangan keyed.
modeconst “keyless” atau const “keyed”yaCara tanda tangan diverifikasi. Himpunannya tertutup. Nilai yang diizinkan: "keyless" — Terhadap sertifikat penandatanganan yang identitas dan penerbitnya cocok dengan yang dipercaya kebijakan, yang berantai ke root kepercayaan yang disematkan kebijakan atau, jika kebijakan tidak menyematkan satu pun, ke root Sigstore publik, dan yang tanda tangannya dicatat oleh log transparansi. "keyed" — Terhadap kunci publik yang disematkan kebijakan.

Properti tambahan tidak diizinkan.

RegistrySearchRecord

Satu rekaman yang cocok dengan pencarian, sebagaimana disimpan indeks lokal, ditambah versi-versinya yang telah di-deprecate oleh penanda yang diterbitkan.

PropertiJenisWajibDeskripsi
uristringyaReferensi asal rekaman di-resolve.
namestringyaNama entitas.
versionstringyaVersi yang menjadi kunci rekaman.
versionsstring[]tidakSetiap versi yang dimiliki indeks untuk referensi ini.
kindstringtidakJenis entitas.
descriptionstringtidakKegunaan entitas.
categorystringtidakKategori tempat entitas diterbitkan.
labelsmap of stringtidakLabel yang dideklarasikan entitas.
pluginTypestringtidakSocket tempat rekaman plugin terpasang.
capabilitiesstring[]tidakKapabilitas yang dideklarasikan rekaman plugin.
manifestDigeststringtidakDigest manifest yang diterbitkan.
listingDigeststringtidakDigest daftar tempat rekaman dibaca.
deprecationsobject[]tidakPenanda deprecation yang dibawa indeks untuk referensi ini, masing-masing dengan versi yang dicakupnya dan penanda terverifikasi itu sendiri.
publishedPublishedVersion[]tidakSetiap versi yang dimiliki indeks untuk referensi ini, dalam urutan yang sama dengan versions, masing-masing dengan digest manifest yang di-resolve dari tag-nya saat indeks dibangun, penandatangan terverifikasinya jika kebijakan kepercayaan yang digunakan saat indeks dibangun memverifikasi tanda tangan versi itu sendiri, serta tanggal penerbitan dan sumber tanggal itu jika ada yang mencatatnya. Versi yang tercatat tanpa penandatangan tidak membawa tanda tangan yang diverifikasi kebijakan itu, dan tidak ada hal lain yang dinyatakan tentangnya. Hanya manifest, lampiran tanda tangan, dan lampiran tanggal penerbitan yang dibaca dari registry untuk mencatat ini; konten entitas tidak diambil.
retractedstring[]tidakVersi yang telah di-deprecate oleh penanda yang diterbitkan.

Properti tambahan tidak diizinkan.

RegistrySearchIndex

Kebaruan satu host yang dicari.

PropertiJenisWajibDeskripsi
hoststringyaHost yang indeksnya dicari.
lastUpdatedstringtidakKapan indeks terakhir diperbarui. Nilai ini tidak ada, alih-alih nol, ketika snapshot tidak membawa waktu, sehingga pemanggil dapat membedakan “tidak tercatat” dari epoch.

Properti tambahan tidak diizinkan.

EffectiveConfigurationSetting

Satu pengaturan yang telah di-resolve, dan dokumen asalnya.

PropertiJenisWajibDeskripsi
fieldstringyaPengaturan tersebut.
valuestringyaNilai yang di-resolve.
sourcestringyaAsal nilai tersebut.

Properti tambahan tidak diizinkan.

ImportedFile

Satu file yang ditulis oleh impor: dokumen draf, atau catatan tentang apa yang ditulis impor.

PropertiJenisWajibDeskripsi
pathstringyaLokasi file, sebagai path relatif terhadap outputDir jawaban.
contentstringyaTeks file.

Properti tambahan tidak diizinkan.

ImportDrift

Satu bagian yang disinkronkan dengan sumber oleh sinkronisasi, atau yang akan disinkronkan di bawah dryRun.

PropertiJenisWajibDeskripsi
changestringyaBagaimana bagian tersebut menyimpang: added, untuk bagian yang ditambahkan sumber; removed, untuk bagian yang dihapusnya; atau changed, untuk bagian yang diubahnya.
filestringyaFile draf tempat bagian tersebut berada, sebagai path relatif terhadap outputDir jawaban.
keystring[]yaKunci-kunci yang mengarah ke bagian tersebut dari puncak Aggregate atau Release draf, satu entri per kunci, sehingga kunci yang memuat titik tetap menjadi satu entri. Kosong jika bagian tersebut adalah seluruh file.

Properti tambahan tidak diizinkan.

ImportOwed

Satu nilai yang masih dibiarkan kosong oleh draf, yang tidak dapat disediakan oleh sumber mana pun dan tidak disediakan oleh jawaban mana pun.

PropertiJenisWajibDeskripsi
filestringyaFile draf tempat nilai tersebut berada, sebagai path relatif terhadap outputDir jawaban.
keystring[]yaKunci-kunci yang mengarah ke nilai dari bagian atas dokumen tersebut, satu entri per kunci, sehingga kunci yang memuat titik tetap menjadi satu entri. Jawaban yang dikirim sebagai answered menyebutkan nilai dengan kunci-kunci ini.
questionstringyaApa nilai itu: deskripsi skemanya, atau jika tidak ada, komentar yang ditulis draf di atas kuncinya, atau jika tidak ada, apa yang menurut skemanya diterima.
sensitivebooleanyaApakah nilai itu milik sebuah secret, yang jawabannya menyebutkan asal secret tersebut dan tidak pernah memuat secret itu sendiri.
secretAdvicestringtidakAda pada nilai sebuah secret: apa yang harus menjadi jawabannya, dalam kalimat yang ditampilkan kepada orang yang menjawabnya di terminal — atau, jika jawaban yang dikirim untuknya sebagai answered ditolak, mengapa jawaban itu ditolak.

Properti tambahan tidak diizinkan.

ImportAnswered

Satu jawaban untuk nilai yang didaftarkan oleh owed jawaban.

PropertiJenisWajibDeskripsi
filestringyaFile draf tempat nilai tersebut berada, sebagaimana owed menyebutkannya.
keystring[]yaKunci-kunci yang mengarah ke nilai, sebagaimana owed menyebutkannya.
answerstringyaJawabannya. Jawaban kosong membiarkan nilai tetap terutang.

Properti tambahan tidak diizinkan.

ImportDiagnostic

Satu hal yang tidak dapat dikonversi oleh konversi. Ini adalah keluaran konversi yang paling berguna, sehingga dilaporkan secara lengkap alih-alih diringkas menjadi satu putusan.

PropertiJenisWajibDeskripsi
severitystringyaTingkat keseriusannya.
messagestringyaApa yang tidak dapat dikonversi.
codestringtidakNama kondisi yang dapat dikutip, jika ada.

Properti tambahan tidak diizinkan.

ImportDecision

Bagaimana konversi memetakan satu node sumber: Components katalog yang dipertimbangkan importer, yang dipilihnya, alasannya, dan cara menukar pilihan tersebut.

PropertiJenisWajibDeskripsi
sourceNodeDecisionSourceNodeyaNode sumber yang menjadi pokok keputusan pemetaan.
candidatesImportCandidate[]tidakComponents katalog yang dipertimbangkan importer untuk node tersebut, masing-masing dengan skornya. Tidak ada jika importer tidak mempertimbangkan satu pun.
chosenDecisionChoicetidakApa yang dipilih importer untuk sebuah node sumber. Tidak ada dalam keputusan yang tidak menghasilkan pilihan.
rationalestringtidakAlasan importer membuat pilihan tersebut, dengan kata-katanya sendiri. Tidak ada jika importer tidak menuliskannya.
swapHintstringtidakCara menukar pilihan dengan alternatif, dengan kata-kata importer sendiri. Tidak ada jika importer tidak menuliskannya.

Properti tambahan tidak diizinkan.

DecisionSourceNode

Node sumber yang menjadi pokok keputusan pemetaan.

PropertiJenisWajibDeskripsi
idstringyaPengenal node di sumber.
typestringyaJenis node, sebagaimana dinamai sumber.
paramsSummarystringyaRingkasan parameter node, untuk ditampilkan di samping keputusan.

Properti tambahan tidak diizinkan.

ImportCandidate

Satu Component katalog yang dipertimbangkan importer untuk sebuah node sumber.

PropertiJenisWajibDeskripsi
componentNamestringyaNama Component.
scorenumberyaSeberapa cocok Component dengan node, menurut skor importer.
tierstringyaTingkat kecocokan tempat skor tersebut berada.
signalsCandidateSignalsyaKontribusi setiap sinyal importer terhadap skor kandidat.

Properti tambahan tidak diizinkan.

CandidateSignals

Kontribusi setiap sinyal importer terhadap skor kandidat.

PropertiJenisWajibDeskripsi
tablenumberyaKontribusi sinyal tabel pemetaan.
categorynumberyaKontribusi sinyal kategori.
domainLabelsnumberyaKontribusi sinyal label domain.
shapenumberyaKontribusi sinyal bentuk.
namenumberyaKontribusi sinyal nama.

Properti tambahan tidak diizinkan.

DecisionChoice

Apa yang dipilih importer untuk sebuah node sumber. Tidak ada dalam keputusan yang tidak menghasilkan pilihan.

PropertiJenisWajibDeskripsi
targetstringyaNama Component yang dipilih: Component katalog yang sudah ada, atau yang didraf untuk node tersebut.
modestringyaCara pilihan ditulis: sebagai referensi ke Component yang sudah ada, atau sebagai Component yang baru didraf.
tierstringyaTingkat kecocokan pilihan.

Properti tambahan tidak diizinkan.

LintFileFindings

Apa yang ditemukan pemeriksaan konvensi dalam satu dokumen.

PropertiJenisWajibDeskripsi
filestringyaDokumen tersebut.
diagnosticsDiagnostic[] atau nullyaTemuan di dalamnya.

Properti tambahan tidak diizinkan.

PluginRetractionExclusion

Satu versi yang tersedia tetapi tidak dipilih.

PropertiJenisWajibDeskripsi
versionstringyaVersi yang dilewati.
reasonstringtidakMengapa dilewati.

Properti tambahan tidak diizinkan.

PluginRetractionProvenance

Asal pengetahuan tentang apa yang usang.

PropertiJenisWajibDeskripsi
sourcestringyaApa yang dirujuk.
lastUpdatedstringtidakKapan itu terakhir diperbarui.

Properti tambahan tidak diizinkan.

PluginRetraction

Bagaimana penanda deprecation memengaruhi versi plugin yang di-pin.

PropertiJenisWajibDeskripsi
referencestringyaReferensi pemilik versi-versi tersebut.
selectedstringtidakVersi yang di-pin.
excludedPluginRetractionExclusion[]tidakVersi-versi yang tersedia dan dilewati.
unscreenedstringtidakApa yang tidak dapat disaring terhadap penanda, dan alasannya.
provenancePluginRetractionProvenancetidakAsal pengetahuan tentang apa yang usang.

Properti tambahan tidak diizinkan.

PluginGeneratedDocument

Satu dokumen katalog yang dihasilkan oleh pembangkitan.

PropertiJenisWajibDeskripsi
pathstringyaLokasi dokumen, sebagai path relatif terhadap root workspace.
contentstringyaTeks dokumen.

Properti tambahan tidak diizinkan.

PluginCommandFlag

Satu flag yang dideklarasikan plugin pada perintah yang disumbangkannya.

PropertiJenisWajibDeskripsi
namestringyaNama panjang flag.
shorthandstringtidakAlias satu karakter flag, jika ada.
descriptionstringtidakTeks bantuan satu baris flag.
typestringtidakJenis nilai flag.
defaultstringtidakNilai yang digunakan ketika flag tidak diberikan.

Properti tambahan tidak diizinkan.

PluginCLICommand

Satu verba perintah tingkat atas yang disumbangkan plugin.

PropertiJenisWajibDeskripsi
namestringyaVerba perintah.
descriptionstringtidakTeks bantuan satu baris perintah.
flagsPluginCommandFlag[]tidakFlag-flag perintah, dalam urutan deklarasi.

Properti tambahan tidak diizinkan.

ConfigCapturedAttachment

Satu attachment yang ditulis pembekuan ke dalam konfigurasi workspace ini sendiri.

PropertiJenisWajibDeskripsi
uristringtidakReferensi tempat attachment di-resolve.
capabilitystringtidakKapabilitas yang dilayani attachment.
functionstringtidakExport tempat attachment diteruskan.
rolestringtidakPeran tempat pemasangan dijalankan, yang menentukan apa yang boleh dihasilkannya.

Properti tambahan tidak diizinkan.

ConfigCapturedSocket

Satu socket yang ditulis pembekuan, beserta attachment yang dibekukan padanya.

PropertiJenisWajibDeskripsi
socketstringyaSocket tersebut.
fieldstringyaField konfigurasi tempat socket ditulis.
attachmentsConfigCapturedAttachment[] atau nullyaAttachment yang dibekukan padanya.

Properti tambahan tidak diizinkan.

ExplainErrorEntry

Satu bagian terpublikasi yang mengajarkan perbaikan penulisan untuk sebuah kondisi.

PropertiJenisWajibDeskripsi
headingstringyaJudul bagian tersebut.
bodystringyaBagian tersebut.

Properti tambahan tidak diizinkan.

SignedArtifact

Satu artefak terpublikasi yang dicakup oleh penandatanganan.

PropertiJenisWajibDeskripsi
referencestringyaReferensi yang ditandatangani.
digeststringyaDigest dari apa yang ditandatangani.

Properti tambahan tidak diizinkan.

DeprecationMarked

Satu versi terpublikasi yang ditandai oleh deprecation.

PropertiJenisWajibDeskripsi
referencestringyaReferensi yang ditandai.
severityconst “warning” atau const “error” atau const “retracted”yaSeberapa kuat penanda berbicara. Nilai yang diizinkan: "warning" — Di-deprecate, pada tingkat yang lebih ringan dari dua tingkat anjuran: tetap dipilih ketika versi dipilih. "error" — Di-deprecate, pada tingkat yang lebih kuat dari dua tingkat anjuran: tetap dipilih ketika versi dipilih. "retracted" — Ditarik: dikecualikan ketika versi dipilih.
issuedOnstringyaKapan penanda diterbitkan.
digeststringyaDigest penanda yang dipublikasikan.

Properti tambahan tidak diizinkan.

InitializeResult

Apa yang ditetapkan sesi untuk klien ini, dan dari lapisan konfigurasi mana hal itu di-resolve.

PropertiJenisWajibDeskripsi
capabilitiesServerCapabilitiesyaApa yang akan dilakukan daemon dalam sesi ini, yang disepakati berdasarkan apa yang dinyatakan klien dapat ditanganinya.
workspaceRootstringyaWorkspace tempat sesi dibuka.
configSourcestringyaLapisan konfigurasi tempat sesi me-resolve pengaturannya.
workspaceMarkerstringtidakFile yang mengidentifikasi root workspace, jika ada.
versionstringyaVersi biner yang menjawab sesi ini: nilai yang sama dengan yang dilaporkan aggrega version untuk biner tersebut. Nilai ini menggambarkan proses yang sedang berjalan, sehingga setelah file tempat daemon dijalankan diganti, nilai ini tetap menyebut versi yang sedang berjalan, sedangkan menanyakan file tersebut akan menyebut versi yang menggantikannya.

Properti tambahan tidak diizinkan.

ValidateResult

Apa yang ditemukan pemeriksaan, dan seberapa banyak yang diperiksa.

PropertiJenisWajibDeskripsi
diagnosticsDiagnostic[] atau nullyaTemuan. Nilainya null, bukan daftar kosong, jika pemeriksaan tidak menemukan apa pun.
checkedstringtidakSeberapa banyak yang diperiksa — satu dokumen, atau isi workspace.

Properti tambahan tidak diizinkan.

InvalidateResult

Apakah daemon menyimpan sesuatu tentang dokumen tersebut untuk dibuang.

PropertiJenisWajibDeskripsi
invalidatedbooleanyaApakah ada yang dibuang.

Properti tambahan tidak diizinkan.

DiagnosticsResult

Temuan yang sudah disimpan daemon untuk dokumen tersebut.

PropertiJenisWajibDeskripsi
diagnosticsDiagnostic[] atau nullyaTemuan. Nilainya null, bukan daftar kosong, jika tidak ada temuan.

Properti tambahan tidak diizinkan.

IrGraphResult

Graf ter-resolve yang menjadi hasil kompilasi sebuah Release.

PropertiJenisWajibDeskripsi
graphanyyaDokumen graf. Nilai yang dinyatakan sensitif oleh penulis tidak disertakan di dalamnya kecuali permintaan memintanya dengan unredacted; semua hal lain diteruskan sebagaimana dikeluarkan compiler. Bentuknya sendiri merupakan kontrak graf yang dipublikasikan dan tidak diulang di sini.

Properti tambahan tidak diizinkan.

BuildResult

Apa yang ditulis oleh build.

PropertiJenisWajibDeskripsi
outputDirectorystringyaDirektori tempat artefak ditulis.
filesstring[] atau nullyaArtefak yang ditulis, sebagai path relatif terhadap direktori output.
noticesBuildNotice[]tidakApa pun yang ingin disampaikan build kepada pemanggil yang bukan temuan maupun kegagalan.
dependencyResolutionDependencyResolutionReporttidakApa yang di-pin dan diperoleh oleh sebuah resolusi dependensi.

Properti tambahan tidak diizinkan.

BuildPreviewResult

Apa yang akan ditulis oleh build. Tidak ada yang ditulis, sehingga tidak ada direktori output yang disebutkan.

PropertiJenisWajibDeskripsi
filesstring[] atau nullyaArtefak yang akan dihasilkan jika penulisan dilakukan.
noticesBuildNotice[]tidakApa pun yang ingin disampaikan kompilasi kepada pemanggil yang bukan temuan maupun kegagalan.

Properti tambahan tidak diizinkan.

EntityDefinitionResult

Hasil resolve sebuah nama entitas, dan dokumen yang mendefinisikannya. Jawaban yang dibaca dari referensi registry membawa published, sedangkan jawaban yang di-resolve katalog berdasarkan nama tidak pernah membawanya.

PropertiJenisWajibDeskripsi
kindstringyaJenis entitas.
namestringyaNama entitas.
versionstringyaVersi yang di-resolve.
descriptionstringtidakKegunaan entitas menurut dokumen.
publishScopestringtidakSeberapa luas entitas dipublikasikan.
filestringyaDokumen yang mendefinisikannya.
authoredLengthintegeryaJumlah byte dokumen yang ditulis penulis, sehingga klien dapat membedakan dokumen yang ditulis penulis dari rendering ter-resolve dokumen tersebut.
definitionstringyaTeks definisi.
publishedPublishedArtifacttidakApa yang dibaca sebuah referensi registry: koordinat, cara koordinat itu menyimpan entitas, dan manifest yang digunakan untuk membacanya. Setiap field ada di mana pun objek ini ada.

Properti tambahan tidak diizinkan.

PublishedArtifact

Apa yang dibaca sebuah referensi registry: koordinat, cara koordinat itu menyimpan entitas, dan manifest yang digunakan untuk membacanya. Setiap field ada di mana pun objek ini ada.

PropertiJenisWajibDeskripsi
referencestringyaReferensi registry yang dibaca.
archivebooleanyaApakah byte koordinat berupa arsip tempat dokumen entitas diekstrak. False jika koordinat menyimpan dokumen entitas itu sendiri.
mediaTypestringyaJenis artefak yang dideklarasikan manifest.
manifestDigeststringyaDigest manifest yang digunakan untuk membaca entitas — nilai yang disebutkan setelah @ untuk membaca byte yang sama persis lagi.

Properti tambahan tidak diizinkan.

ReleaseClosureResult

Semua hal yang menjadi dependensi sebuah Release, sebagaimana dicapai oleh resolusi. Objek ini melaporkan closure, bukan graf yang diturunkan darinya: dokumen yang berbeda tentang Release yang sama.

PropertiJenisWajibDeskripsi
releasestringyaRelease yang diperiksa.
aggregatestringyaAggregate yang di-deploy-nya.
manifeststringyaManifest yang digunakannya untuk resolve.
environmentstringyaLingkungan yang disebutkannya.
entitiesClosureEntity[] atau nullyaEntitas yang dicapai closure.
librariesClosureEntity[] atau nullyaLibrary yang dicapai closure.
pluginsClosureEntity[] atau nullyaPlugin yang dicapai closure.
mappingDiagnosticsstring[] atau nullyaApa yang disampaikan oleh resolusi mapping Manifest.
deprecationsstring[] atau nullyaPenanda deprecation yang ditemui closure.

Properti tambahan tidak diizinkan.

ResolveDependenciesResult

Apa yang di-pin dan diperoleh oleh resolusi dependensi, ditambah apa pun yang ingin disampaikannya kepada pemanggil. Field laporan dibawa langsung pada jawaban ini, bukan disarangkan di bawah salah satu anggotanya.

PropertiJenisWajibDeskripsi
lockfilestringyaLockfile yang ditulis resolusi, atau lockfile yang dibandingkan oleh verifikasi.
verifiedbooleantidakApakah permintaan berupa verifikasi, yang membandingkan lockfile tercatat dan tidak menulis lockfile, catatan kepercayaan plugin, maupun entity.lock.
entitiesClosureEntity[] atau nullyaEntitas yang di-pin oleh resolusi, atau dibandingkan oleh verifikasi.
librariesClosureEntity[] atau nullyaPustaka yang di-pin oleh resolusi, atau dibandingkan oleh verifikasi.
pluginsClosureEntity[] atau nullyaPlugin yang di-pin oleh resolusi, atau dibandingkan oleh verifikasi.
sourceArtifactsintegeryaJumlah artefak sumber yang diperoleh.
trustedPluginsintegeryaJumlah plugin yang di-pin yang membawa tanda tangan terverifikasi.
toolchainToolchainReporttidakCompiler yang melakukan resolusi, beserta plugin yang dibawanya.
externalInputsintegeryaJumlah input eksternal yang dikonsumsi render yang berhasil diperoleh.
incompleteExternalInputsstringtidakInput eksternal mana yang tidak dapat diperoleh, jika ada yang tidak dapat diperoleh.
noticesstring[]tidakApa pun yang ingin disampaikan resolusi kepada pemanggil.

Properti tambahan tidak diizinkan.

PinResult

Apa yang dilakukan langkah pin terhadap lock di samping sebuah entitas, atau yang akan dilakukannya pada dry run. Ini adalah jawaban untuk aggrega/pin, dan publikasi yang menjalankan langkah ini membawanya sebagai pin.

PropertiJenisWajibDeskripsi
entitystringyaDokumen entitas yang dibaca langkah ini, sebagai path relatif terhadap root workspace.
kindstringyaJenis entitas, sebagaimana dideklarasikan dokumennya.
namestringyaNama entitas, sebagaimana dideklarasikan dokumennya.
pinnablebooleanyaApakah entitas dengan jenis ini membaca sesuatu yang pin-nya dicatat oleh lock, seperti Recipe dan FeatureRecipe. Jika false, tidak ada yang disentuh di samping entitas, changed bernilai false, dan lock, removed, pins serta content tidak ada.
lockstringtidakLock yang ditulis, atau akan ditulis, oleh langkah ini, sebagai path relatif terhadap root workspace.
changedbooleanyaApakah lock berubah, atau akan berubah pada dry run. False jika lock sudah mencatat setiap pin yang dibutuhkan entitas dan dibiarkan identik per byte.
removedbooleantidakApakah perubahan tersebut berupa penghapusan: entitas tidak membaca apa pun yang pin-nya dicatat oleh lock, sehingga tidak ada lock yang tersisa di sampingnya.
dryRunbooleantidakApakah objek ini melaporkan apa yang akan dilakukan langkah ini, bukan apa yang telah dilakukannya.
pinsPinClassCount[]tidakJumlah pin setiap kelas yang disimpan lock setelah langkah ini, atau yang akan disimpan setelah dry run. Setiap kelas yang dapat disimpan lock dicantumkan, termasuk kelas tanpa pin.
contentstringtidakLock yang akan ditulis dry run. Tidak ada jika lock akan dibiarkan apa adanya atau dihapus, dan pada setiap jawaban yang bukan dry run.

Properti tambahan tidak diizinkan.

PinClassCount

Jumlah pin satu kelas yang disimpan sebuah lock.

PropertiJenisWajibDeskripsi
classstringyaKelas pin, dengan kata-kata yang digunakan penolakan yang menyebut pin yang hilang — misalnya remote source atau imported file.
pinsintegeryaJumlah pin kelas tersebut yang disimpan lock.

Properti tambahan tidak diizinkan.

CacheStatusResult

Isi cache yang melayani workspace ini.

PropertiJenisWajibDeskripsi
classesCacheClass[] atau nullyaSetiap cache dan isinya.
provenanceCacheProvenance[] atau nullyaIdentitas yang digunakan saat artefak dalam cache diperoleh.
totalCountintegeryaJumlah total entri yang disimpan cache.
totalSizeintegeryaJumlah total byte yang ditempatinya.
totalSizeTextstringyaTotal yang sama, ditulis dalam bentuk yang mudah dibaca manusia.
scopeCacheScopeyaSeberapa jauh jangkauan sebuah jawaban cache. Dua kelas cache digunakan bersama oleh setiap proyek di mesin, sehingga setiap jawaban cache menyebutkan kelas mana yang disentuhnya — jika tidak, sesi yang dibuka atas satu workspace akan dibaca seolah hanya melaporkan tentang workspace tersebut.

Properti tambahan tidak diizinkan.

CachePruneResult

Apa yang dihapus oleh reklamasi, apa yang dipertahankan, dan apa yang tidak dapat direklamasi.

PropertiJenisWajibDeskripsi
removedCacheRemoval[] atau nullyaApa yang dihapus.
heldOpenCacheRemoval[] atau nullyaApa yang akan dihapus oleh prune tetapi dibiarkan di tempatnya karena proses lain sedang membukanya. Hanya Windows yang menolak menghapus file yang sedang terbuka, sehingga di sistem lain nilai ini kosong. Entri-entri ini tidak dihitung sebagai dihapus maupun dipertahankan, tidak ada byte-nya yang dihitung sebagai direklamasi, dan prune berikutnya akan mereklamasinya; entri yang berupa direktori mungkin sudah kehilangan file di dalamnya yang tidak sedang terbuka.
retainedCountintegeryaJumlah entri yang dipertahankan.
reclaimedBytesintegeryaJumlah byte yang direklamasi.
reclaimedBytesTextstringyaAngka yang sama, ditulis dalam bentuk yang mudah dibaca manusia.
unattributedCountintegeryaJumlah entri yang tidak diklaim oleh pemegang mana pun.
unattributedSizeintegeryaJumlah byte yang ditempati entri tersebut.
unattributedSizeTextstringyaAngka yang sama, ditulis dalam bentuk yang mudah dibaca manusia.
notPruneEligibleCacheShortfall[] atau nullyaApa yang tertinggal, dan apa yang dapat mereklamasinya.
scopeCacheScopeyaSeberapa jauh jangkauan sebuah jawaban cache. Dua kelas cache digunakan bersama oleh setiap proyek di mesin, sehingga setiap jawaban cache menyebutkan kelas mana yang disentuhnya — jika tidak, sesi yang dibuka atas satu workspace akan dibaca seolah hanya melaporkan tentang workspace tersebut.

Properti tambahan tidak diizinkan.

CacheEvictResult

Apa yang dihapus oleh reklamasi hingga ukuran tertentu, dan apa yang tersisa.

PropertiJenisWajibDeskripsi
withinCapBeforebooleanyaApakah isi yang disimpan sudah muat di bawah ukuran tersebut, sehingga tidak ada yang perlu dihapus.
removedCacheRemoval[] atau nullyaApa yang dihapus.
heldOpenCacheRemoval[] atau nullyaApa yang akan dihapus oleh reklamasi tetapi dibiarkan di tempatnya karena proses lain sedang membukanya; reklamasi beralih ke entri tertua berikutnya sebagai gantinya. Hanya Windows yang menolak menghapus file yang sedang terbuka, sehingga di sistem lain nilai ini kosong. Entri-entri ini tetap dihitung dalam byte yang tersisa, dan reklamasi berikutnya dapat menghapusnya.
totalBeforeintegeryaJumlah byte yang disimpan sebelumnya.
totalBeforeTextstringyaAngka yang sama, ditulis dalam bentuk yang mudah dibaca manusia.
reclaimedBytesintegeryaJumlah byte yang direklamasi.
reclaimedBytesTextstringyaAngka yang sama, ditulis dalam bentuk yang mudah dibaca manusia.
remainingBytesintegeryaJumlah byte yang tersisa.
remainingBytesTextstringyaAngka yang sama, ditulis dalam bentuk yang mudah dibaca manusia.
capBytesintegeryaUkuran target reklamasi, dalam byte.
capBytesTextstringyaUkuran yang sama, ditulis dalam bentuk yang mudah dibaca manusia.
scopeCacheScopeyaSeberapa jauh jangkauan sebuah jawaban cache. Dua kelas cache digunakan bersama oleh setiap proyek di mesin, sehingga setiap jawaban cache menyebutkan kelas mana yang disentuhnya — jika tidak, sesi yang dibuka atas satu workspace akan dibaca seolah hanya melaporkan tentang workspace tersebut.

Properti tambahan tidak diizinkan.

CacheClearResult

Apa yang direklamasi dengan mengosongkan cache.

PropertiJenisWajibDeskripsi
clearedCacheCleared[] atau nullyaSetiap cache yang dikosongkan.
reclaimedBytesintegeryaJumlah byte yang direklamasi.
reclaimedBytesTextstringyaAngka yang sama, ditulis dalam bentuk yang mudah dibaca manusia.
scopeCacheScopeyaSeberapa jauh jangkauan sebuah jawaban cache. Dua kelas cache digunakan bersama oleh setiap proyek di mesin, sehingga setiap jawaban cache menyebutkan kelas mana yang disentuhnya — jika tidak, sesi yang dibuka atas satu workspace akan dibaca seolah hanya melaporkan tentang workspace tersebut.

Properti tambahan tidak diizinkan.

RegistryListResult

Registry yang digunakan workspace ini untuk resolusi.

PropertiJenisWajibDeskripsi
registriesRegistry[] atau nullyaSetiap registry yang dikonfigurasi.
credentialStateIsMachineWidebooleanyaApakah keberadaan kredensial yang dilaporkan untuk setiap registry merupakan fakta yang berlaku di seluruh mesin, bukan hanya di workspace. Ini dilaporkan agar jawaban yang berlingkup sesi tidak dibaca sebagai menyangkal jangkauan yang lebih luas.

Properti tambahan tidak diizinkan.

SearchResult

Apa yang ditawarkan indeks registry lokal untuk pencarian ini.

PropertiJenisWajibDeskripsi
recordsRegistrySearchRecord[] atau nullyaCatatan yang cocok.
indexesRegistrySearchIndex[] atau nullyaSetiap host yang dicari dan kapan indeksnya terakhir diperbarui.
missingIndexHostsstring[] atau nullyaHost yang dikonfigurasi tetapi tidak memiliki indeks lokal untuk dicari, sehingga jawaban yang pendek dijelaskan alih-alih dibiarkan untuk disimpulkan.
stalebooleanyaApakah ada indeks yang dicari yang sudah cukup lama sehingga layak diperbarui.
registriesConfiguredbooleanyaApakah ada registry yang dikonfigurasi sama sekali, yang membedakan “tidak ada yang cocok” dari “tidak ada yang dicari”.

Properti tambahan tidak diizinkan.

RegistryAddResult

Apa yang ditulis oleh pendaftaran registry, di mana, dan apa yang dibacanya dari registry itu sendiri.

PropertiJenisWajibDeskripsi
hoststringyaHost yang menjadi kunci entri, yang tidak selalu sama dengan ejaan yang digunakan permintaan.
scopeConfigWriteScopeyaDokumen konfigurasi mana yang ditulis dan seberapa jauh jangkauannya. Sebuah permintaan menyebut satu workspace, sehingga jawaban yang tidak menyebutkan apa pun akan dibaca sebagai jawaban tentang workspace tersebut — dan untuk penulisan tingkat mesin, pembacaan itu keliru.
trustTrustFetchOutcomeyaApa hasil pembacaan kebijakan kepercayaan yang diumumkan sebuah registry. Hasil-hasil ini dipisahkan karena maknanya berbeda: kebijakan yang diumumkan diambil, registry tidak mengumumkan apa pun — yang bukan merupakan kegagalan — baseline bawaan dipasang sebagai gantinya, atau tidak ada pembacaan yang dicoba. Jika tidak ada yang diumumkan, apakah registry dapat dijangkau sama sekali dinyatakan di sampingnya.

Properti tambahan tidak diizinkan.

RegistryRemoveResult

Apa yang ditulis oleh penghapusan registry, dan di mana.

PropertiJenisWajibDeskripsi
hoststringyaHost yang entrinya dihapus.
scopeConfigWriteScopeyaDokumen konfigurasi mana yang ditulis dan seberapa jauh jangkauannya. Sebuah permintaan menyebut satu workspace, sehingga jawaban yang tidak menyebutkan apa pun akan dibaca sebagai jawaban tentang workspace tersebut — dan untuk penulisan tingkat mesin, pembacaan itu keliru.

Properti tambahan tidak diizinkan.

RegistryUpdateResult

Apa yang dilakukan pembaruan indeks lokal, per host.

PropertiJenisWajibDeskripsi
hostsHostUpdate[] atau nullyaApa yang dilakukan pembaruan untuk setiap host.
failedstring[] atau nullyaHost yang pembaruannya tidak dapat diselesaikan.
indexRootstringyaDirektori tempat indeks ditulis.
registriesConfiguredbooleanyaApakah ada registry yang dikonfigurasi sama sekali.
reachedRegistriesbooleanyaSelalu true pada jawaban ini: pembaruan indeks menghubungi registry itu sendiri, sedangkan pencantuman dan pencarian registry dijawab dari konfigurasi dan dari indeks lokal. Apakah suatu registry benar-benar terjangkau dinyatakan pada entrinya sendiri di hosts, melalui unreachable.

Properti tambahan tidak diizinkan.

LogoutResult

Kredensial tersimpan mana yang dihapus, dan seberapa jauh jangkauan penyimpanannya.

PropertiJenisWajibDeskripsi
registrystringyaRegistry yang kredensialnya dihapus.
scopeCredentialStoreScopeyaSeberapa jauh jangkauan perubahan kredensial. Penyimpanan digunakan bersama oleh setiap proyek di mesin dan oleh setiap alat lain yang mengakses registry yang sama, sehingga jawaban melaporkan hal itu alih-alih membiarkan pembacaan seolah terbatas pada sesi untuk diduga.

Properti tambahan tidak diizinkan.

PublishEntityResult

Apa yang dihasilkan oleh publikasi sebuah entitas, dan di mana. Publikasi yang menjalankan langkah pin terlebih dahulu juga membawa apa yang dilakukan langkah tersebut, sebagai pin, yang tidak ada jika langkah itu tidak dijalankan.

PropertiJenisWajibDeskripsi
referencestringyaReferensi tempat entitas dipublikasikan.
tagstringyaTag tempat entitas dipublikasikan.
kindstringyaJenis entitas yang dipublikasikan.
mediaTypestringyaMedia type yang dicatat untuk byte yang dipublikasikan.
sizeintegeryaJumlah byte yang dipublikasikan.
sizeTextstringyaUkuran yang sama, ditulis dalam bentuk yang mudah dibaca manusia.
pluginSizeintegertidakJumlah byte yang ditempati modul plugin yang dipublikasikan bersama entitas Plugin.
pluginSizeTextstringtidakUkuran yang sama, ditulis dalam bentuk yang mudah dibaca manusia.
digeststringyaDigest dari apa yang dipublikasikan. Pada dry run, digest yang akan dihasilkan oleh publikasi konten yang sama, dihitung dari konten saja: digest yang dicetak oleh aggrega push --dry-run.
signedbooleanyaApakah publikasi ini melampirkan tanda tangan: tanda tangan yang dibuatnya sebelum memublikasikan, atau, pada versi yang sudah dipublikasikan, tanda tangan yang belum dimiliki versi tersebut.
alreadyPublishedbooleanyaApakah byte yang sama sudah ada di sana, sehingga tidak ada konten yang diunggah. Hanya apa yang masih belum dimiliki publikasi tersebut yang dilampirkan di sampingnya: tanggal publikasinya dan, jika publikasi ini menandatangani, tanda tangannya; signed menyatakan apakah tanda tangan dilampirkan.
dryRunbooleanyaApakah ini melaporkan apa yang akan dihasilkan publikasi, bukan apa yang telah dilakukannya.
reachPublicationReachyaSeberapa jauh sebuah publikasi menjangkau. Jawaban ini menjangkau sepenuhnya melampaui mesin ini — apa yang dilampirkannya adalah apa yang di-resolve oleh setiap konsumen registry tersebut — sehingga masing-masing menyebutkan setiap registry yang dituju dan apakah panggilan tersebut melampirkan sesuatu di sana.
pinPinResulttidakApa yang dilakukan langkah pin terhadap lock di samping sebuah entitas, atau yang akan dilakukannya pada dry run. Ini adalah jawaban untuk aggrega/pin, dan publikasi yang menjalankan langkah ini membawanya sebagai pin.
wholeDirectorySourcestringtidakSumber lokal entitas sebagaimana ditulis, ada jika sumber itu ditulis sebagai templat. Sumber seperti itu baru menamai direktorinya setelah sebuah Release mengisi templat tersebut, sehingga publikasi membawa setiap file di direktori entitas, bukan hanya file yang dinamai entitas. Tidak ada jika publikasi hanya membawa file-file tersebut.
windowsUnusableEntriesstring[]tidakEntri arsip yang dipublikasikan yang jalurnya memuat bagian yang tidak dapat disimpan Windows sebagaimana tertulis — nama yang dicadangkan Windows untuk perangkat, seperti CON, AUX atau NUL, dalam huruf besar atau kecil apa pun dan apa pun ekstensi yang mengikutinya, atau bagian yang diakhiri titik atau spasi — nama file dokumen entitas itu sendiri terlebih dahulu, lalu file yang dibawanya. Workspace di Windows menolak membongkarnya, sehingga tidak dapat menggunakan versi tersebut; publikasi tetap berjalan atau berhenti persis seperti tanpa entri tersebut. Tidak ada jika tidak ada entri seperti itu, termasuk entitas yang dipublikasikan hanya sebagai dokumennya.

Properti tambahan tidak diizinkan.

PublishArtifactResult

Apa yang dihasilkan oleh publikasi sebuah file, dan di mana.

PropertiJenisWajibDeskripsi
referencestringyaReferensi tempat file dipublikasikan.
tagstringyaTag tempat entitas dipublikasikan.
mediaTypestringyaMedia type yang dicatat untuk byte yang dipublikasikan.
sizeintegeryaJumlah byte yang dipublikasikan.
sizeTextstringyaUkuran yang sama, ditulis dalam bentuk yang mudah dibaca manusia.
digeststringyaDigest dari apa yang dipublikasikan.
alreadyPublishedbooleanyaApakah byte yang sama sudah ada di sana, sehingga tidak ada konten yang diunggah. Tanggal publikasi dilampirkan di sampingnya hanya jika artefak belum memilikinya.
dryRunbooleanyaApakah ini melaporkan apa yang akan dihasilkan publikasi, bukan apa yang telah dilakukannya.
reachPublicationReachyaSeberapa jauh sebuah publikasi menjangkau. Jawaban ini menjangkau sepenuhnya melampaui mesin ini — apa yang dilampirkannya adalah apa yang di-resolve oleh setiap konsumen registry tersebut — sehingga masing-masing menyebutkan setiap registry yang dituju dan apakah panggilan tersebut melampirkan sesuatu di sana.

Properti tambahan tidak diizinkan.

SignArtifactsResult

Apa yang ditandatangani, dan di mana tanda tangan itu ditempatkan.

PropertiJenisWajibDeskripsi
signedSignedArtifact[] atau nullyaSetiap referensi yang ditandatangani.
reachPublicationReachyaSeberapa jauh sebuah publikasi menjangkau. Jawaban ini menjangkau sepenuhnya melampaui mesin ini — apa yang dilampirkannya adalah apa yang di-resolve oleh setiap konsumen registry tersebut — sehingga masing-masing menyebutkan setiap registry yang dituju dan apakah panggilan tersebut melampirkan sesuatu di sana.

Properti tambahan tidak diizinkan.

DeprecateArtifactResult

Apa yang ditandai sebagai usang, dan di mana penanda itu ditempatkan.

PropertiJenisWajibDeskripsi
markedDeprecationMarked[] atau nullyaSetiap versi yang ditandai.
reachPublicationReachyaSeberapa jauh sebuah publikasi menjangkau. Jawaban ini menjangkau sepenuhnya melampaui mesin ini — apa yang dilampirkannya adalah apa yang di-resolve oleh setiap konsumen registry tersebut — sehingga masing-masing menyebutkan setiap registry yang dituju dan apakah panggilan tersebut melampirkan sesuatu di sana.

Properti tambahan tidak diizinkan.

ResolveResult

Tempat sesuatu di bawah kursor didefinisikan.

PropertiJenisWajibDeskripsi
locationnull atau LocationyaTempat sesuatu itu didefinisikan. Bernilai null jika tidak ada apa pun di bawah kursor yang mengarah ke sebuah definisi.

Properti tambahan tidak diizinkan.

FindReferencesResult

Tempat sesuatu di bawah kursor dirujuk.

PropertiJenisWajibDeskripsi
locationsLocation[] atau nullyaSetiap tempat sesuatu itu dirujuk.

Properti tambahan tidak diizinkan.

FindImplementationsResult

Dokumen mana yang mengimplementasikan sesuatu di bawah kursor.

PropertiJenisWajibDeskripsi
locationsLocation[] atau nullyaSetiap tempat sesuatu itu diimplementasikan.

Properti tambahan tidak diizinkan.

HoverResult

Apa yang ditampilkan tentang sesuatu di bawah kursor.

PropertiJenisWajibDeskripsi
contentsnull atau MarkupContentyaApa yang ditampilkan. Bernilai null jika tidak ada yang dapat dikatakan tentang apa yang ada di bawah kursor.

Properti tambahan tidak diizinkan.

CompletionResult

Apa yang dapat ditulis di posisi kursor.

PropertiJenisWajibDeskripsi
itemsCompletionItem[] atau nullyaSetiap hal yang dapat ditulis.

Properti tambahan tidak diizinkan.

CatalogIndexResult

Setiap entitas yang dimuat indeks workspace, serta tautan yang mengarah keluar dari workspace, ke direktori dan ke file, yang tidak dibaca untuk indeks tersebut.

PropertiJenisWajibDeskripsi
entitiesCatalogEntity[] atau nullyaSetiap entitas.
unreadLinkedDirsstring[]yaSetiap tautan di bawah root workspace yang mengarah ke direktori di luarnya, dinamai relatif terhadap root tempat tautan itu sendiri berada, dalam urutan workspace ditelusuri. Tidak ada direktori di luar root yang ditelusuri, sehingga tidak ada dokumen di balik salah satu tautan ini yang termasuk dalam entities sebagai milik workspace sendiri, dan klien yang menampilkan daftar entitas dapat menjelaskan alasannya. Tidak dinamai: tautan ke direktori di dalam root, yang ditelusuri, atau dikecualikan, di tempat direktori itu sebenarnya berada; tautan di mana pun sebuah direktori akan dikecualikan, baik karena tempatnya, namanya, maupun oleh .gitignore; tautan yang tidak dapat di-resolve, karena tidak mengarah ke mana pun atau berputar dalam loop; dan, dalam jawaban yang diberikan menurut ketentuan sebuah Release, tautan di bawah direktori katalog yang hanya dibaca oleh Releases lain. Kosong jika workspace tidak memuatnya.
unreadLinkedFilesstring[]yaSetiap tautan di bawah root workspace yang dinamai seperti file YAML, dengan namanya sendiri berakhiran .yaml atau .yml, dan mengarah ke file di luar root, dinamai relatif terhadap root tempat tautan itu sendiri berada, dalam urutan workspace ditelusuri. File semacam itu tidak dibaca untuk indeks, apa pun yang dideklarasikannya, sehingga entitas yang dideklarasikannya tidak termasuk dalam entities sebagai milik workspace sendiri, dan klien yang menampilkan daftar entitas dapat menjelaskan alasannya; direktori katalog yang dikonfigurasi adalah cara entitas di luar workspace dibaca. Tidak dinamai: tautan ke file yang dinamai konfigurasi workspace sebagai Release, sebagai build.authoring_release atau sebagai kunci workspace.releases, dan yang mendeklarasikan satu Release, yang dibaca dan dicantumkan dalam entities di tempat tautan itu sendiri; tautan ke file di dalam root, yang dibaca di tempat tautan itu sendiri; tautan yang dikecualikan oleh .gitignore, atau yang berada di dalam direktori yang dikecualikan penelusuran; tautan yang tidak mengarah ke file, baik ke direktori, yang dinamai unreadLinkedDirs jika mengarah keluar dari root, atau tidak ke mana pun, atau berputar dalam loop; dan, dalam jawaban yang diberikan menurut ketentuan sebuah Release, tautan di bawah direktori katalog yang hanya dibaca oleh Releases lain. File konfigurasi workspace yang merupakan tautan yang mengarah keluar dari workspace, yaitu .aggrega-config.yaml miliknya sendiri atau overlay milik CI di sampingnya, dinamai baik ditemui penelusuran maupun tidak, setelah tautan-tautan yang dinamai penelusuran: konfigurasi workspace lalu tidak dibaca sama sekali, jawaban ini adalah indeks workspace sendiri yang dibaca tanpa konfigurasi apa pun, sehingga tidak ada direktori katalog yang dibaca untuknya, dan setiap permintaan yang ditentukan oleh konfigurasi, termasuk indeks menurut ketentuan sebuah Release, ditolak untuk workspace tersebut dengan kondisi penahanan baca. Kosong jika workspace tidak memuatnya.

Properti tambahan tidak diizinkan.

AttachCandidatesResult

Features mana yang dapat dilampirkan ke entitas, dan label yang menjadi dasar penilaiannya; serta, untuk koneksi yang dinamai permintaan, slot yang dideklarasikan socket-nya beserta Features yang dapat mengisi masing-masing slot.

PropertiJenisWajibDeskripsi
nodestringyaEntitas yang menjadi sasaran penilaian kandidat.
nodeLabelsmap of string atau nullyaLabel yang menjadi dasar penilaian.
labelSourcestringyaSet label mana yang digunakan, yang bukan sekadar kosmetik: label yang dideklarasikan dokumen adalah apa yang dapat dilihat dari pembacaan sumber, sedangkan label node graf adalah set final yang dijadikan dasar penilaian oleh build itu sendiri. Jawaban yang dihitung atas set kedua merupakan pernyataan tentang apa yang akan dilakukan build.
candidatesSourcedEntityRef[] atau nullyaSetiap Feature yang dapat dilampirkan.
slotsSlotCandidacy[]tidakHanya ada jika permintaan menamai sebuah koneksi: setiap slot yang dideklarasikan socket koneksi tersebut, dalam urutan Component mendeklarasikannya, beserta Features yang dapat mengisinya. Kosong jika tidak ada slot yang dapat diisi pada koneksi tersebut, dan noSlotReason lalu menjelaskan alasannya — yang dibaca klien alih-alih menganggap daftar kosong sebagai slot yang tidak cocok dengan Feature mana pun.
noSlotReasonconst “feature-created-connection” atau const “ad-hoc-socket” atau const “no-slot-declared”tidakHanya ada jika permintaan menamai sebuah koneksi dan tidak ada slot yang dapat diisi padanya: alasan tidak ada yang dapat dilampirkan di sana. Tidak ada di mana pun socket mendeklarasikan slot. Set ini tertutup. Nilai yang diizinkan: "feature-created-connection" — Sebuah Feature menggambar koneksi tersebut, dan lampiran hanya ditulis pada koneksi yang digambar oleh komponen atau Release. "ad-hoc-socket" — Socket tersebut tidak dideklarasikan oleh Component, sehingga tidak mendeklarasikan slot untuk diisi koneksi. "no-slot-declared" — Component mendeklarasikan socket tersebut dan tidak mendeklarasikan slot apa pun padanya.

Properti tambahan tidak diizinkan.

ConnectionCandidatesResult

Entitas mana saja yang dapat dihubungkan ke setiap socket pada entitas.

PropertiJenisWajibDeskripsi
nodestringyaEntitas pemilik socket-socket ini.
adHocSocketsAcceptedbooleanyaApakah socket yang tidak dideklarasikan sebelumnya oleh definisi entitas itu sendiri masih dapat ditulis.
socketsSocketCandidacy[] atau nullyaSetiap socket dan apa yang dapat dihubungkan ke dalamnya.

Properti tambahan tidak diizinkan.

InsertionPointResult

Di mana dalam dokumen entri baru di bawah kontainer yang dinamai seharusnya ditempatkan, dan apa yang dibutuhkan klien untuk menuliskannya di sana: titik itu sendiri, apakah teks harus diawali dengan jeda baris, kunci kontainer yang masih belum ada, dan indentasi setiap baris.

PropertiJenisWajibDeskripsi
filestringyaDokumen tersebut.
containerstring[] atau nullyaJalur melalui dokumen menuju kontainer.
positionEncodingstringyaEncoding yang digunakan untuk menyatakan posisi dalam jawaban ini.
positionPositionyaSuatu tempat dalam dokumen: baris dan offset karakter di dalamnya, keduanya dihitung mulai dari nol. Offset diukur dalam satuan encoding yang disepakati sesi saat dibuka, yaitu UTF-16 kecuali klien meminta yang lain.
precededByLineBreakbooleanyaApakah teks yang ditulis pada posisi tersebut harus diawali dengan jeda baris, karena posisi berada di akhir baris yang sudah dimuat dokumen. Nilainya false hanya jika dokumen tidak memuat apa pun untuk diikuti entri.
missingContainerKeysstring[] atau nullyaSegmen jalur kontainer yang belum dimuat dokumen, dimulai dari yang terluar. Masing-masing harus ditulis sebagai kunci tersendiri, diindentasi satu langkah lebih jauh daripada yang sebelumnya, sebelum entri dapat ditempatkan di dalam yang terdalam. Nilainya null jika seluruh jalur sudah ada.
entryIndentintegeryaKolom tempat baris pertama entri itu sendiri dimulai, dihitung dalam spasi dari awal baris.
indentStepintegeryaSeberapa jauh tambahan indentasi untuk setiap tingkat nesting.
indentStepMeasuredbooleanyaApakah langkah diukur dari nesting dokumen ini sendiri. Jika false, dokumen tidak menunjukkan nesting yang dapat diukur dan langkah tersebut merupakan nilai cadangan, sehingga klien yang lebih suka menerapkan nilainya sendiri tahu bahwa ia bebas melakukannya.
entryShapeconst “mapping” atau const “sequence” atau const “unknown”yaBentuk yang digunakan kontainer untuk memuat entrinya, yang menentukan cara teks entri itu sendiri disusun. Bentuk ini dibaca dari kontainer yang sudah dimuat dokumen dan tidak pernah disimpulkan dari nama kontainer. Set ini tertutup. Nilai yang diizinkan: "mapping" — Kontainer adalah block mapping, sehingga entri yang ditambahkan kepadanya adalah sebuah kunci dan nilainya. "sequence" — Kontainer adalah block sequence, sehingga entri yang ditambahkan kepadanya adalah tanda hubung dan nilainya. "unknown" — Dokumen tidak memuat kontainer, atau memuatnya tanpa isi, sehingga bentuk yang diambil entri ditentukan oleh klien.

Properti tambahan tidak diizinkan.

AttachmentContainerResult

Di dokumen mana, dan di bagian mana di dalamnya, sebuah lampiran pada node graf, atau pada koneksi yang dinamai permintaan, seharusnya ditempatkan.

PropertiJenisWajibDeskripsi
nodestringyaNode graf yang menjadi tujuan lampiran.
filestringyaDokumen tempat lampiran seharusnya berada.
containerstring[] atau nullyaJalur melalui dokumen tersebut menuju tempat lampiran seharusnya berada.

Properti tambahan tidak diizinkan.

ConnectionAtPositionResult

Koneksi yang entrinya memuat posisi tersebut, atau alasan tidak ada yang dilaporkan. Tepat satu bagian yang ada: graphNode dan connection bersama-sama, atau noConnectionReason saja. Posisi di mana pun di dalam sebuah entri — pada alias, target, atau lampirannya — berada di dalam entri tersebut, yaitu entri terdalam jika entri bersarang; posisi pada kunci socket itu sendiri, di atas entri yang ditulis di bawahnya, tidak berada di dalam entri mana pun.

PropertiJenisWajibDeskripsi
graphNodestringtidakId node yang komponennya menggambar koneksi, sebagaimana graf hasil kompilasi menjadikannya kunci — nilai yang diterima permintaan kandidat dan kontainer sebagai graphNode.
connectionConnectionCoordinatetidakKoneksi, berdasarkan socket dan aliasnya, dengan document yang menamai dokumen tempat posisi dibaca — nilai yang diterima permintaan kandidat dan kontainer sebagai connection.
noConnectionReasonconst “no-connection-entry” atau const “feature-created-connection” atau const “unknown-connection”tidakHanya ada jika tidak ada koneksi yang dilaporkan: alasannya. Set ini tertutup. Nilai yang diizinkan: "no-connection-entry" — Posisi tidak berada pada entri mana pun tempat lampiran ditulis: bukan koneksi yang digambar komponen dan ditulis di bawah aliasnya, bukan pula entri per-edge di Release. Koneksi yang ditulis sebagai daftar target, dan koneksi yang digambar oleh blok milik Feature sendiri, tidak memiliki entri semacam itu. "feature-created-connection" — Posisi berada pada entri Release untuk koneksi yang digambar oleh Feature, dan lampiran hanya ditulis pada koneksi yang digambar oleh komponen atau Release. "unknown-connection" — Posisi berada pada entri yang ditulis Release untuk koneksi yang tidak ada dalam graf hasil kompilasi.

Properti tambahan tidak diizinkan.

ReleaseCandidatesResult

Releases yang dimuat workspace, beserta tautan yang mengarah keluar darinya, ke direktori dan ke file, yang tidak dibaca untuknya.

PropertiJenisWajibDeskripsi
releasesstring[] atau nullyaSetiap dokumen Release.
lockfilesmap of stringyaLockfile dari setiap Release yang tercantum, dengan kunci berupa Release persis seperti yang tercantum. Masing-masing adalah file yang ditulis oleh pull untuk Release tersebut dan dibaca oleh build, sehingga klien membaca lokasinya alih-alih menyimpulkannya sendiri. Kosong bila workspace tidak memuat Release.
unreadLinkedDirsstring[]yaSetiap tautan di bawah root workspace yang mengarah ke direktori di luarnya, dinamai relatif terhadap root tempat tautan itu sendiri berada, dalam urutan pencarian workspace. Tidak ada direktori di luar root yang dicari, sehingga Release yang hanya terjangkau melalui salah satu tautan ini tidak ada di releases, dan klien yang menawarkan Releases dapat menjelaskan alasannya. Tidak dinamai: tautan ke direktori di dalam root, yang dicari, atau dikecualikan, di tempat ia sebenarnya berada; tautan di mana pun sebuah direktori akan dikecualikan, baik karena lokasinya maupun namanya; dan tautan yang tidak dapat di-resolve, karena tidak mengarah ke mana pun atau berputar dalam loop. Kosong bila workspace tidak memuatnya.
unreadLinkedFilesstring[]yaSetiap tautan di bawah root workspace yang dinamai seperti file YAML, dengan namanya sendiri berakhiran .yaml atau .yml, dan mengarah ke file di luar root, dinamai relatif terhadap root tempat tautan itu sendiri berada, dalam urutan pencarian workspace. File semacam itu tidak dibaca, sehingga Release yang hanya terjangkau melalui salah satu tautan ini tidak ada di releases, dan klien yang menawarkan Releases dapat menjelaskan alasannya. Apakah sebuah file merupakan Release tidak dapat diketahui tanpa membacanya, sehingga setiap tautan semacam itu dinamai apa pun isi filenya. Tidak dinamai: tautan ke file yang dinamai konfigurasi workspace sebagai Release, sebagai build.authoring_release atau sebagai kunci workspace.releases, yang dibaca dan dicantumkan di releases pada tempat tautan itu sendiri; tautan ke file di dalam root, yang dibaca; tautan di dalam direktori yang dikecualikan pencarian; dan tautan yang tidak mengarah ke file, baik ke direktori, yang dinamai oleh unreadLinkedDirs bila mengarah keluar dari root, maupun ke tidak ke mana pun, atau berputar dalam loop. File konfigurasi workspace yang berupa tautan yang mengarah keluar dari workspace, yaitu .aggrega-config.yaml miliknya sendiri atau overlay milik CI di sebelahnya, dinamai terlepas dari apakah pencarian menjumpainya atau tidak, setelah tautan yang dinamai pencarian: konfigurasi workspace kemudian sama sekali tidak dibaca, jawaban ini dibaca tanpa konfigurasi apa pun, sehingga tidak ada Release yang dinamai konfigurasi melalui tautan yang dicantumkan, dan setiap permintaan yang ditentukan oleh konfigurasi ditolak untuk workspace tersebut dengan kondisi penahanan baca. Kosong bila workspace tidak memuatnya.

Properti tambahan tidak diizinkan.

ActiveReleaseResult

Release mana yang secara default harus ditangani klien. Workspace yang tidak menunjuk ke Release mana pun adalah keadaan biasa, bukan kegagalan, sehingga hal itu dilaporkan di sini beserta penjelasan tentang bagaimana pemilihan dicoba, alih-alih dimunculkan sebagai error.

PropertiJenisWajibDeskripsi
releasestringyaRelease yang ditetapkan, atau kosong bila tidak ada.
lockfilestringtidakLockfile dari Release yang ditetapkan: file yang ditulis oleh pull untuknya dan dibaca oleh build. Tidak ada bila tidak ada Release yang ditetapkan.
reasonstringtidakAlasan tidak ada Release yang ditetapkan.
tracestringtidakSetiap langkah pemilihan dan apa yang ditemukannya, sehingga pemanggil dapat melihat langkah mana yang akan menetapkannya.

Properti tambahan tidak diizinkan.

EditDocumentResult

Apa yang ditulis oleh pengeditan, dan di mana. Setelah penulisan, hasil pembacaan daemon atas dokumen tersebut dibuang, sehingga jawaban berikutnya tentangnya dihitung dari byte yang dihasilkan pengeditan.

PropertiJenisWajibDeskripsi
filestringyaDokumen yang diedit.
editstringyaPengeditan mana yang diterapkan.
containerstring[] atau nullyaJalur melalui dokumen ke tempat pengeditan berlaku.
createdContainersstring[] atau nullyaContainer yang harus dibuat oleh pengeditan di sepanjang jalan.
writtenstring[] atau nullyaDokumen-dokumen yang ditulis.
contentstringyaDokumen yang tersusun, untuk permintaan yang meminta agar hasilnya ditampilkan alih-alih ditulis.

Properti tambahan tidak diizinkan.

EffectiveConfigurationResult

Konfigurasi yang di-resolve oleh workspace, dan dari dokumen mana setiap pengaturan berasal.

PropertiJenisWajibDeskripsi
layersstring[] atau nullyaDokumen konfigurasi yang digabungkan, dalam urutan penggabungannya.
settingsEffectiveConfigurationSetting[] atau nullyaSetiap pengaturan yang di-resolve dan asalnya.

Properti tambahan tidak diizinkan.

ConfigInitResult

Apa yang ditulis oleh penyemaian konfigurasi, di mana, dan apa yang dibacanya dari registry.

PropertiJenisWajibDeskripsi
hoststringyaRegistry yang menjadi tujuan penyemaian konfigurasi.
scopeConfigWriteScopeyaDokumen konfigurasi mana yang ditulis dan seberapa jauh jangkauannya. Sebuah permintaan menyebut satu workspace, sehingga jawaban yang tidak menyebutkan apa pun akan dibaca sebagai jawaban tentang workspace tersebut — dan untuk penulisan tingkat mesin, pembacaan itu keliru.
trustTrustFetchOutcomeyaApa hasil pembacaan kebijakan kepercayaan yang diumumkan sebuah registry. Hasil-hasil ini dipisahkan karena maknanya berbeda: kebijakan yang diumumkan diambil, registry tidak mengumumkan apa pun — yang bukan merupakan kegagalan — baseline bawaan dipasang sebagai gantinya, atau tidak ada pembacaan yang dicoba. Jika tidak ada yang diumumkan, apakah registry dapat dijangkau sama sekali dinyatakan di sampingnya.
writtenbooleanyaApakah dokumen ditulis, alih-alih dikembalikan agar ditempatkan oleh pemanggil.
existedbooleantidakAda dan bernilai true bila dokumen sudah ada, sehingga entri registry digabungkan ke dalamnya alih-alih membuat dokumen baru. Hanya permintaan yang mengirim force yang dilanjutkan di atas dokumen yang sudah ada, sehingga properti ini tidak ada di setiap jawaban untuk permintaan yang tidak mengirimnya.
contentstringtidakTeks dokumen, untuk permintaan yang meminta agar teks itu ditampilkan alih-alih ditulis.

Properti tambahan tidak diizinkan.

ConfigCaptureResult

Apa yang ditulis oleh pembekuan konfigurasi yang di-resolve ke dalam dokumen milik workspace ini sendiri.

PropertiJenisWajibDeskripsi
configFilestringyaDokumen yang ditulis. Dokumen ini selalu milik workspace ini sendiri, karena seluruh tujuannya adalah membuat satu workspace mandiri.
workspaceRootstringyaWorkspace yang disebut oleh permintaan.
capturedbooleanyaApakah ada sesuatu yang dibekukan.
socketsConfigCapturedSocket[] atau nullyaSetiap socket yang dibekukan, beserta attachment-nya.
catalogDirsstring[] atau nullyaDirektori katalog yang dibekukan.

Properti tambahan tidak diizinkan.

ImportResult

Apa yang dihasilkan oleh konversi sumber asing, dan apa yang tidak dapat dikonversinya.

PropertiJenisWajibDeskripsi
formatstringyaFormat sumber yang dikonversi.
outputDirstringyaDirektori yang menjadi acuan relatif setiap jalur dalam jawaban, dan tempat file-file ditulis.
writtenstring[] atau nullyaSetiap file yang sampai ke disk, dalam urutan penulisan: draf-draf, lalu catatan tentang apa yang ditulis oleh impor. Dalam sync, hanya draf yang diubah sync dan catatan bila catatan itu berubah. Kosong dalam dryRun.
filesImportedFile[] atau nullyaSetiap file yang ditulis oleh permintaan, beserta teksnya, dengan maupun tanpa dryRun: setiap draf, lalu catatan tentang apa yang ditulis oleh impor. Dalam sync, setiap draf yang diubah sync, dengan teks barunya, lalu catatan bila catatan itu juga berubah, sehingga sync yang sudah selaras menjawab dengan daftar kosong.
driftImportDrift[]yaSetiap bagian yang diselaraskan sync dengan sumber, atau akan diselaraskan dalam dryRun, dalam urutan yang dinamai draf; file draf yang dihapus sync termasuk di antaranya, dihapus tanpa kunci. Daftar kosong untuk permintaan yang bukan sync, untuk sync yang sudah selaras, dan untuk sync yang konversinya berhenti, yang tidak menulis apa pun.
diagnosticsImportDiagnostic[] atau nullyaApa yang tidak dapat dikonversi.
decisionsImportDecision[]yaBagaimana importer memetakan setiap node sumber, dalam urutan importer dan persis seperti yang dilaporkannya: inilah yang memberi tahu Anda di mana konversi menebak. Disertakan dalam kedua cara penyampaian dan terlepas dari apakah konversi berhenti atau tidak, dan berupa daftar kosong untuk importer yang tidak melaporkan apa pun.
owedImportOwed[]tidakSetiap nilai yang masih dibiarkan kosong oleh draf, yang tidak dapat disediakan oleh sumber mana pun dan tidak disediakan oleh jawaban mana pun, dalam urutan penulisan draf — nilai-nilai yang disebut oleh temuan peringatan. Setiap jawaban memuatnya, berupa daftar kosong jika draf tidak kekurangan apa pun.
haltedbooleanyaApakah konversi berhenti alih-alih selesai dengan temuan.

Properti tambahan tidak diizinkan.

ScaffoldEntityResult

Dokumen awal hasil draf, daftar contoh yang dapat dijalankan, atau contoh yang ditulis — setiap bentuk menjawab dengan field-nya sendiri dan membiarkan field lainnya tidak ada.

PropertiJenisWajibDeskripsi
kindstringtidakJenis entitas yang dirancang. Ada pada draf.
skeletonstringtidakTeks dokumen yang dirancang. Ada pada draf.
examplesScaffoldExample[]tidakSetiap contoh yang dapat dijalankan yang dipublikasikan dokumentasi, masing-masing sekali, dalam urutan nama. Ada pada daftar yang menemukan setidaknya satu contoh.
examplestringtidakContoh yang ditulis. Ada pada penulisan.
dirstringtidakDirektori tempat contoh ditulis, relatif terhadap root workspace, sebagaimana disebutkan permintaan atau, jika permintaan tidak menyebutkannya, sebagai nama contoh. Ada pada penulisan.
filesstring[]tidakSetiap berkas yang ditulis, relatif terhadap dir dan dipisahkan garis miring, dalam urutan yang dimuat dokumentasi. Ada pada penulisan.
nextstring[]tidakPerintah yang diberikan halaman contoh untuk membangunnya, baris demi baris sebagaimana ditulis halaman, termasuk komentar: blok shell pertama di bawah judul Build-nya. Tidak ada jika halaman tidak memberikannya.
versionstringtidakVersi dokumentasi tempat contoh dibaca: versi milik biner itu sendiri jika ada yang dipublikasikan untuknya, jika tidak, versi terbaru yang dipublikasikan sebelumnya. Ada pada penulisan.

Properti tambahan tidak diizinkan.

ScaffoldExample

Satu contoh yang dapat dijalankan yang dipublikasikan dokumentasi.

PropertiJenisWajibDeskripsi
namestringyaNama contoh, yang dikirim permintaan sebagai example untuk menulisnya.
levelstringyaTingkat yang dideklarasikan halaman contoh untuknya.
summarystringyaKalimat pertama halaman contoh.

Properti tambahan tidak diizinkan.

LintResult

Apa yang ditemukan oleh pemeriksaan konvensi, dihitung menurut tingkat keparahan dan dicantumkan per dokumen. Pemeriksaan seluruh katalog yang dijalankan sekali untuk setiap Release juga membawa passes; hitungan dan files kemudian mencakup semua pass sekaligus.

PropertiJenisWajibDeskripsi
entitystringtidakSatu entitas yang diperiksa, jika permintaan menyebutkan satu.
releasestringtidakRelease yang closure-nya diperiksa, jika permintaan menyebutkan satu.
checkedintegeryaBerapa banyak dokumen yang diperiksa. Jika pemeriksaan dijalankan sekali untuk setiap Release, jumlahnya adalah total atas semua pass: dokumen yang dibaca oleh dua pass dihitung pada masing-masing pass.
findingsintegeryaBerapa banyak temuan secara keseluruhan.
errorsintegeryaBerapa banyak di antaranya yang berupa galat.
warningsintegeryaBerapa banyak di antaranya yang berupa peringatan.
infosintegeryaBerapa banyak di antaranya yang bersifat informasi.
filesLintFileFindings[] atau nullyaTemuan, per dokumen.
haltedbooleanyaApakah pemeriksaan berhenti alih-alih selesai dengan temuan.
passesLintPass[] atau nulltidakPemeriksaan seluruh katalog, satu pass demi satu pass, hanya ada jika pemeriksaan dijalankan sekali untuk setiap Release karena workspace menyebutkan Releases di bawah workspace.releases. Setiap pass menyatakan untuk Releases mana temuannya ditemukan. Tidak ada untuk workspace yang tidak menyebutkan satu pun, yang diperiksa sekali atas direktorinya sendiri, dan untuk pemeriksaan satu entitas atau closure sebuah Release.

Properti tambahan tidak diizinkan.

LintPass

Satu pass dari pemeriksaan konvensi seluruh katalog dalam workspace yang memberi Releases-nya direktori katalog sendiri: Releases yang menjadi sasaran pass tersebut, direktori yang dibacanya, dan apa yang ditemukannya di sana.

PropertiJenisWajibDeskripsi
releasesstring[] atau nullyaReleases yang menjadi sasaran pass, masing-masing sebagai path relatif terhadap root workspace. Releases yang membaca direktori katalog yang sama berbagi satu pass.
catalogDirsstring[] atau nullyaDirektori katalog yang dibaca pass, dalam urutan pencariannya, masing-masing relatif terhadap root workspace jika berada di dalamnya. Kosong jika Releases-nya tidak membaca direktori katalog apa pun, sehingga pass tidak memeriksa apa pun dan tidak menggagalkan pass lainnya.
checkedintegeryaBerapa banyak dokumen yang diperiksa oleh pass.
findingsintegeryaBerapa banyak temuan yang ditemukan oleh pass.
errorsintegeryaBerapa banyak di antaranya yang berupa galat.
warningsintegeryaBerapa banyak di antaranya yang berupa peringatan.
infosintegeryaBerapa banyak di antaranya yang bersifat informasi.
filesLintFileFindings[] atau nullyaTemuan pass, per dokumen.

Properti tambahan tidak diizinkan.

PluginAddResult

Apa yang ditulis saat memasang plugin, di mana, dan versi mana yang di-pin.

PropertiJenisWajibDeskripsi
typestringyaSocket tempat plugin dipasang.
identitystringtidakIdentitas yang menjadi hasil resolusi pemasangan.
uristringtidakReferensi tempat attachment di-resolve.
capabilitystringtidakKapabilitas yang dilayani attachment.
referencestringtidakReferensi yang di-pin, termasuk versinya.
scopePluginWriteScopeyaDokumen konfigurasi mana yang menjadi tempat penulisan perubahan plugin dan seberapa jauh jangkauannya. Default socket ekstensi perintah sendiri adalah dokumen tingkat mesin, sehingga setiap jawaban menyebutkan dokumen mana yang ditulisnya.
writtenbooleanyaApakah dokumen konfigurasi ditulis, alih-alih dikembalikan agar ditempatkan oleh pemanggil.
contentstringtidakTeks dokumen konfigurasi, untuk permintaan yang meminta agar teks itu ditampilkan alih-alih ditulis.
retractionPluginRetractiontidakBagaimana penanda deprecation memengaruhi versi plugin yang di-pin.
withdrawnbooleantidakBernilai true jika kueri menamai versi yang di-pin dan retraksi yang dipercaya workspace ini telah menarik versi tersebut. Versi yang dinamai tetap di-pin, karena menamainya adalah override-nya. Tidak ada jika sebaliknya, dan ketiadaannya tidak berarti versi tersebut tidak ditarik: jika penanda penarikan dari versi yang dinamai tidak dapat dibaca, retraction.unscreened menyebutkan alasannya, dan jika tidak ada versi yang dinamai, versi terpublikasi terbaru dipilih dan retraction melaporkan apa yang disimpulkan pemeriksaan penarikan tentang pilihan tersebut.

Properti tambahan tidak diizinkan.

PluginRemoveResult

Apa yang ditulis saat melepas plugin, dan di mana.

PropertiJenisWajibDeskripsi
typestringyaSocket tempat plugin dipasang.
querystringyaPemasangan mana yang dihapus.
scopePluginWriteScopeyaDokumen konfigurasi mana yang menjadi tempat penulisan perubahan plugin dan seberapa jauh jangkauannya. Default socket ekstensi perintah sendiri adalah dokumen tingkat mesin, sehingga setiap jawaban menyebutkan dokumen mana yang ditulisnya.

Properti tambahan tidak diizinkan.

PluginSyncResult

Apa yang diubah saat menyelaraskan catatan milik mesin dari entitas Plugin dengan modulnya.

PropertiJenisWajibDeskripsi
entitystringyaDokumen entitas Plugin yang diselaraskan.
hostFunctionsstring[] atau nullyaFungsi host yang dinyatakan diperlukan oleh modul.
commandsPluginCLICommand[] atau nullyaPerintah yang disumbangkan oleh modul.
changedbooleanyaApakah ada sesuatu dalam dokumen yang benar-benar berubah.

Properti tambahan tidak diizinkan.

PluginGenCatalogResult

Dokumen katalog yang dihasilkan oleh suatu pembuatan.

PropertiJenisWajibDeskripsi
documentsPluginGeneratedDocument[]tidakSetiap dokumen yang dihasilkan beserta teksnya.
noticesstringtidakApa pun yang ingin disampaikan oleh proses pembuatan kepada pemanggil.
dryRunbooleanyaApakah dokumen dikembalikan alih-alih ditulis.

Properti tambahan tidak diizinkan.

ExplainErrorResult

Apa yang dinyatakan compiler tentang suatu kondisi, dan bagian terbitan yang mengajarkan perbaikan penulisannya.

PropertiJenisWajibDeskripsi
shortCodestringyaKode singkat kondisi.
codestringyaNama deskriptif kondisi.
messagestringyaApa yang dinyatakan kondisi saat dimunculkan.
entriesExplainErrorEntry[]tidakBagian terbitan yang mengajarkan perbaikannya.
referencestringyaAlamat terpublikasi tempat kondisi dijelaskan.
notestringtidakMengapa bagian terbitan tidak ada, jika bagian itu tidak dapat diperoleh. Apa yang dinyatakan oleh biner itu sendiri tetap dijawab.

Properti tambahan tidak diizinkan.

GetSchemaResult

Skema suatu jenis, atau — jika permintaan tidak menyebutkan satu pun — jenis mana saja yang dapat disebutkan. Kedua cakupan ini dibawa dalam satu jawaban alih-alih dua metode, karena “apa yang boleh saya sebutkan” dan “yang mana di antaranya yang dokumennya ditulis oleh penulis” adalah pertanyaan yang sama dalam dua cakupan, dan dua jawaban harus dijaga agar tetap selaras.

PropertiJenisWajibDeskripsi
kindstringtidakJenis yang menjadi sasaran skema.
schemaanytidakSkema itu sendiri, diteruskan sebagaimana disimpan oleh biner.
kindsstring[]tidakSetiap token yang dijawab oleh biner ini.
entityKindsEntityKindDescriptor[]tidakHimpunan yang lebih sempit yang dokumennya ditulis oleh penulis, masing-masing memasangkan token yang disebutkan permintaan dengan jenis yang dinyatakan oleh header dokumen itu sendiri.

Properti tambahan tidak diizinkan.

SkillsInstallResult

Apa yang ditulis oleh pemasangan skill asisten, dan di mana.

PropertiJenisWajibDeskripsi
skillstringyaSkill yang ditulis.
installedSkillsInstalledFolder[]yaSetiap folder skill yang ditulis, dalam urutan permintaan menyebutkan asisten. Asisten yang membaca satu folder bersama berbagi satu entri, karena skill ditulis ke sana sekali.
scopeSkillFolderScopeyaSeberapa jauh jangkauan pemasangan skill. Permintaan menyebutkan satu workspace, sehingga jawaban yang tidak menyatakan apa pun akan dibaca sebagai berkaitan dengan workspace tersebut — dan untuk folder per pengguna, yang dibaca asisten di setiap proyek, pembacaan itu keliru.

Properti tambahan tidak diizinkan.

SkillsInstalledFolder

Satu folder skill yang ditulis oleh sebuah pemasangan.

PropertiJenisWajibDeskripsi
agentsstring[]yaPengidentifikasi asisten yang disebutkan yang membaca folder ini, dalam urutan permintaan menyebutkannya.
folderstringyaFolder skill, sebagai path absolut.
replacedbooleanyaApakah salinan yang memuat baris komentar yang dimuat setiap salinan skill yang ditulis — yang ditulis pemasangan sebelumnya, atau yang diambil dari repositori skill yang dipublikasikan — ada di sana dan telah diganti. Berkas di sana tanpa baris tersebut ditolak alih-alih diganti.

Properti tambahan tidak diizinkan.

SkillsListResult

Skill yang disertakan biner dan setiap asisten yang dapat dituliskan skill tersebut oleh sebuah pemasangan. Tidak ada yang ditulis dan tidak ada yang dihubungi.

PropertiJenisWajibDeskripsi
skillsSkillsListedSkill[]yaSetiap skill yang disertakan biner, dalam urutan tetap.
agentsSkillsListedAgent[]yaSetiap asisten yang folder skill-nya diketahui oleh pemasangan, diurutkan berdasarkan pengidentifikasi.

Properti tambahan tidak diizinkan.

SkillsListedSkill

Satu skill yang disertakan biner.

PropertiJenisWajibDeskripsi
namestringyaNama skill, yang juga merupakan nama folder yang ditulis oleh pemasangan.
descriptionstringyaKapan asisten menggunakan skill, sebagaimana dideklarasikan oleh skill itu sendiri.

Properti tambahan tidak diizinkan.

SkillsListedAgent

Satu asisten yang dapat dituliskan skill oleh sebuah pemasangan, beserta dua folder tempat asisten tersebut membaca skill.

PropertiJenisWajibDeskripsi
idstringyaPengidentifikasi yang digunakan permintaan untuk menyebutkan asisten.
namestringyaNama asisten itu sendiri.
projectFolderstringyaFolder, relatif terhadap root proyek dan dipisahkan dengan garis miring, tempat asisten membaca skill proyek. Pemasangan proyek menulis folder skill di dalamnya, di workspace yang disebutkan permintaan.
userFolderstringyaFolder, relatif terhadap direktori home dan dipisahkan dengan garis miring, tempat asisten membaca skill milik pengguna sendiri di setiap proyek. Pemasangan dengan global menulis folder skill di dalamnya.

Properti tambahan tidak diizinkan.