Lexicon Garden

com.bad-example.repo.getUriRecord

ergonomic complement to com.atproto.repo.getRecord which accepts an at-uri instead of individual repo/collection/rkey params

Repository @bad-example.com did:plc:hdhoaan3xa3jiuq4fg4mefid namespace authority
Details · query
Kindquery
Authorityrepo.bad-example.com
Indexed
Compare Edit in builder → Fork →
cid bafyreifcfrscieoglneml2mk3grkokeidrgddlvh6jxe543ade4qr6ylie

Checks

Valid
  • field-name-syntax defs.main.parameters.properties.at_uriThe field name at_uri should be letters and digits, starting with a letter.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "ergonomic complement to com.atproto.repo.getRecord which accepts an at-uri instead of individual repo/collection/rkey params",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "cid": {
              "description": "CID for this exact version of the record",
              "format": "cid",
              "type": "string"
            },
            "uri": {
              "description": "at-uri for this record",
              "format": "at-uri",
              "type": "string"
            },
            "value": {
              "description": "the record itself",
              "type": "unknown"
            }
          },
          "required": [
            "uri",
            "value"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "at_uri": {
            "description": "the at-uri of the record (identifier can be a DID or handle)",
            "format": "at-uri",
            "type": "string"
          },
          "cid": {
            "description": "optional CID of the version of the record. if not specified, return the most recent version. if specified and a newer version exists, returns 404.",
            "format": "cid",
            "type": "string"
          }
        },
        "required": [
          "at_uri"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "com.bad-example.repo.getUriRecord",
  "lexicon": 1
}