dev.knotless.getThread

A pull or an issue on a repository: what it says, what was said on it, and for a pull what it brings in, how its checks stand and where it is in the merge queue. No authentication; asked as an account, with a service token or the pages' session cookie, the answer says what that account may do with it, and which reactions are its own. A private repository is read for its members asking so.

Details · query
Kindquery
Authorityknotless.dev
Indexed

Query

query · GET

Parameters

query string

filesOnly

boolean

A pull's changed files without their rows: what each is, how many lines it adds and removes, and a note where its rows would not be shown. dev.knotless.getPullDiff gives the rows of the files a reader comes to.

  • default: false

firstRows

boolean

With filesOnly, the rows of the first files too, as a page draws them at once: from the first, those whose rows would be shown, up to 10 files and 1500 changed lines, passing over any that changes more than 400. The rest come without, for dev.knotless.getPullDiff.

  • default: false

repo

requiredstring · at-uri

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

requiredstring · at-uri

The dev.knotless.pull or dev.knotless.issue record.

Output

application/json

base

string

A pull's target branch.

body

string

What it says, as its author wrote it, in Markdown.

card

requiredstring

The path of the picture its page unfurls into.

What a pull brings in; absent for an issue, or a pull whose branch is gone.

checks

requiredarray

For a pull, the newest run of each workflow at its head: by the target's runners for the pull, and by those of the repository it comes from for its branch. For a pull the merge queue landed, the runs it landed on: those on its base at its batch's tip.

itemsref

For a closed issue, the pull whose merge closed it.

closes

requiredarray

The issues on the repository a pull's title or body names to close as it merges into the default branch.

itemsref

comments

requiredarray

Oldest first.

itemsref

head

ref

What a pull brings in.

html

string

Its body, made into HTML as a comment's is.

item

requiredref

For an issue, the pulls on the repository whose title or body names it, oldest first, whatever their state. Absent when none does.

itemsref
Reference

merged

string

For a merged pull, the commit it merged as.

minutes

array

For a pull, the minutes each runner of the target counts for the target's owner, where it has counted any; none for a private repository.

itemsref

Where an open pull stands in its branch's merge queue, if it was queued or ejected from it.

How accounts reacted to the pull or issue itself, by content, as dev.knotless.getReactions counts them. Absent when none did.

For a merged pull, the revert whose merge undid it: a pull naming it in its `reverts`, merged too. The newest, if it was undone more than once.

reviews

array

For a pull, where each reviewer stands, in the order they last reviewed. Absent when no one has.

itemsref

For a pull built on another or under one, the whole chain. Absent when it stands alone.

What the account asking may do with it; absent when no one asks.

Reference

Errors

NotFound

No such repository or record on it; or this appview keeps no index, so it knows no pulls or issues.

#mention

object

A pull that names an issue.

Properties

closes

boolean

Whether it names the issue after a closing keyword, so that merging it into the default branch closes it. Not, when absent.

item

requiredref

The pull.

#viewerState

object

What the account asking may do with a pull or an issue, past commenting on it, editing what it wrote and reporting, which anyone may.

Properties

assign

boolean

Whether it may assign it, and ask for reviews of a pull besides its author, with dev.knotless.assignItem: as the repository's owner or a collaborator.

dismiss

boolean

Whether it may dismiss a pull's reviews with dev.knotless.dismissReview: as the repository's owner or a collaborator.

hide

boolean

Whether it may hide it, or what is said on it: as the repository's owner.

labels

array

The labels the repository defines that it may put on or take off, in the order the repository defines them.

itemsref

Why the account asking hears of new comments on it with no choice made: as its `author`, as one who `commented`, or as `watching` its repository. Absent when it hears of none, but those that mention it.

  • maxLength: 64
  • knownValues: author | commented | watching

revert

boolean

Whether it may revert a merged pull with dev.knotless.revertPull: as the repository's owner or a collaborator.

setState

boolean

Whether it may close or reopen it: as who opened it, or the repository's owner or a collaborator.

What the account asking chose to hear of it (dev.knotless.putSubscription): every comment, as `subscribed`, or nothing, as `muted`. Absent when it chose nothing.

  • maxLength: 64
  • knownValues: subscribed | muted

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.