Redocly Scout (1.0)

Download OpenAPI description

Overview

API Support team@redocly.com

License Redocly

Terms of Service

Servers

Mock server

https://redocly.com/_mock/docs/realm/scout/api/openapi/

Production main server.

https://{host}/api/

Remotes

Operations related to remotes.

Operations

Metadata

Operations related to metadata.

Operations

Todos

Operations related to todos.

Operations

Tasks

Operations related to tasks.

Operations

Process next job

Request

Retrieve and start the next available job.

Path

orgIdstringrequired

Organization ID.

Example: acme-inc

projectIdstringrequired

Project ID.

Example: my-project

Headers

x-redocly-scout-versionstring

Scout version.

Example: 1.0.0

curl -i -X POST \
  https://redocly.com/_mock/docs/realm/scout/api/openapi/orgs/acme-inc/projects/my-project/scout/tasks \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-redocly-scout-version: 1.0.0'

Responses

OK.

Bodyapplication/json

idstring(ulid)read-onlyrequired

ID of the job.

Example: "sjob_01h2t9ksv7vmsvbhh5ty40zctw"

statusstringread-onlyrequired

Job status.

Enum"PENDING""PROCESSING""COMPLETED""FAILED"

typestringrequired

Type of job.

Enum"PROCESS_GIT_REPO""UPDATE_STATUS"

organizationIdstringread-onlyrequired

Organization ID.

projectIdstringread-onlyrequired

Project ID.

providerIdstring

Git provider identifier (appId for GitHub).

providerTypestringrequired

Git provider type.

Enum"GITHUB_CLOUD""GITHUB_SERVER""GITLAB_CLOUD""GITLAB_SELF_MANAGED""BITBUCKET_CLOUD""BITBUCKET_DATACENTER""AZURE"

namespaceIdstringrequired

Git repo namespace id (organization login for GitHub).

repositoryIdstringrequired

Git repo id.

branchstringrequired

Git branch name.

commitShastringrequired

Git commit SHA.

isMainBranchboolean

True if branch is main.

Default false

prIdstring

Git pull request ID.

attemptsintegerread-onlyrequired

Number of attempts to process the job.

parentJobIdstring(ulid)

ID of the parent job, if any.

Example: "sjob_01h2t9ksv7vmsvbhh5ty40zctw"

checksArray of objects(GitCommitCheck)

Commit status checks.

metadataobject(JobMetadata)

Additional information about job.

startedAtstring(date-time)read-only

Job start date.

createdAtstring(date-time)read-onlyrequired

Job creation date.

updatedAtstring(date-time)read-onlyrequired

Job last update date.

Response

application/json

