Skip to content

chore: update cluster docs#1509

Merged
danielamiao merged 3 commits intomainfrom
dym/update-cluster-docs
Mar 6, 2026
Merged

chore: update cluster docs#1509
danielamiao merged 3 commits intomainfrom
dym/update-cluster-docs

Conversation

@danielamiao
Copy link
Contributor

No description provided.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the Momento Valkey cluster HTTP API documentation to reflect the newer /ec-cluster control-plane endpoints and adds coverage for additional cluster mutation operations.

Changes:

  • Updates Create/Delete/List endpoint paths and request/response shapes to use /ec-cluster and a name field in the create payload.
  • Adds new endpoint documentation for Describe Cluster and for update operations (replication group, shard config, replica count changes).
  • Expands the Examples section with curl commands for the new/updated endpoints.
Comments suppressed due to low confidence (1)

docs/valkey/http-api.md:566

  • Under # Examples, several headings duplicate earlier endpoint headings (e.g., ## Describe Cluster, ## List Clusters). This typically leads to duplicate entries in the rendered table-of-contents and auto-generated anchor IDs with suffixes (e.g., describe-cluster vs describe-cluster-1), which makes deep-linking harder. Consider renaming the example headings (e.g., "Describe Cluster (Example)") or otherwise differentiating them from the API reference headings.
## Describe Cluster

Get details for a specific cluster:

```bash
curl -H "Authorization: <token>" \
  "https://api.cache.cell-1-us-east-1-1.prod.a.momentohq.com/ec-cluster/my-cluster"

List Clusters

</details>



---

💡 <a href="/momentohq/public-dev-docs/new/main?filename=.github/instructions/*.instructions.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add Copilot custom instructions</a> for smarter, more guided reviews. <a href="https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn how to get started</a>.

@danielamiao danielamiao requested a review from rlinehan March 6, 2026 07:32
Comment on lines 94 to 118
@@ -99,24 +102,31 @@ Creates a new Valkey Cluster or updates an existing one with the specified confi
"shard_index": 0,
"availability_zone": "us-east-1a",
"replica_availability_zones": ["us-east-1b", "us-east-1c"]
},
{
"shard_index": 1,
"availability_zone": "us-east-1a",
"replica_availability_zones": ["us-east-1b", "us-east-1c"]
},
{
"shard_index": 2,
"availability_zone": "us-east-1a",
"replica_availability_zones": ["us-east-1b", "us-east-1c"]
}
],
"status": "Creating",
"errors": []
"status": "Creating"
}
Copy link
Contributor

@anp13 anp13 Mar 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not what we will see in response for Creating. This is a sample response for Creating now:

{
  "name": "test-ec-clusters",
  "enforce_shard_multi_az": true,
  "shard_count": 0,
  "replication_factor": 0,
  "shard_placements": [],
  "node_instance_type": "cache.m6g.xlarge",
  "status": "Creating"
}

I think we should not return any response for Create because it is weird that the fields are wiped out in the response. But today we return this.

Comment on lines 252 to +583
@@ -265,28 +575,101 @@ curl -X PUT -H "Authorization: <token>" \
},
{
"shard_index": 1,
"availability_zone": "us-east-1b",
"replica_availability_zones": ["us-east-1a", "us-east-1c"]
"availability_zone": "us-east-1a",
"replica_availability_zones": ["us-east-1b", "us-east-1c"]
}
]
}' \
"https://api.cache.cell-1-us-east-1-1.prod.a.momentohq.com/cluster/my-cluster"
"https://api.cache.cell-1-us-east-1-1.prod.a.momentohq.com/ec-cluster"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: May be we should update this example to have 3 shards since the update shard config example assumes that we are starting with 3 shards and going to 5.

@danielamiao danielamiao requested a review from anp13 March 6, 2026 17:20
@danielamiao danielamiao merged commit 0bea39e into main Mar 6, 2026
4 checks passed
@danielamiao danielamiao deleted the dym/update-cluster-docs branch March 6, 2026 17:39
@danielamiao danielamiao restored the dym/update-cluster-docs branch March 6, 2026 18:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants