aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/administration/administration.rst14
-rw-r--r--docs/apis/api-table.rst10
-rw-r--r--docs/apis/api.rst4926
-rw-r--r--docs/apis/swagger.json1871
-rw-r--r--docs/architecture.rst (renamed from docs/architecture/architecture.rst)8
-rw-r--r--docs/configuration.rst (renamed from docs/configuration/configuration.rst)0
-rw-r--r--docs/consumedapis.rst (renamed from docs/consumedapis/consumedapis.rst)1
-rw-r--r--docs/delivery.rst (renamed from docs/delivery/delivery.rst)0
-rw-r--r--docs/humaninterfaces/humaninterfaces.rst8
-rw-r--r--docs/index.rst23
-rw-r--r--docs/installation.rst (renamed from docs/Installation/Installation.rst)7
-rw-r--r--docs/logging.rst19
-rw-r--r--docs/logging/logging.rst28
-rw-r--r--docs/offeredapis.rst (renamed from docs/offeredapis/offeredapis.rst)6
-rw-r--r--docs/release-notes.rst (renamed from docs/release-notes/release-notes.rst)56
-rw-r--r--docs/security.rst (renamed from docs/security/security.rst)2
16 files changed, 6885 insertions, 94 deletions
diff --git a/docs/administration/administration.rst b/docs/administration/administration.rst
deleted file mode 100644
index b050a1f..0000000
--- a/docs/administration/administration.rst
+++ /dev/null
@@ -1,14 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Administration
-==============
-
-
-Processes
----------
-NA
-
-Actions
--------
-NA
diff --git a/docs/apis/api-table.rst b/docs/apis/api-table.rst
new file mode 100644
index 0000000..402935e
--- /dev/null
+++ b/docs/apis/api-table.rst
@@ -0,0 +1,10 @@
+DMaaP Bus Controller REST API Download docs
+===========================================
+
+.. this table is provided to allow for download of API documentation in diff formats
+
+.. csv-table::
+ :header: "API name", "Swagger JSON"
+ :widths: 10,5
+
+ "DMaaP Buscontroller API", ":download:`link <swagger.json>`"
diff --git a/docs/apis/api.rst b/docs/apis/api.rst
new file mode 100644
index 0000000..7379556
--- /dev/null
+++ b/docs/apis/api.rst
@@ -0,0 +1,4926 @@
+DMaaP Bus Controller REST API 1.1.0
+===================================
+
+Description
+~~~~~~~~~~~
+
+ Bus Controller provides an API for OpenDCAE components which need to provision
+ underlying DMaaP technologies (Data Router and Message Router).
+ Primary clients for this API are anticipated to be the OpenDCAE
+ Controller, OpenDCAE Orchestrator, OpenDCAE Inventory and the
+ ECOMP Portal.
+
+ Objects managed by DMaaP are deployed in a dcaeLocation which is a
+ unique identifier for an OpenStack tenant for a dcaeLayer,
+ opendcae-central (aka ecomp) or opendcae-local-ntc (aka edge).
+
+ A dcaeEnvironment (e.g. FTL or prod) has a single DMaaP. A
+ DMaaP is managed by a one or more stateless DMaaP Bus
+ Controller(s), though Bus Controller relies on PGaaS for
+ persistence. Each DMaaP has a single instance of Data Router,
+ which has 1 or more DR_Nodes deployed at each dcaeLocation. DR
+ Clients of type DR_Pub generally publish to a DR_Node that is
+ local to its dcaeLocation. Routing for a Feed is determined by
+ the dcaelocation of its DR_Sub clients.
+
+ A DMaaP may have many Message Router instances. Each instance is
+ deployed as an MR_Cluster. One MR_Cluster is deployed at each
+ dcaeLocation. MR_Clients generally communicate to the
+ MR_Cluster at the same dcaeLocation. Replication of messages
+ between MR_Clusters is accomplished by MR Bridge, which is
+ provioned by DMaaP Bus Controller based on Topic attributes.
+
+ Therefore, the role of DMaaP Bus Controller is to support other
+ DCAE infrastructure components to dynamically provision DMaaP
+ services on behalf of DMaaP clients, and to assist in any
+ management or discovery activity of its clients.
+
+ A convention of this API is to return JSON responses per
+ OpenStack style.
+
+
+
+Contact Information
+~~~~~~~~~~~~~~~~~~~
+
+
+
+
+http://www.onap.org
+
+
+
+
+License
+~~~~~~~
+
+
+`Licensed under the Apache License, Version 2.0 <http://www.apache.org/licenses/LICENSE-2.0>`_
+
+
+
+
+Base URL
+~~~~~~~~
+
+http://www.[host]:[port]/webapi
+https://www.[host]:[port]/webapi
+
+BRIDGE
+~~~~~~
+
+
+Endpoint for retreiving MR Bridge metrics
+
+
+
+
+
+GET ``/bridge``
+---------------
+
+
+Summary
++++++++
+
+return BrTopic details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Returns array of `BrTopic` objects. If source and target query params are specified, only report on that bridge. If detail param is true, list topics names, else just a count is returned.
+
+Parameters
+++++++++++
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 15, 10, 10, 10, 20, 30
+
+ mmagent | query | No | string | | |
+ detail | query | No | boolean | | |
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`BrTopic <d_d71baea9d8e4e59bc395ef51f45dff1b>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "brSource": "somestring",
+ "brTarget": "somestring",
+ "mmAgentName": "somestring",
+ "topicCount": 1
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+PUT ``/bridge``
+---------------
+
+
+Summary
++++++++
+
+update MirrorMaker details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ replace the topic list for a specific Bridge. Use JSON Body for value to replace whitelist, but if refreshFlag param is true, simply refresh using existing whitelist.If split param is true, spread whitelist over smaller mmagents.
+
+Parameters
+++++++++++
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 15, 10, 10, 10, 20, 30
+
+ mmagent | query | No | string | | |
+ refresh | query | No | boolean | | |
+ split | query | No | boolean | | |
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`BrTopic <d_d71baea9d8e4e59bc395ef51f45dff1b>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "brSource": "somestring",
+ "brTarget": "somestring",
+ "mmAgentName": "somestring",
+ "topicCount": 1
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+DCAELOCATIONS
+~~~~~~~~~~~~~
+
+
+an OpenStack tenant purposed for OpenDCAE (i.e. where OpenDCAE components might be deployed)
+
+
+
+
+
+POST ``/dcaeLocations``
+-----------------------
+
+
+Summary
++++++++
+
+return dcaeLocation details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Create some `dcaeLocation` which is a unique identifier for an *OpenStack* tenant purposed for a *dcaeLayer* (ecomp or edge).
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "central": true,
+ "clli": "somestring",
+ "dcaeLayer": "somestring",
+ "dcaeLocationName": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "local": true,
+ "openStackAvailabilityZone": "somestring",
+ "status": "EMPTY",
+ "subnet": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+DELETE ``/dcaeLocations/{locationName}``
+----------------------------------------
+
+
+Summary
++++++++
+
+return dcaeLocation details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ delete a dcaeLocation
+
+Parameters
+++++++++++
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 15, 10, 10, 10, 20, 30
+
+ locationName | path | Yes | string | | |
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+successful operation
+
+
+Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "central": true,
+ "clli": "somestring",
+ "dcaeLayer": "somestring",
+ "dcaeLocationName": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "local": true,
+ "openStackAvailabilityZone": "somestring",
+ "status": "EMPTY",
+ "subnet": "somestring"
+ }
+
+**204**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "central": true,
+ "clli": "somestring",
+ "dcaeLayer": "somestring",
+ "dcaeLocationName": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "local": true,
+ "openStackAvailabilityZone": "somestring",
+ "status": "EMPTY",
+ "subnet": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+GET ``/dcaeLocations/{locationName}``
+-------------------------------------
+
+
+Summary
++++++++
+
+return dcaeLocation details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Returns a specific `dcaeLocation` object with specified tag
+
+Parameters
+++++++++++
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 15, 10, 10, 10, 20, 30
+
+ locationName | path | Yes | string | | |
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "central": true,
+ "clli": "somestring",
+ "dcaeLayer": "somestring",
+ "dcaeLocationName": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "local": true,
+ "openStackAvailabilityZone": "somestring",
+ "status": "EMPTY",
+ "subnet": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+GET ``/dcaeLocations``
+----------------------
+
+
+Summary
++++++++
+
+return dcaeLocation details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Returns array of `dcaeLocation` objects. All objects managed by DMaaP are deployed in some `dcaeLocation` which is a unique identifier for an *OpenStack* tenant purposed for a *dcaeLayer* (ecomp or edge).
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "central": true,
+ "clli": "somestring",
+ "dcaeLayer": "somestring",
+ "dcaeLocationName": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "local": true,
+ "openStackAvailabilityZone": "somestring",
+ "status": "EMPTY",
+ "subnet": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+PUT ``/dcaeLocations/{locationName}``
+-------------------------------------
+
+
+Summary
++++++++
+
+return dcaeLocation details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ update the openStackAvailabilityZone of a dcaeLocation
+
+Parameters
+++++++++++
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 15, 10, 10, 10, 20, 30
+
+ locationName | path | Yes | string | | |
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "central": true,
+ "clli": "somestring",
+ "dcaeLayer": "somestring",
+ "dcaeLocationName": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "local": true,
+ "openStackAvailabilityZone": "somestring",
+ "status": "EMPTY",
+ "subnet": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+DMAAP
+~~~~~
+
+
+V2 Endpoint for this instance of DMaaP object containing values for this OpenDCAE deployment
+
+
+
+
+
+POST ``/dmaap_v2``
+------------------
+
+
+Summary
++++++++
+
+return dmaap details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Create a new DMaaP set system wide configuration settings for the *dcaeEnvironment*. Deprecated with introduction of persistence in 1610.
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "accessKeyOwner": "somestring",
+ "bridgeAdminTopic": "somestring",
+ "dmaapName": "somestring",
+ "drProvUrl": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "loggingUrl": "somestring",
+ "nodeKey": "somestring",
+ "status": "EMPTY",
+ "topicNsRoot": "somestring",
+ "version": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+POST ``/dmaap``
+---------------
+
+
+Summary
++++++++
+
+return dmaap details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Create a new DMaaP set system wide configuration settings for the *dcaeEnvironment*. Deprecated with introduction of persistence in 1610.
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "accessKeyOwner": "somestring",
+ "bridgeAdminTopic": "somestring",
+ "dmaapName": "somestring",
+ "drProvUrl": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "loggingUrl": "somestring",
+ "nodeKey": "somestring",
+ "status": "EMPTY",
+ "topicNsRoot": "somestring",
+ "version": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+GET ``/dmaap_v2``
+-----------------
+
+
+Summary
++++++++
+
+return dmaap details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ returns the `dmaap` object, which contains system wide configuration settings
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "accessKeyOwner": "somestring",
+ "bridgeAdminTopic": "somestring",
+ "dmaapName": "somestring",
+ "drProvUrl": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "loggingUrl": "somestring",
+ "nodeKey": "somestring",
+ "status": "EMPTY",
+ "topicNsRoot": "somestring",
+ "version": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+GET ``/dmaap``
+--------------
+
+
+Summary
++++++++
+
+return dmaap details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ returns the `dmaap` object, which contains system wide configuration settings
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "accessKeyOwner": "somestring",
+ "bridgeAdminTopic": "somestring",
+ "dmaapName": "somestring",
+ "drProvUrl": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "loggingUrl": "somestring",
+ "nodeKey": "somestring",
+ "status": "EMPTY",
+ "topicNsRoot": "somestring",
+ "version": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+PUT ``/dmaap_v2``
+-----------------
+
+
+Summary
++++++++
+
+return dmaap details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Update system settings for *dcaeEnvironment*.
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "accessKeyOwner": "somestring",
+ "bridgeAdminTopic": "somestring",
+ "dmaapName": "somestring",
+ "drProvUrl": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "loggingUrl": "somestring",
+ "nodeKey": "somestring",
+ "status": "EMPTY",
+ "topicNsRoot": "somestring",
+ "version": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+PUT ``/dmaap``
+--------------
+
+
+Summary
++++++++
+
+return dmaap details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Update system settings for *dcaeEnvironment*.
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "accessKeyOwner": "somestring",
+ "bridgeAdminTopic": "somestring",
+ "dmaapName": "somestring",
+ "drProvUrl": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "loggingUrl": "somestring",
+ "nodeKey": "somestring",
+ "status": "EMPTY",
+ "topicNsRoot": "somestring",
+ "version": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+DR_NODES
+~~~~~~~~
+
+
+Endpoint for a Data Router Node server
+
+
+
+
+
+POST ``/dr_nodes``
+------------------
+
+
+Summary
++++++++
+
+return DR_Node details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ create a `DR_Node` in a *dcaeLocation*. Note that multiple `DR_Node`s may exist in the same `dcaeLocation`.
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "dcaeLocationName": "somestring",
+ "fqdn": "somestring",
+ "hostName": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "status": "EMPTY",
+ "version": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+DELETE ``/dr_nodes/{fqdn}``
+---------------------------
+
+
+Summary
++++++++
+
+No Content
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Delete a single `DR_Node` object.
+
+Parameters
+++++++++++
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 15, 10, 10, 10, 20, 30
+
+ fqdn | path | Yes | string | | |
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+successful operation
+
+
+Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "dcaeLocationName": "somestring",
+ "fqdn": "somestring",
+ "hostName": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "status": "EMPTY",
+ "version": "somestring"
+ }
+
+**204**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "dcaeLocationName": "somestring",
+ "fqdn": "somestring",
+ "hostName": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "status": "EMPTY",
+ "version": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+GET ``/dr_nodes/{fqdn}``
+------------------------
+
+
+Summary
++++++++
+
+return DR_Node details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Retrieve a single `DR_Node` object.
+
+Parameters
+++++++++++
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 15, 10, 10, 10, 20, 30
+
+ fqdn | path | Yes | string | | |
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "dcaeLocationName": "somestring",
+ "fqdn": "somestring",
+ "hostName": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "status": "EMPTY",
+ "version": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+GET ``/dr_nodes``
+-----------------
+
+
+Summary
++++++++
+
+return DR_Node details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Returns array of `DR_Node` object array. Need to add filter by dcaeLocation.
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "dcaeLocationName": "somestring",
+ "fqdn": "somestring",
+ "hostName": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "status": "EMPTY",
+ "version": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+PUT ``/dr_nodes/{fqdn}``
+------------------------
+
+
+Summary
++++++++
+
+return DR_Node details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Update a single `DR_Node` object.
+
+Parameters
+++++++++++
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 15, 10, 10, 10, 20, 30
+
+ fqdn | path | Yes | string | | |
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`DR_Node <d_d15e2cee407536866c875375e3f705e0>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "dcaeLocationName": "somestring",
+ "fqdn": "somestring",
+ "hostName": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "status": "EMPTY",
+ "version": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+DR_PUBS
+~~~~~~~
+
+
+Endpoint for a Data Router client that implements a Publisher
+
+
+
+
+
+POST ``/dr_pubs``
+-----------------
+
+
+Summary
++++++++
+
+return DR_Pub details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ create a DR Publisher in the specified environment.
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "dcaeLocationName": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "pubId": "somestring",
+ "status": "EMPTY",
+ "username": "somestring",
+ "userpwd": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+DELETE ``/dr_pubs/{pubId}``
+---------------------------
+
+
+Summary
++++++++
+
+return DR_Pub details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ delete a DR Publisher in the specified environment. Delete a `DR_Pub` object by pubId
+
+Parameters
+++++++++++
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 15, 10, 10, 10, 20, 30
+
+ pubId | path | Yes | string | | |
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+successful operation
+
+
+Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "dcaeLocationName": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "pubId": "somestring",
+ "status": "EMPTY",
+ "username": "somestring",
+ "userpwd": "somestring"
+ }
+
+**204**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "dcaeLocationName": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "pubId": "somestring",
+ "status": "EMPTY",
+ "username": "somestring",
+ "userpwd": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+GET ``/dr_pubs/{pubId}``
+------------------------
+
+
+Summary
++++++++
+
+return DR_Pub details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ returns a DR Publisher in the specified environment. Gets a `DR_Pub` object by pubId
+
+Parameters
+++++++++++
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 15, 10, 10, 10, 20, 30
+
+ pubId | path | Yes | string | | |
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "dcaeLocationName": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "pubId": "somestring",
+ "status": "EMPTY",
+ "username": "somestring",
+ "userpwd": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+GET ``/dr_pubs``
+----------------
+
+
+Summary
++++++++
+
+return DR_Pub details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Returns array of `DR_Pub` objects. Add filter for feedId.
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "dcaeLocationName": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "pubId": "somestring",
+ "status": "EMPTY",
+ "username": "somestring",
+ "userpwd": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+PUT ``/dr_pubs/{pubId}``
+------------------------
+
+
+Summary
++++++++
+
+return DR_Pub details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ update a DR Publisher in the specified environment. Update a `DR_Pub` object by pubId
+
+Parameters
+++++++++++
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 15, 10, 10, 10, 20, 30
+
+ pubId | path | Yes | string | | |
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "dcaeLocationName": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "pubId": "somestring",
+ "status": "EMPTY",
+ "username": "somestring",
+ "userpwd": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+DR_SUBS
+~~~~~~~
+
+
+Endpoint for a Data Router client that implements a Subscriber
+
+
+
+
+
+POST ``/dr_subs``
+-----------------
+
+
+Summary
++++++++
+
+return DR_Sub details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Create a `DR_Sub` object.
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "bytes": [
+ "somestring",
+ "somestring"
+ ],
+ "dcaeLocationName": "somestring",
+ "deliveryURL": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "logURL": "somestring",
+ "owner": "somestring",
+ "status": "EMPTY",
+ "subId": "somestring",
+ "suspended": true,
+ "use100": true,
+ "username": "somestring",
+ "userpwd": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+DELETE ``/dr_subs/{subId}``
+---------------------------
+
+
+Summary
++++++++
+
+return DR_Sub details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Delete a `DR_Sub` object, selected by subId
+
+Parameters
+++++++++++
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 15, 10, 10, 10, 20, 30
+
+ subId | path | Yes | string | | |
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "bytes": [
+ "somestring",
+ "somestring"
+ ],
+ "dcaeLocationName": "somestring",
+ "deliveryURL": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "logURL": "somestring",
+ "owner": "somestring",
+ "status": "EMPTY",
+ "subId": "somestring",
+ "suspended": true,
+ "use100": true,
+ "username": "somestring",
+ "userpwd": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+GET ``/dr_subs/{subId}``
+------------------------
+
+
+Summary
++++++++
+
+return DR_Sub details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Retrieve a `DR_Sub` object, selected by subId
+
+Parameters
+++++++++++
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 15, 10, 10, 10, 20, 30
+
+ subId | path | Yes | string | | |
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "bytes": [
+ "somestring",
+ "somestring"
+ ],
+ "dcaeLocationName": "somestring",
+ "deliveryURL": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "logURL": "somestring",
+ "owner": "somestring",
+ "status": "EMPTY",
+ "subId": "somestring",
+ "suspended": true,
+ "use100": true,
+ "username": "somestring",
+ "userpwd": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+GET ``/dr_subs``
+----------------
+
+
+Summary
++++++++
+
+return DR_Sub details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Returns array of `DR_Sub` objects. Add filter for feedId.
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "bytes": [
+ "somestring",
+ "somestring"
+ ],
+ "dcaeLocationName": "somestring",
+ "deliveryURL": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "logURL": "somestring",
+ "owner": "somestring",
+ "status": "EMPTY",
+ "subId": "somestring",
+ "suspended": true,
+ "use100": true,
+ "username": "somestring",
+ "userpwd": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+PUT ``/dr_subs/{subId}``
+------------------------
+
+
+Summary
++++++++
+
+return DR_Sub details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Update a `DR_Sub` object, selected by subId
+
+Parameters
+++++++++++
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 15, 10, 10, 10, 20, 30
+
+ subId | path | Yes | string | | |
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "bytes": [
+ "somestring",
+ "somestring"
+ ],
+ "dcaeLocationName": "somestring",
+ "deliveryURL": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "logURL": "somestring",
+ "owner": "somestring",
+ "status": "EMPTY",
+ "subId": "somestring",
+ "suspended": true,
+ "use100": true,
+ "username": "somestring",
+ "userpwd": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+FEEDS
+~~~~~
+
+
+Endpoint for a Data Router Feed
+
+
+
+
+
+POST ``/feeds``
+---------------
+
+
+Summary
++++++++
+
+return Feed details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Create a of `Feed` object.
+
+Parameters
+++++++++++
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 15, 10, 10, 10, 20, 30
+
+ useExisting | query | No | string | | |
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`Feed <d_289ad39619725df26c9ff382d4c97c75>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "asprClassification": "somestring",
+ "bytes": [
+ "somestring",
+ "somestring"
+ ],
+ "feedDescription": "somestring",
+ "feedId": "somestring",
+ "feedName": "somestring",
+ "feedVersion": "somestring",
+ "formatUuid": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "logURL": "somestring",
+ "owner": "somestring",
+ "publishURL": "somestring",
+ "pubs": [
+ {
+ "dcaeLocationName": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "pubId": "somestring",
+ "status": "EMPTY",
+ "username": "somestring",
+ "userpwd": "somestring"
+ },
+ {
+ "dcaeLocationName": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "pubId": "somestring",
+ "status": "EMPTY",
+ "username": "somestring",
+ "userpwd": "somestring"
+ }
+ ],
+ "status": "EMPTY",
+ "subs": [
+ {
+ "bytes": [
+ "somestring",
+ "somestring"
+ ],
+ "dcaeLocationName": "somestring",
+ "deliveryURL": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "logURL": "somestring",
+ "owner": "somestring",
+ "status": "EMPTY",
+ "subId": "somestring",
+ "suspended": true,
+ "use100": true,
+ "username": "somestring",
+ "userpwd": "somestring"
+ },
+ {
+ "bytes": [
+ "somestring",
+ "somestring"
+ ],
+ "dcaeLocationName": "somestring",
+ "deliveryURL": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "logURL": "somestring",
+ "owner": "somestring",
+ "status": "EMPTY",
+ "subId": "somestring",
+ "suspended": true,
+ "use100": true,
+ "username": "somestring",
+ "userpwd": "somestring"
+ }
+ ],
+ "subscribeURL": "somestring",
+ "suspended": true
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+DELETE ``/feeds/{id}``
+----------------------
+
+
+Summary
++++++++
+
+return Feed details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Delete a `Feed` object, specified by id.
+
+Parameters
+++++++++++
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 15, 10, 10, 10, 20, 30
+
+ id | path | Yes | string | | |
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+successful operation
+
+
+Type: :ref:`Feed <d_289ad39619725df26c9ff382d4c97c75>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "asprClassification": "somestring",
+ "bytes": [
+ "somestring",
+ "somestring"
+ ],
+ "feedDescription": "somestring",
+ "feedId": "somestring",
+ "feedName": "somestring",
+ "feedVersion": "somestring",
+ "formatUuid": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "logURL": "somestring",
+ "owner": "somestring",
+ "publishURL": "somestring",
+ "pubs": [
+ {
+ "dcaeLocationName": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "pubId": "somestring",
+ "status": "EMPTY",
+ "username": "somestring",
+ "userpwd": "somestring"
+ },
+ {
+ "dcaeLocationName": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "pubId": "somestring",
+ "status": "EMPTY",
+ "username": "somestring",
+ "userpwd": "somestring"
+ }
+ ],
+ "status": "EMPTY",
+ "subs": [
+ {
+ "bytes": [
+ "somestring",
+ "somestring"
+ ],
+ "dcaeLocationName": "somestring",
+ "deliveryURL": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "logURL": "somestring",
+ "owner": "somestring",
+ "status": "EMPTY",
+ "subId": "somestring",
+ "suspended": true,
+ "use100": true,
+ "username": "somestring",
+ "userpwd": "somestring"
+ },
+ {
+ "bytes": [
+ "somestring",
+ "somestring"
+ ],
+ "dcaeLocationName": "somestring",
+ "deliveryURL": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "logURL": "somestring",
+ "owner": "somestring",
+ "status": "EMPTY",
+ "subId": "somestring",
+ "suspended": true,
+ "use100": true,
+ "username": "somestring",
+ "userpwd": "somestring"
+ }
+ ],
+ "subscribeURL": "somestring",
+ "suspended": true
+ }
+
+**204**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`Feed <d_289ad39619725df26c9ff382d4c97c75>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "asprClassification": "somestring",
+ "bytes": [
+ "somestring",
+ "somestring"
+ ],
+ "feedDescription": "somestring",
+ "feedId": "somestring",
+ "feedName": "somestring",
+ "feedVersion": "somestring",
+ "formatUuid": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "logURL": "somestring",
+ "owner": "somestring",
+ "publishURL": "somestring",
+ "pubs": [
+ {
+ "dcaeLocationName": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "pubId": "somestring",
+ "status": "EMPTY",
+ "username": "somestring",
+ "userpwd": "somestring"
+ },
+ {
+ "dcaeLocationName": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "pubId": "somestring",
+ "status": "EMPTY",
+ "username": "somestring",
+ "userpwd": "somestring"
+ }
+ ],
+ "status": "EMPTY",
+ "subs": [
+ {
+ "bytes": [
+ "somestring",
+ "somestring"
+ ],
+ "dcaeLocationName": "somestring",
+ "deliveryURL": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "logURL": "somestring",
+ "owner": "somestring",
+ "status": "EMPTY",
+ "subId": "somestring",
+ "suspended": true,
+ "use100": true,
+ "username": "somestring",
+ "userpwd": "somestring"
+ },
+ {
+ "bytes": [
+ "somestring",
+ "somestring"
+ ],
+ "dcaeLocationName": "somestring",
+ "deliveryURL": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "logURL": "somestring",
+ "owner": "somestring",
+ "status": "EMPTY",
+ "subId": "somestring",
+ "suspended": true,
+ "use100": true,
+ "username": "somestring",
+ "userpwd": "somestring"
+ }
+ ],
+ "subscribeURL": "somestring",
+ "suspended": true
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+GET ``/feeds/{id}``
+-------------------
+
+
+Summary
++++++++
+
+return Feed details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Retrieve a `Feed` object, specified by id.
+
+Parameters
+++++++++++
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 15, 10, 10, 10, 20, 30
+
+ id | path | Yes | string | | |
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "dcaeLocationName": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "pubId": "somestring",
+ "status": "EMPTY",
+ "username": "somestring",
+ "userpwd": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+GET ``/feeds``
+--------------
+
+
+Summary
++++++++
+
+return Feed details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Returns array of `Feed` objects.
+
+Parameters
+++++++++++
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 15, 10, 10, 10, 20, 30
+
+ feedName | query | No | string | | |
+ version | query | No | string | | |
+ match | query | No | string | | |
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`Feed <d_289ad39619725df26c9ff382d4c97c75>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "asprClassification": "somestring",
+ "bytes": [
+ "somestring",
+ "somestring"
+ ],
+ "feedDescription": "somestring",
+ "feedId": "somestring",
+ "feedName": "somestring",
+ "feedVersion": "somestring",
+ "formatUuid": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "logURL": "somestring",
+ "owner": "somestring",
+ "publishURL": "somestring",
+ "pubs": [
+ {
+ "dcaeLocationName": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "pubId": "somestring",
+ "status": "EMPTY",
+ "username": "somestring",
+ "userpwd": "somestring"
+ },
+ {
+ "dcaeLocationName": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "pubId": "somestring",
+ "status": "EMPTY",
+ "username": "somestring",
+ "userpwd": "somestring"
+ }
+ ],
+ "status": "EMPTY",
+ "subs": [
+ {
+ "bytes": [
+ "somestring",
+ "somestring"
+ ],
+ "dcaeLocationName": "somestring",
+ "deliveryURL": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "logURL": "somestring",
+ "owner": "somestring",
+ "status": "EMPTY",
+ "subId": "somestring",
+ "suspended": true,
+ "use100": true,
+ "username": "somestring",
+ "userpwd": "somestring"
+ },
+ {
+ "bytes": [
+ "somestring",
+ "somestring"
+ ],
+ "dcaeLocationName": "somestring",
+ "deliveryURL": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "logURL": "somestring",
+ "owner": "somestring",
+ "status": "EMPTY",
+ "subId": "somestring",
+ "suspended": true,
+ "use100": true,
+ "username": "somestring",
+ "userpwd": "somestring"
+ }
+ ],
+ "subscribeURL": "somestring",
+ "suspended": true
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+PUT ``/feeds/{id}``
+-------------------
+
+
+Summary
++++++++
+
+return Feed details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Update a `Feed` object, specified by id.
+
+Parameters
+++++++++++
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 15, 10, 10, 10, 20, 30
+
+ id | path | Yes | string | | |
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`Feed <d_289ad39619725df26c9ff382d4c97c75>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "asprClassification": "somestring",
+ "bytes": [
+ "somestring",
+ "somestring"
+ ],
+ "feedDescription": "somestring",
+ "feedId": "somestring",
+ "feedName": "somestring",
+ "feedVersion": "somestring",
+ "formatUuid": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "logURL": "somestring",
+ "owner": "somestring",
+ "publishURL": "somestring",
+ "pubs": [
+ {
+ "dcaeLocationName": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "pubId": "somestring",
+ "status": "EMPTY",
+ "username": "somestring",
+ "userpwd": "somestring"
+ },
+ {
+ "dcaeLocationName": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "pubId": "somestring",
+ "status": "EMPTY",
+ "username": "somestring",
+ "userpwd": "somestring"
+ }
+ ],
+ "status": "EMPTY",
+ "subs": [
+ {
+ "bytes": [
+ "somestring",
+ "somestring"
+ ],
+ "dcaeLocationName": "somestring",
+ "deliveryURL": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "logURL": "somestring",
+ "owner": "somestring",
+ "status": "EMPTY",
+ "subId": "somestring",
+ "suspended": true,
+ "use100": true,
+ "username": "somestring",
+ "userpwd": "somestring"
+ },
+ {
+ "bytes": [
+ "somestring",
+ "somestring"
+ ],
+ "dcaeLocationName": "somestring",
+ "deliveryURL": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "logURL": "somestring",
+ "owner": "somestring",
+ "status": "EMPTY",
+ "subId": "somestring",
+ "suspended": true,
+ "use100": true,
+ "username": "somestring",
+ "userpwd": "somestring"
+ }
+ ],
+ "subscribeURL": "somestring",
+ "suspended": true
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+INFO
+~~~~
+
+
+Endpoint for this instance of DBCL. Returns health info.
+
+
+
+
+
+GET ``/info``
+-------------
+
+
+Summary
++++++++
+
+return info details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ returns the `info` object
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "accessKeyOwner": "somestring",
+ "bridgeAdminTopic": "somestring",
+ "dmaapName": "somestring",
+ "drProvUrl": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "loggingUrl": "somestring",
+ "nodeKey": "somestring",
+ "status": "EMPTY",
+ "topicNsRoot": "somestring",
+ "version": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+MR_CLIENTS
+~~~~~~~~~~
+
+
+Endpoint for a Message Router Client that implements a Publisher or a Subscriber
+
+
+
+
+
+POST ``/mr_clients``
+--------------------
+
+
+Summary
++++++++
+
+Associate an MR_Client object to a Topic
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Create a `MR_Client` object.The `dcaeLocation` attribute is used to match an `MR_Cluster` object with the same value, with the intent of localizing message traffic. In legacy implementation, the `clientRole` is granted appropriate permission in AAF. Newer implementions may instead specify an AAF Identity, which will be added to the appropriate `Topic` role.
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "action": [
+ "somestring",
+ "somestring"
+ ],
+ "clientIdentity": "somestring",
+ "clientRole": "somestring",
+ "dcaeLocationName": "somestring",
+ "fqtn": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "mrClientId": "somestring",
+ "status": "EMPTY",
+ "topicURL": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+DELETE ``/mr_clients/{subId}``
+------------------------------
+
+
+Summary
++++++++
+
+Delete an MR_Client object
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Delete a `MR_Client` object, specified by clientId
+
+Parameters
+++++++++++
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 15, 10, 10, 10, 20, 30
+
+ subId | path | Yes | string | | |
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+successful operation
+
+
+Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "action": [
+ "somestring",
+ "somestring"
+ ],
+ "clientIdentity": "somestring",
+ "clientRole": "somestring",
+ "dcaeLocationName": "somestring",
+ "fqtn": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "mrClientId": "somestring",
+ "status": "EMPTY",
+ "topicURL": "somestring"
+ }
+
+**204**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "action": [
+ "somestring",
+ "somestring"
+ ],
+ "clientIdentity": "somestring",
+ "clientRole": "somestring",
+ "dcaeLocationName": "somestring",
+ "fqtn": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "mrClientId": "somestring",
+ "status": "EMPTY",
+ "topicURL": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+GET ``/mr_clients``
+-------------------
+
+
+Summary
++++++++
+
+return MR_Client details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Returns array of `MR_Client` objects.
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "action": [
+ "somestring",
+ "somestring"
+ ],
+ "clientIdentity": "somestring",
+ "clientRole": "somestring",
+ "dcaeLocationName": "somestring",
+ "fqtn": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "mrClientId": "somestring",
+ "status": "EMPTY",
+ "topicURL": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+GET ``/mr_clients/{subId}``
+---------------------------
+
+
+Summary
++++++++
+
+return MR_Client details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Retrieve a `MR_Client` object, specified by clientId
+
+Parameters
+++++++++++
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 15, 10, 10, 10, 20, 30
+
+ subId | path | Yes | string | | |
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "action": [
+ "somestring",
+ "somestring"
+ ],
+ "clientIdentity": "somestring",
+ "clientRole": "somestring",
+ "dcaeLocationName": "somestring",
+ "fqtn": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "mrClientId": "somestring",
+ "status": "EMPTY",
+ "topicURL": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+PUT ``/mr_clients/{clientId}``
+------------------------------
+
+
+Summary
++++++++
+
+Update an MR_Client object
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Update a `MR_Client` object, specified by clientId
+
+Parameters
+++++++++++
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 15, 10, 10, 10, 20, 30
+
+ clientId | path | Yes | string | | |
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "action": [
+ "somestring",
+ "somestring"
+ ],
+ "clientIdentity": "somestring",
+ "clientRole": "somestring",
+ "dcaeLocationName": "somestring",
+ "fqtn": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "mrClientId": "somestring",
+ "status": "EMPTY",
+ "topicURL": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+MR_CLUSTERS
+~~~~~~~~~~~
+
+
+Endpoint for a Message Router servers in a Cluster configuration
+
+
+
+
+
+POST ``/mr_clusters``
+---------------------
+
+
+Summary
++++++++
+
+return MR_Cluster details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Create an `MR_Cluster` object.
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "dcaeLocationName": "somestring",
+ "fqdn": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "replicationGroup": "somestring",
+ "sourceReplicationPort": "somestring",
+ "status": "EMPTY",
+ "targetReplicationPort": "somestring",
+ "topicPort": "somestring",
+ "topicProtocol": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+DELETE ``/mr_clusters/{clusterId}``
+-----------------------------------
+
+
+Summary
++++++++
+
+return MR_Cluster details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Delete an `MR_Cluster` object, specified by clusterId.
+
+Parameters
+++++++++++
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 15, 10, 10, 10, 20, 30
+
+ clusterId | path | Yes | string | | |
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+successful operation
+
+
+Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "dcaeLocationName": "somestring",
+ "fqdn": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "replicationGroup": "somestring",
+ "sourceReplicationPort": "somestring",
+ "status": "EMPTY",
+ "targetReplicationPort": "somestring",
+ "topicPort": "somestring",
+ "topicProtocol": "somestring"
+ }
+
+**204**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "dcaeLocationName": "somestring",
+ "fqdn": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "replicationGroup": "somestring",
+ "sourceReplicationPort": "somestring",
+ "status": "EMPTY",
+ "targetReplicationPort": "somestring",
+ "topicPort": "somestring",
+ "topicProtocol": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+GET ``/mr_clusters/{clusterId}``
+--------------------------------
+
+
+Summary
++++++++
+
+return MR_Cluster details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Retrieve an `MR_Cluster` object, specified by clusterId.
+
+Parameters
+++++++++++
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 15, 10, 10, 10, 20, 30
+
+ clusterId | path | Yes | string | | |
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "dcaeLocationName": "somestring",
+ "fqdn": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "replicationGroup": "somestring",
+ "sourceReplicationPort": "somestring",
+ "status": "EMPTY",
+ "targetReplicationPort": "somestring",
+ "topicPort": "somestring",
+ "topicProtocol": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+GET ``/mr_clusters``
+--------------------
+
+
+Summary
++++++++
+
+return MR_Cluster details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Returns array of `MR_Cluster` objects.
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "dcaeLocationName": "somestring",
+ "fqdn": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "replicationGroup": "somestring",
+ "sourceReplicationPort": "somestring",
+ "status": "EMPTY",
+ "targetReplicationPort": "somestring",
+ "topicPort": "somestring",
+ "topicProtocol": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+PUT ``/mr_clusters/{clusterId}``
+--------------------------------
+
+
+Summary
++++++++
+
+return MR_Cluster details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Update an `MR_Cluster` object, specified by clusterId.
+
+Parameters
+++++++++++
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 15, 10, 10, 10, 20, 30
+
+ clusterId | path | Yes | string | | |
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "dcaeLocationName": "somestring",
+ "fqdn": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "replicationGroup": "somestring",
+ "sourceReplicationPort": "somestring",
+ "status": "EMPTY",
+ "targetReplicationPort": "somestring",
+ "topicPort": "somestring",
+ "topicProtocol": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+TOPICS
+~~~~~~
+
+
+Endpoint for retreiving MR Topics
+
+
+
+
+
+POST ``/topics``
+----------------
+
+
+Summary
++++++++
+
+Create a Topic object
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Create `Topic` object.For convenience, the message body may populate the `clients` array, in which case each entry will be added as an `MR_Client`. Beginning in ONAP Dublin Release, dbcapi will create two AAF Roles by default, one each for the publisher and subscriber per topic. MR_Clients can then specify an AAF Identity to be added to the appropriate default Role, avoiding the need to create Role(s) in advance.
+
+Parameters
+++++++++++
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 15, 10, 10, 10, 20, 30
+
+ useExisting | query | No | string | | |
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "clients": [
+ {
+ "action": [
+ "somestring",
+ "somestring"
+ ],
+ "clientIdentity": "somestring",
+ "clientRole": "somestring",
+ "dcaeLocationName": "somestring",
+ "fqtn": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "mrClientId": "somestring",
+ "status": "EMPTY",
+ "topicURL": "somestring"
+ },
+ {
+ "action": [
+ "somestring",
+ "somestring"
+ ],
+ "clientIdentity": "somestring",
+ "clientRole": "somestring",
+ "dcaeLocationName": "somestring",
+ "fqtn": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "mrClientId": "somestring",
+ "status": "EMPTY",
+ "topicURL": "somestring"
+ }
+ ],
+ "formatUuid": "somestring",
+ "fqtn": "somestring",
+ "fqtnStyle": "FQTN_NOT_SPECIFIED",
+ "globalMrURL": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "owner": "somestring",
+ "partitionCount": "somestring",
+ "publisherRole": "somestring",
+ "replicationCase": "REPLICATION_NOT_SPECIFIED",
+ "replicationCount": "somestring",
+ "status": "EMPTY",
+ "subscriberRole": "somestring",
+ "tnxEnabled": "somestring",
+ "topicDescription": "somestring",
+ "topicName": "somestring",
+ "version": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+DELETE ``/topics/{topicId}``
+----------------------------
+
+
+Summary
++++++++
+
+return Topic details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Delete a `Topic` object, identified by topicId
+
+Parameters
+++++++++++
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 15, 10, 10, 10, 20, 30
+
+ topicId | path | Yes | string | | |
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+successful operation
+
+
+Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "clients": [
+ {
+ "action": [
+ "somestring",
+ "somestring"
+ ],
+ "clientIdentity": "somestring",
+ "clientRole": "somestring",
+ "dcaeLocationName": "somestring",
+ "fqtn": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "mrClientId": "somestring",
+ "status": "EMPTY",
+ "topicURL": "somestring"
+ },
+ {
+ "action": [
+ "somestring",
+ "somestring"
+ ],
+ "clientIdentity": "somestring",
+ "clientRole": "somestring",
+ "dcaeLocationName": "somestring",
+ "fqtn": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "mrClientId": "somestring",
+ "status": "EMPTY",
+ "topicURL": "somestring"
+ }
+ ],
+ "formatUuid": "somestring",
+ "fqtn": "somestring",
+ "fqtnStyle": "FQTN_NOT_SPECIFIED",
+ "globalMrURL": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "owner": "somestring",
+ "partitionCount": "somestring",
+ "publisherRole": "somestring",
+ "replicationCase": "REPLICATION_NOT_SPECIFIED",
+ "replicationCount": "somestring",
+ "status": "EMPTY",
+ "subscriberRole": "somestring",
+ "tnxEnabled": "somestring",
+ "topicDescription": "somestring",
+ "topicName": "somestring",
+ "version": "somestring"
+ }
+
+**204**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "clients": [
+ {
+ "action": [
+ "somestring",
+ "somestring"
+ ],
+ "clientIdentity": "somestring",
+ "clientRole": "somestring",
+ "dcaeLocationName": "somestring",
+ "fqtn": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "mrClientId": "somestring",
+ "status": "EMPTY",
+ "topicURL": "somestring"
+ },
+ {
+ "action": [
+ "somestring",
+ "somestring"
+ ],
+ "clientIdentity": "somestring",
+ "clientRole": "somestring",
+ "dcaeLocationName": "somestring",
+ "fqtn": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "mrClientId": "somestring",
+ "status": "EMPTY",
+ "topicURL": "somestring"
+ }
+ ],
+ "formatUuid": "somestring",
+ "fqtn": "somestring",
+ "fqtnStyle": "FQTN_NOT_SPECIFIED",
+ "globalMrURL": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "owner": "somestring",
+ "partitionCount": "somestring",
+ "publisherRole": "somestring",
+ "replicationCase": "REPLICATION_NOT_SPECIFIED",
+ "replicationCount": "somestring",
+ "status": "EMPTY",
+ "subscriberRole": "somestring",
+ "tnxEnabled": "somestring",
+ "topicDescription": "somestring",
+ "topicName": "somestring",
+ "version": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+GET ``/topics/{topicId}``
+-------------------------
+
+
+Summary
++++++++
+
+return Topic details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Retrieve a `Topic` object, identified by topicId
+
+Parameters
+++++++++++
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 15, 10, 10, 10, 20, 30
+
+ topicId | path | Yes | string | | |
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "clients": [
+ {
+ "action": [
+ "somestring",
+ "somestring"
+ ],
+ "clientIdentity": "somestring",
+ "clientRole": "somestring",
+ "dcaeLocationName": "somestring",
+ "fqtn": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "mrClientId": "somestring",
+ "status": "EMPTY",
+ "topicURL": "somestring"
+ },
+ {
+ "action": [
+ "somestring",
+ "somestring"
+ ],
+ "clientIdentity": "somestring",
+ "clientRole": "somestring",
+ "dcaeLocationName": "somestring",
+ "fqtn": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "mrClientId": "somestring",
+ "status": "EMPTY",
+ "topicURL": "somestring"
+ }
+ ],
+ "formatUuid": "somestring",
+ "fqtn": "somestring",
+ "fqtnStyle": "FQTN_NOT_SPECIFIED",
+ "globalMrURL": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "owner": "somestring",
+ "partitionCount": "somestring",
+ "publisherRole": "somestring",
+ "replicationCase": "REPLICATION_NOT_SPECIFIED",
+ "replicationCount": "somestring",
+ "status": "EMPTY",
+ "subscriberRole": "somestring",
+ "tnxEnabled": "somestring",
+ "topicDescription": "somestring",
+ "topicName": "somestring",
+ "version": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+GET ``/topics``
+---------------
+
+
+Summary
++++++++
+
+return Topic details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Returns array of `Topic` objects.
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "clients": [
+ {
+ "action": [
+ "somestring",
+ "somestring"
+ ],
+ "clientIdentity": "somestring",
+ "clientRole": "somestring",
+ "dcaeLocationName": "somestring",
+ "fqtn": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "mrClientId": "somestring",
+ "status": "EMPTY",
+ "topicURL": "somestring"
+ },
+ {
+ "action": [
+ "somestring",
+ "somestring"
+ ],
+ "clientIdentity": "somestring",
+ "clientRole": "somestring",
+ "dcaeLocationName": "somestring",
+ "fqtn": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "mrClientId": "somestring",
+ "status": "EMPTY",
+ "topicURL": "somestring"
+ }
+ ],
+ "formatUuid": "somestring",
+ "fqtn": "somestring",
+ "fqtnStyle": "FQTN_NOT_SPECIFIED",
+ "globalMrURL": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "owner": "somestring",
+ "partitionCount": "somestring",
+ "publisherRole": "somestring",
+ "replicationCase": "REPLICATION_NOT_SPECIFIED",
+ "replicationCount": "somestring",
+ "status": "EMPTY",
+ "subscriberRole": "somestring",
+ "tnxEnabled": "somestring",
+ "topicDescription": "somestring",
+ "topicName": "somestring",
+ "version": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+
+PUT ``/topics/{topicId}``
+-------------------------
+
+
+Summary
++++++++
+
+return Topic details
+
+Description
++++++++++++
+
+.. raw:: html
+
+ Update a `Topic` object, identified by topicId
+
+Parameters
+++++++++++
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 15, 10, 10, 10, 20, 30
+
+ topicId | path | Yes | string | | |
+
+
+Request
++++++++
+
+
+Responses
++++++++++
+
+**200**
+^^^^^^^
+
+Success
+
+
+Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "clients": [
+ {
+ "action": [
+ "somestring",
+ "somestring"
+ ],
+ "clientIdentity": "somestring",
+ "clientRole": "somestring",
+ "dcaeLocationName": "somestring",
+ "fqtn": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "mrClientId": "somestring",
+ "status": "EMPTY",
+ "topicURL": "somestring"
+ },
+ {
+ "action": [
+ "somestring",
+ "somestring"
+ ],
+ "clientIdentity": "somestring",
+ "clientRole": "somestring",
+ "dcaeLocationName": "somestring",
+ "fqtn": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "mrClientId": "somestring",
+ "status": "EMPTY",
+ "topicURL": "somestring"
+ }
+ ],
+ "formatUuid": "somestring",
+ "fqtn": "somestring",
+ "fqtnStyle": "FQTN_NOT_SPECIFIED",
+ "globalMrURL": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "owner": "somestring",
+ "partitionCount": "somestring",
+ "publisherRole": "somestring",
+ "replicationCase": "REPLICATION_NOT_SPECIFIED",
+ "replicationCount": "somestring",
+ "status": "EMPTY",
+ "subscriberRole": "somestring",
+ "tnxEnabled": "somestring",
+ "topicDescription": "somestring",
+ "topicName": "somestring",
+ "version": "somestring"
+ }
+
+**400**
+^^^^^^^
+
+Error
+
+
+Type: :ref:`ApiError <d_a3a7580ce9d87225d7f62e6b67b4d036>`
+
+**Example:**
+
+.. code-block:: javascript
+
+ {
+ "code": 1,
+ "fields": "somestring",
+ "is2xx": true,
+ "message": "somestring"
+ }
+
+
+
+
+Data Structures
+~~~~~~~~~~~~~~~
+
+.. _d_a3a7580ce9d87225d7f62e6b67b4d036:
+
+ApiError Model Structure
+------------------------
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 10, 15, 15, 30, 25
+
+ code | No | integer | int32 | |
+ fields | No | string | | |
+ is2xx | No | boolean | | |
+ message | No | string | | |
+
+.. _d_d71baea9d8e4e59bc395ef51f45dff1b:
+
+BrTopic Model Structure
+-----------------------
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 10, 15, 15, 30, 25
+
+ brSource | No | string | | |
+ brTarget | No | string | | |
+ mmAgentName | No | string | | |
+ topicCount | No | integer | int32 | |
+
+.. _d_d15e2cee407536866c875375e3f705e0:
+
+DR_Node Model Structure
+-----------------------
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 10, 15, 15, 30, 25
+
+ dcaeLocationName | No | string | | |
+ fqdn | No | string | | |
+ hostName | No | string | | |
+ lastMod | No | string | date-time | | datestamp for last update to this object
+ status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
+ version | No | string | | |
+
+.. _d_e926d3fa8701e0cc9c8ed1761b3255cd:
+
+DR_Pub Model Structure
+----------------------
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 10, 15, 15, 30, 25
+
+ dcaeLocationName | No | string | | |
+ feedId | No | string | | |
+ lastMod | No | string | date-time | | datestamp for last update to this object
+ pubId | No | string | | |
+ status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
+ username | No | string | | |
+ userpwd | No | string | | |
+
+.. _d_48cf328d246f41e1d11a09251b042f02:
+
+DR_Sub Model Structure
+----------------------
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 10, 15, 15, 30, 25
+
+ bytes | No | array of string | | |
+ dcaeLocationName | No | string | | |
+ deliveryURL | No | string | | |
+ feedId | No | string | | |
+ lastMod | No | string | date-time | | datestamp for last update to this object
+ logURL | No | string | | |
+ owner | No | string | | |
+ status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
+ subId | No | string | | |
+ suspended | No | boolean | | |
+ use100 | No | boolean | | |
+ username | No | string | | |
+ userpwd | No | string | | |
+
+.. _d_47d80e451933beb623fcf5257867cbcb:
+
+DcaeLocation Model Structure
+----------------------------
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 10, 15, 15, 30, 25
+
+ central | No | boolean | | |
+ clli | No | string | | |
+ dcaeLayer | No | string | | |
+ dcaeLocationName | No | string | | |
+ lastMod | No | string | date-time | | datestamp for last update to this object
+ local | No | boolean | | |
+ openStackAvailabilityZone | No | string | | |
+ status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
+ subnet | No | string | | |
+
+.. _d_4ea0e7758a1f8502222793e4a13b04f7:
+
+Dmaap Model Structure
+---------------------
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 10, 15, 15, 30, 25
+
+ accessKeyOwner | No | string | | |
+ bridgeAdminTopic | No | string | | |
+ dmaapName | No | string | | |
+ drProvUrl | No | string | | |
+ lastMod | No | string | date-time | | datestamp for last update to this object
+ loggingUrl | No | string | | |
+ nodeKey | No | string | | |
+ status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
+ topicNsRoot | No | string | | |
+ version | No | string | | |
+
+.. _d_289ad39619725df26c9ff382d4c97c75:
+
+Feed Model Structure
+--------------------
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 10, 15, 15, 30, 25
+
+ asprClassification | No | string | | |
+ bytes | No | array of string | | |
+ feedDescription | No | string | | |
+ feedId | No | string | | |
+ feedName | No | string | | |
+ feedVersion | No | string | | |
+ formatUuid | No | string | | |
+ lastMod | No | string | date-time | | datestamp for last update to this object
+ logURL | No | string | | |
+ owner | No | string | | |
+ publishURL | No | string | | |
+ pubs | No | array of :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>` | | |
+ status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
+ subs | No | array of :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>` | | |
+ subscribeURL | No | string | | |
+ suspended | No | boolean | | |
+
+.. _d_56ff81dc98986e27074d9be2731e3f4c:
+
+MR_Client Model Structure
+-------------------------
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 10, 15, 15, 30, 25
+
+ action | No | array of string | | | one or more actions from the set ('pub', 'sub', 'view') for which this client needs Permission
+ clientIdentity | No | string | | | an AAF identity to be associated to an appropriate topic Role
+ clientRole | No | string | | | an AAF Role to be granted an appropriate Permission. If specified, takes precedence over clientIdentity, for backwards compatibility.
+ dcaeLocationName | No | string | | | a tag indicating a logical deployment site
+ fqtn | No | string | | | Fully Qualified Topic Name constructed by dbcapi
+ lastMod | No | string | date-time | | datestamp for last update to this object
+ mrClientId | No | string | | | a unique identifier generated by dbcapi for this client
+ status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
+ topicURL | No | string | | | the URL for a MR instance - typically in the same dcaeLocation - that this client should use to access the topic
+
+.. _d_eec7176a0080debe1b19c2dad2e97c24:
+
+MR_Cluster Model Structure
+--------------------------
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 10, 15, 15, 30, 25
+
+ dcaeLocationName | No | string | | |
+ fqdn | No | string | | |
+ lastMod | No | string | date-time | |
+ replicationGroup | No | string | | |
+ sourceReplicationPort | No | string | | |
+ status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
+ targetReplicationPort | No | string | | |
+ topicPort | No | string | | |
+ topicProtocol | No | string | | |
+
+.. _d_08fb211d40d6deb9b6e04b000fd988e4:
+
+MirrorMaker Model Structure
+---------------------------
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 10, 15, 15, 30, 25
+
+ lastMod | No | string | date-time | | datestamp for last update to this object
+ mmName | No | string | | |
+ sourceCluster | No | string | | |
+ status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
+ targetCluster | No | string | | |
+ topicCount | No | integer | int32 | |
+ topics | No | array of string | | |
+ whitelistUpdateJSON | No | string | | |
+
+.. _d_2e99841971da81b9d240071b86bf168d:
+
+Topic Model Structure
+---------------------
+
+.. csv-table::
+ :delim: |
+ :header: "Name", "Required", "Type", "Format", "Properties", "Description"
+ :widths: 20, 10, 15, 15, 30, 25
+
+ clients | No | array of :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>` | | | an array of `MR_Client` objects associated to this `Topic`
+ formatUuid | No | string | | | a reference to an identifier that describes a data format used for this `Topic`
+ fqtn | No | string | | | Fully Qualified Topic Name constructed by dbcapi, following the rules for `fqtnStyle`
+ fqtnStyle | No | string | | {'enum': ['FQTN_NOT_SPECIFIED', 'FQTN_LEGACY_FORMAT', 'FQTN_PROJECTID_FORMAT', 'FQTN_PROJECTID_VERSION_FORMAT']} | the construction rule for the `fqtn` field
+ globalMrURL | No | string | | | the URL of an outside MR instance
+ lastMod | No | string | date-time | | datestamp for last update to this object
+ owner | No | string | | | a label used to identify who requested this `Topic` to be provisioned. In the future this may be an AAF Identity.
+ partitionCount | No | string | | | the kafka attribute for specifying the number of partitions
+ publisherRole | No | string | | | a value generated by dbcapi, this AAF Role has permission to publish to this `Topic`
+ replicationCase | No | string | | {'enum': ['REPLICATION_NOT_SPECIFIED', 'REPLICATION_NONE', 'REPLICATION_EDGE_TO_CENTRAL', 'REPLICATION_EDGE_TO_CENTRAL_TO_GLOBAL', 'REPLICATION_CENTRAL_TO_EDGE', 'REPLICATION_CENTRAL_TO_GLOBAL', 'REPLICATION_GLOBAL_TO_CENTRAL', 'REPLICATION_GLOBAL_TO_CENTRAL_TO_EDGE', 'REPLICATION_EDGE_TO_FQDN', 'REPLICATION_FQDN_TO_EDGE', 'REPLICATION_FQDN_TO_GLOBAL', 'REPLICATION_GLOBAL_TO_FQDN', 'REPLICATION_EDGE_TO_FQDN_TO_GLOBAL', 'REPLICATION_GLOBAL_TO_FQDN_TO_EDGE']} | An indicator for how this `Topic` should be replicated when there are more than one `MR_Cluster` instances
+ replicationCount | No | string | | | the kafka attribute for specifying replication within an `MR_Cluster` instance
+ status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
+ subscriberRole | No | string | | | a value generated by dbcapi, this AAF Role has permission to subscribe to this `Topic`
+ tnxEnabled | No | string | | |
+ topicDescription | No | string | | | a description of what this Topic is used for
+ topicName | No | string | | | the short name used by humans, and utilized to construct the `FQTN`
+ version | No | string | | | a hook for any versioning needed for managing a `Topic` over time
+
diff --git a/docs/apis/swagger.json b/docs/apis/swagger.json
new file mode 100644
index 0000000..ceb041f
--- /dev/null
+++ b/docs/apis/swagger.json
@@ -0,0 +1,1871 @@
+{
+ "swagger" : "2.0",
+ "info" : {
+ "description" : "provides an API for OpenDCAE components which need to provision\n\t\t\t\t\t\t\t\t\tunderlying DMaaP technologies (Data Router and Message Router).\n\t\t\t\t\t\t\t\t\tPrimary clients for this API are anticipated to be the OpenDCAE\n\t\t\t\t\t\t\t\t\tController, OpenDCAE Orchestrator, OpenDCAE Inventory and the\n\t\t\t\t\t\t\t\t\tECOMP Portal.\n\n\t\t\t\t\t\t\t\t\tObjects managed by DMaaP are deployed in a dcaeLocation which is a\n\t\t\t\t\t\t\t\t\tunique identifier for an OpenStack tenant for a dcaeLayer,\n\t\t\t\t\t\t\t\t\topendcae-central (aka ecomp) or opendcae-local-ntc (aka edge).\n\n\t\t\t\t\t\t\t\t\tA dcaeEnvironment (e.g. FTL or prod) has a single DMaaP. A\n\t\t\t\t\t\t\t\t\tDMaaP is managed by a one or more stateless DMaaP Bus\n\t\t\t\t\t\t\t\t\tController(s), though Bus Controller relies on PGaaS for\n\t\t\t\t\t\t\t\t\tpersistence. Each DMaaP has a single instance of Data Router,\n\t\t\t\t\t\t\t\t\twhich has 1 or more DR_Nodes deployed at each dcaeLocation. DR\n\t\t\t\t\t\t\t\t\tClients of type DR_Pub generally publish to a DR_Node that is\n\t\t\t\t\t\t\t\t\tlocal to its dcaeLocation. Routing for a Feed is determined by\n\t\t\t\t\t\t\t\t\tthe dcaelocation of its DR_Sub clients.\n\n\t\t\t\t\t\t\t\t\tA DMaaP may have many Message Router instances. Each instance is\n\t\t\t\t\t\t\t\t\tdeployed as an MR_Cluster. One MR_Cluster is deployed at each\n\t\t\t\t\t\t\t\t\tdcaeLocation. MR_Clients generally communicate to the\n\t\t\t\t\t\t\t\t\tMR_Cluster at the same dcaeLocation. Replication of messages\n\t\t\t\t\t\t\t\t\tbetween MR_Clusters is accomplished by MR Bridge, which is\n\t\t\t\t\t\t\t\t\tprovioned by DMaaP Bus Controller based on Topic attributes.\n\n\t\t\t\t\t\t\t\t\tTherefore, the role of DMaaP Bus Controller is to support other\n\t\t\t\t\t\t\t\t\tDCAE infrastructure components to dynamically provision DMaaP\n\t\t\t\t\t\t\t\t\tservices on behalf of DMaaP clients, and to assist in any\n\t\t\t\t\t\t\t\t\tmanagement or discovery activity of its clients.\n\n\t\t\t\t\t\t\t\t\tA convention of this API is to return JSON responses per\n\t\t\t\t\t\t\t\t\tOpenStack style.",
+ "version" : "1.1.0",
+ "title" : "DMaaP Bus Controller REST API",
+ "termsOfService" : "http://www.apache.org/licenses/LICENSE-2.0",
+ "contact" : {
+ "url" : "http://www.onap.org"
+ },
+ "license" : {
+ "name" : "Licensed under the Apache License, Version 2.0",
+ "url" : "http://www.apache.org/licenses/LICENSE-2.0"
+ }
+ },
+ "host" : "www.[host]:[port]",
+ "basePath" : "/webapi",
+ "tags" : [ {
+ "name" : "Feeds",
+ "description" : "Endpoint for a Data Router Feed"
+ }, {
+ "name" : "MR_Clients",
+ "description" : "Endpoint for a Message Router Client that implements a Publisher or a Subscriber"
+ }, {
+ "name" : "MR_Clusters",
+ "description" : "Endpoint for a Message Router servers in a Cluster configuration"
+ }, {
+ "name" : "bridge",
+ "description" : "Endpoint for retreiving MR Bridge metrics"
+ }, {
+ "name" : "dcaeLocations",
+ "description" : "an OpenStack tenant purposed for OpenDCAE (i.e. where OpenDCAE components might be deployed)"
+ }, {
+ "name" : "dmaap",
+ "description" : "Endpoint for this instance of DMaaP object containing values for this OpenDCAE deployment"
+ }, {
+ "name" : "dr_nodes",
+ "description" : "Endpoint for a Data Router Node server"
+ }, {
+ "name" : "dr_pubs",
+ "description" : "Endpoint for a Data Router client that implements a Publisher"
+ }, {
+ "name" : "dr_subs",
+ "description" : "Endpoint for a Data Router client that implements a Subscriber"
+ }, {
+ "name" : "info",
+ "description" : "Endpoint for this instance of DBCL. Returns health info."
+ }, {
+ "name" : "topics",
+ "description" : "Endpoint for retreiving MR Topics"
+ } ],
+ "schemes" : [ "http", "https" ],
+ "paths" : {
+ "/bridge" : {
+ "get" : {
+ "tags" : [ "bridge" ],
+ "summary" : "return BrTopic details",
+ "description" : "Returns array of `BrTopic` objects. If source and target query params are specified, only report on that bridge. If detail param is true, list topics names, else just a count is returned.",
+ "operationId" : "getBridgedTopics",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "mmagent",
+ "in" : "query",
+ "required" : false,
+ "type" : "string"
+ }, {
+ "name" : "detail",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/BrTopic"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ },
+ "put" : {
+ "tags" : [ "bridge" ],
+ "summary" : "update MirrorMaker details",
+ "description" : "replace the topic list for a specific Bridge. Use JSON Body for value to replace whitelist, but if refreshFlag param is true, simply refresh using existing whitelist.If split param is true, spread whitelist over smaller mmagents.",
+ "operationId" : "putBridgedTopics",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "mmagent",
+ "in" : "query",
+ "required" : false,
+ "type" : "string"
+ }, {
+ "name" : "refresh",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean"
+ }, {
+ "name" : "split",
+ "in" : "query",
+ "required" : false,
+ "type" : "boolean"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/BrTopic"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ }
+ },
+ "/dcaeLocations" : {
+ "get" : {
+ "tags" : [ "dcaeLocations" ],
+ "summary" : "return dcaeLocation details",
+ "description" : "Returns array of `dcaeLocation` objects. All objects managed by DMaaP are deployed in some `dcaeLocation` which is a unique identifier for an *OpenStack* tenant purposed for a *dcaeLayer* (ecomp or edge).",
+ "operationId" : "getDcaeLocations",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/DcaeLocation"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "dcaeLocations" ],
+ "summary" : "return dcaeLocation details",
+ "description" : "Create some `dcaeLocation` which is a unique identifier for an *OpenStack* tenant purposed for a *dcaeLayer* (ecomp or edge).",
+ "operationId" : "addDcaeLocation",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/DcaeLocation"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ }
+ },
+ "/dcaeLocations/{locationName}" : {
+ "get" : {
+ "tags" : [ "dcaeLocations" ],
+ "summary" : "return dcaeLocation details",
+ "description" : "Returns a specific `dcaeLocation` object with specified tag",
+ "operationId" : "getDcaeLocation",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "locationName",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/DcaeLocation"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ },
+ "put" : {
+ "tags" : [ "dcaeLocations" ],
+ "summary" : "return dcaeLocation details",
+ "description" : "update the openStackAvailabilityZone of a dcaeLocation",
+ "operationId" : "updateDcaeLocation",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "locationName",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/DcaeLocation"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "dcaeLocations" ],
+ "summary" : "return dcaeLocation details",
+ "description" : "delete a dcaeLocation",
+ "operationId" : "deleteDcaeLocation",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "locationName",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/DcaeLocation"
+ }
+ },
+ "204" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/DcaeLocation"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ }
+ },
+ "/dmaap" : {
+ "get" : {
+ "tags" : [ "dmaap" ],
+ "summary" : "return dmaap details",
+ "description" : "returns the `dmaap` object, which contains system wide configuration settings",
+ "operationId" : "getDmaap",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/Dmaap"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "dmaap" ],
+ "summary" : "return dmaap details",
+ "description" : "Create a new DMaaP set system wide configuration settings for the *dcaeEnvironment*. Deprecated with introduction of persistence in 1610.",
+ "operationId" : "addDmaap",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/Dmaap"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ },
+ "put" : {
+ "tags" : [ "dmaap" ],
+ "summary" : "return dmaap details",
+ "description" : "Update system settings for *dcaeEnvironment*.",
+ "operationId" : "updateDmaap",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/Dmaap"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ }
+ },
+ "/dr_nodes" : {
+ "get" : {
+ "tags" : [ "dr_nodes" ],
+ "summary" : "return DR_Node details",
+ "description" : "Returns array of `DR_Node` object array. Need to add filter by dcaeLocation.",
+ "operationId" : "getDr_Nodes",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/DR_Node"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "dr_nodes" ],
+ "summary" : "return DR_Node details",
+ "description" : "create a `DR_Node` in a *dcaeLocation*. Note that multiple `DR_Node`s may exist in the same `dcaeLocation`.",
+ "operationId" : "addDr_Node",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/DR_Node"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ }
+ },
+ "/dr_nodes/{fqdn}" : {
+ "get" : {
+ "tags" : [ "dr_nodes" ],
+ "summary" : "return DR_Node details",
+ "description" : "Retrieve a single `DR_Node` object.",
+ "operationId" : "get",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "fqdn",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/DR_Node"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ },
+ "put" : {
+ "tags" : [ "dr_nodes" ],
+ "summary" : "return DR_Node details",
+ "description" : "Update a single `DR_Node` object.",
+ "operationId" : "updateDr_Node",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "fqdn",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/DR_Node"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "dr_nodes" ],
+ "summary" : "No Content",
+ "description" : "Delete a single `DR_Node` object.",
+ "operationId" : "deleteDr_Node",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "fqdn",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/DR_Node"
+ }
+ },
+ "204" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/DR_Node"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ }
+ },
+ "/dr_pubs" : {
+ "get" : {
+ "tags" : [ "dr_pubs" ],
+ "summary" : "return DR_Pub details",
+ "description" : "Returns array of `DR_Pub` objects. Add filter for feedId.",
+ "operationId" : "getDr_Pubs",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/DR_Pub"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "dr_pubs" ],
+ "summary" : "return DR_Pub details",
+ "description" : "create a DR Publisher in the specified environment.",
+ "operationId" : "addDr_Pub",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/DR_Pub"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ }
+ },
+ "/dr_pubs/{pubId}" : {
+ "get" : {
+ "tags" : [ "dr_pubs" ],
+ "summary" : "return DR_Pub details",
+ "description" : "returns a DR Publisher in the specified environment. Gets a `DR_Pub` object by pubId",
+ "operationId" : "get",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "pubId",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/DR_Pub"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ },
+ "put" : {
+ "tags" : [ "dr_pubs" ],
+ "summary" : "return DR_Pub details",
+ "description" : "update a DR Publisher in the specified environment. Update a `DR_Pub` object by pubId",
+ "operationId" : "updateDr_Pub",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "pubId",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/DR_Pub"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "dr_pubs" ],
+ "summary" : "return DR_Pub details",
+ "description" : "delete a DR Publisher in the specified environment. Delete a `DR_Pub` object by pubId",
+ "operationId" : "deleteDr_Pub",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "pubId",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/DR_Pub"
+ }
+ },
+ "204" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/DR_Pub"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ }
+ },
+ "/dr_subs" : {
+ "get" : {
+ "tags" : [ "dr_subs" ],
+ "summary" : "return DR_Sub details",
+ "description" : "Returns array of `DR_Sub` objects. Add filter for feedId.",
+ "operationId" : "getDr_Subs",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/DR_Sub"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "dr_subs" ],
+ "summary" : "return DR_Sub details",
+ "description" : "Create a `DR_Sub` object. ",
+ "operationId" : "addDr_Sub",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/DR_Sub"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ }
+ },
+ "/dr_subs/{subId}" : {
+ "get" : {
+ "tags" : [ "dr_subs" ],
+ "summary" : "return DR_Sub details",
+ "description" : "Retrieve a `DR_Sub` object, selected by subId",
+ "operationId" : "get",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "subId",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/DR_Sub"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ },
+ "put" : {
+ "tags" : [ "dr_subs" ],
+ "summary" : "return DR_Sub details",
+ "description" : "Update a `DR_Sub` object, selected by subId",
+ "operationId" : "updateDr_Sub",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "subId",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/DR_Sub"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "dr_subs" ],
+ "summary" : "return DR_Sub details",
+ "description" : "Delete a `DR_Sub` object, selected by subId",
+ "operationId" : "deleteDr_Sub",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "subId",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/DR_Sub"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ }
+ },
+ "/feeds" : {
+ "get" : {
+ "tags" : [ "Feeds" ],
+ "summary" : "return Feed details",
+ "description" : "Returns array of `Feed` objects.",
+ "operationId" : "getFeeds",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "feedName",
+ "in" : "query",
+ "required" : false,
+ "type" : "string"
+ }, {
+ "name" : "version",
+ "in" : "query",
+ "required" : false,
+ "type" : "string"
+ }, {
+ "name" : "match",
+ "in" : "query",
+ "required" : false,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/Feed"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "Feeds" ],
+ "summary" : "return Feed details",
+ "description" : "Create a of `Feed` object.",
+ "operationId" : "addFeed",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "useExisting",
+ "in" : "query",
+ "required" : false,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/Feed"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ }
+ },
+ "/feeds/sync" : {
+ "put" : {
+ "tags" : [ "Feeds" ],
+ "summary" : "sync feeds to existing DR",
+ "description" : "When Bus Controller is deployed after DR, then it is possiblethat DR has previous provisioning data that needs to be importedinto Bus Controller.",
+ "operationId" : "syncFeeds",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "hard",
+ "in" : "query",
+ "required" : false,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/Feed"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ }
+ },
+ "/feeds/{id}" : {
+ "get" : {
+ "tags" : [ "Feeds" ],
+ "summary" : "return Feed details",
+ "description" : "Retrieve a `Feed` object, specified by id.",
+ "operationId" : "getFeed",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "id",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/DR_Pub"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ },
+ "put" : {
+ "tags" : [ "Feeds" ],
+ "summary" : "return Feed details",
+ "description" : "Update a `Feed` object, specified by id.",
+ "operationId" : "updateFeed",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "id",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/Feed"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "Feeds" ],
+ "summary" : "return Feed details",
+ "description" : "Delete a `Feed` object, specified by id.",
+ "operationId" : "deleteFeed",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "id",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/Feed"
+ }
+ },
+ "204" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/Feed"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ }
+ },
+ "/info" : {
+ "get" : {
+ "tags" : [ "info" ],
+ "summary" : "return info details",
+ "description" : "returns the `info` object",
+ "operationId" : "getInfo",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/Dmaap"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ }
+ },
+ "/mr_clients" : {
+ "get" : {
+ "tags" : [ "MR_Clients" ],
+ "summary" : "return MR_Client details",
+ "description" : "Returns array of `MR_Client` objects.",
+ "operationId" : "getMr_Clients",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/MR_Client"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "MR_Clients" ],
+ "summary" : "Associate an MR_Client object to a Topic",
+ "description" : "Create a `MR_Client` object.The `dcaeLocation` attribute is used to match an `MR_Cluster` object with the same value, with the intent of localizing message traffic. In legacy implementation, the `clientRole` is granted appropriate permission in AAF. Newer implementions may instead specify an AAF Identity, which will be added to the appropriate `Topic` role.",
+ "operationId" : "addMr_Client",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/MR_Client"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ }
+ },
+ "/mr_clients/{clientId}" : {
+ "put" : {
+ "tags" : [ "MR_Clients" ],
+ "summary" : "Update an MR_Client object",
+ "description" : "Update a `MR_Client` object, specified by clientId",
+ "operationId" : "updateMr_Client",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "clientId",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/MR_Client"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ }
+ },
+ "/mr_clients/{subId}" : {
+ "get" : {
+ "tags" : [ "MR_Clients" ],
+ "summary" : "return MR_Client details",
+ "description" : "Retrieve a `MR_Client` object, specified by clientId",
+ "operationId" : "test",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "subId",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/MR_Client"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "MR_Clients" ],
+ "summary" : "Delete an MR_Client object",
+ "description" : "Delete a `MR_Client` object, specified by clientId",
+ "operationId" : "deleteMr_Client",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "subId",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/MR_Client"
+ }
+ },
+ "204" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/MR_Client"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ }
+ },
+ "/mr_clusters" : {
+ "get" : {
+ "tags" : [ "MR_Clusters" ],
+ "summary" : "return MR_Cluster details",
+ "description" : "Returns array of `MR_Cluster` objects.",
+ "operationId" : "getMr_Clusters",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/MR_Cluster"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "MR_Clusters" ],
+ "summary" : "return MR_Cluster details",
+ "description" : "Create an `MR_Cluster` object.",
+ "operationId" : "addMr_Cluster",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/MR_Cluster"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ }
+ },
+ "/mr_clusters/{clusterId}" : {
+ "get" : {
+ "tags" : [ "MR_Clusters" ],
+ "summary" : "return MR_Cluster details",
+ "description" : "Retrieve an `MR_Cluster` object, specified by clusterId.",
+ "operationId" : "getMR_Cluster",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "clusterId",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/MR_Cluster"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ },
+ "put" : {
+ "tags" : [ "MR_Clusters" ],
+ "summary" : "return MR_Cluster details",
+ "description" : "Update an `MR_Cluster` object, specified by clusterId.",
+ "operationId" : "updateMr_Cluster",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "clusterId",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/MR_Cluster"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "MR_Clusters" ],
+ "summary" : "return MR_Cluster details",
+ "description" : "Delete an `MR_Cluster` object, specified by clusterId.",
+ "operationId" : "deleteMr_Cluster",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "clusterId",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/MR_Cluster"
+ }
+ },
+ "204" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/MR_Cluster"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ }
+ },
+ "/topics" : {
+ "get" : {
+ "tags" : [ "topics" ],
+ "summary" : "return Topic details",
+ "description" : "Returns array of `Topic` objects.",
+ "operationId" : "getTopics",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/Topic"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "topics" ],
+ "summary" : "Create a Topic object",
+ "description" : "Create `Topic` object.For convenience, the message body may populate the `clients` array, in which case each entry will be added as an `MR_Client`. Beginning in ONAP Dublin Release, dbcapi will create two AAF Roles by default, one each for the publisher and subscriber per topic. MR_Clients can then specify an AAF Identity to be added to the appropriate default Role, avoiding the need to create Role(s) in advance.",
+ "operationId" : "addTopic",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "useExisting",
+ "in" : "query",
+ "required" : false,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/Topic"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ }
+ },
+ "/topics/{topicId}" : {
+ "get" : {
+ "tags" : [ "topics" ],
+ "summary" : "return Topic details",
+ "description" : "Retrieve a `Topic` object, identified by topicId",
+ "operationId" : "getTopic",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "topicId",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/Topic"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ },
+ "put" : {
+ "tags" : [ "topics" ],
+ "summary" : "return Topic details",
+ "description" : "Update a `Topic` object, identified by topicId",
+ "operationId" : "updateTopic",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "topicId",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/Topic"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "topics" ],
+ "summary" : "return Topic details",
+ "description" : "Delete a `Topic` object, identified by topicId",
+ "operationId" : "deleteTopic",
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "topicId",
+ "in" : "path",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/Topic"
+ }
+ },
+ "204" : {
+ "description" : "Success",
+ "schema" : {
+ "$ref" : "#/definitions/Topic"
+ }
+ },
+ "400" : {
+ "description" : "Error",
+ "schema" : {
+ "$ref" : "#/definitions/ApiError"
+ }
+ }
+ }
+ }
+ }
+ },
+ "definitions" : {
+ "ApiError" : {
+ "type" : "object",
+ "properties" : {
+ "code" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "message" : {
+ "type" : "string"
+ },
+ "fields" : {
+ "type" : "string"
+ },
+ "is2xx" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "BrTopic" : {
+ "type" : "object",
+ "properties" : {
+ "brSource" : {
+ "type" : "string"
+ },
+ "brTarget" : {
+ "type" : "string"
+ },
+ "mmAgentName" : {
+ "type" : "string"
+ },
+ "topicCount" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ }
+ },
+ "DR_Node" : {
+ "type" : "object",
+ "properties" : {
+ "lastMod" : {
+ "type" : "string",
+ "format" : "date-time",
+ "description" : "datestamp for last update to this object"
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "EMPTY", "NEW", "STAGED", "VALID", "INVALID", "DELETED" ]
+ },
+ "fqdn" : {
+ "type" : "string"
+ },
+ "dcaeLocationName" : {
+ "type" : "string"
+ },
+ "hostName" : {
+ "type" : "string"
+ },
+ "version" : {
+ "type" : "string"
+ }
+ }
+ },
+ "DR_Pub" : {
+ "type" : "object",
+ "properties" : {
+ "lastMod" : {
+ "type" : "string",
+ "format" : "date-time",
+ "description" : "datestamp for last update to this object"
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "EMPTY", "NEW", "STAGED", "VALID", "INVALID", "DELETED" ]
+ },
+ "dcaeLocationName" : {
+ "type" : "string"
+ },
+ "username" : {
+ "type" : "string"
+ },
+ "userpwd" : {
+ "type" : "string"
+ },
+ "feedId" : {
+ "type" : "string"
+ },
+ "pubId" : {
+ "type" : "string"
+ },
+ "feedName" : {
+ "type" : "string"
+ },
+ "feedVersion" : {
+ "type" : "string"
+ }
+ }
+ },
+ "DR_Sub" : {
+ "type" : "object",
+ "properties" : {
+ "lastMod" : {
+ "type" : "string",
+ "format" : "date-time",
+ "description" : "datestamp for last update to this object"
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "EMPTY", "NEW", "STAGED", "VALID", "INVALID", "DELETED" ]
+ },
+ "dcaeLocationName" : {
+ "type" : "string"
+ },
+ "username" : {
+ "type" : "string"
+ },
+ "userpwd" : {
+ "type" : "string"
+ },
+ "feedId" : {
+ "type" : "string"
+ },
+ "deliveryURL" : {
+ "type" : "string"
+ },
+ "logURL" : {
+ "type" : "string"
+ },
+ "subId" : {
+ "type" : "string"
+ },
+ "use100" : {
+ "type" : "boolean"
+ },
+ "suspended" : {
+ "type" : "boolean"
+ },
+ "owner" : {
+ "type" : "string"
+ },
+ "guaranteedDelivery" : {
+ "type" : "boolean"
+ },
+ "guaranteedSequence" : {
+ "type" : "boolean"
+ },
+ "privilegedSubscriber" : {
+ "type" : "boolean"
+ },
+ "decompress" : {
+ "type" : "boolean"
+ },
+ "feedName" : {
+ "type" : "string"
+ },
+ "feedVersion" : {
+ "type" : "string"
+ }
+ }
+ },
+ "DcaeLocation" : {
+ "type" : "object",
+ "properties" : {
+ "lastMod" : {
+ "type" : "string",
+ "format" : "date-time",
+ "description" : "datestamp for last update to this object"
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "EMPTY", "NEW", "STAGED", "VALID", "INVALID", "DELETED" ]
+ },
+ "clli" : {
+ "type" : "string"
+ },
+ "dcaeLayer" : {
+ "type" : "string"
+ },
+ "dcaeLocationName" : {
+ "type" : "string"
+ },
+ "openStackAvailabilityZone" : {
+ "type" : "string"
+ },
+ "subnet" : {
+ "type" : "string"
+ },
+ "local" : {
+ "type" : "boolean"
+ },
+ "central" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "Dmaap" : {
+ "type" : "object",
+ "properties" : {
+ "lastMod" : {
+ "type" : "string",
+ "format" : "date-time",
+ "description" : "datestamp for last update to this object"
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "EMPTY", "NEW", "STAGED", "VALID", "INVALID", "DELETED" ]
+ },
+ "version" : {
+ "type" : "string"
+ },
+ "topicNsRoot" : {
+ "type" : "string"
+ },
+ "dmaapName" : {
+ "type" : "string"
+ },
+ "drProvUrl" : {
+ "type" : "string"
+ },
+ "bridgeAdminTopic" : {
+ "type" : "string"
+ },
+ "loggingUrl" : {
+ "type" : "string"
+ },
+ "nodeKey" : {
+ "type" : "string"
+ },
+ "accessKeyOwner" : {
+ "type" : "string"
+ }
+ }
+ },
+ "Feed" : {
+ "type" : "object",
+ "properties" : {
+ "lastMod" : {
+ "type" : "string",
+ "format" : "date-time",
+ "description" : "datestamp for last update to this object"
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "EMPTY", "NEW", "STAGED", "VALID", "INVALID", "DELETED" ]
+ },
+ "feedId" : {
+ "type" : "string"
+ },
+ "feedName" : {
+ "type" : "string"
+ },
+ "feedVersion" : {
+ "type" : "string"
+ },
+ "feedDescription" : {
+ "type" : "string"
+ },
+ "owner" : {
+ "type" : "string"
+ },
+ "asprClassification" : {
+ "type" : "string"
+ },
+ "publishURL" : {
+ "type" : "string"
+ },
+ "subscribeURL" : {
+ "type" : "string"
+ },
+ "suspended" : {
+ "type" : "boolean"
+ },
+ "logURL" : {
+ "type" : "string"
+ },
+ "formatUuid" : {
+ "type" : "string"
+ },
+ "pubs" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/DR_Pub"
+ }
+ },
+ "subs" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/DR_Sub"
+ }
+ },
+ "bytes" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string",
+ "format" : "byte"
+ }
+ }
+ }
+ },
+ "MR_Client" : {
+ "type" : "object",
+ "properties" : {
+ "lastMod" : {
+ "type" : "string",
+ "format" : "date-time",
+ "description" : "datestamp for last update to this object"
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "EMPTY", "NEW", "STAGED", "VALID", "INVALID", "DELETED" ]
+ },
+ "dcaeLocationName" : {
+ "type" : "string",
+ "description" : "a tag indicating a logical deployment site"
+ },
+ "topicURL" : {
+ "type" : "string",
+ "description" : "the URL for a MR instance - typically in the same dcaeLocation - that this client should use to access the topic"
+ },
+ "fqtn" : {
+ "type" : "string",
+ "description" : "Fully Qualified Topic Name constructed by dbcapi"
+ },
+ "clientRole" : {
+ "type" : "string",
+ "description" : "an AAF Role to be granted an appropriate Permission. If specified, takes precedence over clientIdentity, for backwards compatibility."
+ },
+ "action" : {
+ "type" : "array",
+ "description" : "one or more actions from the set (\"pub\", \"sub\", \"view\") for which this client needs Permission",
+ "items" : {
+ "type" : "string"
+ }
+ },
+ "mrClientId" : {
+ "type" : "string",
+ "description" : "a unique identifier generated by dbcapi for this client"
+ },
+ "clientIdentity" : {
+ "type" : "string",
+ "description" : "an AAF identity to be associated to an appropriate topic Role"
+ }
+ }
+ },
+ "MR_Cluster" : {
+ "type" : "object",
+ "properties" : {
+ "lastMod" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "EMPTY", "NEW", "STAGED", "VALID", "INVALID", "DELETED" ]
+ },
+ "dcaeLocationName" : {
+ "type" : "string"
+ },
+ "fqdn" : {
+ "type" : "string"
+ },
+ "topicProtocol" : {
+ "type" : "string"
+ },
+ "topicPort" : {
+ "type" : "string"
+ },
+ "replicationGroup" : {
+ "type" : "string"
+ },
+ "sourceReplicationPort" : {
+ "type" : "string"
+ },
+ "targetReplicationPort" : {
+ "type" : "string"
+ }
+ }
+ },
+ "MirrorMaker" : {
+ "type" : "object",
+ "properties" : {
+ "lastMod" : {
+ "type" : "string",
+ "format" : "date-time",
+ "description" : "datestamp for last update to this object"
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "EMPTY", "NEW", "STAGED", "VALID", "INVALID", "DELETED" ]
+ },
+ "sourceCluster" : {
+ "type" : "string"
+ },
+ "targetCluster" : {
+ "type" : "string"
+ },
+ "mmName" : {
+ "type" : "string"
+ },
+ "topics" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ },
+ "whitelistUpdateJSON" : {
+ "type" : "string"
+ },
+ "topicCount" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ }
+ },
+ "Topic" : {
+ "type" : "object",
+ "properties" : {
+ "lastMod" : {
+ "type" : "string",
+ "format" : "date-time",
+ "description" : "datestamp for last update to this object"
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "EMPTY", "NEW", "STAGED", "VALID", "INVALID", "DELETED" ]
+ },
+ "fqtn" : {
+ "type" : "string",
+ "description" : "Fully Qualified Topic Name constructed by dbcapi, following the rules for `fqtnStyle`"
+ },
+ "topicName" : {
+ "type" : "string",
+ "description" : "the short name used by humans, and utilized to construct the `FQTN`"
+ },
+ "topicDescription" : {
+ "type" : "string",
+ "description" : "a description of what this Topic is used for"
+ },
+ "tnxEnabled" : {
+ "type" : "string"
+ },
+ "owner" : {
+ "type" : "string",
+ "description" : "a label used to identify who requested this `Topic` to be provisioned. In the future this may be an AAF Identity."
+ },
+ "formatUuid" : {
+ "type" : "string",
+ "description" : "a reference to an identifier that describes a data format used for this `Topic`"
+ },
+ "replicationCase" : {
+ "type" : "string",
+ "description" : "An indicator for how this `Topic` should be replicated when there are more than one `MR_Cluster` instances",
+ "enum" : [ "REPLICATION_NOT_SPECIFIED", "REPLICATION_NONE", "REPLICATION_EDGE_TO_CENTRAL", "REPLICATION_EDGE_TO_CENTRAL_TO_GLOBAL", "REPLICATION_CENTRAL_TO_EDGE", "REPLICATION_CENTRAL_TO_GLOBAL", "REPLICATION_GLOBAL_TO_CENTRAL", "REPLICATION_GLOBAL_TO_CENTRAL_TO_EDGE", "REPLICATION_EDGE_TO_FQDN", "REPLICATION_FQDN_TO_EDGE", "REPLICATION_FQDN_TO_GLOBAL", "REPLICATION_GLOBAL_TO_FQDN", "REPLICATION_EDGE_TO_FQDN_TO_GLOBAL", "REPLICATION_GLOBAL_TO_FQDN_TO_EDGE" ]
+ },
+ "globalMrURL" : {
+ "type" : "string",
+ "description" : "the URL of an outside MR instance"
+ },
+ "fqtnStyle" : {
+ "type" : "string",
+ "description" : "the construction rule for the `fqtn` field",
+ "enum" : [ "FQTN_NOT_SPECIFIED", "FQTN_LEGACY_FORMAT", "FQTN_PROJECTID_FORMAT", "FQTN_PROJECTID_VERSION_FORMAT" ]
+ },
+ "version" : {
+ "type" : "string",
+ "description" : "a hook for any versioning needed for managing a `Topic` over time"
+ },
+ "partitionCount" : {
+ "type" : "string",
+ "description" : "the kafka attribute for specifying the number of partitions"
+ },
+ "replicationCount" : {
+ "type" : "string",
+ "description" : "the kafka attribute for specifying replication within an `MR_Cluster` instance"
+ },
+ "publisherRole" : {
+ "type" : "string",
+ "description" : "a value generated by dbcapi, this AAF Role has permission to publish to this `Topic`"
+ },
+ "subscriberRole" : {
+ "type" : "string",
+ "description" : "a value generated by dbcapi, this AAF Role has permission to subscribe to this `Topic`"
+ },
+ "clients" : {
+ "type" : "array",
+ "description" : "an array of `MR_Client` objects associated to this `Topic`",
+ "items" : {
+ "$ref" : "#/definitions/MR_Client"
+ }
+ }
+ }
+ }
+ }
+} \ No newline at end of file
diff --git a/docs/architecture/architecture.rst b/docs/architecture.rst
index 547e204..721146d 100644
--- a/docs/architecture/architecture.rst
+++ b/docs/architecture.rst
@@ -8,13 +8,15 @@ Architecture
Capabilities
------------
-Bus Controller is a RESTful web service used to provision DMaaP topics (on Message Router) and feeds (on Data Router), with associated authorization (on AAF).
+Bus Controller is a RESTful web service used to provision DMaaP topics on MR (Message Router)
+and feeds on DR (Data Router), with associated authorization via AAF.
Usage Scenarios
---------------
Bus Controller endpoints are used to provision:
-- a authorized topic on MR, and to create and grant permission for publishers and subscribers.
-- a feed on DR, with associated user authenticatio n.
+
+- an authorized topic on MR, and to create and grant permission for publishers and subscribers.
+- a feed on DR, with associated user authentication.
.. blockdiag::
diff --git a/docs/configuration/configuration.rst b/docs/configuration.rst
index d85b4dc..d85b4dc 100644
--- a/docs/configuration/configuration.rst
+++ b/docs/configuration.rst
diff --git a/docs/consumedapis/consumedapis.rst b/docs/consumedapis.rst
index c45851c..303fad5 100644
--- a/docs/consumedapis/consumedapis.rst
+++ b/docs/consumedapis.rst
@@ -5,6 +5,7 @@ Consumed APIs
==============
Bus Controller consumes the following APIs:
+
1) the Message Router topic creation API
2) the AAF authorization API to create and grant permissions
3) the DR Provisioning API to create feeds and subscribers
diff --git a/docs/delivery/delivery.rst b/docs/delivery.rst
index e438b25..e438b25 100644
--- a/docs/delivery/delivery.rst
+++ b/docs/delivery.rst
diff --git a/docs/humaninterfaces/humaninterfaces.rst b/docs/humaninterfaces/humaninterfaces.rst
deleted file mode 100644
index f115731..0000000
--- a/docs/humaninterfaces/humaninterfaces.rst
+++ /dev/null
@@ -1,8 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Human Interfaces
-================
-
-
-Buscontroller does not have human interfaces.
diff --git a/docs/index.rst b/docs/index.rst
index 4e2ad15..5feae2f 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -6,17 +6,16 @@ dmaap/buscontroller
===================
.. toctree::
- :maxdepth: 3
+ :maxdepth: 1
+
+ architecture.rst
+ configuration.rst
+ installation.rst
+ offeredapis.rst
+ consumedapis.rst
+ logging.rst
+ delivery.rst
+ security.rst
+ release-notes.rst
- architecture/architecture.rst
- release-notes/release-notes.rst
- configuration/configuration.rst
- humaninterfaces/humaninterfaces.rst
- offeredapis/offeredapis.rst
- Installation/Installation.rst
- consumedapis/consumedapis.rst
- administration/administration.rst
- logging/logging.rst
- delivery/delivery.rst
- security/security.rst
diff --git a/docs/Installation/Installation.rst b/docs/installation.rst
index 3a8e732..cee606c 100644
--- a/docs/Installation/Installation.rst
+++ b/docs/installation.rst
@@ -4,8 +4,6 @@
Installation
============
-Environment
-===========
Bus Controller is developed using Postgresql. An embedded Jetty server is used to create the REST service.
The service is packaged as a Docker container image.
Helm charts for Bus Controller are part of the overall dmaap chart set.
@@ -25,6 +23,7 @@ Customizing the Bus Controller configuration
The Bus Controller is highly configurable, but by default has settings that should work for a standard ONAP oom deployment.
However, if some customization is desired, there are places to change behavior:
+
1) The --namespace argument of the helm install step is also refernced to compose the topic namespace used. i.e. the value is appended to org.onap.dmaap. Since Message Router uses org.onap.dmaap.mr by default, we also use --namespace=mr. But this can be changed to a value that matches a different deployment of MR.
2) oom/kubernetes/dmaap/charts/dmaap-bus-controller/values.yaml contains the set of tags used within the charts. These can be modified if necessary.
3) oom/kubernetes/dmaap/charts/dmaap-bus-controller/resources/config/buscontroller.env contains some environment settings for the container. These can be modified. For example, to indicate that AAF integration should be enabled, set USE_AAF=true in this file.
@@ -38,7 +37,7 @@ On Intel dev machine, in terminal (> indicates prompt) :
> git clone https://gerrit.onap.org/r/dmaap/buscontroller
- anonymous http, can't push changes
> cd buscontroller
- > mvn clean install -Pdocker
+ > mvn clean install -P docker
- builds dmaap-bc and dbc-client images
2) Run tests
> cd dmaap-bc/src/main/resources/
@@ -56,7 +55,7 @@ On Arm:
> git clone https://gerrit.onap.org/r/dmaap/buscontroller
- anonymous http, can't push changes
> cd buscontroller
- > mvn clean install -Pdocker -Ddocker.pull.registry=docker.io
+ > mvn clean install -P docker -Ddocker.pull.registry=docker.io
- ensure we pull Arm version of base image
2) Run tests
> cd dmaap-bc/src/main/resources/
diff --git a/docs/logging.rst b/docs/logging.rst
new file mode 100644
index 0000000..676a106
--- /dev/null
+++ b/docs/logging.rst
@@ -0,0 +1,19 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+ .. http://creativecommons.org/licenses/by/4.0
+
+Logging
+=======
+
+Where to Access Information
+---------------------------
+Bus Controller uses logback framework to generate logs found under logs/ONAP.
+Logs are organized into files:
+
+- application.log - contains general logs
+- error.log - contains errors
+- audit.log - contains transactions for audit trail
+- server.log - contains jetty server specific logging
+
+Error / Warning Messages
+------------------------
+Logging to error.log will distinguish critical errors from warnings.
diff --git a/docs/logging/logging.rst b/docs/logging/logging.rst
deleted file mode 100644
index aa6ae57..0000000
--- a/docs/logging/logging.rst
+++ /dev/null
@@ -1,28 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
- .. http://creativecommons.org/licenses/by/4.0
-
-Logging
-=======
-
-.. note::
- * This section is used to describe the informational or diagnostic messages emitted from
- a software component and the methods or collecting them.
-
- * This section is typically: provided for a platform-component and sdk; and
- referenced in developer and user guides
-
- * This note must be removed after content has been added.
-
-
-Where to Access Information
----------------------------
-Bus Controller uses logback framework to generate logs found under logs/ONAP.
-Logs are organized into files:
-application.log - contains general logs
-error.log - contains errors
-audit.log - contains transactions for audit trail
-server.log - contains jetty server specific logging
-
-Error / Warning Messages
-------------------------
-Logging to error.log will distinguish critical errors from warnings.
diff --git a/docs/offeredapis/offeredapis.rst b/docs/offeredapis.rst
index f905f38..61991da 100644
--- a/docs/offeredapis/offeredapis.rst
+++ b/docs/offeredapis.rst
@@ -5,4 +5,8 @@
Offered APIs
==============
-Refer to Bus Controller API under https://onap.readthedocs.io/en/latest/guides/onap-developer/apiref/index.html
+.. toctree::
+ :maxdepth: 1
+
+ apis/api-table.rst
+ apis/api.rst
diff --git a/docs/release-notes/release-notes.rst b/docs/release-notes.rst
index 42f7b2c..40dcb45 100644
--- a/docs/release-notes/release-notes.rst
+++ b/docs/release-notes.rst
@@ -3,8 +3,9 @@
.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
.. _release_notes:
-DMaaP Buscontroller Release Notes
-====================
+=============
+Release Notes
+=============
.. note
.. * This Release Notes must be updated each time the team decides to Release new artifacts.
@@ -16,9 +17,9 @@ DMaaP Buscontroller Release Notes
.. * This note must be removed after content has been added.
-.. ===========================
-.. * * * Honolulu * * *
-.. ===========================
+
+Honolulu
+========
@@ -80,7 +81,7 @@ Security Notes
References
----------
-For more information on the ONAP Guilin release, please see:
+For more information on the ONAP Honolulu release, please see:
#. `ONAP Home Page`_
#. `ONAP Documentation`_
@@ -95,14 +96,13 @@ For more information on the ONAP Guilin release, please see:
Quick Links:
-- `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
-- `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/1751>`_
-.. ===========================
-.. * * * GUILIN * * *
-.. ===========================
+- `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
+- `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
+Guilin
+======
Abstract
--------
@@ -179,13 +179,13 @@ For more information on the ONAP Guilin release, please see:
Quick Links:
+
- `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
-- `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/1751>`_
-.. ===========================
-.. * * * FRANKFURT * * *
-.. ===========================
+- `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
+Frankfurt
+=========
Abstract
@@ -271,12 +271,13 @@ For more information on the ONAP Frankfurt release, please see:
Quick Links:
+
- `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
-- `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/1751>`_
-.. ==========================
-.. * * * EL ALTO * * *
-.. ==========================
+- `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
+
+El Alto
+=======
Version: 1.1.5
--------------
@@ -297,9 +298,12 @@ Version: 1.1.5
DMAAP code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The DMAAP open Critical security vulnerabilities and their risk assessment have been documented as part of the `Dublin <https://wiki.onap.org/pages/viewpage.action?pageId=64003715>`_.
Quick Links:
+
- `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
-- `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/1751>`_
-- `El Alto Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=71835817>`
+
+- `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
+
+- `El Alto Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=71835817>`_
**Upgrade Notes**
NA
@@ -327,8 +331,11 @@ Version: 1.1.5 (Dublin)
DMAAP code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The DMAAP open Critical security vulnerabilities and their risk assessment have been documented as part of the `Dublin <https://wiki.onap.org/pages/viewpage.action?pageId=64003715>`_.
Quick Links:
+
- `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
-- `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/1751>`_
+
+- `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
+
- `Dublin Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=64003715>`_
**Upgrade Notes**
@@ -356,8 +363,11 @@ Version: 1.0.23
DMAAP code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The DMAAP open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28379799>`_.
Quick Links:
+
- `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
-- `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/1751>`_
+
+- `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
+
- `Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=28379799>`_
**Upgrade Notes**
diff --git a/docs/security/security.rst b/docs/security.rst
index 47a1736..aab2c3d 100644
--- a/docs/security/security.rst
+++ b/docs/security.rst
@@ -13,7 +13,7 @@ Roles and Permissions
| The roles and permissions are being provisioned to AAF instance during DMaaP BC instance initialization phase only when AAF is in use.
| The default namespace in AAF for storing Bus Controller API roles and permissions is ``org.onap.dmaap-bc.api``.
| Separate permission is created for every HTTP method on each DMaaP BC REST api endpoint.
-| Refer to :doc:`DMaaP Bus Controller REST API<../../../../dmaap/dbcapi.git/docs/api>` for comprehensive api information.
+| Refer to :ref:`offeredapis` for comprehensive api information.
| Default name for DMaaP instance in ONAP is ``mr`` which is reflected in instance part of every created permission under DMaaP BC API.
| Exception of above rule is for ``/dmaap`` endpoint where additionally set of permissions for ``boot`` instance is defined: