Challenge Overview
Merge and update swagger file.
Project Background
We are in the process of updating the Project Service API from “v4” to “v5”. The update to “v5” has been already done in a separate branch `v5-upgrade`. At the same time in parallel, we have been making changes in the `dev` branch (current v4 API). And we already merge new changes done in `dev` to `v5-upgrade` so our new “v5” version has the latest code. The only 2 files left not yet merged. And in this challenge, we would merge and update one of them - the swagger file.
Technology Stack
Code access
The work for this challenge has to be done in one repository:
- Project Service repo https://github.com/topcoder-platform/tc-project-service branch v5-upgrade commit b477a8e337328058a0042555e27d97045a05a72f or later.
Individual requirements
-
During the work on “dev” branch, there are some new endpoints have been added, see all the changes in “dev” which have been done to “swagger.yml”: https://github.com/topcoder-platform/tc-project-service/compare/84ce3c5f0d484a80b9f985c711a1531da22609a8..1cee66ef658d285a2b87fbfca2aef892a61ef3c0#diff-9b8425f9cf681baff601421388c1af3c. Alternatively, you can run the next command to see the changes in swagger file made in “dev”: “git diff 84ce3c5f0d484a80b9f985c711a1531da22609a8 1cee66ef658d285a2b87fbfca2aef892a61ef3c0 -- swagger.yaml“.
-
We should move them to the current swagger file in “v5-upgrade” branch and update them to follow “v5” standard. We already did such update to “v5” standard to other endpoints in a previous challenge. Please, follow the requirement from that challenge on how to update newly added endpoints. You can also check the commit with the winning submission of that challenge for the reference.
-
Also, in “dev” branch we not only added new endpoints, but also made some updates to existent endpoints. Please, apply such updates to the current version of the swagger file taking into account that all the endpoints now follow the “v5” standard as described in the previous challenge.
General requirements
-
Use swagger editor to validate the updated swagger
-
Ensure that there are no validation errors in the updated swagger
Final Submission Guidelines
-
Git patch.
-
The winner would be required to raise a PR to the repository.