Go client: Convert cannot set `documents` / `compact` / `omit_derived` / `keep_derived` / `include_check_diagnostics` (service and every other client expose them)

Aperta
#2,330 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@devin-ai-integration ci sta già lavorando.

Dal 16/11/2026.

  • #2331 di @devin-ai-integration — aperta

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

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

enhancement performance

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 a model_hash, write only these documents;
    the rest are read for references. Empty writes every document. Reported as
    convert_documents.
  • bool compact = 9 — write api-json-compact/1. Reported as convert_compact.
  • bool omit_derived = 10 — with compact, drop derived metamodel properties
    except those in keep_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 — convertOptions has only
    from, tolerated, idForm, libraryStubs, inherited.
  • client/opensysml/authoring.go:199 — convertRequest sets only
    FromFormat, ToFormat, TolerateSyntaxErrors, IdForm,
    IncludeLibraryStubs, InheritedMembers.
  • No WithDocuments, WithCompact, WithOmitDerived, WithKeepDerived,
    WithCheckDiagnostics exists 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-131 marks Go "bound" for
    convert_documents / convert_compact; the options table at :146 omits the
    Go column entirely, and client/opensysml/parity_options_test.go has no test
    for any of these request fields. TestClientCapabilityChecklist only 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, Convert 14.9 s,
    Generate 1.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

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di Open-MBEE/OpenSysML

Tutte le issue di Open-MBEE/OpenSysML

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.