summaryrefslogtreecommitdiffstats
path: root/docs/sections/apis
diff options
context:
space:
mode:
Diffstat (limited to 'docs/sections/apis')
-rw-r--r--docs/sections/apis/DFC.json2
-rw-r--r--docs/sections/apis/DFC.rst4
-rw-r--r--docs/sections/apis/DFC.yaml1
-rw-r--r--docs/sections/apis/PMSH.rst5
-rw-r--r--docs/sections/apis/PRH.rst4
-rw-r--r--docs/sections/apis/PRH.yaml1
-rw-r--r--docs/sections/apis/SDK.rst1
-rw-r--r--docs/sections/apis/des_api.json2
-rw-r--r--docs/sections/apis/des_api.rst4
-rw-r--r--docs/sections/apis/pmmapper.rst3
-rw-r--r--docs/sections/apis/swagger_vescollector.yaml1
-rw-r--r--docs/sections/apis/ves-hv/MeasDataCollection.proto4
-rw-r--r--docs/sections/apis/ves-hv/index.rst17
-rw-r--r--docs/sections/apis/ves.rst3
14 files changed, 30 insertions, 22 deletions
diff --git a/docs/sections/apis/DFC.json b/docs/sections/apis/DFC.json
index 08d03993..035875d9 100644
--- a/docs/sections/apis/DFC.json
+++ b/docs/sections/apis/DFC.json
@@ -618,4 +618,4 @@
"title": "Mono«ResponseEntity«string»»"
}
}
-} \ No newline at end of file
+}
diff --git a/docs/sections/apis/DFC.rst b/docs/sections/apis/DFC.rst
index 1470ce7a..636946f6 100644
--- a/docs/sections/apis/DFC.rst
+++ b/docs/sections/apis/DFC.rst
@@ -1,5 +1,6 @@
.. This work is licensed under a
Creative Commons Attribution 4.0 International License.
+ http://creativecommons.org/licenses/by/4.0
========================
DFC (DataFile Collector)
@@ -15,7 +16,7 @@ Overview
Component description can be found under `DFC`_.
-.. _DFC: ../../sections/services/dfc/index.html
+.. _DFC: ../../sections/services/dfc/index.rst
Offered APIs
============
@@ -25,4 +26,3 @@ Offered APIs
:widths: 10,5
"Datafile Collector API", ":download:`link <DFC.json>`"
-
diff --git a/docs/sections/apis/DFC.yaml b/docs/sections/apis/DFC.yaml
index 7f56ca55..a9296bd8 100644
--- a/docs/sections/apis/DFC.yaml
+++ b/docs/sections/apis/DFC.yaml
@@ -73,4 +73,3 @@ definitions:
Mono«ResponseEntity«string»»:
type: object
title: Mono«ResponseEntity«string»»
-
diff --git a/docs/sections/apis/PMSH.rst b/docs/sections/apis/PMSH.rst
index 504d5945..e4deeca5 100644
--- a/docs/sections/apis/PMSH.rst
+++ b/docs/sections/apis/PMSH.rst
@@ -1,5 +1,6 @@
.. This work is licensed under a
Creative Commons Attribution 4.0 International License.
+ http://creativecommons.org/licenses/by/4.0
========================
PM Subscription Handler
@@ -13,7 +14,7 @@ Overview
Component description can be found under `PM Subscription Handler`_.
-.. _PM Subscription Handler: ../../sections/services/pm-subscription-handler/index.html
+.. _PM Subscription Handler: ../../sections/services/pm-subscription-handler/index.rst
Offered APIs
============
@@ -22,4 +23,4 @@ Offered APIs
:header: "API name", "Swagger JSON", "Swagger YAML"
:widths: 10,5,5
- "PM Subscription Handler Service", ":download:`link <pmsh_swagger.json>`", ":download:`link <pmsh_swagger.yaml>`" \ No newline at end of file
+ "PM Subscription Handler Service", ":download:`link <pmsh_swagger.json>`", ":download:`link <pmsh_swagger.yml>`"
diff --git a/docs/sections/apis/PRH.rst b/docs/sections/apis/PRH.rst
index e566c86e..52d12d1d 100644
--- a/docs/sections/apis/PRH.rst
+++ b/docs/sections/apis/PRH.rst
@@ -1,5 +1,6 @@
.. This work is licensed under a
Creative Commons Attribution 4.0 International License.
+ http://creativecommons.org/licenses/by/4.0
.. _prh_api:
@@ -123,7 +124,7 @@ Compiling PRH
=============
Whole project (top level of PRH directory) and each module (sub module
-directory) can be compiled using `mvn clean install` command.
+directory) can be compiled using `mvn clean install` command.
Main API Endpoints
==================
@@ -150,4 +151,3 @@ Maven Children Artifacts:
2. prh-aai-client: Contains implementation of AAI client
3. prh-dmaap-client: Contains implementation of DmaaP client
4. prh-commons: Common code for whole prh modules
-
diff --git a/docs/sections/apis/PRH.yaml b/docs/sections/apis/PRH.yaml
index 37040bc8..aad51db6 100644
--- a/docs/sections/apis/PRH.yaml
+++ b/docs/sections/apis/PRH.yaml
@@ -73,4 +73,3 @@ definitions:
Mono«ResponseEntity«string»»:
type: object
title: Mono«ResponseEntity«string»»
-
diff --git a/docs/sections/apis/SDK.rst b/docs/sections/apis/SDK.rst
index c76348e4..27cc5433 100644
--- a/docs/sections/apis/SDK.rst
+++ b/docs/sections/apis/SDK.rst
@@ -1,5 +1,6 @@
.. This work is licensed under a
Creative Commons Attribution 4.0 International License.
+ http://creativecommons.org/licenses/by/4.0
DCAE SDK
diff --git a/docs/sections/apis/des_api.json b/docs/sections/apis/des_api.json
index 0db3b4df..26e45fdf 100644
--- a/docs/sections/apis/des_api.json
+++ b/docs/sections/apis/des_api.json
@@ -64,4 +64,4 @@
}
}
}
-} \ No newline at end of file
+}
diff --git a/docs/sections/apis/des_api.rst b/docs/sections/apis/des_api.rst
index 57e68ca9..23fa0d03 100644
--- a/docs/sections/apis/des_api.rst
+++ b/docs/sections/apis/des_api.rst
@@ -1,5 +1,6 @@
.. This work is licensed under a
Creative Commons Attribution 4.0 International License.
+ http://creativecommons.org/licenses/by/4.0
=================================
DES (DataLake Extraction Service)
@@ -15,7 +16,7 @@ Overview
Component description is included in `DES`_.
-.. _DES: ../../sections/services/datalake-handler/index.html
+.. _DES: ../../sections/services/datalake-handler/index.rst
Offered APIs
============
@@ -25,4 +26,3 @@ Offered APIs
:widths: 10,5
"Datafile Collector API", ":download:`link <des_api.json>`"
-
diff --git a/docs/sections/apis/pmmapper.rst b/docs/sections/apis/pmmapper.rst
index 5da8bf16..543fbf0d 100644
--- a/docs/sections/apis/pmmapper.rst
+++ b/docs/sections/apis/pmmapper.rst
@@ -1,5 +1,6 @@
.. This work is licensed under a
Creative Commons Attribution 4.0 International License.
+ http://creativecommons.org/licenses/by/4.0
========================
3GPP PM Mapper
@@ -13,7 +14,7 @@ Overview
Component description can be found under `3GPP PM Mapper`_.
-.. _3GPP PM Mapper: ../../sections/services/pm-mapper/index.html
+.. _3GPP PM Mapper: ../../sections/services/pm-mapper/index.rst
Paths
=====
diff --git a/docs/sections/apis/swagger_vescollector.yaml b/docs/sections/apis/swagger_vescollector.yaml
index 77ced698..b5bffb92 100644
--- a/docs/sections/apis/swagger_vescollector.yaml
+++ b/docs/sections/apis/swagger_vescollector.yaml
@@ -1,3 +1,4 @@
+# ===========LICENSE_START========================================================
# ================================================================================
# Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
# Modifications Copyright (C) 2020 Nokia. All rights reserved.
diff --git a/docs/sections/apis/ves-hv/MeasDataCollection.proto b/docs/sections/apis/ves-hv/MeasDataCollection.proto
index 498358fc..123c99ef 100644
--- a/docs/sections/apis/ves-hv/MeasDataCollection.proto
+++ b/docs/sections/apis/ves-hv/MeasDataCollection.proto
@@ -25,7 +25,7 @@ package org.onap.ves;
// Note (2018-09): work is in progress for 3GPP TS 28.550. Changes will be made, if needed, to align with final version.
// Differences/additions to 3GPP TS 28.550 are marked with "%%".
-message MeasDataCollection // top-level message
+message MeasDataCollection // top-level message
{
// %% Combined messageFileHeader, measData (single instance), messageFileFooter (not needed: timestamp = collectionBeginTime + granularityPeriod).
string formatVersion = 1; // required, current value "28.550 2.0"
@@ -34,7 +34,7 @@ message MeasDataCollection // top-level message
string measuredEntityDn = 4; // DN as per 3GPP TS 32.300
string measuredEntitySoftwareVersion = 5;
repeated string measObjInstIdList = 6; // %%: optional, monitored object LDNs as per 3GPP TS 32.300 and 3GPP TS 32.432
- repeated MeasInfo measInfo = 7;
+ repeated MeasInfo measInfo = 7;
}
message MeasInfo
diff --git a/docs/sections/apis/ves-hv/index.rst b/docs/sections/apis/ves-hv/index.rst
index 88a240e6..b1871b18 100644
--- a/docs/sections/apis/ves-hv/index.rst
+++ b/docs/sections/apis/ves-hv/index.rst
@@ -9,6 +9,11 @@ HV-VES (High Volume VES)
.. contents::
:depth: 4
+.. toctree::
+ :maxdepth: 1
+
+ ./supported-domains.rst
+
..
Overview
@@ -16,7 +21,8 @@ Overview
Component description can be found under `HV-VES Collector`_.
-.. _HV-VES Collector: ../../services/ves-hv/index.html
+.. _HV-VES Collector: ../../services/ves-hv/index.rst
+.. _Domains supported by HV-VES: ./supported-domains.rst
.. _tcp_endpoint:
@@ -26,15 +32,15 @@ TCP Endpoint
HV-VES is exposed as NodePort service on Kubernetes cluster on port 30222/tcp.
By default, as of the Frankfurt release, all TCP communications are secured using
SSL/TLS. Plain, insecure TCP connections without socket data encryption can be enabled if needed.
- (see ref:`ssl_tls_authorization`).
-
-Without TLS, client authentication/authorization is not possible.
+(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.
Communication is wrapped with thin Wire Transfer Protocol, which mainly provides delimitation.
.. literalinclude:: WTP.asn
- :language: asn
+ :language: text
Payload is binary-encoded, using Google Protocol Buffers (GPB) representation of the VES Event.
@@ -96,4 +102,3 @@ Messages handling:
.. note:: xNF (VNF/PNF) can split messages bigger than 1 MiB and set `sequence` field in CommonEventHeader accordingly. It is advised to use smaller than 1 MiB messages for GPBs encoding/decoding efficiency.
- Skipped messages (for any of the above reasons) might not leave any trace in HV-VES logs.
-
diff --git a/docs/sections/apis/ves.rst b/docs/sections/apis/ves.rst
index 35d4ebdb..f50f675c 100644
--- a/docs/sections/apis/ves.rst
+++ b/docs/sections/apis/ves.rst
@@ -1,5 +1,6 @@
.. This work is licensed under a
Creative Commons Attribution 4.0 International License.
+ http://creativecommons.org/licenses/by/4.0
VES-Collector
=============
@@ -125,7 +126,7 @@ Request Example
Response Example
-.. code-block:: http
+.. code-block:: text
HTTPS/1.1 202 Accepted
X-MinorVersion: 1