dev.knotless.ref Documentation (EN)

main record

Keyed `<repo key>.<ref hash>`, where the hash is the first 26 characters of the lowercase unpadded base32 SHA-256 of `name`. Written only in the same applyWrites as the dev.knotless.claim for its current generation.

Record Key any Any valid record key

Properties

generation integer Required

How many times the ref has moved.

minimum: 1

name string Required

The full ref name, such as refs/heads/main.

maxLength: 1024 bytes

pusher string did Optional

The account that last moved the ref, when not the repository's owner: a collaborator or runner pushing through the gateway, which sets it from the caller's verified service token. Readers credit it only while the repository names it among its collaborators or runners.

repo string tid Required

The `key` of the dev.knotless.repo this ref belongs to.

target string Optional

The hex object ID the ref points at. Absent once the ref is deleted; the record stays so its generation never repeats.

maxLength: 64 bytesminLength: 40 bytes

updatedAt string datetime Required

When the ref last moved.

View raw schema

{
  "description": "Keyed `<repo key>.<ref hash>`, where the hash is the first 26 characters of the lowercase unpadded base32 SHA-256 of `name`. Written only in the same applyWrites as the dev.knotless.claim for its current generation.",
  "key": "any",
  "record": {
    "properties": {
      "generation": {
        "description": "How many times the ref has moved.",
        "minimum": 1,
        "type": "integer"
      },
      "name": {
        "description": "The full ref name, such as refs/heads/main.",
        "maxLength": 1024,
        "type": "string"
      },
      "pusher": {
        "description": "The account that last moved the ref, when not the repository's owner: a collaborator or runner pushing through the gateway, which sets it from the caller's verified service token. Readers credit it only while the repository names it among its collaborators or runners.",
        "format": "did",
        "type": "string"
      },
      "repo": {
        "description": "The `key` of the dev.knotless.repo this ref belongs to.",
        "format": "tid",
        "type": "string"
      },
      "target": {
        "description": "The hex object ID the ref points at. Absent once the ref is deleted; the record stays so its generation never repeats.",
        "maxLength": 64,
        "minLength": 40,
        "type": "string"
      },
      "updatedAt": {
        "description": "When the ref last moved.",
        "format": "datetime",
        "type": "string"
      }
    },
    "required": [
      "repo",
      "name",
      "generation",
      "updatedAt"
    ],
    "type": "object"
  },
  "type": "record"
}