Go client: Convert cannot set `documents` / `compact` / `omit_derived` / `keep_derived` / `include_check_diagnostics` (service and every other client expose them)
Maintainer thường phản hồi trong vòng 1 ngày
@devin-ai-integration đang làm issue này rồi.
Từ ngày 16/11/2026.
- #2331 của @devin-ai-integration — đang mở
Đánh giá
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức phù hợp với người mới
- 35/100
- Loại issue
- Tính năng
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- go
- Lĩnh vực
- api, backend-api-design
Hướng nghiên cứu
Start with client/opensysml/authoring.go to trace how convertOptions become ConvertRequest fields, then review the request definitions in api/proto/sysml.proto and the existing option patterns. Add coverage in client/opensysml/parity_options_test.go and update docs/reference/client-parity.md; done means the Go client can set the listed conversion options and tests verify the corresponding request fields.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Disclaimer, the following issue report has been written by an AI
Summary
ConvertRequest supports document-scoped and compact API-JSON conversion, and every
non-Go client exposes it. client/opensysml exposes none of it: Convert always
writes every document in the model, in full derived-property form. The capability
table in docs/reference/client-parity.md nevertheless marks Go as "bound" for
convert_documents and convert_compact, because the names are declared in
types.go even though no option ever sets the request fields.
Service/CLI version: main @ cb359eb (also present in 0.12.1).
What the service already provides
api/proto/sysml.proto (ConvertRequest):
repeated string documents = 8— for amodel_hash, write only these documents;
the rest are read for references. Empty writes every document. Reported as
convert_documents.bool compact = 9— writeapi-json-compact/1. Reported asconvert_compact.bool omit_derived = 10— withcompact, drop derived metamodel properties
except those inkeep_derived.repeated string keep_derived = 11.bool include_check_diagnostics = 12— add the semantic check's diagnostics to
ConvertResponse.diagnostics, each with its severity. Reported as
convert_check_diagnostics.
What the Go client does today
client/opensysml/authoring.go:65—convertOptionshas only
from,tolerated,idForm,libraryStubs,inherited.client/opensysml/authoring.go:199—convertRequestsets only
FromFormat,ToFormat,TolerateSyntaxErrors,IdForm,
IncludeLibraryStubs,InheritedMembers.- No
WithDocuments,WithCompact,WithOmitDerived,WithKeepDerived,
WithCheckDiagnosticsexists anywhere in the package. client/opensysml/client.go:22(Client) and:358(caller) are
unexported; there is no raw/generic call, so a caller cannot set the fields
either.docs/reference/client-parity.md:130-131marks Go "bound" for
convert_documents/convert_compact; the options table at:146omits the
Go column entirely, andclient/opensysml/parity_options_test.gohas no test
for any of these request fields.TestClientCapabilityChecklistonly checks
that the capability name is declared, so the declaration alone passes while
the option is missing.
Impact
Any in-process Go program pays a full-model API-JSON conversion even when it needs
one document. Measured on a real project (PLAIN, Reactor across its library and
the generated IFC vocabulary):
- 572 KB of sources -> 79.7 MB / 51,386 elements,
Convert14.9 s,
Generate1.0 s; - converting only the project document would be ~8.2k elements and ~5.4 s, and the
walker needs only the annotated usages.
There is no workaround: the service supports documents, but the only public Go
door does not.
Proposed API
Follow the existing option style (WithIDForm, WithLibraryStubs,
WithInheritedMembers):
// WithDocuments writes only the named documents of a parsed model; the model's
// other documents are read for the references into them. Requires
// CapabilityConvertDocuments.
func WithDocuments(names ...string) ConvertOption
// WithCompact writes the compact api-json-compact/1 document.
// Requires CapabilityConvertCompact.
func WithCompact() ConvertOption
// WithOmitDerived drops derived metamodel properties from a compact document,
// except the ones named in keep. Requires CapabilityConvertCompact.
func WithOmitDerived(keep ...string) ConvertOption
// WithCheckDiagnostics adds the semantic check's diagnostics (with severity) to
// Conversion.Diagnostics. Requires CapabilityConvertCheckDiagnostics.
func WithCheckDiagnostics() ConvertOption
- Ngôn ngữ chính
- Go
- Star
- 59
- Fork
- 20
- Merge trung bình
- 10 giờ 23 phút
- Pull request đã merge (30 ngày)
- 897
Chuẩn bị môi trường
- Có Dockerfile hoặc tệp Docker Compose
- Có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của Open-MBEE/OpenSysML
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
Maintainer thường phản hồi trong vòng 1 ngày
-
A model's parse is still paid cold in every process; the library record cache does not cover itĐang mở
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 35/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 35/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 55/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 28/100
Maintainer thường phản hồi trong vòng 1 ngày
Tất cả issue của Open-MBEE/OpenSysML
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
Maintainer thường phản hồi trong vòng 1 ngày
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 66/100
AvengeMedia/DankMaterialShell#4301 · 1 bình luận ·
-
priority: p2 type: bug type: docs
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 84/100
googleapis/google-cloud-swift#1641 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
needs-triage
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
krakenhavoc/cmd_and_ctrl#5853 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
flaky test: TestTRTAsyncPrefillFailures/transport reads the token load before prefillDone has released itCó thể đã có người làm @Jackmeson1 đã nhận hôm nay. Đang mởarea/cicd area/gateway kind/misc
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 85/100
vllm-project/aibrix#3488 · 2 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày