Skip to content
Snippets Groups Projects
Commit 1a9fb437 authored by inertia's avatar inertia
Browse files

#83 merged sdk links

parent f7b7a46a
No related branches found
No related tags found
1 merge request!114Restoring Master
......@@ -18,3 +18,6 @@
- '[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)'
- '[hivesql](https://docs.hivesql.io/technical-informations/operations/txaccountupdates2)'
- '[hivesql](https://docs.hivesql.io/technical-informations/state-tables/accounts)'
......@@ -339,6 +339,7 @@
client_docs:
- '[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)'
- api_method: bridge.list_communities
purpose: |
Gets community
......@@ -379,6 +380,7 @@
client_docs:
- '[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)'
- api_method: bridge.list_pop_communities
purpose: |
Gets a list of popular communities.
......@@ -429,6 +431,7 @@
client_docs:
- '[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)'
- api_method: bridge.list_community_roles
purpose: |
List community roles and labels for each account in the community.
......@@ -447,6 +450,7 @@
client_docs:
- '[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)'
- api_method: bridge.list_all_subscriptions
purpose: |
List all subscriptions, titles, and roles to a community for an account.
......@@ -463,6 +467,7 @@
client_docs:
- '[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)'
- api_method: bridge.get_community
purpose: |
Get community details.
......@@ -553,6 +558,7 @@
client_docs:
- '[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)'
- api_method: bridge.get_post
purpose: |
Gives single selected post.
......@@ -643,3 +649,4 @@
client_docs:
- '[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)'
......@@ -1431,7 +1431,7 @@
- '["update_proposal_votes",{"voter":"alice","proposal_ids":[0],"approve":true}]'
client_docs:
- '[hive-keychain](https://github.com/stoodkev/hive-keychain#requestupdateproposalvote)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.blockchaininstance.html?#beem.blockchaininstance.BlockChainInstance.update_proposal_votes)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Broadcast.update_proposal_votes)'
- '[hivesql](https://docs.hivesql.io/technical-informations/operations/txproposalvoteupdates)'
- name: claim_reward_balance2
......
This diff is collapsed.
This diff is collapsed.
......@@ -210,7 +210,7 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"jsonrpc.get_methods", "id":1}'
client_docs:
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
- api_method: jsonrpc.get_signature
purpose: Returns the signature information for a JSON RPC method including the
arguments and expected response JSON.
......@@ -230,4 +230,4 @@
- '{"jsonrpc":"2.0", "method":"jsonrpc.get_signature", "params":{"method":"database_api.get_dynamic_global_properties"},
"id":1}'
client_docs:
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
- "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
......@@ -48,8 +48,8 @@
- '{"jsonrpc":"2.0", "method":"market_history_api.get_market_history", "params":{"bucket_seconds":86400,"start":"2018-01-01T00:00:00","end":"2018-01-02T00:00:00"},
"id":1}'
client_docs:
- '[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-market-history)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
- "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-market-history)"
- "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: market_history_api.get_market_history_buckets
purpose: Returns the bucket seconds being tracked by the plugin.
parameter_json: "{}"
......@@ -67,9 +67,9 @@
- '{"jsonrpc":"2.0", "method":"market_history_api.get_market_history_buckets",
"id":1}'
client_docs:
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-market-history-buckets)'
- '[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-market-history-buckets)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
- "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-market-history-buckets)"
- "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-market-history-buckets)"
- "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: market_history_api.get_order_book
purpose: Returns the internal market order book.
parameter_json: '{"limit":500}'
......@@ -139,9 +139,9 @@
- '{"jsonrpc":"2.0", "method":"market_history_api.get_order_book", "params":{"limit":50},
"id":1}'
client_docs:
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-order-book)'
- '[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-order-book)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
- "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-order-book)"
- "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-order-book)"
- "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: market_history_api.get_recent_trades
purpose: Returns the most recent trades for the internal HBD:HIVE market.
parameter_json: '{"limit":1000}'
......@@ -169,9 +169,9 @@
- '{"jsonrpc":"2.0", "method":"market_history_api.get_recent_trades", "params":{"limit":500},
"id":1}'
client_docs:
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-recent-trades)'
- '[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-recent-trades)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
- "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-recent-trades)"
- "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-recent-trades)"
- "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: market_history_api.get_ticker
purpose: Returns the market ticker for the internal HBD:HIVE market.
parameter_json: "{}"
......@@ -195,9 +195,9 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"market_history_api.get_ticker", "id":1}'
client_docs:
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-ticker)'
- '[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-ticker)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
- "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-ticker)"
- "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-ticker)"
- "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: market_history_api.get_trade_history
purpose: Returns the trade history for the internal HBD:HIVE market.
parameter_json: '{"start":"1970-01-01T00:00:00","end":"1970-01-01T00:00:00","limit":1000}'
......@@ -223,9 +223,9 @@
- '{"jsonrpc":"2.0", "method":"market_history_api.get_trade_history", "params":{"start":"2018-01-01T00:00:00","end":"2018-01-02T00:00:00","limit":10},
"id":1}'
client_docs:
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-trade-history)'
- '[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-trade-history)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
- "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-trade-history)"
- "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-trade-history)"
- "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: market_history_api.get_volume
purpose: Returns the market volume for the past 24 hours.
parameter_json: "{}"
......@@ -245,6 +245,6 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"market_history_api.get_volume", "id":1}'
client_docs:
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-volume)'
- '[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-volume)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
- "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-volume)"
- "[beem](https://beem.readthedocs.io/en/latest/apidefinitions.html#get-volume)"
- "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
......@@ -39,13 +39,13 @@
- '{"jsonrpc":"2.0", "method":"rc_api.find_rc_accounts", "params":{"accounts":["alice","bob"]},
"id":1}'
client_docs:
- '[beem](https://beem.readthedocs.io/en/latest/beem.rc.html)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
- "[beem](https://beem.readthedocs.io/en/latest/beem.rc.html)"
- "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: rc_api.get_resource_params
since: HF20
purpose: |
Exports all relevant resource size constants, in particular the measurement-based execution time parameters.
See: [#2980]({{ 'https://github.com/steemit/steem/issues/2980' | archived_url }})
parameter_json: "{}"
expected_response_json: |
......@@ -248,8 +248,8 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"rc_api.get_resource_params", "id":1}'
client_docs:
- '[beem](https://beem.readthedocs.io/en/latest/beem.rc.html)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
- "[beem](https://beem.readthedocs.io/en/latest/beem.rc.html)"
- "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
- api_method: rc_api.get_resource_pool
since: HF20
purpose: |
......@@ -278,5 +278,5 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"rc_api.get_resource_pool", "id":1}'
client_docs:
- '[beem](https://beem.readthedocs.io/en/latest/beem.rc.html)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
- "[beem](https://beem.readthedocs.io/en/latest/beem.rc.html)"
- "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
......@@ -18,7 +18,7 @@
| `"hiveio"` | 10 | Queries the reputation for account named "hiveio". |
See [#1425]({{ 'https://github.com/steemit/steem/issues/1425' | archived_url }})
Also see: [Paginated API Methods]({{ '/tutorials-recipes/paginated-api-methods.html#reputation_apiget_account_reputations' | relative_url }})
parameter_json: '{"account_lower_bound":"","limit":1000}'
expected_response_json: | # TODO - recheck in HF23
......@@ -29,6 +29,6 @@
curl_examples:
- '{"jsonrpc":"2.0", "method":"reputation_api.get_account_reputations", "params": {"account_lower_bound": "hive"}, "id":1}'
client_docs:
- '[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-account-reputations)'
- '[beem](https://beem.readthedocs.io/en/latest/beem.account.html#beem.account.Account.get_reputation)'
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
- "[hive-js](https://gitlab.syncad.com/hive/hive-js/tree/master/doc#get-account-reputations)"
- "[beem](https://beem.readthedocs.io/en/latest/beem.account.html#beem.account.Account.get_reputation)"
- "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
......@@ -4,22 +4,22 @@
- name: transaction_status_api
description: |
This API is intended to evaluate a transaction status after calling [`condenser_api.broadcast_transaction`]({{ '/apidefinitions/#condenser_api.broadcast_transaction' | relative_url }}).
To enable this API for `hived`, the following is required in `config.ini` by specifying:
```ini
plugin = transaction_status_api
```
See: [#3060]({{ 'https://github.com/steemit/steem/pull/3060' | archived_url }})
methods:
- api_method: transaction_status_api.find_transaction
since: HF23
purpose: |
Returns the status of a given transaction id. Parameters: `trx_id:string`; `expiration:timestamp` (optional)
The result will contain one of the following `status` values:
| Status | Meaning |
|--------|---------|
| `unknown` | Expiration time in future, transaction not included in block or mempool |
......@@ -35,4 +35,4 @@
- '{"jsonrpc":"2.0", "method":"transaction_status_api.find_transaction", "params": {"transaction_id": "0000000000000000000000000000000000000000"}, "id":1}'
- '{"jsonrpc":"2.0", "method":"transaction_status_api.find_transaction", "params": {"transaction_id": "0000000000000000000000000000000000000000", "expiration":"2016-03-24T18:00:21"}, "id":1}'
client_docs:
- '[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)'
- "[hive-ruby](https://www.rubydoc.info/gems/hive-ruby/Hive/Api)"
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