dev.knotless.listWorkflows Documentation (EN)

main 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

ref string Optional

A branch or a tag, by name or in full; the default branch if none.

repo string at-uri Required

The repository's dev.knotless.repo record, as dev.knotless.getRepo takes it.

Output

Encodingapplication/json

ref string Required

The ref, in full.

workflows array Required

No description available.

Errors

NotFound No such repository, or no such ref.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

ref A branch or a tag, by name or in full; the default branch if none.

repo * The repository's dev.knotless.repo record, as dev.knotless.getRepo takes it.

View raw schema

{
  "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 object

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

Properties

asked boolean Required

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 Optional

Why it does not load: nothing runs it then.

name string Required

What its checks are filed as.

pull boolean Required

A pull into the ref, a branch, runs it.

push boolean Required

A push to the ref runs it.

View raw schema

{
  "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"
}