Skip to content

Update Redis Enterprise openapi spec #2827

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.

Sign up for GitHub

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

Merged
rrelledge merged 1 commit into from
Feb 26, 2026
Merged

Update Redis Enterprise openapi spec #2827

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
190 changes: 131 additions & 59 deletions content/operate/rs/references/rest-api/api-reference/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,75 +1,75 @@
{
"components": {
"responses": {
"BadRequest": {
"Conflict": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
"$ref": "#/components/schemas/cluster_Error"
}
}
},
"description": "Bad Request"
"description": "Conflict"
},
"Conflict": {
"Forbidden": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
"$ref": "#/components/schemas/cluster_Error"
}
}
},
"description": "Conflict"
"description": "Forbidden"
},
"Forbidden": {
"NotAcceptable": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
"$ref": "#/components/schemas/cluster_Error"
}
}
},
"description": "Forbidden"
"description": "Not Acceptable"
},
"InternalServerError": {
"NotFound": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
"$ref": "#/components/schemas/cluster_Error"
}
}
},
"description": "Internal Server Error"
"description": "Not Found"
},
"NotAcceptable": {
"ServiceUnavailable": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
"$ref": "#/components/schemas/cluster_Error"
}
}
},
"description": "Not Acceptable"
"description": "Service Unavailable"
},
"NotFound": {
"cluster_BadRequest": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
"$ref": "#/components/schemas/cluster_Error"
}
}
},
"description": "Not Found"
"description": "Bad Request"
},
"ServiceUnavailable": {
"cluster_InternalServerError": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
"$ref": "#/components/schemas/cluster_Error"
}
}
},
"description": "Service Unavailable"
"description": "Internal Server Error"
}
},
"schemas": {
Expand Down Expand Up @@ -441,27 +441,6 @@
],
"type": "object"
},
"Error": {
"properties": {
"description": {
"description": "Human-readable error description",
"type": "string"
},
"error_code": {
"description": "Semantic error code (e.g., password_not_complex)",
"type": "string"
},
"status_code": {
"type": "integer",
"x-go-json-ignore": true
}
},
"required": [
"error_code",
"description",
"status_code"
]
},
"HighAvailability": {
"properties": {
"status": {
Expand Down Expand Up @@ -671,6 +650,44 @@
],
"type": "object"
},
"OcspConfig": {
"description": "OCSP configuration",
"properties": {
"ocsp_functionality": {
"description": "Whether to enable/disable OCSP for the cluster.",
"type": "boolean"
},
"query_frequency": {
"description": "Determines the interval (in seconds) in which the control plane will poll the OCSP responder for a new status for the server certificate.",
"type": "integer"
},
"recovery_frequency": {
"description": "Determines the interval (in seconds) in which the control plane will poll the OCSP responder for a new status for the server certificate when the current staple is invalid.",
"type": "integer"
},
"recovery_max_tries": {
"description": "Determines the maximum number for the OCSP recovery attempts. After max number of tries passed, the control plane will revert back to the regular frequency.",
"type": "integer"
},
"responder_url": {
"description": "The OCSP server url embedded in the proxy certificate (if available)",
"type": "string"
},
"response_timeout": {
"description": "Determines the time interval (in seconds) for which the request waits for a response from the OCSP responder.",
"type": "integer"
}
},
"required": [
"ocsp_functionality",
"responder_url",
"query_frequency",
"response_timeout",
"recovery_frequency",
"recovery_max_tries"
],
"type": "object"
},
"PasswordHashMethod": {
"description": "Used when password is passed pre-hashed",
"enum": [
Expand Down Expand Up @@ -1207,6 +1224,27 @@
},
"type": "object"
},
"cluster_Error": {
"properties": {
"description": {
"description": "Human-readable error description",
"type": "string"
},
"error_code": {
"description": "Semantic error code",
"type": "string"
},
"status_code": {
"type": "integer",
"x-go-json-ignore": true
}
},
"required": [
"error_code",
"description",
"status_code"
]
},
"database_detailed_status": {
"default": "unknown",
"description": "The database detailed status",
Expand Down Expand Up @@ -1327,10 +1365,10 @@
"description": "List of database proxy certificates"
},
"400": {
"$ref": "#/components/responses/BadRequest"
"$ref": "#/components/responses/cluster_BadRequest"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
"$ref": "#/components/responses/cluster_InternalServerError"
}
},
"security": [
Expand Down Expand Up @@ -1481,7 +1519,7 @@
"description": "The updated database proxy certificate"
},
"400": {
"$ref": "#/components/responses/BadRequest"
"$ref": "#/components/responses/cluster_BadRequest"
},
"404": {
"$ref": "#/components/responses/NotFound"
Expand All @@ -1490,7 +1528,7 @@
"$ref": "#/components/responses/NotAcceptable"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
"$ref": "#/components/responses/cluster_InternalServerError"
}
},
"security": [
Expand Down Expand Up @@ -1698,7 +1736,7 @@
"description": "Password hashing algorithm changed successfully"
},
"400": {
"$ref": "#/components/responses/BadRequest"
"$ref": "#/components/responses/cluster_BadRequest"
},
"403": {
"$ref": "#/components/responses/Forbidden"
Expand All @@ -1722,6 +1760,40 @@
"x-stability-level": "stable"
}
},
"/v1/ocsp": {
"get": {
"description": "Get the OCSP configuration for the cluster",
"operationId": "cluster_get_ocsp_config",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OcspConfig"
}
}
},
"description": "OCSP configuration"
},
"500": {
"$ref": "#/components/responses/cluster_InternalServerError"
}
},
"security": [
{
"Auth": [
"view_ocsp_config"
]
}
],
"summary": "Get OCSP configuration",
"tags": [
"Cluster"
],
"x-publish-docs": true,
"x-stability-level": "stable"
}
},
"/v1/redis_acls": {
"get": {
"description": "Get all Redis ACLs in the cluster",
Expand Down Expand Up @@ -1796,7 +1868,7 @@
"description": "Redis ACL created successfully"
},
"400": {
"$ref": "#/components/responses/BadRequest"
"$ref": "#/components/responses/cluster_BadRequest"
},
"403": {
"$ref": "#/components/responses/Forbidden"
Expand Down Expand Up @@ -1847,7 +1919,7 @@
"description": "Redis ACL validated successfully"
},
"400": {
"$ref": "#/components/responses/BadRequest"
"$ref": "#/components/responses/cluster_BadRequest"
},
"403": {
"$ref": "#/components/responses/Forbidden"
Expand Down Expand Up @@ -2029,7 +2101,7 @@
"description": "Redis ACL updated successfully"
},
"400": {
"$ref": "#/components/responses/BadRequest"
"$ref": "#/components/responses/cluster_BadRequest"
},
"403": {
"$ref": "#/components/responses/Forbidden"
Expand Down Expand Up @@ -2134,7 +2206,7 @@
"description": "Role created successfully."
},
"400": {
"$ref": "#/components/responses/BadRequest"
"$ref": "#/components/responses/cluster_BadRequest"
},
"403": {
"$ref": "#/components/responses/Forbidden"
Expand All @@ -2143,7 +2215,7 @@
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
"$ref": "#/components/schemas/cluster_Error"
}
}
},
Expand Down Expand Up @@ -2336,7 +2408,7 @@
"description": "Role updated successfully."
},
"400": {
"$ref": "#/components/responses/BadRequest"
"$ref": "#/components/responses/cluster_BadRequest"
},
"403": {
"$ref": "#/components/responses/Forbidden"
Expand Down Expand Up @@ -2440,7 +2512,7 @@
"description": "User created successfully"
},
"400": {
"$ref": "#/components/responses/BadRequest"
"$ref": "#/components/responses/cluster_BadRequest"
},
"403": {
"$ref": "#/components/responses/Forbidden"
Expand All @@ -2449,7 +2521,7 @@
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
"$ref": "#/components/schemas/cluster_Error"
}
}
},
Expand Down Expand Up @@ -2508,7 +2580,7 @@
"description": "Password deleted successfully"
},
"400": {
"$ref": "#/components/responses/BadRequest"
"$ref": "#/components/responses/cluster_BadRequest"
},
"403": {
"$ref": "#/components/responses/Forbidden"
Expand Down Expand Up @@ -2573,7 +2645,7 @@
"description": "Password added successfully"
},
"400": {
"$ref": "#/components/responses/BadRequest"
"$ref": "#/components/responses/cluster_BadRequest"
},
"403": {
"$ref": "#/components/responses/Forbidden"
Expand Down Expand Up @@ -2638,7 +2710,7 @@
"description": "Password reset successfully"
},
"400": {
"$ref": "#/components/responses/BadRequest"
"$ref": "#/components/responses/cluster_BadRequest"
},
"403": {
"$ref": "#/components/responses/Forbidden"
Expand Down Expand Up @@ -2971,7 +3043,7 @@
"description": "User updated successfully"
},
"400": {
"$ref": "#/components/responses/BadRequest"
"$ref": "#/components/responses/cluster_BadRequest"
},
"403": {
"$ref": "#/components/responses/Forbidden"
Expand Down