Merge pull request #8 from ABlockOfficial/basic-tutorials

Fixed build error

docs/mempool-api/create-receipt-asset.api.mdx → docs/api/mempool/create-receipt-asset.api.mdx

@@ -7,7 +7,7 @@ hide_title: true
 hide_table_of_contents: true
 api: {"tags":["transaction"],"description":"Create new receipt/asset.","operationId":"createReceiptAsset","parameters":[{"in":"header","name":"x-request-id","required":true,"description":"An idempotent key for retrieving cached responses from the node","schema":{"type":"string","example":"4d1e5754af0931a15138445c3ecd1a82","pattern":"^[a-z0-9]{32}$"}}],"requestBody":{"description":"Create a new receipt/asset","content":{"application/json":{"schema":{"type":"object","example":{"receipt_amount":1000,"script_public_key":"b46f37c1dc444f76eed55eee851dcbc34b8795ed1c7731a638d578e2803bfb01","public_key":"ffe056dcad98fbeb8fdeb79ef95fb49b0c9b5d2bc3c5191cb08df55fa71c4e5d","signature":"014643bab9a5859ccf6b0403d68c38b26b8888a41034b533f1a0ec2ba6b3afad5ac988e630a69b28f068c74d386df0ae86410aca1c8b1ce0b968f09b83111d07","drs_tx_hash_spec":"Default"},"title":"ReceiptCreate"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"4d1e5754af0931a15138445c3ecd1a82","description":"The ID of the call, which corresponds to the x-request-id used in the header"},"status":{"type":"string","example":"Success","description":"The status of the call, which will be one of either \"Success\", \"Error\", or \"Pending\""},"reason":{"type":"string","example":"Debug data successfully retrieved","description":"The reason for the status of the call. Most useful to debug errors"},"route":{"type":"string","example":"debug_data","description":"The endpoint route that was called"},"content":{"type":"object","properties":{"asset":{"type":"object","properties":{"asset":{"type":"object","properties":{"Receipt":{"type":"object","properties":{"amount":{"type":"number","example":1000},"drs_tx_hash":{"type":"string","example":"default_drs_tx_hash"},"metadata":{"type":"string","example":null}}}}},"extra_info":{"type":"string","example":null}}},"to_address":{"type":"string","example":"b46f37c1dc444f76eed55eee851dcbc34b8795ed1c7731a638d578e2803bfb01"},"tx_hash":{"type":"string","example":"default_drs_tx_hash"}}}},"title":"ResponseCreateReceipt"}},"application/xml":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"4d1e5754af0931a15138445c3ecd1a82","description":"The ID of the call, which corresponds to the x-request-id used in the header"},"status":{"type":"string","example":"Success","description":"The status of the call, which will be one of either \"Success\", \"Error\", or \"Pending\""},"reason":{"type":"string","example":"Debug data successfully retrieved","description":"The reason for the status of the call. Most useful to debug errors"},"route":{"type":"string","example":"debug_data","description":"The endpoint route that was called"},"content":{"type":"object","properties":{"asset":{"type":"object","properties":{"asset":{"type":"object","properties":{"Receipt":{"type":"object","properties":{"amount":{"type":"number","example":1000},"drs_tx_hash":{"type":"string","example":"default_drs_tx_hash"},"metadata":{"type":"string","example":null}}}}},"extra_info":{"type":"string","example":null}}},"to_address":{"type":"string","example":"b46f37c1dc444f76eed55eee851dcbc34b8795ed1c7731a638d578e2803bfb01"},"tx_hash":{"type":"string","example":"default_drs_tx_hash"}}}},"title":"ResponseCreateReceipt"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":null},"status":{"type":"string","example":"Error"},"reason":{"type":"string","example":"Bad Request"},"route":{"type":"string","example":null},"content":{"type":"string","example":null}},"title":"ResponseBadRequest"}},"application/xml":{"schema":{"type":"object","properties":{"id":{"type":"string","example":null},"status":{"type":"string","example":"Error"},"reason":{"type":"string","example":"Bad Request"},"route":{"type":"string","example":null},"content":{"type":"string","example":null}},"title":"ResponseBadRequest"}}}}},"method":"post","path":"/create_receipt_asset","servers":[{"url":"http://49.12.234.10:3003","description":"Mempool Node"}],"jsonRequestBodyExample":{"receipt_amount":1000,"script_public_key":"b46f37c1dc444f76eed55eee851dcbc34b8795ed1c7731a638d578e2803bfb01","public_key":"ffe056dcad98fbeb8fdeb79ef95fb49b0c9b5d2bc3c5191cb08df55fa71c4e5d","signature":"014643bab9a5859ccf6b0403d68c38b26b8888a41034b533f1a0ec2ba6b3afad5ac988e630a69b28f068c74d386df0ae86410aca1c8b1ce0b968f09b83111d07","drs_tx_hash_spec":"Default"},"info":{"title":"Mempool API","description":"The Mempool node is a special type of node responsible for collecting transactions and bundling them into new blocks. \nThey also partition the mining network for mining and validate the blocks that these partitions mine. \nThere are only a limited number of Mempool nodes.  ","contact":{"email":"[email protected]"},"license":{"name":"GPL-3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"},"version":"1.0.0"},"postman":{"name":"create_receipt_asset","description":{"content":"Create new receipt/asset.","type":"text/plain"},"url":{"path":["create_receipt_asset"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) An idempotent key for retrieving cached responses from the node","type":"text/plain"},"key":"x-request-id","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}}
 sidebar_class_name: "post api-method"
