community.lexicon.media.book.resolveEditions

Resolve one book by exact equality of at least one identifier issuer/value pair. Shared grouping identifiers may match several editions. Results are in provider-defined relevance order. This operation does not write user records.

Details · procedure
Kindprocedure
Authoritybook.media.lexicon.community
Commit rev3n2h5svwgmg2b
Indexed
cid bafyreif2vql3hksu37yzlxggzikgj5qixgrmmcgmbwm5svlwgqrrwxky3m

Checks

Valid Lint pass
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Resolve one book by exact equality of at least one identifier issuer/value pair. Shared grouping identifiers may match several editions. Results are in provider-defined relevance order. This operation does not write user records.",
      "input": {
        "encoding": "application/json",
        "schema": {
          "description": "Resolve one identifier bag. Batch resolution is not defined in this version.",
          "properties": {
            "identifiers": {
              "description": "Identifiers describing one book. An edition qualifies when at least one supplied issuer/value pair matches exactly. Unknown identifiers do not invalidate other matches.",
              "items": {
                "ref": "community.lexicon.media.book.defs#identifier",
                "type": "ref"
              },
              "minLength": 1,
              "type": "array"
            },
            "limit": {
              "default": 25,
              "description": "Maximum number of editions to return in this page.",
              "maximum": 100,
              "minimum": 1,
              "type": "integer"
            },
            "offset": {
              "default": 0,
              "description": "Number of matching editions to skip in the provider's ordered result set.",
              "minimum": 0,
              "type": "integer"
            }
          },
          "required": [
            "identifiers"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "ref": "community.lexicon.media.book.defs#editionResults",
          "type": "ref"
        }
      },
      "type": "procedure"
    }
  },
  "description": "Resolve one book by exact equality of at least one identifier issuer/value pair. Shared grouping identifiers may match several editions. Results are in provider-defined relevance order. This operation does not write user records.",
  "id": "community.lexicon.media.book.resolveEditions",
  "lexicon": 1
}