From 956361f657eda468d5980249db6b155c472f5f85 Mon Sep 17 00:00:00 2001 From: dglFromAtt Date: Wed, 26 Dec 2018 17:56:34 -0500 Subject: [PATCH] Fix object references to show fields Change-Id: I4a81d70cfb5c94d162488c15e2d12662d5217cef Signed-off-by: dglFromAtt Issue-ID: DMAAP-892 --- docs/api.rst | 876 ++++++++++++++++----- .../dmaap/dbcapi/resources/BridgeResource.java | 5 +- .../dbcapi/resources/DcaeLocationResource.java | 15 +- .../onap/dmaap/dbcapi/resources/FeedResource.java | 17 +- .../dmaap/dbcapi/resources/MR_ClientResource.java | 11 +- .../dmaap/dbcapi/resources/MR_ClusterResource.java | 11 +- .../onap/dmaap/dbcapi/resources/TopicResource.java | 11 +- 7 files changed, 720 insertions(+), 226 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index 401cd63..5ba2eef 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -121,24 +121,17 @@ Responses Success -Type: :ref:`Dmaap ` +Type: :ref:`BrTopic ` **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", - "statusValid": true, - "topicNsRoot": "somestring", - "version": "somestring" + "brSource": "somestring", + "brTarget": "somestring", + "mmAgentName": "somestring", + "topicCount": 1 } **400** @@ -206,24 +199,17 @@ Responses Success -Type: :ref:`Dmaap ` +Type: :ref:`BrTopic ` **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", - "statusValid": true, - "topicNsRoot": "somestring", - "version": "somestring" + "brSource": "somestring", + "brTarget": "somestring", + "mmAgentName": "somestring", + "topicCount": 1 } **400** @@ -288,24 +274,23 @@ Responses Success -Type: :ref:`Dmaap ` +Type: :ref:`DcaeLocation ` **Example:** .. code-block:: javascript { - "accessKeyOwner": "somestring", - "bridgeAdminTopic": "somestring", - "dmaapName": "somestring", - "drProvUrl": "somestring", + "central": true, + "clli": "somestring", + "dcaeLayer": "somestring", + "dcaeLocationName": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", - "loggingUrl": "somestring", - "nodeKey": "somestring", + "local": true, + "openStackAvailabilityZone": "somestring", "status": "EMPTY", "statusValid": true, - "topicNsRoot": "somestring", - "version": "somestring" + "subnet": "somestring" } **400** @@ -371,24 +356,23 @@ Responses successful operation -Type: :ref:`Dmaap ` +Type: :ref:`DcaeLocation ` **Example:** .. code-block:: javascript { - "accessKeyOwner": "somestring", - "bridgeAdminTopic": "somestring", - "dmaapName": "somestring", - "drProvUrl": "somestring", + "central": true, + "clli": "somestring", + "dcaeLayer": "somestring", + "dcaeLocationName": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", - "loggingUrl": "somestring", - "nodeKey": "somestring", + "local": true, + "openStackAvailabilityZone": "somestring", "status": "EMPTY", "statusValid": true, - "topicNsRoot": "somestring", - "version": "somestring" + "subnet": "somestring" } **204** @@ -397,24 +381,23 @@ Type: :ref:`Dmaap ` Success -Type: :ref:`Dmaap ` +Type: :ref:`DcaeLocation ` **Example:** .. code-block:: javascript { - "accessKeyOwner": "somestring", - "bridgeAdminTopic": "somestring", - "dmaapName": "somestring", - "drProvUrl": "somestring", + "central": true, + "clli": "somestring", + "dcaeLayer": "somestring", + "dcaeLocationName": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", - "loggingUrl": "somestring", - "nodeKey": "somestring", + "local": true, + "openStackAvailabilityZone": "somestring", "status": "EMPTY", "statusValid": true, - "topicNsRoot": "somestring", - "version": "somestring" + "subnet": "somestring" } **400** @@ -480,24 +463,23 @@ Responses Success -Type: :ref:`Dmaap ` +Type: :ref:`DcaeLocation ` **Example:** .. code-block:: javascript { - "accessKeyOwner": "somestring", - "bridgeAdminTopic": "somestring", - "dmaapName": "somestring", - "drProvUrl": "somestring", + "central": true, + "clli": "somestring", + "dcaeLayer": "somestring", + "dcaeLocationName": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", - "loggingUrl": "somestring", - "nodeKey": "somestring", + "local": true, + "openStackAvailabilityZone": "somestring", "status": "EMPTY", "statusValid": true, - "topicNsRoot": "somestring", - "version": "somestring" + "subnet": "somestring" } **400** @@ -553,24 +535,23 @@ Responses Success -Type: :ref:`Dmaap ` +Type: :ref:`DcaeLocation ` **Example:** .. code-block:: javascript { - "accessKeyOwner": "somestring", - "bridgeAdminTopic": "somestring", - "dmaapName": "somestring", - "drProvUrl": "somestring", + "central": true, + "clli": "somestring", + "dcaeLayer": "somestring", + "dcaeLocationName": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", - "loggingUrl": "somestring", - "nodeKey": "somestring", + "local": true, + "openStackAvailabilityZone": "somestring", "status": "EMPTY", "statusValid": true, - "topicNsRoot": "somestring", - "version": "somestring" + "subnet": "somestring" } **400** @@ -636,24 +617,23 @@ Responses Success -Type: :ref:`Dmaap ` +Type: :ref:`DcaeLocation ` **Example:** .. code-block:: javascript { - "accessKeyOwner": "somestring", - "bridgeAdminTopic": "somestring", - "dmaapName": "somestring", - "drProvUrl": "somestring", + "central": true, + "clli": "somestring", + "dcaeLayer": "somestring", + "dcaeLocationName": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", - "loggingUrl": "somestring", - "nodeKey": "somestring", + "local": true, + "openStackAvailabilityZone": "somestring", "status": "EMPTY", "statusValid": true, - "topicNsRoot": "somestring", - "version": "somestring" + "subnet": "somestring" } **400** @@ -682,7 +662,7 @@ DMAAP ~~~~~ -V2 Endpoint for this instance of DMaaP object containing values for this OpenDCAE deployment +Endpoint for this instance of DMaaP object containing values for this OpenDCAE deployment @@ -2427,21 +2407,93 @@ Responses Success -Type: :ref:`DR_Pub ` +Type: :ref:`Feed ` **Example:** .. code-block:: javascript { - "dcaeLocationName": "somestring", + "asprClassification": "somestring", + "bytes": [ + "somestring", + "somestring" + ], + "feedDescription": "somestring", "feedId": "somestring", + "feedName": "somestring", + "feedVersion": "somestring", + "formatUuid": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", - "pubId": "somestring", + "logURL": "somestring", + "owner": "somestring", + "publishURL": "somestring", + "pubs": [ + { + "dcaeLocationName": "somestring", + "feedId": "somestring", + "lastMod": "2015-01-01T15:00:00.000Z", + "pubId": "somestring", + "status": "EMPTY", + "statusValid": true, + "username": "somestring", + "userpwd": "somestring" + }, + { + "dcaeLocationName": "somestring", + "feedId": "somestring", + "lastMod": "2015-01-01T15:00:00.000Z", + "pubId": "somestring", + "status": "EMPTY", + "statusValid": true, + "username": "somestring", + "userpwd": "somestring" + } + ], "status": "EMPTY", "statusValid": true, - "username": "somestring", - "userpwd": "somestring" + "subs": [ + { + "bytes": [ + "somestring", + "somestring" + ], + "dcaeLocationName": "somestring", + "deliveryURL": "somestring", + "feedId": "somestring", + "lastMod": "2015-01-01T15:00:00.000Z", + "logURL": "somestring", + "owner": "somestring", + "status": "EMPTY", + "statusValid": true, + "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", + "statusValid": true, + "subId": "somestring", + "suspended": true, + "use100": true, + "username": "somestring", + "userpwd": "somestring" + } + ], + "subscribeURL": "somestring", + "suspended": true } **400** @@ -2602,21 +2654,93 @@ Type: :ref:`Feed ` Success -Type: :ref:`DR_Pub ` +Type: :ref:`Feed ` **Example:** .. code-block:: javascript { - "dcaeLocationName": "somestring", + "asprClassification": "somestring", + "bytes": [ + "somestring", + "somestring" + ], + "feedDescription": "somestring", "feedId": "somestring", + "feedName": "somestring", + "feedVersion": "somestring", + "formatUuid": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", - "pubId": "somestring", + "logURL": "somestring", + "owner": "somestring", + "publishURL": "somestring", + "pubs": [ + { + "dcaeLocationName": "somestring", + "feedId": "somestring", + "lastMod": "2015-01-01T15:00:00.000Z", + "pubId": "somestring", + "status": "EMPTY", + "statusValid": true, + "username": "somestring", + "userpwd": "somestring" + }, + { + "dcaeLocationName": "somestring", + "feedId": "somestring", + "lastMod": "2015-01-01T15:00:00.000Z", + "pubId": "somestring", + "status": "EMPTY", + "statusValid": true, + "username": "somestring", + "userpwd": "somestring" + } + ], "status": "EMPTY", "statusValid": true, - "username": "somestring", - "userpwd": "somestring" + "subs": [ + { + "bytes": [ + "somestring", + "somestring" + ], + "dcaeLocationName": "somestring", + "deliveryURL": "somestring", + "feedId": "somestring", + "lastMod": "2015-01-01T15:00:00.000Z", + "logURL": "somestring", + "owner": "somestring", + "status": "EMPTY", + "statusValid": true, + "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", + "statusValid": true, + "subId": "somestring", + "suspended": true, + "use100": true, + "username": "somestring", + "userpwd": "somestring" + } + ], + "subscribeURL": "somestring", + "suspended": true } **400** @@ -2764,21 +2888,93 @@ Responses Success -Type: :ref:`DR_Pub ` +Type: :ref:`Feed ` **Example:** .. code-block:: javascript { - "dcaeLocationName": "somestring", - "feedId": "somestring", - "lastMod": "2015-01-01T15:00:00.000Z", - "pubId": "somestring", - "status": "EMPTY", - "statusValid": true, - "username": "somestring", - "userpwd": "somestring" + "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", + "statusValid": true, + "username": "somestring", + "userpwd": "somestring" + }, + { + "dcaeLocationName": "somestring", + "feedId": "somestring", + "lastMod": "2015-01-01T15:00:00.000Z", + "pubId": "somestring", + "status": "EMPTY", + "statusValid": true, + "username": "somestring", + "userpwd": "somestring" + } + ], + "status": "EMPTY", + "statusValid": true, + "subs": [ + { + "bytes": [ + "somestring", + "somestring" + ], + "dcaeLocationName": "somestring", + "deliveryURL": "somestring", + "feedId": "somestring", + "lastMod": "2015-01-01T15:00:00.000Z", + "logURL": "somestring", + "owner": "somestring", + "status": "EMPTY", + "statusValid": true, + "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", + "statusValid": true, + "subId": "somestring", + "suspended": true, + "use100": true, + "username": "somestring", + "userpwd": "somestring" + } + ], + "subscribeURL": "somestring", + "suspended": true } **400** @@ -2844,21 +3040,93 @@ Responses Success -Type: :ref:`DR_Pub ` +Type: :ref:`Feed ` **Example:** .. code-block:: javascript { - "dcaeLocationName": "somestring", + "asprClassification": "somestring", + "bytes": [ + "somestring", + "somestring" + ], + "feedDescription": "somestring", "feedId": "somestring", + "feedName": "somestring", + "feedVersion": "somestring", + "formatUuid": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", - "pubId": "somestring", + "logURL": "somestring", + "owner": "somestring", + "publishURL": "somestring", + "pubs": [ + { + "dcaeLocationName": "somestring", + "feedId": "somestring", + "lastMod": "2015-01-01T15:00:00.000Z", + "pubId": "somestring", + "status": "EMPTY", + "statusValid": true, + "username": "somestring", + "userpwd": "somestring" + }, + { + "dcaeLocationName": "somestring", + "feedId": "somestring", + "lastMod": "2015-01-01T15:00:00.000Z", + "pubId": "somestring", + "status": "EMPTY", + "statusValid": true, + "username": "somestring", + "userpwd": "somestring" + } + ], "status": "EMPTY", "statusValid": true, - "username": "somestring", - "userpwd": "somestring" + "subs": [ + { + "bytes": [ + "somestring", + "somestring" + ], + "dcaeLocationName": "somestring", + "deliveryURL": "somestring", + "feedId": "somestring", + "lastMod": "2015-01-01T15:00:00.000Z", + "logURL": "somestring", + "owner": "somestring", + "status": "EMPTY", + "statusValid": true, + "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", + "statusValid": true, + "subId": "somestring", + "suspended": true, + "use100": true, + "username": "somestring", + "userpwd": "somestring" + } + ], + "subscribeURL": "somestring", + "suspended": true } **400** @@ -3005,21 +3273,25 @@ Responses Success -Type: :ref:`DR_Pub ` +Type: :ref:`MR_Client ` **Example:** .. code-block:: javascript { + "action": [ + "somestring", + "somestring" + ], + "clientRole": "somestring", "dcaeLocationName": "somestring", - "feedId": "somestring", + "fqtn": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", - "pubId": "somestring", + "mrClientId": "somestring", "status": "EMPTY", "statusValid": true, - "username": "somestring", - "userpwd": "somestring" + "topicURL": "somestring" } **400** @@ -3112,21 +3384,25 @@ Type: :ref:`MR_Client ` Success -Type: :ref:`DR_Pub ` +Type: :ref:`MR_Client ` **Example:** .. code-block:: javascript { + "action": [ + "somestring", + "somestring" + ], + "clientRole": "somestring", "dcaeLocationName": "somestring", - "feedId": "somestring", + "fqtn": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", - "pubId": "somestring", + "mrClientId": "somestring", "status": "EMPTY", "statusValid": true, - "username": "somestring", - "userpwd": "somestring" + "topicURL": "somestring" } **400** @@ -3182,21 +3458,25 @@ Responses Success -Type: :ref:`DR_Pub ` +Type: :ref:`MR_Client ` **Example:** .. code-block:: javascript { + "action": [ + "somestring", + "somestring" + ], + "clientRole": "somestring", "dcaeLocationName": "somestring", - "feedId": "somestring", + "fqtn": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", - "pubId": "somestring", + "mrClientId": "somestring", "status": "EMPTY", "statusValid": true, - "username": "somestring", - "userpwd": "somestring" + "topicURL": "somestring" } **400** @@ -3262,21 +3542,25 @@ Responses Success -Type: :ref:`DR_Pub ` +Type: :ref:`MR_Client ` **Example:** .. code-block:: javascript { + "action": [ + "somestring", + "somestring" + ], + "clientRole": "somestring", "dcaeLocationName": "somestring", - "feedId": "somestring", + "fqtn": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", - "pubId": "somestring", + "mrClientId": "somestring", "status": "EMPTY", "statusValid": true, - "username": "somestring", - "userpwd": "somestring" + "topicURL": "somestring" } **400** @@ -3342,21 +3626,25 @@ Responses Success -Type: :ref:`DR_Pub ` +Type: :ref:`MR_Client ` **Example:** .. code-block:: javascript { + "action": [ + "somestring", + "somestring" + ], + "clientRole": "somestring", "dcaeLocationName": "somestring", - "feedId": "somestring", + "fqtn": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", - "pubId": "somestring", + "mrClientId": "somestring", "status": "EMPTY", "statusValid": true, - "username": "somestring", - "userpwd": "somestring" + "topicURL": "somestring" } **400** @@ -3421,7 +3709,7 @@ Responses Success -Type: :ref:`DR_Pub ` +Type: :ref:`MR_Cluster ` **Example:** @@ -3429,13 +3717,15 @@ Type: :ref:`DR_Pub ` { "dcaeLocationName": "somestring", - "feedId": "somestring", + "fqdn": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", - "pubId": "somestring", + "replicationGroup": "somestring", + "sourceReplicationPort": "somestring", "status": "EMPTY", "statusValid": true, - "username": "somestring", - "userpwd": "somestring" + "targetReplicationPort": "somestring", + "topicPort": "somestring", + "topicProtocol": "somestring" } **400** @@ -3526,7 +3816,7 @@ Type: :ref:`MR_Cluster ` Success -Type: :ref:`DR_Pub ` +Type: :ref:`MR_Cluster ` **Example:** @@ -3534,14 +3824,16 @@ Type: :ref:`DR_Pub ` { "dcaeLocationName": "somestring", - "feedId": "somestring", + "fqdn": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", - "pubId": "somestring", + "replicationGroup": "somestring", + "sourceReplicationPort": "somestring", "status": "EMPTY", "statusValid": true, - "username": "somestring", - "userpwd": "somestring" - } + "targetReplicationPort": "somestring", + "topicPort": "somestring", + "topicProtocol": "somestring" + } **400** ^^^^^^^ @@ -3606,7 +3898,7 @@ Responses Success -Type: :ref:`DR_Pub ` +Type: :ref:`MR_Cluster ` **Example:** @@ -3614,13 +3906,15 @@ Type: :ref:`DR_Pub ` { "dcaeLocationName": "somestring", - "feedId": "somestring", + "fqdn": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", - "pubId": "somestring", + "replicationGroup": "somestring", + "sourceReplicationPort": "somestring", "status": "EMPTY", "statusValid": true, - "username": "somestring", - "userpwd": "somestring" + "targetReplicationPort": "somestring", + "topicPort": "somestring", + "topicProtocol": "somestring" } **400** @@ -3676,7 +3970,7 @@ Responses Success -Type: :ref:`DR_Pub ` +Type: :ref:`MR_Cluster ` **Example:** @@ -3684,13 +3978,15 @@ Type: :ref:`DR_Pub ` { "dcaeLocationName": "somestring", - "feedId": "somestring", + "fqdn": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", - "pubId": "somestring", + "replicationGroup": "somestring", + "sourceReplicationPort": "somestring", "status": "EMPTY", "statusValid": true, - "username": "somestring", - "userpwd": "somestring" + "targetReplicationPort": "somestring", + "topicPort": "somestring", + "topicProtocol": "somestring" } **400** @@ -3756,7 +4052,7 @@ Responses Success -Type: :ref:`DR_Pub ` +Type: :ref:`MR_Cluster ` **Example:** @@ -3764,13 +4060,15 @@ Type: :ref:`DR_Pub ` { "dcaeLocationName": "somestring", - "feedId": "somestring", + "fqdn": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", - "pubId": "somestring", + "replicationGroup": "somestring", + "sourceReplicationPort": "somestring", "status": "EMPTY", "statusValid": true, - "username": "somestring", - "userpwd": "somestring" + "targetReplicationPort": "somestring", + "topicPort": "somestring", + "topicProtocol": "somestring" } **400** @@ -3845,21 +4143,63 @@ Responses Success -Type: :ref:`DR_Pub ` +Type: :ref:`Topic ` **Example:** .. code-block:: javascript { - "dcaeLocationName": "somestring", - "feedId": "somestring", + "bytes": [ + "somestring", + "somestring" + ], + "clients": [ + { + "action": [ + "somestring", + "somestring" + ], + "clientRole": "somestring", + "dcaeLocationName": "somestring", + "fqtn": "somestring", + "lastMod": "2015-01-01T15:00:00.000Z", + "mrClientId": "somestring", + "status": "EMPTY", + "statusValid": true, + "topicURL": "somestring" + }, + { + "action": [ + "somestring", + "somestring" + ], + "clientRole": "somestring", + "dcaeLocationName": "somestring", + "fqtn": "somestring", + "lastMod": "2015-01-01T15:00:00.000Z", + "mrClientId": "somestring", + "status": "EMPTY", + "statusValid": true, + "topicURL": "somestring" + } + ], + "formatUuid": "somestring", + "fqtn": "somestring", + "fqtnStyle": "FQTN_NOT_SPECIFIED", + "globalMrURL": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", - "pubId": "somestring", + "numClients": 1, + "owner": "somestring", + "partitionCount": "somestring", + "replicationCase": "REPLICATION_NOT_SPECIFIED", + "replicationCount": "somestring", "status": "EMPTY", "statusValid": true, - "username": "somestring", - "userpwd": "somestring" + "tnxEnabled": "somestring", + "topicDescription": "somestring", + "topicName": "somestring", + "version": "somestring" } **400** @@ -3990,21 +4330,63 @@ Type: :ref:`Topic ` Success -Type: :ref:`DR_Pub ` +Type: :ref:`Topic ` **Example:** .. code-block:: javascript { - "dcaeLocationName": "somestring", - "feedId": "somestring", + "bytes": [ + "somestring", + "somestring" + ], + "clients": [ + { + "action": [ + "somestring", + "somestring" + ], + "clientRole": "somestring", + "dcaeLocationName": "somestring", + "fqtn": "somestring", + "lastMod": "2015-01-01T15:00:00.000Z", + "mrClientId": "somestring", + "status": "EMPTY", + "statusValid": true, + "topicURL": "somestring" + }, + { + "action": [ + "somestring", + "somestring" + ], + "clientRole": "somestring", + "dcaeLocationName": "somestring", + "fqtn": "somestring", + "lastMod": "2015-01-01T15:00:00.000Z", + "mrClientId": "somestring", + "status": "EMPTY", + "statusValid": true, + "topicURL": "somestring" + } + ], + "formatUuid": "somestring", + "fqtn": "somestring", + "fqtnStyle": "FQTN_NOT_SPECIFIED", + "globalMrURL": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", - "pubId": "somestring", + "numClients": 1, + "owner": "somestring", + "partitionCount": "somestring", + "replicationCase": "REPLICATION_NOT_SPECIFIED", + "replicationCount": "somestring", "status": "EMPTY", "statusValid": true, - "username": "somestring", - "userpwd": "somestring" + "tnxEnabled": "somestring", + "topicDescription": "somestring", + "topicName": "somestring", + "version": "somestring" } **400** @@ -4070,21 +4452,63 @@ Responses Success -Type: :ref:`DR_Pub ` +Type: :ref:`Topic ` **Example:** .. code-block:: javascript { - "dcaeLocationName": "somestring", - "feedId": "somestring", + "bytes": [ + "somestring", + "somestring" + ], + "clients": [ + { + "action": [ + "somestring", + "somestring" + ], + "clientRole": "somestring", + "dcaeLocationName": "somestring", + "fqtn": "somestring", + "lastMod": "2015-01-01T15:00:00.000Z", + "mrClientId": "somestring", + "status": "EMPTY", + "statusValid": true, + "topicURL": "somestring" + }, + { + "action": [ + "somestring", + "somestring" + ], + "clientRole": "somestring", + "dcaeLocationName": "somestring", + "fqtn": "somestring", + "lastMod": "2015-01-01T15:00:00.000Z", + "mrClientId": "somestring", + "status": "EMPTY", + "statusValid": true, + "topicURL": "somestring" + } + ], + "formatUuid": "somestring", + "fqtn": "somestring", + "fqtnStyle": "FQTN_NOT_SPECIFIED", + "globalMrURL": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", - "pubId": "somestring", + "numClients": 1, + "owner": "somestring", + "partitionCount": "somestring", + "replicationCase": "REPLICATION_NOT_SPECIFIED", + "replicationCount": "somestring", "status": "EMPTY", "statusValid": true, - "username": "somestring", - "userpwd": "somestring" + "tnxEnabled": "somestring", + "topicDescription": "somestring", + "topicName": "somestring", + "version": "somestring" } **400** @@ -4140,21 +4564,63 @@ Responses Success -Type: :ref:`DR_Pub ` +Type: :ref:`Topic ` **Example:** .. code-block:: javascript { - "dcaeLocationName": "somestring", - "feedId": "somestring", + "bytes": [ + "somestring", + "somestring" + ], + "clients": [ + { + "action": [ + "somestring", + "somestring" + ], + "clientRole": "somestring", + "dcaeLocationName": "somestring", + "fqtn": "somestring", + "lastMod": "2015-01-01T15:00:00.000Z", + "mrClientId": "somestring", + "status": "EMPTY", + "statusValid": true, + "topicURL": "somestring" + }, + { + "action": [ + "somestring", + "somestring" + ], + "clientRole": "somestring", + "dcaeLocationName": "somestring", + "fqtn": "somestring", + "lastMod": "2015-01-01T15:00:00.000Z", + "mrClientId": "somestring", + "status": "EMPTY", + "statusValid": true, + "topicURL": "somestring" + } + ], + "formatUuid": "somestring", + "fqtn": "somestring", + "fqtnStyle": "FQTN_NOT_SPECIFIED", + "globalMrURL": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", - "pubId": "somestring", + "numClients": 1, + "owner": "somestring", + "partitionCount": "somestring", + "replicationCase": "REPLICATION_NOT_SPECIFIED", + "replicationCount": "somestring", "status": "EMPTY", "statusValid": true, - "username": "somestring", - "userpwd": "somestring" + "tnxEnabled": "somestring", + "topicDescription": "somestring", + "topicName": "somestring", + "version": "somestring" } **400** @@ -4220,21 +4686,63 @@ Responses Success -Type: :ref:`DR_Pub ` +Type: :ref:`Topic ` **Example:** .. code-block:: javascript { - "dcaeLocationName": "somestring", - "feedId": "somestring", + "bytes": [ + "somestring", + "somestring" + ], + "clients": [ + { + "action": [ + "somestring", + "somestring" + ], + "clientRole": "somestring", + "dcaeLocationName": "somestring", + "fqtn": "somestring", + "lastMod": "2015-01-01T15:00:00.000Z", + "mrClientId": "somestring", + "status": "EMPTY", + "statusValid": true, + "topicURL": "somestring" + }, + { + "action": [ + "somestring", + "somestring" + ], + "clientRole": "somestring", + "dcaeLocationName": "somestring", + "fqtn": "somestring", + "lastMod": "2015-01-01T15:00:00.000Z", + "mrClientId": "somestring", + "status": "EMPTY", + "statusValid": true, + "topicURL": "somestring" + } + ], + "formatUuid": "somestring", + "fqtn": "somestring", + "fqtnStyle": "FQTN_NOT_SPECIFIED", + "globalMrURL": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", - "pubId": "somestring", + "numClients": 1, + "owner": "somestring", + "partitionCount": "somestring", + "replicationCase": "REPLICATION_NOT_SPECIFIED", + "replicationCount": "somestring", "status": "EMPTY", "statusValid": true, - "username": "somestring", - "userpwd": "somestring" + "tnxEnabled": "somestring", + "topicDescription": "somestring", + "topicName": "somestring", + "version": "somestring" } **400** diff --git a/src/main/java/org/onap/dmaap/dbcapi/resources/BridgeResource.java b/src/main/java/org/onap/dmaap/dbcapi/resources/BridgeResource.java index f1466ee..e6fede7 100644 --- a/src/main/java/org/onap/dmaap/dbcapi/resources/BridgeResource.java +++ b/src/main/java/org/onap/dmaap/dbcapi/resources/BridgeResource.java @@ -35,7 +35,6 @@ import javax.ws.rs.core.Response.Status; import org.onap.dmaap.dbcapi.logging.BaseLoggingClass; import org.onap.dmaap.dbcapi.model.ApiError; import org.onap.dmaap.dbcapi.model.BrTopic; -import org.onap.dmaap.dbcapi.model.Dmaap; import org.onap.dmaap.dbcapi.model.MirrorMaker; import org.onap.dmaap.dbcapi.service.ApiService; import org.onap.dmaap.dbcapi.service.MirrorMakerService; @@ -60,7 +59,7 @@ public class BridgeResource extends BaseLoggingClass { + "If detail param is true, list topics names, else just a count is returned.", response = BrTopic.class) @ApiResponses( value = { - @ApiResponse( code = 200, message = "Success", response = Dmaap.class), + @ApiResponse( code = 200, message = "Success", response = BrTopic.class), @ApiResponse( code = 400, message = "Error", response = ApiError.class ) }) public Response getBridgedTopics(@QueryParam("mmagent") String mmagent, @@ -148,7 +147,7 @@ public class BridgeResource extends BaseLoggingClass { + "If split param is true, spread whitelist over smaller mmagents.", response = MirrorMaker.class) @ApiResponses( value = { - @ApiResponse( code = 200, message = "Success", response = Dmaap.class), + @ApiResponse( code = 200, message = "Success", response = BrTopic.class), @ApiResponse( code = 400, message = "Error", response = ApiError.class ) }) public Response putBridgedTopics(@QueryParam("mmagent") String mmagent, diff --git a/src/main/java/org/onap/dmaap/dbcapi/resources/DcaeLocationResource.java b/src/main/java/org/onap/dmaap/dbcapi/resources/DcaeLocationResource.java index 25e6f3a..8cb5336 100644 --- a/src/main/java/org/onap/dmaap/dbcapi/resources/DcaeLocationResource.java +++ b/src/main/java/org/onap/dmaap/dbcapi/resources/DcaeLocationResource.java @@ -45,7 +45,6 @@ import org.apache.log4j.Logger; import org.onap.dmaap.dbcapi.logging.BaseLoggingClass; import org.onap.dmaap.dbcapi.model.ApiError; import org.onap.dmaap.dbcapi.model.DcaeLocation; -import org.onap.dmaap.dbcapi.model.Dmaap; import org.onap.dmaap.dbcapi.service.ApiService; import org.onap.dmaap.dbcapi.service.DcaeLocationService; @@ -64,7 +63,7 @@ public class DcaeLocationResource extends BaseLoggingClass { notes = "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).", response = DcaeLocation.class) @ApiResponses( value = { - @ApiResponse( code = 200, message = "Success", response = Dmaap.class), + @ApiResponse( code = 200, message = "Success", response = DcaeLocation.class), @ApiResponse( code = 400, message = "Error", response = ApiError.class ) }) public Response getDcaeLocations() { @@ -82,7 +81,7 @@ public class DcaeLocationResource extends BaseLoggingClass { notes = "Create some `dcaeLocation` which is a unique identifier for an *OpenStack* tenant purposed for a *dcaeLayer* (ecomp or edge).", response = DcaeLocation.class) @ApiResponses( value = { - @ApiResponse( code = 200, message = "Success", response = Dmaap.class), + @ApiResponse( code = 200, message = "Success", response = DcaeLocation.class), @ApiResponse( code = 400, message = "Error", response = ApiError.class ) }) public Response addDcaeLocation( @@ -108,7 +107,7 @@ public class DcaeLocationResource extends BaseLoggingClass { notes = "update the openStackAvailabilityZone of a dcaeLocation", response = DcaeLocation.class) @ApiResponses( value = { - @ApiResponse( code = 200, message = "Success", response = Dmaap.class), + @ApiResponse( code = 200, message = "Success", response = DcaeLocation.class), @ApiResponse( code = 400, message = "Error", response = ApiError.class ) }) @Path("/{locationName}") @@ -135,9 +134,9 @@ public class DcaeLocationResource extends BaseLoggingClass { } @DELETE - @ApiOperation( value = "return dcaeLocation details", notes = "delete a dcaeLocation", response = Dmaap.class) + @ApiOperation( value = "return dcaeLocation details", notes = "delete a dcaeLocation", response = DcaeLocation.class) @ApiResponses( value = { - @ApiResponse( code = 204, message = "Success", response = Dmaap.class), + @ApiResponse( code = 204, message = "Success", response = DcaeLocation.class), @ApiResponse( code = 400, message = "Error", response = ApiError.class ) }) @Path("/{locationName}") @@ -151,9 +150,9 @@ public class DcaeLocationResource extends BaseLoggingClass { } @GET - @ApiOperation( value = "return dcaeLocation details", notes = "Returns a specific `dcaeLocation` object with specified tag", response = Dmaap.class) + @ApiOperation( value = "return dcaeLocation details", notes = "Returns a specific `dcaeLocation` object with specified tag", response = DcaeLocation.class) @ApiResponses( value = { - @ApiResponse( code = 200, message = "Success", response = Dmaap.class), + @ApiResponse( code = 200, message = "Success", response = DcaeLocation.class), @ApiResponse( code = 400, message = "Error", response = ApiError.class ) }) @Path("/{locationName}") diff --git a/src/main/java/org/onap/dmaap/dbcapi/resources/FeedResource.java b/src/main/java/org/onap/dmaap/dbcapi/resources/FeedResource.java index 97336c1..a7b4f73 100644 --- a/src/main/java/org/onap/dmaap/dbcapi/resources/FeedResource.java +++ b/src/main/java/org/onap/dmaap/dbcapi/resources/FeedResource.java @@ -31,29 +31,20 @@ import javax.jws.WebParam; import javax.ws.rs.Consumes; import javax.ws.rs.DELETE; import javax.ws.rs.GET; -import javax.ws.rs.HeaderParam; import javax.ws.rs.POST; import javax.ws.rs.PUT; import javax.ws.rs.Path; import javax.ws.rs.PathParam; import javax.ws.rs.Produces; import javax.ws.rs.QueryParam; -import javax.ws.rs.core.Context; import javax.ws.rs.core.GenericEntity; import javax.ws.rs.core.MediaType; import javax.ws.rs.core.Response; import javax.ws.rs.core.Response.Status; -import javax.ws.rs.core.UriInfo; - -import org.apache.log4j.Logger; -import org.onap.dmaap.dbcapi.authentication.AuthenticationErrorException; import org.onap.dmaap.dbcapi.logging.BaseLoggingClass; -import org.onap.dmaap.dbcapi.logging.DmaapbcLogMessageEnum; import org.onap.dmaap.dbcapi.model.ApiError; import org.onap.dmaap.dbcapi.model.DR_Pub; -import org.onap.dmaap.dbcapi.model.DR_Sub; import org.onap.dmaap.dbcapi.model.Feed; -import org.onap.dmaap.dbcapi.model.Topic; import org.onap.dmaap.dbcapi.model.DmaapObject.DmaapObject_Status; import org.onap.dmaap.dbcapi.service.ApiService; import org.onap.dmaap.dbcapi.service.FeedService; @@ -71,7 +62,7 @@ public class FeedResource extends BaseLoggingClass { notes = "Returns array of `Feed` objects.", response = Feed.class) @ApiResponses( value = { - @ApiResponse( code = 200, message = "Success", response = DR_Pub.class), + @ApiResponse( code = 200, message = "Success", response = Feed.class), @ApiResponse( code = 400, message = "Error", response = ApiError.class ) }) public Response getFeeds( @@ -96,7 +87,7 @@ public class FeedResource extends BaseLoggingClass { notes = "Create a of `Feed` object.", response = Feed.class) @ApiResponses( value = { - @ApiResponse( code = 200, message = "Success", response = DR_Pub.class), + @ApiResponse( code = 200, message = "Success", response = Feed.class), @ApiResponse( code = 400, message = "Error", response = ApiError.class ) }) public Response addFeed( @@ -151,7 +142,7 @@ public class FeedResource extends BaseLoggingClass { notes = "Update a `Feed` object, specified by id.", response = Feed.class) @ApiResponses( value = { - @ApiResponse( code = 200, message = "Success", response = DR_Pub.class), + @ApiResponse( code = 200, message = "Success", response = Feed.class), @ApiResponse( code = 400, message = "Error", response = ApiError.class ) }) @Path("/{id}") @@ -196,7 +187,7 @@ public class FeedResource extends BaseLoggingClass { notes = "Delete a `Feed` object, specified by id.", response = Feed.class) @ApiResponses( value = { - @ApiResponse( code = 204, message = "Success", response = DR_Pub.class), + @ApiResponse( code = 204, message = "Success", response = Feed.class), @ApiResponse( code = 400, message = "Error", response = ApiError.class ) }) @Path("/{id}") diff --git a/src/main/java/org/onap/dmaap/dbcapi/resources/MR_ClientResource.java b/src/main/java/org/onap/dmaap/dbcapi/resources/MR_ClientResource.java index 8f6a506..1ca4a53 100644 --- a/src/main/java/org/onap/dmaap/dbcapi/resources/MR_ClientResource.java +++ b/src/main/java/org/onap/dmaap/dbcapi/resources/MR_ClientResource.java @@ -42,7 +42,6 @@ import javax.ws.rs.core.Response.Status; import org.onap.dmaap.dbcapi.logging.BaseLoggingClass; import org.onap.dmaap.dbcapi.model.ApiError; -import org.onap.dmaap.dbcapi.model.DR_Pub; import org.onap.dmaap.dbcapi.model.MR_Client; import org.onap.dmaap.dbcapi.model.MR_Cluster; import org.onap.dmaap.dbcapi.model.Topic; @@ -66,7 +65,7 @@ public class MR_ClientResource extends BaseLoggingClass { notes = "Returns array of `MR_Client` objects.", response = MR_Client.class) @ApiResponses( value = { - @ApiResponse( code = 200, message = "Success", response = DR_Pub.class), + @ApiResponse( code = 200, message = "Success", response = MR_Client.class), @ApiResponse( code = 400, message = "Error", response = ApiError.class ) }) public Response getMr_Clients() { @@ -84,7 +83,7 @@ public class MR_ClientResource extends BaseLoggingClass { notes = "Create a `MR_Client` object.", response = MR_Client.class) @ApiResponses( value = { - @ApiResponse( code = 200, message = "Success", response = DR_Pub.class), + @ApiResponse( code = 200, message = "Success", response = MR_Client.class), @ApiResponse( code = 400, message = "Error", response = ApiError.class ) }) public Response addMr_Client( @@ -144,7 +143,7 @@ public class MR_ClientResource extends BaseLoggingClass { notes = "Update a `MR_Client` object, specified by clientId", response = MR_Client.class) @ApiResponses( value = { - @ApiResponse( code = 200, message = "Success", response = DR_Pub.class), + @ApiResponse( code = 200, message = "Success", response = MR_Client.class), @ApiResponse( code = 400, message = "Error", response = ApiError.class ) }) @Path("/{clientId}") @@ -180,7 +179,7 @@ public class MR_ClientResource extends BaseLoggingClass { notes = "Delete a `MR_Client` object, specified by clientId", response = MR_Client.class) @ApiResponses( value = { - @ApiResponse( code = 204, message = "Success", response = DR_Pub.class), + @ApiResponse( code = 204, message = "Success", response = MR_Client.class), @ApiResponse( code = 400, message = "Error", response = ApiError.class ) }) @Path("/{subId}") @@ -208,7 +207,7 @@ public class MR_ClientResource extends BaseLoggingClass { notes = "Retrieve a `MR_Client` object, specified by clientId", response = MR_Client.class) @ApiResponses( value = { - @ApiResponse( code = 200, message = "Success", response = DR_Pub.class), + @ApiResponse( code = 200, message = "Success", response = MR_Client.class), @ApiResponse( code = 400, message = "Error", response = ApiError.class ) }) @Path("/{subId}") diff --git a/src/main/java/org/onap/dmaap/dbcapi/resources/MR_ClusterResource.java b/src/main/java/org/onap/dmaap/dbcapi/resources/MR_ClusterResource.java index 41aaead..50ab4db 100644 --- a/src/main/java/org/onap/dmaap/dbcapi/resources/MR_ClusterResource.java +++ b/src/main/java/org/onap/dmaap/dbcapi/resources/MR_ClusterResource.java @@ -42,7 +42,6 @@ import javax.ws.rs.core.Response.Status; import org.onap.dmaap.dbcapi.logging.BaseLoggingClass; import org.onap.dmaap.dbcapi.model.ApiError; -import org.onap.dmaap.dbcapi.model.DR_Pub; import org.onap.dmaap.dbcapi.model.MR_Cluster; import org.onap.dmaap.dbcapi.service.ApiService; import org.onap.dmaap.dbcapi.service.MR_ClientService; @@ -64,7 +63,7 @@ public class MR_ClusterResource extends BaseLoggingClass { notes = "Returns array of `MR_Cluster` objects.", response = MR_Cluster.class) @ApiResponses( value = { - @ApiResponse( code = 200, message = "Success", response = DR_Pub.class), + @ApiResponse( code = 200, message = "Success", response = MR_Cluster.class), @ApiResponse( code = 400, message = "Error", response = ApiError.class ) }) public Response getMr_Clusters() { @@ -82,7 +81,7 @@ public class MR_ClusterResource extends BaseLoggingClass { notes = "Create an `MR_Cluster` object.", response = MR_Cluster.class) @ApiResponses( value = { - @ApiResponse( code = 200, message = "Success", response = DR_Pub.class), + @ApiResponse( code = 200, message = "Success", response = MR_Cluster.class), @ApiResponse( code = 400, message = "Error", response = ApiError.class ) }) public Response addMr_Cluster( @@ -109,7 +108,7 @@ public class MR_ClusterResource extends BaseLoggingClass { notes = "Update an `MR_Cluster` object, specified by clusterId.", response = MR_Cluster.class) @ApiResponses( value = { - @ApiResponse( code = 200, message = "Success", response = DR_Pub.class), + @ApiResponse( code = 200, message = "Success", response = MR_Cluster.class), @ApiResponse( code = 400, message = "Error", response = ApiError.class ) }) @Path("/{clusterId}") @@ -138,7 +137,7 @@ public class MR_ClusterResource extends BaseLoggingClass { notes = "Delete an `MR_Cluster` object, specified by clusterId.", response = MR_Cluster.class) @ApiResponses( value = { - @ApiResponse( code = 204, message = "Success", response = DR_Pub.class), + @ApiResponse( code = 204, message = "Success", response = MR_Cluster.class), @ApiResponse( code = 400, message = "Error", response = ApiError.class ) }) @Path("/{clusterId}") @@ -164,7 +163,7 @@ public class MR_ClusterResource extends BaseLoggingClass { notes = "Retrieve an `MR_Cluster` object, specified by clusterId.", response = MR_Cluster.class) @ApiResponses( value = { - @ApiResponse( code = 200, message = "Success", response = DR_Pub.class), + @ApiResponse( code = 200, message = "Success", response = MR_Cluster.class), @ApiResponse( code = 400, message = "Error", response = ApiError.class ) }) @Path("/{clusterId}") diff --git a/src/main/java/org/onap/dmaap/dbcapi/resources/TopicResource.java b/src/main/java/org/onap/dmaap/dbcapi/resources/TopicResource.java index dbeea63..5f027aa 100644 --- a/src/main/java/org/onap/dmaap/dbcapi/resources/TopicResource.java +++ b/src/main/java/org/onap/dmaap/dbcapi/resources/TopicResource.java @@ -43,7 +43,6 @@ import javax.ws.rs.core.Response.Status; import org.onap.dmaap.dbcapi.logging.BaseLoggingClass; import org.onap.dmaap.dbcapi.model.ApiError; -import org.onap.dmaap.dbcapi.model.DR_Pub; import org.onap.dmaap.dbcapi.model.ReplicationType; import org.onap.dmaap.dbcapi.model.FqtnType; import org.onap.dmaap.dbcapi.model.Topic; @@ -76,7 +75,7 @@ public class TopicResource extends BaseLoggingClass { notes = "Returns array of `Topic` objects.", response = Topic.class) @ApiResponses( value = { - @ApiResponse( code = 200, message = "Success", response = DR_Pub.class), + @ApiResponse( code = 200, message = "Success", response = Topic.class), @ApiResponse( code = 400, message = "Error", response = ApiError.class ) }) public Response getTopics() { @@ -96,7 +95,7 @@ public class TopicResource extends BaseLoggingClass { notes = "Create `Topic` object.", response = Topic.class) @ApiResponses( value = { - @ApiResponse( code = 200, message = "Success", response = DR_Pub.class), + @ApiResponse( code = 200, message = "Success", response = Topic.class), @ApiResponse( code = 400, message = "Error", response = ApiError.class ) }) public Response addTopic( @@ -150,7 +149,7 @@ public class TopicResource extends BaseLoggingClass { notes = "Update a `Topic` object, identified by topicId", response = Topic.class) @ApiResponses( value = { - @ApiResponse( code = 200, message = "Success", response = DR_Pub.class), + @ApiResponse( code = 200, message = "Success", response = Topic.class), @ApiResponse( code = 400, message = "Error", response = ApiError.class ) }) @Path("/{topicId}") @@ -170,7 +169,7 @@ public class TopicResource extends BaseLoggingClass { notes = "Delete a `Topic` object, identified by topicId", response = Topic.class) @ApiResponses( value = { - @ApiResponse( code = 204, message = "Success", response = DR_Pub.class), + @ApiResponse( code = 204, message = "Success", response = Topic.class), @ApiResponse( code = 400, message = "Error", response = ApiError.class ) }) @Path("/{topicId}") @@ -199,7 +198,7 @@ public class TopicResource extends BaseLoggingClass { notes = "Retrieve a `Topic` object, identified by topicId", response = Topic.class) @ApiResponses( value = { - @ApiResponse( code = 200, message = "Success", response = DR_Pub.class), + @ApiResponse( code = 200, message = "Success", response = Topic.class), @ApiResponse( code = 400, message = "Error", response = ApiError.class ) }) @Path("/{topicId}") -- 2.16.6