From 0fa019897cb79de1def349b8fd0b660d1951681a Mon Sep 17 00:00:00 2001 From: efiacor Date: Mon, 8 Apr 2019 14:52:08 +0000 Subject: Adding docs for CADI Change-Id: If3324973a2e41ca0d98804cb8e6520fc1beccfe9 Issue-ID: DMAAP-1016 Signed-off-by: efiacor --- docs/data-router/DataRouterUserGuide.rst | 25 - docs/data-router/administration.rst | 14 - docs/data-router/architecture.rst | 25 - docs/data-router/configuration.rst | 7 - docs/data-router/consumedapis.rst | 7 - docs/data-router/data-router.rst | 1176 ------------------------------ docs/data-router/delivery.rst | 32 - docs/data-router/dr_arch.png | Bin 35750 -> 0 bytes docs/data-router/humaninterfaces.rst | 10 - docs/data-router/logging.rst | 33 - docs/data-router/release-notes.rst | 153 ---- 11 files changed, 1482 deletions(-) delete mode 100644 docs/data-router/DataRouterUserGuide.rst delete mode 100644 docs/data-router/administration.rst delete mode 100644 docs/data-router/architecture.rst delete mode 100644 docs/data-router/configuration.rst delete mode 100644 docs/data-router/consumedapis.rst delete mode 100755 docs/data-router/data-router.rst delete mode 100644 docs/data-router/delivery.rst delete mode 100644 docs/data-router/dr_arch.png delete mode 100644 docs/data-router/humaninterfaces.rst delete mode 100644 docs/data-router/logging.rst delete mode 100644 docs/data-router/release-notes.rst (limited to 'docs/data-router') diff --git a/docs/data-router/DataRouterUserGuide.rst b/docs/data-router/DataRouterUserGuide.rst deleted file mode 100644 index 8f7b9ef1..00000000 --- a/docs/data-router/DataRouterUserGuide.rst +++ /dev/null @@ -1,25 +0,0 @@ -=========================== -Data Router (DR) User Guide -=========================== - -Standalone Mode ---------------- - -Installation -============ - -1. Find the datarouter project on the gerrit website: https://gerrit.onap.org/r/#/admin/projects/dmaap/datarouter - -2. Clone the repo onto your server using the clone command found on the datarouter page on gerrit. - -3. cd into the docker-compose directory and run docker-compose up. - -Configurations -============== - -Using the Data Router ---------------------- - -For information on how to use the Data Router refer to the Data Router API guide at: - - :ref:`data_router_api_guide` \ No newline at end of file diff --git a/docs/data-router/administration.rst b/docs/data-router/administration.rst deleted file mode 100644 index b050a1fe..00000000 --- a/docs/data-router/administration.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Administration -============== - - -Processes ---------- -NA - -Actions -------- -NA diff --git a/docs/data-router/architecture.rst b/docs/data-router/architecture.rst deleted file mode 100644 index b18f7bb3..00000000 --- a/docs/data-router/architecture.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Architecture -============ - - -Capabilities ------------- -Data Router is a RESTful web service used for the transfer of data across networks any larger than a Message Router message (> 1Mb). - -Usage Scenarios ---------------- - Data Router endpoints are used to create/view/delete Feeds, Subscribers and Published files. Clients can use the Data Router endpoints - to publish a file to a feed and subscribe to this feed to receive the file. - -Interactions ------------- -Data Router REST service uses the Data Router API to allow users to publish to and subscribe to a feed, in order to send and receive files. - - - - |image0| - - .. |image0| image:: dr_arch.png diff --git a/docs/data-router/configuration.rst b/docs/data-router/configuration.rst deleted file mode 100644 index 2a7096a1..00000000 --- a/docs/data-router/configuration.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Configuration -============= - -NA \ No newline at end of file diff --git a/docs/data-router/consumedapis.rst b/docs/data-router/consumedapis.rst deleted file mode 100644 index aa1a8bd1..00000000 --- a/docs/data-router/consumedapis.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Consumed APIs -============= - -Data Router does not consume any API diff --git a/docs/data-router/data-router.rst b/docs/data-router/data-router.rst deleted file mode 100755 index 66e13bf5..00000000 --- a/docs/data-router/data-router.rst +++ /dev/null @@ -1,1176 +0,0 @@ -.. _data_router_api_guide: - -========================== -Data Router (DR) API Guide -========================== -Introduction ------------- - -The DataRouter(DR) provisioning API is an HTTPS-based, REST-like API for creating and managing DR feeds -and subscriptions. The DMaaP Data Router System project is intended to provide a common framework by which -data producers can make data available to data consumers and a way for potential consumers to find feeds -with the data they require. - - -HTTP Service APIs ------------------ - -DMaaP Data Router utilizes an HTTP REST API to service all transactions. HTTP and REST standards are followed so -clients as varied as CURL, Java applications and even Web Browsers will work to interact with the Data Router. - -General HTTP Requirements -========================= - -A DMaaP Data Router transactions consists of 4 distinct segments, HTTP URL, HTTP Header, HTTP Body (POST/PUT) -and HTTP Response. The general considerations for each segment are as follows and are required for each -of the specific transactions described in this section. - -HTTP URL -======== - -http[s]://{serverBaseURL}/{resourcePath} - -* The serverBaseURL points to DMaaP Data Router host:port that will service the request. -* The resourcePath specifies the service that the client is attempting to reach. - - -HTTP Header -=========== - -Specifies HTTP Headers, such as Content-Type, that define the parameters of the HTTP Transaction - -HTTP Body -========= - -The HTTP Body contains the feed content when creating a feed. - -Create a Feed -------------- - -**Description**: Creates a unique feed URL to service the publisher/subscriber model. - -Sample Request -============== - -``curl -k -X POST -H "Content-Type:application/vnd.dmaap-dr.feed" -H "X-DMAAP-DR-ON-BEHALF-OF:{user}" --data-ascii @createFeed.json https://{host}:{port}`` - -Request Parameters: -=================== - -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| Name | Description | Param Type | Data Type | MaxLen | Required | Valid/Example Values | -+========================+=================================+==================+============+==============+=============+======================================+ -| name | Feed name | Body | String | <=20 | Y | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| version | Feed version | Body | String | <=20 | Y | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| description | Feed description | Body | String | <=256 | Y | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| business description | Business description | Body | String | <=256 | Y | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| Authorization | Information for authorizing | Body | Object | | Y | | -| | publishing requests | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| suspend | Set to true if the feed is in | Body | Boolean | | N | * true | -| | the suspended state | | | | | * false | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| group-id | | Body | Integer | | Y | | -| | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| content-type | To specify type of message | Header | String | | Y | application/vnd.dmaap-dr.feed | -| | (feed,subscriber,publisher) | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| X-DMAAP-DR-ON-BEHALF-OF| User id of owner of feed | Header | String | <=8 | Y | username | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ - -Response/Error Codes -==================== - -+------------------------+-------------------------------------------+ -| Response statusCode | Response Description | -+========================+===========================================+ -| 201 | Successful query | -+------------------------+-------------------------------------------+ -| 400 | Bad request - The request is defective in | -| | some way. Possible causes: | -| | | -| | * JSON object in request body does not | -| | conform to the spec. | -| | * Invalid parameter value in query string | -+------------------------+-------------------------------------------+ -| 401 | Indicates that the request was missing the| -| | Authorization header or, if the header | -| | was presented, the credentials were not | -| | acceptable | -+------------------------+-------------------------------------------+ -| 403 | The request failed authorization. | -| | Possible causes: | -| | | -| | * Request originated from an unauthorized | -| | IP address | -| | * Client certificate subject is not on | -| | the API’s authorized list. | -| | * X-DMAAP-DR-ON-BEHALF-OF identity is not | -| | authorized to perform | -+------------------------+-------------------------------------------+ -| 404 | Not Found - The Request-URI does not point| -| | to a resource that is known to the API. | -+------------------------+-------------------------------------------+ -| 405 | Method Not Allowed - The HTTP method in | -| | the request is not supported for the | -| | resource addressed by the Request-URI. | -+------------------------+-------------------------------------------+ -| 415 | Unsupported Media Type - The media type in| -| | the requests Content-Type header is not | -| | appropriate for the request. | -+------------------------+-------------------------------------------+ -| 500 | Internal Server Error - The DR API server | -| | encountered an internal error and could | -| | not complete the request. | -+------------------------+-------------------------------------------+ -| 503 | Service Unavailable - The DR API service | -| | is currently unavailable | -+------------------------+-------------------------------------------+ -| -1 | Failed Delivery | -+------------------------+-------------------------------------------+ - -Sample Body -=========== -.. code-block:: json - - { - "name": "Jettydemo", - "version": "v1.0.0", - "description": "Jettydemo", - "business_description": "Jettydemo", - "suspend": false, - "changeowner": true, - "authorization": { - "classification": "unclassified", - "endpoint_addrs": ["172.18.0.3","192.167.3.42"], - "endpoint_ids": [ - { - "password": "password", - "id": "user" - } - ] - } - } - - -Updating a Feed ---------------- - -**Description**: Update a feed with new parameters. - -Sample Request -============== - -``curl -k -X PUT -H "Content-Type: application/vnd.dmaap-dr.feed" -H "X-DMAAP-DR-ON-BEHALF-OF: {user}" --data-ascii @updateFeed.json --location-trusted https://{host}:{port}/feed/{feedId}`` - -Request Parameters: -=================== - -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| Name | Description | Param Type | Data Type | MaxLen | Required | Valid/Example Values | -+========================+=================================+==================+============+==============+=============+======================================+ -| description | Feed description | Body | String | <=256 | Y | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| business description | Business description | Body | String | <=256 | Y | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| Authorization | Information for authorizing | Body | Object | | Y | | -| | publishing requests | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| suspend | Set to true if the feed is in | Body | Boolean | | N | * true | -| | the suspended state | | | | | * false | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| group-id | | Body | Integer | | Y | | -| | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| content-type | To specify type of message | Header | String | | Y | application/vnd.dmaap-dr.feed | -| | (feed,subscriber,publisher) | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| X-DMAAP-DR-ON-BEHALF-OF| User id of owner of feed | Header | String | <=8 | Y | username | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ - -Response/Error Codes -==================== - -+------------------------+-------------------------------------------+ -| Response statusCode | Response Description | -+========================+===========================================+ -| 200 | Successful query | -+------------------------+-------------------------------------------+ -| 400 | Bad request - The request is defective in | -| | some way. Possible causes: | -| | | -| | * JSON object in request body does not | -| | conform to the spec. | -| | * Invalid parameter value in query string | -+------------------------+-------------------------------------------+ -| 401 | Indicates that the request was missing the| -| | Authorization header or, if the header | -| | was presented, the credentials were not | -| | acceptable | -+------------------------+-------------------------------------------+ -| 403 | The request failed authorization. | -| | Possible causes: | -| | | -| | * Request originated from an unauthorized | -| | IP address | -| | * Client certificate subject is not on | -| | the API’s authorized list. | -| | * X-DMAAP-DR-ON-BEHALF-OF identity is not | -| | authorized to perform | -+------------------------+-------------------------------------------+ -| 404 | Not Found - The Request-URI does not point| -| | to a resource that is known to the API. | -+------------------------+-------------------------------------------+ -| 405 | Method Not Allowed - The HTTP method in | -| | the request is not supported for the | -| | resource addressed by the Request-URI. | -+------------------------+-------------------------------------------+ -| 415 | Unsupported Media Type - The media type in| -| | the request’s Content-Type header is not | -| | appropriate for the request. | -+------------------------+-------------------------------------------+ -| 500 | Internal Server Error - The DR API server | -| | encountered an internal error and could | -| | not complete the request. | -+------------------------+-------------------------------------------+ -| 503 | Service Unavailable - The DR API service | -| | is currently unavailable | -+------------------------+-------------------------------------------+ -| -1 | Failed Delivery | -+------------------------+-------------------------------------------+ - -Sample Body -=========== -.. code-block:: json - - { - "name": "Jettydemo", - "version": "v1.0.0", - "description": "Updated decription", - "business_description": "Updated business description", - "suspend": false, - "changeowner": true, - "authorization": { - "classification": "unclassified", - "endpoint_addrs": ["172.18.0.3","192.167.3.42"], - "endpoint_ids": [ - { - "password": "password", - "id": "user" - } - ] - } - } - - -Get a Feed ----------- - -**Description**: Retrieves a representation of the specified feed. - -Request URL -=========== - -http[s]://{host}:{port}/feed/{feedId} - -* {feedId}: Id of the feed you want to see a representation of - -Sample Request -============== - -``curl -k -H "X-DMAAP-DR-ON-BEHALF-OF: {user}" https://{host}:{port}/feed/{feedId}`` - -Response/Error Codes -==================== - -+------------------------+-------------------------------------------+ -| Response statusCode | Response Description | -+========================+===========================================+ -| 200 | Successful query | -+------------------------+-------------------------------------------+ -| 401 | Indicates that the request was missing the| -| | Authorization header or, if the header | -| | was presented, the credentials were not | -| | acceptable | -+------------------------+-------------------------------------------+ -| 403 | The request failed authorization. | -| | Possible causes: | -| | | -| | * Request originated from an unauthorized | -| | IP address | -| | * Client certificate subject is not on | -| | the API’s authorized list. | -| | * X-DMAAP-DR-ON-BEHALF-OF identity is not | -| | authorized to perform | -+------------------------+-------------------------------------------+ -| 404 | Not Found - The Request-URI does not point| -| | to a resource that is known to the API. | -+------------------------+-------------------------------------------+ -| 405 | Method Not Allowed - The HTTP method in | -| | the request is not supported for the | -| | resource addressed by the Request-URI. | -+------------------------+-------------------------------------------+ -| 415 | Unsupported Media Type - The media type in| -| | the request’s Content-Type header is not | -| | appropriate for the request. | -+------------------------+-------------------------------------------+ -| 500 | Internal Server Error - The DR API server | -| | encountered an internal error and could | -| | not complete the request. | -+------------------------+-------------------------------------------+ -| 503 | Service Unavailable - The DR API service | -| | is currently unavailable | -+------------------------+-------------------------------------------+ -| -1 | Failed Delivery | -+------------------------+-------------------------------------------+ - -Delete a Feed -------------- - -**Description**: Deletes a specified feed - -Request URL -=========== - -http[s]://{host}:{port}/feed/{feedId} - -* {feedId}: Id of the feed you want to delete - -Sample Request -============== - -``curl -k -X DELETE -H "X-DMAAP-DR-ON-BEHALF-OF: {user}" https://{host}:{port}/feed/{feedId}`` - -Response/Error Codes -==================== - -+------------------------+-------------------------------------------+ -| Response statusCode | Response Description | -+========================+===========================================+ -| 204 | Successful query | -+------------------------+-------------------------------------------+ -| 401 | Indicates that the request was missing the| -| | Authorization header or, if the header | -| | was presented, the credentials were not | -| | acceptable | -+------------------------+-------------------------------------------+ -| 403 | The request failed authorization. | -| | Possible causes: | -| | | -| | * Request originated from an unauthorized | -| | IP address | -| | * Client certificate subject is not on | -| | the API’s authorized list. | -| | * X-DMAAP-DR-ON-BEHALF-OF identity is not | -| | authorized to perform | -+------------------------+-------------------------------------------+ -| 404 | Not Found - The Request-URI does not point| -| | to a resource that is known to the API. | -+------------------------+-------------------------------------------+ -| 405 | Method Not Allowed - The HTTP method in | -| | the request is not supported for the | -| | resource addressed by the Request-URI. | -+------------------------+-------------------------------------------+ -| 415 | Unsupported Media Type - The media type in| -| | the request’s Content-Type header is not | -| | appropriate for the request. | -+------------------------+-------------------------------------------+ -| 500 | Internal Server Error - The DR API server | -| | encountered an internal error and could | -| | not complete the request. | -+------------------------+-------------------------------------------+ -| 503 | Service Unavailable - The DR API service | -| | is currently unavailable | -+------------------------+-------------------------------------------+ -| -1 | Failed Delivery | -+------------------------+-------------------------------------------+ - - -Subscribe to Feed ------------------ - -**Description**: Subscribes to a created feed to receive files published to that feed. - -Request URL -=========== - -http[s]://{host}:{port}/subscribe/{feedId} - -* {feedId}: Id of the feed to subscribe to - -Sample Request -============== - -``curl -k -X POST -H "Content-Type:application/vnd.dmaap-dr.subscription" -H "X-DMAAP-DR-ON-BEHALF-OF:{user}" --data-ascii @addSubscriber.json https://{host}:{port}/subscribe/{feedId}`` - -Request Parameters: -=================== - -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| Name | Description | Param Type | Data Type | MaxLen | Required | Valid/Example Values | -+========================+=================================+==================+============+==============+=============+======================================+ -| feedId | ID for the feed you are | Path | String | | Y | | -| | subscribing to | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| delivery | Address and credentials for | Body | Object | | Y | | -| | delivery | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| follow_redirect | Set to true if feed redirection | Body | Boolean | | Y | * true | -| | is expected | | | | | * false | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| metadata_only | Set to true if subscription is | Body | Boolean | | Y | * true | -| | to receive per-file metadata | | | | | * false | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| suspend | Set to true if the subscription | Body | Boolean | | N | * true | -| | is in the suspended state | | | | | * false | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| decompress | Set to true if the data is to | Body | Boolean | | N | * true | -| | be decompressed for subscriber | | | | | * false | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| group-id | | Body | Integer | | Y | | -| | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| content-type | To specify type of message | Header | String | | Y | application/vnd.dmaap-dr.subscription| -| | (feed,subscriber,publisher) | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| X-DMAAP-DR-ON-BEHALF-OF| User id of subscriber | Header | String | <=8 | Y | username | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ - -Response/Error Codes -==================== - -+------------------------+-------------------------------------------+ -| Response statusCode | Response Description | -+========================+===========================================+ -| 201 | Successful query | -+------------------------+-------------------------------------------+ -| 400 | Bad request - The request is defective in | -| | some way. Possible causes: | -| | | -| | * JSON object in request body does not | -| | conform to the spec. | -| | * Invalid parameter value in query string | -+------------------------+-------------------------------------------+ -| 401 | Indicates that the request was missing the| -| | Authorization header or, if the header | -| | was presented, the credentials were not | -| | acceptable | -+------------------------+-------------------------------------------+ -| 403 | The request failed authorization. | -| | Possible causes: | -| | | -| | * Request originated from an unauthorized | -| | IP address | -| | * Client certificate subject is not on | -| | the API’s authorized list. | -| | * X-DMAAP-DR-ON-BEHALF-OF identity is not | -| | authorized to perform | -+------------------------+-------------------------------------------+ -| 404 | Not Found - The Request-URI does not point| -| | to a resource that is known to the API. | -+------------------------+-------------------------------------------+ -| 405 | Method Not Allowed - The HTTP method in | -| | the request is not supported for the | -| | resource addressed by the Request-URI. | -+------------------------+-------------------------------------------+ -| 415 | Unsupported Media Type - The media type in| -| | the requests Content-Type header is not | -| | appropriate for the request. | -+------------------------+-------------------------------------------+ -| 500 | Internal Server Error - The DR API server | -| | encountered an internal error and could | -| | not complete the request. | -+------------------------+-------------------------------------------+ -| 503 | Service Unavailable - The DR API service | -| | is currently unavailable | -+------------------------+-------------------------------------------+ -| -1 | Failed Delivery | -+------------------------+-------------------------------------------+ - -Sample Body -=========== -.. code-block:: json - - { - "delivery" :{ - "url" : "http://172.18.0.3:7070/", - "user" : "LOGIN", - "password" : "PASSWORD", - "use100" : true - }, - "metadataOnly" : false, - "groupid" : 1, - "subscriber" : "subuser" - } - -Update subscription -------------------- - -**Description**: Update a subscription to a feed. - -Request URL -=========== - -http[s]://{host}:{port}/subs/{subId} - -* {subId}: Id of the subscription to be updated - -Sample Request -============== - -``curl -k -X PUT -H "Content-Type:application/vnd.dmaap-dr.subscription" -H "X-DMAAP-DR-ON-BEHALF-OF:{user}" --data-ascii @updateSubscriber.json https://{host}:{port}/subs/{subId}`` - -Request Parameters: -=================== - -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| Name | Description | Param Type | Data Type | MaxLen | Required | Valid/Example Values | -+========================+=================================+==================+============+==============+=============+======================================+ -| subId | ID for the subscription you are | Path | String | | Y | | -| | updating | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| delivery | Address and credentials for | Body | Object | | Y | | -| | delivery | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| follow_redirect | Set to true if feed redirection | Body | Boolean | | Y | * true | -| | is expected | | | | | * false | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| metadata_only | Set to true if subscription is | Body | Boolean | | Y | * true | -| | to receive per-file metadata | | | | | * false | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| suspend | Set to true if the subscription | Body | Boolean | | N | * true | -| | is in the suspended state | | | | | * false | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| decompress | Set to true if the data is to | Body | Boolean | | N | * true | -| | be decompressed for subscriber | | | | | * false | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| group-id | | Body | Integer | | Y | | -| | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| content-type | To specify type of message | Header | String | | Y | application/vnd.dmaap-dr.subscription| -| | (feed,subscriber,publisher) | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| X-DMAAP-DR-ON-BEHALF-OF| User id of subscriber | Header | String | 8 | Y | username | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ - -Response/Error Codes -==================== - -+------------------------+-------------------------------------------+ -| Response statusCode | Response Description | -+========================+===========================================+ -| 200 | Successful query | -+------------------------+-------------------------------------------+ -| 400 | Bad request - The request is defective in | -| | some way. Possible causes: | -| | | -| | * JSON object in request body does not | -| | conform to the spec. | -| | * Invalid parameter value in query string | -+------------------------+-------------------------------------------+ -| 401 | Indicates that the request was missing the| -| | Authorization header or, if the header | -| | was presented, the credentials were not | -| | acceptable | -+------------------------+-------------------------------------------+ -| 403 | The request failed authorization. | -| | Possible causes: | -| | | -| | * Request originated from an unauthorized | -| | IP address | -| | * Client certificate subject is not on | -| | the API’s authorized list. | -| | * X-DMAAP-DR-ON-BEHALF-OF identity is not | -| | authorized to perform | -+------------------------+-------------------------------------------+ -| 404 | Not Found - The Request-URI does not point| -| | to a resource that is known to the API. | -+------------------------+-------------------------------------------+ -| 405 | Method Not Allowed - The HTTP method in | -| | the request is not supported for the | -| | resource addressed by the Request-URI. | -+------------------------+-------------------------------------------+ -| 415 | Unsupported Media Type - The media type in| -| | the request’s Content-Type header is not | -| | appropriate for the request. | -+------------------------+-------------------------------------------+ -| 500 | Internal Server Error - The DR API server | -| | encountered an internal error and could | -| | not complete the request. | -+------------------------+-------------------------------------------+ -| 503 | Service Unavailable - The DR API service | -| | is currently unavailable | -+------------------------+-------------------------------------------+ -| -1 | Failed Delivery | -+------------------------+-------------------------------------------+ - -Sample Body -=========== -.. code-block:: json - - { - "delivery" :{ - "url" : "http://192.0.0.1:7070/", - "user" : "NEW_LOGIN", - "password" : "NEW_PASSWORD", - "use100" : true - }, - "metadataOnly" : false, - "groupid" : 2, - "subscriber" : "subuser" - } - - -Get a Subscription ------------------- - -**Description**: Retrieves a representation of the specified subscription. - -Request URL -=========== - -http[s]://{host}:{port}/subs/{subId} - -* {subId}: Id of the subscription you want to see a representation of - -Sample Request -============== - -``curl -k -H "X-DMAAP-DR-ON-BEHALF-OF:{user}" https://{host}:{port}/subs/{subId}`` - -Response/Error Codes -==================== - -+------------------------+-------------------------------------------+ -| Response statusCode | Response Description | -+========================+===========================================+ -| 200 | Successful query | -+------------------------+-------------------------------------------+ -| 401 | Indicates that the request was missing the| -| | Authorization header or, if the header | -| | was presented, the credentials were not | -| | acceptable | -+------------------------+-------------------------------------------+ -| 403 | The request failed authorization. | -| | Possible causes: | -| | | -| | * Request originated from an unauthorized | -| | IP address | -| | * Client certificate subject is not on | -| | the API’s authorized list. | -| | * X-DMAAP-DR-ON-BEHALF-OF identity is not | -| | authorized to perform | -+------------------------+-------------------------------------------+ -| 404 | Not Found - The Request-URI does not point| -| | to a resource that is known to the API. | -+------------------------+-------------------------------------------+ -| 405 | Method Not Allowed - The HTTP method in | -| | the request is not supported for the | -| | resource addressed by the Request-URI. | -+------------------------+-------------------------------------------+ -| 415 | Unsupported Media Type - The media type in| -| | the request’s Content-Type header is not | -| | appropriate for the request. | -+------------------------+-------------------------------------------+ -| 500 | Internal Server Error - The DR API server | -| | encountered an internal error and could | -| | not complete the request. | -+------------------------+-------------------------------------------+ -| 503 | Service Unavailable - The DR API service | -| | is currently unavailable | -+------------------------+-------------------------------------------+ -| -1 | Failed Delivery | -+------------------------+-------------------------------------------+ - -Delete a subscription ---------------------- - -**Description**: Deletes a specified subscription - -Request URL -=========== - -http[s]://{host}:{port}/subs/{subId} - -* {subId}: Id of the subscription you want to delete - -Sample Request -============== - -``curl -k -X DELETE -H "X-DMAAP-DR-ON-BEHALF-OF:{user}" https://{host}:{port}/subs/{subId}`` - -Response/Error Codes -==================== - -+------------------------+-------------------------------------------+ -| Response statusCode | Response Description | -+========================+===========================================+ -| 204 | Successful query | -+------------------------+-------------------------------------------+ -| 401 | Indicates that the request was missing the| -| | Authorization header or, if the header | -| | was presented, the credentials were not | -| | acceptable | -+------------------------+-------------------------------------------+ -| 403 | The request failed authorization. | -| | Possible causes: | -| | | -| | * Request originated from an unauthorized | -| | IP address | -| | * Client certificate subject is not on | -| | the API’s authorized list. | -| | * X-DMAAP-DR-ON-BEHALF-OF identity is not | -| | authorized to perform | -+------------------------+-------------------------------------------+ -| 404 | Not Found - The Request-URI does not point| -| | to a resource that is known to the API. | -+------------------------+-------------------------------------------+ -| 405 | Method Not Allowed - The HTTP method in | -| | the request is not supported for the | -| | resource addressed by the Request-URI. | -+------------------------+-------------------------------------------+ -| 415 | Unsupported Media Type - The media type in| -| | the request’s Content-Type header is not | -| | appropriate for the request. | -+------------------------+-------------------------------------------+ -| 500 | Internal Server Error - The DR API server | -| | encountered an internal error and could | -| | not complete the request. | -+------------------------+-------------------------------------------+ -| 503 | Service Unavailable - The DR API service | -| | is currently unavailable | -+------------------------+-------------------------------------------+ -| -1 | Failed Delivery | -+------------------------+-------------------------------------------+ - -Publish to Feed ---------------- - -**Description**: Publish data to a given feed - -Request URL -=========== - -http[s]://{host}:{port}/publish/{feedId}/{fileName} - -* {feedId} The id of the feed you are publishing to. -* {fileId} The name of the file you are publishing to the feed. - -Sample Request -============== - -``curl -k -X PUT --user {user}:{password} -H "Content-Type:application/octet-stream" -H "X-DMAAP-DR-META:{\"filetype\":\"txt\"}" --data-binary @sampleFile.txt --post301 --location-trusted https://{host}:{port}/publish/{feedId}/sampleFile`` - -Request parameters -================== - -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------------------------------------------+ -| Name | Description | Param Type | Data Type | MaxLen | Required | Valid/Example Values | -+========================+=================================+==================+============+==============+=============+==========================================================================+ -| feedId | ID of the feed you are | Path | String | | Y | | -| | publishing to | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------------------------------------------+ -| fileId | Name of the file when it is | Path | String | | Y | | -| | published to subscribers | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------------------------------------------+ -| content-type | To specify type of message | Header | String | | Y | application/octet-stream | -| | format | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------------------------------------------+ -| X-DMAAP-DR-META | Metadata for the file. Accepts | Header | String | 4096 | N | '{"compressionType":"gzip","id": 1234, "transferred":true, "size":null}' | -| | only non nested json objects | | | | | | -| | of the following type : | | | | | | -| | -Numbers | | | | | | -| | -Strings | | | | | | -| | -Lowercase boolean | | | | | | -| | -null | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------------------------------------------+ - -Response/Error Codes -==================== - -+------------------------+---------------------------------+ -| Response statusCode | Response Description | -+========================+=================================+ -| 204 | Successful PUT or DELETE | -+------------------------+---------------------------------+ -| 400 | Failure - Malformed request | -+------------------------+---------------------------------+ -| 401 | Failure - Request was missing | -| | authorization header, or | -| | credentials were not accepted | -+------------------------+---------------------------------+ -| 403 | Failure - User could not be | -| | authenticated, or was not | -| | authorized to make the request | -+------------------------+---------------------------------+ -| 404 | Failure - Path in the request | -| | URL did not point to a valid | -| | feed publishing URL | -+------------------------+---------------------------------+ -| 500 | Failure - DR experienced an | -| | internal problem | -+------------------------+---------------------------------+ -| 503 | Failure - DR is not currently | -| | available | -+------------------------+---------------------------------+ - - -Delete a Published file ------------------------ - -**Description**: Deletes a specified published file - -Request URL -=========== - -http[s]://{host}:{port}/publish/{feedId}/{fileId} - -* {feedId}: Id of the feed you want to delete a published file from -* {fileId}: Id of the published file you want to delete - -Sample Request -============== - -``curl -k -X DELETE --user {user}:{password} --location-trusted https://{host}:{port}/publish/{feedId}/{fileId}`` - -Response/Error Codes -==================== - -+------------------------+---------------------------------+ -| Response statusCode | Response Description | -+========================+=================================+ -| 204 | Successful PUT or DELETE | -+------------------------+---------------------------------+ -| 400 | Failure - Malformed request | -+------------------------+---------------------------------+ -| 401 | Failure - Request was missing | -| | authorization header, or | -| | credentials were not accepted | -+------------------------+---------------------------------+ -| 403 | Failure - User could not be | -| | authenticated, or was not | -| | authorized to make the request | -+------------------------+---------------------------------+ -| 404 | Failure - Path in the request | -| | URL did not point to a valid | -| | feed publishing URL | -+------------------------+---------------------------------+ -| 500 | Failure - DR experienced an | -| | internal problem | -+------------------------+---------------------------------+ -| 503 | Failure - DR is not currently | -| | available | -+------------------------+---------------------------------+ - -Feed logging ------------- - -**Description**: View logging information for specified feeds, which can be narrowed down with further parameters - -Request URL -=========== - -http[s]://{host}:{port}/feedlog/{feedId}?{queryParameter} - -* {feedId} : The id of the feed you want to get logs for -* {queryParameter}: A parameter passed through to narrow the returned logs. Multiple parameters can be passed. - - -Sample Request -============== - -``curl -k https://{host}:{port}/feedlog/{feedId}?statusCode=204`` - -Request parameters -================== - -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| Name | Description | Param Type | Data Type | MaxLen | Required | Valid/Example Values | -+========================+=================================+==================+============+==============+=============+======================================+ -| feedId | Id of the feed you want | Path | String | | Y | 1 | -| | logs for | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| type | Select records of the | Path | String | | N | * pub: Publish attempt | -| | specified type | | | | | * del: Delivery attempt | -| | | | | | | * exp: Delivery expiry | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| publishId | Select records with specified | Path | String | | N | | -| | publish id, carried in the | | | | | | -| | X-DMAAP-DR-PUBLISH-ID header | | | | | | -| | from original publish request | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| start | Select records created at or | Path | String | | N | A date-time expressed in the format | -| | after specified date | | | | | specified by RFC 3339 | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| end | Select records created at or | Path | String | | N | A date-time expressed in the format | -| | before specified date | | | | | specified by RFC 3339 | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| statusCode | Select records with the | Path | String | | N | An HTTP Integer status code or one | -| | specified statusCode field | | | | | of the following special values: | -| | | | | | | | -| | | | | | | * Success: Any code between 200-299 | -| | | | | | | * Redirect: Any code between 300-399 | -| | | | | | | * Failure: Any code > 399 | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| expiryReason | Select records with the | Path | String | | N | | -| | specified expiry reason | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| filename | Select published records with | Path | String | | N | | -| | the specified filename | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ - -Response Parameters -=================== - -+------------------------+----------------------------------------------+ -| Name | Description | -+========================+==============================================+ -| type | Record type: | -| | | -| | * pub: publication attempt | -| | * del: delivery attempt | -| | * exp: delivery expiry | -+------------------------+----------------------------------------------+ -| date | The UTC date and time at which the record | -| | was generated, with millisecond resolution | -| | in the format specified by RFC 3339 | -+------------------------+----------------------------------------------+ -| publishId | The unique identifier assigned by the DR | -| | at the time of the initial publication | -| | request (carried in the X-DMAAP-DR-PUBLISH-ID| -| | header in the response to the original | -| | publish request) | -+------------------------+----------------------------------------------+ -| requestURI | The Request-URI associated with the | -| | request | -+------------------------+----------------------------------------------+ -| method | The HTTP method (PUT or DELETE) for the | -| | request | -+------------------------+----------------------------------------------+ -| contentType | The media type of the payload of the | -| | request | -+------------------------+----------------------------------------------+ -| contentLength | The size (in bytes) of the payload of | -| | the request | -+------------------------+----------------------------------------------+ -| sourceIp | The IP address from which the request | -| | originated | -+------------------------+----------------------------------------------+ -| endpointId | The identity used to submit a publish | -| | request to the DR | -+------------------------+----------------------------------------------+ -| deliveryId | The identity used to submit a delivery | -| | request to a subscriber endpoint | -+------------------------+----------------------------------------------+ -| statusCode | The HTTP status code in the response to | -| | the request. A value of -1 indicates that | -| | the DR was not able to obtain an HTTP | -| | status code | -+------------------------+----------------------------------------------+ -| expiryReason | The reason that delivery attempts were | -| | discontinued: | -| | | -| | * notRetryable: The last delivery attempt | -| | encountered an error condition for which | -| | the DR does not make retries. | -| | * retriesExhausted: The DR reached its | -| | limit for making further retry attempts | -+------------------------+----------------------------------------------+ -| attempts | Total number of attempts made before | -| | delivery attempts were discontinued | -+------------------------+----------------------------------------------+ -| filename | File name associated with a publish record | -+------------------------+----------------------------------------------+ - -Response/Error Codes -==================== - -+------------------------+-------------------------------------------+ -| Response statusCode | Response Description | -+========================+===========================================+ -| 200 | Successful query | -+------------------------+-------------------------------------------+ -| 400 | Bad request - The request is defective in | -| | some way. Possible causes: | -| | | -| | * Unrecognized parameter name in query | -| | string | -| | * Invalid parameter value in query string | -+------------------------+-------------------------------------------+ -| 404 | Not Found - The request was not directed | -| | to a feed log URL or subscription log URL | -| | known to the system | -+------------------------+-------------------------------------------+ -| 405 | Method not allowed - The HTTP method in | -| | the request was something other than GET | -+------------------------+-------------------------------------------+ -| 406 | Not Acceptable - The request has an Accept| -| | header indicating that the requester will | -| | not accept a response with | -| | application/vnd.dmaap-dr.log-list content.| -+------------------------+-------------------------------------------+ -| 500 | Internal Server Error - The DR API server | -| | encountered an internal error and could | -| | not complete the request | -+------------------------+-------------------------------------------+ -| 503 | Service Unavailable - The DR API service | -| | is currently unavailable | -+------------------------+-------------------------------------------+ - - -Subscription logging ------------------- - -**Description**: View logging information for specified subscriptions, which can be narrowed down with further parameters - -Request URL -=========== - -http[s]://{host}:{port}/sublog/{subId}?{queryParameter} - -* {subId}: The id of the feed you want to get logs from -* {queryParameter}: A parameter passed through to narrow the returned logs. Multiple parameters can be passed. - - -Sample Request -============== - -``curl -k https://{host}:{port}/sublog/{subId}?statusCode=204`` - -Request parameters -================== - -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| Name | Description | Param Type | Data Type | MaxLen | Required | Valid/Example Values | -+========================+=================================+==================+============+==============+=============+======================================+ -| subId | Id of the subscription you want | Path | String | | N | 1 | -| | logs for | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| type | Select records of the | Path | String | | N | * pub: Publish attempt | -| | specified type | | | | | * del: Delivery attempt | -| | | | | | | * exp: Delivery expiry | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| publishId | Select records with specified | Path | String | | N | | -| | publish id, carried in the | | | | | | -| | X-DMAAP-DR-PUBLISH-ID header | | | | | | -| | from original publish request | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| start | Select records created at or | Path | String | | N | A date-time expressed in the format | -| | after specified date | | | | | specified by RFC 3339 | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| end | Select records created at or | Path | String | | N | A date-time expressed in the format | -| | before specified date | | | | | specified by RFC 3339 | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| statusCode | Select records with the | Path | String | | N | An Http Integer status code or one | -| | specified statusCode field | | | | | of the following special values: | -| | | | | | | | -| | | | | | | * Success: Any code between 200-299 | -| | | | | | | * Redirect: Any code between 300-399 | -| | | | | | | * Failure: Any code > 399 | -| | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ -| expiryReason | Select records with the | Path | String | | N | | -| | specified expiry reason | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ - -Response Parameters -=================== - -+------------------------+---------------------------------------------+ -| Name | Description | -+========================+=============================================+ -| type | Record type: | -| | | -| | * pub: publication attempt | -| | * del: delivery attempt | -| | * exp: delivery expiry | -+------------------------+---------------------------------------------+ -| date | The UTC date and time at which the record | -| | was generated, with millisecond resolution | -| | in the format specified by RFC 3339 | -+------------------------+---------------------------------------------+ -| publishId | The unique identifier assigned by the DR | -| | at the time of the initial publication | -| | request(carried in the X-DMAAP-DR-PUBLISH-ID| -| | header in the response to the original | -| | publish request) to a feed log URL or | -| | subscription log URL known to the system | -+------------------------+---------------------------------------------+ -| requestURI | The Request-URI associated with the | -| | request | -+------------------------+---------------------------------------------+ -| method | The HTTP method (PUT or DELETE) for the | -| | request | -+------------------------+---------------------------------------------+ -| contentType | The media type of the payload of the | -| | request | -+------------------------+---------------------------------------------+ -| contentLength | The size (in bytes) of the payload of | -| | the request | -+------------------------+---------------------------------------------+ -| sourceIp | The IP address from which the request | -| | originated | -+------------------------+---------------------------------------------+ -| endpointId | The identity used to submit a publish | -| | request to the DR | -+------------------------+---------------------------------------------+ -| deliveryId | The identity used to submit a delivery | -| | request to a subscriber endpoint | -+------------------------+---------------------------------------------+ -| statusCode | The HTTP status code in the response to | -| | the request. A value of -1 indicates that | -| | the DR was not able to obtain an HTTP | -| | status code | -+------------------------+---------------------------------------------+ -| expiryReason | The reason that delivery attempts were | -| | discontinued: | -| | | -| | * notRetryable: The last delivery attempt | -| | encountered an error condition for which | -| | the DR does not make retries. | -| | * retriesExhausted: The DR reached its | -| | limit for making further retry attempts | -+------------------------+---------------------------------------------+ -| attempts | Total number of attempts made before | -| | delivery attempts were discontinued | -+------------------------+---------------------------------------------+ - -Response/Error Codes -==================== - -+------------------------+-------------------------------------------+ -| Response statusCode | Response Description | -+========================+===========================================+ -| 200 | Successful query | -+------------------------+-------------------------------------------+ -| 400 | Bad request - The request is defective in | -| | some way. Possible causes: | -| | | -| | * Unrecognized parameter name in query | -| | string | -| | * Invalid parameter value in query string | -+------------------------+-------------------------------------------+ -| 404 | Not Found - The request was not directed | -| | to a feed log URL or subscription log URL | -| | known to the system | -+------------------------+-------------------------------------------+ -| 405 | Method not allowed - The HTTP method in | -| | the request was something other than GET | -+------------------------+-------------------------------------------+ -| 406 | Not Acceptable - The request has an Accept| -| | header indicating that the requester will | -| | not accept a response with | -| | application/vnd.dmaap-dr.log-list content.| -+------------------------+-------------------------------------------+ -| 500 | Internal Server Error - The DR API server | -| | encountered an internal error and could | -| | could not complete the request | -+------------------------+-------------------------------------------+ -| 503 | Service Unavailable - The DR API service | -| | is currently unavailable | -+------------------------+-------------------------------------------+ diff --git a/docs/data-router/delivery.rst b/docs/data-router/delivery.rst deleted file mode 100644 index 775841a4..00000000 --- a/docs/data-router/delivery.rst +++ /dev/null @@ -1,32 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Delivery -============== - -Data Router is comprised of a datarouter-provisioning container, a datarouter-node container and a mariadb container. - -.. blockdiag:: - - - blockdiag layers { - orientation = portrait - MARIADB -> DR-PROV; - DR-PROV -> DR-NODE; - group l1 { - color = blue; - label = "dr-prov Container"; - DR-PROV; - } - group l2 { - color = yellow; - label = "dr-node Container"; - DR-NODE; - } - group l3 { - color = orange; - label = "MariaDb Container"; - MARIADB; - } - - } diff --git a/docs/data-router/dr_arch.png b/docs/data-router/dr_arch.png deleted file mode 100644 index 54cd7e8d..00000000 Binary files a/docs/data-router/dr_arch.png and /dev/null differ diff --git a/docs/data-router/humaninterfaces.rst b/docs/data-router/humaninterfaces.rst deleted file mode 100644 index 71a2b730..00000000 --- a/docs/data-router/humaninterfaces.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Human Interfaces -================ - -Data Router does not have human interfaces - - - diff --git a/docs/data-router/logging.rst b/docs/data-router/logging.rst deleted file mode 100644 index 6ac7a0a3..00000000 --- a/docs/data-router/logging.rst +++ /dev/null @@ -1,33 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Logging -======= - - -Where to Access Information ---------------------------- -Data Router uses logback framework to generate logs. - -Error / Warning Messages ------------------------- -Currently Data Router does not have any unique error codes. However the following are the common HTTP error codes that -could possibly occur in Data Router: - - OK = 200 : The normal response from a successful update or get of a feed or subscription - - CREATED = 201 : the normal response from successfully creating or subscribing to a feed. - - NO_CONTENT = 204 : the normal response from a successful publish attempt and on successfully deleting a feed or subscription - - MOVED_PERMANENTLY = 301 :the normal redirect response from prov to a publisher - - BAD_REQUEST = 400: Usually indicates that either Json object in request body is incorrect in some way, or an Invalid parameter value was included in query string. - - UNAUTHORIZED = 401 : Usually indicated either request was missing Authorization header, or indicates incorrect Username/password credentials - - FORBIDDEN = 403 : Usually indicates the request originated from an unauthorized IP address, or that a client certificate was not a part of authorized list. - - NOT_FOUND = 404 : Usually indicates an incorrect URI - - METHOD_NOT_ALLOWED = 405 : Indicates an HTTP method is not accepted for given URI \ No newline at end of file diff --git a/docs/data-router/release-notes.rst b/docs/data-router/release-notes.rst deleted file mode 100644 index b879c6bc..00000000 --- a/docs/data-router/release-notes.rst +++ /dev/null @@ -1,153 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Release-notes -============== -Version: 1.0.3 (Casablanca) ---------------------------- - -:Release Date: 2018-11-30 - -The DataRouter(DR) provisioning API is a HTTPS-based, REST-like API for creating and managing DR feeds and -subscriptions. - -New Features: - -+--------------+------------------------------------------------------------------+ -| JIRA ID | Description | -+==============+==================================================================+ -| DMAAP-20 | REST api for publishing data to DR | -+--------------+------------------------------------------------------------------+ -| DMAAP-21 | REST api for subscribing to data in DR | -+--------------+------------------------------------------------------------------+ - -Bug Fixes: - -+----------------+---------------------------------------------------------------------------------------------------------------------------------+ -| JIRA ID | Description | -+================+=================================================================================================================================+ -| DMAAP-877 | DR Logging API not storing Feed/Sub data | -+----------------+---------------------------------------------------------------------------------------------------------------------------------+ -| DMAAP-850 | Second subscriber not receiving the published file | -+----------------+---------------------------------------------------------------------------------------------------------------------------------+ -| DMAAP-596 | DR - datarouter-prov container fails to come up successfully | -+----------------+---------------------------------------------------------------------------------------------------------------------------------+ -| DMAAP-565 | Incorrect nexusUrl parameter in datarouter pom files | -+----------------+---------------------------------------------------------------------------------------------------------------------------------+ - -Known Issues -N/A - -Security Issues -DMAAP code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been -addressed, items that remain open have been assessed for risk and determined to be false positive. The DMAAP open -Critical security vulnerabilities and their risk assessment have been documented as part of the `project `_. - -- `DMAAP Project Page `_ -- `Passing Badge information for DMAAP DataRouter `_ -- `Project Vulnerability Review Table for DMAAP `_ - -Upgrade Notes -N/A - -Deprecation Notes -N/A - -Other -N/A - -Version: 1.0.8 (Casablanca) ---------------------------- - -:Release Date: 2019-02-28 - -The DataRouter(DR) provisioning API is a HTTPS-based, REST-like API for creating and managing DR feeds and -subscriptions. - -New Features: - -+--------------+------------------------------------------------------------------+ -| JIRA ID | Description | -+==============+==================================================================+ -+--------------+------------------------------------------------------------------+ - -Bug Fixes: - -+----------------+--------------------------------------------------------------------------------------------------+ -| JIRA ID | Description | -+================+==================================================================================================+ -| DMAAP-1065 | [DR] Casablanca - AAF certs expired on dmaap-dr-prov and dmaap-dr-node | -+----------------+--------------------------------------------------------------------------------------------------+ - -Known Issues -N/A - -Security Issues -DMAAP code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been -addressed, items that remain open have been assessed for risk and determined to be false positive. The DMAAP open -Critical security vulnerabilities and their risk assessment have been documented as part of the `project `_. - -- `DMAAP Project Page `_ -- `Passing Badge information for DMAAP DataRouter `_ -- `Project Vulnerability Review Table for DMAAP `_ - -Upgrade Notes -N/A - -Deprecation Notes -N/A - -Other -N/A - - -Version: 2.0.1 (Dublin) ---------------------------- - -:Release Date: 2019-02-28 - -The DataRouter(DR) provisioning API is a HTTPS-based, REST-like API for creating and managing DR feeds and -subscriptions. - -New Features: - -+--------------+------------------------------------------------------------------+ -| JIRA ID | Description | -+==============+==================================================================+ -| DMAAP-988 | Update to new oparent | -+--------------+------------------------------------------------------------------+ - -Bug Fixes: - -+----------------+--------------------------------------------------------------------------------------------------+ -| JIRA ID | Description | -+================+==================================================================================================+ -| DMAAP-964 | DMAAP deployment failures starting 20190115 on casablanca branch | -+----------------+--------------------------------------------------------------------------------------------------+ -| DMAAP-1047 | Data Router docker version missing explicit version number | -+----------------+--------------------------------------------------------------------------------------------------+ -| DMAAP-1048 | [DR] AAF certs expired on dmaap-dr-prov and dmaap-dr-node | -+----------------+--------------------------------------------------------------------------------------------------+ -| DMAAP-1064 | [DR] Update datarouter POM version following AAF cert updates | -+----------------+--------------------------------------------------------------------------------------------------+ - -Known Issues -N/A - -Security Issues -DMAAP code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been -addressed, items that remain open have been assessed for risk and determined to be false positive. The DMAAP open -Critical security vulnerabilities and their risk assessment have been documented as part of the `project `_. - -- `DMAAP Project Page `_ -- `Passing Badge information for DMAAP DataRouter `_ -- `Project Vulnerability Review Table for DMAAP `_ - -Upgrade Notes -N/A - -Deprecation Notes -N/A - -Other -N/A \ No newline at end of file -- cgit 1.2.3-korg