dev.knotless.defs
Definitions shared by the knotless lexicons.
Details · defs
| Kind | defs |
|---|---|
| Authority | knotless.dev |
| Commit rev | 3n2w5pow3i2dy |
| Indexed |
Showing version bafyreihvzojmkozestfd6rznjhhgmd2tfcvra3y626izddu44byyv6qbia. Show the latest
#actorView
objectAn account, as an appview shows it beside what it did.
Properties
avatar
string · uriThe account's picture, as in dev.knotless.getProfile#profileView.
bot
booleanWhether its knotless profile says it is a bot, as the appview has indexed. Absent when it does not, and from an appview that keeps no index.
The handle the account claims, when it resolves back to it; else the DID.
#actorViewerState
objectWhat the account asking a query has to do with an account.
#attachmentView
objectA picture a pull, an issue or a comment attaches, as readers load it: from this appview, with no cookie or header needed.
Properties
The attached blob.
height
integerHow high it is drawn, in CSS pixels, as its record's dev.knotless.defs#image says.
minimum: 1
An absolute URL on this appview's public origin that serves it: dev.knotless.getAttachment's. For a private repository it carries a `token` for the account that asked, lasting about an hour and ended by their logging out here: theirs alone, not to be shared or kept.
width
integerHow wide it is drawn, in CSS pixels, as its record's dev.knotless.defs#image says.
minimum: 1
#byteSlice
objectA span of a text, by its UTF-8 bytes, counted from zero: the start inclusive, the end exclusive.
#changesView
objectWhat a pull brings in: for a merged one, what its merge brought into the base; otherwise what its branch has since it left the base.
Properties
Oldest first.
As an editor's file tree lists them: in each directory, its directories before its files, each by name.
head
stringFor an open pull, the hex object ID of the commit its branch is at: what its checks and reviews are of.
The repository whose commit pages show its commits.
#checkImageView
objectA picture a check made: screenshots of the pages a change moved, say.
#checkView
objectThe newest run of a workflow, as a runner the repository names in its record reported it.
Properties
The commit it ran at, in hex.
error
stringWhy it could not run.
finishedAt
string · datetimeThe pictures it made to be looked at, in order.
The repository it is of, whose pages show it.
skipped
stringFor a `success` that ran nothing, as the change touched none of the paths its workflow names: why.
`queued` is a run filed and waiting for a job on its runner, no step started yet.
knownValues: queued | running | success | failure | error | cancelled
Its dev.knotless.check record.
#commentView
objectSomething said on a pull, an issue or a gist.
Properties
attachments
arrayThe pictures its record attaches (dev.knotless.defs#image), in its order, each where any reader loads it. Absent when it attaches none.
body
stringWhat it says, as its author wrote it, in Markdown.
commit
stringFor a review of a pull, the hex object ID of the head it looked at; for a comment on its lines, the commit they are in.
dismisses
string · at-uriThe review, another comment on the pull, this dismissed, its body saying why: from the owner or a collaborator.
What it says, its Markdown made into HTML: raw HTML shown as text, and links made relative to the repository.
reactions
arrayHow accounts reacted to it, by content, in the order dev.knotless.defs#reactionContent lists them. Absent when none did.
reply
string · at-uriThe comment starting the thread on a pull's lines that this answers.
resolved
booleanFor a comment starting a thread on a pull's lines, whether the thread is resolved.
review
string · at-uriThe review this was sent with, as one of its line comments.
updatedAt
string · datetimeWhen its author last changed it, if they have.
uri
string · at-uriIts dev.knotless.comment record.
verdict
stringFor a review, what it found.
knownValues: approve | changes
#commitAuthorView
objectWho wrote a commit or helped to: by the name git gives, and by account when that is one of the repository's people whose address it is.
#commitRefView
objectA commit, by its object name.
Properties
In hex.
#commitView
objectA commit, with the accounts that wrote it where the repository's pages believe their claims (dev.knotless.emails).
Properties
Who its message's `Co-authored-by` trailers name.
committedAt
string · datetimeWhen it was committed: what history runs in, as its author's date need not.
committer
refWho committed it, when someone other than its author did.
When its author made it, which a rebase or a squash keeps.
Its message, less the last line naming the pull it merged, if it did.
pull
refThe pull that brought it in: the one its message's last line names, as a squash or merge commit records it, when that is a pull on this repository; else the merged pull whose merge brought it into the branch, as a fast-forward's commits.
Its object name, in hex.
#diffRowView
objectOne row of a file's diff: a hunk header, a note, or a line with its old and new numbers.
#facet
objectWhere a text says more than its words, shaped as app.bsky.richtext.facet: the span it covers and what that span is. A pull's, an issue's or a comment's body has its own, and a pull's or an issue's title its own.
Properties
What the span is. Kinds unknown to a reader are passed over.
maxLength: 8
#fileDiffView
objectOne file of a diff, or why its rows are not shown.
Properties
Lines added.
minimum: 0
hunkCount
integerOf those rows, how many are hunk headers, which a page may draw taller than a line.
minimum: 0
Its path after.
note
stringWhy its rows are not shown, when they are not.
Its path before.
ranges
stringThe ranges its highlighting paints, encoded as the pages read them.
Lines removed.
minimum: 0
rowCount
integerWhere its rows are left out but would be shown, as dev.knotless.getThread's filesOnly leaves them, how many there are: the room a page keeps for them until they come.
minimum: 0
knownValues: added | deleted | renamed | modified
#followState
objectAn account's followers, as following or unfollowing it leaves them.
Properties
How many accounts follow it now.
minimum: 0
following
string · at-uriThe asker's dev.knotless.follow record naming it; absent once unfollowed.
#gistFile
objectA file of a gist.
Properties
The file's name, at the root of the gist's default branch.
maxLength: 255
#gistView
objectA gist among others: a dev.knotless.repo record whose kind is gist, its files flat at the root of its default branch.
Properties
commentCount
integerHow many comments stand on it, as dev.knotless.getGistComments lists them. Absent from an appview that keeps no index.
minimum: 0
As its record says.
description
stringHow many files are at the root of its default branch, as `files` was read.
minimum: 0
The first ten files at the root of its default branch, by name, ignoring case. Empty when the appview could not read them, or nothing was pushed.
maxLength: 10
How many forks of it there are, as the appview has indexed: 0 from an appview that keeps no index.
minimum: 0
The gist's name: its record key, a TID given when it was made.
How many accounts starred it, as the appview has indexed: 0 from an appview that keeps no index.
minimum: 0
Its dev.knotless.repo record.
#image
objectA picture a pull's, an issue's or a comment's body shows, attached so its author's PDS keeps it. The body links to it on that PDS, as `com.atproto.sync.getBlob` serves it, saying what it shows as Markdown's alt text; readers may show it from elsewhere, as dev.knotless.getAttachment does.
Properties
height
integerHow high it is drawn, in CSS pixels, as `width` is.
minimum: 1
maxSize: 1000000accept: image/png, image/jpeg, image/webp, image/gif
width
integerHow wide it is drawn, in CSS pixels: its pixels over the density it was made at, so a screenshot taken at 2x shows at the size it was seen. Readers draw it no wider than where it goes, keeping its shape.
minimum: 1
#itemView
objectA pull or an issue in a list of them.
Properties
assignees
arrayThose the repository's owner or collaborators assign it to, in the order assigned (dev.knotless.assignment). Absent when it is assigned to no one.
attachments
arrayThe pictures its record attaches (dev.knotless.defs#image), in its order, each where any reader loads it. Given where the view is made for someone asking, as dev.knotless.getThread's `item`; absent when it attaches none.
Who opened it.
How many comments are on it, its own body aside.
minimum: 0
draft
booleanA pull its author has not marked ready to merge. Not, when absent.
knownValues: pull | issue
labels
arrayThe labels it carries, as the repository defines them, in the order it does. Absent when it carries none.
requiredReviewers
arrayOf reviewers, those the rule protecting the pull's base requires: asked of every pull into it, and stopped only by changing the rule. Absent when there are none.
reviewers
arrayThose asked to review a pull, in the order asked: first by its author, then by the repository's owner or collaborators (dev.knotless.assignment), then the required reviewers the rule protecting its base names. Absent when no one is asked.
A merged pull is merged; a closed one, or an issue, closed.
knownValues: open | closed | merged
updatedAt
string · datetimeWhen its author last changed its title or body, if they have.
Its dev.knotless.pull or dev.knotless.issue record.
#itemViewBasic
objectA pull or an issue, by its record and its title.
#labelName
objectA label a repository defines, by name, as one to put on a pull or an issue.
Properties
The label's name, as the repository defines it.
maxLength: 100maxGraphemes: 50
#languageView
objectOne language a repository is written in.
#lineTextView
objectOne line of a file.
#lineView
objectThe lines of a pull's diff a comment is on.
Properties
The last line.
minimum: 1
lines
arrayThe lines as they were at the comment's commit, and for one alone a few before it; absent when that commit can no longer be read.
Whether that side of the file has changed since the comment's commit, so its lines may no longer be where they were.
The file's path on that side.
side
string`old` for the side the pull leaves; absent, `new`.
knownValues: old | new
startLine
integerThe first, for more than one.
minimum: 1
#link
objectA link shown on an account's profile or a repository's pages.
#mention
objectAn account the span, `@handle` in the text, mentions: kept by DID, so it names the account still after its handle changes. The account hears of it as a notification.
Properties
#minutesView
objectThe minutes a runner the repository names counts for its owner's public repositories, from its dev.knotless.minutes record.
Properties
allowance
integerThe minutes in 30 days it gives the owner's runs before they go one at a time. Absent when there is no limit.
minimum: 1
freeing
arrayWhen minutes counted now stop counting, soonest first.
The minutes steps took in the 30 days up to `updatedAt`.
minimum: 0
The runner's account.
When the runner last counted.
#packageView
objectOne package a repository publishes.
Properties
image
booleanTrue when its latest version, or its newest when none is latest, is a container image.
latest
stringIts latest version: the highest with no pre-release part. Absent when it has only pre-releases.
The package's name.
releaseCount
integerHow many versions of it are published.
minimum: 0
#pullHeadView
objectWhat a pull brings in: a branch of a repository.
Properties
repo
refThe repository the branch is on, if the index knows it.
#queueStateView
objectWhere an open pull stands in its target branch's merge queue.
Properties
aheadStartedAt
string · datetimeQueued in no batch, when the newest batch being checked ahead of it started.
batchStartedAt
string · datetimeWhile its batch is being checked or landing, when that started.
While its batch is being checked or landing, the batch's checks; queued in no batch, its pre-flights' newest runs; once ejected by checks that failed, those.
When it was queued or ejected.
reason
stringWhy it was ejected, as the runner said.
Where it stands, in words: `Queued, 3rd of 5, running its checks`, `In a batch of 4 being checked`, `Landing`, or why it was ejected.
stage
stringWhile queued, where it stands, as `dev.knotless.getQueue#queuedView` says.
knownValues: queued | preflight | again | ready | review | checking | landing | stacked
knownValues: queued | ejected
typical
refWhile queued, how long its merge queue typically takes.
#queueTypicalView
objectHow long a repository's merge queue typically takes, for saying when a queued pull should land: a pull in a batch lands a batch after the batch started; one in no batch is ready once its pre-flights would pass, or now if they have, and lands a batch after that or after the batch being checked ahead of it, whichever is later.
Properties
A batch, from its first run starting to its last ending: the median of those that landed lately.
minimum: 0
A pull's pre-flights at a head, as long as the longest of them that passed: the median, or a batch's with none to go by.
minimum: 0
#reactionContent
stringWhat a reaction says, as GitHub's eight: a thumbs up, a thumbs down, a laugh, a party popper, a confused face, a heart, a rocket and eyes.
maxLength: 32knownValues: +1 | -1 | laugh | hooray | confused | heart | rocket | eyes
#reactionCountView
objectHow many accounts reacted to something with one content.
Properties
How many accounts reacted so, each once.
minimum: 0
reaction
string · at-uriThe asker's dev.knotless.reaction record of this content on it, if they reacted so.
#reactionState
objectThe reactions to a pull, an issue or a comment.
Properties
By content, in the order dev.knotless.defs#reactionContent lists them; a content no account reacted with is left out.
The pull, issue or comment.
#releaseFileView
objectOne file of a release.
#releaseView
objectOne version of a package a repository publishes, from its dev.knotless.release record, with its files and notes.
Properties
check
string · at-uriThe dev.knotless.check of the run that built it, if its record names one.
commit
stringThe hex object ID of the commit its files were built from, if its record names one.
crate
booleanTrue when it is a crate, added with Cargo from its repository's registry, at `/cargo/<owner's DID>/<repository's key>/`, rather than downloaded.
As its record says.
What it publishes, in its record's order.
html
string`notes` made into HTML, as dev.knotless.getThread's comments are: raw HTML shown as text, and links made relative to the repository.
image
booleanTrue when its files are a container image's OCI layout: an `index.json` beside blobs named `sha256-<hex>`, pulled by `docker pull` rather than downloaded.
latest
booleanTrue for its package's latest version: the highest with no pre-release part that is not yanked.
maven
stringIts coordinates, `<group>:<artifact>`, when it is a Maven artifact, resolved with Gradle or Maven from its repository's Maven repository, at `/maven/<owner's DID>/<repository's key>/`, rather than downloaded.
notes
stringWhat changed since the version before, in Markdown, as its record says.
npm
booleanTrue when it is an npm package, installed with npm from its repository's registry, at `/npm/<owner's DID>/<repository's key>/`, rather than downloaded.
The package's name.
swift
stringIts identifier, `<scope>.<name>` as it was published, when it is a Swift package, resolved with SwiftPM from its repository's registry, at `/swift/<owner's DID>/<repository's key>/`, rather than downloaded.
Its dev.knotless.release record.
Its Semantic Versioning 2.0 version.
yanked
booleanTrue when its owner withdrew it, by a dev.knotless.releaseYank record: its files can still be read, but it is no one's latest.
#releaseViewBasic
objectOne version of a package a repository publishes, from its dev.knotless.release record: which, and when.
Properties
As its record says.
image
booleanTrue when its files are a container image's OCI layout, pulled by `docker pull` rather than downloaded.
latest
booleanTrue for its package's latest version: the highest with no pre-release part that is not yanked.
The package's name.
Its dev.knotless.release record.
Its Semantic Versioning 2.0 version.
#releasesView
objectWhat a repository publishes, in brief, for its pages to show under its name.
Properties
How many releases it has published, of all its packages.
minimum: 0
Each package it publishes, by name.
The release to show for it: the latest of the package named as the repository, else the newest that is its package's latest, or the newest of all when each is a pre-release.
#repoMade
objectA repository the pages made: created, forked, renamed or taken up.
#repoRef
objectA repository, as another record names it. The URI's name is the one the repository had when the record was written; a rename changes it, and a later repository can take it. The owner in the URI and `key` stay the repository's own, and are what a reader matches on.
#repoView
objectA repository among others, from its dev.knotless.repo record.
Properties
As its record says.
description
stringforkCount
integerHow many forks of it there are, as the appview has indexed. Given only where a list shows it, as an account's stars do.
minimum: 0
forkOf
refThe repository it was forked from, if the appview knows it.
language
refThe language most of its default branch is written in, as its file listing counts them. Absent when none is counted, or the appview could not read it.
The repository's name: its record key.
private
booleanWhether it is private, in a space: listed only to its owner, asking.
starCount
integerHow many accounts starred it, as the appview has indexed. Given only where a list shows it, as an account's stars do.
minimum: 0
Its dev.knotless.repo record, under the name it has now.
#repoViewBasic
objectA repository, under the name it has now.
#repoViewDetailed
objectA repository, with what its pages show above themselves.
Properties
archivedAt
string · datetimeWhen its owner archived it, making it read only. Absent when it is not archived.
The path, on this appview, of the picture a link to its pages unfurls into: a new one whenever the picture changes.
collaboratorCount
integerHow many accounts may push to it besides its owner: more than `collaborators` holds when the list was cut short.
minimum: 0
collaborators
arrayThe first twenty accounts that may push to it besides its owner, as its record names them.
The branch its HEAD names: empty, for a repository never pushed.
description
stringforkCount
integerHow many forks of it there are, as the appview has indexed. Absent for a private repository, whose forks are private too, and from an appview that keeps no index.
minimum: 0
forkOf
refThe repository it was forked from, if the appview knows it.
key
stringThe repository's key, as its dev.knotless.repo record holds it, which a rename keeps: what dev.knotless.putSecret and dev.knotless.listSecrets name it by.
maxLength: 32
kind
stringgist for a gist, a repository whose record says it is one. Absent for any other repository.
knownValues: gist
links
arrayLinks its pages show, in display order, as its record names them: its website first. Only http and https addresses.
mergeQueue
booleanWhether its pages lead to its merge queue: a rule of its record has a branch take pulls through it, or an open pull waits in it still. Absent when neither.
The repository's name: its record key.
minimum: 0
minimum: 0
private
booleanWhether it is private, in a space: shown only to its members, each logged in to this appview.
releases
refWhat it publishes, in brief, as the appview has indexed. Absent when it has published nothing, for a private repository, which cannot publish, and from an appview that keeps no index.
site
refIts website, where this appview serves sites. Absent when it has none, or it is taken down.
starCount
integerHow many accounts starred it, as the appview has indexed. Absent for a private repository, which cannot be starred, and from an appview that keeps no index.
minimum: 0
topics
arrayWhat it is about, as its record names them, in its order.
Its dev.knotless.repo record, under the name it has now.
viewer
refWhat the account asking has to do with it; absent when no one asks.
#repoViewerState
objectWhat the account asking a query has to do with a repository.
Properties
admin
booleanWhether the account asking may change its settings: as its owner, or as an admin who joined the organization that owns it, when that organization delegated its writes to this appview's gateway, which makes the changes as it. Renaming, deleting and transferring it stay the owner's own. Absent when it may not.
labels
arrayThe labels it defines that the account asking may put on its pulls and issues, in its order: as its owner, a collaborator, or a triager of their scopes. Absent when there are none.
star
string · at-uriIts dev.knotless.star record naming the repository, if it starred it.
subscription
stringWhat the account asking chose to hear of it (dev.knotless.putSubscription): `all` it does, its `releases` alone, or nothing, as it `ignore`s it. Its owner, until it chooses, hears `all`. Absent when it hears only of what it takes part in.
maxLength: 64knownValues: all | releases | ignore
transfer
refWhere the owner has offered to move the repository, when it is offered to the account asking, which can take it up (dev.knotless.acceptTransfer).
#reviewView
objectWhere one reviewer stands on a pull: their latest comment with a verdict. A comment without one leaves it as it was, and a pull's author reviews nothing of their own.
Properties
commit
stringThe hex object ID of the head it looked at.
dismissed
booleanWhether the owner or a collaborator dismissed it (dev.knotless.dismissReview): it counts for nothing, for or against the pull, until its reviewer reviews again.
gate
booleanWhether the rule protecting the pull's base names the reviewer as a gate, whose review of the head the pull waits for though it may not write.
Whether the reviewer is the repository's owner or a collaborator.
Whether the open pull has moved past the head it looked at: an approval then stands for what the pull was, not what it is.
The dev.knotless.comment that reviewed it.
`approve`, or `changes` for one that asked for changes.
knownValues: approve | changes
#siteView
objectA repository's website, as its dev.knotless.site record was last indexed.
Properties
check
string · at-uriThe dev.knotless.check of the run that built and deployed it, given only when the check is in the account of a runner the repository's record names.
commit
stringThe hex object ID of the commit its record says the files were built from, as whoever deployed it said, unchecked.
When it was deployed, as its record says.
Where it is served: under its owner's label of the pages domain, or, for a private repository, at a host of its own.
#stackPullView
objectOne pull of a stack.
#stackView
objectThe chain of pulls a pull is part of, each built on the one below it.
Properties
into
stringThe branch the lowest pull targets.
Highest first: the lowest, which lands first, is last.
#starState
objectA repository's stars, as starring or unstarring it leaves them.
#stepCommandView
objectA command a shared step needs in the workflow's image, checked before its steps run.
Properties
The command's name, as `command -v` finds it.
#stepInputView
objectAn input a shared step takes, which reaches its steps as the environment variable `INPUT_<NAME>`.
Properties
default
stringIts value when a workflow does not give it.
description
stringWhat it is, as the step file says.
The input's name, as a workflow's `with` gives it.
True when a workflow using the step must give it.
#stepSecretView
objectA secret a shared step asks to be given, which a workflow passes it by name.
Properties
The secret's name.
#stepVersionView
objectOne published version of a shared step.
#stepView
objectA shared step, a file of workflow steps a repository publishes for others' workflows to use, at its latest version: from its dev.knotless.release records of the package `@step/<name>`.
Properties
When its latest version was published, as its record says.
description
stringWhat it does, as its step file says.
The step's name: its file's, `.knotless/steps/<name>.yml`.
The repository it is in.
How many secrets it asks to be given.
minimum: 0
The dev.knotless.release record of its latest version.
How many public repositories pin it, at any version, in the `.knotless/uses.lock` of their default branch, as the appview last read each.
minimum: 0
Its latest version: the highest with no pre-release part, or the highest of all when each is a pre-release.
#stepViewDetailed
objectA shared step at its latest version, as #stepView, with what it takes and asks for, its versions and some of the repositories that use it.
Properties
The hex object ID of the commit its latest version was published at.
When its latest version was published, as its record says.
description
stringWhat it does, as its step file says.
Its inputs, by name.
The step's name: its file's, `.knotless/steps/<name>.yml`.
The commands it needs in the workflow's image.
Its file in its repository: `.knotless/steps/<name>.yml`.
The repository it is in.
The secrets it asks to be given, by name.
The dev.knotless.release record of its latest version.
How many public repositories pin it, as in #stepView.
minimum: 0
Some of the repositories that pin it, at most 30.
What a workflow step's `uses` names it by to take its latest major version: `<handle>/<repo>/<name>@<major>`, or `@0.<minor>` before 1.0.0.
Its latest version, as in #stepView.
Each version published that is a step file, the highest first.
#themeView
objectA theme made for the pages, from its dev.knotless.theme record.
Properties
The account that made it.
What it is called.
Its colours, only those given as #rrggbb.
Its dev.knotless.theme record.
Similar lexicons
semantic matchLexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.
-
dev.knotless.comment
recordA comment on a pull, an issue or a gist. With a verdict it is a review of a pull; with a line, a comment on lines of a pull's diff, starting a thread there; with a reply, an answer in such a thread. A comment on a gist has none of these.
-
dev.knotless.getFeed
queryWhat happened on the public repositories an appview has indexed, and on the private ones the account asking may read, newest first.
-
dev.knotless.getThread
queryA pull or an issue, and everything said on it.