Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Contributors

Contributors

References

2018-10-17 AAI Meeting Notes

...

https://wiki.onap.org/download/attachments/44467093/AAI_Schema_Service_ONAP.pptx

AAI Schema Service

User Story

  • As a developer of the CCVPN Use Case in ONAP, I would like to change the AAI schema to support all the new data and relationships as needed. It would be nicer to use an API to dynamically update the schema, rather than using a static configuration file.

Glossary

DescriptionOXM terminologyXSD terminologyJava terminology

"schema element"

"java-type"

"class"

"java-type" XML tag"xs:element" XML tag as outer containerJava class

"attribute"

"java-attribute"

"xml-element" XML tag inside "java-attributes" XML tag

  • having a "type" relating to basic Java values, such as String, Integer, Boolean, etc.

"xs:element" XML tag as inner container

  • having "type" relating to basic values such as "xs:string", "xs:unsignedInt", "xs:boolean", etc.
Java field/member variable
"relationship"

"xml-element" XML tag inside "java-attributes" XML tag

  • having a "type" relating to another "java-type"

"xs:element" XML tag as inner container

  • having "ref" relating to another "xs:element" as outer container
  • having the value prefixed by "tns:"
Java field/member variable

"metadata"

"xml-property"

"xml-property" XML tag inside "xml-properties" XML tag"xs:annotation" XML tag containing "annox:annotate" metadataN/A. There are various hard-coded behaviours for each individual item of metadata.
"namespace"

special "java-type" that

  • is at the root of the object graph and root of the REST URL path
  • does not have any "attributes", only top-level "relationships"

"xs:element" XML tag as outer container

  • that never appears anywhere else as a "relationship" of another "xs:element"
N/A. There is special hard-coded behaviour for a specific set of "namespaces".
"top-level"

a "relationship" of a "namespace"


N/A. There is special hard-coded behaviour that prevents "top-level" classes from also being used as "sub-components".
"sub-component"

a "relationship" of a "java-type" that is not a "namespace"


N/A. There is special hard-coded behaviour that prevents "top-level" classes from also being used as "sub-components".
"EdgeRule"

a separate JSON configuration file that regulates the behaviour of the "relationship"


N/A. There is special hard-coded behaviours for each individual item of metadata.
"cousin edge"
  • a "relationship" via the "relationship-list" java-type
  • an "EdgeRule" with a specific configuration (the "java-type" does not "contain" the other "java-type")

N/A. There is special hard-coded behaviour that handles the "relationship-list" for "cousin edges".


Analysis from CCVPN Schema Changes in Casablanca Release

See also:

...