dev.knotless.shareRepo Documentation (EN)

main procedure

Names the account among the collaborators of the repository's dev.knotless.repo record, as `knotless share --write` does: it pushes and commits through the gateway the owner delegated writes to, which must be named first, as `knotless delegate` names it. 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

repo stringat-uri Required

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

with stringat-identifier Required

The account, by handle or DID.

write boolean Optional

Whether it may push, as `knotless share --write` lets it; false lets it only read a private repository, and open pulls and issues there, as `knotless share` does, taking back any push it had. True when absent.

Output

Encodingapplication/json

collaborators array Required

The accounts that may push to it now.

Errors

NotFound No such repository.

InvalidRequest There is no such account, the owner has delegated writes to no gateway, or a public repository was shared for reading, which anyone may.

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.

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

Request Body (JSON) Enter valid JSON for the request body

View raw schema

{
  "description": "Names the account among the collaborators of the repository's dev.knotless.repo record, as `knotless share --write` does: it pushes and commits through the gateway the owner delegated writes to, which must be named first, as `knotless delegate` names it. 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": "There is no such account, the owner has delegated writes to no gateway, or a public repository was shared for reading, which anyone may.",
      "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": {
        "repo": {
          "description": "The repository's dev.knotless.repo record, as dev.knotless.getRepo takes it.",
          "format": "at-uri",
          "type": "string"
        },
        "with": {
          "description": "The account, by handle or DID.",
          "format": "at-identifier",
          "type": "string"
        },
        "write": {
          "description": "Whether it may push, as `knotless share --write` lets it; false lets it only read a private repository, and open pulls and issues there, as `knotless share` does, taking back any push it had. True when absent.",
          "type": "boolean"
        }
      },
      "required": [
        "repo",
        "with"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "collaborators": {
          "description": "The accounts that may push to it now.",
          "items": {
            "ref": "dev.knotless.defs#actorView",
            "type": "ref"
          },
          "type": "array"
        }
      },
      "required": [
        "collaborators"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}