# dev.knotless.listChecks

> Published by [lexicons.knotless.dev](https://lexicon.garden/identity/did:plc:yqsg7znbbhfmj3a2nrpnaerk)

✓ This is the authoritative definition for this NSID.

## Description

What the runners a public repository trusts have reported of its workflows, as an appview has indexed it from the firehose.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:yqsg7znbbhfmj3a2nrpnaerk/dev.knotless.listChecks)
- [Documentation](https://lexicon.garden/lexicon/did:plc:yqsg7znbbhfmj3a2nrpnaerk/dev.knotless.listChecks/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:yqsg7znbbhfmj3a2nrpnaerk/dev.knotless.listChecks/examples)

## Definitions

### `dev.knotless.listChecks#check`

**Type**: `object`

One check, as its runner wrote it.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `runner` | `string` (did) | Yes | The account the check is in: one of the repository's runners. |
| `uri` | `string` (at-uri) | Yes | The check record's URI. |
| `value` | `unknown` | Yes | The dev.knotless.check record verbatim. |

### `dev.knotless.listChecks`

**Type**: `query`

The dev.knotless.check records written about a public repository by the accounts its record names in `runners`, newest run first; checks by any other account, and anything the appview has taken down, are left out. The `runners` read are those of the repository's record as the appview has it now. A page at a time: follow `cursor` until it is absent. No authentication; responses are not personalized.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `commit` | `string` | No | Only checks of this commit, its hex object ID. |
| `cursor` | `string` | No | The `cursor` of the page before. |
| `key` | `string` (tid) | Yes | The repository's `key`. |
| `limit` | `integer` | No |  |
| `pull` | `string` (at-uri) | No | Only the runs of this pull's head. |
| `ref` | `string` | No | Only checks of this ref, named in full, such as refs/heads/main. |
| `repo` | `string` (at-uri) | Yes | The repository's dev.knotless.repo record; only its owner is matched. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `checks` | `array` | Yes |  |
| `cursor` | `string` | No | Absent on the last page. |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "check": {
      "description": "One check, as its runner wrote it.",
      "properties": {
        "runner": {
          "description": "The account the check is in: one of the repository's runners.",
          "format": "did",
          "type": "string"
        },
        "uri": {
          "description": "The check record's URI.",
          "format": "at-uri",
          "type": "string"
        },
        "value": {
          "description": "The dev.knotless.check record verbatim.",
          "type": "unknown"
        }
      },
      "required": [
        "uri",
        "runner",
        "value"
      ],
      "type": "object"
    },
    "main": {
      "description": "The dev.knotless.check records written about a public repository by the accounts its record names in `runners`, newest run first; checks by any other account, and anything the appview has taken down, are left out. The `runners` read are those of the repository's record as the appview has it now. A page at a time: follow `cursor` until it is absent. No authentication; responses are not personalized.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "checks": {
              "items": {
                "ref": "#check",
                "type": "ref"
              },
              "type": "array"
            },
            "cursor": {
              "description": "Absent on the last page.",
              "maxLength": 2048,
              "type": "string"
            }
          },
          "required": [
            "checks"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "commit": {
            "description": "Only checks of this commit, its hex object ID.",
            "maxLength": 64,
            "minLength": 40,
            "type": "string"
          },
          "cursor": {
            "description": "The `cursor` of the page before.",
            "maxLength": 2048,
            "type": "string"
          },
          "key": {
            "description": "The repository's `key`.",
            "format": "tid",
            "type": "string"
          },
          "limit": {
            "default": 50,
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          },
          "pull": {
            "description": "Only the runs of this pull's head.",
            "format": "at-uri",
            "type": "string"
          },
          "ref": {
            "description": "Only checks of this ref, named in full, such as refs/heads/main.",
            "maxLength": 1024,
            "type": "string"
          },
          "repo": {
            "description": "The repository's dev.knotless.repo record; only its owner is matched.",
            "format": "at-uri",
            "type": "string"
          }
        },
        "required": [
          "repo",
          "key"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "description": "What the runners a public repository trusts have reported of its workflows, as an appview has indexed it from the firehose.",
  "id": "dev.knotless.listChecks",
  "lexicon": 1
}
```