From cae9c8df0bfdbc22cdbca4624a0bc4f9555ad5f2 Mon Sep 17 00:00:00 2001
From: Keong Lim <keong.lim@huawei.com>
Date: Fri, 17 May 2019 15:29:58 +1000
Subject: 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>
---
 .../src/main/resources/swagger.plantuml.ftl        | 28 ++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 aai-schema-gen/src/main/resources/swagger.plantuml.ftl

(limited to 'aai-schema-gen/src/main')

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
+
-- 
cgit 1.2.3-korg