aboutsummaryrefslogtreecommitdiffstats
path: root/aai-schema-gen
diff options
context:
space:
mode:
authorKeong Lim <keong.lim@huawei.com>2019-05-17 15:29:58 +1000
committerKeong Lim <keong.lim@huawei.com>2019-05-31 13:45:53 +1000
commitcae9c8df0bfdbc22cdbca4624a0bc4f9555ad5f2 (patch)
tree10e17448288c2f1dbf75256e998f16562c34eeac /aai-schema-gen
parent749dea32a7c883a1418008135ba15cdca9901c30 (diff)
AAI-2441 Swagger to document AAI schema PlantUML
Use Swagger template to generate a file close to PlantUML diagram format from the AAI schema (OXM file) Run generate-uml-snapshot.sh to massage it to complete the set of class diagrams with compositions and another set of diagrams with EdgeRule relationships Add the generated plantuml text files Ignore the /plantuml/backups/ files Change-Id: I7ef8363095bf1adcf0f7ad792051b4e593683609 Issue-ID: AAI-2441 Signed-off-by: Keong Lim <keong.lim@huawei.com>
Diffstat (limited to 'aai-schema-gen')
-rw-r--r--aai-schema-gen/src/main/resources/swagger.plantuml.ftl28
1 files changed, 28 insertions, 0 deletions
diff --git a/aai-schema-gen/src/main/resources/swagger.plantuml.ftl b/aai-schema-gen/src/main/resources/swagger.plantuml.ftl
new file mode 100644
index 0000000..8127b5f
--- /dev/null
+++ b/aai-schema-gen/src/main/resources/swagger.plantuml.ftl
@@ -0,0 +1,28 @@
+@startuml
+
+title ${version} Active and Available Inventory Relationships Class Diagram
+
+
+class Inventory
+<#list sortedAaiApis?keys as key>
+ <#list sortedAaiApis[key] as api>
+class ${api.getPath()}
+ </#list>
+</#list>
+
+"Inventory" *-- "business"
+"Inventory" *-- "cloud-infrastructure"
+"Inventory" *-- "common"
+"Inventory" *-- "external-system"
+"Inventory" *-- "network"
+"Inventory" *-- "service-design-and-creation"
+
+Note: Convert the paths below into compositions like above
+<#list sortedAaiApis?keys as key>
+ <#list sortedAaiApis[key] as api>
+${api.getPath()}
+ </#list>
+</#list>
+
+@enduml
+