Challenge Overview
For this challenge, we'd like to add CURD endpoints for managing platforms and technologies.
1. Manage Platforms
the base endpoint should be /platforms,
- these endpoints will do against tcs_catalog:project_platform_lu table.
- Use different method, for different operations, like GET for retrieve, POST for creation, Patch for update, and DELETE for deletion.
- For deletion, it is not really removing the records, since there is no status_id, so leave it dummy now.
- For retrieving, it should return all data including id, name
- For creation and update, please update the create_user, create_date, modify_user and modify_date fields properly
1. Manage Technologies
the base endpoint should be /technologies
- these endpoints will do against tcs_catalog:technology_types table.
- Use different method, for different operations, like GET for retrieve, POST for creation, Patch for update, and DELETE for deletion.
- For deletion, it is not really removing the records, but update the status_id.
- For retrieving, it should return all data including id, name, description and status.
General Requirements
1. swagger.yaml should be updated to reflect the changes.
2. The API requests and responses should follow the v3 API standards.
About Local Setup
- The Challenge APIs need to communicate with Direct App, 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.
- Please check ap-challenge-microservice.zip/docs/Deployment Guide.docx about how to run the service and test with the API.
- Updated swagger.yaml file
- Deployment Guide and Verification Steps
1. Manage Platforms
the base endpoint should be /platforms,
- these endpoints will do against tcs_catalog:project_platform_lu table.
- Use different method, for different operations, like GET for retrieve, POST for creation, Patch for update, and DELETE for deletion.
- For deletion, it is not really removing the records, since there is no status_id, so leave it dummy now.
- For retrieving, it should return all data including id, name
- For creation and update, please update the create_user, create_date, modify_user and modify_date fields properly
1. Manage Technologies
the base endpoint should be /technologies
- these endpoints will do against tcs_catalog:technology_types table.
- Use different method, for different operations, like GET for retrieve, POST for creation, Patch for update, and DELETE for deletion.
- For deletion, it is not really removing the records, but update the status_id.
- For retrieving, it should return all data including id, name, description and status.
General Requirements
1. swagger.yaml should be updated to reflect the changes.
2. The API requests and responses should follow the v3 API standards.
About Local Setup
- The Challenge APIs need to communicate with Direct App, 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.
- 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 to fix the problems- Updated swagger.yaml file
- Deployment Guide and Verification Steps