# dev.knotless.listWorkflows

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

✓ This is the authoritative definition for this NSID.

## Description

A repository's workflows at a ref, and what runs each there.

## Links

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

## Definitions

### `dev.knotless.listWorkflows`

**Type**: `query`

The workflows under .knotless/workflows at a ref of a repository, in file name order, each with what runs it there, as `knotless workflows` lists them: which its owner may ask for by name, with variables, through dev.knotless.requestRerun. No authentication; responses are not personalized.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `ref` | `string` | No | A branch or a tag, by name or in full; the default branch if none. |
| `repo` | `string` (at-uri) | Yes | The repository's dev.knotless.repo record, as dev.knotless.getRepo takes it. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `ref` | `string` | Yes | The ref, in full. |
| `workflows` | `array` | Yes |  |

#### Errors

- **NotFound**: No such repository, or no such ref.

### `dev.knotless.listWorkflows#workflowView`

**Type**: `object`

A workflow at the ref, and what runs it there.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `asked` | `boolean` | Yes | Its owner may ask for it at the ref by name: it runs on a push there, or its asked trigger names the ref. |
| `error` | `string` | No | Why it does not load: nothing runs it then. |
| `name` | `string` | Yes | What its checks are filed as. |
| `pull` | `boolean` | Yes | A pull into the ref, a branch, runs it. |
| `push` | `boolean` | Yes | A push to the ref runs it. |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "The workflows under .knotless/workflows at a ref of a repository, in file name order, each with what runs it there, as `knotless workflows` lists them: which its owner may ask for by name, with variables, through dev.knotless.requestRerun. No authentication; responses are not personalized.",
      "errors": [
        {
          "description": "No such repository, or no such ref.",
          "name": "NotFound"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "ref": {
              "description": "The ref, in full.",
              "type": "string"
            },
            "workflows": {
              "items": {
                "ref": "#workflowView",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "ref",
            "workflows"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "ref": {
            "description": "A branch or a tag, by name or in full; the default branch if none.",
            "maxLength": 1024,
            "type": "string"
          },
          "repo": {
            "description": "The repository's dev.knotless.repo record, as dev.knotless.getRepo takes it.",
            "format": "at-uri",
            "type": "string"
          }
        },
        "required": [
          "repo"
        ],
        "type": "params"
      },
      "type": "query"
    },
    "workflowView": {
      "description": "A workflow at the ref, and what runs it there.",
      "properties": {
        "asked": {
          "description": "Its owner may ask for it at the ref by name: it runs on a push there, or its asked trigger names the ref.",
          "type": "boolean"
        },
        "error": {
          "description": "Why it does not load: nothing runs it then.",
          "type": "string"
        },
        "name": {
          "description": "What its checks are filed as.",
          "type": "string"
        },
        "pull": {
          "description": "A pull into the ref, a branch, runs it.",
          "type": "boolean"
        },
        "push": {
          "description": "A push to the ref runs it.",
          "type": "boolean"
        }
      },
      "required": [
        "name",
        "push",
        "pull",
        "asked"
      ],
      "type": "object"
    }
  },
  "description": "A repository's workflows at a ref, and what runs each there.",
  "id": "dev.knotless.listWorkflows",
  "lexicon": 1
}
```