Challenge Overview
Welcome to the Topcoder Services - OpenAPI Specification contest. As part of this contest, you will update an existing OpenAPI based specification to include endpoint definitions for an existing set of services on the Topcoder platform.
ATTENTION: The duration for the submission phase is 48 hours. We are also using the Subjective scorecard for this contest
Contest Details
Topcoder is now streamlining their APIs by releasing a new version and following a standard. We ran a contest earlier where we created a specification for a set of endpoints. We now have a code base with some additional endpoints that we would like to define in the specification.
Your task for this contest is:
-
Go through the source code of Topcoder Bus API and check out the Postman Collection that defines the endpoints in the app. Note that this project has two Postman Collections in the source code. Make sure you are checking out the correct one.
-
Go through the provided OpenAPI Specification and determine which endpoints exist in the code base that are not defined in the specification. Note that you may come across definitions in the specification that are not yet implemented in the code base. That is ok. You don’t have to make changes to that. You only need to add definitions for endpoints that exist in the code base but not in the OpenAPI specification
Points To Note
-
Follow the conventions used in the existing OpenAPI Specification
-
We believe the Postman collection pointed out contains all endpoints in the codebase. If you come across any endpoint that exists in the code base but is not part of the Postman collection, please do let us know
-
The OpenAPI specification shared takes inspiration from Github and Gitlab APIs. It contains additional features such as headers and user roles / authorizations that you may not find implemented for the existing endpoints in the code base. You are required to add these to the OpenAPI specification for these endpoints nevertheless - as the first point says, follow conventions used in the existing OpenAPI specification
-
We will also share with you a Standard documentation that was used when creating the OpenAPI specification. You can refer to that as well. In case of a conflict between the OpenAPI specification and the Standards document, follow the OpenAPI specification.
-
We are using OpenAPI Specification version 3.0.1. Please don't’ change this
Final Submission Guidelines
Upload the specification to Topcoder