org.hypercerts.vocab.tag

{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "A reusable vocabulary term for classifying any Hypercerts record — for example a land-cover class, a zone role, or a methodology. The vocabulary is domain-general; geospatial categories are simply its first entries. The schema carries portable term data; named vocabulary profiles decide which published terms and attachment points they recognize. Recommended record key: the deterministic form <category>.<key> (for example zone-role.site), as defined by the governing vocabulary profile; Lexicon validation cannot bind a record key to body fields, so writers and indexers enforce that agreement. A tag reference pins the specific version (CID) of the term that the referencing record classified against; consumers resolve the term's current status and supersession by its URI.",
      "key": "any",
      "record": {
        "properties": {
          "aliases": {
            "description": "Alternative human-readable labels and abbreviations for search and display. Aliases carry no identity: references always point at the record, not at a label.",
            "items": {
              "maxLength": 200,
              "type": "string"
            },
            "maxLength": 50,
            "type": "array"
          },
          "broader": {
            "description": "Optional references to directly broader terms, forming a polyhierarchy (a term may have several broader terms). Each referenced record must conform with org.hypercerts.vocab.tag.",
            "items": {
              "ref": "com.atproto.repo.strongRef",
              "type": "ref"
            },
            "maxLength": 20,
            "type": "array"
          },
          "category": {
            "description": "The classification axis this term belongs to, for example land-cover or zone-role. One term belongs to one category; a subject may carry tags from many categories at once. Values beyond the known set are permitted. Must not contain dots, so that the recommended <category>.<key> record key remains unambiguous.",
            "format": "record-key",
            "knownValues": [
              "zone-role",
              "land-cover",
              "ecosystem-type",
              "stratum-class",
              "tenure",
              "methodology",
              "outcome-class",
              "evidence-type"
            ],
            "maxLength": 50,
            "type": "string"
          },
          "createdAt": {
            "description": "Client-declared timestamp when this record was originally created.",
            "format": "datetime",
            "type": "string"
          },
          "description": {
            "description": "Definition and scope notes for the term, written so a reader outside the publishing organization can apply it consistently.",
            "maxGraphemes": 1000,
            "maxLength": 10000,
            "type": "string"
          },
          "key": {
            "description": "Stable lowercase machine identifier for this term within its publisher and category, for example boundary or mangrove. Must not contain dots, so that the recommended <category>.<key> record key remains unambiguous.",
            "format": "record-key",
            "maxLength": 120,
            "type": "string"
          },
          "name": {
            "description": "Human-readable display name of the term.",
            "maxLength": 200,
            "type": "string"
          },
          "referenceDocument": {
            "description": "A document defining or motivating this term, as a URI or an attached small blob.",
            "refs": [
              "org.hypercerts.defs#uri",
              "org.hypercerts.defs#smallBlob"
            ],
            "type": "union"
          },
          "sameAs": {
            "description": "URIs of exactly equivalent concepts in external vocabularies, for example ENVO, IUCN GET, OSM tag conventions, or registry methodology identifiers. Exact matches only; typed broader/narrower/close mappings are a named future field.",
            "items": {
              "format": "uri",
              "type": "string"
            },
            "maxLength": 20,
            "type": "array"
          },
          "signatures": {
            "description": "Optional cryptographic signatures attesting to this record's content.",
            "ref": "app.certified.signature.defs#list",
            "type": "ref"
          },
          "status": {
            "description": "Lifecycle status of the term: proposed (submitted, not yet governed), accepted (in active governed use), or deprecated (retired; see supersededBy). Values beyond the known set are permitted.",
            "knownValues": [
              "proposed",
              "accepted",
              "deprecated"
            ],
            "maxLength": 20,
            "type": "string"
          },
          "supersededBy": {
            "description": "The replacement term for a deprecated term, letting consumers roll classifications forward without rewriting published records. The referenced record must conform with org.hypercerts.vocab.tag.",
            "ref": "com.atproto.repo.strongRef",
            "type": "ref"
          }
        },
        "required": [
          "key",
          "name",
          "category",
          "status",
          "createdAt"
        ],
        "type": "object"
      },
      "type": "record"
    }
  },
  "id": "org.hypercerts.vocab.tag",
  "lexicon": 1
}