[$75] "GET /taas-teams" must support `perPage`, `page`, `sortBy`, `sortOrder`, and `name` params about taas-apis

[nkumar-topcoder]

@maxceem can you pls take a look this.

[maxceem]

I had a look, understood the issue, and would update with details tomorrow.

[maxceem]

Internally GET /taas-teams endpoint calls Projects API GET /projects.
Projects API support sorting, pagination, and filtering by name: https://api.topcoder-dev.com/v5/projects/?sort=lastActivityAt+desc&perPage=20&page=1&name=*test*.

1. GET /taas-teams should support pagination params page and perPage (pass to Projects API).

   • TaaS app should set pagination headers the same way as for other TaaS endpoints. Projects API returns pagination headers:

     

   • Replace the custom code https://github.com/topcoder-platform/taas-apis/blob/feature/integration-test-fix/src/common/helper.js#L128-L134, with CORS config https://github.com/topcoder-platform/resources-api/pull/45/files

2. GET /taas-teams should support sorting params sortBy and sortOrder and pass them to Projects API in one param sort as sort=<sortBy>+<sortOrder>

3. GET /taas-teams should support filtering param name and pass it to Projects API

4. Make sure that all these params work as per the description above and I didn't miss anything.

5. Update API documentation: Swagger, Potman.

FYI @nkumar-topcoder

[maxceem]

@imcaizheng you may pick it up if it looks good for you.

[imcaizheng]

PR created #44

[maxceem]

Contest https://www.topcoder.com/challenges/30156198 has been created for this ticket.

This is an automated message for maxceem via Topcoder X

[maxceem]

Contest https://www.topcoder.com/challenges/30156198 has been updated - it has been assigned to aaron2017.

This is an automated message for maxceem via Topcoder X

[maxceem]

Works good.

The only thing, I guess we shouldn't add result when we return arrays in the response because as per swagger we have to return arrays of records directly, like:

[
  {},
   ...
  {}
]

instead of

{ 
   result: [
     {},
      ...
     {}
   ]
}

So I removed result for all the "list" endpoints f3328f7

@imcaizheng please, let me know if I missed something, and we should handle it another way, rather than removing result.

[imcaizheng]

@maxceem other operations such as GET /jobs, GET /jobCandidates and GET /resourceBookings return data with the result field, I think it may make API clients a little happy by letting GET /taas-teams to return data the same way, also considering the taas-teams endpoints were developed after the jobs, jobCandidates and resourceBookings endpionts. I would prefer to change the swagger spec instead if it is not too late to do that.

[maxceem]

Thanks, @imcaizheng.

@nkumar-topcoder as per swagger and implementation all list endpoints return data in result field:

While endpoints which return single records, return data directly without result field:

Also, other Topcoder V5 API return all the data without result field in the response. For example Challenges API:

Do you know if there was some intention behind adding result for the "list" endpoints or this happened unintentionally?
Also, I think Topcoder API V5 guidelines require to return data directly.

[nkumar-topcoder]

@maxceem
not sure , @veshu can help us here. pls reach out to him (offline on slack).
feel free to implement as deemed fit. thanks

[maxceem]

Ok, I believe there should not be result in responses, so I've removed it in endpoints and in Swagger.

[maxceem]

Payment task has been updated: https://software.topcoder.com/review/actions/ViewProjectDetails?pid=30156198

This is an automated message for maxceem via Topcoder X