Challenge Overview
The message service maintains a relationship between topcoder entities, such as projects, challenges, and submissions with Discourse topics.
This relationship is maintained by the topics table (app/models/topics.js).
Currently, we have mixed logic to create topics logic in get topics api, which we'd like to revise and separate out. Please check https://docs.google.com/document/d/1ewRWSP7JS54_BDdNZojw7STaPlNJt0DUOuuj2i-dgqM/edit?usp=sharing for detail requirements to update.
About Local Setup and Testing
- The latest source code will be provided in forum.
- Please check README.md file in local directory for environment setup and testing.
- Unit Tests should be updated/added for this challenge. Please follow the same approach in code.
Create Swagger API Spec
- Just need to cover the Get Topics API and Create Topics API
- The file should be named swagger.yaml
- The spec should written in Swagger 2.0 YAML format.
- The requests and responses should be properly listed with every single fields.
- For responses, you should cover all the cases, not just 200.
- Descriptions should be properly written for APIs, requests and responses etc
- Updated README.md file for local setup if needed.
- Verificaition Steps
This relationship is maintained by the topics table (app/models/topics.js).
Currently, we have mixed logic to create topics logic in get topics api, which we'd like to revise and separate out. Please check https://docs.google.com/document/d/1ewRWSP7JS54_BDdNZojw7STaPlNJt0DUOuuj2i-dgqM/edit?usp=sharing for detail requirements to update.
About Local Setup and Testing
- The latest source code will be provided in forum.
- Please check README.md file in local directory for environment setup and testing.
- Unit Tests should be updated/added for this challenge. Please follow the same approach in code.
Create Swagger API Spec
- Just need to cover the Get Topics API and Create Topics API
- The file should be named swagger.yaml
- The spec should written in Swagger 2.0 YAML format.
- The requests and responses should be properly listed with every single fields.
- For responses, you should cover all the cases, not just 200.
- Descriptions should be properly written for APIs, requests and responses etc
Final Submission Guidelines
- Updated/New Code addressing the requirements in spec- Updated README.md file for local setup if needed.
- Verificaition Steps