dev.knotless.label

lexicons.knotless.dev

Documentation

Kept in the account of whoever labels, one per pull or issue, keyed `<repo key>.<hash of the subject's URI>` and rewritten as they change; for a private repository, in their repo inside its space. Readers honor it from the repository's owner and collaborators, and from its triagers for the scopes named, and only for labels the repository defines. Each label stands as the latest of everyone's entries for it says, by `setAt`; of a scope's exclusive labels, only the latest set stands.

main record

Record Key any Any valid record key

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

judged ref #judgment Optional

For labels a triager chose, what it judged and how.

labels array of ref #entry Required

One entry per label this account has set or taken off, the latest of each.

maxLength: 200 items

repo ref dev.knotless.defs#repoRef Required

The repository the pull or issue is on.

subject string at-uri Required

The dev.knotless.pull or dev.knotless.issue labelled.

View raw schema

{
  "description": "Kept in the account of whoever labels, one per pull or issue, keyed `<repo key>.<hash of the subject's URI>` and rewritten as they change; for a private repository, in their repo inside its space. Readers honor it from the repository's owner and collaborators, and from its triagers for the scopes named, and only for labels the repository defines. Each label stands as the latest of everyone's entries for it says, by `setAt`; of a scope's exclusive labels, only the latest set stands.",
  "key": "any",
  "record": {
    "properties": {
      "createdAt": {
        "format": "datetime",
        "type": "string"
      },
      "judged": {
        "description": "For labels a triager chose, what it judged and how.",
        "ref": "#judgment",
        "type": "ref"
      },
      "labels": {
        "description": "One entry per label this account has set or taken off, the latest of each.",
        "items": {
          "ref": "#entry",
          "type": "ref"
        },
        "maxLength": 200,
        "type": "array"
      },
      "repo": {
        "description": "The repository the pull or issue is on.",
        "ref": "dev.knotless.defs#repoRef",
        "type": "ref"
      },
      "subject": {
        "description": "The dev.knotless.pull or dev.knotless.issue labelled.",
        "format": "at-uri",
        "type": "string"
      }
    },
    "required": [
      "repo",
      "subject",
      "labels",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "record"
}

entry object

A label set, or taken off, at a time.

Properties

name string Required

The label, by its name among the repository's `labels`.

maxLength: 100 bytesmaxGraphemes: 50 graphemes

removed boolean Optional

Taken off, rather than set.

setAt string datetime Required

When it was set or taken off. Readers pass over one later than their own clock by more than a few minutes, until it is not.

View raw schema

{
  "description": "A label set, or taken off, at a time.",
  "properties": {
    "name": {
      "description": "The label, by its name among the repository's `labels`.",
      "maxGraphemes": 50,
      "maxLength": 100,
      "type": "string"
    },
    "removed": {
      "description": "Taken off, rather than set.",
      "type": "boolean"
    },
    "setAt": {
      "description": "When it was set or taken off. Readers pass over one later than their own clock by more than a few minutes, until it is not.",
      "format": "datetime",
      "type": "string"
    }
  },
  "required": [
    "name",
    "setAt"
  ],
  "type": "object"
}

judgment object

What a triager judged in choosing its labels, so it judges again only when that changes.

Properties

cid string cid Optional

The version of the pull or issue it read.

model string Optional

What chose them, as a model's name and version.

maxLength: 200 bytes

reason string Optional

Why, in a sentence or two, for those who check its work.

maxLength: 2000 bytesmaxGraphemes: 500 graphemes

View raw schema

{
  "description": "What a triager judged in choosing its labels, so it judges again only when that changes.",
  "properties": {
    "cid": {
      "description": "The version of the pull or issue it read.",
      "format": "cid",
      "type": "string"
    },
    "model": {
      "description": "What chose them, as a model's name and version.",
      "maxLength": 200,
      "type": "string"
    },
    "reason": {
      "description": "Why, in a sentence or two, for those who check its work.",
      "maxGraphemes": 500,
      "maxLength": 2000,
      "type": "string"
    }
  },
  "type": "object"
}