add openrpc documentation

massalabs · Jan 9, 2025 · e7a4811 · e7a4811
1 parent 1705251
commit e7a4811
Showing 1 changed file with 107 additions and 0 deletions.
diff --git a/massa-node/base_config/openrpc.json b/massa-node/base_config/openrpc.json
@@ -124,6 +124,39 @@
             "summary": "To check when your address is selected to stake.",
             "description": "To check when your address is selected to stake, run this command and look at the “next draws” section.\nAlso check that your balance increases, for each block or endorsement that you create you should get a small reward."
         },
+        {
+            "tags": [
+                {
+                    "name": "public",
+                    "description": "Massa public api"
+                }
+            ],
+            "params": [
+                {
+                    "name": "address keys request",
+                    "description": "TODO",
+                    "schema": {
+                        "type": "array",
+                        "items": {
+                            "$ref": "#/components/schemas/GetAddressDatastoreKeysRequest"
+                        }
+                    },
+                    "required": true
+                }
+            ],
+            "result": {
+                "name": "address keys response",
+                "schema": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/components/schemas/GetAddressDatastoreKeysResponse"
+                    }
+                }
+            },
+            "name": "get_addresses_datastore_keys",
+            "summary": "TODO",
+            "description": "TODO"
+        },
         {
             "tags": [
                 {
@@ -2619,6 +2652,80 @@
                 },
                 "additionalProperties": false
             },
+            "GetAddressDatastoreKeysRequest": {
+                "title": "GetAddressDatastoreKeysRequest",
+                "required": [
+                    "address",
+                    "prefix",
+                    "is_final"
+                ],
+                "type": "object",
+                "properties": {
+                    "address": {
+                        "$ref": "#/components/schemas/Address"
+                    },
+                    "prefix": {
+                        "$ref": "#/components/schemas/Bytes"
+                    },
+                    "is_final": {
+                        "type": "boolean"
+                    },
+                    "start_key": {
+                        "description": "start key to filter",
+                        "$ref": "#/components/schemas/BytesOption"
+                    },
+                    "inclusive_start_key": {
+                        "description": "include or exclude start_key",
+                        "oneOf": [
+                            {
+                                "type": "null"
+                            },
+                            {
+                                "type": "boolean"
+                            }
+                        ]
+                    },
+                    "count": {
+                        "description": "limit the number of keys",
+                        "oneOf": [
+                            {
+                                "type": "null"
+                            },
+                            {
+                                "type": "number"
+                            }
+                        ]
+                    }
+                }
+            },
+            "GetAddressDatastoreKeysResponse": {
+                "title": "GetAddressDatastoreKeysResponse",
+                "required": [
+                    "address",
+                    "keys",
+                    "is_final"
+                ],
+                "type": "object",
+                "properties": {
+                    "address": {
+                        "$ref": "#/components/schemas/Address"
+                    },
+                    "is_final": {
+                        "type": "boolean"
+                    },
+                    "keys": {
+                        "title": "keys list",
+                        "type": "array",
+                        "items": {
+                            "type": "array",
+                            "title": "key",
+                            "items": {
+                                "$ref": "#/components/schemas/Bytes"
+                            }
+                        }
+                    }
+                }
+            },
             "GraphInterval": {
                 "title": "GraphInterval",
                 "required": [