dapr
/
docs
mirror of https://github.com/dapr/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix Configuration API unsubscribe endpoint (#2797) 

* fix unsubscribe path

Signed-off-by: Sarthak Sharma <sartsharma@microsoft.com>

* maintain punctuation uniformity

Signed-off-by: Sarthak Sharma <sartsharma@microsoft.com>

* maintain punctuation uniformity

Signed-off-by: Sarthak Sharma <sartsharma@microsoft.com>

* Update configuration_api.md

Making examples consistent

Signed-off-by: Mark Fussell <markfussell@gmail.com>

Signed-off-by: Sarthak Sharma <sartsharma@microsoft.com>
Signed-off-by: Mark Fussell <markfussell@gmail.com>
Co-authored-by: Mark Fussell <markfussell@gmail.com>
This commit is contained in:
Sarthak Sharma 2022-09-27 10:28:54 +05:30 committed by GitHub
parent a70b666c9c
commit 1bbdb328bb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
daprdocs/content/en/reference/api/configuration_api.md
View File

@ -21,7 +21,7 @@ GET http://localhost:<daprPort>/v1.0-alpha1/configuration/<storename>
Parameter | Description Parameter | Description
--------- | ----------- --------- | -----------
`daprPort` | The Dapr port `daprPort` | The Dapr port
`storename` | The `metadata.name` field component file. Refer to the [component schema] ({{< ref component-schema.md>}}) `storename` | The `metadata.name` field component file. Refer to the [component schema]({{< ref component-schema.md>}})
#### Query Parameters #### Query Parameters
@ -83,7 +83,7 @@ GET http://localhost:<daprPort>/v1.0-alpha1/configuration/<storename>/subscribe
Parameter | Description Parameter | Description
--------- | ----------- --------- | -----------
`daprPort` | The Dapr port `daprPort` | The Dapr port
`storename` | The `metadata.name` field component file. Refer to the [component schema] ({{< ref component-schema.md>}}) `storename` | The `metadata.name` field component file. Refer to the [component schema]({{< ref component-schema.md>}})
#### Query Parameters #### Query Parameters
@ -141,7 +141,7 @@ This endpoint lets you unsubscribe to configuration changes.
### HTTP Request ### HTTP Request
``` ```
GET http://localhost:<daprPort>/v1.0-alpha1/configuration/<subscription-id>/unsubscribe GET http://localhost:<daprPort>/v1.0-alpha1/configuration/<storename>/<subscription-id>/unsubscribe
``` ```
#### URL Parameters #### URL Parameters
@ -149,6 +149,7 @@ GET http://localhost:<daprPort>/v1.0-alpha1/configuration/<subscription-id>/unsu
Parameter | Description Parameter | Description
--------- | ----------- --------- | -----------
`daprPort` | The Dapr port `daprPort` | The Dapr port
`storename` | The `metadata.name` field component file. Refer to the [component schema]({{< ref component-schema.md>}})
`subscription-id` | The value from the `id` field returned from the response of the subscribe endpoint `subscription-id` | The value from the `id` field returned from the response of the subscribe endpoint
#### Query Parameters #### Query Parameters
@ -165,18 +166,22 @@ None
Code | Description Code | Description
---- | ----------- ---- | -----------
`204` | Unsubscribe operation successful `200` | Unsubscribe operation successful
`400` | Configuration store is missing or misconfigured or malformed request `400` | Configuration store is missing or misconfigured or malformed request
`500` | Failed to unsubscribe to configuration changes `500` | Failed to unsubscribe to configuration changes
#### Response Body #### Response Body
None ```
{
"ok" : true
}
```
### Example ### Example
```shell ```shell
curl -X GET 'http://localhost:3500/v1.0-alpha1/configuration/bf3aa454-312d-403c-af95-6dec65058fa2/unsubscribe' curl -X GET 'http://localhost:3500/v1.0-alpha1/configuration/mystore/bf3aa454-312d-403c-af95-6dec65058fa2/unsubscribe'
``` ```
## Optional application (user code) routes ## Optional application (user code) routes
@ -196,7 +201,7 @@ POST http://localhost:<appPort>/configuration/<store-name>/<key>
Parameter | Description Parameter | Description
--------- | ----------- --------- | -----------
`appPort` | The application port `appPort` | The application port
`storename` | The `metadata.name` field component file. Refer to the [component schema] ({{< ref component-schema.md>}}) `storename` | The `metadata.name` field component file. Refer to the [component schema]({{< ref component-schema.md>}})
`key` | The key subscribed to `key` | The key subscribed to
#### Request Body #### Request Body
@ -231,4 +236,4 @@ A list of configuration items for a given subscription id. Configuration items c
## Next Steps ## Next Steps
- [Configuration API overview]({{< ref configuration-api-overview.md >}}) - [Configuration API overview]({{< ref configuration-api-overview.md >}})
- [How-To: Manage configuration from a store]({{< ref howto-manage-configuration.md >}}) - [How-To: Manage configuration from a store]({{< ref howto-manage-configuration.md >}})