nus-pe-bot
commented
3 years ago Team's Response
Should define API in glossary
Items for the Tester to Verify
:question: Issue severity
Team chose [severity.Low]
Originally [severity.High]
- [x] I disagree
Reason for disagreement: By far, the greatest flaw of your software is caused by the API limit. I understand that it is a limitation of the API you are working with, but there should be effort to explain or work around these limitations. When a user sees the "API limit reached" error message, there is no explanation on what causes an API request, or more importantly, which commands make how many API requests. Hence, the user does not know which commands they may use or which commands will just cause the "API limit reached" error message to show up again.
For example, it is reasonable for a user to assume that the "wallet" function does not use the API, since your UG stated that it shows "how much you have allocated to stocks". However, your implementation of "wallet" does cause and API request, and there is no evidence in the UG to suggest otherwise.
The frequency of the "API limit reached" error message, combined with the lack of explanation, creates a flaw that affects users virtually all the time and causes major problems for them. Therefore, this deserves a severity of high.
The UG has no mention on what an API request is, or which commands make API requests, and yet it stipulates a limit of 5 API requests per minute. Consider removing the term "API" from the UG, as it is a technical term, and explain the limit in terms of your features and commands instead.