# dev.knotless.listRuns

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

✓ This is the authoritative definition for this NSID.

## Description

What a repository's runners ran: every run of its workflows, and the workflows themselves.

## Links

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

## Definitions

### `dev.knotless.listRuns`

**Type**: `query`

The runs of a public repository's workflows that the runners its record names reported, newest first, of every workflow or of one: each as its check, with what it ran on. And the workflows on its default branch, those that run only when asked for by name among them. A page at a time: follow `cursor` until it is absent. No authentication; responses are not personalized.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No | The `cursor` of the page before. |
| `limit` | `integer` | No |  |
| `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. |
| `workflow` | `string` | No | Only the runs of this workflow, by name. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No | Absent on the last page. |
| `minutes` | `array` | No | The minutes each of the repository's runners counts for its owner, where it has counted any; none for a private repository. |
| `runs` | `array` | Yes |  |
| `workflows` | `array` | Yes | The workflows in .knotless/workflows on the default branch, by name. |

### `dev.knotless.listRuns#runView`

**Type**: `object`

One run of a workflow, with what it ran on.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `batch` | `integer` | No | For a run of a merge queue's batch, how many pulls it lands. |
| `check` | `ref` → `dev.knotless.defs#checkView` | Yes |  |
| `pull` | `ref` → `dev.knotless.defs#itemViewBasic` | No | For a run of a pull's head, the pull. |
| `ref` | `string` | Yes | The ref it ran at, in full: for a pull's run its head branch, for a merge queue batch's the branch it lands on. |
| `subject` | `string` | No | For a run of a commit pushed to the ref, the first line of its message, where this server has the commit. |

### `dev.knotless.listRuns#workflowView`

**Type**: `object`

A workflow file on the default branch.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `about` | `string` | No | The first sentence of the comment its file opens with. |
| `asked` | `boolean` | No | Whether it runs only when asked for by name, on no push or pull. |
| `name` | `string` | Yes |  |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "The runs of a public repository's workflows that the runners its record names reported, newest first, of every workflow or of one: each as its check, with what it ran on. And the workflows on its default branch, those that run only when asked for by name among them. A page at a time: follow `cursor` until it is absent. No authentication; responses are not personalized.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "cursor": {
              "description": "Absent on the last page.",
              "maxLength": 2048,
              "type": "string"
            },
            "minutes": {
              "description": "The minutes each of the repository's runners counts for its owner, where it has counted any; none for a private repository.",
              "items": {
                "ref": "dev.knotless.defs#minutesView",
                "type": "ref"
              },
              "type": "array"
            },
            "runs": {
              "items": {
                "ref": "#runView",
                "type": "ref"
              },
              "type": "array"
            },
            "workflows": {
              "description": "The workflows in .knotless/workflows on the default branch, by name.",
              "items": {
                "ref": "#workflowView",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "runs",
            "workflows"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "cursor": {
            "description": "The `cursor` of the page before.",
            "maxLength": 2048,
            "type": "string"
          },
          "limit": {
            "default": 30,
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          },
          "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"
          },
          "workflow": {
            "description": "Only the runs of this workflow, by name.",
            "maxLength": 64,
            "type": "string"
          }
        },
        "required": [
          "repo"
        ],
        "type": "params"
      },
      "type": "query"
    },
    "runView": {
      "description": "One run of a workflow, with what it ran on.",
      "properties": {
        "batch": {
          "description": "For a run of a merge queue's batch, how many pulls it lands.",
          "minimum": 1,
          "type": "integer"
        },
        "check": {
          "ref": "dev.knotless.defs#checkView",
          "type": "ref"
        },
        "pull": {
          "description": "For a run of a pull's head, the pull.",
          "ref": "dev.knotless.defs#itemViewBasic",
          "type": "ref"
        },
        "ref": {
          "description": "The ref it ran at, in full: for a pull's run its head branch, for a merge queue batch's the branch it lands on.",
          "maxLength": 1024,
          "type": "string"
        },
        "subject": {
          "description": "For a run of a commit pushed to the ref, the first line of its message, where this server has the commit.",
          "type": "string"
        }
      },
      "required": [
        "check",
        "ref"
      ],
      "type": "object"
    },
    "workflowView": {
      "description": "A workflow file on the default branch.",
      "properties": {
        "about": {
          "description": "The first sentence of the comment its file opens with.",
          "type": "string"
        },
        "asked": {
          "default": false,
          "description": "Whether it runs only when asked for by name, on no push or pull.",
          "type": "boolean"
        },
        "name": {
          "maxLength": 64,
          "type": "string"
        }
      },
      "required": [
        "name"
      ],
      "type": "object"
    }
  },
  "description": "What a repository's runners ran: every run of its workflows, and the workflows themselves.",
  "id": "dev.knotless.listRuns",
  "lexicon": 1
}
```