From c14d957c447559f67bb06ac417d4d54af897908b Mon Sep 17 00:00:00 2001 From: Emmett Cox Date: Wed, 14 Nov 2018 17:00:18 +0000 Subject: [PATCH] Documentation fixes Change-Id: Ia8f0abc90b031b7769ef229302658fd0a1b79491 Signed-off-by: Emmett Cox Issue-ID: DMAAP-881 --- docs/data-router/data-router.rst | 386 ++++++++++++++++++++------------------- docs/data-router/logging.rst | 8 + 2 files changed, 205 insertions(+), 189 deletions(-) diff --git a/docs/data-router/data-router.rst b/docs/data-router/data-router.rst index aaee3851..39d61e1c 100755 --- a/docs/data-router/data-router.rst +++ b/docs/data-router/data-router.rst @@ -54,36 +54,36 @@ Create a Feed Sample Request ============== -curl -v -X POST -H "Content-Type: application/vnd.att-dr.feed" -H "X-ATT-DR-ON-BEHALF-OF: {user}" --data-ascii @/opt/app/datartr/addFeed3.txt --post301 --location-trusted -k https:/{host}:{port} +``curl -v -X POST -H "Content-Type: application/vnd.att-dr.feed" -H "X-ATT-DR-ON-BEHALF-OF: {user}" --data-ascii @/opt/app/datartr/addFeed3.txt --post301 --location-trusted -k https:/{host}:{port}`` Request Parameters: =================== -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| Name | Description | Param Type | Data Type | MaxLen | Required | Format | Valid/Example Values | -+========================+=================================+==================+============+==============+=============+=====================+======================================+ -| name | Feed name | Body | String | <=20 | Y | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| version | Feed version | Body | String | <=20 | Y | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| description | Feed description | Body | String | | Y | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| business description | Business description | Body | String | | 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 | 20 | N | | application/vnd.att-dr.feed | -| | (feed,subscriber,publisher) | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| X-ATT-DR-ON-BEHALF-OF | User id of owner of feed | Header | String | 1 | N | | username | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| 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.att-dr.feed | +| | (feed,subscriber,publisher) | | | | | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| X-ATT-DR-ON-BEHALF-OF | User id of owner of feed | Header | String | 8 | Y | username | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ Response/Error Codes ==================== @@ -161,7 +161,7 @@ Sample Body ] }, -} + } Updating a Feed --------------- @@ -171,32 +171,32 @@ Updating a Feed Sample Request ============== -curl -v -X PUT -H "Content-Type: application/vnd.att-dr.feed" -H "X-ATT-DR-ON-BEHALF-OF: {user}" --data-ascii @/opt/app/datartr/addFeed3.txt --location-trusted -k https:/{host}:{port} +``curl -v -X PUT -H "Content-Type: application/vnd.att-dr.feed" -H "X-ATT-DR-ON-BEHALF-OF: {user}" --data-ascii @/opt/app/datartr/addFeed3.txt --location-trusted -k https:/{host}:{port}`` Request Parameters: =================== -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| Name | Description | Param Type | Data Type | MaxLen | Required | Format | Valid/Example Values | -+========================+=================================+==================+============+==============+=============+=====================+======================================+ -| description | Feed description | Body | String | | Y | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| business description | Business description | Body | String | | 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 | 20 | N | | application/vnd.att-dr.feed | -| | (feed,subscriber,publisher) | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| X-ATT-DR-ON-BEHALF-OF | User id of owner of feed | Header | String | 1 | N | | username | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| 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.att-dr.feed | +| | (feed,subscriber,publisher) | | | | | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| X-ATT-DR-ON-BEHALF-OF | User id of owner of feed | Header | String | 8 | Y | username | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ Response/Error Codes ==================== @@ -274,7 +274,7 @@ Sample Body ] }, -} + } Get a Feed ---------- @@ -291,7 +291,7 @@ http[s]://{host}:{port}/feed/{feedId} Sample Request ============== -curl -v -X GET -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/feed/{feedId} +``curl -v -X GET -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/feed/{feedId}`` Response/Error Codes ==================== @@ -352,7 +352,7 @@ http[s]://{host}:{port}/feed/{feedId} Sample Request ============== -curl -v -X DELETE -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/feed/{feedId} +``curl -v -X DELETE -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/feed/{feedId}`` Response/Error Codes ==================== @@ -412,37 +412,37 @@ http[s]://{host}:{port}/subscribe/{feedId} Sample Request ============== -curl -v -X POST -H "Content-Type: application/vnd.att-dr.subscription" -H "X-ATT-DR-ON-BEHALF-OF: {user}" --data-ascii @/opt/app/datartr/addSubscriber.txt --post301 --location-trusted -k https://{host}:{port}/subscribe/{feedId} +``curl -v -X POST -H "Content-Type: application/vnd.att-dr.subscription" -H "X-ATT-DR-ON-BEHALF-OF: {user}" --data-ascii @/opt/app/datartr/addSubscriber.txt --post301 --location-trusted -k https://{host}:{port}/subscribe/{feedId}`` Request Parameters: =================== -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| Name | Description | Param Type | Data Type | MaxLen | Required | Format | 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 | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| group-id | | Body | Integer | | Y | | | -| | | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| content-type | To specify type of message | Header | String | 20 | N | | application/vnd.att-dr.subscription | -| | (feed,subscriber,publisher) | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| X-ATT-DR-ON-BEHALF-OF | User id of subscriber | Header | String | 1 | N | | username | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| 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 | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| group-id | | Body | Integer | | Y | | +| | | | | | | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| content-type | To specify type of message | Header | String | | Y | application/vnd.att-dr.subscription | +| | (feed,subscriber,publisher) | | | | | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| X-ATT-DR-ON-BEHALF-OF | User id of subscriber | Header | String | 8 | Y | username | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ Response/Error Codes ==================== @@ -511,7 +511,7 @@ Sample Body "groupid" : 29, "subscriber" : "subscriber123" -} + } Update subscription ------------------- @@ -526,37 +526,37 @@ http[s]://{host}:{port}/subscribe/{feedId} Sample Request ============== -curl -v -X PUT -H "Content-Type: application/vnd.att-dr.subscription" -H "X-ATT-DR-ON-BEHALF-OF: {user}" --data-ascii @/opt/app/datartr/addSubscriber.txt --location-trusted -k https://{host}:{port}/subscribe/{feedId} +``curl -v -X PUT -H "Content-Type: application/vnd.att-dr.subscription" -H "X-ATT-DR-ON-BEHALF-OF: {user}" --data-ascii @/opt/app/datartr/addSubscriber.txt --location-trusted -k https://{host}:{port}/subscribe/{feedId}`` Request Parameters: =================== -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| Name | Description | Param Type | Data Type | MaxLen | Required | Format | Valid/Example Values | -+========================+=================================+==================+============+==============+=============+=====================+======================================+ -| feedId | 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 | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| group-id | | Body | Integer | | Y | | | -| | | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| content-type | To specify type of message | Header | String | 20 | N | | application/vnd.att-dr.subscription | -| | (feed,subscriber,publisher) | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| X-ATT-DR-ON-BEHALF-OF | User id of subscriber | Header | String | 1 | N | | username | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| Name | Description | Param Type | Data Type | MaxLen | Required | Valid/Example Values | ++========================+=================================+==================+============+==============+=============+======================================+ +| feedId | 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 | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| group-id | | Body | Integer | | Y | | +| | | | | | | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| content-type | To specify type of message | Header | String | | Y | application/vnd.att-dr.subscription | +| | (feed,subscriber,publisher) | | | | | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| X-ATT-DR-ON-BEHALF-OF | User id of subscriber | Header | String | 8 | Y | username | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ Response/Error Codes ==================== @@ -625,7 +625,7 @@ Sample Body "groupid" : 29, "subscriber" : "subscriber123" -} + } Get a Subscription @@ -643,7 +643,7 @@ http[s]://{host}:{port}/subscribe/{subId} Sample Request ============== -curl -v -X GET -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/subscribe/{subId} +``curl -v -X GET -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/subscribe/{subId}`` Response/Error Codes ==================== @@ -704,7 +704,7 @@ http[s]://{host}:{port}/feed/{feedId} Sample Request ============== -curl -v -X DELETE -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/subscribe/{feedId} +``curl -v -X DELETE -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/subscribe/{feedId}`` Response/Error Codes ==================== @@ -767,18 +767,26 @@ http[s]://{host}:{port}/publish/{feedId}/{fileName} Request parameters ================== -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| Name | Description | Param Type | Data Type | MaxLen | Required | Format | 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 | 20 | N | | application/octet-stream | -| | format | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------------------------------------------+ +| 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-ATT-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 ==================== @@ -812,7 +820,7 @@ Response/Error Codes Sample Request ============== -curl -v -X PUT --user {user}:{password} -H "Content-Type: application/octet-stream" --data-binary @/opt/app/datartr/sampleFile.txt --post301 --location-trusted -k https://{host}:{port}/publish/{feedId}/sampleFile.txt +``curl -v -X PUT --user {user}:{password} -H "Content-Type: application/octet-stream" -H X-ATT-DR-META:'{"filetype":"zip"}' --data-binary @/opt/app/datartr/sampleFile.txt --post301 --location-trusted -k https://{host}:{port}/publish/{feedId}/sampleFile.txt`` Delete a Published file ----------------------- @@ -830,7 +838,7 @@ http[s]://{host}:{port}/publish/{feedId}/{fileId} Sample Request ============== -curl -v -X DELETE -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/publish/{feedId}/{fileId} +``curl -v -X DELETE -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/publish/{feedId}/{fileId}`` Response/Error Codes ==================== @@ -878,37 +886,37 @@ http[s]://{host}:{port}/feedlog/{feedId}?{queryParameter} Request parameters ================== -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| Name | Description | Param Type | Data Type | MaxLen | Required | Format | Valid/Example Values | -+========================+=================================+==================+============+==============+=============+=====================+======================================+ -| feedId | Id of the feed you want | Path | String | | N | | 1 | -| | logs from | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| 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-ATT-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 | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| Name | Description | Param Type | Data Type | MaxLen | Required | Valid/Example Values | ++========================+=================================+==================+============+==============+=============+======================================+ +| feedId | Id of the feed you want | Path | String | | N | 1 | +| | logs from | | | | | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| 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-ATT-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 =================== @@ -1009,7 +1017,7 @@ Response/Error Codes Sample Request ============== -curl -v -k https://{host}:{port}/feedlog/{feedId}?statusCode=204 +``curl -v -k https://{host}:{port}/feedlog/{feedId}?statusCode=204`` Subscriber logging ------------------ @@ -1028,38 +1036,38 @@ http[s]://{host}:{port}/sublog/{subId}?{queryParameter} Request parameters ================== -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| Name | Description | Param Type | Data Type | MaxLen | Required | Format | Valid/Example Values | -+========================+=================================+==================+============+==============+=============+=====================+======================================+ -| subId | Id of the feed you want | Path | String | | N | | 1 | -| | logs from | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| 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-ATT-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 | -| | | | | | | | * Sedirect: Any code between 300-399 | -| | | | | | | | * Sailure: Any code > 399 | -| | | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| expiryReason | Select records with the | Path | String | | N | | | -| | specified expiry reason | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| Name | Description | Param Type | Data Type | MaxLen | Required | Valid/Example Values | ++========================+=================================+==================+============+==============+=============+======================================+ +| subId | Id of the feed you want | Path | String | | N | 1 | +| | logs from | | | | | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| 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-ATT-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 =================== @@ -1161,4 +1169,4 @@ Response/Error Codes Sample Request ============== -curl -v -k https://{host}:{port}/sublog/{subscriberId}?statusCode=204 \ No newline at end of file +``curl -v -k https://{host}:{port}/sublog/{subscriberId}?statusCode=204`` diff --git a/docs/data-router/logging.rst b/docs/data-router/logging.rst index ac6aa95c..6ac7a0a3 100644 --- a/docs/data-router/logging.rst +++ b/docs/data-router/logging.rst @@ -15,11 +15,19 @@ Currently Data Router does not have any unique error codes. However the followin 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 -- 2.16.6