Lexicon Garden

pub.chive.backlink.create

Create a backlink record. Internal/plugin use only. Requires authentication.

Repository @lexicons.governance.chive.pub did:plc:egjghlwgts2hlcer2txilxeh not from the namespace authority
Details · procedure
Kindprocedure
Authoritybacklink.chive.pub
Indexed
Compare Edit in builder → Fork →
cid bafyreigjt6lbr2uzhtj3lxhsnptca6s5gwdnbpw6ntd7rdhztzdso7ego4

Checks

Valid
  • unlimited-string defs.backlink.properties.sourceTypeNo maxLength, maxGraphemes or format limits this string.
  • unlimited-string defs.main.input.schema.properties.sourceTypeNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "backlink": {
      "description": "Backlink record",
      "properties": {
        "context": {
          "description": "Optional context about the backlink",
          "maxLength": 500,
          "type": "string"
        },
        "deleted": {
          "description": "Whether the backlink has been deleted",
          "type": "boolean"
        },
        "id": {
          "description": "Backlink ID",
          "type": "integer"
        },
        "indexedAt": {
          "description": "Timestamp when the backlink was indexed",
          "format": "datetime",
          "type": "string"
        },
        "sourceType": {
          "description": "Type of the source record",
          "knownValues": [
            "cosmik.collection",
            "leaflet.list",
            "bluesky.post",
            "bluesky.embed",
            "other"
          ],
          "type": "string"
        },
        "sourceUri": {
          "description": "AT-URI of the source record",
          "format": "at-uri",
          "type": "string"
        },
        "targetUri": {
          "description": "AT-URI of the target eprint",
          "format": "at-uri",
          "type": "string"
        }
      },
      "required": [
        "id",
        "sourceUri",
        "sourceType",
        "targetUri",
        "indexedAt",
        "deleted"
      ],
      "type": "object"
    },
    "main": {
      "description": "Create a backlink record. Internal/plugin use only. Requires authentication.",
      "errors": [
        {
          "name": "AuthenticationRequired"
        },
        {
          "name": "InvalidRequest"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "context": {
              "description": "Optional context about the backlink",
              "maxLength": 500,
              "type": "string"
            },
            "sourceType": {
              "description": "Type of the source record",
              "knownValues": [
                "cosmik.collection",
                "leaflet.list",
                "bluesky.post",
                "bluesky.embed",
                "other"
              ],
              "type": "string"
            },
            "sourceUri": {
              "description": "AT-URI of the source record",
              "format": "at-uri",
              "type": "string"
            },
            "targetUri": {
              "description": "AT-URI of the target eprint",
              "format": "at-uri",
              "type": "string"
            }
          },
          "required": [
            "sourceUri",
            "sourceType",
            "targetUri"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "ref": "#backlink",
          "type": "ref"
        }
      },
      "type": "procedure"
    }
  },
  "id": "pub.chive.backlink.create",
  "lexicon": 1,
  "revision": 1
}