# dev.knotless.getCheck

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

✓ This is the authoritative definition for this NSID.

## Description

A check of one of a repository's workflows.

## Links

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

## Definitions

### `dev.knotless.getCheck`

**Type**: `query`

A check of one of a repository's workflows, as its runner reported it: each step, and the end of what they printed. Only a check by a runner the repository's record names is found. No authentication; responses are not personalized.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `repo` | `string` (at-uri) | Yes | The repository's dev.knotless.repo record. Its authority may be a handle; a name the repository had before, or an owner it moved from with its agreement, finds it under the name it has now. |
| `uri` | `string` (at-uri) | Yes | The dev.knotless.check record, by a runner the repository names. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `check` | `ref` → `dev.knotless.defs#checkView` | Yes |  |
| `log` | `string` | No | The end of what its steps printed, each step's after a line `==> <name>`. |
| `pull` | `string` (at-uri) | No | The dev.knotless.pull it ran for, if it ran for one. |
| `ref` | `string` | Yes | The ref it ran at, in full, such as refs/heads/main. |
| `runner` | `ref` → `dev.knotless.defs#actorView` | Yes | The account that ran it. |
| `steps` | `array` | Yes | In the order they ran. |

#### Errors

- **InvalidRequest**: `uri` names no dev.knotless.check record.
- **NotFound**: No such repository, or no such check of it by a runner it names.

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "A check of one of a repository's workflows, as its runner reported it: each step, and the end of what they printed. Only a check by a runner the repository's record names is found. No authentication; responses are not personalized.",
      "errors": [
        {
          "description": "`uri` names no dev.knotless.check record.",
          "name": "InvalidRequest"
        },
        {
          "description": "No such repository, or no such check of it by a runner it names.",
          "name": "NotFound"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "check": {
              "ref": "dev.knotless.defs#checkView",
              "type": "ref"
            },
            "log": {
              "description": "The end of what its steps printed, each step's after a line `==> <name>`.",
              "type": "string"
            },
            "pull": {
              "description": "The dev.knotless.pull it ran for, if it ran for one.",
              "format": "at-uri",
              "type": "string"
            },
            "ref": {
              "description": "The ref it ran at, in full, such as refs/heads/main.",
              "type": "string"
            },
            "runner": {
              "description": "The account that ran it.",
              "ref": "dev.knotless.defs#actorView",
              "type": "ref"
            },
            "steps": {
              "description": "In the order they ran.",
              "items": {
                "ref": "dev.knotless.check#step",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "check",
            "ref",
            "runner",
            "steps"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "repo": {
            "description": "The repository's dev.knotless.repo record. Its authority may be a handle; a name the repository had before, or an owner it moved from with its agreement, finds it under the name it has now.",
            "format": "at-uri",
            "type": "string"
          },
          "uri": {
            "description": "The dev.knotless.check record, by a runner the repository names.",
            "format": "at-uri",
            "type": "string"
          }
        },
        "required": [
          "repo",
          "uri"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "description": "A check of one of a repository's workflows.",
  "id": "dev.knotless.getCheck",
  "lexicon": 1
}
```