Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(api): add orderBy query parameter documentation to the Public API docs #437

Merged
merged 7 commits into from Jun 23, 2019

Conversation

Projects
None yet
3 participants
@Lemii
Copy link
Contributor

commented Jun 19, 2019

Resolves #436

Summary

This PR adds documentation of the orderBy query parameter to the following Public API docs:

  • Blocks
  • Delegates
  • Transactions
  • Votes
  • Wallets

Steps taken

The following steps have been taking for each of the API endpoints:

  • Look up / find out about all sortable columns
  • Test each individual column in a query
  • Add orderBy to the query parameter table
  • Add information about all sortable columns for the specific endpoint below the table (a :::TIP ::: box has been used for this)
  • Add an example curl command containing a orderBy parameter
  • Add the example response

Some of the ### Response lines have been removed for paragraphs with multiple Examples/Responses. This is to comply with the styling found on other pages (eg: /Blocks)

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Refactor
  • Performance
  • Tests
  • Build
  • Documentation
  • Code style update
  • Continuous Integration
  • Other, please describe:

Does this PR introduce a breaking change?

  • Yes
  • No

Does this PR release a new version?

  • Yes
  • No
@ArkEcosystemBot

This comment has been minimized.

Copy link
Member

commented Jun 19, 2019

Thanks for submitting this pull request! A maintainer will review this in the next few days and explicitly select labels so you know what's going on.

If no reviewer appears after a week, a reminder will be sent out.

@ArkEcosystemBot

This comment has been minimized.

Copy link
Member

commented Jun 23, 2019

A contributor has approved this PR. A maintainer will merge this PR shortly. If it shouldn't be merged yet, please leave a comment saying so and we'll wait.

Thank you for your contribution!

@faustbrian faustbrian merged commit 8e3adb7 into ArkEcosystem:master Jun 23, 2019

1 check passed

ci/circleci: build Your tests passed on CircleCI!
Details
@ArkEcosystemBot

This comment has been minimized.

Copy link
Member

commented Jun 23, 2019

Your pull request has been merged and marked as tier 3. It will earn you $25 USD.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.