REredocly
Todos

Create a job todo

Changed on

Git provider webhook triggers Scout to create a job todo. Similarly, a lint job started or completed triggers jobs todo. Since Scout is stateless and distributed, this is the API for storing things to do. It's also a way to communicate with Scout by making jobs for it to do too (such as communicating status back to Git). Finally, it can be used to trigger Scout to update again in the case of a GitHub webhook outage.

post/orgs/{orgId}/projects/{projectId}/scout/todos

Request

Path parameters

orgIdstring required
Example:acme-inc

Organization ID.

projectIdstring required
Example:my-project

Project ID.

Headers

x-redocly-scout-versionstring
Example:1.0.0

Scout version.

Request body

idstring ulid required

ID of the job.

status'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' required

Job status.

type'PROCESS_GIT_REPO' | 'UPDATE_STATUS' required

Type of job.

organizationIdstring

Organization ID.

projectIdstring

Project ID.

providerIdstring

Git provider identifier (appId for GitHub).

providerType'GITHUB_CLOUD' | 'GITHUB_SERVER' | 'GITLAB_CLOUD' | 'GITLAB_SELF_MANAGED' | 'BITBUCKET_CLOUD' | 'BITBUCKET_DATACENTER' | 'AZURE' required

Git provider type.

namespaceIdstring required

Git repo namespace id (organization login for GitHub).

repositoryIdstring required

Git repo id.

branchstring required

Git branch name.

commitShastring required

Git commit SHA.

isMainBranchboolean

True if branch is main.

prIdstring

Git pull request ID.

attemptsinteger required

Number of attempts to process the job.

parentJobIdstring ulid

ID of the parent job, if any.

startedAtstring date-time

Job start date.

createdAtstring date-time required

Job creation date.

updatedAtstring date-time required

Job last update date.

Example request

{
  "id": "sjob_01h2t9ksv7vmsvbhh5ty40zctw",
  "parentJobId": "sjob_01h2t9ksv7vmsvbhh5ty40zctw",
  "checks": [
    {
      "name": "Scorecard - Compliance API"
    }
  ],
  "metadata": {
    "scoutVersion": "1.0.0"
  }
}

Response

Created.

idstring ulid required

ID of the job.

status'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' required

Job status.

type'PROCESS_GIT_REPO' | 'UPDATE_STATUS' required

Type of job.

organizationIdstring

Organization ID.

projectIdstring

Project ID.

providerIdstring

Git provider identifier (appId for GitHub).

providerType'GITHUB_CLOUD' | 'GITHUB_SERVER' | 'GITLAB_CLOUD' | 'GITLAB_SELF_MANAGED' | 'BITBUCKET_CLOUD' | 'BITBUCKET_DATACENTER' | 'AZURE' required

Git provider type.

namespaceIdstring required

Git repo namespace id (organization login for GitHub).

repositoryIdstring required

Git repo id.

branchstring required

Git branch name.

commitShastring required

Git commit SHA.

isMainBranchboolean

True if branch is main.

prIdstring

Git pull request ID.

attemptsinteger required

Number of attempts to process the job.

parentJobIdstring ulid

ID of the parent job, if any.

startedAtstring date-time

Job start date.

createdAtstring date-time required

Job creation date.

updatedAtstring date-time required

Job last update date.

Example response

{
  "id": "sjob_01h2t9ksv7vmsvbhh5ty40zctw",
  "parentJobId": "sjob_01h2t9ksv7vmsvbhh5ty40zctw",
  "checks": [
    {
      "name": "Scorecard - Compliance API"
    }
  ],
  "metadata": {
    "scoutVersion": "1.0.0"
  }
}

Changes

  • 5dc606d075e4Revision changes
    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status