Challenge Overview
Previously, we have updated the elasticsearch feeder to populate a isTask field in elasticsearch.
This challenge is going to update Challenge APIs to properly support this field.
1. Support isTask field In Challenge Response
2. Filter Out assigned tasks in GET /challenges Endpoint And Support Filtering with isTask field
for assgined tasks, it is isTask flag be TRUE and numRegistrants is not 0.
3. Update For GET '/members/{handle}/challenges' Endpoint
3.1 If the api is accessed annoymous or handle is different from the current caller, filter out challenges that isTask is true
3.2 If the api is accessed by the same user, show all challenges including tasks.
4. If the isTask field missing in ElasticSearch, consider it as false.
5. Unit Tests should be properly updated.
6. API Spec (swagger.yaml) should be properly updated to reflect the changes.
- Postman scripts for easily of testing
- Updated swagger.yaml file
- Verification Steps
This challenge is going to update Challenge APIs to properly support this field.
1. Support isTask field In Challenge Response
2. Filter Out assigned tasks in GET /challenges Endpoint And Support Filtering with isTask field
for assgined tasks, it is isTask flag be TRUE and numRegistrants is not 0.
3. Update For GET '/members/{handle}/challenges' Endpoint
3.1 If the api is accessed annoymous or handle is different from the current caller, filter out challenges that isTask is true
3.2 If the api is accessed by the same user, show all challenges including tasks.
4. If the isTask field missing in ElasticSearch, consider it as false.
5. Unit Tests should be properly updated.
6. API Spec (swagger.yaml) should be properly updated to reflect the changes.
7. Create Postman Script for Easily of testing updated APIs
About Local Setup
- Please check https://github.com/appirio-tech/tc-common-tutorials/tree/master/docker/direct-app about how to build, deploy and run direct-app locally.
- Be sure to start the elasticsearch feeder service, otherwise, the challenge service will not work properly, please use the files in forum to build a new elasticsearch-feeder image, which is supporting to populate the isTask field in ElasticSearch index.
- Please use Topcoder Direct to setup the test challenge data.
- Please check ap-challenge-microservice.zip/docs/Deployment Guide.docx about how to run the service and test with the API.
Final Submission Guidelines
- Code changes for the requirements above- Postman scripts for easily of testing
- Updated swagger.yaml file
- Verification Steps