Namespaces
Note
The qualifying prefix tosca.onap.* here is a just "quarantine" zone where new TOSCA types of the ONAP DM will stay as long as they are being discussed.
Has a type reached its maturity, an action should be taken to make this type part of the tosca.nfv.* namespace.
tosca.onap.* | |
tosca.onap.datatypes.* | |
tosca.onap.nodes.* | |
tosca.onap.capabilities.* | |
tosca.onap.policies.* | |
tosca.onap.groups.* |
Lowercase & Uppercase
All lowercase for namespace prefixes: tosca.onap.capabilities.Root.
UpperCamelCase for all shorthand (i.e., not including the namespace part) type names: Root, VirtualLink, SoftwareImage.
lowerCamelCase or snake_case for names of properties, attributes, inputs, capabilities, requirements, etc.
Type Names
The TOSCA types used to reflect the ETSI “descriptor” concept should be named without adding special postfixes like *D, *Desc, *Descr, etc.
Reason: in this DM, the representations of “Description” and “Instance” objects are distinguished very clearly: the ETSI “Descriptions” are modelled as node types, while their “Instances” are modelled as node templates (ref to the Patterns section). Therefore, there is no need to overload type names with unnecessary postfixes.