Review Request

List review requests for the authenticated user

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

typestring · enumOptional

Filter requests (e.g., "sent", "received", "all")

Possible values:

Responses

200

List of review requests retrieved

application/json

401

Unauthorized

get

/api/v1/review-requests

HTTPcURLJavaScriptPython

GET /api/v1/review-requests HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "code": "text",
  "message": "text",
  "data": [
    {
      "id": 1,
      "reviewee": {
        "id": 1,
        "userId": 1,
        "displayName": "text",
        "preferences": [
          "text"
        ],
        "createdAt": "2025-12-29T19:45:45.357Z",
        "updatedAt": "2025-12-29T19:45:45.357Z"
      },
      "reviewer": {
        "id": 1,
        "userId": 1,
        "expertise": "text",
        "bio": "text",
        "tags": [
          "text"
        ],
        "createdAt": "2025-12-29T19:45:45.357Z",
        "updatedAt": "2025-12-29T19:45:45.357Z"
      },
      "githubLink": "text",
      "requestDetails": "text",
      "status": "PENDING",
      "createdAt": "2025-12-29T19:45:45.357Z",
      "updatedAt": "2025-12-29T19:45:45.357Z"
    }
  ]
}

Create a new review request (by a Reviewee)

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

reviewerIdinteger · int64Required

ID of the Reviewer being requested.

githubLinkstring · urlRequired

requestDetailsstringRequired

Responses

201

Review request created successfully

application/json

400

Invalid request (e.g., reviewerId not found)

401

Unauthorized (User not logged in or not a reviewee)

post

/api/v1/review-requests

HTTPcURLJavaScriptPython

POST /api/v1/review-requests HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "reviewerId": 1,
  "githubLink": "text",
  "requestDetails": "text"
}

{
  "code": "text",
  "message": "text",
  "data": {
    "id": 1,
    "reviewee": {
      "id": 1,
      "userId": 1,
      "displayName": "text",
      "preferences": [
        "text"
      ],
      "createdAt": "2025-12-29T19:45:45.357Z",
      "updatedAt": "2025-12-29T19:45:45.357Z"
    },
    "reviewer": {
      "id": 1,
      "userId": 1,
      "expertise": "text",
      "bio": "text",
      "tags": [
        "text"
      ],
      "createdAt": "2025-12-29T19:45:45.357Z",
      "updatedAt": "2025-12-29T19:45:45.357Z"
    },
    "githubLink": "text",
    "requestDetails": "text",
    "status": "PENDING",
    "createdAt": "2025-12-29T19:45:45.357Z",
    "updatedAt": "2025-12-29T19:45:45.357Z"
  }
}

Get a specific review request

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

requestIdinteger · int64Required

ID of the Review Request

Responses

200

Review request details retrieved

application/json

401

Unauthorized

403

Forbidden (not involved in this request)

404

Review request not found

get

/api/v1/review-requests/{requestId}

HTTPcURLJavaScriptPython

GET /api/v1/review-requests/{requestId} HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "code": "text",
  "message": "text",
  "data": {
    "id": 1,
    "reviewee": {
      "id": 1,
      "userId": 1,
      "displayName": "text",
      "preferences": [
        "text"
      ],
      "createdAt": "2025-12-29T19:45:45.357Z",
      "updatedAt": "2025-12-29T19:45:45.357Z"
    },
    "reviewer": {
      "id": 1,
      "userId": 1,
      "expertise": "text",
      "bio": "text",
      "tags": [
        "text"
      ],
      "createdAt": "2025-12-29T19:45:45.357Z",
      "updatedAt": "2025-12-29T19:45:45.357Z"
    },
    "githubLink": "text",
    "requestDetails": "text",
    "status": "PENDING",
    "createdAt": "2025-12-29T19:45:45.357Z",
    "updatedAt": "2025-12-29T19:45:45.357Z"
  }
}

Reviewer approves a review request

patch

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

