dev.knotless.updateRepo

lexicons.knotless.dev

Documentation

Rewrites the repository's dev.knotless.repo record with a new description, new links or a new default branch, any of them, as `knotless describe` does. The default branch must be one of its branches, once it has any. Only its owner, logged in to this appview's web pages, can: the appview writes with the session it keeps for that account, which the pages' session cookie names.

main procedure

Rewrites the repository's dev.knotless.repo record with a new description, new links or a new default branch, any of them, as `knotless describe` does. The default branch must be one of its branches, once it has any. Only its owner, logged in to this appview's web pages, can: the appview writes with the session it keeps for that account, which the pages' session cookie names.

Input

Encodingapplication/json
defaultBranch string Optional

The branch its HEAD names, without refs/heads/. Left as it is when absent.

maxLength: 255 bytes
description string Optional

What the repository is; empty drops it. Left as it is when absent.

maxLength: 3000 bytesmaxGraphemes: 300 graphemes
links array Optional

The links its pages show, in order, each an http or https address: its website first. Replaces those it had; empty drops them. Left as they are when absent.

maxLength: 5 items
repo stringat-uri Required

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

Output

Encodingapplication/json
defaultBranch string Optional

The branch its HEAD names now.

description string Optional

What it says it is now; absent when it says nothing.

links array Optional

The links its pages show now; absent when there are none.

Errors

NotFound No such repository.
InvalidRequest None was given, the description is too long, a link is not an http or https address or there are too many, or the repository has no such branch.
AuthenticationRequired No account is logged in to the pages, or its session has ended.
Forbidden The account logged in is not the repository's owner.
Try It

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

Base URL for XRPC calls (e.g., https://bsky.social)
Enter valid JSON for the request body
View raw schema 
{
  "description": "Rewrites the repository's dev.knotless.repo record with a new description, new links or a new default branch, any of them, as `knotless describe` does. The default branch must be one of its branches, once it has any. Only its owner, logged in to this appview's web pages, can: the appview writes with the session it keeps for that account, which the pages' session cookie names.",
  "errors": [
    {
      "description": "No such repository.",
      "name": "NotFound"
    },
    {
      "description": "None was given, the description is too long, a link is not an http or https address or there are too many, or the repository has no such branch.",
      "name": "InvalidRequest"
    },
    {
      "description": "No account is logged in to the pages, or its session has ended.",
      "name": "AuthenticationRequired"
    },
    {
      "description": "The account logged in is not the repository's owner.",
      "name": "Forbidden"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "defaultBranch": {
          "description": "The branch its HEAD names, without refs/heads/. Left as it is when absent.",
          "maxLength": 255,
          "type": "string"
        },
        "description": {
          "description": "What the repository is; empty drops it. Left as it is when absent.",
          "maxGraphemes": 300,
          "maxLength": 3000,
          "type": "string"
        },
        "links": {
          "description": "The links its pages show, in order, each an http or https address: its website first. Replaces those it had; empty drops them. Left as they are when absent.",
          "items": {
            "ref": "dev.knotless.defs#link",
            "type": "ref"
          },
          "maxLength": 5,
          "type": "array"
        },
        "repo": {
          "description": "The repository's dev.knotless.repo record, as dev.knotless.getRepo takes it.",
          "format": "at-uri",
          "type": "string"
        }
      },
      "required": [
        "repo"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "defaultBranch": {
          "description": "The branch its HEAD names now.",
          "type": "string"
        },
        "description": {
          "description": "What it says it is now; absent when it says nothing.",
          "type": "string"
        },
        "links": {
          "description": "The links its pages show now; absent when there are none.",
          "items": {
            "ref": "dev.knotless.defs#link",
            "type": "ref"
          },
          "type": "array"
        }
      },
      "type": "object"
    }
  },
  "type": "procedure"
}

Lexicon Garden

@