Skip to content

Commit 987ab98

Browse files
author
tac0turtle
committed
update openapi
1 parent 04a5c17 commit 987ab98

File tree

1 file changed

+102
-34
lines changed

1 file changed

+102
-34
lines changed

‎docs/src/openapi-rpc.json‎

Lines changed: 102 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,11 @@
3434
}
3535
],
3636
"paths": {
37-
"/rollkit.v1.SignerService/Sign": {
37+
"/evnode.v1.SignerService/Sign": {
3838
"post": {
39-
"tags": ["Signer Service"],
39+
"tags": [
40+
"Signer Service"
41+
],
4042
"summary": "Sign a message",
4143
"description": "Sign the given message bytes and return the signature.",
4244
"operationId": "sign",
@@ -79,9 +81,11 @@
7981
}
8082
}
8183
},
82-
"/rollkit.v1.SignerService/GetPublic": {
84+
"/evnode.v1.SignerService/GetPublic": {
8385
"post": {
84-
"tags": ["Signer Service"],
86+
"tags": [
87+
"Signer Service"
88+
],
8589
"summary": "Get public key",
8690
"description": "Retrieve the public key of the signer.",
8791
"operationId": "getPublic",
@@ -119,9 +123,11 @@
119123
}
120124
}
121125
},
122-
"/rollkit.v1.StoreService/GetBlock": {
126+
"/evnode.v1.StoreService/GetBlock": {
123127
"post": {
124-
"tags": ["Store Service"],
128+
"tags": [
129+
"Store Service"
130+
],
125131
"summary": "Get a block",
126132
"description": "Retrieve a block by height or hash from the chain store.",
127133
"operationId": "getBlock",
@@ -173,9 +179,11 @@
173179
}
174180
}
175181
},
176-
"/rollkit.v1.StoreService/GetState": {
182+
"/evnode.v1.StoreService/GetState": {
177183
"post": {
178-
"tags": ["Store Service"],
184+
"tags": [
185+
"Store Service"
186+
],
179187
"summary": "Get current state",
180188
"description": "Retrieve the current state of the chain.",
181189
"operationId": "getState",
@@ -213,9 +221,11 @@
213221
}
214222
}
215223
},
216-
"/rollkit.v1.StoreService/GetMetadata": {
224+
"/evnode.v1.StoreService/GetMetadata": {
217225
"post": {
218-
"tags": ["Store Service"],
226+
"tags": [
227+
"Store Service"
228+
],
219229
"summary": "Get metadata",
220230
"description": "Retrieve metadata by key from the chain store.",
221231
"operationId": "getMetadata",
@@ -261,9 +271,11 @@
261271
}
262272
}
263273
},
264-
"/rollkit.v1.P2PService/GetPeerInfo": {
274+
"/evnode.v1.P2PService/GetPeerInfo": {
265275
"post": {
266-
"tags": ["P2P Service"],
276+
"tags": [
277+
"P2P Service"
278+
],
267279
"summary": "Get peer information",
268280
"description": "Retrieve information about connected peers.",
269281
"operationId": "getPeerInfo",
@@ -301,9 +313,11 @@
301313
}
302314
}
303315
},
304-
"/rollkit.v1.P2PService/GetNetInfo": {
316+
"/evnode.v1.P2PService/GetNetInfo": {
305317
"post": {
306-
"tags": ["P2P Service"],
318+
"tags": [
319+
"P2P Service"
320+
],
307321
"summary": "Get network information",
308322
"description": "Retrieve network information and statistics.",
309323
"operationId": "getNetInfo",
@@ -341,9 +355,11 @@
341355
}
342356
}
343357
},
344-
"/rollkit.v1.HealthService/Livez": {
358+
"/evnode.v1.HealthService/Livez": {
345359
"post": {
346-
"tags": ["Health Service"],
360+
"tags": [
361+
"Health Service"
362+
],
347363
"summary": "Check node health",
348364
"description": "Check if the node is alive and healthy.",
349365
"operationId": "livez",
@@ -390,7 +406,9 @@
390406
},
391407
"/health/live": {
392408
"get": {
393-
"tags": ["Health Service"],
409+
"tags": [
410+
"Health Service"
411+
],
394412
"summary": "Simple liveness check",
395413
"description": "Simple HTTP endpoint to check if the node is alive. Returns plain text 'OK' response.",
396414
"operationId": "healthLive",
@@ -447,7 +465,9 @@
447465
"SignRequest": {
448466
"type": "object",
449467
"description": "Request to sign a message",
450-
"required": ["message"],
468+
"required": [
469+
"message"
470+
],
451471
"properties": {
452472
"message": {
453473
"type": "string",
@@ -460,7 +480,9 @@
460480
"SignResponse": {
461481
"type": "object",
462482
"description": "Response containing signature",
463-
"required": ["signature"],
483+
"required": [
484+
"signature"
485+
],
464486
"properties": {
465487
"signature": {
466488
"type": "string",
@@ -478,7 +500,9 @@
478500
"GetPublicResponse": {
479501
"type": "object",
480502
"description": "Response containing public key",
481-
"required": ["public_key"],
503+
"required": [
504+
"public_key"
505+
],
482506
"properties": {
483507
"public_key": {
484508
"type": "string",
@@ -542,7 +566,9 @@
542566
"GetMetadataRequest": {
543567
"type": "object",
544568
"description": "Request to get metadata by key",
545-
"required": ["key"],
569+
"required": [
570+
"key"
571+
],
546572
"properties": {
547573
"key": {
548574
"type": "string",
@@ -554,7 +580,9 @@
554580
"GetMetadataResponse": {
555581
"type": "object",
556582
"description": "Response containing metadata",
557-
"required": ["value"],
583+
"required": [
584+
"value"
585+
],
558586
"properties": {
559587
"value": {
560588
"type": "string",
@@ -572,7 +600,9 @@
572600
"GetPeerInfoResponse": {
573601
"type": "object",
574602
"description": "Response containing peer information",
575-
"required": ["peers"],
603+
"required": [
604+
"peers"
605+
],
576606
"properties": {
577607
"peers": {
578608
"type": "array",
@@ -605,7 +635,9 @@
605635
"GetHealthResponse": {
606636
"type": "object",
607637
"description": "Response indicating node health status",
608-
"required": ["status"],
638+
"required": [
639+
"status"
640+
],
609641
"properties": {
610642
"status": {
611643
"$ref": "#/components/schemas/HealthStatus"
@@ -614,7 +646,12 @@
614646
},
615647
"HealthStatus": {
616648
"type": "string",
617-
"enum": ["UNKNOWN", "PASS", "WARN", "FAIL"],
649+
"enum": [
650+
"UNKNOWN",
651+
"PASS",
652+
"WARN",
653+
"FAIL"
654+
],
618655
"description": "Health status of the node"
619656
},
620657
"Block": {
@@ -649,7 +686,11 @@
649686
"Header": {
650687
"type": "object",
651688
"description": "Block header information",
652-
"required": ["height", "time", "chain_id"],
689+
"required": [
690+
"height",
691+
"time",
692+
"chain_id"
693+
],
653694
"properties": {
654695
"version": {
655696
"$ref": "#/components/schemas/Version"
@@ -713,7 +754,10 @@
713754
"Version": {
714755
"type": "object",
715756
"description": "Version captures the consensus rules for processing a block",
716-
"required": ["block", "app"],
757+
"required": [
758+
"block",
759+
"app"
760+
],
717761
"properties": {
718762
"block": {
719763
"type": "integer",
@@ -730,7 +774,10 @@
730774
"Signer": {
731775
"type": "object",
732776
"description": "Signer of a block",
733-
"required": ["address", "pub_key"],
777+
"required": [
778+
"address",
779+
"pub_key"
780+
],
734781
"properties": {
735782
"address": {
736783
"type": "string",
@@ -747,7 +794,9 @@
747794
"Data": {
748795
"type": "object",
749796
"description": "Block transaction data",
750-
"required": ["txs"],
797+
"required": [
798+
"txs"
799+
],
751800
"properties": {
752801
"metadata": {
753802
"$ref": "#/components/schemas/Metadata"
@@ -765,7 +814,11 @@
765814
"Metadata": {
766815
"type": "object",
767816
"description": "Metadata of a block",
768-
"required": ["chain_id", "height", "time"],
817+
"required": [
818+
"chain_id",
819+
"height",
820+
"time"
821+
],
769822
"properties": {
770823
"chain_id": {
771824
"type": "string",
@@ -791,7 +844,12 @@
791844
"State": {
792845
"type": "object",
793846
"description": "Current chain state",
794-
"required": ["chain_id", "initial_height", "last_block_height", "da_height"],
847+
"required": [
848+
"chain_id",
849+
"initial_height",
850+
"last_block_height",
851+
"da_height"
852+
],
795853
"properties": {
796854
"version": {
797855
"$ref": "#/components/schemas/Version"
@@ -835,7 +893,10 @@
835893
"PeerInfo": {
836894
"type": "object",
837895
"description": "Information about a connected peer",
838-
"required": ["id", "address"],
896+
"required": [
897+
"id",
898+
"address"
899+
],
839900
"properties": {
840901
"id": {
841902
"type": "string",
@@ -850,7 +911,11 @@
850911
"NetInfo": {
851912
"type": "object",
852913
"description": "Network information",
853-
"required": ["id", "listen_addresses", "connected_peers"],
914+
"required": [
915+
"id",
916+
"listen_addresses",
917+
"connected_peers"
918+
],
854919
"properties": {
855920
"id": {
856921
"type": "string",
@@ -875,7 +940,10 @@
875940
"Error": {
876941
"type": "object",
877942
"description": "Error response",
878-
"required": ["code", "message"],
943+
"required": [
944+
"code",
945+
"message"
946+
],
879947
"properties": {
880948
"code": {
881949
"type": "integer",

0 commit comments

Comments
 (0)