X-Git-Url: https://gerrit.onap.org/r/gitweb?p=dmaap%2Fdbcapi.git;a=blobdiff_plain;f=docs%2Fapi.rst;h=624727da22a294ee0c7f72bc14f646c836036aa9;hp=5ba2eefbb29b1446167558b6cfc936f495785ca4;hb=HEAD;hpb=956361f657eda468d5980249db6b155c472f5f85 diff --git a/docs/api.rst b/docs/api.rst index 5ba2eef..624727d 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,5 +1,6 @@ DMaaP Bus Controller REST API 1.1.0 =================================== +.. _offeredapis: .. toctree:: :maxdepth: 3 @@ -289,7 +290,6 @@ Type: :ref:`DcaeLocation ` "local": true, "openStackAvailabilityZone": "somestring", "status": "EMPTY", - "statusValid": true, "subnet": "somestring" } @@ -371,7 +371,6 @@ Type: :ref:`DcaeLocation ` "local": true, "openStackAvailabilityZone": "somestring", "status": "EMPTY", - "statusValid": true, "subnet": "somestring" } @@ -396,7 +395,6 @@ Type: :ref:`DcaeLocation ` "local": true, "openStackAvailabilityZone": "somestring", "status": "EMPTY", - "statusValid": true, "subnet": "somestring" } @@ -478,7 +476,6 @@ Type: :ref:`DcaeLocation ` "local": true, "openStackAvailabilityZone": "somestring", "status": "EMPTY", - "statusValid": true, "subnet": "somestring" } @@ -550,7 +547,6 @@ Type: :ref:`DcaeLocation ` "local": true, "openStackAvailabilityZone": "somestring", "status": "EMPTY", - "statusValid": true, "subnet": "somestring" } @@ -632,7 +628,6 @@ Type: :ref:`DcaeLocation ` "local": true, "openStackAvailabilityZone": "somestring", "status": "EMPTY", - "statusValid": true, "subnet": "somestring" } @@ -662,7 +657,7 @@ DMAAP ~~~~~ -Endpoint for this instance of DMaaP object containing values for this OpenDCAE deployment +V2 Endpoint for this instance of DMaaP object containing values for this OpenDCAE deployment @@ -713,7 +708,6 @@ Type: :ref:`Dmaap ` "loggingUrl": "somestring", "nodeKey": "somestring", "status": "EMPTY", - "statusValid": true, "topicNsRoot": "somestring", "version": "somestring" } @@ -786,7 +780,6 @@ Type: :ref:`Dmaap ` "loggingUrl": "somestring", "nodeKey": "somestring", "status": "EMPTY", - "statusValid": true, "topicNsRoot": "somestring", "version": "somestring" } @@ -859,7 +852,6 @@ Type: :ref:`Dmaap ` "loggingUrl": "somestring", "nodeKey": "somestring", "status": "EMPTY", - "statusValid": true, "topicNsRoot": "somestring", "version": "somestring" } @@ -932,7 +924,6 @@ Type: :ref:`Dmaap ` "loggingUrl": "somestring", "nodeKey": "somestring", "status": "EMPTY", - "statusValid": true, "topicNsRoot": "somestring", "version": "somestring" } @@ -1005,7 +996,6 @@ Type: :ref:`Dmaap ` "loggingUrl": "somestring", "nodeKey": "somestring", "status": "EMPTY", - "statusValid": true, "topicNsRoot": "somestring", "version": "somestring" } @@ -1078,7 +1068,6 @@ Type: :ref:`Dmaap ` "loggingUrl": "somestring", "nodeKey": "somestring", "status": "EMPTY", - "statusValid": true, "topicNsRoot": "somestring", "version": "somestring" } @@ -1157,7 +1146,6 @@ Type: :ref:`DR_Node ` "hostName": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", "status": "EMPTY", - "statusValid": true, "version": "somestring" } @@ -1236,7 +1224,6 @@ Type: :ref:`DR_Node ` "hostName": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", "status": "EMPTY", - "statusValid": true, "version": "somestring" } @@ -1258,7 +1245,6 @@ Type: :ref:`DR_Node ` "hostName": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", "status": "EMPTY", - "statusValid": true, "version": "somestring" } @@ -1337,7 +1323,6 @@ Type: :ref:`DR_Node ` "hostName": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", "status": "EMPTY", - "statusValid": true, "version": "somestring" } @@ -1406,7 +1391,6 @@ Type: :ref:`DR_Node ` "hostName": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", "status": "EMPTY", - "statusValid": true, "version": "somestring" } @@ -1485,7 +1469,6 @@ Type: :ref:`DR_Node ` "hostName": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", "status": "EMPTY", - "statusValid": true, "version": "somestring" } @@ -1563,7 +1546,6 @@ Type: :ref:`DR_Pub ` "lastMod": "2015-01-01T15:00:00.000Z", "pubId": "somestring", "status": "EMPTY", - "statusValid": true, "username": "somestring", "userpwd": "somestring" } @@ -1643,7 +1625,6 @@ Type: :ref:`DR_Pub ` "lastMod": "2015-01-01T15:00:00.000Z", "pubId": "somestring", "status": "EMPTY", - "statusValid": true, "username": "somestring", "userpwd": "somestring" } @@ -1666,7 +1647,6 @@ Type: :ref:`DR_Pub ` "lastMod": "2015-01-01T15:00:00.000Z", "pubId": "somestring", "status": "EMPTY", - "statusValid": true, "username": "somestring", "userpwd": "somestring" } @@ -1746,7 +1726,6 @@ Type: :ref:`DR_Pub ` "lastMod": "2015-01-01T15:00:00.000Z", "pubId": "somestring", "status": "EMPTY", - "statusValid": true, "username": "somestring", "userpwd": "somestring" } @@ -1816,7 +1795,6 @@ Type: :ref:`DR_Pub ` "lastMod": "2015-01-01T15:00:00.000Z", "pubId": "somestring", "status": "EMPTY", - "statusValid": true, "username": "somestring", "userpwd": "somestring" } @@ -1896,7 +1874,6 @@ Type: :ref:`DR_Pub ` "lastMod": "2015-01-01T15:00:00.000Z", "pubId": "somestring", "status": "EMPTY", - "statusValid": true, "username": "somestring", "userpwd": "somestring" } @@ -1981,7 +1958,6 @@ Type: :ref:`DR_Sub ` "logURL": "somestring", "owner": "somestring", "status": "EMPTY", - "statusValid": true, "subId": "somestring", "suspended": true, "use100": true, @@ -2070,7 +2046,6 @@ Type: :ref:`DR_Sub ` "logURL": "somestring", "owner": "somestring", "status": "EMPTY", - "statusValid": true, "subId": "somestring", "suspended": true, "use100": true, @@ -2159,7 +2134,6 @@ Type: :ref:`DR_Sub ` "logURL": "somestring", "owner": "somestring", "status": "EMPTY", - "statusValid": true, "subId": "somestring", "suspended": true, "use100": true, @@ -2238,7 +2212,6 @@ Type: :ref:`DR_Sub ` "logURL": "somestring", "owner": "somestring", "status": "EMPTY", - "statusValid": true, "subId": "somestring", "suspended": true, "use100": true, @@ -2327,7 +2300,6 @@ Type: :ref:`DR_Sub ` "logURL": "somestring", "owner": "somestring", "status": "EMPTY", - "statusValid": true, "subId": "somestring", "suspended": true, "use100": true, @@ -2435,7 +2407,6 @@ Type: :ref:`Feed ` "lastMod": "2015-01-01T15:00:00.000Z", "pubId": "somestring", "status": "EMPTY", - "statusValid": true, "username": "somestring", "userpwd": "somestring" }, @@ -2445,13 +2416,11 @@ Type: :ref:`Feed ` "lastMod": "2015-01-01T15:00:00.000Z", "pubId": "somestring", "status": "EMPTY", - "statusValid": true, "username": "somestring", "userpwd": "somestring" } ], "status": "EMPTY", - "statusValid": true, "subs": [ { "bytes": [ @@ -2465,7 +2434,6 @@ Type: :ref:`Feed ` "logURL": "somestring", "owner": "somestring", "status": "EMPTY", - "statusValid": true, "subId": "somestring", "suspended": true, "use100": true, @@ -2484,7 +2452,6 @@ Type: :ref:`Feed ` "logURL": "somestring", "owner": "somestring", "status": "EMPTY", - "statusValid": true, "subId": "somestring", "suspended": true, "use100": true, @@ -2587,7 +2554,6 @@ Type: :ref:`Feed ` "lastMod": "2015-01-01T15:00:00.000Z", "pubId": "somestring", "status": "EMPTY", - "statusValid": true, "username": "somestring", "userpwd": "somestring" }, @@ -2597,13 +2563,11 @@ Type: :ref:`Feed ` "lastMod": "2015-01-01T15:00:00.000Z", "pubId": "somestring", "status": "EMPTY", - "statusValid": true, "username": "somestring", "userpwd": "somestring" } ], "status": "EMPTY", - "statusValid": true, "subs": [ { "bytes": [ @@ -2617,7 +2581,6 @@ Type: :ref:`Feed ` "logURL": "somestring", "owner": "somestring", "status": "EMPTY", - "statusValid": true, "subId": "somestring", "suspended": true, "use100": true, @@ -2636,7 +2599,6 @@ Type: :ref:`Feed ` "logURL": "somestring", "owner": "somestring", "status": "EMPTY", - "statusValid": true, "subId": "somestring", "suspended": true, "use100": true, @@ -2682,7 +2644,6 @@ Type: :ref:`Feed ` "lastMod": "2015-01-01T15:00:00.000Z", "pubId": "somestring", "status": "EMPTY", - "statusValid": true, "username": "somestring", "userpwd": "somestring" }, @@ -2692,13 +2653,11 @@ Type: :ref:`Feed ` "lastMod": "2015-01-01T15:00:00.000Z", "pubId": "somestring", "status": "EMPTY", - "statusValid": true, "username": "somestring", "userpwd": "somestring" } ], "status": "EMPTY", - "statusValid": true, "subs": [ { "bytes": [ @@ -2712,7 +2671,6 @@ Type: :ref:`Feed ` "logURL": "somestring", "owner": "somestring", "status": "EMPTY", - "statusValid": true, "subId": "somestring", "suspended": true, "use100": true, @@ -2731,7 +2689,6 @@ Type: :ref:`Feed ` "logURL": "somestring", "owner": "somestring", "status": "EMPTY", - "statusValid": true, "subId": "somestring", "suspended": true, "use100": true, @@ -2818,7 +2775,6 @@ Type: :ref:`DR_Pub ` "lastMod": "2015-01-01T15:00:00.000Z", "pubId": "somestring", "status": "EMPTY", - "statusValid": true, "username": "somestring", "userpwd": "somestring" } @@ -2916,7 +2872,6 @@ Type: :ref:`Feed ` "lastMod": "2015-01-01T15:00:00.000Z", "pubId": "somestring", "status": "EMPTY", - "statusValid": true, "username": "somestring", "userpwd": "somestring" }, @@ -2926,13 +2881,11 @@ Type: :ref:`Feed ` "lastMod": "2015-01-01T15:00:00.000Z", "pubId": "somestring", "status": "EMPTY", - "statusValid": true, "username": "somestring", "userpwd": "somestring" } ], "status": "EMPTY", - "statusValid": true, "subs": [ { "bytes": [ @@ -2946,7 +2899,6 @@ Type: :ref:`Feed ` "logURL": "somestring", "owner": "somestring", "status": "EMPTY", - "statusValid": true, "subId": "somestring", "suspended": true, "use100": true, @@ -2965,7 +2917,6 @@ Type: :ref:`Feed ` "logURL": "somestring", "owner": "somestring", "status": "EMPTY", - "statusValid": true, "subId": "somestring", "suspended": true, "use100": true, @@ -3068,7 +3019,6 @@ Type: :ref:`Feed ` "lastMod": "2015-01-01T15:00:00.000Z", "pubId": "somestring", "status": "EMPTY", - "statusValid": true, "username": "somestring", "userpwd": "somestring" }, @@ -3078,13 +3028,11 @@ Type: :ref:`Feed ` "lastMod": "2015-01-01T15:00:00.000Z", "pubId": "somestring", "status": "EMPTY", - "statusValid": true, "username": "somestring", "userpwd": "somestring" } ], "status": "EMPTY", - "statusValid": true, "subs": [ { "bytes": [ @@ -3098,7 +3046,6 @@ Type: :ref:`Feed ` "logURL": "somestring", "owner": "somestring", "status": "EMPTY", - "statusValid": true, "subId": "somestring", "suspended": true, "use100": true, @@ -3117,7 +3064,6 @@ Type: :ref:`Feed ` "logURL": "somestring", "owner": "somestring", "status": "EMPTY", - "statusValid": true, "subId": "somestring", "suspended": true, "use100": true, @@ -3206,7 +3152,6 @@ Type: :ref:`Dmaap ` "loggingUrl": "somestring", "nodeKey": "somestring", "status": "EMPTY", - "statusValid": true, "topicNsRoot": "somestring", "version": "somestring" } @@ -3250,14 +3195,14 @@ POST ``/mr_clients`` Summary +++++++ -return MR_Client details +Associate an MR_Client object to a Topic Description +++++++++++ .. raw:: html - Create a `MR_Client` object. + 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 @@ -3284,13 +3229,13 @@ Type: :ref:`MR_Client ` "somestring", "somestring" ], + "clientIdentity": "somestring", "clientRole": "somestring", "dcaeLocationName": "somestring", "fqtn": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", "mrClientId": "somestring", "status": "EMPTY", - "statusValid": true, "topicURL": "somestring" } @@ -3324,7 +3269,7 @@ DELETE ``/mr_clients/{subId}`` Summary +++++++ -return MR_Client details +Delete an MR_Client object Description +++++++++++ @@ -3368,13 +3313,13 @@ Type: :ref:`MR_Client ` "somestring", "somestring" ], + "clientIdentity": "somestring", "clientRole": "somestring", "dcaeLocationName": "somestring", "fqtn": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", "mrClientId": "somestring", "status": "EMPTY", - "statusValid": true, "topicURL": "somestring" } @@ -3395,13 +3340,13 @@ Type: :ref:`MR_Client ` "somestring", "somestring" ], + "clientIdentity": "somestring", "clientRole": "somestring", "dcaeLocationName": "somestring", "fqtn": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", "mrClientId": "somestring", "status": "EMPTY", - "statusValid": true, "topicURL": "somestring" } @@ -3469,13 +3414,13 @@ Type: :ref:`MR_Client ` "somestring", "somestring" ], + "clientIdentity": "somestring", "clientRole": "somestring", "dcaeLocationName": "somestring", "fqtn": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", "mrClientId": "somestring", "status": "EMPTY", - "statusValid": true, "topicURL": "somestring" } @@ -3553,13 +3498,13 @@ Type: :ref:`MR_Client ` "somestring", "somestring" ], + "clientIdentity": "somestring", "clientRole": "somestring", "dcaeLocationName": "somestring", "fqtn": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", "mrClientId": "somestring", "status": "EMPTY", - "statusValid": true, "topicURL": "somestring" } @@ -3593,7 +3538,7 @@ PUT ``/mr_clients/{clientId}`` Summary +++++++ -return MR_Client details +Update an MR_Client object Description +++++++++++ @@ -3637,13 +3582,13 @@ Type: :ref:`MR_Client ` "somestring", "somestring" ], + "clientIdentity": "somestring", "clientRole": "somestring", "dcaeLocationName": "somestring", "fqtn": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", "mrClientId": "somestring", "status": "EMPTY", - "statusValid": true, "topicURL": "somestring" } @@ -3722,7 +3667,6 @@ Type: :ref:`MR_Cluster ` "replicationGroup": "somestring", "sourceReplicationPort": "somestring", "status": "EMPTY", - "statusValid": true, "targetReplicationPort": "somestring", "topicPort": "somestring", "topicProtocol": "somestring" @@ -3804,7 +3748,6 @@ Type: :ref:`MR_Cluster ` "replicationGroup": "somestring", "sourceReplicationPort": "somestring", "status": "EMPTY", - "statusValid": true, "targetReplicationPort": "somestring", "topicPort": "somestring", "topicProtocol": "somestring" @@ -3829,7 +3772,6 @@ Type: :ref:`MR_Cluster ` "replicationGroup": "somestring", "sourceReplicationPort": "somestring", "status": "EMPTY", - "statusValid": true, "targetReplicationPort": "somestring", "topicPort": "somestring", "topicProtocol": "somestring" @@ -3911,7 +3853,6 @@ Type: :ref:`MR_Cluster ` "replicationGroup": "somestring", "sourceReplicationPort": "somestring", "status": "EMPTY", - "statusValid": true, "targetReplicationPort": "somestring", "topicPort": "somestring", "topicProtocol": "somestring" @@ -3983,7 +3924,6 @@ Type: :ref:`MR_Cluster ` "replicationGroup": "somestring", "sourceReplicationPort": "somestring", "status": "EMPTY", - "statusValid": true, "targetReplicationPort": "somestring", "topicPort": "somestring", "topicProtocol": "somestring" @@ -4065,7 +4005,6 @@ Type: :ref:`MR_Cluster ` "replicationGroup": "somestring", "sourceReplicationPort": "somestring", "status": "EMPTY", - "statusValid": true, "targetReplicationPort": "somestring", "topicPort": "somestring", "topicProtocol": "somestring" @@ -4110,14 +4049,14 @@ POST ``/topics`` Summary +++++++ -return Topic details +Create a Topic object Description +++++++++++ .. raw:: html - Create `Topic` object. + 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 ++++++++++ @@ -4150,23 +4089,19 @@ Type: :ref:`Topic ` .. code-block:: javascript { - "bytes": [ - "somestring", - "somestring" - ], "clients": [ { "action": [ "somestring", "somestring" ], + "clientIdentity": "somestring", "clientRole": "somestring", "dcaeLocationName": "somestring", "fqtn": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", "mrClientId": "somestring", "status": "EMPTY", - "statusValid": true, "topicURL": "somestring" }, { @@ -4174,13 +4109,13 @@ Type: :ref:`Topic ` "somestring", "somestring" ], + "clientIdentity": "somestring", "clientRole": "somestring", "dcaeLocationName": "somestring", "fqtn": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", "mrClientId": "somestring", "status": "EMPTY", - "statusValid": true, "topicURL": "somestring" } ], @@ -4189,13 +4124,13 @@ Type: :ref:`Topic ` "fqtnStyle": "FQTN_NOT_SPECIFIED", "globalMrURL": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", - "numClients": 1, "owner": "somestring", "partitionCount": "somestring", + "publisherRole": "somestring", "replicationCase": "REPLICATION_NOT_SPECIFIED", "replicationCount": "somestring", "status": "EMPTY", - "statusValid": true, + "subscriberRole": "somestring", "tnxEnabled": "somestring", "topicDescription": "somestring", "topicName": "somestring", @@ -4272,23 +4207,19 @@ Type: :ref:`Topic ` .. code-block:: javascript { - "bytes": [ - "somestring", - "somestring" - ], "clients": [ { "action": [ "somestring", "somestring" ], + "clientIdentity": "somestring", "clientRole": "somestring", "dcaeLocationName": "somestring", "fqtn": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", "mrClientId": "somestring", "status": "EMPTY", - "statusValid": true, "topicURL": "somestring" }, { @@ -4296,13 +4227,13 @@ Type: :ref:`Topic ` "somestring", "somestring" ], + "clientIdentity": "somestring", "clientRole": "somestring", "dcaeLocationName": "somestring", "fqtn": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", "mrClientId": "somestring", "status": "EMPTY", - "statusValid": true, "topicURL": "somestring" } ], @@ -4311,13 +4242,13 @@ Type: :ref:`Topic ` "fqtnStyle": "FQTN_NOT_SPECIFIED", "globalMrURL": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", - "numClients": 1, "owner": "somestring", "partitionCount": "somestring", + "publisherRole": "somestring", "replicationCase": "REPLICATION_NOT_SPECIFIED", "replicationCount": "somestring", "status": "EMPTY", - "statusValid": true, + "subscriberRole": "somestring", "tnxEnabled": "somestring", "topicDescription": "somestring", "topicName": "somestring", @@ -4337,23 +4268,19 @@ Type: :ref:`Topic ` .. code-block:: javascript { - "bytes": [ - "somestring", - "somestring" - ], "clients": [ { "action": [ "somestring", "somestring" ], + "clientIdentity": "somestring", "clientRole": "somestring", "dcaeLocationName": "somestring", "fqtn": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", "mrClientId": "somestring", "status": "EMPTY", - "statusValid": true, "topicURL": "somestring" }, { @@ -4361,13 +4288,13 @@ Type: :ref:`Topic ` "somestring", "somestring" ], + "clientIdentity": "somestring", "clientRole": "somestring", "dcaeLocationName": "somestring", "fqtn": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", "mrClientId": "somestring", "status": "EMPTY", - "statusValid": true, "topicURL": "somestring" } ], @@ -4376,13 +4303,13 @@ Type: :ref:`Topic ` "fqtnStyle": "FQTN_NOT_SPECIFIED", "globalMrURL": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", - "numClients": 1, "owner": "somestring", "partitionCount": "somestring", + "publisherRole": "somestring", "replicationCase": "REPLICATION_NOT_SPECIFIED", "replicationCount": "somestring", "status": "EMPTY", - "statusValid": true, + "subscriberRole": "somestring", "tnxEnabled": "somestring", "topicDescription": "somestring", "topicName": "somestring", @@ -4459,23 +4386,19 @@ Type: :ref:`Topic ` .. code-block:: javascript { - "bytes": [ - "somestring", - "somestring" - ], "clients": [ { "action": [ "somestring", "somestring" ], + "clientIdentity": "somestring", "clientRole": "somestring", "dcaeLocationName": "somestring", "fqtn": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", "mrClientId": "somestring", "status": "EMPTY", - "statusValid": true, "topicURL": "somestring" }, { @@ -4483,13 +4406,13 @@ Type: :ref:`Topic ` "somestring", "somestring" ], + "clientIdentity": "somestring", "clientRole": "somestring", "dcaeLocationName": "somestring", "fqtn": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", "mrClientId": "somestring", "status": "EMPTY", - "statusValid": true, "topicURL": "somestring" } ], @@ -4498,13 +4421,13 @@ Type: :ref:`Topic ` "fqtnStyle": "FQTN_NOT_SPECIFIED", "globalMrURL": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", - "numClients": 1, "owner": "somestring", "partitionCount": "somestring", + "publisherRole": "somestring", "replicationCase": "REPLICATION_NOT_SPECIFIED", "replicationCount": "somestring", "status": "EMPTY", - "statusValid": true, + "subscriberRole": "somestring", "tnxEnabled": "somestring", "topicDescription": "somestring", "topicName": "somestring", @@ -4571,23 +4494,19 @@ Type: :ref:`Topic ` .. code-block:: javascript { - "bytes": [ - "somestring", - "somestring" - ], "clients": [ { "action": [ "somestring", "somestring" ], + "clientIdentity": "somestring", "clientRole": "somestring", "dcaeLocationName": "somestring", "fqtn": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", "mrClientId": "somestring", "status": "EMPTY", - "statusValid": true, "topicURL": "somestring" }, { @@ -4595,13 +4514,13 @@ Type: :ref:`Topic ` "somestring", "somestring" ], + "clientIdentity": "somestring", "clientRole": "somestring", "dcaeLocationName": "somestring", "fqtn": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", "mrClientId": "somestring", "status": "EMPTY", - "statusValid": true, "topicURL": "somestring" } ], @@ -4610,13 +4529,13 @@ Type: :ref:`Topic ` "fqtnStyle": "FQTN_NOT_SPECIFIED", "globalMrURL": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", - "numClients": 1, "owner": "somestring", "partitionCount": "somestring", + "publisherRole": "somestring", "replicationCase": "REPLICATION_NOT_SPECIFIED", "replicationCount": "somestring", "status": "EMPTY", - "statusValid": true, + "subscriberRole": "somestring", "tnxEnabled": "somestring", "topicDescription": "somestring", "topicName": "somestring", @@ -4693,23 +4612,19 @@ Type: :ref:`Topic ` .. code-block:: javascript { - "bytes": [ - "somestring", - "somestring" - ], "clients": [ { "action": [ "somestring", "somestring" ], + "clientIdentity": "somestring", "clientRole": "somestring", "dcaeLocationName": "somestring", "fqtn": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", "mrClientId": "somestring", "status": "EMPTY", - "statusValid": true, "topicURL": "somestring" }, { @@ -4717,13 +4632,13 @@ Type: :ref:`Topic ` "somestring", "somestring" ], + "clientIdentity": "somestring", "clientRole": "somestring", "dcaeLocationName": "somestring", "fqtn": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", "mrClientId": "somestring", "status": "EMPTY", - "statusValid": true, "topicURL": "somestring" } ], @@ -4732,13 +4647,13 @@ Type: :ref:`Topic ` "fqtnStyle": "FQTN_NOT_SPECIFIED", "globalMrURL": "somestring", "lastMod": "2015-01-01T15:00:00.000Z", - "numClients": 1, "owner": "somestring", "partitionCount": "somestring", + "publisherRole": "somestring", "replicationCase": "REPLICATION_NOT_SPECIFIED", "replicationCount": "somestring", "status": "EMPTY", - "statusValid": true, + "subscriberRole": "somestring", "tnxEnabled": "somestring", "topicDescription": "somestring", "topicName": "somestring", @@ -4813,9 +4728,8 @@ DR_Node Model Structure dcaeLocationName | No | string | | | fqdn | No | string | | | hostName | No | string | | | - lastMod | No | string | date-time | | + lastMod | No | string | date-time | | datestamp for last update to this object status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} | - statusValid | No | boolean | | | version | No | string | | | .. _d_e926d3fa8701e0cc9c8ed1761b3255cd: @@ -4830,10 +4744,9 @@ DR_Pub Model Structure dcaeLocationName | No | string | | | feedId | No | string | | | - lastMod | No | string | date-time | | + 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']} | - statusValid | No | boolean | | | username | No | string | | | userpwd | No | string | | | @@ -4851,11 +4764,10 @@ DR_Sub Model Structure dcaeLocationName | No | string | | | deliveryURL | No | string | | | feedId | No | string | | | - lastMod | No | string | date-time | | + 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']} | - statusValid | No | boolean | | | subId | No | string | | | suspended | No | boolean | | | use100 | No | boolean | | | @@ -4876,11 +4788,10 @@ DcaeLocation Model Structure clli | No | string | | | dcaeLayer | No | string | | | dcaeLocationName | No | string | | | - lastMod | No | string | date-time | | + 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']} | - statusValid | No | boolean | | | subnet | No | string | | | .. _d_4ea0e7758a1f8502222793e4a13b04f7: @@ -4897,11 +4808,10 @@ Dmaap Model Structure bridgeAdminTopic | No | string | | | dmaapName | No | string | | | drProvUrl | No | string | | | - lastMod | No | string | date-time | | + 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']} | - statusValid | No | boolean | | | topicNsRoot | No | string | | | version | No | string | | | @@ -4922,13 +4832,12 @@ Feed Model Structure feedName | No | string | | | feedVersion | No | string | | | formatUuid | No | string | | | - lastMod | No | string | date-time | | + 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 ` | | | status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} | - statusValid | No | boolean | | | subs | No | array of :ref:`DR_Sub ` | | | subscribeURL | No | string | | | suspended | No | boolean | | | @@ -4943,15 +4852,15 @@ MR_Client Model Structure :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - action | No | array of string | | | - clientRole | No | string | | | - dcaeLocationName | No | string | | | - fqtn | No | string | | | - lastMod | No | string | date-time | | - mrClientId | No | string | | | + 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']} | - statusValid | No | boolean | | | - topicURL | No | string | | | + 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: @@ -4969,7 +4878,6 @@ MR_Cluster Model Structure replicationGroup | No | string | | | sourceReplicationPort | No | string | | | status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} | - statusValid | No | boolean | | | targetReplicationPort | No | string | | | topicPort | No | string | | | topicProtocol | No | string | | | @@ -4984,11 +4892,10 @@ MirrorMaker Model Structure :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - lastMod | No | string | date-time | | + 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']} | - statusValid | No | boolean | | | targetCluster | No | string | | | topicCount | No | integer | int32 | | topics | No | array of string | | | @@ -5004,22 +4911,21 @@ Topic Model Structure :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - bytes | No | array of string | | | - clients | No | array of :ref:`MR_Client ` | | | - formatUuid | No | string | | | - fqtn | No | string | | | - fqtnStyle | No | string | | {'enum': ['FQTN_NOT_SPECIFIED', 'FQTN_LEGACY_FORMAT', 'FQTN_PROJECTID_FORMAT', 'FQTN_PROJECTID_VERSION_FORMAT']} | - globalMrURL | No | string | | | - lastMod | No | string | date-time | | - numClients | No | integer | int32 | | - owner | No | string | | | - partitionCount | No | string | | | - 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']} | - replicationCount | No | string | | | + clients | No | array of :ref:`MR_Client ` | | | 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']} | - statusValid | No | boolean | | | + subscriberRole | No | string | | | a value generated by dbcapi, this AAF Role has permission to subscribe to this `Topic` tnxEnabled | No | string | | | - topicDescription | No | string | | | - topicName | No | string | | | - version | 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