The tooling we use to generate the diagrams for the API user guides can be found here: https://github.com/knutaa/oas2puml/packages/781389.
The latest version is 6.6.8 with this executable jar file: apidiagram-6.6.8-20230829.193646-1-exec.jar.
Run with a command like
java -jar apidiagram-6.6.8-20230829.193646-1-exec.jar diagrams --openapi <oas_file>
Some help on command line arguments can found as
java -jar apidiagram-6.6.8-20230829.193646-1-exec.jar --help
Arguments that may be relevant:
--target-directory - for the generated output files
--generate-images - to also generate png images based on the embedded plantuml version
--config - used to modify the embedded (internal) configuration used by the diagram generator
--keep-inheritance-decorations - decorations are added like shown for Organization
As seen in the user guides, the diagram generator tries to split large diagrams into "sensible" fragments without user input. There are ways to modify that behavior when necessary.
------------------------------
Knut Johannessen
Knut Johannessen
------------------------------
Original Message:
Sent: Aug 23, 2023 05:42
From: Jonathan Goldberg
Subject: TMF645 - Service Qualification - Resource Models Diagram download
As far as I know we have a combination of python scripts that generate PUML model text from the schemas in the YAML/OAS files. A FOSS is then used to create the diagrams from the PUML text.
Would be best for our generation wizard @Knut Johannessen to describe the process.
In the (medium/far?) future, there's hopefully going to be an ongoing import from the Open API model assets into TMF's MODA repository, which is their new central place for holding all models.
------------------------------
Jonathan Goldberg
Amdocs Management Limited
Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
Original Message:
Sent: Aug 23, 2023 02:44
From: Paul Stanek
Subject: TMF645 - Service Qualification - Resource Models Diagram download
Hi Jonathan
Could you say what tool you are using to generate puml files? Is that tool is FOSS kind of tool or your internal tool? I was looking for a tool online but the one I found was rather old and not working correctly.
------------------------------
Paul Stanek
Suntech S.A.
Original Message:
Sent: Apr 07, 2022 05:22
From: Jonathan Goldberg
Subject: TMF645 - Service Qualification - Resource Models Diagram download
Hi Juliano
Currently the diagrams are not available outside the Open API project. There are plans to publish the Open API data model publicly, but I don't think that this has been done yet.
We actually generate the diagrams using PlantUML, where the puml files themselves are generated from the swagger and json schema. So you could in principle parse the swagger and create uml diagrams yourself. Or maybe there's FOSS out there that can generate diagrams directly from swagger.
Hope it helps
------------------------------
Jonathan Goldberg
Amdocs Management Limited
Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
Original Message:
Sent: Apr 07, 2022 02:21
From: Juliano Sugavara
Subject: TMF645 - Service Qualification - Resource Models Diagram download
Hi TMForum Community!
I was wondering if the diagrams for resource models from API user guide are available for download somewhere.
The ones provided in the released document have several overlapping lines and text... I wanted to have access to the source diagram to have an easier view and to be able to create some custom views for some scenarios I am studying.
I looked into the .DOCX version of the document, but the diagram is a image in that document.
Thanks!
------------------------------
Juliano Sugavara
Nokia
------------------------------