Feedbacks & Bugs on Get Apps By User

[Buwujiu]

Feedbacks

Feedbacks for https://daco-api.pcgl-dev.cumulus.genomeinformatics.org/api-docs/#/Applications/get_applications:

1. Add instruction to the swagger UI on how to filter by state. What are the filter states?
2. Add instructions on how to sort. Add an example string is even better. Such as
   Example:
   [{"direction":"desc","column":"id"}]
3. What is the first page number? 0 or 1? Would be nice to indicate it on swagger UI.
4. add total page, the current page to the response. Standardise the paging info in all endpoints.
5. make sure the response filters the Review apps and return it to the top.
6. Return more fields: user names, email, country.

Bugs:

1. when enter a negative number as pageSize, endpoint returns all applications. Expected: throw an error to indicate that pageSize cannot be negative.
   

Sorting Rules:

Cannot sorting because sorting items are unclear, but here are the rules:

• Applications should be sorted by application #, Updated, Status.
• Sort By application # in ascending by default.
• Sort by Updated in ascending by default.
• Sort by Status: Show the “For Review” applications first by default, then sort alphabetically.