dev.knotless.createCommit

lexicons.knotless.dev

Documentation

Fails with 409 when a change touches a path that moved since `base`, or when the branch kept moving under the batch.

main procedure

Fails with 409 when a change touches a path that moved since `base`, or when the branch kept moving under the batch.

Input

Encodingapplication/json
author ref#author Optional

No description available.

base string Optional

The hex object ID of the commit the changes were made against. Without it the changes apply to whatever the branch holds.

maxLength: 64 bytesminLength: 40 bytes
branch string Required

Without refs/heads/. Created when absent, from `base`, or else from the default branch's tip.

maxLength: 255 bytes
changes array Required

No description available.

message string Required

No description available.

maxLength: 20000 bytes
name string Required

The repository's name: its dev.knotless.repo record key.

maxLength: 100 bytes
repo stringdid Required

The repository's owner.

Output

Encodingapplication/json
batched integer Required

How many commits went out in the write that carried this one.

changed boolean Required

False when the changes left the tree as it was, and no commit was made.

parent string Optional

The hex object ID the commit was built on; absent for a branch's first commit.

sha string Required

The hex object ID of the commit, or of the branch tip when nothing changed.

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": "Fails with 409 when a change touches a path that moved since `base`, or when the branch kept moving under the batch.",
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "author": {
          "ref": "#author",
          "type": "ref"
        },
        "base": {
          "description": "The hex object ID of the commit the changes were made against. Without it the changes apply to whatever the branch holds.",
          "maxLength": 64,
          "minLength": 40,
          "type": "string"
        },
        "branch": {
          "description": "Without refs/heads/. Created when absent, from `base`, or else from the default branch's tip.",
          "maxLength": 255,
          "type": "string"
        },
        "changes": {
          "items": {
            "ref": "#change",
            "type": "ref"
          },
          "type": "array"
        },
        "message": {
          "maxLength": 20000,
          "type": "string"
        },
        "name": {
          "description": "The repository's name: its dev.knotless.repo record key.",
          "maxLength": 100,
          "type": "string"
        },
        "repo": {
          "description": "The repository's owner.",
          "format": "did",
          "type": "string"
        }
      },
      "required": [
        "repo",
        "name",
        "branch",
        "message",
        "changes"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "batched": {
          "description": "How many commits went out in the write that carried this one.",
          "minimum": 0,
          "type": "integer"
        },
        "changed": {
          "description": "False when the changes left the tree as it was, and no commit was made.",
          "type": "boolean"
        },
        "parent": {
          "description": "The hex object ID the commit was built on; absent for a branch's first commit.",
          "maxLength": 64,
          "minLength": 40,
          "type": "string"
        },
        "sha": {
          "description": "The hex object ID of the commit, or of the branch tip when nothing changed.",
          "maxLength": 64,
          "minLength": 40,
          "type": "string"
        }
      },
      "required": [
        "sha",
        "changed",
        "batched"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}
author object

Who the commit names as its author, when not the gateway's default.

Properties

email string Required

No description available.

maxLength: 1000 bytes
name string Required

No description available.

maxLength: 1000 bytes
View raw schema 
{
  "description": "Who the commit names as its author, when not the gateway's default.",
  "properties": {
    "email": {
      "maxLength": 1000,
      "type": "string"
    },
    "name": {
      "maxLength": 1000,
      "type": "string"
    }
  },
  "required": [
    "name",
    "email"
  ],
  "type": "object"
}
change object

One path written or deleted.

Properties

data bytes Optional

The file's new contents; absent to delete it.

executable boolean Optional

No description available.

path string Required

Relative to the repository root.

maxLength: 4096 bytes
View raw schema 
{
  "description": "One path written or deleted.",
  "properties": {
    "data": {
      "description": "The file's new contents; absent to delete it.",
      "type": "bytes"
    },
    "executable": {
      "default": false,
      "type": "boolean"
    },
    "path": {
      "description": "Relative to the repository root.",
      "maxLength": 4096,
      "type": "string"
    }
  },
  "required": [
    "path"
  ],
  "type": "object"
}

Lexicon Garden

@