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

Review all APIs, add new optional parameters and change some old parameters to optional #1766

Open
6 tasks
abitmore opened this issue May 20, 2019 · 0 comments
Open
6 tasks
Labels
1a Epic High level concept to be addressed. Description should contain a list referencing child User Stories 2a Discussion Needed Prompt for team to discuss at next stand up. 3c Enhancement Classification indicating a change to the functionality of the existing imlementation 4b Normal Priority Priority indicating the moderate impact to system/user -OR- existing workaround is costly to perform 6 API Impact flag identifying the application programing interface (API) 6 UX Impact flag identifying the User Interface (UX) 9c Large Effort estimation indicating TBD

Comments

@abitmore
Copy link
Member

abitmore commented May 20, 2019

User Story
We'll soon support optional parameters for APIs (bitshares/bitshares-fc#126), so we can update existing APIs to be more user-friendly.

For example, get_call_orders API now has two parameters, asset and limit, a user have to specify a limit, and can only query for the first page. If we change limit to optional and have a default value for it, users can simply call get_call_orders(asset) to fetch the top results; if we add an optional start, then users will be able to fetch next pages.

CORE TEAM TASK LIST

  • Evaluate / Prioritize Feature Request
  • Refine User Stories / Requirements
  • Define Test Cases
  • Design / Develop Solution
  • Perform QA/Testing
  • Update Documentation
@abitmore abitmore added 1a Epic High level concept to be addressed. Description should contain a list referencing child User Stories 2a Discussion Needed Prompt for team to discuss at next stand up. 3c Enhancement Classification indicating a change to the functionality of the existing imlementation 4b Normal Priority Priority indicating the moderate impact to system/user -OR- existing workaround is costly to perform 6 API Impact flag identifying the application programing interface (API) 9c Large Effort estimation indicating TBD 6 UX Impact flag identifying the User Interface (UX) labels May 20, 2019
@abitmore abitmore added this to the Future Feature Release milestone May 20, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1a Epic High level concept to be addressed. Description should contain a list referencing child User Stories 2a Discussion Needed Prompt for team to discuss at next stand up. 3c Enhancement Classification indicating a change to the functionality of the existing imlementation 4b Normal Priority Priority indicating the moderate impact to system/user -OR- existing workaround is costly to perform 6 API Impact flag identifying the application programing interface (API) 6 UX Impact flag identifying the User Interface (UX) 9c Large Effort estimation indicating TBD
Projects
None yet
Development

No branches or pull requests

1 participant