Go client: Convert cannot set `documents` / `compact` / `omit_derived` / `keep_derived` / `include_check_diagnostics` (service and every other client expose them)
I maintainer di solito rispondono entro 1 giorno
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 35/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Ferma
- Stack tecnologico
- go
- Ambito
- api, backend-api-design
Direzione di ricerca
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.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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
- Lingua principale
- Go
- Stelle
- 59
- Fork
- 20
- Merge medio
- 10h 23m
- PR unite (30g)
- 897
Preparare l'ambiente
- Include un Dockerfile o un file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di Open-MBEE/OpenSysML
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
I maintainer di solito rispondono entro 1 giorno
-
A model's parse is still paid cold in every process; the library record cache does not cover itAperta
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 55/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 28/100
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di Open-MBEE/OpenSysML
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
I maintainer di solito rispondono entro 1 giorno
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 66/100
AvengeMedia/DankMaterialShell#4301 · 1 commento ·
-
priority: p2 type: bug type: docs
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
googleapis/google-cloud-swift#1641 ·
I maintainer di solito rispondono entro 1 giorno
-
needs-triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
krakenhavoc/cmd_and_ctrl#5853 ·
I maintainer di solito rispondono entro 1 giorno
-
flaky test: TestTRTAsyncPrefillFailures/transport reads the token load before prefillDone has released itForse già presa @Jackmeson1 l’ha presa oggi. Apertaarea/cicd area/gateway kind/misc
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100
vllm-project/aibrix#3488 · 2 commenti ·
I maintainer di solito rispondono entro 1 giorno