Skip to content

V5 mapping

Justin Gasper edited this page Apr 28, 2020 · 3 revisions

List of Topcoder API used in Topcoder-X

Topcoder-X Processor

Challenge API

Available v4 to V5 API Mappings

API Path (v4) Wrapper Function (v4) Service (v5) API Path (v5)
GET /challenges/{id} challengesIdGet challenge-api GET /challenges/{id}
POST /challenges saveDraftContest challenge-api POST /challenges
PUT /challenges/{id} challengesIdPut challenge-api PUT /challenges/{id}
GET /challenges/{id}/resources challengesIdResourcesGet resources-api GET /resources?challengeId={id}
POST /challenges/{id}/resources challengesIdResourcesPost resources-api POST /resources
DELETE /challenges/{id}/resources challengesIdResourcesDelete resources-api DELETE /resources

Unavailable v4 to V5 API Mappings

These are topcoder challenge API v4 that are used in topcoder-x but there are no API similarity in v5. But some of them might have possible alternative API. We need to confirm them to make sure that the backend behavior is applicable.

API Path (v4) Wrapper Function (v4) Possible v5 API Note
POST /challenges/{id}/activate activateChallenge PATCH /challenges/{id} Updating a challenge with v5 PATCH method and body {"status":"Active"}
POST /challenges/{id}/close closePrivateContest PATCH /challenges/{id} Updating a challenge with v5 PATCH method and body {"status":"Completed"}
POST /challenges/{id}/cancel cancelPrivateContest PATCH /challenges/{id} Updating a challenge with v5 PATCH method and body {"status":"Canceled"}. This API is implemented in topcoder-api-helper.js but the method is never user. So we may can ignore it.
POST /challenges/{id}/unregister unregisterChallenge N/A This can now be handled via the resources API. Previously we tried to do this, but it always failed in the challenge API.

Project API

Available v4 to V5 API Mappings

API Path (v4) Wrapper Function (v4) Service (v5) API Path (v5)
POST /direct/projects directProjectsPost project-api POST /projects
GET /direct/projects/{projectId} directProjectsProjectIdGet project-api GET /projects/{projectId}

Member API

Available v4 to V5 API Mappings

API Path (v4) Service (v5) API Path (v5)
GET /members/{handle} member-api GET /members/{handle}

Topcoder-X UI

Challenge API

Available v4 to V5 API Mappings

API Path (v4) Service (v5) API Path (v5)
GET /challenges/{id} challenge-api GET /challenges/{id}

Auth API

API Path (v3) Service (v5) API Path (v5)
GET /authorizations/1 N/A N/A
Clone this wiki locally