Skip to content

Commit 0e81e6a

Browse files
andreclaroclaude
andreclaro
and
claude
authored
chore: generate new openapi spec 3.1.0 (#73)
chore: generate new openapi spec 3.1.0 quicknode.com/docs/openapi/admin-api.openapi.json --------- Co-authored-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
1 parent 7984cc0 commit 0e81e6a

4 files changed

Lines changed: 848 additions & 141 deletions

File tree

‎api/quicknode/openapi.json‎

Lines changed: 213 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@
282282
}
283283
},
284284
"400": {
285-
"description": "invalid request_id format"
285+
"description": "hermes rejects non-time-based UUID"
286286
},
287287
"404": {
288288
"description": "endpoint not found"
@@ -646,12 +646,38 @@
646646
}
647647
},
648648
"/v0/endpoints/{id}/rate-limits": {
649-
"put": {
650-
"summary": "Updates rate limits",
649+
"get": {
650+
"summary": "List endpoint rate limits",
651+
"tags": [
652+
"Endpoint Rate Limits"
653+
],
654+
"description": "Returns the rate limits currently enforced on the endpoint, with the source of each value.",
655+
"operationId": "getRateLimits",
656+
"parameters": [
657+
{
658+
"name": "id",
659+
"in": "path",
660+
"required": true,
661+
"schema": {
662+
"type": "string"
663+
}
664+
}
665+
],
666+
"responses": {
667+
"200": {
668+
"description": "Rate limits returned"
669+
},
670+
"404": {
671+
"description": "Endpoint not found"
672+
}
673+
}
674+
},
675+
"patch": {
676+
"summary": "Update endpoint rate limits (partial)",
651677
"tags": [
652678
"Endpoint Rate Limits"
653679
],
654-
"description": "Update rate limits on an endpoint",
680+
"description": "Partial update of endpoint-level rate-limit overrides (RPS/RPM/RPD). Only buckets included in the request body are modified — omitted buckets are left unchanged. There is no clear-by-omission behavior. PUT is also accepted as a legacy alias of this operation.",
655681
"operationId": "updateRateLimits",
656682
"parameters": [
657683
{
@@ -690,13 +716,19 @@
690716
"type": "object",
691717
"properties": {
692718
"rps": {
693-
"type": "integer"
719+
"type": "integer",
720+
"minimum": 1,
721+
"description": "Maximum requests per second. Capped by the account's plan tier."
694722
},
695723
"rpm": {
696-
"type": "integer"
724+
"type": "integer",
725+
"minimum": 1,
726+
"description": "Maximum requests per minute. Capped by the account's plan tier."
697727
},
698728
"rpd": {
699-
"type": "integer"
729+
"type": "integer",
730+
"minimum": 1,
731+
"description": "Maximum requests per day. Capped by the account's plan tier."
700732
}
701733
},
702734
"minProperties": 1
@@ -706,6 +738,99 @@
706738
}
707739
}
708740
}
741+
},
742+
"put": {
743+
"summary": "Update endpoint rate limits (legacy PUT alias)",
744+
"tags": [
745+
"Endpoint Rate Limits"
746+
],
747+
"description": "Deprecated — kept for backwards compatibility with existing API clients. Use PATCH /v0/endpoints/{id}/rate-limits instead.",
748+
"operationId": "updateRateLimitsLegacyPut",
749+
"deprecated": true,
750+
"parameters": [
751+
{
752+
"name": "id",
753+
"in": "path",
754+
"required": true,
755+
"schema": {
756+
"type": "string"
757+
}
758+
}
759+
],
760+
"responses": {
761+
"200": {
762+
"description": "Rate limits updated"
763+
}
764+
},
765+
"requestBody": {
766+
"content": {
767+
"application/json": {
768+
"schema": {
769+
"type": "object",
770+
"required": [
771+
"rate_limits"
772+
],
773+
"properties": {
774+
"rate_limits": {
775+
"type": "object",
776+
"properties": {
777+
"rps": {
778+
"type": "integer",
779+
"minimum": 1,
780+
"description": "Maximum requests per second. Capped by the account's plan tier."
781+
},
782+
"rpm": {
783+
"type": "integer",
784+
"minimum": 1,
785+
"description": "Maximum requests per minute. Capped by the account's plan tier."
786+
},
787+
"rpd": {
788+
"type": "integer",
789+
"minimum": 1,
790+
"description": "Maximum requests per day. Capped by the account's plan tier."
791+
}
792+
},
793+
"minProperties": 1
794+
}
795+
}
796+
}
797+
}
798+
}
799+
}
800+
}
801+
},
802+
"/v0/endpoints/{id}/rate-limits/{override_id}": {
803+
"delete": {
804+
"summary": "Delete a user-set rate-limit override",
805+
"tags": [
806+
"Endpoint Rate Limits"
807+
],
808+
"description": "Delete the user-set rate-limit override identified by its UUID. The override id is exposed on the GET rate-limits response for user_override rows. Returns 404 if the id does not match a user-set override on this endpoint — plan defaults are not deletable.",
809+
"operationId": "deleteRateLimitOverride",
810+
"parameters": [
811+
{
812+
"name": "id",
813+
"in": "path",
814+
"required": true,
815+
"schema": {
816+
"type": "string"
817+
}
818+
},
819+
{
820+
"name": "override_id",
821+
"in": "path",
822+
"description": "The UUID of the user-set rate-limit override, as returned by the GET rate-limits response.",
823+
"required": true,
824+
"schema": {
825+
"type": "string"
826+
}
827+
}
828+
],
829+
"responses": {
830+
"404": {
831+
"description": "Override not found"
832+
}
833+
}
709834
}
710835
},
711836
"/v0/endpoints/{id}/security_options": {
@@ -2522,6 +2647,47 @@
25222647
}
25232648
}
25242649
},
2650+
"/v0/endpoints/{id}/urls": {
2651+
"get": {
2652+
"summary": "Get endpoint URLs",
2653+
"tags": [
2654+
"Endpoints"
2655+
],
2656+
"description": "Returns the http/wss URLs for the endpoint, plus multichain_urls for multichain endpoints.",
2657+
"operationId": "showEndpointUrls",
2658+
"parameters": [
2659+
{
2660+
"name": "id",
2661+
"in": "path",
2662+
"required": true,
2663+
"schema": {
2664+
"type": "string"
2665+
}
2666+
}
2667+
],
2668+
"responses": {
2669+
"200": {
2670+
"description": "success",
2671+
"content": {
2672+
"application/json": {
2673+
"schema": {
2674+
"type": "object",
2675+
"properties": {
2676+
"data": {
2677+
"$ref": "#/components/schemas/endpoint_urls"
2678+
},
2679+
"error": {
2680+
"type": "string",
2681+
"nullable": true
2682+
}
2683+
}
2684+
}
2685+
}
2686+
}
2687+
}
2688+
}
2689+
}
2690+
},
25252691
"/v0/metrics": {
25262692
"get": {
25272693
"summary": "Fetch account-level metrics",
@@ -2748,7 +2914,7 @@
27482914
"tags": [
27492915
"Tags"
27502916
],
2751-
"description": "Deletes an account tag. Hard-fails if the tag is still assigned to any endpoints \u2014 remove it from all endpoints first. Admin-only.",
2917+
"description": "Deletes an account tag. Hard-fails if the tag is still assigned to any endpoints — remove it from all endpoints first. Admin-only.",
27522918
"operationId": "deleteAccountTag",
27532919
"parameters": [
27542920
{
@@ -4483,6 +4649,44 @@
44834649
"is_multichain"
44844650
]
44854651
},
4652+
"endpoint_urls": {
4653+
"type": "object",
4654+
"properties": {
4655+
"http_url": {
4656+
"type": "string"
4657+
},
4658+
"wss_url": {
4659+
"type": "string",
4660+
"nullable": true
4661+
},
4662+
"multichain_urls": {
4663+
"type": "object",
4664+
"nullable": true,
4665+
"description": "Map of network name → { http_url, wss_url } for multichain endpoints; null otherwise.",
4666+
"additionalProperties": {
4667+
"type": "object",
4668+
"properties": {
4669+
"http_url": {
4670+
"type": "string"
4671+
},
4672+
"wss_url": {
4673+
"type": "string",
4674+
"nullable": true
4675+
}
4676+
},
4677+
"required": [
4678+
"http_url",
4679+
"wss_url"
4680+
]
4681+
}
4682+
}
4683+
},
4684+
"required": [
4685+
"http_url",
4686+
"wss_url",
4687+
"multichain_urls"
4688+
]
4689+
},
44864690
"endpoint_rate_limits": {
44874691
"type": "object",
44884692
"properties": {
@@ -4764,4 +4968,4 @@
47644968
}
47654969
],
47664970
"host": "www.quicknode.com"
4767-
}
4971+
}

0 commit comments

Comments
 (0)