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

Merge pull request #3653 from hhunter-ms/pull_2731 

[config api] Pull changes from config PR
This commit is contained in:
Hannah Hunter 2023-07-31 18:13:07 -04:00 committed by GitHub
parent f820097287 363ceaa4e7
commit cfaceb9207
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -21,7 +21,7 @@ GET http://localhost:<daprPort>/v1.0/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 spec]({{< ref component-schema.md>}})
#### Query Parameters #### Query Parameters
@ -83,7 +83,7 @@ GET http://localhost:<daprPort>/v1.0/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 spec]({{< ref component-schema.md>}})
#### Query Parameters #### Query Parameters
@ -149,7 +149,7 @@ GET http://localhost:<daprPort>/v1.0/configuration/<storename>/<subscription-id>
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 spec]({{< 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
@ -172,7 +172,7 @@ Code | Description
#### Response Body #### Response Body
``` ```json
{ {
"ok" : true "ok" : true
} }
@ -181,7 +181,25 @@ Code | Description
### Example ### Example
```shell ```shell
curl -X GET 'http://localhost:3500/v1.0/configuration/mystore/bf3aa454-312d-403c-af95-6dec65058fa2/unsubscribe' curl -X GET 'http://localhost:3500/v1.0-alpha1/configuration/mystore/bf3aa454-312d-403c-af95-6dec65058fa2/unsubscribe'
```
> The above command returns the following JSON:
In case of successful operation:
```json
{
"ok": true
}
```
In case of unsuccessful operation:
```json
{
"ok": false,
"message": "<dapr returned error message>"
}
``` ```
## Optional application (user code) routes ## Optional application (user code) routes
@ -201,7 +219,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 spec]({{< ref component-schema.md>}})
`key` | The key subscribed to `key` | The key subscribed to
#### Request Body #### Request Body