Skip to content
Snippets Groups Projects
Commit ffd51e8c authored by feruzm's avatar feruzm
Browse files

check and improve

parent 54999b06
No related branches found
No related tags found
3 merge requests!142Deploy recent changes,!141Deploy recent updates,!140API improvements 1
---
position: 1
position: 3
group: communities
exclude: true
canonical_url: .#apidefinitions-bridge
......
---
position: 0
position: 4
exclude: true
canonical_url: .#apidefinitions-condenser-api
---
......
---
position: 4
position: 5
exclude: true
canonical_url: .#apidefinitions-database-api
---
......
......@@ -18,6 +18,5 @@
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-key-references)'
- '[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-key-references)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
- '[hivesql](https://docs.hivesql.io/technical-informations/operations/txaccountupdates)'
- '[hivexplorer](https://hivexplorer.com/api-docs?q=get_key_references)'
- '[hivesql](https://docs.hivesql.io/technical-informations/operations/txaccountupdates2)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/accounts)'
......@@ -54,6 +54,7 @@
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-account-history)'
- '[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-account-history)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
- '[hivexplorer](https://hivexplorer.com/api-docs?q=get_account_history)'
- api_method: account_history_api.get_ops_in_block
purpose: |
Returns all operations contained in a block. Parameter:
......@@ -85,6 +86,7 @@
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-ops-in-block)'
- '[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-ops-in-block)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
- '[hivexplorer](https://hivexplorer.com/api-docs?q=get_ops_in_block)'
- api_method: account_history_api.get_transaction
purpose: |
Returns the details of a transaction based on a transaction id (including their signatures, operations like also a block_num it was included to).
......@@ -173,6 +175,7 @@
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-transaction)'
- '[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-transaction)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
- '[hivexplorer](https://hivexplorer.com/api-docs?q=get_transaction)'
- '[hivesql](https://docs.hivesql.io/technical-informations/database-diagram#blocks-and-transactions)'
- api_method: account_history_api.enum_virtual_ops
since: HF24
......@@ -230,7 +233,7 @@
* `escrow_approved_operation = 0x8000000000`
* `escrow_rejected_operation = 0x10000000000`
* `proxy_cleared_operation = 0x20000000000`
parameter_json: '{"block_range_begin":1,"block_range_end":2,"include_reversible":true,"group_by_block":false,"operation_begin":0,"limit":1000,"filter":1}'
expected_response_json: |
{
......@@ -251,3 +254,4 @@
client_docs:
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
- '[hivesql](https://docs.hivesql.io/technical-informations/virtual-operations)'
- '[hivexplorer](https://hivexplorer.com/api-docs?q=enum_virtual_ops)'
......@@ -47,6 +47,7 @@
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-block)'
- '[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-block)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/BlockApi)'
- '[hivexplorer](https://hivexplorer.com/api-docs?q=get_block)'
- api_method: block_api.get_block_header
purpose: |
Retrieve a block header of the referenced block, or null if no matching
......@@ -83,6 +84,7 @@
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-block-header)'
- '[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-block-header)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/BlockApi)'
- '[hivexplorer](https://hivexplorer.com/api-docs?q=get_block_header)'
- api_method: block_api.get_block_range
purpose: |
Retrieve a range of full, signed blocks. The list may be shorter than requested if `count` blocks would take you past the current head block.
......@@ -105,3 +107,5 @@
- '{"jsonrpc":"2.0", "method":"block_api.get_block_range", "params":{"starting_block_num": 1, "count": 10}, "id":1}'
- '{"jsonrpc":"2.0", "method":"block_api.get_block_range", "params":{"starting_block_num": 8675309, "count": 50}, "id":1}'
- '{"jsonrpc":"2.0", "method":"block_api.get_block_range", "params":{"starting_block_num": 62396745, "count": 1000}, "id":1}'
client_docs:
- '[hivexplorer](https://hivexplorer.com/api-docs?q=get_block_range)'
......@@ -65,6 +65,7 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"bridge.get_ranked_posts", "params":{"sort":"trending","tag":"","observer":"alice"}, "id":1}'
client_docs:
- '[hivexplorer](https://hivexplorer.com/api-docs?q=get_ranked_posts)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/tags)'
- api_method: bridge.account_notifications
purpose: |
......@@ -102,6 +103,7 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"bridge.account_notifications", "params":{"account":"alice","limit":100}, "id":1}'
client_docs:
- '[hivexplorer](https://hivexplorer.com/api-docs?q=account_notifications)'
- '[openApi](https://gitlab.syncad.com/hive/hivemind/-/blob/pczempiel_openapi_bridge/openApi/client/docs/DefaultApi.md#bridge_account_notifications)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Bridge)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/followers)'
......@@ -116,6 +118,7 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"bridge.does_user_follow_any_lists", "params":{"observer":"alice"}, "id":1}'
client_docs:
- '[hivexplorer](https://hivexplorer.com/api-docs?q=does_user_follow_any_lists)'
- '[openApi](https://gitlab.syncad.com/hive/hivemind/-/blob/pczempiel_openapi_bridge/openApi/client/docs/DefaultApi.md#bridge_does_user_follow_any_lists)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Bridge)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/blacklistsfollows)'
......@@ -136,7 +139,7 @@
* `start_author`: author account name, if passed must be passed with `start_permlink` [optional]
* `start_permlink`: post permlink of given author, point to valid post, paging mechanism [optional]
* `limit`: if omitted the server will use the default value of 20 [optional]
* `observer`: ignored for `blog`, feed and `replies`, otherwise when passed has to point to valid account used to fill blacklist stats and mark posts of authors blacklisted by observer, at this time ignored [optional]
* `observer`: ignored for `blog`, feed and `replies`, otherwise when passed has to point to valid account used to fill blacklist stats and mark posts of authors blacklisted by observer, at this time ignored [optional]
parameter_json: {"sort":"blog", "account": "alice", "limit": 1}
expected_response_json: |
[
......@@ -197,6 +200,7 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"bridge.get_account_posts", "params":{"sort":"blog", "account": "alice", "limit": 1}, "id":1}'
client_docs:
- '[hivexplorer](https://hivexplorer.com/api-docs?q=get_account_posts)'
- '[openApi](https://gitlab.syncad.com/hive/hivemind/-/blob/pczempiel_openapi_bridge/openApi/client/docs/DefaultApi.md#bridge_get_account_posts)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Bridge)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/reblogs)'
......@@ -208,6 +212,7 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"bridge.get_community_context", "params":{"name": "hive-111111", "account": "therealwolf"}, "id":1}'
client_docs:
- '[hivexplorer](https://hivexplorer.com/api-docs?q=get_community_context)'
- '[openApi](https://gitlab.syncad.com/hive/hivemind/-/blob/pczempiel_openapi_bridge/openApi/client/docs/DefaultApi.md#bridge_get_community_context)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Bridge)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/communities)'
......@@ -275,6 +280,7 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"bridge.get_discussion", "params":{"author": "hiveio", "permlink": "around-the-hive-reflections", "observer": "alice"}, "id":1}'
client_docs:
- '[hivexplorer](https://hivexplorer.com/api-docs?q=get_discussion)'
- '[openApi](https://gitlab.syncad.com/hive/hivemind/-/blob/pczempiel_openapi_bridge/openApi/client/docs/DefaultApi.md#bridge_get_discussion)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Bridge)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/tags)'
......@@ -293,6 +299,7 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"bridge.get_follow_list", "params":{"observer": "blocktrades", "follow_type": "follow_blacklist"}, "id":1}'
client_docs:
- '[hivexplorer](https://hivexplorer.com/api-docs?q=get_follow_list)'
- '[openApi](https://gitlab.syncad.com/hive/hivemind/-/blob/pczempiel_openapi_bridge/openApi/client/docs/DefaultApi.md#bridge_get_follow_list)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Bridge)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/blacklistsfollows)'
......@@ -339,6 +346,7 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"bridge.get_profile", "params":{"account": "alice", "observer": "bob"}, "id":1}'
client_docs:
- '[hivexplorer](https://hivexplorer.com/api-docs?q=get_profile)'
- '[openApi](https://gitlab.syncad.com/hive/hivemind/-/blob/pczempiel_openapi_bridge/openApi/client/docs/DefaultApi.md#bridge_get_profile)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Bridge)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/accounts)'
......@@ -380,6 +388,7 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"bridge.list_communities", "params":{"limit": 1, "query": "wall street bets"}, "id":1}'
client_docs:
- '[hivexplorer](https://hivexplorer.com/api-docs?q=list_communities)'
- '[openApi](https://gitlab.syncad.com/hive/hivemind/-/blob/pczempiel_openapi_bridge/openApi/client/docs/DefaultApi.md#bridge_list_communities)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Bridge)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/communities)'
......@@ -405,6 +414,7 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"bridge.list_pop_communities", "params":{"limit": 10}, "id":1}'
client_docs:
- '[hivexplorer](https://hivexplorer.com/api-docs?q=list_pop_communities)'
- '[openApi](https://gitlab.syncad.com/hive/hivemind/-/blob/pczempiel_openapi_bridge/openApi/client/docs/DefaultApi.md#bridge_list_pop_communities)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Bridge)'
- api_method: bridge.list_subscribers
......@@ -431,6 +441,7 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"bridge.list_subscribers", "params":{"community": "hive-111111", "limit": 10}, "id":1}'
client_docs:
- '[hivexplorer](https://hivexplorer.com/api-docs?q=list_subscribers)'
- '[openApi](https://gitlab.syncad.com/hive/hivemind/-/blob/pczempiel_openapi_bridge/openApi/client/docs/DefaultApi.md#bridge_list_subscribers)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Bridge)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/communitiessubscribers)'
......@@ -450,6 +461,7 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"bridge.list_community_roles", "params":{"community":"hive-123456"}, "id":1}'
client_docs:
- '[hivexplorer](https://hivexplorer.com/api-docs?q=list_community_roles)'
- '[openApi](https://gitlab.syncad.com/hive/hivemind/-/blob/pczempiel_openapi_bridge/openApi/client/docs/DefaultApi.md#bridge_list_community_roles)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Bridge)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/communitiesroles)'
......@@ -467,6 +479,7 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"bridge.list_all_subscriptions", "params":{"account":"alice"}, "id":1}'
client_docs:
- '[hivexplorer](https://hivexplorer.com/api-docs?q=list_all_subscriptions)'
- '[openApi](https://gitlab.syncad.com/hive/hivemind/-/blob/pczempiel_openapi_bridge/openApi/client/docs/DefaultApi.md#bridge_list_all_subscriptions)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Bridge)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/communitiessubscribers)'
......@@ -477,7 +490,7 @@
* `name` - community category name
* `observer` - valid account [optional]
parameter_json: '{"name":"hive-123456","observer":"alice"}'
expected_response_json:
expected_response_json:
{
"id": 1332149,
"name": "hive-123456",
......@@ -508,6 +521,7 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"bridge.get_community", "params":{"name":"hive-123456","observer":"alice"}, "id":1}'
client_docs:
- '[hivexplorer](https://hivexplorer.com/api-docs?q=get_community)'
- '[openApi](https://gitlab.syncad.com/hive/hivemind/-/blob/pczempiel_openapi_bridge/openApi/client/docs/DefaultApi.md#bridge_get_community)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Bridge)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/communities)'
......@@ -527,6 +541,7 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"bridge.get_relationship_between_accounts", "params":["alice", "bob"], "id":1}'
client_docs:
- '[hivexplorer](https://hivexplorer.com/api-docs?q=get_relationship_between_accounts)'
- '[openApi](https://gitlab.syncad.com/hive/hivemind/-/blob/pczempiel_openapi_bridge/openApi/client/docs/DefaultApi.md#bridge_get_relationship_between_accounts)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Bridge)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/blacklists)'
......@@ -558,6 +573,7 @@
- '{"jsonrpc":"2.0", "method":"bridge.get_payout_stats", "params":{"limit": 1}, "id":1}'
- '{"jsonrpc":"2.0", "method":"bridge.get_payout_stats", "params":{"limit": 250}, "id":1}'
client_docs:
- '[hivexplorer](https://hivexplorer.com/api-docs?q=get_payout_stats)'
- '[openApi](https://gitlab.syncad.com/hive/hivemind/-/blob/pczempiel_openapi_bridge/openApi/client/docs/DefaultApi.md#bridge_get_payout_stats)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Bridge)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/comments)'
......@@ -627,6 +643,7 @@
- '{"jsonrpc":"2.0", "method":"bridge.get_post", "params":{"author": "alice", "permlink": "that-march-hare", "observer": "bob"}, "id":1}'
- '{"jsonrpc":"2.0", "method":"bridge.get_post", "params":{"author": "hiveio", "permlink": "around-the-hive-reflections"}, "id":1}'
client_docs:
- '[hivexplorer](https://hivexplorer.com/api-docs?q=get_post)'
- '[openApi](https://gitlab.syncad.com/hive/hivemind/-/blob/pczempiel_openapi_bridge/openApi/client/docs/DefaultApi.md#bridge_get_post)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Bridge)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/comments)'
......@@ -649,6 +666,7 @@
- '{"jsonrpc":"2.0", "method":"bridge.get_post_header", "params":{"author": "alice", "permlink": "that-march-hare"}, "id":1}'
- '{"jsonrpc":"2.0", "method":"bridge.get_post_header", "params":{"author": "hiveio", "permlink": "around-the-hive-reflections"}, "id":1}'
client_docs:
- '[hivexplorer](https://hivexplorer.com/api-docs?q=get_post_header)'
- '[openApi](https://gitlab.syncad.com/hive/hivemind/-/blob/pczempiel_openapi_bridge/openApi/client/docs/DefaultApi.md#bridge_post_header)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Bridge)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/comments)'
......@@ -19,32 +19,6 @@
Because the method has no arguments, the params field can be omitted when not using `condenser_api`. However, it can optionally be included as the void type (e.g. `"params":{}`) but it is not required.
methods:
- api_method: condenser_api.broadcast_block
removed: true
purpose: |
**Removed: HF26**
Used to broadcast a block.
Also see: [network_broadcast_api.broadcast_block]({{ '/apidefinitions/#network_broadcast_api.broadcast_block' | relative_url }})
parameter_json:
- previous: '0000000000000000000000000000000000000000'
timestamp: '1970-01-01T00:00:00'
witness: ''
transaction_merkle_root: '0000000000000000000000000000000000000000'
extensions: []
witness_signature: '0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000'
transactions: []
expected_response_json: {}
curl_examples:
- '{"jsonrpc":"2.0", "method":"condenser_api.broadcast_block", "params":[{"previous":"0000000000000000000000000000000000000000","timestamp":"1970-01-01T00:00:00","witness":"","transaction_merkle_root":"0000000000000000000000000000000000000000","extensions":[],"witness_signature":"0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000","transactions":[]}],
"id":1}'
expected_curl_responses:
- attempting to push a block that is too old
client_docs:
- "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#broadcast-block)"
- "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#broadcast-block)"
- "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.broadcast_transaction
purpose: |
Used to broadcast a transaction.
......@@ -98,39 +72,6 @@
- "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#broadcast-api)"
- "[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)"
- "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/TransactionBuilder)"
- api_method: condenser_api.get_account_bandwidth
removed: true
purpose: |
**Disabled since 0.20.6, see: [#3029]({{ 'https://github.com/steemit/steem/issues/3029' | archived_url }}#issuecomment-428404844); Removed: HF24**
Returns the available bandwidth of an account. Parameters: `account:string`; `type:string`, e.g.: `forum` or `market`
| `account` (string) | `type` (string) | |
|--------------------|-----------------|-|
| `"hiveio"` | `"forum"` | Query the available forum bandwidth for the account named "hiveio". |
| `"alice"` | `"market"` | Query the available market bandwidth for the account named "alice". |
See: [Forum/Market Bandwidth]({{ '/tutorials-recipes/forum-market-bandwidth.html' | relative_url }})
parameter_json: ["", ""]
expected_response_json:
id: 8
account: hiveio
type: forum
average_bandwidth: 214996934
lifetime_bandwidth: '48395000000'
last_bandwidth_update: '2018-02-16T03:11:00'
curl_examples:
- '{"jsonrpc":"2.0", "method":"condenser_api.get_account_bandwidth", "params":["hiveio","forum"],
"id":1}'
- '{"jsonrpc":"2.0", "method":"condenser_api.get_account_bandwidth", "params":["alice","market"],
"id":1}'
expected_curl_responses:
- Could not find method get_account_bandwidth
- Could not find method get_account_bandwidth
client_docs:
- "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#api-call)"
- "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-account-bandwidth)"
- "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: condenser_api.get_account_count
purpose: Returns the number of accounts.
parameter_json: []
......
......@@ -34,12 +34,12 @@ toc:
url: "/layer2/"
position: 5
exclude: true
- title: "Appbase API"
- title: "JSON-RPC Methods"
collection: apidefinitions
url: "/apidefinitions/"
exclude: true
position: 6
- title: "Node Operation"
- title: "Node Configs"
collection: "nodeop"
url: "/nodeop/"
position: 7
......
......@@ -735,10 +735,18 @@ a[href*='hivesql'] {
padding-left: .90em;
}
a[href*='hivexplorer'] {
background-image: url(../images/languages/nodejs.svg);
background-size: .90em .90em;
background-repeat: no-repeat;
background-position: left top;
padding-left: .90em;
}
#search-process {
background-image: url(../images/loading.gif);
background-size: .90em .90em;
background-repeat: no-repeat;
background-position: right top;
padding-left: .90em;
padding-left: .90em;
}
......@@ -4,14 +4,6 @@ section: API Definitions
permalink: /apidefinitions/
---
<section class="row">
<section class="row">
<blockquote class="warning">
While the <code>condenser_api.*</code> calls are ready for use, all other appbase methods are currently works in progress and may change, or be unsuitable for production use.
</blockquote>
</section>
</section>
{% assign sorted_collections = site.collections | where:'title', "API Definitions" %}
{% for collection in sorted_collections %}
{% assign sorted_docs = collection.docs | sort: "position" %}
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment