dev.knotless.getQueue

lexicons.knotless.dev

Documentation

What is queued on each branch of a repository, in the order it lands, the batches being checked, the open pulls the queue turned away and why, and the batches it landed last, as the runners the repository names report them. No authentication; responses are not personalized.

main query

What is queued on each branch of a repository, in the order it lands, the batches being checked, the open pulls the queue turned away and why, and the batches it landed last, as the runners the repository names report them. No authentication; responses are not personalized.

Parameters

repo string at-uri Required

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.

Output

Encodingapplication/json
branches array Required

Each branch with pulls queued, by name.

ejected array Required

The open pulls the queue turned away, newest first.

landed array Required

The last few batches landed, newest first.

Errors

NotFound No such repository; or this appview keeps no index, so it knows no pulls.
Try It

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

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
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.
View raw schema
{
  "description": "What is queued on each branch of a repository, in the order it lands, the batches being checked, the open pulls the queue turned away and why, and the batches it landed last, as the runners the repository names report them. No authentication; responses are not personalized.",
  "errors": [
    {
      "description": "No such repository; or this appview keeps no index, so it knows no pulls.",
      "name": "NotFound"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "branches": {
          "description": "Each branch with pulls queued, by name.",
          "items": {
            "ref": "#branchView",
            "type": "ref"
          },
          "type": "array"
        },
        "ejected": {
          "description": "The open pulls the queue turned away, newest first.",
          "items": {
            "ref": "#ejectedView",
            "type": "ref"
          },
          "type": "array"
        },
        "landed": {
          "description": "The last few batches landed, newest first.",
          "items": {
            "ref": "#landedView",
            "type": "ref"
          },
          "type": "array"
        }
      },
      "required": [
        "branches",
        "ejected",
        "landed"
      ],
      "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"
      }
    },
    "required": [
      "repo"
    ],
    "type": "params"
  },
  "type": "query"
}
batchView object

A batch being checked, or landing once its checks have passed.

Properties

commit string Required

The commit it would leave the branch at, in hex.

size integer Required

How many pulls are in it.

minimum: 1
state string Required

No description available.

Known values: checking, landing
View raw schema
{
  "description": "A batch being checked, or landing once its checks have passed.",
  "properties": {
    "checks": {
      "description": "The newest run of each workflow at its commit.",
      "items": {
        "ref": "dev.knotless.defs#checkView",
        "type": "ref"
      },
      "type": "array"
    },
    "commit": {
      "description": "The commit it would leave the branch at, in hex.",
      "type": "string"
    },
    "size": {
      "description": "How many pulls are in it.",
      "minimum": 1,
      "type": "integer"
    },
    "state": {
      "knownValues": [
        "checking",
        "landing"
      ],
      "type": "string"
    }
  },
  "required": [
    "commit",
    "state",
    "size",
    "checks"
  ],
  "type": "object"
}
branchView object

A branch's merge queue.

Properties

batches array of ref#batchView Required

The batches being checked or landing, in the order they land: a pull names the one it is in.

branch string Required

The branch's name.

pulls array of ref#queuedView Required

In the order they land.

View raw schema
{
  "description": "A branch's merge queue.",
  "properties": {
    "batches": {
      "description": "The batches being checked or landing, in the order they land: a pull names the one it is in.",
      "items": {
        "ref": "#batchView",
        "type": "ref"
      },
      "type": "array"
    },
    "branch": {
      "description": "The branch's name.",
      "type": "string"
    },
    "pulls": {
      "description": "In the order they land.",
      "items": {
        "ref": "#queuedView",
        "type": "ref"
      },
      "type": "array"
    }
  },
  "required": [
    "branch",
    "pulls",
    "batches"
  ],
  "type": "object"
}
ejectedView object

A pull the merge queue turned away.

Properties

ejectedAt string datetime Required

An RFC 3339 formatted timestamp.

reason string Optional

Why, as the runner said.

View raw schema
{
  "description": "A pull the merge queue turned away.",
  "properties": {
    "checks": {
      "description": "The checks of its batch that did not pass, if they are why.",
      "items": {
        "ref": "dev.knotless.defs#checkView",
        "type": "ref"
      },
      "type": "array"
    },
    "ejectedAt": {
      "format": "datetime",
      "type": "string"
    },
    "pull": {
      "ref": "dev.knotless.defs#itemView",
      "type": "ref"
    },
    "reason": {
      "description": "Why, as the runner said.",
      "type": "string"
    }
  },
  "required": [
    "pull",
    "ejectedAt",
    "checks"
  ],
  "type": "object"
}
landedView object

A batch the merge queue landed.

Properties

branch string Required

The branch's name.

commit string Required

The commit it left the branch at, in hex.

landedAt string datetime Optional

An RFC 3339 formatted timestamp.

View raw schema
{
  "description": "A batch the merge queue landed.",
  "properties": {
    "branch": {
      "description": "The branch's name.",
      "type": "string"
    },
    "commit": {
      "description": "The commit it left the branch at, in hex.",
      "type": "string"
    },
    "landedAt": {
      "format": "datetime",
      "type": "string"
    },
    "pulls": {
      "description": "In the order they were squashed onto the branch.",
      "items": {
        "ref": "dev.knotless.defs#itemView",
        "type": "ref"
      },
      "type": "array"
    }
  },
  "required": [
    "branch",
    "commit",
    "pulls"
  ],
  "type": "object"
}
queuedView object

A pull in a merge queue.

Properties

batch integer Optional

The batch it is in, by its place in its branch's `batches`.

minimum: 0
queuedAt string datetime Required

An RFC 3339 formatted timestamp.

said string Required

Where it stands, in words: `Queued, 3rd of 5`, `In a batch of 4 being checked` or `Landing`.

View raw schema
{
  "description": "A pull in a merge queue.",
  "properties": {
    "batch": {
      "description": "The batch it is in, by its place in its branch's `batches`.",
      "minimum": 0,
      "type": "integer"
    },
    "pull": {
      "ref": "dev.knotless.defs#itemView",
      "type": "ref"
    },
    "queuedAt": {
      "format": "datetime",
      "type": "string"
    },
    "said": {
      "description": "Where it stands, in words: `Queued, 3rd of 5`, `In a batch of 4 being checked` or `Landing`.",
      "type": "string"
    }
  },
  "required": [
    "pull",
    "queuedAt",
    "said"
  ],
  "type": "object"
}

Lexicon Garden

@