dev.knotless.defs

Definitions shared by the knotless lexicons.

Details · defs
Kinddefs
Authorityknotless.dev
Commit rev3n2sbyo6sitby
Indexed

Showing version bafyreid7dwck4ys7e4vduu6jatuychxmyhy6mk23b6gkgl5lm2oxd72rda. Show the latest

#actorView

object

An account, as an appview shows it beside what it did.

Properties

avatar

string · uri

The account's picture, as in dev.knotless.getProfile#profileView.

bot

boolean

Whether 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.

did

requiredstring · did

handle

requiredstring

The handle the account claims, when it resolves back to it; else the DID.

#actorViewerState

object

What the account asking a query has to do with an account.

Properties

blocking

string · at-uri

Its dev.knotless.block record keeping the account out of all its repositories, if it has one.

following

string · at-uri

Its dev.knotless.follow record naming the account, if it follows it.

#attachmentView

object

A picture a pull, an issue or a comment attaches, as readers load it: from this appview, with no cookie or header needed.

Properties

cid

requiredstring · cid

The attached blob.

height

integer

How high it is drawn, in CSS pixels, as its record's dev.knotless.defs#image says.

  • minimum: 1

url

requiredstring · uri

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

integer

How wide it is drawn, in CSS pixels, as its record's dev.knotless.defs#image says.

  • minimum: 1

#byteSlice

object

A span of a text, by its UTF-8 bytes, counted from zero: the start inclusive, the end exclusive.

Properties

byteEnd

requiredinteger
  • minimum: 0

byteStart

requiredinteger
  • minimum: 0

#changesView

object

What 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

commits

requiredarray

Oldest first.

itemsref
Reference

files

requiredarray

As an editor's file tree lists them: in each directory, its directories before its files, each by name.

itemsref
Reference

head

string

For an open pull, the hex object ID of the commit its branch is at: what its checks and reviews are of.

repo

requiredref

The repository whose commit pages show its commits.

Reference

#checkImageView

object

A picture a check made: screenshots of the pages a change moved, say.

Properties

alt

requiredstring

What it shows.

url

requiredstring

Where this appview serves it, as a path.

#checkView

object

The newest run of a workflow, as a runner the repository names in its record reported it.

Properties

commit

requiredstring

The commit it ran at, in hex.

error

string

Why it could not run.

finishedAt

string · datetime

images

requiredarray

The pictures it made to be looked at, in order.

itemsref
Reference

repo

requiredref

The repository it is of, whose pages show it.

Reference

skipped

string

For a `success` that ran nothing, as the change touched none of the paths its workflow names: why.

startedAt

requiredstring · datetime

status

requiredstring

`queued` is a run filed and waiting for a job on its runner, no step started yet.

  • knownValues: queued | running | success | failure | error | cancelled

uri

requiredstring · at-uri

Its dev.knotless.check record.

workflow

requiredstring

#commentView

object

Something said on a pull, an issue or a gist.

Properties

