Challenge Overview
Challenge Overview
In this challenge we are updating CSFV Gaming Stats API based on an updated API document, and the outlined requirements below.
Challenge Requirements
- The API controller in scope is GameStatsAPI.js and all related code used by the controller.
- The updated API document is provided in challenge forums. Note the following about changes made in the document :
- The change tracking is enabled so you can tell what exactly was changed.
- The API name is changed from "Stats API" to be "Gameplay Data Repository API"
- Update code/field/class/functions documentation to match the revised descriptions in the document.
- GameStats model will have playerId, levelId, gameId, and sessionId as a compound unique key. These 4 parameters will always be passed in all API calls.
- All changes in the document must be reflected to the API. if anything is not clear, please post question in the forums.
- We also need to add a new field to GameStats model :
- The field is an array of key/value pairs where keys are unique.
- Field name should be 'properties'.
- It is structure will be :
properties : [{
key: {type: String, required: true},
value: {type: String}
}] - The field will be passed in create and update operation
- for update operation we will replace the existing properties array completely.
- Update the API document to include this new field, in field descriptions, api examples . etc.
- Create postman file for the endpoints with proper test data. Check the official website for more details how to create one http://www.getpostman.com/
- Update the API document.
Github Repo
Gaming API source code is hosted in private repo https://github.com/topcoderinc/csfv_gaming_api_module
If you are getting 404 it means you dont' have access, you then need to request it in forums, include your github username when you post the request.
Final Submission Guidelines
Submission Deliverables
A complete list of deliverables can be viewed in the TopCoder Assembly competition Tutorial at: http://apps.topcoder.com/wiki/display/tc/Assembly+Competition+Tutorials
- Patch file of the changes. Postman file should be part of the patch as a new file.
- Text file with any notes to reviewer for how to deploy the api, and how to setup and run the postman.
- Updated API document.
Final Submission
For each member, the final submission should be uploaded via the challenge detail page on topcoder.com.