Reviews

Submit, list, and dismiss reviews to approve or reject the changes captured in a build.

List the reviews submitted on a build

get

List the reviews submitted on a build, with pagination.

Authorizations

personalAccessToken

AuthorizationstringRequired

Authenticate as a user with a personal access token.

Send it as a bearer token in the Authorization header:

Authorization: Bearer <personal-access-token>

Personal access tokens act on behalf of the user that created them and are required by endpoints that perform user actions, such as reviewing builds and posting comments.

Path parameters

ownerstring · min: 1Required

projectstring · min: 1Required

buildNumberstringRequired

The build number

Example: 42

Responses

200

Build reviews

application/json

Build review

idstringRequired

buildIdstringRequired

statestring · enumRequired

State of a build review: approved, rejected, commented (neutral) or pending (an unsubmitted draft).

Possible values:

dismissedAtstring · nullableRequired

Date the review was dismissed, null if not dismissed.

datestringRequired

Date the review was created.

400

Invalid parameters

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Server error

application/json

get/projects/{owner}/{project}/builds/{buildNumber}/reviews

HTTPcURLJavaScriptPython

GET /v2/projects/{owner}/{project}/builds/{buildNumber}/reviews HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "text",
    "buildId": "text",
    "state": "approved",
    "user": {
      "id": "text",
      "slug": "text",
      "name": "text"
    },
    "dismissedAt": "text",
    "dismissedBy": {
      "id": "text",
      "slug": "text",
      "name": "text"
    },
    "date": "text"
  }
]

Create a review on a build

post

Submit a review on a build to approve or reject the changes it captured.

Authorizations

personalAccessToken

AuthorizationstringRequired

Authenticate as a user with a personal access token.

Send it as a bearer token in the Authorization header:

Authorization: Bearer <personal-access-token>

Personal access tokens act on behalf of the user that created them and are required by endpoints that perform user actions, such as reviewing builds and posting comments.

Path parameters

ownerstring · min: 1Required

projectstring · min: 1Required

buildNumberstringRequired

The build number

Example: 42

Body

application/json

eventstring · enumOptional

Review event to apply to the build: "APPROVE", "REJECT" or "COMMENT". Required when conclusion is not provided.

Possible values:

conclusionstring · enumOptionalDeprecated

Deprecated: use event instead. Overall review conclusion for the build: "APPROVE" or "REQUEST_CHANGES".

Possible values:

bodyanyOptional

Optional comment to attach to the review. Either Markdown text or the JSON representation of a rich-text document.

Responses

200

Review submitted successfully — returns the review

application/json

Build review

idstringRequired

buildIdstringRequired

statestring · enumRequired

State of a build review: approved, rejected, commented (neutral) or pending (an unsubmitted draft).

Possible values:

dismissedAtstring · nullableRequired

Date the review was dismissed, null if not dismissed.

datestringRequired

Date the review was created.

400

Invalid parameters

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Server error

application/json

post/projects/{owner}/{project}/builds/{buildNumber}/reviews

HTTPcURLJavaScriptPython

POST /v2/projects/{owner}/{project}/builds/{buildNumber}/reviews HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 82

{
  "event": "APPROVE",
  "body": null,
  "snapshots": [
    {
      "id": "text",
      "conclusion": "APPROVE"
    }
  ]
}

{
  "id": "text",
  "buildId": "text",
  "state": "approved",
  "user": {
    "id": "text",
    "slug": "text",
    "name": "text"
  },
  "dismissedAt": "text",
  "dismissedBy": {
    "id": "text",
    "slug": "text",
    "name": "text"
  },
  "date": "text"
}

Dismiss a submitted review on a build

post

Dismiss a previously submitted review on a build, clearing its effect on the build's review status.

Authorizations

personalAccessToken

AuthorizationstringRequired

Authenticate as a user with a personal access token.

Send it as a bearer token in the Authorization header:

Authorization: Bearer <personal-access-token>

Personal access tokens act on behalf of the user that created them and are required by endpoints that perform user actions, such as reviewing builds and posting comments.

Path parameters

ownerstring · min: 1Required

projectstring · min: 1Required

buildNumberstringRequired

The build number

Example: 42

reviewIdstringRequired

The ID of the review

Responses

200

Review dismissed successfully — returns the review

application/json

Build review

idstringRequired

buildIdstringRequired

statestring · enumRequired

State of a build review: approved, rejected, commented (neutral) or pending (an unsubmitted draft).

Possible values:

dismissedAtstring · nullableRequired

Date the review was dismissed, null if not dismissed.

datestringRequired

Date the review was created.

400

Invalid parameters

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Server error

application/json

post/projects/{owner}/{project}/builds/{buildNumber}/reviews/{reviewId}/dismiss

HTTPcURLJavaScriptPython

POST /v2/projects/{owner}/{project}/builds/{buildNumber}/reviews/{reviewId}/dismiss HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "buildId": "text",
  "state": "approved",
  "user": {
    "id": "text",
    "slug": "text",
    "name": "text"
  },
  "dismissedAt": "text",
  "dismissedBy": {
    "id": "text",
    "slug": "text",
    "name": "text"
  },
  "date": "text"
}