Merge pull request #3653 from hhunter-ms/pull_2731

[config api] Pull changes from config PR
dapr · Jul 31, 2023 · cfaceb9 · cfaceb9
2 parents f820097 + 363ceaa
commit cfaceb9
Showing 1 changed file with 24 additions and 6 deletions.
diff --git 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:<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
 
@@ -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
 
@@ -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
@@ -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": "<dapr returned error message>"
+}
 ```
 
 ## Optional application (user code) routes
@@ -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