Is there a singular canonical schema file for USDM?

[zero1zero]

My best sleuthing right now is the UML data structure YAML combined with the USDM_API OpenAPI specification return types. Is there a place (possibly not in this repo) where I can find the complete canonical data schema for USDM?

I'm happy to convert between any schema formats, just anything that contains the entirety of the spec.

[ghost]

The "USDM_UML.xmi" file in the UML directory is probably your best best.

[zero1zero]

Any possibility of getting an export in a more standard format for data structures, such as JSON schema? I've been trying to convert this file but have been unable to with available tooling thus far.

[zero1zero]

Since the diagram uses Enterprise Architect, maybe one of their available output formats: https://sparxsystems.com/domains/schema-composer/#output-formats?

[BSnoeijerCD]

@zero1zero
The API exchange format is in json. So, if you like to use json, you can use the api definition in the API directory.
Note that in the api, because of the flat nature of the json file, cross-references are made to avoid duplication of information, and for identification of this, are renamed (with addition of id or ids to the original name). Also, an instanceType attribute is added to each of the classes in the API json indicating the original UML class name.
If you have enterprise architect, you could also pick up the the enterprise architect file itself: USDM_UML.qea

Could you let us know if this works for you?

[zero1zero]

Thank you for the reply Barbara. I was hoping for the full JSON schema as exported directly from the UML, with inclusion of the field descriptions, types, and metadata (like NCI C-Codes).

I was able to extract this programmatically from a combination of the UML definition YAML and the OpenAPI input/output response types, but I was hoping for something more canonical that could be exported directly from EA.

I can get my hands on EA to try and export it myself (if I understand the docs correctly), but I figured it might help the project at large to have this as a regular export saved to GitHub as the spec iterates.

I've attached the schema I've extracted. This is just a POC and probably has errors, but is an example of what I was thinking.
constrained_uml_schema.json

[BSnoeijerCD]

Thank you for the reply Barbara. I was hoping for the full JSON schema as exported directly from the UML, with inclusion of the field descriptions, types, and metadata (like NCI C-Codes).

I was able to extract this programmatically from a combination of the UML definition YAML and the OpenAPI input/output response types, but I was hoping for something more canonical that could be exported directly from EA.

I can get my hands on EA to try and export it myself (if I understand the docs correctly), but I figured it might help the project at large to have this as a regular export saved to GitHub as the spec iterates.

I've attached the schema I've extracted. This is just a POC and probably has errors, but is an example of what I was thinking. constrained_uml_schema.json

That makes sense. Not all the information like NCI codes and attribute descriptions are in enterprise architect either. We are working on an update of the yml fie to include all the information from CT, API, UML and even the Core rules. We can let you know when that is available.

[BSnoeijerCD]

If you did not already do so, you can check out the dataStructure.yml file in the UML Github directory, to see wether that already helps.

[zero1zero]

If you did not already do so, you can check out the dataStructure.yml file in the UML Github directory, to see wether that already helps.

This was the main resource in generating that attached schema, with constraints and some other information coming from the OpenAPI schemas.

We can let you know when that is available.

Sounds good! Next broader update I would love to get a JSON schema or complete schema export as an artifact of the project. I'm sure it would help adoption to have that as an easy reference (and code generator source) for people.

Thank you and I'll keep tracking for updates!