Challenge Overview
The purpose of this contest is to create REST API documentation for the provided IDC Dashboard UI Prototype pages.
The client already has a codebase which provides some preliminary APIs for the dashboard, and your task is to update the APIs to match the latest dashboard pages.
And here are the requirements:
- Carefully analyze the provided database schema, source code and APIs to understand the requirements.
- For the calculated fields, please look into the provided codebase to see how they are calculated.
- Update the database schema to match the latest UI.
- For designed API, please clearly document the sql statements to execute against the database tables, and how the API map to the UI elements.
You can find the latest IDC dashboard in this challenge: https://www.topcoder.com/challenges/30060706/?type=develop&noncache=true
You can find some more info about the original UI created for the old codebase and API document in the design contest: https://www.topcoder.com/challenges/30059671/?type=design&noncache=true
For the swagger file:
- The file should be named swagger.yaml
- The spec should written in Swagger 2.0 with YAML format.
- The requests and responses should properly list all fields.
- For responses, you should cover all the cases, not just 200 status code, like 404
- Descriptions should be properly written for APIs, request input and responses etc
* Swagger REST API Document
* Document to explain the mapping for each API to the database tables and UI elements
* Updated DB Schema (We are targeting Postgres)
The client already has a codebase which provides some preliminary APIs for the dashboard, and your task is to update the APIs to match the latest dashboard pages.
And here are the requirements:
- Carefully analyze the provided database schema, source code and APIs to understand the requirements.
- For the calculated fields, please look into the provided codebase to see how they are calculated.
- Update the database schema to match the latest UI.
- For designed API, please clearly document the sql statements to execute against the database tables, and how the API map to the UI elements.
You can find the latest IDC dashboard in this challenge: https://www.topcoder.com/challenges/30060706/?type=develop&noncache=true
You can find some more info about the original UI created for the old codebase and API document in the design contest: https://www.topcoder.com/challenges/30059671/?type=design&noncache=true
For the swagger file:
- The file should be named swagger.yaml
- The spec should written in Swagger 2.0 with YAML format.
- The requests and responses should properly list all fields.
- For responses, you should cover all the cases, not just 200 status code, like 404
- Descriptions should be properly written for APIs, request input and responses etc
Final Submission Guidelines
Submission Deliverable* Swagger REST API Document
* Document to explain the mapping for each API to the database tables and UI elements
* Updated DB Schema (We are targeting Postgres)