dev.knotless.getRepoSettings Documentation (EN)

main query

A repository's settings, read from its dev.knotless.repo record as its PDS has it now, for the pages' settings to show and change. All of it is public, as the record is.

Parameters

repo string at-uri Required

The repository's dev.knotless.repo record, as dev.knotless.getRepo takes it.

Output

Encodingapplication/json

collaborators array Required

The accounts that may push to it.

defaultBranch string Optional

The branch its record names for HEAD, without refs/heads/.

delegated stringdid Optional

The gateway its owner delegated writes to from this appview's pages (dev.knotless.delegateWrites), which sharing it for writing names as its gateway; absent until they have.

description string Optional

What the repository says it is.

gateway stringdid Optional

The gateway the owner delegated writes to, through which collaborators push: absent until the owner delegates.

indexed boolean Optional

Deprecated, and no longer set: knotless.dev indexes every private repository its members read there. Was, for a private repository, whether its owner let this appview keep an index of it.

labels array Required

The labels its pulls and issues may carry.

links array Optional

The links its pages show, in order, as its record names them.

readers array Optional

For a private repository, asked by its owner, the members who read it but do not push to it, its runners among them; absent for a public one, which anyone reads, and empty to anyone else.

rules array Required

Its protected branches.

storage ref#storageView Optional

What it takes up on its owner's PDS; absent if that could not be read.

transfer refdev.knotless.defs#repoViewBasic Optional

Where the owner has offered to move it, if they have: the account, and the name it would have there.

triagers array Required

The accounts whose labels of some scopes count.

uri stringat-uri Required

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

Errors

NotFound No such repository.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

repo * The repository's dev.knotless.repo record, as dev.knotless.getRepo takes it.

View raw schema

{
  "description": "A repository's settings, read from its dev.knotless.repo record as its PDS has it now, for the pages' settings to show and change. All of it is public, as the record is.",
  "errors": [
    {
      "description": "No such repository.",
      "name": "NotFound"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "collaborators": {
          "description": "The accounts that may push to it.",
          "items": {
            "ref": "dev.knotless.defs#actorView",
            "type": "ref"
          },
          "type": "array"
        },
        "defaultBranch": {
          "description": "The branch its record names for HEAD, without refs/heads/.",
          "type": "string"
        },
        "delegated": {
          "description": "The gateway its owner delegated writes to from this appview's pages (dev.knotless.delegateWrites), which sharing it for writing names as its gateway; absent until they have.",
          "format": "did",
          "type": "string"
        },
        "description": {
          "description": "What the repository says it is.",
          "type": "string"
        },
        "gateway": {
          "description": "The gateway the owner delegated writes to, through which collaborators push: absent until the owner delegates.",
          "format": "did",
          "type": "string"
        },
        "indexed": {
          "description": "Deprecated, and no longer set: knotless.dev indexes every private repository its members read there. Was, for a private repository, whether its owner let this appview keep an index of it.",
          "type": "boolean"
        },
        "labels": {
          "description": "The labels its pulls and issues may carry.",
          "items": {
            "ref": "dev.knotless.repo#label",
            "type": "ref"
          },
          "type": "array"
        },
        "links": {
          "description": "The links its pages show, in order, as its record names them.",
          "items": {
            "ref": "dev.knotless.defs#link",
            "type": "ref"
          },
          "type": "array"
        },
        "readers": {
          "description": "For a private repository, asked by its owner, the members who read it but do not push to it, its runners among them; absent for a public one, which anyone reads, and empty to anyone else.",
          "items": {
            "ref": "dev.knotless.defs#actorView",
            "type": "ref"
          },
          "type": "array"
        },
        "rules": {
          "description": "Its protected branches.",
          "items": {
            "ref": "dev.knotless.repo#rule",
            "type": "ref"
          },
          "type": "array"
        },
        "storage": {
          "description": "What it takes up on its owner's PDS; absent if that could not be read.",
          "ref": "#storageView",
          "type": "ref"
        },
        "transfer": {
          "description": "Where the owner has offered to move it, if they have: the account, and the name it would have there.",
          "ref": "dev.knotless.defs#repoViewBasic",
          "type": "ref"
        },
        "triagers": {
          "description": "The accounts whose labels of some scopes count.",
          "items": {
            "ref": "#triagerView",
            "type": "ref"
          },
          "type": "array"
        },
        "uri": {
          "description": "Its dev.knotless.repo record, under the name it has now.",
          "format": "at-uri",
          "type": "string"
        }
      },
      "required": [
        "uri",
        "rules",
        "labels",
        "collaborators",
        "triagers"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "repo": {
        "description": "The repository's dev.knotless.repo record, as dev.knotless.getRepo takes it.",
        "format": "at-uri",
        "type": "string"
      }
    },
    "required": [
      "repo"
    ],
    "type": "params"
  },
  "type": "query"
}

storageView object

A repository's packs, which hold all of its history, as `knotless storage` counts them.

Properties

blobBytes integer Required

Of those, the bytes in blobs rather than inline in records.

minimum: 0

bytes integer Required

Their bytes, as git packs them.

minimum: 0

objects integer Required

The objects in them, pack by pack: one in two packs counts twice, until compaction folds them.

minimum: 0

packs integer Required

No description available.

minimum: 0

View raw schema

{
  "description": "A repository's packs, which hold all of its history, as `knotless storage` counts them.",
  "properties": {
    "blobBytes": {
      "description": "Of those, the bytes in blobs rather than inline in records.",
      "minimum": 0,
      "type": "integer"
    },
    "bytes": {
      "description": "Their bytes, as git packs them.",
      "minimum": 0,
      "type": "integer"
    },
    "objects": {
      "description": "The objects in them, pack by pack: one in two packs counts twice, until compaction folds them.",
      "minimum": 0,
      "type": "integer"
    },
    "packs": {
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "packs",
    "objects",
    "bytes",
    "blobBytes"
  ],
  "type": "object"
}

triagerView object

An account whose labels of some scopes count on a repository.

Properties

actor ref dev.knotless.defs#actorView Required

No description available.

scopes array of refdev.knotless.repo#scope Required

The scopes of the labels it may put on.

View raw schema

{
  "description": "An account whose labels of some scopes count on a repository.",
  "properties": {
    "actor": {
      "ref": "dev.knotless.defs#actorView",
      "type": "ref"
    },
    "scopes": {
      "description": "The scopes of the labels it may put on.",
      "items": {
        "ref": "dev.knotless.repo#scope",
        "type": "ref"
      },
      "type": "array"
    }
  },
  "required": [
    "actor",
    "scopes"
  ],
  "type": "object"
}