Checkers | CodeBattles

[ADMIN] Get all checkers

get

Retrieves a list of all checkers. Required admin role.

Authorizations

Responses

200

OK

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

GET /api/checkers HTTP/1.1
Host: localhost:8080
Authorization: Bearer JWT
Accept: */*

[
  {
    "id": 1,
    "displayName": "Default Python3 Checker",
    "languageHighlightName": "python"
  }
]

[ADMIN] Create a checker

post

Creates a new checker. Required admin role.

Authorizations

Body

Details for creating a new checker

displayNamestringRequired

Display name of the checker

Example: Python Checker

languageHighlightNamestringRequired

Language highlight name for the checker

Example: python

addressstringRequired

Address of the checker service

Example: http://localhost:8080

Responses

200

OK

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

post

POST /api/checkers HTTP/1.1
Host: localhost:8080
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 99

{
  "displayName": "Python Checker",
  "languageHighlightName": "python",
  "address": "http://localhost:8080"
}

{
  "displayName": "text",
  "languageHighlightName": "text",
  "address": "text",
  "id": 1,
  "createdAt": "2025-06-30T18:41:08.744Z",
  "updatedAt": "2025-06-30T18:41:08.744Z"
}

[ADMIN] Get checker by ID

get

Retrieves a checker by its ID. Required admin role.

Authorizations

Path parameters

idinteger · int64Required

Responses

200

OK

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

GET /api/checkers/{id} HTTP/1.1
Host: localhost:8080
Authorization: Bearer JWT
Accept: */*

{
  "id": 1,
  "displayName": "Default Python3 Checker",
  "languageHighlightName": "python"
}

[ADMIN] Delete a checker

delete

Deletes a specific checker by its ID. Required admin role.

Authorizations

Path parameters

idinteger · int64Required

Responses

200

OK

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

delete

DELETE /api/checkers/{id} HTTP/1.1
Host: localhost:8080
Authorization: Bearer JWT
Accept: */*

{
  "displayName": "text",
  "languageHighlightName": "text",
  "address": "text",
  "id": 1,
  "createdAt": "2025-06-30T18:41:08.744Z",
  "updatedAt": "2025-06-30T18:41:08.744Z"
}

[ADMIN] Update a checker

patch

Applies partial updates to a checker by its ID. Required admin role.

Authorizations

Path parameters

idinteger · int64Required

Body

anyOptional

Responses

200

OK

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

patch

PATCH /api/checkers/{id} HTTP/1.1
Host: localhost:8080
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*

{
  "displayName": "text",
  "languageHighlightName": "text",
  "address": "text",
  "id": 1,
  "createdAt": "2025-06-30T18:41:08.744Z",
  "updatedAt": "2025-06-30T18:41:08.744Z"
}

[ADMIN] Get checker by ID (extra fields)

get

Retrieves a checker by its ID with admin-level access. Required admin role.

Authorizations

Path parameters

idinteger · int64Required

Responses

200

OK

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

GET /api/checkers/{id}/admin HTTP/1.1
Host: localhost:8080
Authorization: Bearer JWT
Accept: */*

{
  "displayName": "text",
  "languageHighlightName": "text",
  "address": "text",
  "id": 1,
  "createdAt": "2025-06-30T18:41:08.744Z",
  "updatedAt": "2025-06-30T18:41:08.744Z"
}