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>

1 files changed, 208 insertions, 0 deletions

diff --git a/plantuml/aai_edgerules_v15.plantuml b/plantuml/aai_edgerules_v15.plantuml
new file mode 100644
index 0000000..8fed9aa
--- /dev/null
+++ b/plantuml/aai_edgerules_v15.plantuml
@@ -0,0 +1,208 @@
+@startuml
+title v15 Active and Available Inventory EdgeRule Relationships
+"allotted-resource" -- "allotted-resource" : BindsTo >
+"allotted-resource" -- "generic-vnf" : PartOf >
+"allotted-resource" -- "instance-group" : MemberOf >
+"allotted-resource" -- "l3-network" : PartOf >
+"allotted-resource" -- "l-interface" : Uses >
+"allotted-resource" -- "model-ver" : IsA >
+"allotted-resource" -- "network-policy" : Uses >
+"allotted-resource" -- "p-interface" : Uses >
+"allotted-resource" -- "vlan" : PartOf >
+"availability-zone" -- "complex" : LocatedIn >
+"availability-zone" -- "service-capability" : AppliesTo >
+"cloud-region" -- "complex" : LocatedIn >
+"cloud-region" -- "instance-group" : Uses >
+"cloud-region" -- "l3-network" : Uses >
+"cloud-region" -- "network-technology" : Uses >
+"cloud-region" -- "zone" : LocatedIn >
+"collection" -- "model-ver" : IsA >
+"complex" -- "l3-network" : Uses >
+"configuration" -- "allotted-resource" : Uses >
+"configuration" -- "configuration" : BindsTo >
+"configuration" -- "l3-network" : PartOf >
+"configuration" -- "l-interface" : AppliesTo >
+"configuration" -- "logical-link" : Uses >
+"configuration" -- "model-ver" : IsA >
+"configuration" -- "pnf" : AppliesTo >
+"configuration" -- "vnfc" : Uses >
+"configuration" -- "vpn-binding" : Uses >
+"configuration" -- "vrf" : Uses >
+"connectivity" -- "service-instance" : PartOf >
+"connectivity" -- "vpn-binding" : PartOf >
+"connector" -- "model-ver" : IsA >
+"connector" -- "virtual-data-center" : LocatedIn >
+"contact" -- "generic-vnf" : supports >
+"ctag-pool" -- "availability-zone" : AppliesTo >
+"device" -- "generic-vnf" : Uses >
+"device" -- "service-instance" : PartOf >
+"dvs-switch" -- "availability-zone" : AppliesTo >
+"esr-thirdparty-sdnc" -- "pnf" : AppliesTo >
+"ext-aai-network" -- "esr-system-info" : Uses >
+"flavor" -- "pserver" : CanBeInstantiatedIn >
+"forwarder" -- "configuration" : Uses >
+"forwarder" -- "generic-vnf" : AppliesTo >
+"forwarder" -- "lag-interface" : ForwardsTo >
+"forwarder" -- "l-interface" : ForwardsTo >
+"forwarder" -- "p-interface" : ForwardsTo >
+"forwarding-path" -- "configuration" : Uses >
+"forwarding-path" -- "service-instance" : AppliesTo >
+"generic-vnf" -- "availability-zone" : Uses >
+"generic-vnf" -- "cloud-region" : LocatedIn >
+"generic-vnf" -- "complex" : LocatedIn >
+"generic-vnf" -- "configuration" : Uses >
+"generic-vnf" -- "ctag-pool" : Uses >
+"generic-vnf" -- "esr-vnfm" : DependsOn >
+"generic-vnf" -- "instance-group" : MemberOf >
+"generic-vnf" -- "instance-group" : Uses >
+"generic-vnf" -- "ipsec-configuration" : Uses >
+"generic-vnf" -- "l3-network" : Uses >
+"generic-vnf" -- "model-ver" : IsA >
+"generic-vnf" -- "nos-server" : HostedOn >
+"generic-vnf" -- "pnf" : HostedOn >
+"generic-vnf" -- "pserver" : HostedOn >
+"generic-vnf" -- "virtual-data-center" : LocatedIn >
+"generic-vnf" -- "vnf-image" : Uses >
+"generic-vnf" -- "volume-group" : DependsOn >
+"generic-vnf" -- "vserver" : HostedOn >
+"instance-group" -- "model" : Targets >
+"instance-group" -- "model-ver" : IsA >
+"l3-interface-ipv4-address-list" -- "cp" : BelongsTo >
+"l3-interface-ipv4-address-list" -- "instance-group" : MemberOf >
+"l3-interface-ipv4-address-list" -- "l3-network" : MemberOf >
+"l3-interface-ipv4-address-list" -- "subnet" : MemberOf >
+"l3-interface-ipv6-address-list" -- "cp" : BelongsTo >
+"l3-interface-ipv6-address-list" -- "instance-group" : MemberOf >
+"l3-interface-ipv6-address-list" -- "l3-network" : MemberOf >
+"l3-interface-ipv6-address-list" -- "subnet" : MemberOf >
+"l3-network" -- "cp" : LinksTo >
+"l3-network" -- "instance-group" : MemberOf >
+"l3-network" -- "l3-network" : Uses >
+"l3-network" -- "model-ver" : IsA >
+"l3-network" -- "network-policy" : Uses >
+"l3-network" -- "route-table-reference" : Uses >
+"l3-network" -- "vpn-binding" : Uses >
+"lag-interface" -- "lag-link" : LinksTo >
+"lag-interface" -- "l-interface" : Uses >
+"lag-interface" -- "logical-link" : Uses >
+"lag-interface" -- "p-interface" : Uses >
+"lag-interface" -- "pnf" : BindsTo >
+"lag-interface" -- "pserver" : BindsTo >
+"lag-interface" -- "vpls-pe" : BindsTo >
+"lan-port-config" -- "dhcp-service" : Uses >
+"lan-port-config" -- "service-instance" : PartOf >
+"line-of-business" -- "generic-vnf" : Uses >
+"line-of-business" -- "l3-network" : Uses >
+"l-interface" -- "cp" : LinksTo >
+"l-interface" -- "instance-group" : MemberOf >
+"l-interface" -- "logical-link" : LinksTo >
+"l-interface" -- "p-interface" : BindsTo >
+"l-interface" -- "vserver" : BindsTo >
+"logical-link" -- "cloud-region" : LocatedIn >
+"logical-link" -- "generic-vnf" : BridgedTo >
+"logical-link" -- "lag-link" : Uses >
+"logical-link" -- "l-interface" : Destination >
+"logical-link" -- "l-interface" : Source >
+"logical-link" -- "logical-link" : Uses >
+"logical-link" -- "model-ver" : IsA >
+"logical-link" -- "pnf" : BridgedTo >
+"logical-link" -- "pserver" : BridgedTo >
+"logical-link" -- "virtual-data-center" : LocatedIn >
+"logical-link" -- "vpn-binding" : Uses >
+"model-element" -- "model-ver" : IsA >
+"named-query" -- "model" : AppliesTo >
+"named-query-element" -- "model" : IsA >
+"network-profile" -- "generic-vnf" : AppliesTo >
+"network-resource" -- "vpn-binding" : Uses >
+"nos-server" -- "pserver" : HostedOn >
+"oam-network" -- "complex" : AppliesTo >
+"oam-network" -- "service-capability" : AppliesTo >
+"operational-environment" -- "operational-environment" : Uses >
+"p-interface" -- "logical-link" : LinksTo >
+"p-interface" -- "physical-link" : LinksTo >
+"p-interface" -- "pnf" : BindsTo >
+"p-interface" -- "pserver" : BindsTo >
+"p-interface" -- "vpls-pe" : BindsTo >
+"platform" -- "generic-vnf" : Uses >
+"platform" -- "l3-network" : Uses >
+"pnf" -- "complex" : LocatedIn >
+"pnf" -- "instance-group" : MemberOf >
+"pnf" -- "model-ver" : IsA >
+"pnf" -- "network-resource" : LinksTo >
+"pnf" -- "zone" : LocatedIn >
+"project" -- "service-instance" : Uses >
+"pserver" -- "availability-zone" : MemberOf >
+"pserver" -- "cloud-region" : LocatedIn >
+"pserver" -- "complex" : LocatedIn >
+"pserver" -- "group-assignment" : MemberOf >
+"pserver" -- "zone" : LocatedIn >
+"sdwan-vpn" -- "service-instance" : PartOf >
+"sdwan-vpn" -- "tenant" : PartOf >
+"sdwan-vpn" -- "vpn-binding" : PartOf >
+"service-instance" -- "allotted-resource" : Uses >
+"service-instance" -- "collection" : ComposedOf >
+"service-instance" -- "configuration" : ComposedOf >
+"service-instance" -- "configuration" : Uses >
+"service-instance" -- "connector" : Uses >
+"service-instance" -- "ctag-assignment" : Uses >
+"service-instance" -- "cvlan-tag" : ComposedOf >
+"service-instance" -- "generic-vnf" : ComposedOf >
+"service-instance" -- "instance-group" : MemberOf >
+"service-instance" -- "instance-group" : Uses >
+"service-instance" -- "l3-network" : ComposedOf >
+"service-instance" -- "logical-link" : Uses >
+"service-instance" -- "model-ver" : IsA >
+"service-instance" -- "pnf" : ComposedOf >
+"service-instance" -- "service-instance" : ComposedOf >
+"service-instance" -- "vce" : ComposedOf >
+"service-instance" -- "vlan" : ComposedOf >
+"service-instance" -- "zone" : LocatedIn >
+"service-subscription" -- "tenant" : Uses >
+"site-pair-set" -- "generic-vnf" : AppliesTo >
+"site-resource" -- "allotted-resource" : Uses >
+"site-resource" -- "complex" : Uses >
+"site-resource" -- "service-instance" : PartOf >
+"sp-partner" -- "service-instance" : PartOf >
+"sriov-vf" -- "sriov-pf" : Uses >
+"tenant" -- "group-assignment" : MemberOf >
+"tenant" -- "l3-network" : Uses >
+"tenant" -- "volume-group" : DependsOn >
+"vce" -- "availability-zone" : Uses >
+"vce" -- "complex" : LocatedIn >
+"vce" -- "vserver" : HostedOn >
+"vf-module" -- "l3-network" : DependsOn >
+"vf-module" -- "model-ver" : IsA >
+"vf-module" -- "vnfc" : Uses >
+"vf-module" -- "volume-group" : Uses >
+"vf-module" -- "vserver" : Uses >
+"vip-ipv4-address-list" -- "cp" : Uses >
+"vip-ipv4-address-list" -- "instance-group" : MemberOf >
+"vip-ipv4-address-list" -- "subnet" : MemberOf >
+"vip-ipv6-address-list" -- "cp" : Uses >
+"vip-ipv6-address-list" -- "instance-group" : MemberOf >
+"vip-ipv6-address-list" -- "subnet" : MemberOf >
+"vlan" -- "l-interface" : LinksTo >
+"vlan" -- "logical-link" : Uses >
+"vlan" -- "multicast-configuration" : Uses >
+"vlan-tag" -- "cp" : Uses >
+"vnfc" -- "instance-group" : MemberOf >
+"vnfc" -- "model-ver" : IsA >
+"vnfc" -- "vip-ipv4-address-list" : Uses >
+"vnfc" -- "vip-ipv6-address-list" : Uses >
+"vnfc" -- "vserver" : HostedOn >
+"volume-group" -- "complex" : LocatedIn >
+"vpls-pe" -- "complex" : LocatedIn >
+"vpls-pe" -- "ctag-pool" : Uses >
+"vpn-binding" -- "customer" : Uses >
+"vpn-binding" -- "p-interface" : BindsTo >
+"vrf" -- "l3-network" : Uses >
+"vrf" -- "l-interface" : Uses >
+"vrf" -- "vpn-binding" : AppliesTo >
+"vserver" -- "flavor" : Uses >
+"vserver" -- "image" : Uses >
+"vserver" -- "pserver" : HostedOn >
+"vserver" -- "snapshot" : Uses >
+"vserver" -- "volume" : AttachesTo >
+"wan-port-config" -- "service-instance" : PartOf >
+"zone" -- "complex" : LocatedIn >
+@enduml