\r
The HTTP Body contains the feed content when creating a feed.\r
\r
-**HTTP Authorization**\r
-\r
-The user-id:password pair:\r
-\r
-* If AAF enabled: A valid AAF AppId to be authenticated and authorized by the AAF CADI framework.\r
-* If Non AAF : When publishing or retracting a file, a valid `EID Object`_ with publish permissions.\r
\r
Create a Feed\r
-------------\r
\r
**Request Parameters:**\r
\r
-+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
-| Field | Description | Param Type | Data Type | MaxLen | Set By | Updatable? | Required | Valid/Example Values |\r
-+======================+================================+============+==================+========+========+============+==========+===============================+\r
-| name | Feed name | Body | String | <=20 | Client | N | Y | |\r
-+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
-| version | Feed version | Body | String | <=20 | Client | N | Y | v1.0.0 |\r
-+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
-| description | Feed description | Body | String | <=256 | Client | Y | N | |\r
-+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
-| business description | Business description | Body | String | <=256 | Client | Y | N | |\r
-+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
-| authorization | Information for authorizing | Body |`Auth Object`_ | | Client | Y | Y | |\r
-| | publishing requests | | | | | | | |\r
-+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
-| suspend | Set to true if the feed is in | Body | Boolean | | Client | Y | N | * true |\r
-| | the suspended state | | | | | | | * false (default) |\r
-+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
-| group-id | Auth group for feed management | Body | Integer | | Client | Y | N | 0 (default) |\r
-+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
-| aaf_instance | The instance passed to aaf | Body | String | <=256 | Client | N | N | legacy (default) |\r
-| | during permission checks | | | | | | | |\r
-+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
-| Content-Type | To specify type of message | Header | String | | Client | N | Y | application/vnd.dmaap-dr.feed |\r
-+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
-| publisher | Publisher identity as passed | Header | String | <=8 | DR | N | Y | username |\r
-| | in X-DMAAP-DR-ON-BEHALF-OF at | | | | | | | |\r
-| | creation time | | | | | | | |\r
-+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
-| Authorization | The user / AppId to be | Header | String | | Client | N | Y if AAF | dcae@dcae.onap.org:{password} |\r
-| | authorized by the AAF CADI | | | | | | enabled | |\r
-| | framework | | | | | | | |\r
-+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
-| X-EXCLUDE-AAF | To determine if the feed to | Header | Boolean | | Client | N | Y if AAF | * true (for legacy feed) |\r
-| | create is legacy or AAF | | | | | | enabled | * false (for AAF feed) |\r
-+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
-| Links | URLs related to this feed | Body |`Feed Links Obj`_ | | DR | N | N | |\r
-+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
++-------------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
+| Field | Description | Param Type | Data Type | MaxLen | Set By | Updatable? | Required | Valid/Example Values |\r
++=========================+================================+============+==================+========+========+============+==========+===============================+\r
+| name | Feed name | Body | String | <=20 | Client | N | Y | |\r
++-------------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
+| version | Feed version | Body | String | <=20 | Client | N | Y | v1.0.0 |\r
++-------------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
+| description | Feed description | Body | String | <=256 | Client | Y | N | |\r
++-------------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
+| business description | Business description | Body | String | <=256 | Client | Y | N | |\r
++-------------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
+| authorization | Information for authorizing | Body |`Auth Object`_ | | Client | Y | Y | |\r
+| | publishing requests | | | | | | | |\r
++-------------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
+| suspend | Set to true if the feed is in | Body | Boolean | | Client | Y | N | * true |\r
+| | the suspended state | | | | | | | * false (default) |\r
++-------------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
+| group-id | Auth group for feed management | Body | Integer | | Client | Y | N | 0 (default) |\r
++-------------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
+| Content-Type | To specify type of message | Header | String | | Client | N | Y | application/vnd.dmaap-dr.feed |\r
++-------------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
+| Authorization | The user / AppId to be | Header | String | | Client | N | Y | Basic <credentials> |\r
+| | authorized | | | | | | | |\r
++-------------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
+| X-DMAAP-DR-ON-BEHALF-OF | Publisher identity as passed | Header | String | <=8 | DR | N | Y | username |\r
+| | in X-DMAAP-DR-ON-BEHALF-OF at | | | | | | | |\r
+| | creation time | | | | | | | |\r
++-------------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+\r
+\r
\r
**Response Codes**\r
\r
{\r
"password": "dradmin",\r
"id": "dradmin"\r
- },\r
- {\r
- "password": "demo123456!",\r
- "id": "onap"\r
}\r
]\r
},\r
"name": "ONAP Data Feed",\r
"business_description": "",\r
- "aaf_instance": "legacy",\r
- "publisher": "dradmin",\r
+ "publisher": "{user}",\r
"links": {\r
"subscribe": "https://dmaap-dr-prov/subscribe/1",\r
"log": "https://dmaap-dr-prov/feedlog/1",\r
\r
**Request Parameters:**\r
\r
-+------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
-| Field | Description | Param Type | Data Type | MaxLen | Required |\r
-+========================+=================================+=============+===============+============+=============+\r
-| name | Feed name | Body | String | <=20 | Y |\r
-+------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
-| description | Feed description | Body | String | <=256 | N |\r
-+------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
-| business description | Business description | Body | String | <=256 | N |\r
-+------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
-| authorization | Information for authorizing | Body |`Auth Object`_ | | Y |\r
-| | publishing requests | | | | |\r
-+------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
-| suspend | Set to true if the feed is in | Body | Boolean | | N |\r
-| | the suspended state | | | | |\r
-+------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
-| group-id | Auth group for feed management | Body | Integer | | N |\r
-| | | | | | |\r
-+------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
-| Content-type | To specify type of message | Header | String | | Y |\r
-| | (feed,subscriber,publisher) | | | | |\r
-+------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
-| publisher | Publisher identity as passed | Header | String | <=8 | Y |\r
-| | in X-DMAAP-DR-ON-BEHALF-OF at | | | | |\r
-| | creation time | | | | |\r
-+------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
-| Authorization | The user / AppId to be | Header | String | | Y if AAF |\r
-| | authorized by the AAF CADI | | | | enabled |\r
-| | framework | | | | |\r
-+------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+| Field | Description | Param Type | Data Type | MaxLen | Required |\r
++=========================+=================================+=============+===============+============+=============+\r
+| name | Feed name | Body | String | <=20 | Y |\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+| description | Feed description | Body | String | <=256 | N |\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+| business description | Business description | Body | String | <=256 | N |\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+| authorization | Information for authorizing | Body |`Auth Object`_ | | Y |\r
+| | publishing requests | | | | |\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+| suspend | Set to true if the feed is in | Body | Boolean | | N |\r
+| | the suspended state | | | | |\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+| group-id | Auth group for feed management | Body | Integer | | N |\r
+| | | | | | |\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+| Content-type | To specify type of message | Header | String | | Y |\r
+| | (feed,subscriber,publisher) | | | | |\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+| Authorization | The user / AppId to be | Header | String | | Y |\r
+| | authorized | | | | |\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+| X-DMAAP-DR-ON-BEHALF-OF | Publisher identity as passed | Header | String | <=8 | Y |\r
+| | in X-DMAAP-DR-ON-BEHALF-OF at | | | | |\r
+| | creation time | | | | |\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
\r
**Response Codes**\r
\r
},\r
"name": "ONAP Data Feed1",\r
"business_description": "Updated ONAP Feed",\r
- "aaf_instance": "legacy",\r
- "publisher": "dradmin",\r
+ "publisher": "{user}",\r
"links": {\r
"subscribe": "https://dmaap-dr-prov/subscribe/1",\r
"log": "https://dmaap-dr-prov/feedlog/1",\r
\r
**Request Parameters:**\r
\r
-+------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
-| Field | Description | Param Type | Data Type | MaxLen | Required |\r
-+========================+=================================+=============+===============+============+=============+\r
-| publisher | Publisher identity as passed | Header | String | <=8 | Y |\r
-| | in X-DMAAP-DR-ON-BEHALF-OF at | | | | |\r
-| | creation time | | | | |\r
-+------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
-| Authorization | The user / AppId to be | Header | String | | Y if AAF |\r
-| | authorized by the AAF CADI | | | | enabled |\r
-| | framework | | | | |\r
-+------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+| Field | Description | Param Type | Data Type | MaxLen | Required |\r
++=========================+=================================+=============+===============+============+=============+\r
+| Authorization | The user / AppId to be | Header | String | | Y |\r
+| | authorized | | | | |\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+| X-DMAAP-DR-ON-BEHALF-OF | Publisher identity as passed | Header | String | <=8 | Y |\r
+| | in X-DMAAP-DR-ON-BEHALF-OF at | | | | |\r
+| | creation time | | | | |\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
\r
**Response Codes**\r
\r
{\r
"password": "dradmin",\r
"id": "dradmin"\r
- },\r
- {\r
- "password": "demo123456!",\r
- "id": "onap"\r
}\r
]\r
},\r
"name": "ONAP Data Feed",\r
"business_description": "Updated ONAP Feed",\r
- "aaf_instance": "legacy",\r
- "publisher": "dradmin",\r
+ "publisher": "{user}",\r
"links": {\r
"subscribe": "https://dmaap-dr-prov/subscribe/1",\r
"log": "https://dmaap-dr-prov/feedlog/1",\r
\r
**Request Parameters:**\r
\r
-+------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
-| Field | Description | Param Type | Data Type | MaxLen | Required |\r
-+========================+=================================+=============+===============+============+=============+\r
-| publisher | Publisher identity as passed | Header | String | <=8 | Y |\r
-| | in X-DMAAP-DR-ON-BEHALF-OF at | | | | |\r
-| | creation time | | | | |\r
-+------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
-| Authorization | The user / AppId to be | Header | String | | Y if AAF |\r
-| | authorized by the AAF CADI | | | | enabled |\r
-| | framework | | | | |\r
-+------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+| Field | Description | Param Type | Data Type | MaxLen | Required |\r
++=========================+=================================+=============+===============+============+=============+\r
+| Authorization | The user / AppId to be | Header | String | | Y |\r
+| | authorized | | | | |\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+| X-DMAAP-DR-ON-BEHALF-OF | Publisher identity as passed | Header | String | <=8 | Y |\r
+| | in X-DMAAP-DR-ON-BEHALF-OF at | | | | |\r
+| | creation time | | | | |\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
\r
**Response Codes**\r
\r
\r
**Request Parameters:**\r
\r
-+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
-| Field | Description | Param Type | Data Type | MaxLen | Set By | Updatable? | Required | Valid/Example Values |\r
-+=================+=================================+===============+=================+========+========+============+==========+======================================+\r
-| feedId | ID for the feed you are | Path | String | | Client | N | Y | 1 |\r
-| | subscribing to | | | | | | | |\r
-+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
-| delivery | Address and credentials for | Body | `Del Object`_ | | Client | Y | Y | |\r
-| | delivery | | | | | | | |\r
-+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
-| follow_redirect | Set to true if feed redirection | Body | Boolean | | Client | Y | N | * true |\r
-| | is expected | | | | | | | * false (default) |\r
-+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
-| metadata_only | Set to true if subscription is | Body | Boolean | | Client | Y | Y | * true |\r
-| | to receive per-file metadata | | | | | | | * false |\r
-+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
-| suspend | Set to true if the subscription | Body | Boolean | | Client | Y | N | * true |\r
-| | is in the suspended state | | | | | | | * false (default) |\r
-+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
-| decompress | Set to true if the data is to | Body | Boolean | | Client | Y | N | * true |\r
-| | be decompressed for subscriber | | | | | | | * false (default) |\r
-+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
-| group-id | Auth group for sub management | Body | Integer | | Client | Y | Y | 22 |\r
-| | | | | | | | | |\r
-+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
-| aaf_instance | The instance passed to aaf | Body | String | <=256 | Client | N | N | * legacy (default) |\r
-| | during permission checks | | | | | | | |\r
-| | | | | | | | | |\r
-+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
-| Content-type | To specify type of message | Header | String | | Client | N | Y | application/vnd.dmaap-dr.subscription|\r
-| | (feed,subscriber,publisher) | | | | | | | |\r
-+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
-| subscriber | Subscriber identity as passed | Header | String | <=8 | DR | N | Y | username |\r
-| | in X-DMAAP-DR-ON-BEHALF-OF at | | | | | | | |\r
-| | creation time | | | | | | | |\r
-+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
-| Authorization | The user / AppId to be | Header | String | | Client | N | Y if AAF | dcae@dcae.onap.org:{password} |\r
-| | authorized by the AAF CADI | | | | | | enabled | |\r
-| | framework | | | | | | | |\r
-+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
-| X-EXCLUDE-AAF | To determine if the feed to | Header | Boolean | | Client | N | Y if AAF | * true (for legacy feed) |\r
-| | create is legacy or AAF | | | | | | enabled | * false (for AAF feed) |\r
-+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
-| Links | URLs related to this | Body |`Sub Links Obj`_ | | DR | N | N | |\r
-| | subscription | | | | | | | |\r
-+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
++-------------------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
+| Field | Description | Param Type | Data Type | MaxLen | Set By | Updatable? | Required | Valid/Example Values |\r
++=========================+=================================+===============+=================+========+========+============+==========+======================================+\r
+| feedId | ID for the feed you are | Path | String | | Client | N | Y | 1 |\r
+| | subscribing to | | | | | | | |\r
++-------------------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
+| delivery | Address and credentials for | Body | `Del Object`_ | | Client | Y | Y | |\r
+| | delivery | | | | | | | |\r
++-------------------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
+| follow_redirect | Set to true if feed redirection | Body | Boolean | | Client | Y | N | * true |\r
+| | is expected | | | | | | | * false (default) |\r
++-------------------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
+| metadata_only | Set to true if subscription is | Body | Boolean | | Client | Y | Y | * true |\r
+| | to receive per-file metadata | | | | | | | * false |\r
++-------------------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
+| suspend | Set to true if the subscription | Body | Boolean | | Client | Y | N | * true |\r
+| | is in the suspended state | | | | | | | * false (default) |\r
++-------------------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
+| decompress | Set to true if the data is to | Body | Boolean | | Client | Y | N | * true |\r
+| | be decompressed for subscriber | | | | | | | * false (default) |\r
++-------------------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
+| group-id | Auth group for sub management | Body | Integer | | Client | Y | Y | 22 |\r
+| | | | | | | | | |\r
++-------------------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
+| Content-type | To specify type of message | Header | String | | Client | N | Y | application/vnd.dmaap-dr.subscription|\r
+| | (feed,subscriber,publisher) | | | | | | | |\r
++-------------------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
+| Authorization | The user / AppId to be | Header | String | | Client | N | Y | Basic <credentials> |\r
+| | authorized | | | | | | | |\r
++-------------------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
+| X-DMAAP-DR-ON-BEHALF-OF | Publisher identity as passed | Header | String | <=8 | DR | N | Y | username |\r
+| | in X-DMAAP-DR-ON-BEHALF-OF at | | | | | | | |\r
+| | creation time | | | | | | | |\r
++-------------------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+\r
\r
**Response Codes**\r
\r
"user": "LOGIN",\r
"url": "http://dmaap-dr-subscriber:7070/"\r
},\r
- "subscriber": "onap",\r
+ "subscriber": "{user}",\r
"groupid": 1,\r
"metadataOnly": false,\r
"follow_redirect": true,\r
"decompress": true,\r
- "aaf_instance": "legacy",\r
"links": {\r
"feed": "https://dmaap-dr-prov/feed/1",\r
"log": "https://dmaap-dr-prov/sublog/1",\r
\r
**Request Parameters:**\r
\r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
-| Field | Description | Param Type | Data Type | MaxLen | Required |\r
-+=================+=================================+==============+===============+========+=============+\r
-| subId | ID for the subscription you are | Path | String | | Y |\r
-| | updating | | | | |\r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
-| delivery | Address and credentials for | Body | `Del Object`_ | | Y |\r
-| | delivery | | | | |\r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
-| follow_redirect | Set to true if feed redirection | Body | Boolean | | N |\r
-| | is expected | | | | |\r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
-| metadata_only | Set to true if subscription is | Body | Boolean | | Y |\r
-| | to receive per-file metadata | | | | |\r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
-| suspend | Set to true if the subscription | Body | Boolean | | N |\r
-| | is in the suspended state | | | | |\r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
-| decompress | Set to true if the data is to | Body | Boolean | | N |\r
-| | be decompressed for subscriber | | | | |\r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
-| group-id | Auth group for sub management | Body | Integer | | Y |\r
-| | | | | | |\r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
-| Content-type | To specify type of message | Header | String | | Y |\r
-| | (feed,subscriber,publisher) | | | | |\r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
-| subscriber | Subscriber identity as passed | Header | String | <=8 | Y |\r
-| | in X-DMAAP-DR-ON-BEHALF-OF at | | | | |\r
-| | creation time | | | | |\r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
-| Authorization | The user / AppId to be | Header | String | | Y if AAF |\r
-| | authorized by the AAF CADI | | | | enabled |\r
-| | framework | | | | |\r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
-| X-EXCLUDE-AAF | To determine if the feed to | Header | Boolean | | Y if AAF |\r
-| | create is legacy or AAF | | | | enabled |\r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
++-------------------------+---------------------------------+--------------+---------------+--------+-------------+\r
+| Field | Description | Param Type | Data Type | MaxLen | Required |\r
++=========================+=================================+==============+===============+========+=============+\r
+| subId | ID for the subscription you are | Path | String | | Y |\r
+| | updating | | | | |\r
++-------------------------+---------------------------------+--------------+---------------+--------+-------------+\r
+| delivery | Address and credentials for | Body | `Del Object`_ | | Y |\r
+| | delivery | | | | |\r
++-------------------------+---------------------------------+--------------+---------------+--------+-------------+\r
+| follow_redirect | Set to true if feed redirection | Body | Boolean | | N |\r
+| | is expected | | | | |\r
++-------------------------+---------------------------------+--------------+---------------+--------+-------------+\r
+| metadata_only | Set to true if subscription is | Body | Boolean | | Y |\r
+| | to receive per-file metadata | | | | |\r
++-------------------------+---------------------------------+--------------+---------------+--------+-------------+\r
+| suspend | Set to true if the subscription | Body | Boolean | | N |\r
+| | is in the suspended state | | | | |\r
++-------------------------+---------------------------------+--------------+---------------+--------+-------------+\r
+| decompress | Set to true if the data is to | Body | Boolean | | N |\r
+| | be decompressed for subscriber | | | | |\r
++-------------------------+---------------------------------+--------------+---------------+--------+-------------+\r
+| group-id | Auth group for sub management | Body | Integer | | Y |\r
+| | | | | | |\r
++-------------------------+---------------------------------+--------------+---------------+--------+-------------+\r
+| Content-type | To specify type of message | Header | String | | Y |\r
+| | (feed,subscriber,publisher) | | | | |\r
++-------------------------+---------------------------------+--------------+---------------+--------+-------------+\r
+| Authorization | The user / AppId to be | Header | String | | Y |\r
+| | authorized | | | | |\r
++-------------------------+---------------------------------+--------------+---------------+--------+-------------+\r
+| X-DMAAP-DR-ON-BEHALF-OF | Publisher identity as passed | Header | String | <=8 | Y |\r
+| | in X-DMAAP-DR-ON-BEHALF-OF at | | | | |\r
+| | creation time | | | | |\r
++-------------------------+---------------------------------+--------------+---------------+--------+-------------+\r
\r
**Response Codes**\r
\r
"user": "NEW_LOGIN",\r
"url": "http://dmaap-dr-subscriber:7070/"\r
},\r
- "subscriber": "onap",\r
+ "subscriber": "{user}",\r
"groupid": 67,\r
"metadataOnly": true,\r
"follow_redirect": false,\r
"decompress": false,\r
- "aaf_instance": "legacy",\r
"links": {\r
"feed": "https://dmaap-dr-prov/feed/1",\r
"log": "https://dmaap-dr-prov/sublog/1",\r
\r
**Request Parameters:**\r
\r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
-| Field | Description | Param Type | Data Type | MaxLen | Required |\r
-+=================+=================================+==============+===============+========+=============+\r
-| subscriber | Subscriber identity as passed | Header | String | <=8 | Y |\r
-| | in X-DMAAP-DR-ON-BEHALF-OF at | | | | |\r
-| | creation time | | | | |\r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
-| Authorization | The user / AppId to be | Header | String | | Y if AAF |\r
-| | authorized by the AAF CADI | | | | enabled |\r
-| | framework | | | | |\r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+| Field | Description | Param Type | Data Type | MaxLen | Required |\r
++=========================+=================================+=============+===============+============+=============+\r
+| Authorization | The user / AppId to be | Header | String | | Y |\r
+| | authorized | | | | |\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+| X-DMAAP-DR-ON-BEHALF-OF | Subscriber identity as passed | Header | String | <=8 | Y |\r
+| | in X-DMAAP-DR-ON-BEHALF-OF at | | | | |\r
+| | creation time | | | | |\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+\r
\r
**Response Codes**\r
\r
"user": "NEW_LOGIN",\r
"url": "http://dmaap-dr-subscriber:7070/"\r
},\r
- "subscriber": "onap",\r
+ "subscriber": "{user}",\r
"groupid": 67,\r
"metadataOnly": true,\r
"privilegedSubscriber": false,\r
"follow_redirect": false,\r
"decompress": false,\r
- "aaf_instance": "legacy",\r
"links": {\r
"feed": "https://dmaap-dr-prov/feed/2",\r
"log": "https://dmaap-dr-prov/sublog/6",\r
\r
**Request Parameters:**\r
\r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
-| Field | Description | Param Type | Data Type | MaxLen | Required |\r
-+=================+=================================+==============+===============+========+=============+\r
-| subscriber | Subscriber identity as passed | Header | String | <=8 | Y |\r
-| | in X-DMAAP-DR-ON-BEHALF-OF at | | | | |\r
-| | creation time | | | | |\r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
-| Authorization | The user / AppId to be | Header | String | | Y if AAF |\r
-| | authorized by the AAF CADI | | | | enabled |\r
-| | framework | | | | |\r
-+-----------------+---------------------------------+--------------+---------------+--------+-------------+\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+| Field | Description | Param Type | Data Type | MaxLen | Required |\r
++=========================+=================================+=============+===============+============+=============+\r
+| Authorization | The user / AppId to be | Header | String | | Y |\r
+| | authorized | | | | |\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
+| X-DMAAP-DR-ON-BEHALF-OF | Subscriber identity as passed | Header | String | <=8 | Y |\r
+| | in X-DMAAP-DR-ON-BEHALF-OF at | | | | |\r
+| | creation time | | | | |\r
++-------------------------+---------------------------------+-------------+---------------+------------+-------------+\r
\r
**Response Codes**\r
\r
| | * Lowercase boolean | | | | | |\r
| | * null | | | | | |\r
+------------------------+---------------------------------+------------------+------------+--------------+-------------+-------------------------------------------+\r
-| Authorization | An `EID Object`_ with publish | Header | String | | Y | * (legacy Feed) dradmin:dradmin |\r
-| | permissions. | | | | | * (AAF Feed) dcae@dcae.onap.org:{password}|\r
-| | If AAF CADI is enabled, use a | | | | | |\r
-| | valid AAF user/AppId instead. | | | | | |\r
+| Authorization | An `EID Object`_ with publish | Header | String | | Y | * dradmin:dradmin |\r
+| | permissions. | | | | | |\r
+------------------------+---------------------------------+------------------+------------+--------------+-------------+-------------------------------------------+\r
\r
**Response Codes**\r
+-----------------+---------------------------------+--------------+---------------+------------+-------------------------------------------+\r
| Field | Description | Param Type | Data Type | Required | Valid/Example Values |\r
+=================+=================================+==============+===============+============+===========================================+\r
-| Authorization | An `EID Object`_ with publish | Header | String | Y | * (legacy Feed) dradmin:dradmin |\r
-| | permissions. | | | | * (AAF Feed) dcae@dcae.onap.org:{password}|\r
-| | If AAF CADI is enabled, use a | | | | |\r
-| | valid AAF user/AppId instead. | | | | |\r
+| Authorization | An `EID Object`_ with publish | Header | String | Y | * dradmin:dradmin |\r
+| | permissions. | | | | |\r
+-----------------+---------------------------------+--------------+---------------+------------+-------------------------------------------+\r
| feedId | ID of the feed that was | Path | String | Y | |\r
| | publishing to | | | | |\r
from docs_conf.conf import *
-branch = 'latest'
-doc_url = 'https://docs.onap.org/projects'
master_doc = 'index'
intersphinx_mapping = {}
-# Latest (change to branch)
-intersphinx_mapping['onap-aai-aai-common'] = ('{}/onap-aai-aai-common/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-aai-sparky-be'] = ('{}/onap-aai-sparky-be/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-ccsdk-cds'] = ('{}/onap-ccsdk-cds/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-ccsdk-features'] = ('{}/onap-ccsdk-features/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-ccsdk-distribution'] = ('{}/onap-ccsdk-distribution/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-ccsdk-oran'] = ('{}/onap-ccsdk-oran/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-cli'] = ('{}/onap-cli/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-cps'] = ('{}/onap-cps/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-dcaegen2'] = ('{}/onap-dcaegen2/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-dmaap-messagerouter-messageservice'] = (
- '{}/onap-dmaap-messagerouter-messageservice/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-dmaap-buscontroller'] = ('{}/onap-dmaap-buscontroller/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-dmaap-datarouter'] = ('{}/onap-dmaap-datarouter/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-dmaap-dbcapi'] = ('{}/onap-dmaap-dbcapi/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-externalapi-nbi'] = ('{}/onap-externalapi-nbi/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-holmes-engine-management'] = (
- '{}/onap-holmes-engine-management/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-holmes-rule-management'] = (
- '{}/onap-holmes-rule-management/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-integration'] = ('{}/onap-integration/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-modeling-etsicatalog'] = ('{}/onap-modeling-etsicatalog/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-modeling-modelspec'] = ('{}/onap-modeling-modelspec/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-multicloud-framework'] = ('{}/onap-multicloud-framework/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-msb-apigateway'] = ('{}/onap-msb-apigateway/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-oom'] = ('{}/onap-oom/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-oom-offline-installer'] = ('{}/onap-oom-offline-installer/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-oom-platform-cert-service'] = (
- '{}/onap-oom-platform-cert-service/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-optf-cmso'] = ('{}/onap-optf-cmso/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-optf-osdf'] = ('{}/onap-optf-osdf/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-optf-has'] = ('{}/onap-optf-has/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-policy-clamp'] = ('{}/onap-policy-clamp/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-policy-parent'] = ('{}/onap-policy-parent/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-sdc'] = ('{}/onap-sdc/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-sdnc-oam'] = ('{}/onap-sdnc-oam/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-so'] = ('{}/onap-so/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-usecase-ui'] = ('{}/onap-usecase-ui/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-vfc-nfvo-lcm'] = ('{}/onap-vfc-nfvo-lcm/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-vid'] = ('{}/onap-vid/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-vnfrqts-guidelines'] = ('{}/onap-vnfrqts-guidelines/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-vnfrqts-requirements'] = ('{}/onap-vnfrqts-requirements/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-vnfrqts-testcases'] = ('{}/onap-vnfrqts-testcases/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-vnfrqts-usecases'] = ('{}/onap-vnfrqts-usecases/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-vnfsdk-model'] = ('{}/onap-vnfsdk-model/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-vvp-documentation'] = ('{}/onap-vvp-documentation/en/%s'.format(doc_url) % branch, None)
-
-# Guilin
-branch = 'guilin'
-intersphinx_mapping['onap-portal'] = ('{}/onap-portal/en/%s'.format(doc_url) % branch, None)
-
-# Frankfurt
-branch = 'frankfurt'
-intersphinx_mapping['onap-appc'] = ('{}/onap-appc/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-appc-deployment'] = ('{}/onap-appc-deployment/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-music'] = ('{}/onap-music/en/%s'.format(doc_url) % branch, None)
-
-# Latest
-branch = 'latest'
-intersphinx_mapping['onap-aaf-authz'] = ('{}/onap-aaf-authz/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-aaf-sms'] = ('{}/onap-aaf-sms/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-aai-event-client'] = ('{}/onap-aai-event-client/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-aai-esr-gui'] = ('{}/onap-aai-esr-gui/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-aai-esr-server'] = ('{}/onap-aai-esr-server/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-ccsdk-apps'] = ('{}/onap-ccsdk-apps/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-ccsdk-dashboard'] = ('{}/onap-ccsdk-dashboard/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-ccsdk-platform-plugins'] = (
- '{}/onap-ccsdk-platform-plugins/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-logging-analytics'] = ('{}/onap-logging-analytics/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-logging-analytics-pomba-pomba-audit-common'] = (
- '{}/onap-logging-analytics-pomba-pomba-audit-common/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-modeling-toscaparsers'] = (
- '{}/onap-modeling-toscaparsers/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-msb-discovery'] = ('{}/onap-msb-discovery/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-msb-java-sdk'] = ('{}/onap-msb-java-sdk/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-msb-swagger-sdk'] = ('{}/onap-msb-swagger-sdk/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-multicloud-azure'] = ('{}/onap-multicloud-azure/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-multicloud-k8s'] = ('{}/onap-multicloud-k8s/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-music-distributed-kv-store'] = (
- '{}/onap-music-distributed-kv-store/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-oparent-cia'] = ('{}/onap-oparent-cia/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-osa'] = ('{}/onap-osa/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-sdc-sdc-distribution-client'] = (
- '{}/onap-sdc-sdc-distribution-client/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-sdc-sdc-workflow-designer'] = (
- '{}/onap-sdc-sdc-workflow-designer/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-sdc-sdc-tosca'] = ('{}/onap-sdc-sdc-tosca/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-sdc-sdc-docker-base'] = ('{}/onap-sdc-sdc-docker-base/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-so-libs'] = ('{}/onap-so-libs/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-vfc-nfvo-driver-vnfm-svnfm'] = (
- '{}/onap-vfc-nfvo-driver-vnfm-svnfm/en/%s'.format(doc_url) % branch, None)
-
linkcheck_ignore = [
'http://localhost',
'https://example.com',