Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[config api] Pull changes from config PR #3653

Merged
merged 2 commits into from
Jul 31, 2023
Merged

[config api] Pull changes from config PR #3653

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
71d7b53
pull changes from config PR
hhunter-ms Jul 31, 2023
363ceaa
Merge branch 'v1.11' into pull_2731
msfussell Jul 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 24 additions & 6 deletions daprdocs/content/en/reference/api/configuration_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ GET http://localhost:<daprPort>/v1.0/configuration/<storename>
Parameter | Description
--------- | -----------
`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

Expand Down Expand Up @@ -83,7 +83,7 @@ GET http://localhost:<daprPort>/v1.0/configuration/<storename>/subscribe
Parameter | Description
--------- | -----------
`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

Expand Down Expand Up @@ -149,7 +149,7 @@ GET http://localhost:<daprPort>/v1.0/configuration/<storename>/<subscription-id>
Parameter | Description
--------- | -----------
`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

#### Query Parameters
Expand All @@ -172,7 +172,7 @@ Code | Description

#### Response Body

```
```json
{
"ok" : true
}
Expand All @@ -181,7 +181,25 @@ Code | Description
### Example

```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
Expand All @@ -201,7 +219,7 @@ POST http://localhost:<appPort>/configuration/<store-name>/<key>
Parameter | Description
--------- | -----------
`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

#### Request Body
Expand Down
Loading