Challenge Overview
1. Project Overview
TopCoder and the TopCoder community have worked hard to get the platform to its currently level of maturity, but we're far from done. It's time to take the platform to the next level. TopCoder is going to start taking some steps to open up the platform API to the outside and community developers so they could incorporate it in their websites, applications or build their own applications (web, mobile or desktop).
The ultimate goal is to open up and build an "API" that is targeting all different type of audiences - Software and Studio Competitors, SRM/MM competitors, Copilots, Admins and TopCoder partners - each audience will have different interests and usages of the API, so it will be a huge project and we need to make sure that we are in the right direction from the beginning.
2. Contest Overview
Please check existing issues in JIRA first.
Please DON'T report dupliate issues.
API Specification: http://docs.tcapi.apiary.io
GitHub Source Code: https://github.com/cloudspokes/tc-api
This challenge should find the inconsistent issues of API Specification. (You can assume GitHub API Implementation is correct)
I'd suggest you start from routes.js: https://github.com/cloudspokes/tc-api/blob/master/routes.js
you can find the details here: https://github.com/cloudspokes/tc-api/tree/master/actions
You will get 5 points per issue If you find any issue in the API definition, e.g. wrong api path, more or less parameters, etc.
You will get 3 points per issue If you find any issue in the Parameter definition, e.g. wrong parameter type, wrong required / optional propery
You will get 1 point per issue If you have any grammar / description suggestion.
The member who gets most points will win this challenge and other members will receive $2 per point.
3. Bug Report
- JIRA Project: https://apps.topcoder.com/bugs/browse/TCAPI
- Component - Select "API Specification" - This is important
- The Bug Description should include following information
- GitHub Code Reference
- API Specification Reference
- Point what's the issue or what's your suggestion.
Final Submission Guidelines
N/A