Documenting Reputation and Database API Definitions

Repository

https://github.com/inertia186/devportal

Site

https://inertia186.github.io/devportal

Issue

• For reputation_api, this is a new API, so I generated it from the rake commands included in the devportal project.
• For database_api, some of the method notes were only stubs. But more importantly, there were "order" arguments that were not defined at all, which required digging in c++ to determine.
• These changes fill in a lot of those blanks and synchronizes methods already documented in condenser_api to database_api where appropriate.

I've also included and will continue to submit pull requests for Steemit, Inc. in the event they want to sync up to the latest information I have available. This is just a courtesy on my part and have no bearing on my fork.

https://github.com/steemit/devportal/pull/405
https://github.com/steemit/devportal/pull/404

Just to clarify, since I've transitioned to my own fork, I'll likely stop including PR information in my blog entries about my fork to reduce confusion, but I plan to keep submitting them to Steemit, Inc.

---

Details on reputation_api

There's really not much to this API. It's really intended for API deploys that have hivemind. I think I'll add an issue on how this API enables you to run more complete full node with fewer steemd plugins, but that's a different document. All I'm doing here is capturing the facts about the new method and its origin.

Details on database_api

Here, I filled in details that were missing from database_api definitions. Some of them were outlined in condenser_api and copied over to database_api and then adjusted to the AppBase parameters. Some of them are unique to database_api. They all have curl examples that pass verification as of steem_rev: a99266.

$ rake test:curl[database_api]
node: https://api.steemit.com; blockchain_version: 0.20.6; steem_rev: a99266; fc_rev: a99266
Testing database_api.find_account_recovery_requests ... √
Testing database_api.find_accounts ... √
Testing database_api.find_change_recovery_account_requests ... √
Testing database_api.find_comments ... √
Testing database_api.find_decline_voting_rights_requests ... √
Testing database_api.find_escrows ... √
Testing database_api.find_limit_orders ... √
Testing database_api.find_owner_histories ... √
Testing database_api.find_savings_withdrawals ... √
Testing database_api.find_sbd_conversion_requests ... √
Testing database_api.find_vesting_delegation_expirations ... √
Testing database_api.find_vesting_delegations ... √
Testing database_api.find_votes ... √
Testing database_api.find_withdraw_vesting_routes ... √
Testing database_api.find_witnesses ... √
Testing database_api.get_active_witnesses ... √
Testing database_api.get_config ... √
Testing database_api.get_current_price_feed ... √
Testing database_api.get_dynamic_global_properties ... √
Testing database_api.get_feed_history ... √
Testing database_api.get_hardfork_properties ... √
Testing database_api.get_order_book ... √√
Testing database_api.get_potential_signatures ... √
Testing database_api.get_required_signatures ... √
Testing database_api.get_reward_funds ... √
Testing database_api.get_transaction_hex ... √
Testing database_api.get_version ... √
Testing database_api.get_witness_schedule ... √
Testing database_api.list_account_recovery_requests ... √
Testing database_api.list_accounts ... √
Testing database_api.list_change_recovery_account_requests ... √
Testing database_api.list_comments ... √
Testing database_api.list_decline_voting_rights_requests ... √
Testing database_api.list_escrows ... √
Testing database_api.list_limit_orders ... √
Testing database_api.list_owner_histories ... √
Testing database_api.list_savings_withdrawals ... √
Testing database_api.list_sbd_conversion_requests ... √
Testing database_api.list_vesting_delegation_expirations ... √
Testing database_api.list_vesting_delegations ... √
Testing database_api.list_votes ... √
Testing database_api.list_withdraw_vesting_routes ... √
Testing database_api.list_witness_votes ... √
Testing database_api.list_witnesses ... √
Testing database_api.verify_account_authority ... √
Testing database_api.verify_authority ... √
Testing database_api.verify_signatures ... √

Notes

These changes are now live:

https://inertia186.github.io/devportal/apidefinitions/#apidefinitions-reputation-api
https://inertia186.github.io/devportal/apidefinitions/#apidefinitions-database-api

GitHub Account

https://github.com/inertia186