diff options
author | Vijay Venkatesh Kumar <vv770d@att.com> | 2018-11-20 15:25:22 +0000 |
---|---|---|
committer | Gerrit Code Review <gerrit@onap.org> | 2018-11-20 15:25:22 +0000 |
commit | 4392680e1da068818787cef962585aa5e031da21 (patch) | |
tree | 8e635243359efd4f0007b2d56872b1bd3e1e5bab /docs/sections/apis | |
parent | 290488ddc4acc0e216e5325ea3f445be8301d5d9 (diff) | |
parent | e284409662fd311bd78fa88b92a5ca8945481ac1 (diff) |
Merge "Restore proto schemas in docs"
Diffstat (limited to 'docs/sections/apis')
-rw-r--r-- | docs/sections/apis/ves-hv/MeasDataCollection.proto | 8 | ||||
-rw-r--r-- | docs/sections/apis/ves-hv/VesEvent.proto | 3 | ||||
-rw-r--r-- | docs/sections/apis/ves-hv/index.rst | 2 | ||||
-rw-r--r-- | docs/sections/apis/ves-hv/supported-domains.rst | 8 |
4 files changed, 14 insertions, 7 deletions
diff --git a/docs/sections/apis/ves-hv/MeasDataCollection.proto b/docs/sections/apis/ves-hv/MeasDataCollection.proto index 978cb28a..cd2adabb 100644 --- a/docs/sections/apis/ves-hv/MeasDataCollection.proto +++ b/docs/sections/apis/ves-hv/MeasDataCollection.proto @@ -41,16 +41,16 @@ message MeasInfo { oneof MeasInfoId { // measurement group identifier uint32 iMeasInfoId = 1; // identifier as integer (%%: more compact) - string measInfoId = 2; // identifier as string (more generic) + string sMeasInfoId = 2; // identifier as string (more generic) } oneof MeasTypes { // measurement identifiers associated with the measurement results IMeasTypes iMeasTypes = 3; // identifiers as integers (%%: more compact) - SMeasTypes measTypes = 4; // identifiers as strings (more generic) + SMeasTypes sMeasTypes = 4; // identifiers as strings (more generic) } // Needed only because GPB does not support repeated fields directly inside 'oneof' message IMeasTypes { repeated uint32 iMeasType = 1; } - message SMeasTypes { repeated string measType = 1; } + message SMeasTypes { repeated string sMeasType = 1; } string jobId = 5; repeated MeasValue measValues = 6; // performance measurements grouped by measurement object @@ -59,7 +59,7 @@ message MeasInfo message MeasValue { oneof MeasObjInstId { // monitored object LDN as per 3GPP TS 32.300 and 3GPP TS 32.432 - string measObjInstId = 1; // LDN itself + string sMeasObjInstId = 1; // LDN itself uint32 measObjInstIdListIdx = 2; // %%: index into measObjInstIdList (zero-based) } repeated MeasResult measResults = 3; diff --git a/docs/sections/apis/ves-hv/VesEvent.proto b/docs/sections/apis/ves-hv/VesEvent.proto index dbe0aa3f..2db6b64e 100644 --- a/docs/sections/apis/ves-hv/VesEvent.proto +++ b/docs/sections/apis/ves-hv/VesEvent.proto @@ -32,7 +32,6 @@ message VesEvent // top-level message, currently the } // VES CommonEventHeader adapted to GPB (Google Protocol Buffers) -// Aligned with VES 7.0.1 schema, and extending to Performance Domain. message CommonEventHeader { @@ -69,7 +68,7 @@ message CommonEventHeader bytes sourceId = 15; // "UUID identifying the entity experiencing the event issue; must be populated by the ATT enrichment process" string sourceName = 16; // required, "name of the entity experiencing the event issued use A&AI entry" string timeZoneOffset = 17; // "Offset to GMT to indicate local time zone for the device" - string vesEventListenerVersion = 18; // required, "Version of the VesEvent Listener", current value "7.0.2" + string vesEventListenerVersion = 18; // required, "Version of the VesEvent Listener", current value "7.2" reserved "InternalHeaderFields"; // "enrichment fields for internal VES Event Listener service use only, not supplied by event sources" reserved 100; diff --git a/docs/sections/apis/ves-hv/index.rst b/docs/sections/apis/ves-hv/index.rst index b477ba14..d87d1aa0 100644 --- a/docs/sections/apis/ves-hv/index.rst +++ b/docs/sections/apis/ves-hv/index.rst @@ -25,7 +25,7 @@ TCP Endpoint ============ HV-VES is exposed as NodePort service on Kubernetes cluster on port 30222/tcp. -It uses plain, insecure TCP connection without socket data encryption. In Casablanca release, there is an experimental option to enable SSL/TLS (see :ref:`authorization`). +It uses plain, insecure TCP connection without socket data encryption. In Casablanca release, there is an experimental option to enable SSL/TLS (see :ref:`ssl_tls_authorization`). Without TLS client authentication/authorization is not possible. Connections are stream-based (as opposed to request-based) and long-running. diff --git a/docs/sections/apis/ves-hv/supported-domains.rst b/docs/sections/apis/ves-hv/supported-domains.rst index 980b9f22..d1badaa6 100644 --- a/docs/sections/apis/ves-hv/supported-domains.rst +++ b/docs/sections/apis/ves-hv/supported-domains.rst @@ -33,6 +33,14 @@ The **perf3gpp** domain is based on 3GPP specifications: The event structure is changed in comparison to the one presented in 3GPP technical specifications. The 3GPP structure is enhanced to provide support for efficient transport. +Definitions for the **perf3gpp** domain are stored in Perf3gppFields.proto and MeasDataCollection.proto, listed below: + +.. literalinclude:: Perf3gppFields.proto + :language: protobuf + +.. literalinclude:: MeasDataCollection.proto + :language: protobuf + Selecting Complimentary fields for population of **perf3gpp** event ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |