Go client: Convert cannot set `documents` / `compact` / `omit_derived` / `keep_derived` / `include_check_diagnostics` (service and every other client expose them)
Los mantenedores suelen responder en 1 día
@devin-ai-integration ya está trabajando en esto.
Desde el 16/11/2026.
- #2331 de @devin-ai-integration — abierto
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Bien especificado
- Estado de actividad
- Estancado
- Stack tecnológico
- go
- Área
- api, backend-api-design
Línea de trabajo
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.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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
- Lenguaje dominante
- Go
- Estrellas
- 59
- Forks
- 20
- Merge medio
- 10 h 23 min
- PR fusionados (30 d)
- 897
Preparar el entorno
- Incluye un Dockerfile o un archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de Open-MBEE/OpenSysML
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
Los mantenedores suelen responder en 1 día
-
A model's parse is still paid cold in every process; the library record cache does not cover itAbierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
Los mantenedores suelen responder en 1 día
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
Los mantenedores suelen responder en 1 día
-
Dificultad 4/5 3-5 días Aptitud para principiantes 55/100
Los mantenedores suelen responder en 1 día
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 28/100
Los mantenedores suelen responder en 1 día
Todos los issues de Open-MBEE/OpenSysML
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 66/100
AvengeMedia/DankMaterialShell#4301 · 1 comentario ·
-
priority: p2 type: bug type: docs
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
googleapis/google-cloud-swift#1641 ·
Los mantenedores suelen responder en 1 día
-
needs-triage
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
krakenhavoc/cmd_and_ctrl#5853 ·
Los mantenedores suelen responder en 1 día
-
flaky test: TestTRTAsyncPrefillFailures/transport reads the token load before prefillDone has released itPosiblemente ocupada @Jackmeson1 la tomó hoy. Abiertoarea/cicd area/gateway kind/misc
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
vllm-project/aibrix#3488 · 2 comentarios ·
Los mantenedores suelen responder en 1 día