Skip to content

Commit 1c554ba

Browse files
authored
docs: minor status updates (#1510)
* docs: update Create response to 204 No Content (mr2rs PR #2932) * docs: fix Create response to 202 Accepted per mr2rs main * docs: update Delete Object Store response to 204 No Content (mr2rs PR #2933) * docs: fix Delete Cluster response to 202 Accepted per mr2rs main
1 parent 0bea39e commit 1c554ba

File tree

2 files changed

+5
-25
lines changed

2 files changed

+5
-25
lines changed

docs/objectstore/http-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ Deletes an object store.
244244

245245
#### Success
246246

247-
*Status Code: 200 OK*
247+
*Status Code: 204 No Content*
248248

249249
- The object store was successfully deleted.
250250

docs/valkey/http-api.md

Lines changed: 4 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -88,29 +88,9 @@ Creates a new Valkey Cluster with the specified configuration.
8888

8989
#### Success
9090

91-
*Status Code: 201 Created*
92-
93-
```json
94-
{
95-
"name": "my-cluster",
96-
"node_instance_type": "cache.m6g.large",
97-
"shard_count": 0,
98-
"replication_factor": 0,
99-
"enforce_shard_multi_az": true,
100-
"shard_placements": [],
101-
"status": "Creating"
102-
}
103-
```
91+
*Status Code: 202 Accepted*
10492

105-
| Field | Type | Description |
106-
|-------|------|-------------|
107-
| name | String | The name of the cluster. |
108-
| node_instance_type | String | The instance type for cluster nodes. |
109-
| shard_count | Integer | The number of shards. |
110-
| replication_factor | Integer | The number of replicas per shard. |
111-
| enforce_shard_multi_az | Boolean | Whether multi-AZ placement is enforced. |
112-
| shard_placements | Array | The placement configuration for each shard. |
113-
| status | String | The cluster status: `Creating`, `CreationFailed`, `Active`, `Updating`, or `Deleting`. |
93+
- The cluster creation has been accepted and is being processed asynchronously. Use the [Describe Cluster](#describe-cluster) endpoint to poll until the cluster status is `Active`.
11494

11595
#### Error
11696

@@ -271,9 +251,9 @@ Deletes a Valkey Cluster.
271251

272252
#### Success
273253

274-
*Status Code: 204 No Content*
254+
*Status Code: 202 Accepted*
275255

276-
- The cluster was successfully deleted.
256+
- The cluster deletion has been accepted and is being processed asynchronously.
277257

278258
#### Error
279259

0 commit comments

Comments
 (0)