Skip to content

Commit ce9320f

Browse files
redis-enterprise-doc-sync[bot]redis-enterprise-doc-sync[bot]
authored
Update Redis Enterprise API specification (#2827)
Co-authored-by: redis-enterprise-doc-sync[bot] <246451900+redis-enterprise-doc-sync[bot]@users.noreply.github.com>
1 parent ede5abc commit ce9320f

File tree

1 file changed

+131
-59
lines changed
  • content/operate/rs/references/rest-api/api-reference

1 file changed

+131
-59
lines changed

‎content/operate/rs/references/rest-api/api-reference/openapi.json‎

Lines changed: 131 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,75 @@
11
{
22
"components": {
33
"responses": {
4-
"BadRequest": {
4+
"Conflict": {
55
"content": {
66
"application/json": {
77
"schema": {
8-
"$ref": "#/components/schemas/Error"
8+
"$ref": "#/components/schemas/cluster_Error"
99
}
1010
}
1111
},
12-
"description": "Bad Request"
12+
"description": "Conflict"
1313
},
14-
"Conflict": {
14+
"Forbidden": {
1515
"content": {
1616
"application/json": {
1717
"schema": {
18-
"$ref": "#/components/schemas/Error"
18+
"$ref": "#/components/schemas/cluster_Error"
1919
}
2020
}
2121
},
22-
"description": "Conflict"
22+
"description": "Forbidden"
2323
},
24-
"Forbidden": {
24+
"NotAcceptable": {
2525
"content": {
2626
"application/json": {
2727
"schema": {
28-
"$ref": "#/components/schemas/Error"
28+
"$ref": "#/components/schemas/cluster_Error"
2929
}
3030
}
3131
},
32-
"description": "Forbidden"
32+
"description": "Not Acceptable"
3333
},
34-
"InternalServerError": {
34+
"NotFound": {
3535
"content": {
3636
"application/json": {
3737
"schema": {
38-
"$ref": "#/components/schemas/Error"
38+
"$ref": "#/components/schemas/cluster_Error"
3939
}
4040
}
4141
},
42-
"description": "Internal Server Error"
42+
"description": "Not Found"
4343
},
44-
"NotAcceptable": {
44+
"ServiceUnavailable": {
4545
"content": {
4646
"application/json": {
4747
"schema": {
48-
"$ref": "#/components/schemas/Error"
48+
"$ref": "#/components/schemas/cluster_Error"
4949
}
5050
}
5151
},
52-
"description": "Not Acceptable"
52+
"description": "Service Unavailable"
5353
},
54-
"NotFound": {
54+
"cluster_BadRequest": {
5555
"content": {
5656
"application/json": {
5757
"schema": {
58-
"$ref": "#/components/schemas/Error"
58+
"$ref": "#/components/schemas/cluster_Error"
5959
}
6060
}
6161
},
62-
"description": "Not Found"
62+
"description": "Bad Request"
6363
},
64-
"ServiceUnavailable": {
64+
"cluster_InternalServerError": {
6565
"content": {
6666
"application/json": {
6767
"schema": {
68-
"$ref": "#/components/schemas/Error"
68+
"$ref": "#/components/schemas/cluster_Error"
6969
}
7070
}
7171
},
72-
"description": "Service Unavailable"
72+
"description": "Internal Server Error"
7373
}
7474
},
7575
"schemas": {
@@ -441,27 +441,6 @@
441441
],
442442
"type": "object"
443443
},
444-
"Error": {
445-
"properties": {
446-
"description": {
447-
"description": "Human-readable error description",
448-
"type": "string"
449-
},
450-
"error_code": {
451-
"description": "Semantic error code (e.g., password_not_complex)",
452-
"type": "string"
453-
},
454-
"status_code": {
455-
"type": "integer",
456-
"x-go-json-ignore": true
457-
}
458-
},
459-
"required": [
460-
"error_code",
461-
"description",
462-
"status_code"
463-
]
464-
},
465444
"HighAvailability": {
466445
"properties": {
467446
"status": {
@@ -671,6 +650,44 @@
671650
],
672651
"type": "object"
673652
},
653+
"OcspConfig": {
654+
"description": "OCSP configuration",
655+
"properties": {
656+
"ocsp_functionality": {
657+
"description": "Whether to enable/disable OCSP for the cluster.",
658+
"type": "boolean"
659+
},
660+
"query_frequency": {
661+
"description": "Determines the interval (in seconds) in which the control plane will poll the OCSP responder for a new status for the server certificate.",
662+
"type": "integer"
663+
},
664+
"recovery_frequency": {
665+
"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.",
666+
"type": "integer"
667+
},
668+
"recovery_max_tries": {
669+
"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.",
670+
"type": "integer"
671+
},
672+
"responder_url": {
673+
"description": "The OCSP server url embedded in the proxy certificate (if available)",
674+
"type": "string"
675+
},
676+
"response_timeout": {
677+
"description": "Determines the time interval (in seconds) for which the request waits for a response from the OCSP responder.",
678+
"type": "integer"
679+
}
680+
},
681+
"required": [
682+
"ocsp_functionality",
683+
"responder_url",
684+
"query_frequency",
685+
"response_timeout",
686+
"recovery_frequency",
687+
"recovery_max_tries"
688+
],
689+
"type": "object"
690+
},
674691
"PasswordHashMethod": {
675692
"description": "Used when password is passed pre-hashed",
676693
"enum": [
@@ -1207,6 +1224,27 @@
12071224
},
12081225
"type": "object"
12091226
},
1227+
"cluster_Error": {
1228+
"properties": {
1229+
"description": {
1230+
"description": "Human-readable error description",
1231+
"type": "string"
1232+
},
1233+
"error_code": {
1234+
"description": "Semantic error code",
1235+
"type": "string"
1236+
},
1237+
"status_code": {
1238+
"type": "integer",
1239+
"x-go-json-ignore": true
1240+
}
1241+
},
1242+
"required": [
1243+
"error_code",
1244+
"description",
1245+
"status_code"
1246+
]
1247+
},
12101248
"database_detailed_status": {
12111249
"default": "unknown",
12121250
"description": "The database detailed status",
@@ -1327,10 +1365,10 @@
13271365
"description": "List of database proxy certificates"
13281366
},
13291367
"400": {
1330-
"$ref": "#/components/responses/BadRequest"
1368+
"$ref": "#/components/responses/cluster_BadRequest"
13311369
},
13321370
"500": {
1333-
"$ref": "#/components/responses/InternalServerError"
1371+
"$ref": "#/components/responses/cluster_InternalServerError"
13341372
}
13351373
},
13361374
"security": [
@@ -1481,7 +1519,7 @@
14811519
"description": "The updated database proxy certificate"
14821520
},
14831521
"400": {
1484-
"$ref": "#/components/responses/BadRequest"
1522+
"$ref": "#/components/responses/cluster_BadRequest"
14851523
},
14861524
"404": {
14871525
"$ref": "#/components/responses/NotFound"
@@ -1490,7 +1528,7 @@
14901528
"$ref": "#/components/responses/NotAcceptable"
14911529
},
14921530
"500": {
1493-
"$ref": "#/components/responses/InternalServerError"
1531+
"$ref": "#/components/responses/cluster_InternalServerError"
14941532
}
14951533
},
14961534
"security": [
@@ -1698,7 +1736,7 @@
16981736
"description": "Password hashing algorithm changed successfully"
16991737
},
17001738
"400": {
1701-
"$ref": "#/components/responses/BadRequest"
1739+
"$ref": "#/components/responses/cluster_BadRequest"
17021740
},
17031741
"403": {
17041742
"$ref": "#/components/responses/Forbidden"
@@ -1722,6 +1760,40 @@
17221760
"x-stability-level": "stable"
17231761
}
17241762
},
1763+
"/v1/ocsp": {
1764+
"get": {
1765+
"description": "Get the OCSP configuration for the cluster",
1766+
"operationId": "cluster_get_ocsp_config",
1767+
"responses": {
1768+
"200": {
1769+
"content": {
1770+
"application/json": {
1771+
"schema": {
1772+
"$ref": "#/components/schemas/OcspConfig"
1773+
}
1774+
}
1775+
},
1776+
"description": "OCSP configuration"
1777+
},
1778+
"500": {
1779+
"$ref": "#/components/responses/cluster_InternalServerError"
1780+
}
1781+
},
1782+
"security": [
1783+
{
1784+
"Auth": [
1785+
"view_ocsp_config"
1786+
]
1787+
}
1788+
],
1789+
"summary": "Get OCSP configuration",
1790+
"tags": [
1791+
"Cluster"
1792+
],
1793+
"x-publish-docs": true,
1794+
"x-stability-level": "stable"
1795+
}
1796+
},
17251797
"/v1/redis_acls": {
17261798
"get": {
17271799
"description": "Get all Redis ACLs in the cluster",
@@ -1796,7 +1868,7 @@
17961868
"description": "Redis ACL created successfully"
17971869
},
17981870
"400": {
1799-
"$ref": "#/components/responses/BadRequest"
1871+
"$ref": "#/components/responses/cluster_BadRequest"
18001872
},
18011873
"403": {
18021874
"$ref": "#/components/responses/Forbidden"
@@ -1847,7 +1919,7 @@
18471919
"description": "Redis ACL validated successfully"
18481920
},
18491921
"400": {
1850-
"$ref": "#/components/responses/BadRequest"
1922+
"$ref": "#/components/responses/cluster_BadRequest"
18511923
},
18521924
"403": {
18531925
"$ref": "#/components/responses/Forbidden"
@@ -2029,7 +2101,7 @@
20292101
"description": "Redis ACL updated successfully"
20302102
},
20312103
"400": {
2032-
"$ref": "#/components/responses/BadRequest"
2104+
"$ref": "#/components/responses/cluster_BadRequest"
20332105
},
20342106
"403": {
20352107
"$ref": "#/components/responses/Forbidden"
@@ -2134,7 +2206,7 @@
21342206
"description": "Role created successfully."
21352207
},
21362208
"400": {
2137-
"$ref": "#/components/responses/BadRequest"
2209+
"$ref": "#/components/responses/cluster_BadRequest"
21382210
},
21392211
"403": {
21402212
"$ref": "#/components/responses/Forbidden"
@@ -2143,7 +2215,7 @@
21432215
"content": {
21442216
"application/json": {
21452217
"schema": {
2146-
"$ref": "#/components/schemas/Error"
2218+
"$ref": "#/components/schemas/cluster_Error"
21472219
}
21482220
}
21492221
},
@@ -2336,7 +2408,7 @@
23362408
"description": "Role updated successfully."
23372409
},
23382410
"400": {
2339-
"$ref": "#/components/responses/BadRequest"
2411+
"$ref": "#/components/responses/cluster_BadRequest"
23402412
},
23412413
"403": {
23422414
"$ref": "#/components/responses/Forbidden"
@@ -2440,7 +2512,7 @@
24402512
"description": "User created successfully"
24412513
},
24422514
"400": {
2443-
"$ref": "#/components/responses/BadRequest"
2515+
"$ref": "#/components/responses/cluster_BadRequest"
24442516
},
24452517
"403": {
24462518
"$ref": "#/components/responses/Forbidden"
@@ -2449,7 +2521,7 @@
24492521
"content": {
24502522
"application/json": {
24512523
"schema": {
2452-
"$ref": "#/components/schemas/Error"
2524+
"$ref": "#/components/schemas/cluster_Error"
24532525
}
24542526
}
24552527
},
@@ -2508,7 +2580,7 @@
25082580
"description": "Password deleted successfully"
25092581
},
25102582
"400": {
2511-
"$ref": "#/components/responses/BadRequest"
2583+
"$ref": "#/components/responses/cluster_BadRequest"
25122584
},
25132585
"403": {
25142586
"$ref": "#/components/responses/Forbidden"
@@ -2573,7 +2645,7 @@
25732645
"description": "Password added successfully"
25742646
},
25752647
"400": {
2576-
"$ref": "#/components/responses/BadRequest"
2648+
"$ref": "#/components/responses/cluster_BadRequest"
25772649
},
25782650
"403": {
25792651
"$ref": "#/components/responses/Forbidden"
@@ -2638,7 +2710,7 @@
26382710
"description": "Password reset successfully"
26392711
},
26402712
"400": {
2641-
"$ref": "#/components/responses/BadRequest"
2713+
"$ref": "#/components/responses/cluster_BadRequest"
26422714
},
26432715
"403": {
26442716
"$ref": "#/components/responses/Forbidden"
@@ -2971,7 +3043,7 @@
29713043
"description": "User updated successfully"
29723044
},
29733045
"400": {
2974-
"$ref": "#/components/responses/BadRequest"
3046+
"$ref": "#/components/responses/cluster_BadRequest"
29753047
},
29763048
"403": {
29773049
"$ref": "#/components/responses/Forbidden"

0 commit comments

Comments
 (0)