-info_path: docs/mempool-api/mempool-api
+info_path: api/mempool/mempool-api
 custom_edit_url: null
 hide_send_button: true
 ---

docs/mempool-api/create-tx.api.mdx → docs/api/mempool/create-tx.api.mdx

@@ -7,7 +7,7 @@ hide_title: true
 hide_table_of_contents: true
 api: {"tags":["transaction"],"description":"This section is incomplete and docs could be outdated. Create new transaction/s, which will be submitted to the Mempool nodes for inclusion into a new block. This call assumes a full transaction as part of the request body, which might make raw calls difficult to manage. For convenience, it may be best to use an A-Block library or SDK that abstracts this call for you.","operationId":"createTx","parameters":[{"in":"header","name":"x-request-id","required":true,"description":"An idempotent key for retrieving cached responses from the node","schema":{"type":"string","example":"4d1e5754af0931a15138445c3ecd1a82","pattern":"^[a-z0-9]{32}$"}}],"requestBody":{"description":"Create a new transaction","content":{"application/json":{"schema":{"type":"object","xml":{"name":"txcreate"},"properties":{"id":{"type":"string","example":"a957bc20","description":"The ID of the transaction being created"},"inputs":{"type":"array","items":{"type":"object","properties":{"previous_out":{"type":"string","example":"f0698b112da09"},"script_signature":{"type":"object","properties":{"stack":{"type":"array","items":{"type":"string"}}},"title":"Script"}},"xml":{"name":"txinput"},"title":"TransactionInput"},"description":"The inputs to the transaction"},"outputs":{"type":"integer","format":"int32","example":7},"version":{"type":"integer","format":"int8","example":2,"description":"The transaction's schema version"},"druid_info":{"type":"object","properties":{"druid":{"type":"string","example":"DRUID_1"},"participants":{"type":"integer","example":2},"expectations":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"},"asset":{"type":"object"}}}}}},"title":"TransactionCreate"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"a1d46199e5c89b00509e118f5af83172","description":"The ID of the call, which corresponds to the x-request-id used in the header"},"status":{"type":"string","example":"Success","description":"The status of the call, which will be one of either \"Success\", \"Error\", or \"Pending\""},"reason":{"type":"string","example":"Transaction/s successfully created","description":"The reason for the status of the call. Most useful to debug errors"},"route":{"type":"string","example":"create_transactions","description":"The endpoint route that was called"},"content":{"type":"object","properties":{"node_type":{"type":"string","example":"Compute","description":"The type of this node"},"node_api":{"type":"array","description":"The publicly visible endpoints available on this node","items":{"type":"string"},"example":["fetch_balance","create_receipt_asset","create_transactions"]},"node_peers":{"type":"array","description":"The publicly visible nodes that this node is connected to","items":{"type":"string"},"example":["Storage"]}}}},"title":"ResponseCreateTransactions"}},"application/xml":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"a1d46199e5c89b00509e118f5af83172","description":"The ID of the call, which corresponds to the x-request-id used in the header"},"status":{"type":"string","example":"Success","description":"The status of the call, which will be one of either \"Success\", \"Error\", or \"Pending\""},"reason":{"type":"string","example":"Transaction/s successfully created","description":"The reason for the status of the call. Most useful to debug errors"},"route":{"type":"string","example":"create_transactions","description":"The endpoint route that was called"},"content":{"type":"object","properties":{"node_type":{"type":"string","example":"Compute","description":"The type of this node"},"node_api":{"type":"array","description":"The publicly visible endpoints available on this node","items":{"type":"string"},"example":["fetch_balance","create_receipt_asset","create_transactions"]},"node_peers":{"type":"array","description":"The publicly visible nodes that this node is connected to","items":{"type":"string"},"example":["Storage"]}}}},"title":"ResponseCreateTransactions"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":null},"status":{"type":"string","example":"Error"},"reason":{"type":"string","example":"Bad Request"},"route":{"type":"string","example":null},"content":{"type":"string","example":null}},"title":"ResponseBadRequest"}},"application/xml":{"schema":{"type":"object","properties":{"id":{"type":"string","example":null},"status":{"type":"string","example":"Error"},"reason":{"type":"string","example":"Bad Request"},"route":{"type":"string","example":null},"content":{"type":"string","example":null}},"title":"ResponseBadRequest"}}}}},"method":"post","path":"/create_transactions","servers":[{"url":"http://49.12.234.10:3003","description":"Mempool Node"}],"jsonRequestBodyExample":{"id":"a957bc20","inputs":[{"previous_out":"f0698b112da09","script_signature":{"stack":["string"]}}],"outputs":7,"version":2,"druid_info":{"druid":"DRUID_1","participants":2,"expectations":{"from":"string","to":"string","asset":{}}}},"info":{"title":"Mempool API","description":"The Mempool node is a special type of node responsible for collecting transactions and bundling them into new blocks. \nThey also partition the mining network for mining and validate the blocks that these partitions mine. \nThere are only a limited number of Mempool nodes.  ","contact":{"email":"[email protected]"},"license":{"name":"GPL-3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"},"version":"1.0.0"},"postman":{"name":"create_transactions - Incomplete","description":{"content":"This section is incomplete and docs could be outdated. Create new transaction/s, which will be submitted to the Mempool nodes for inclusion into a new block. This call assumes a full transaction as part of the request body, which might make raw calls difficult to manage. For convenience, it may be best to use an A-Block library or SDK that abstracts this call for you.","type":"text/plain"},"url":{"path":["create_transactions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) An idempotent key for retrieving cached responses from the node","type":"text/plain"},"key":"x-request-id","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}}
 sidebar_class_name: "post api-method"
-info_path: docs/mempool-api/mempool-api
+info_path: api/mempool/mempool-api
 custom_edit_url: null
 hide_send_button: true
 ---

docs/mempool-api/debug-data.api.mdx → docs/api/mempool/debug-data.api.mdx

@@ -7,7 +7,7 @@ hide_title: true
 hide_table_of_contents: true
 api: {"tags":["info"],"description":"Get general information about the current node.","operationId":"debugData","parameters":[{"in":"header","name":"x-request-id","required":true,"description":"An idempotent key for retrieving cached responses from the node.","schema":{"type":"string","example":"4d1e5754af0931a15138445c3ecd1a82","pattern":"^[a-z0-9]{32}$"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"4d1e5754af0931a15138445c3ecd1a82","description":"The ID of the call, which corresponds to the x-request-id used in the header"},"status":{"type":"string","example":"Success","description":"The status of the call, which will be one of either \"Success\", \"Error\", or \"Pending\""},"reason":{"type":"string","example":"Debug data successfully retrieved","description":"The reason for the status of the call. Most useful to debug errors"},"route":{"type":"string","example":"debug_data","description":"The endpoint route that was called"},"content":{"type":"object","properties":{"node_type":{"type":"string","example":"Compute","description":"The type of this node"},"node_api":{"type":"array","description":"The publicly visible endpoints available on this node","items":{"type":"string"},"example":["fetch_balance","create_receipt_asset","create_transactions"]},"node_peers":{"type":"array","description":"The publicly visible nodes that this node is connected to","items":{"type":"string"},"example":["Storage"]}}}},"title":"ResponseDebugData"}},"application/xml":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"4d1e5754af0931a15138445c3ecd1a82","description":"The ID of the call, which corresponds to the x-request-id used in the header"},"status":{"type":"string","example":"Success","description":"The status of the call, which will be one of either \"Success\", \"Error\", or \"Pending\""},"reason":{"type":"string","example":"Debug data successfully retrieved","description":"The reason for the status of the call. Most useful to debug errors"},"route":{"type":"string","example":"debug_data","description":"The endpoint route that was called"},"content":{"type":"object","properties":{"node_type":{"type":"string","example":"Compute","description":"The type of this node"},"node_api":{"type":"array","description":"The publicly visible endpoints available on this node","items":{"type":"string"},"example":["fetch_balance","create_receipt_asset","create_transactions"]},"node_peers":{"type":"array","description":"The publicly visible nodes that this node is connected to","items":{"type":"string"},"example":["Storage"]}}}},"title":"ResponseDebugData"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":null},"status":{"type":"string","example":"Error"},"reason":{"type":"string","example":"Bad Request"},"route":{"type":"string","example":null},"content":{"type":"string","example":null}},"title":"ResponseBadRequest"}},"application/xml":{"schema":{"type":"object","properties":{"id":{"type":"string","example":null},"status":{"type":"string","example":"Error"},"reason":{"type":"string","example":"Bad Request"},"route":{"type":"string","example":null},"content":{"type":"string","example":null}},"title":"ResponseBadRequest"}}}}},"method":"get","path":"/debug_data","servers":[{"url":"http://49.12.234.10:3003","description":"Mempool Node"}],"info":{"title":"Mempool API","description":"The Mempool node is a special type of node responsible for collecting transactions and bundling them into new blocks. \nThey also partition the mining network for mining and validate the blocks that these partitions mine. \nThere are only a limited number of Mempool nodes.  ","contact":{"email":"[email protected]"},"license":{"name":"GPL-3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"},"version":"1.0.0"},"postman":{"name":"debug_data","description":{"content":"Get general information about the current node.","type":"text/plain"},"url":{"path":["debug_data"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) An idempotent key for retrieving cached responses from the node.","type":"text/plain"},"key":"x-request-id","value":""},{"key":"Accept","value":"application/json"}],"method":"GET"}}
 sidebar_class_name: "get api-method"
-info_path: docs/mempool-api/mempool-api
+info_path: api/mempool/mempool-api
 custom_edit_url: null
 hide_send_button: true
 ---