requestIdinteger · int64Required

ID of the Review Request to approve

Responses

200

Review request approved

application/json

400

Request cannot be approved (e.g., not PENDING)

401

Unauthorized

403

Forbidden (not the designated reviewer)

404

Review request not found

patch

/api/v1/review-requests/{requestId}/approve

HTTPcURLJavaScriptPython

PATCH /api/v1/review-requests/{requestId}/approve HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "code": "text",
  "message": "text",
  "data": {
    "id": 1,
    "reviewee": {
      "id": 1,
      "userId": 1,
      "displayName": "text",
      "preferences": [
        "text"
      ],
      "createdAt": "2025-12-29T19:45:45.357Z",
      "updatedAt": "2025-12-29T19:45:45.357Z"
    },
    "reviewer": {
      "id": 1,
      "userId": 1,
      "expertise": "text",
      "bio": "text",
      "tags": [
        "text"
      ],
      "createdAt": "2025-12-29T19:45:45.357Z",
      "updatedAt": "2025-12-29T19:45:45.357Z"
    },
    "githubLink": "text",
    "requestDetails": "text",
    "status": "PENDING",
    "createdAt": "2025-12-29T19:45:45.357Z",
    "updatedAt": "2025-12-29T19:45:45.357Z"
  }
}

Reviewer rejects a review request

patch

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

requestIdinteger · int64Required

ID of the Review Request to reject

Responses

200

Review request rejected

application/json

400

Request cannot be rejected

401

Unauthorized

403

Forbidden

404

Review request not found

patch

/api/v1/review-requests/{requestId}/reject

HTTPcURLJavaScriptPython

PATCH /api/v1/review-requests/{requestId}/reject HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "code": "text",
  "message": "text",
  "data": {
    "id": 1,
    "reviewee": {
      "id": 1,
      "userId": 1,
      "displayName": "text",
      "preferences": [
        "text"
      ],
      "createdAt": "2025-12-29T19:45:45.357Z",
      "updatedAt": "2025-12-29T19:45:45.357Z"
    },
    "reviewer": {
      "id": 1,
      "userId": 1,
      "expertise": "text",
      "bio": "text",
      "tags": [
        "text"
      ],
      "createdAt": "2025-12-29T19:45:45.357Z",
      "updatedAt": "2025-12-29T19:45:45.357Z"
    },
    "githubLink": "text",
    "requestDetails": "text",
    "status": "PENDING",
    "createdAt": "2025-12-29T19:45:45.357Z",
    "updatedAt": "2025-12-29T19:45:45.357Z"
  }
}

Reviewee cancels their own review request

patch

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

requestIdinteger · int64Required

ID of the Review Request to cancel

Responses

200

Review request canceled

application/json

400

Request cannot be canceled (e.g., not PENDING)

401

Unauthorized

403

Forbidden (not the original reviewee)

404

Review request not found

patch

/api/v1/review-requests/{requestId}/cancel

HTTPcURLJavaScriptPython

PATCH /api/v1/review-requests/{requestId}/cancel HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "code": "text",
  "message": "text",
  "data": {
    "id": 1,
    "reviewee": {
      "id": 1,
      "userId": 1,
      "displayName": "text",
      "preferences": [
        "text"
      ],
      "createdAt": "2025-12-29T19:45:45.357Z",
      "updatedAt": "2025-12-29T19:45:45.357Z"
    },
    "reviewer": {
      "id": 1,
      "userId": 1,
      "expertise": "text",
      "bio": "text",
      "tags": [
        "text"
      ],
      "createdAt": "2025-12-29T19:45:45.357Z",
      "updatedAt": "2025-12-29T19:45:45.357Z"
    },
    "githubLink": "text",
    "requestDetails": "text",
    "status": "PENDING",
    "createdAt": "2025-12-29T19:45:45.357Z",
    "updatedAt": "2025-12-29T19:45:45.357Z"
  }
}