Skip to content

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

Open

Description

@abitmore

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

Activity

  1. added
    1a EpicHigh level concept to be addressed. Description should contain a list referencing child User Stories
    2a Discussion NeededPrompt for team to discuss at next stand up.
    3c EnhancementClassification indicating a change to the functionality of the existing imlementation
    4b Normal PriorityPriority indicating the moderate impact to system/user -OR- existing workaround is costly to perform
    6 APIImpact flag identifying the application programing interface (API)
    9c LargeEffort estimation indicating TBD
    6 UXImpact flag identifying the User Interface (UX)
    on May 20, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    1a EpicHigh level concept to be addressed. Description should contain a list referencing child User Stories2a Discussion NeededPrompt for team to discuss at next stand up.3c EnhancementClassification indicating a change to the functionality of the existing imlementation4b Normal PriorityPriority indicating the moderate impact to system/user -OR- existing workaround is costly to perform6 APIImpact flag identifying the application programing interface (API)6 UXImpact flag identifying the User Interface (UX)9c LargeEffort estimation indicating TBD

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions