Ctrlk
discordx-twitter
For the complete documentation index, see llms.txt. This page is also available as Markdown.

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
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.

get/projects/{owner}/{project}/builds/{buildNumber}/reviews
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": null
    },
    "dismissedAt": null,
    "dismissedBy": {
      "id": "text",
      "slug": "text",
      "name": null
    },
    "agent": {
      "id": "text",
      "name": null
    },
    "date": "text"
  }
]

Create a review on a build

post

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

Authorizations
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
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.

post/projects/{owner}/{project}/builds/{buildNumber}/reviews
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": null
  },
  "dismissedAt": null,
  "dismissedBy": {
    "id": "text",
    "slug": "text",
    "name": null
  },
  "agent": {
    "id": "text",
    "name": null
  },
  "date": "text"
}

List a build's requested reviewers

get

List the users currently requested to review a build.

Authorizations
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

The users requested to review the build

application/json

The review requests standing on a build.

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

{
  "reviewers": [
    {
      "id": "text",
      "slug": "text",
      "name": null
    }
  ]
}

Request reviewers on a build

post

Ask users to review a build. Each newly-requested reviewer is notified. Idempotent: users already requested are left untouched and not notified again. Users without access to the project are ignored, and you cannot request yourself.

Authorizations
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
userIdsstring[] · min: 1 · max: 100Required

Identifiers of the users to act on — the id of a user as returned by listBuildReviewers or getMe.

Responses
200

The users requested to review the build

application/json

The review requests standing on a build.

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

{
  "userIds": [
    "text"
  ]
}
{
  "reviewers": [
    {
      "id": "text",
      "slug": "text",
      "name": null
    }
  ]
}

Cancel review requests on a build

delete

Cancel the review requests standing on a build. Removing a user that was not requested is a no-op.

Authorizations
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
userIdsstring[] · min: 1 · max: 100Required

Identifiers of the users to act on — the id of a user as returned by listBuildReviewers or getMe.

Responses
200

The users still requested to review the build

application/json

The review requests standing on a build.

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

{
  "userIds": [
    "text"
  ]
}
{
  "reviewers": [
    {
      "id": "text",
      "slug": "text",
      "name": null
    }
  ]
}

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
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.

post/projects/{owner}/{project}/builds/{buildNumber}/reviews/{reviewId}/dismiss
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": null
  },
  "dismissedAt": null,
  "dismissedBy": {
    "id": "text",
    "slug": "text",
    "name": null
  },
  "agent": {
    "id": "text",
    "name": null
  },
  "date": "text"
}

Last updated

Was this helpful?