-
Notifications
You must be signed in to change notification settings - Fork 298
Update Redis Enterprise openapi spec #2615
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
|
redis-enterprise-doc-sync[bot] seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
rrelledge
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you, this looks great! I just left a few small comments related to some example requests/responses.
| "x-stability-level": "stable" | ||
| } | ||
| }, | ||
| "/v1/users/permissions/{role}": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the staged preview, the response example for GET /v1/users/permissions/{role} currently shows:
{
"admin": {
"api_permissions": [
"create_node",
"update_node",
"delete_node"
],
"ui_permissions": [
"view_cluster_page",
"view_database_page"
]
},
"db_viewer": {
"api_permissions": [
"view_bdb_info",
"view_all_bdbs_info"
],
"ui_permissions": [
"view_database_page"
]
}
}Shouldn't the example for this one show only one role, such as admin instead of both admin and db_viewer?
| "x-stability-level": "stable" | ||
| }, | ||
| "put": { | ||
| "description": "Update a user configuration by unique ID", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For PUT /v1/users/{uid}, the name and email_alerts fields in the example request do not match the example response, which might be confusing.
Request:
{
"email_alerts": false,
"name": "Jane Poe"
}Response:
{
"auth_method": "regular",
"email": "user@redis.com",
"email_alerts": true,
"last_login": 1760618047,
"name": "John Doe",
"password_issue_date": "2025-03-02T09:43:34Z",
"role_uids": [
1
],
"status": "active"
}
Daily sync found updated API definitions.