@PLUGIN@ - /plugins/@PLUGIN@/checks.pending/ REST API

This page describes the pending-checks-related REST endpoints that are added by the @PLUGIN@ plugin.

Please also take note of the general information on the REST API.

Pending Checks Endpoints

List Pending Checks

‘GET /plugins/@PLUGIN@/checks.pending/’

Lists pending checks for a checker.

Checks are pending if they are in a non-final state and the external checker system intends to post further updates on them.

By default this REST endpoint only returns checks that are in state NOT_STARTED but callers may specify the states that they are interested in (see state request parameter).

Request parameters:

checker: the UUID of the checker for which pending checks should be listed (required)
state: state that should be considered as pending (optional, by default the state NOT_STARTED is assumed, this option may be specified multiple times to request checks matching any of several states)

This REST endpoint only returns pending checks for current patch sets.

Note that all users are allowed to list pending checks but the result includes only checks on changes that are visible to the calling user. This means pending checks for non-visible changes are filtered out.

Request by checker

  GET /plugins/@PLUGIN@/checks.pending/?checker=test:my-checker&state=NOT_STARTED&state=SCHEDULED HTTP/1.0

As response a list of PendingChecksInfo entities is returned that describes the pending checks.

Response by checker

  HTTP/1.1 200 OK
  Content-Disposition: attachment
  Content-Type: application/json; charset=UTF-8
  )]}'
  [
    {
      "patch_set": {
        "project": "test-project",
        "change_number": 1,
        "patch_set_id": 1,
      }
      "pending_checks": {
        "test:my-checker": {
          "state": "NOT_STARTED",
        }
      }
    },
    {
      "patch_set": {
        "project": "test-project",
        "change_number": 5,
        "patch_set_id": 2,
      }
      "pending_checks": {
        "test:my-checker": {
          "state": "SCHEDULED",
        }
      }
    }
  ]

JSON Entities

CheckablePatchSetInfo

The CheckablePatchSetInfo entity describes a patch set for which checks are pending.

Field Name	Description
`project`	The project name that this pending check applies to.
`change_number`	The change number that this pending check applies to.
`patch_set_id`	The ID of the patch set that this pending check applies to.

PendingCheckInfo

The PendingCheckInfo entity describes a pending check.

Field Name	Description
`state`	The state of the pending check

PendingChecksInfo

The PendingChecksInfo entity describes the pending checks on patch set.

Field Name	Description
`patch_set`	The patch set for checks are pending as CheckablePatchSetInfo entity.
`pending_checks`	The checks that are pending for the patch set as checker UUID to PendingCheckInfo entity.