{
  "id": "sjob_01h2t9ksv7vmsvbhh5ty40zctw",
  "status": "PENDING",
  "type": "PROCESS_GIT_REPO",
  "organizationId": "string",
  "projectId": "string",
  "providerId": "string",
  "providerType": "GITHUB_CLOUD",
  "namespaceId": "string",
  "repositoryId": "string",
  "branch": "string",
  "commitSha": "string",
  "isMainBranch": false,
  "prId": "string",
  "attempts": 0,
  "parentJobId": "sjob_01h2t9ksv7vmsvbhh5ty40zctw",
  "checks": [
    { … }
  ],
  "metadata": {
    "scoutVersion": "1.0.0",
    "errorMessage": "string",
    "errorStack": "string"
  },
  "startedAt": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

List all tasks

Request

Path

orgIdstringrequired

Organization ID.

Example: acme-inc

projectIdstringrequired

Project ID.

Example: my-project

Query

afterstring

Use the endCursor as a value for the after parameter to get the next page.

Example: after=a25fgaksjf23la==

beforestring

Use the startCursor as a value for the before parameter to get the next page.

Example: before=bfg23aksjf23zb1==

sortstring

This list is currently not sortable by other properties. It is sorted by the id descending (-id) by default. To reverse the sort order, use id as the value.

Default "-id"

filterstring

Filters the collection items. This field requires a special format.

For more information, see Using filter with collections.

Example: filter=status:approved,pending updatedAt:2020-01-01..2022-01-01

limitinteger[ 1 .. 100 ]

Use to return a number of results per page. If there is more data, use in combination with after to page through the data.

Default 10

Headers

x-redocly-scout-versionstring

Scout version.

Example: 1.0.0

curl -i -X GET \
  'https://redocly.com/_mock/docs/realm/scout/api/openapi/orgs/acme-inc/projects/my-project/scout/tasks?after=a25fgaksjf23la%3D%3D&before=bfg23aksjf23zb1%3D%3D&filter=status%3Aapproved%2Cpending%20updatedAt%3A2020-01-01..2022-01-01&limit=10&sort=-id' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-redocly-scout-version: 1.0.0'

Responses

OK.

Bodyapplication/json

objectstringrequired

Value "list"

pageobject(Page)required

page.endCursorstring or nullrequired

Use with the after query parameter to load the next page of data. When null, there is no data. The cursor is opaque and internal structure is subject to change.

page.startCursorstring or nullrequired

Use with the before query parameter to load the previous page of data. When null, there is no data. The cursor is opaque and internal structure is subject to change.

page.hasNextPagebooleanrequired

Indicates if there is a next page with items.

page.hasPrevPagebooleanrequired

Indicates if there is a previous page with items.

page.limitinteger[ 1 .. 100 ]required

Value showing how many items are in the page limit.

Default 10

page.totalinteger>= 0required

Count of items across all pages.

itemsArray of objects(Job)>= 0 itemsrequired

items[].idstring(ulid)read-onlyrequired

ID of the job.

Example: "sjob_01h2t9ksv7vmsvbhh5ty40zctw"

items[].statusstringread-onlyrequired

Job status.

Enum"PENDING""PROCESSING""COMPLETED""FAILED"

items[].typestringrequired

Type of job.

Enum"PROCESS_GIT_REPO""UPDATE_STATUS"

items[].organizationIdstringread-onlyrequired

Organization ID.

items[].projectIdstringread-onlyrequired

Project ID.

items[].providerIdstring

Git provider identifier (appId for GitHub).

items[].providerTypestringrequired

Git provider type.

Enum"GITHUB_CLOUD""GITHUB_SERVER""GITLAB_CLOUD""GITLAB_SELF_MANAGED""BITBUCKET_CLOUD""BITBUCKET_DATACENTER""AZURE"

items[].namespaceIdstringrequired

Git repo namespace id (organization login for GitHub).

items[].repositoryIdstringrequired

Git repo id.

items[].branchstringrequired

Git branch name.

items[].commitShastringrequired

Git commit SHA.

items[].isMainBranchboolean

True if branch is main.

Default false

items[].prIdstring

Git pull request ID.

items[].attemptsintegerread-onlyrequired

Number of attempts to process the job.

items[].parentJobIdstring(ulid)

ID of the parent job, if any.

Example: "sjob_01h2t9ksv7vmsvbhh5ty40zctw"

items[].checksArray of objects(GitCommitCheck)

Commit status checks.

items[].metadataobject(JobMetadata)

Additional information about job.

items[].startedAtstring(date-time)read-only

Job start date.

items[].createdAtstring(date-time)read-onlyrequired

Job creation date.

items[].updatedAtstring(date-time)read-onlyrequired

Job last update date.

Response

application/json

{
  "object": "list",
  "page": {
    "endCursor": "string",
    "startCursor": "string",
    "hasNextPage": true,
    "hasPrevPage": true,
    "limit": 10,
    "total": 0
  },
  "items": [
    { … }
  ]
}

Get task

Request

Get task.

Path

orgIdstringrequired

Organization ID.

Example: acme-inc

projectIdstringrequired

Project ID.

Example: my-project

jobIdstring(ulid)required

Job ID.

Example: sjob_01h2t9ksv7vmsvbhh5ty40zctw

Headers

x-redocly-scout-versionstring

Scout version.

Example: 1.0.0

curl -i -X GET \
  https://redocly.com/_mock/docs/realm/scout/api/openapi/orgs/acme-inc/projects/my-project/scout/tasks/sjob_01h2t9ksv7vmsvbhh5ty40zctw \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-redocly-scout-version: 1.0.0'

Responses

OK.

Bodyapplication/json

idstring(ulid)read-onlyrequired

ID of the job.

Example: "sjob_01h2t9ksv7vmsvbhh5ty40zctw"

statusstringread-onlyrequired

Job status.

Enum"PENDING""PROCESSING""COMPLETED""FAILED"

typestringrequired

Type of job.

Enum"PROCESS_GIT_REPO""UPDATE_STATUS"

organizationIdstringread-onlyrequired

Organization ID.

projectIdstringread-onlyrequired

Project ID.

providerIdstring

Git provider identifier (appId for GitHub).

providerTypestringrequired

Git provider type.

Enum"GITHUB_CLOUD""GITHUB_SERVER""GITLAB_CLOUD""GITLAB_SELF_MANAGED""BITBUCKET_CLOUD""BITBUCKET_DATACENTER""AZURE"

namespaceIdstringrequired

Git repo namespace id (organization login for GitHub).

repositoryIdstringrequired

Git repo id.

branchstringrequired

Git branch name.

commitShastringrequired

Git commit SHA.

isMainBranchboolean

True if branch is main.

Default false

prIdstring

Git pull request ID.

attemptsintegerread-onlyrequired

Number of attempts to process the job.

parentJobIdstring(ulid)

ID of the parent job, if any.

Example: "sjob_01h2t9ksv7vmsvbhh5ty40zctw"

checksArray of objects(GitCommitCheck)

Commit status checks.

metadataobject(JobMetadata)

Additional information about job.

startedAtstring(date-time)read-only

Job start date.

createdAtstring(date-time)read-onlyrequired

Job creation date.

updatedAtstring(date-time)read-onlyrequired

Job last update date.

Response

application/json

{
  "id": "sjob_01h2t9ksv7vmsvbhh5ty40zctw",
  "status": "PENDING",
  "type": "PROCESS_GIT_REPO",
  "organizationId": "string",
  "projectId": "string",
  "providerId": "string",
  "providerType": "GITHUB_CLOUD",
  "namespaceId": "string",
  "repositoryId": "string",
  "branch": "string",
  "commitSha": "string",
  "isMainBranch": false,
  "prId": "string",
  "attempts": 0,
  "parentJobId": "sjob_01h2t9ksv7vmsvbhh5ty40zctw",
  "checks": [
    { … }
  ],
  "metadata": {
    "scoutVersion": "1.0.0",
    "errorMessage": "string",
    "errorStack": "string"
  },
  "startedAt": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Update job

Request

Scout sends this API request after completing a job. Supports only PROCESSING -> COMPLETED and PROCESSING -> FAILED transitions.

Path

orgIdstringrequired

Organization ID.

Example: acme-inc

projectIdstringrequired

Project ID.

Example: my-project

jobIdstring(ulid)required

Job ID.

Example: sjob_01h2t9ksv7vmsvbhh5ty40zctw

Headers

x-redocly-scout-versionstring

Scout version.

Example: 1.0.0

Bodyapplication/json

statusstringrequired

Job status.

Enum"COMPLETED""FAILED"

metadataobject(JobMetadata)

Additional information about job.

curl -i -X PATCH \
  https://redocly.com/_mock/docs/realm/scout/api/openapi/orgs/acme-inc/projects/my-project/scout/tasks/sjob_01h2t9ksv7vmsvbhh5ty40zctw \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'x-redocly-scout-version: 1.0.0' \
  -d '{
    "status": "COMPLETED",
    "metadata": {
      "errorMessage": "string",
      "errorStack": "string"
    }
  }'

Responses

OK.

Bodyapplication/json

idstring(ulid)read-onlyrequired

ID of the job.

Example: "sjob_01h2t9ksv7vmsvbhh5ty40zctw"

statusstringread-onlyrequired

Job status.

Enum"PENDING""PROCESSING""COMPLETED""FAILED"

typestringrequired

Type of job.

Enum"PROCESS_GIT_REPO""UPDATE_STATUS"

organizationIdstringread-onlyrequired

Organization ID.

projectIdstringread-onlyrequired

Project ID.

providerIdstring

Git provider identifier (appId for GitHub).

providerTypestringrequired

Git provider type.

Enum"GITHUB_CLOUD""GITHUB_SERVER""GITLAB_CLOUD""GITLAB_SELF_MANAGED""BITBUCKET_CLOUD""BITBUCKET_DATACENTER""AZURE"

namespaceIdstringrequired

Git repo namespace id (organization login for GitHub).

repositoryIdstringrequired

Git repo id.

branchstringrequired

Git branch name.

commitShastringrequired

Git commit SHA.

isMainBranchboolean

True if branch is main.

Default false

prIdstring

Git pull request ID.

attemptsintegerread-onlyrequired

Number of attempts to process the job.

parentJobIdstring(ulid)

ID of the parent job, if any.

Example: "sjob_01h2t9ksv7vmsvbhh5ty40zctw"

checksArray of objects(GitCommitCheck)

Commit status checks.

metadataobject(JobMetadata)

Additional information about job.

startedAtstring(date-time)read-only

Job start date.

createdAtstring(date-time)read-onlyrequired

Job creation date.

updatedAtstring(date-time)read-onlyrequired

Job last update date.

Response

application/json

{
  "id": "sjob_01h2t9ksv7vmsvbhh5ty40zctw",
  "status": "PENDING",
  "type": "PROCESS_GIT_REPO",
  "organizationId": "string",
  "projectId": "string",
  "providerId": "string",
  "providerType": "GITHUB_CLOUD",
  "namespaceId": "string",
  "repositoryId": "string",
  "branch": "string",
  "commitSha": "string",
  "isMainBranch": false,
  "prId": "string",
  "attempts": 0,
  "parentJobId": "sjob_01h2t9ksv7vmsvbhh5ty40zctw",
  "checks": [
    { … }
  ],
  "metadata": {
    "scoutVersion": "1.0.0",
    "errorMessage": "string",
    "errorStack": "string"
  },
  "startedAt": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Status

Operations related to status.

Operations