dev.knotless.editItem

lexicons.knotless.dev

Documentation

Rewrites a dev.knotless.pull, dev.knotless.issue or dev.knotless.comment record in the account logged in to this appview's web pages, which must have written it, as `knotless edit` does: a pull's or an issue's title or body, or a comment's body, and whether a pull is a draft. An empty body takes a pull's or an issue's away; a comment keeps one. Requires the session cookie the pages' login sets.

main procedure

Rewrites a dev.knotless.pull, dev.knotless.issue or dev.knotless.comment record in the account logged in to this appview's web pages, which must have written it, as `knotless edit` does: a pull's or an issue's title or body, or a comment's body, and whether a pull is a draft. An empty body takes a pull's or an issue's away; a comment keeps one. Requires the session cookie the pages' login sets.

Input

Encodingapplication/json
body string Optional

Its new body, in Markdown.

maxLength: 20000 bytes
draft boolean Optional

For a pull, make it a draft, or with false mark it ready to merge. Left as it is, when absent; any other item refuses it.

images array Optional

Pictures uploaded with dev.knotless.uploadImage for the new body. Of these and those it had, the new body's links decide which stay attached.

maxLength: 32 items
repo stringat-uri Required

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

subject stringat-uri Required

The pull, issue or comment to change.

title string Optional

A pull's or an issue's new title.

maxLength: 3000 bytesmaxGraphemes: 300 graphemes

Output

Encodingapplication/json
uri stringat-uri Required

The record changed.

Errors

NotFound No such repository.
AuthenticationRequired No account is logged in to the pages, or its session has ended.
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 a dev.knotless.pull, dev.knotless.issue or dev.knotless.comment record in the account logged in to this appview's web pages, which must have written it, as `knotless edit` does: a pull's or an issue's title or body, or a comment's body, and whether a pull is a draft. An empty body takes a pull's or an issue's away; a comment keeps one. Requires the session cookie the pages' login sets.",
  "errors": [
    {
      "description": "No such repository.",
      "name": "NotFound"
    },
    {
      "description": "No account is logged in to the pages, or its session has ended.",
      "name": "AuthenticationRequired"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "body": {
          "description": "Its new body, in Markdown.",
          "maxLength": 20000,
          "type": "string"
        },
        "draft": {
          "description": "For a pull, make it a draft, or with false mark it ready to merge. Left as it is, when absent; any other item refuses it.",
          "type": "boolean"
        },
        "images": {
          "description": "Pictures uploaded with dev.knotless.uploadImage for the new body. Of these and those it had, the new body's links decide which stay attached.",
          "items": {
            "ref": "dev.knotless.defs#image",
            "type": "ref"
          },
          "maxLength": 32,
          "type": "array"
        },
        "repo": {
          "description": "The repository's dev.knotless.repo record, as dev.knotless.getRepo takes it.",
          "format": "at-uri",
          "type": "string"
        },
        "subject": {
          "description": "The pull, issue or comment to change.",
          "format": "at-uri",
          "type": "string"
        },
        "title": {
          "description": "A pull's or an issue's new title.",
          "maxGraphemes": 300,
          "maxLength": 3000,
          "type": "string"
        }
      },
      "required": [
        "repo",
        "subject"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "uri": {
          "description": "The record changed.",
          "format": "at-uri",
          "type": "string"
        }
      },
      "required": [
        "uri"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}

Lexicon Garden

@