-
Notifications
You must be signed in to change notification settings - Fork 0
Closed
Labels
bugSomething isn't workingSomething isn't workingdocumentationImprovements or additions to documentationImprovements or additions to documentation
Description
Problem
During testing of the Redis Cloud API quick start guide, we discovered several incorrect endpoint references in the documentation and potentially in the code:
1. Account Endpoint Issue
- Documented as:
/account - Actually is:
/(root endpoint) - The account information is retrieved from the root endpoint, not
/account - Test confirmed:
redisctl api cloud get /returns account info with fields likeaccount.idandaccount.name
2. Database Stats/Metrics Endpoints Don't Exist
- Documented as:
/subscriptions/{id}/databases/{db_id}/stats/subscriptions/{id}/databases/{db_id}/stats/last/subscriptions/{id}/databases/{db_id}/metrics/subscriptions/{id}/databases/{db_id}/metrics/last
- Reality: These endpoints return 404 errors
- Actual metrics location: Metrics data is included directly in the database details response from
/subscriptions/{id}/databases/{db_id}- Fields include:
memoryUsedInMb,datasetSizeInGb,memoryLimitInGb,throughputMeasurement
- Fields include:
Affected Files to Check
Based on grep results, these files may contain incorrect references:
docs/src/common-features/raw-api.mddocs/src/developer/libraries.md- Any Cloud API handler code that references these endpoints
- Test files that mock these endpoints
Action Items
- Search for all references to
/accountendpoint in Cloud API context - Search for all references to database stats/metrics endpoints
- Update documentation to use correct endpoints
- Update any code that references these incorrect endpoints
- Update tests if they mock these non-existent endpoints
- Verify no commands are trying to use these endpoints
Test Commands to Verify
# Correct - returns account info
redisctl api cloud get /
# Incorrect - would need to be fixed if referenced
redisctl api cloud get /account # This doesn't exist
# Correct - database details include metrics
redisctl api cloud get /subscriptions/123/databases/456
# Incorrect - these return 404
redisctl api cloud get /subscriptions/123/databases/456/stats
redisctl api cloud get /subscriptions/123/databases/456/stats/lastMetadata
Metadata
Assignees
Labels
bugSomething isn't workingSomething isn't workingdocumentationImprovements or additions to documentationImprovements or additions to documentation