diff options
| author |   Lovett, Trevor <trevor.lovett@att.com> | 2020-04-01 13:39:41 -0500 |
|---|---|---|
| committer | Lovett, Trevor <trevor.lovett@att.com> | 2020-04-01 13:39:41 -0500 |
| commit | b367d7d465af1c6fb3532745d88516169c74bd11 (patch) | |
| tree | 8cdb5492447beea808c33a5aaafeee3d0a5689be /docs/Chapter8 | |
| parent | 1e9417a22ea4ec8f58e1ba100d9096312b1c4729 (diff) | |
Relax camel casing requirements in VES
In 7.1, the VES spec added requirements that
made it mandatory for event names and
other fields to camel case the values
of those fields. This had the negative
side-effect of requiring vendor and
operator updates for existing VES
events and their associated processing.
To avoid this, the requirements have been
updated from must requirements to should
Issue-ID: VNFRQTS-869
Signed-off-by: Lovett, Trevor <trevor.lovett@att.com>
Change-Id: I8669e08f7c4cd2df44239ca2fa49421e011f2e1d
Diffstat (limited to 'docs/Chapter8')
| -rw-r--r-- | docs/Chapter8/ves7_1spec.rst | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/docs/Chapter8/ves7_1spec.rst b/docs/Chapter8/ves7_1spec.rst index 83829ae..e63628a 100644 --- a/docs/Chapter8/ves7_1spec.rst +++ b/docs/Chapter8/ves7_1spec.rst @@ -115,9 +115,9 @@ the uniqueness of the eventName: {DomainAbbreviation}\_{PublisherName}\_{Description} -Each underscore-separated subfield above must start with a capital +Each underscore-separated subfield above should start with a capital letter and use camel-casing to separate words and acronyms. Acronyms -must capitalize only the first letter of the acronym. Spaces and +should capitalize only the first letter of the acronym. Spaces and underscores should not appear within any subfield. The DomainAbbreviation subfield derives from the ‘domain’ field in the @@ -647,7 +647,7 @@ Note on extensible fields: VES has explicitly defined a cpuUsage.cpuIdle field for the communication of that information. -- Keys sent through extensible fields must use camel casing to separate +- Keys sent through extensible fields should use camel casing to separate words and acronyms; only the first letter of each acronym shall be capitalized. @@ -748,8 +748,8 @@ Datatype: hashMap The hashMap datatype is an ‘associative array’, which is an unordered collection of key-value pairs of the form "key": "value", where each key -and value are strings. Keys must use camel casing to separate words and -acronyms; only the first letter of each acronym shall be capitalized. +and value are strings. Keys should use camel casing to separate words and +acronyms; only the first letter of each acronym should be capitalized. Datatype: jsonObject ++++++++++++++++++++ @@ -6213,6 +6213,8 @@ Contents. | | | - Corrected publishEventBatch call flow diagram | | | | - Changed AuthorizationHeader to Required? = NO for | | | | publishAnyEvent operation | +| | | - Relaxed various requirements related to camel | +| | | casing of values from 'must' to 'should' | +-----------+---------+-------------------------------------------------------+ .. _time_zone_abbreviations: https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations |