Skip to content

Commit

Permalink
Updating endpoints
Browse files Browse the repository at this point in the history
  • Loading branch information
BHouwens committed Apr 12, 2024
1 parent f17bd27 commit 7040bcf
Show file tree
Hide file tree
Showing 16 changed files with 38 additions and 43 deletions.
2 changes: 1 addition & 1 deletion docs/api/mempool/create-item-asset.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Create new item/asset."
sidebar_label: "create_item_asset"
hide_title: true
hide_table_of_contents: true
api: {"tags":["transaction"],"description":"Create new item/asset.","operationId":"createItemAsset","parameters":[{"in":"header","name":"x-cache-id","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 item/asset","content":{"application/json":{"schema":{"type":"object","properties":{"item_amount":{"type":"number","example":10,"description":"The amount of `Item` assets to create"},"script_public_key":{"type":"string","example":"b46f37c1dc444f76eed55eee851dcbc34b8795ed1c7731a638d578e2803bfb01","description":"Address"},"public_key":{"type":"string","example":"ffe056dcad98fbeb8fdeb79ef95fb49b0c9b5d2bc3c5191cb08df55fa71c4e5d","description":"Key-pair to use for the creation of the item-assets"},"signature":{"type":"string","example":"014643bab9a5859ccf6b0403d68c38b26b8888a41034b533f1a0ec2ba6b3afad5ac988e630a69b28f068c74d386df0ae86410aca1c8b1ce0b968f09b83111d07","description":"Signature to use for the creation of the item-assets"},"drs_tx_hash_spec":{"type":"string","example":"Default","description":"Whether to create `Item` assets that contain the default DRS identifier"}},"title":"ItemCreate"}}},"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-cache-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":{"Item":{"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":"ResponseCreateItem"}}}},"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"}}}}},"method":"post","path":"/create_item_asset","servers":[{"url":"http://37.27.23.104:3003","description":"Testnet Mempool Node"}],"jsonRequestBodyExample":{"item_amount":10,"script_public_key":"b46f37c1dc444f76eed55eee851dcbc34b8795ed1c7731a638d578e2803bfb01","public_key":"ffe056dcad98fbeb8fdeb79ef95fb49b0c9b5d2bc3c5191cb08df55fa71c4e5d","signature":"014643bab9a5859ccf6b0403d68c38b26b8888a41034b533f1a0ec2ba6b3afad5ac988e630a69b28f068c74d386df0ae86410aca1c8b1ce0b968f09b83111d07","drs_tx_hash_spec":"Default"},"info":{"title":"Mempool API","description":"⚠️ **Some sections may still be incomplete. We higly recommend getting started by downloading our [Postman collection](/docs/postman-collections)**.\n\nThe 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.1"},"postman":{"name":"create_item_asset","description":{"content":"Create new item/asset.","type":"text/plain"},"url":{"path":["create_item_asset"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"An idempotent key for retrieving cached responses from the node","type":"text/plain"},"key":"x-cache-id","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}}
api: {"tags":["transaction"],"description":"Create new item/asset.","operationId":"createItemAsset","parameters":[{"in":"header","name":"x-cache-id","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 item/asset","content":{"application/json":{"schema":{"type":"object","properties":{"item_amount":{"type":"number","example":10,"description":"The amount of `Item` assets to create"},"script_public_key":{"type":"string","example":"b46f37c1dc444f76eed55eee851dcbc34b8795ed1c7731a638d578e2803bfb01","description":"Address"},"public_key":{"type":"string","example":"ffe056dcad98fbeb8fdeb79ef95fb49b0c9b5d2bc3c5191cb08df55fa71c4e5d","description":"Key-pair to use for the creation of the item-assets"},"signature":{"type":"string","example":"014643bab9a5859ccf6b0403d68c38b26b8888a41034b533f1a0ec2ba6b3afad5ac988e630a69b28f068c74d386df0ae86410aca1c8b1ce0b968f09b83111d07","description":"Signature to use for the creation of the item-assets"},"drs_tx_hash_spec":{"type":"string","example":"Default","description":"Whether to create `Item` assets that contain the default DRS identifier"}},"title":"ItemCreate"}}},"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-cache-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":{"Item":{"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":"ResponseCreateItem"}}}},"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"}}}}},"method":"post","path":"/create_item_asset","servers":[{"url":"https://mempool.aiblock.dev","description":"Testnet Mempool Node"}],"jsonRequestBodyExample":{"item_amount":10,"script_public_key":"b46f37c1dc444f76eed55eee851dcbc34b8795ed1c7731a638d578e2803bfb01","public_key":"ffe056dcad98fbeb8fdeb79ef95fb49b0c9b5d2bc3c5191cb08df55fa71c4e5d","signature":"014643bab9a5859ccf6b0403d68c38b26b8888a41034b533f1a0ec2ba6b3afad5ac988e630a69b28f068c74d386df0ae86410aca1c8b1ce0b968f09b83111d07","drs_tx_hash_spec":"Default"},"info":{"title":"Mempool API","description":"⚠️ **Some sections may still be incomplete. We higly recommend getting started by downloading our [Postman collection](/docs/postman-collections)**.\n\nThe 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.1"},"postman":{"name":"create_item_asset","description":{"content":"Create new item/asset.","type":"text/plain"},"url":{"path":["create_item_asset"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"An idempotent key for retrieving cached responses from the node","type":"text/plain"},"key":"x-cache-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/api/mempool/mempool-api
custom_edit_url: null
Expand Down
Loading

0 comments on commit 7040bcf

Please sign in to comment.