The pictures its record attaches (dev.knotless.defs#image), in its order, each where any reader loads it. Absent when it attaches none.

itemsref
Reference

author

requiredref
Reference

body

string

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

commit

string

For 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.

createdAt

requiredstring · datetime

dismisses

string · at-uri

The review, another comment on the pull, this dismissed, its body saying why: from the owner or a collaborator.

html

requiredstring

What it says, its Markdown made into HTML: raw HTML shown as text, and links made relative to the repository.

line

ref

For a comment on a pull's lines, which, as they stand now.

Reference

How accounts reacted to it, by content, in the order dev.knotless.defs#reactionContent lists them. Absent when none did.

itemsref
Reference

reply

string · at-uri

The comment starting the thread on a pull's lines that this answers.

resolved

boolean

For a comment starting a thread on a pull's lines, whether the thread is resolved.

review

string · at-uri

The review this was sent with, as one of its line comments.

updatedAt

string · datetime

When its author last changed it, if they have.

uri

string · at-uri

Its dev.knotless.comment record.

verdict

string

For a review, what it found.

  • knownValues: approve | changes

#commitAuthorView

object

Who 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.

Properties

Reference

agent

string

The coding agent whose address it is, when it is one the pages know the face of.

  • knownValues: claude

name

requiredstring

The name git records.

#commitRefView

object

A commit, by its object name.

Properties

sha

requiredstring

In hex.

#commitView

object

A commit, with the accounts that wrote it where the repository's pages believe their claims (dev.knotless.emails).

Properties

author

requiredref
Reference

coauthors

requiredarray

Who its message's `Co-authored-by` trailers name.

itemsref
Reference

committedAt

string · datetime

When it was committed: what history runs in, as its author's date need not.

Who committed it, when someone other than its author did.

Reference

date

requiredstring · datetime

When its author made it, which a rebase or a squash keeps.

message

requiredstring

Its message, less the last line naming the pull it merged, if it did.

parents

requiredarray
itemsref
Reference

pull

ref

The 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.

Reference

sha

requiredstring

Its object name, in hex.

#diffRowView

object

One row of a file's diff: a hunk header, a note, or a line with its old and new numbers.

Properties

kind

requiredstring

`h` for a hunk header, `x` for a note, `a` for a line added, `d` for one removed, or empty for context.

line

requiredboolean

Whether it is a line of the file.

new

integer

Its number after.

  • minimum: 0

old

integer

Its number before.

  • minimum: 0

text

requiredstring

#facet

object

Where 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

features

requiredarray

What the span is. Kinds unknown to a reader are passed over.

  • maxLength: 8
itemsunion
One of

index

requiredref
Reference

#fileDiffView

object

One file of a diff, or why its rows are not shown.

Properties

added

requiredinteger

Lines added.

  • minimum: 0

hunkCount

integer

Of those rows, how many are hunk headers, which a page may draw taller than a line.

  • minimum: 0

new

requiredstring

Its path after.

note

string

Why its rows are not shown, when they are not.

old

requiredstring

Its path before.

ranges

string

The ranges its highlighting paints, encoded as the pages read them.

removed

requiredinteger

Lines removed.

  • minimum: 0

rowCount

integer

Where 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

rows

requiredarray
itemsref
Reference

status

requiredstring
  • knownValues: added | deleted | renamed | modified

#followState

object

An account's followers, as following or unfollowing it leaves them.

Properties

followersCount

requiredinteger

How many accounts follow it now.

  • minimum: 0

following

string · at-uri

The asker's dev.knotless.follow record naming it; absent once unfollowed.

#gistFile

object

A file of a gist.

Properties

name

requiredstring

The file's name, at the root of the gist's default branch.

  • maxLength: 255

#gistView

object

A gist among others: a dev.knotless.repo record whose kind is gist, its files flat at the root of its default branch.

Properties

How many comments stand on it, as dev.knotless.getGistComments lists them. Absent from an appview that keeps no index.

  • minimum: 0

createdAt

requiredstring · datetime

As its record says.

fileCount

requiredinteger

How many files are at the root of its default branch, as `files` was read.

  • minimum: 0

files

requiredarray

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
itemsref
Reference

forkCount

requiredinteger

How many forks of it there are, as the appview has indexed: 0 from an appview that keeps no index.

  • minimum: 0

name

requiredstring

The gist's name: its record key, a TID given when it was made.

owner

requiredref
Reference

starCount

requiredinteger

How many accounts starred it, as the appview has indexed: 0 from an appview that keeps no index.

  • minimum: 0

uri

requiredstring · at-uri

Its dev.knotless.repo record.

#image

object

A 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

integer

How high it is drawn, in CSS pixels, as `width` is.

  • minimum: 1

image

requiredblob
  • maxSize: 1000000
  • accept: image/png, image/jpeg, image/webp, image/gif

width

integer

How 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

object

A pull or an issue in a list of them.

Properties

Those the repository's owner or collaborators assign it to, in the order assigned (dev.knotless.assignment). Absent when it is assigned to no one.

itemsref
Reference

The 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.

itemsref
Reference

author

requiredref

Who opened it.

Reference

comments

requiredinteger

How many comments are on it, its own body aside.

  • minimum: 0

createdAt

requiredstring · datetime

draft

boolean

A pull its author has not marked ready to merge. Not, when absent.

kind

requiredstring
  • knownValues: pull | issue

labels

array

The labels it carries, as the repository defines them, in the order it does. Absent when it carries none.

itemsref

Of 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.

itemsref
Reference

Those 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.

itemsref
Reference

state

requiredstring

A merged pull is merged; a closed one, or an issue, closed.

  • knownValues: open | closed | merged

title

requiredstring

updatedAt

string · datetime

When its author last changed its title or body, if they have.

uri

requiredstring · at-uri

Its dev.knotless.pull or dev.knotless.issue record.

#itemViewBasic

object

A pull or an issue, by its record and its title.

Properties

title

requiredstring

uri

requiredstring · at-uri

Its dev.knotless.pull or dev.knotless.issue record.

#labelName

object

A label a repository defines, by name, as one to put on a pull or an issue.

Properties

name

requiredstring

The label's name, as the repository defines it.

  • maxLength: 100
  • maxGraphemes: 50

#languageView

object

One language a repository is written in.

Properties

bytes

requiredinteger
  • minimum: 0

color

requiredstring

Its color, as linguist has it.

name

requiredstring

Its name, or `Other` for the languages each under one percent.

permille

requiredinteger

Its share of all the bytes counted, in tenths of a percent.

  • minimum: 0
  • maximum: 1000

#lineTextView

object

One line of a file.

Properties

number

requiredinteger

Counting from 1.

  • minimum: 1

text

requiredstring

#lineView

object

The lines of a pull's diff a comment is on.

Properties

line

requiredinteger

The last line.

  • minimum: 1

lines

array

The 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.

itemsref
Reference

outdated

requiredboolean

Whether that side of the file has changed since the comment's commit, so its lines may no longer be where they were.

path

requiredstring

The file's path on that side.

side

string

`old` for the side the pull leaves; absent, `new`.

  • knownValues: old | new

startLine

integer

The first, for more than one.

  • minimum: 1

#mention

object

An 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

did

requiredstring · did

#minutesView

object

The minutes a runner the repository names counts for its owner's public repositories, from its dev.knotless.minutes record.

Properties

allowance

integer

The 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

array

When minutes counted now stop counting, soonest first.

itemsref

minutes

requiredinteger

The minutes steps took in the 30 days up to `updatedAt`.

  • minimum: 0

runner

requiredref

The runner's account.

Reference

updatedAt

requiredstring · datetime

When the runner last counted.

#packageView

object

One package a repository publishes.

Properties

image

boolean

True when its latest version, or its newest when none is latest, is a container image.

latest

string

Its latest version: the highest with no pre-release part. Absent when it has only pre-releases.

name

requiredstring

The package's name.

How many versions of it are published.

  • minimum: 0

#pullHeadView

object

What a pull brings in: a branch of a repository.

Properties

branch

requiredstring

repo

ref

The repository the branch is on, if the index knows it.

Reference

#queueStateView

object

Where an open pull stands in its target branch's merge queue.

Properties

aheadStartedAt

string · datetime

Queued in no batch, when the newest batch being checked ahead of it started.

batchStartedAt

string · datetime

While its batch is being checked or landing, when that started.

checks

requiredarray

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.

itemsref
Reference

createdAt

requiredstring · datetime

When it was queued or ejected.

reason

string

Why it was ejected, as the runner said.

said

requiredstring

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

string

While queued, where it stands, as `dev.knotless.getQueue#queuedView` says.

  • knownValues: queued | preflight | again | ready | review | checking | landing | stacked

state

requiredstring
  • knownValues: queued | ejected

While queued, how long its merge queue typically takes.

Reference

#queueTypicalView

object

How 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

batchSeconds

requiredinteger

A batch, from its first run starting to its last ending: the median of those that landed lately.

  • minimum: 0

preflightSeconds

requiredinteger

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

string

What 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: 32
  • knownValues: +1 | -1 | laugh | hooray | confused | heart | rocket | eyes

#reactionCountView

object

How many accounts reacted to something with one content.

Properties

content

requiredref
Reference

count

requiredinteger

How many accounts reacted so, each once.

  • minimum: 0

reaction

string · at-uri

The asker's dev.knotless.reaction record of this content on it, if they reacted so.

#reactionState

object

The reactions to a pull, an issue or a comment.

Properties

reactions

requiredarray

By content, in the order dev.knotless.defs#reactionContent lists them; a content no account reacted with is left out.

itemsref
Reference

subject

requiredstring · at-uri

The pull, issue or comment.

#releaseFileView

object

One file of a release.

Properties

name

requiredstring

Its name, as it is downloaded.

sha256

requiredstring

The lowercase hex SHA-256 of the file, which a reader checks it against.

size

requiredinteger

Bytes in the file.

  • minimum: 1

#releaseView

object

One version of a package a repository publishes, from its dev.knotless.release record, with its files and notes.

Properties

check

string · at-uri

The dev.knotless.check of the run that built it, if its record names one.

commit

string

The hex object ID of the commit its files were built from, if its record names one.

crate

boolean

True when it is a crate, added with Cargo from its repository's registry, at `/cargo/<owner's DID>/<repository's key>/`, rather than downloaded.

createdAt

requiredstring · datetime

As its record says.

files

requiredarray

What it publishes, in its record's order.

itemsref
Reference

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

boolean

True 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

boolean

True for its package's latest version: the highest with no pre-release part that is not yanked.

notes

string

What changed since the version before, in Markdown, as its record says.

npm

boolean

True 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.

package

requiredstring

The package's name.

uri

requiredstring · at-uri

Its dev.knotless.release record.

version

requiredstring

Its Semantic Versioning 2.0 version.

yanked

boolean

True 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

object

One version of a package a repository publishes, from its dev.knotless.release record: which, and when.

Properties

createdAt

requiredstring · datetime

As its record says.

image

boolean

True when its files are a container image's OCI layout, pulled by `docker pull` rather than downloaded.

latest

boolean

True for its package's latest version: the highest with no pre-release part that is not yanked.

package

requiredstring

The package's name.

uri

requiredstring · at-uri

Its dev.knotless.release record.

version

requiredstring

Its Semantic Versioning 2.0 version.

#releasesView

object

What a repository publishes, in brief, for its pages to show under its name.

Properties

count

requiredinteger

How many releases it has published, of all its packages.

  • minimum: 0

packages

requiredarray

Each package it publishes, by name.

itemsref
Reference

release

requiredref

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.

Reference

#repoMade

object

A repository the pages made: created, forked, renamed or taken up.

Properties

name

requiredstring

Its name, the record key.

  • maxLength: 100

uri

requiredstring · at-uri

Its dev.knotless.repo record, by its owner's DID.

#repoRef

object

A 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.

Properties

key

requiredstring · tid

The repository's `key`.

uri

requiredstring · at-uri

The dev.knotless.repo record, as it was named when this was written.

#repoView

object

A repository among others, from its dev.knotless.repo record.

Properties

createdAt

requiredstring · datetime

As its record says.

forkCount

integer

How 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

The repository it was forked from, if the appview knows it.

Reference

The 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.

Reference

name

requiredstring

The repository's name: its record key.

owner

requiredref
Reference

private

boolean

Whether it is private, in a space: listed only to its owner, asking.

starCount

integer

How many accounts starred it, as the appview has indexed. Given only where a list shows it, as an account's stars do.

  • minimum: 0

uri

requiredstring · at-uri

Its dev.knotless.repo record, under the name it has now.

#repoViewBasic

object

A repository, under the name it has now.

Properties

did

requiredstring · did

The repository's owner.

handle

requiredstring

The owner's handle, as in #actorView.

name

requiredstring

The repository's name: its record key.

#repoViewDetailed

object

A repository, with what its pages show above themselves.

Properties

archivedAt

string · datetime

When its owner archived it, making it read only. Absent when it is not archived.

card

requiredstring

The path, on this appview, of the picture a link to its pages unfurls into: a new one whenever the picture changes.

How many accounts may push to it besides its owner: more than `collaborators` holds when the list was cut short.

  • minimum: 0

The first twenty accounts that may push to it besides its owner, as its record names them.

itemsref
Reference

defaultBranch

requiredstring

The branch its HEAD names: empty, for a repository never pushed.

forkCount

integer

How 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

The repository it was forked from, if the appview knows it.

Reference

key

string

The 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

string

gist for a gist, a repository whose record says it is one. Absent for any other repository.

  • knownValues: gist

mergeQueue

boolean

Whether 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.

name

requiredstring

The repository's name: its record key.

openIssues

requiredinteger
  • minimum: 0

openPulls

requiredinteger
  • minimum: 0

owner

requiredref
Reference

private

boolean

Whether it is private, in a space: shown only to its members, each logged in to this appview.

What 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.

Reference

site

ref

Its website, where this appview serves sites. Absent when it has none, or it is taken down.

Reference

starCount

integer

How 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

array

What it is about, as its record names them, in its order.

itemsref

uri

requiredstring · at-uri

Its dev.knotless.repo record, under the name it has now.

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

Reference

#repoViewerState

object

What the account asking a query has to do with a repository.

Properties

admin

boolean

Whether 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

array

The 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.

itemsref

star

string · at-uri

Its dev.knotless.star record naming the repository, if it starred it.

What 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: 64
  • knownValues: all | releases | ignore

Where the owner has offered to move the repository, when it is offered to the account asking, which can take it up (dev.knotless.acceptTransfer).

Reference

#reviewView

object

Where 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

string

The hex object ID of the head it looked at.

dismissed

boolean

Whether 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

boolean

Whether 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.

maintainer

requiredboolean

Whether the reviewer is the repository's owner or a collaborator.

outdated

requiredboolean

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.

reviewer

requiredref
Reference

uri

requiredstring · at-uri

The dev.knotless.comment that reviewed it.

verdict

requiredstring

`approve`, or `changes` for one that asked for changes.

  • knownValues: approve | changes

#siteView

object

A repository's website, as its dev.knotless.site record was last indexed.

Properties

check

string · at-uri

The 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

string

The hex object ID of the commit its record says the files were built from, as whoever deployed it said, unchecked.

deployedAt

requiredstring · datetime

When it was deployed, as its record says.

url

requiredstring · uri

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

object

One pull of a stack.

Properties

branch

string

Its head branch.

item

requiredref
Reference

merged

string

The commit it landed as.

#stackView

object

The chain of pulls a pull is part of, each built on the one below it.

Properties

into

string

The branch the lowest pull targets.

pulls

requiredarray

Highest first: the lowest, which lands first, is last.

itemsref
Reference

#starState

object

A repository's stars, as starring or unstarring it leaves them.

Properties

star

string · at-uri

The asker's dev.knotless.star record naming it; absent once unstarred.

starCount

requiredinteger

How many accounts starred it now.

  • minimum: 0

#stepCommandView

object

A command a shared step needs in the workflow's image, checked before its steps run.

Properties

name

requiredstring

The command's name, as `command -v` finds it.

#stepInputView

object

An input a shared step takes, which reaches its steps as the environment variable `INPUT_<NAME>`.

Properties

default

string

Its value when a workflow does not give it.

What it is, as the step file says.

name

requiredstring

The input's name, as a workflow's `with` gives it.

required

requiredboolean

True when a workflow using the step must give it.

#stepSecretView

object

A secret a shared step asks to be given, which a workflow passes it by name.

Properties

name

requiredstring

The secret's name.

#stepVersionView

object

One published version of a shared step.

Properties

commit

requiredstring

The hex object ID of the commit it was published at, which a lock pins.

createdAt

requiredstring · datetime

As its record says.

uri

requiredstring · at-uri

Its dev.knotless.release record.

version

requiredstring

Its Semantic Versioning 2.0 version.

#stepView

object

A 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

createdAt

requiredstring · datetime

When its latest version was published, as its record says.

What it does, as its step file says.

name

requiredstring

The step's name: its file's, `.knotless/steps/<name>.yml`.

repo

requiredref

The repository it is in.

Reference

secretCount

requiredinteger

How many secrets it asks to be given.

  • minimum: 0

uri

requiredstring · at-uri

The dev.knotless.release record of its latest version.

useCount

requiredinteger

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

version

requiredstring

Its latest version: the highest with no pre-release part, or the highest of all when each is a pre-release.

#stepViewDetailed

object

A 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

commit

requiredstring

The hex object ID of the commit its latest version was published at.

createdAt

requiredstring · datetime

When its latest version was published, as its record says.

What it does, as its step file says.

inputs

requiredarray

Its inputs, by name.

itemsref
Reference

name

requiredstring

The step's name: its file's, `.knotless/steps/<name>.yml`.

needs

requiredarray

The commands it needs in the workflow's image.

itemsref
Reference

path

requiredstring

Its file in its repository: `.knotless/steps/<name>.yml`.

repo

requiredref

The repository it is in.

Reference

secrets

requiredarray

The secrets it asks to be given, by name.

itemsref
Reference

uri

requiredstring · at-uri

The dev.knotless.release record of its latest version.

useCount

requiredinteger

How many public repositories pin it, as in #stepView.

  • minimum: 0

usedBy

requiredarray

Some of the repositories that pin it, at most 30.

itemsref
Reference

uses

requiredstring

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.

version

requiredstring

Its latest version, as in #stepView.

versions

requiredarray

Each version published that is a step file, the highest first.

itemsref
Reference

#themeView

object

A theme made for the pages, from its dev.knotless.theme record.

Properties

createdAt

requiredstring · datetime

creator

requiredref

The account that made it.

Reference

name

requiredstring

What it is called.

palette

requiredref

Its colours, only those given as #rrggbb.

uri

requiredstring · at-uri

Its dev.knotless.theme record.

Similar lexicons

semantic match

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

  • A 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.

  • What happened on the public repositories an appview has indexed, and on the private ones the account asking may read, newest first.

  • A pull or an issue, and everything said on it.