Operations related to remotes.
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.
Git provider type.
curl -i -X POST \
https://redocly.com/_mock/docs/realm/scout/api/openapi/orgs/acme-inc/projects/my-project/scout/todos \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-H 'x-redocly-scout-version: 1.0.0' \
-d '{
"type": "PROCESS_GIT_REPO",
"providerId": "string",
"providerType": "GITHUB_CLOUD",
"namespaceId": "string",
"repositoryId": "string",
"branch": "string",
"commitSha": "string",
"isMainBranch": false,
"prId": "string",
"parentJobId": "sjob_01h2t9ksv7vmsvbhh5ty40zctw",
"checks": [
{
"name": "Scorecard - Compliance API",
"status": "IN_PROGRESS",
"description": "string",
"targetUrl": "string"
}
],
"metadata": {
"errorMessage": "string",
"errorStack": "string"
}
}'
{ "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" }
Use the endCursor
as a value for the after
parameter to get the next page.
Use the startCursor
as a value for the before
parameter to get the next page.
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.
Filters the collection items. This field requires a special format.
For more information, see Using filter with collections.
curl -i -X GET \
'https://redocly.com/_mock/docs/realm/scout/api/openapi/orgs/acme-inc/projects/my-project/scout/todos?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'
OK.
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.
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.
Value showing how many items are in the page limit.
Git provider type.
ID of the parent job, if any.
{ "object": "list", "page": { "endCursor": "string", "startCursor": "string", "hasNextPage": true, "hasPrevPage": true, "limit": 10, "total": 0 }, "items": [ { … } ] }