Common Model Glossary Review Comments

example

#1 @My Name: Comment ABC

Resolution XYZ

classes

#1 @Michela Bevilacqua a number of classes are present in the glossary but no definition is associated to

e.g.BusinessInteractionItemRelationship, ConfigRelationship, ConfigSpecRelationship, ConfigurationInstance, ConfigurationSpecification, ResourceConfigurationDescriptor, ResourceConfigurationInstance, ServiceConfigurationDescriptor, ServiceConfigurationInstance

I would reccomend to remove any Classes in the document that does not have a description session

 classes

#2 @Michela Bevilacqua some classes are not providing a description but just some indication not relvent in the context of a glossary

eg.

ParameterProfile

This class is abstract.

Remove any class that does not have a description session

"classes"

#3 @Michela Bevilacqua :"classes" word is repeated multiple times in the doc

Remove "classes" word

 Use of acronym

 #4@Michela Bevilacqua : descriptions include too many acronym not defined in the glossary.

eg.

The VirtualLinkProfile class specifies a profile for instantiating VLs of a particular NS DF according to a specific VLD and VL DF.

Remove the use of acronym or add an acronym definition session

Enumeration

#5: @Michela Bevilacqua .enumeration as well as data types definitions introduced some "strange" section numbering

Open

Remove section numbering for enumerated

 Enumeration

 #6: @Michela Bevilacqua enumeration description has is provided on multiple rows instead of a single row.

 Align enumeration description with class description format and size

Ip version

 #7: @Michela Bevilacqua : we have repetation in the definition between description and contains enumeration literals keyword.

1.1.1.1.1        IpVersion enumeration

Description:

Specifies IP version of this L3 protocol.

Value:

• IPV4.

• IPV6.

Contains Enumeration Literals:

• IPV4

• IPV6

Remove repetation

 uuid type

#8: @Michela Bevilacqua : can we review this description ? I believe there is some required reviewed

1.1.1.1         Uuid primitive type

Description:

type string {

pattern

'[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'; }

A Universally Unique IDentifier in the string representation defined in RFC 4122. The canonical representation uses lowercase characters.

The following is an example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6 ";

reference

"RFC 4122: A Universally Unique IDentifier (UUID) URN Namespace"

 Review , in particular, &apos and &quot

       Uri primitive type

 #9: @Michela Bevilacqua ,same problem as #8

+

clarify STD 66.

  Review

 Readibility

 #11: @Michela Bevilacqua : The Readiblity of this doc is very poor. Classes are grouped together but  it is difficult to understand grouping and look for a specific concept in the glossary. We could explore some options to increase readibility:

The split in multiple files in my view is only increasing the problems in terms of readibility.

 Explore options for readibility improvment.

e.g:

1) order definition in the glossary using an alphabetical order or

2)  introduce some picture grouping concepts.