From 71d7b53e921499a577db8143f2e6a41f8963ea75 Mon Sep 17 00:00:00 2001 From: Hannah Hunter Date: Mon, 31 Jul 2023 16:01:15 -0400 Subject: [PATCH] pull changes from config PR Signed-off-by: Hannah Hunter --- .../en/reference/api/configuration_api.md | 30 +++++++++++++++---- 1 file changed, 24 insertions(+), 6 deletions(-) diff --git a/daprdocs/content/en/reference/api/configuration_api.md b/daprdocs/content/en/reference/api/configuration_api.md index a1d8784724e..3fe4ed283ea 100644 --- a/daprdocs/content/en/reference/api/configuration_api.md +++ b/daprdocs/content/en/reference/api/configuration_api.md @@ -21,7 +21,7 @@ GET http://localhost:/v1.0/configuration/ 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 @@ -83,7 +83,7 @@ GET http://localhost:/v1.0/configuration//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 @@ -149,7 +149,7 @@ GET http://localhost:/v1.0/configuration// 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 @@ -172,7 +172,7 @@ Code | Description #### Response Body -``` +```json { "ok" : true } @@ -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": "" +} ``` ## Optional application (user code) routes @@ -201,7 +219,7 @@ POST http://localhost:/configuration// 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