Topcoder Project API - Update Swagger to V5 Standards

• Update existing Swagger to be in compliance with Topcoder V5 API Standards

Project background

• Topcoder is streamlining its APIs and in this project we will be upgrading the existing Project API to V5 standards

• Project API powers Topcoder connect and supplies data for Direct as well

Technology Stack

• Swagger

• Swagger editor

Challenge Assets

• Existing Topcoder Project API code can be found here

• Topcoder V5 API standards document is provided in the challenge forum which will be accessible after registration.

Requirements

• Update existing swagger to be in compliance with Topcoder API V5 standards

• Swagger version will remain as 2.0 itself

• Updates required in the existing Swagger briefly involves

  • Update response structure and headers of each endpoint to be in compliance with V5 standards (E.g. Use pagination headers in listing endpoints)

  • Use status code 200 instead of 201 everywhere

  • Use status code 400 in place of 422 for invalid inputs.

  • Ensure that all endpoints which require JWT has 401 status code defined

  • Ensure that all endpoints which has permissions defined has 403 status code defined

  • Update the query parameters to be in compliance with V5 standards (E.g. GET /projects, filter parameter is a URL encoded string with multiple filters as a string. In V5 API, Every field listed like id, name, memberOnly etc.. will become a separate query parameter for that endpoint)

Important Notes:

• Use swagger editor to validate the updated swagger

• Ensure that there are no validation errors in the updated swagger

• Topcoder Submission API swagger could be used as a reference to update the existing swagger

Final Submission Guidelines

• Zip the updated Swagger file and submit the zip file using the Submit link