Challenge Overview
Welcome to the Topcoder Submissions API - OpenAPI Specification contest. As part of this contest, you will create a Swagger Specification for Topcoder’s Submissions API.
ATTENTION: We will be 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 are now looking to create the swagger specification for the Submissions API.
We will share a diagram in the contest forum that contains 4 objects of concerns for this contest, namely:
-
Submission
-
ReviewSummation
-
Review
-
ReviewType
We would like you to define the endpoints for these 4 objects in the OpenAPI specification. You need to use OpenAPI version 3 for this contest.
We will share an ERD diagram. We will also share an OpenAPI specification that we have for another set of Topcoder services that you can use as reference, in addition to a Standards document. You are expected to follow conventions used in these reference assets. Note that you are not updating the provided specification. You will be creating a new specification document.
Points To Note
-
Follow the conventions used in the OpenAPI Specification shared as reference. This is for reference only. Do not update this specification. For this contest, you will be submitting a new OpenAPI specification document.
-
The OpenAPI specification shared takes inspiration from Github and Gitlab APIs. It contains additional features such as headers and user roles / authorizations that are relevant for this contest. You are required to add these to the OpenAPI specification for these endpoints - as the first point says, follow conventions used in the provided 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.
Final Submission Guidelines
Upload the specification to Topcoder