Add API documentation for /cryptos/{cryptoCode}/rpc #486
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SuperJMN
changed the title
| }, | ||
| "security": [ | ||
| { | ||
| "ApiKeyAuth": [] |
| "post": { | ||
| "summary": "Proxy RPC call to the underlying node", | ||
| "description": "Allows you to make RPC calls to the underlying cryptocurrency node (e.g., Bitcoin Core) via NBXplorer. This endpoint acts as a proxy, forwarding your RPC requests to the node and returning the node's responses.", | ||
| "tags": ["Node RPC Proxy"], |
| "summary": "Proxy RPC call to the underlying node", | ||
| "description": "Allows you to make RPC calls to the underlying cryptocurrency node (e.g., Bitcoin Core) via NBXplorer. This endpoint acts as a proxy, forwarding your RPC requests to the node and returning the node's responses.", | ||
| "tags": ["Node RPC Proxy"], | ||
| "parameters": [ |
| } | ||
| }, | ||
| "401": { | ||
| "description": "Unauthorized. Authentication failed.", |
There was a problem hiding this comment.
Look how I documented other errors, here 401 can be json-rpc-not-exposed
| } | ||
| } | ||
| }, | ||
| "403": { |
| } | ||
| } | ||
| }, | ||
| "500": { |
| "/cryptos/{cryptoCode}/node/rpc": { | ||
| "post": { | ||
| "summary": "Proxy RPC call to the underlying node", | ||
| "description": "Allows you to make RPC calls to the underlying cryptocurrency node (e.g., Bitcoin Core) via NBXplorer. This endpoint acts as a proxy, forwarding your RPC requests to the node and returning the node's responses.", |
There was a problem hiding this comment.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds documentation for the API for this missing endpoint.