From e7a4811cf512628f15e8c46c3c1db3f01391d9af Mon Sep 17 00:00:00 2001 From: modship Date: Thu, 9 Jan 2025 16:06:08 +0100 Subject: [PATCH] add openrpc documentation --- massa-node/base_config/openrpc.json | 107 ++++++++++++++++++++++++++++ 1 file changed, 107 insertions(+) diff --git a/massa-node/base_config/openrpc.json b/massa-node/base_config/openrpc.json index 6c04908089..2f2bc9b8d7 100644 --- 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": [