summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorLovett, Trevor <trevor.lovett@att.com>2020-03-25 15:44:47 -0500
committerTrevor Lovett <trevor.lovett@att.com>2020-03-26 13:26:30 +0000
commit861678290e4da598301c381b9ecb1c060c5b8d80 (patch)
treeab87b49fdbedce37c65371a8a1808e5675642bcb /docs
parent44798b34e5995e10ba080556f45a2600d9c35bb8 (diff)
Fixed PublishEventBatch diagram in VES spec
Since we no longer have the source images, I've converted them to either diagrams generated from Sphinx plugins or simple text representations. Issue-ID: VNFRQTS-862 Signed-off-by: Lovett, Trevor <trevor.lovett@att.com> Change-Id: Iafd346336ca8b5cec71bbeee9fad825da2a5d0bf
Diffstat (limited to 'docs')
-rw-r--r--docs/Chapter8/publish-event-flow.pngbin8505 -> 0 bytes
-rw-r--r--docs/Chapter8/rest-resource.pngbin4438 -> 0 bytes
-rw-r--r--docs/Chapter8/ves7_1spec.rst46
3 files changed, 33 insertions, 13 deletions
diff --git a/docs/Chapter8/publish-event-flow.png b/docs/Chapter8/publish-event-flow.png
deleted file mode 100644
index 3ae9c05..0000000
--- a/docs/Chapter8/publish-event-flow.png
+++ /dev/null
Binary files differ
diff --git a/docs/Chapter8/rest-resource.png b/docs/Chapter8/rest-resource.png
deleted file mode 100644
index ecfad9c..0000000
--- a/docs/Chapter8/rest-resource.png
+++ /dev/null
Binary files differ
diff --git a/docs/Chapter8/ves7_1spec.rst b/docs/Chapter8/ves7_1spec.rst
index 44b3725..83829ae 100644
--- a/docs/Chapter8/ves7_1spec.rst
+++ b/docs/Chapter8/ves7_1spec.rst
@@ -607,12 +607,15 @@ REST resources are defined with respect to a ServerRoot:
ServerRoot = https://{Domain|IP}:{Port}/{optionalRoutingPath}
-The resource structure is provided below:
+The resource structure is provided below::
-.. figure:: rest-resource.png
- :alt: REST Resource Structure
+ {ServerRoot}
+ |
+ |--- /eventListener/v{apiVersion}
+ |
+ |--- /eventBatch
- REST Resource Structure
+**Figure 1**: REST Resource Structure
The {Port} above is typically 8443.
@@ -3686,8 +3689,8 @@ Message Size
The maximum allowed message size is 2 megabytes of uncompressed text.
However,messages of this size have been known to cause performance and data
loss. It is strongly recommended,that messages not exceed 1 megabyte.
-In a future version of the specification, a 1 megabyte limit will become
-a mandatory requirement.
+In a future version of the specification, a 1 megabyte limit will become
+a mandatory requirement.
Operation: publishAnyEvent
~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -3710,10 +3713,17 @@ listener.
Call Flow
++++++++++
-.. figure:: publish-event-flow.png
- :alt: publishAnyEvent Call Flow
+.. seqdiag::
+ :caption: ``publishAnyEvent`` Call Flow
- ``publishAnyEvent`` Call Flow
+ seqdiag {
+ edge_length = 250;
+ client -> listener [label = "POST /eventlistener/v7"];
+ client <- listener [label = "HTTP 202 Accepted", note = "sync response"];
+ === Error Scenario ===
+ client -> listener [label = "POST /eventlistener/v7"];
+ client <- listener [label = "HTTP 4XX/5XX", note = "sync response"];
+ }
Input Parameters
+++++++++++++++++
@@ -3940,7 +3950,7 @@ Sample Service Exception
X-MinorVersion: 1
X-PatchVersion: 1
X-LatestVersion: 7.1.1
-
+
{
"requestError": {
"serviceException": {
@@ -3975,10 +3985,17 @@ listener.
Call Flow
+++++++++++
-.. figure:: publish-event-flow.png
- :alt: publishEvent Call Flow
+.. seqdiag::
+ :caption: ``publishEventBatch`` Call Flow
- ``publishEventBatch`` Call Flow
+ seqdiag {
+ edge_length = 250;
+ client -> listener [label = "POST /eventlistener/v7/eventBatch"];
+ client <- listener [label = "HTTP 202 Accepted", note = "sync response"];
+ === Error Scenario ===
+ client -> listener [label = "POST /eventlistener/v7/eventBatch"];
+ client <- listener [label = "HTTP 4XX/5XX", note = "sync response"];
+ }
Input Parameters
+++++++++++++++++
@@ -6193,6 +6210,9 @@ Contents.
| | | * Changed measValues to measValuesList and similar |
| | | changes throughout |
| | | * Changed iMeasTypesList to sMeasTypesList |
+| | | - Corrected publishEventBatch call flow diagram |
+| | | - Changed AuthorizationHeader to Required? = NO for |
+| | | publishAnyEvent operation |
+-----------+---------+-------------------------------------------------------+
.. _time_zone_abbreviations: https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations