space.highport.sites.defs

{
  "id": "space.highport.sites.defs",
  "defs": {
    "access": {
      "type": "object",
      "properties": {
        "audience": {
          "refs": [
            "space.highport.sites.defs#spaceMembers"
          ],
          "type": "union",
          "closed": true,
          "description": "Who the paths in requireAuth are for. Absent means any signed-in reader, which is what requireAuth alone has always meant. Meaningful only alongside requireAuth: an audience with nothing gated narrows a gate that is not there. The union is closed because a host that cannot evaluate an audience must refuse the record rather than serve it to everybody — an unrecognized audience that fell open would be a gate quietly removed by a schema it did not understand."
        },
        "requireAuth": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 1024
          },
          "maxLength": 64,
          "description": "Path prefixes that always require a signed-in reader and always bill that reader, whatever the owner budget says and whether or not it is spent. Matched against the normalized request path, so a prefix covers everything beneath it. A prefix of \"/\" is the whole site and says the same thing as an owner budget of zero."
        }
      },
      "description": "Which parts of a site require a signed-in reader, and which readers count. Absent means none of it: the domain's owner budget decides every path, which is the arrangement almost every site wants. This is content policy rather than a billing arrangement — it says which parts of a publication are premium and to whom, it survives moving to another host, and a reader of the record can see it without asking the host."
    },
    "manifest": {
      "type": "object",
      "required": [
        "resources"
      ],
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 1000,
          "description": "Bundle name. Required when the manifest is a tile's content; optional for an inline site source.",
          "maxGraphemes": 100
        },
        "resources": {
          "type": "unknown",
          "description": "Map of absolute request path (beginning with '/') to space.highport.sites.defs#resource. Lexicon has no map type. A '/' entry is required for tile content and recommended for sites."
        }
      },
      "description": "A path-keyed bundle of resources — bard's camelCase subset of a MASL bundle-mode document. The inline source of a site, or the content of a tile."
    },
    "redirect": {
      "type": "object",
      "required": [
        "from",
        "to"
      ],
      "properties": {
        "to": {
          "type": "string",
          "maxLength": 2048,
          "description": "Destination path. Must be an absolute path on this site that exists as a manifest key."
        },
        "from": {
          "type": "string",
          "maxLength": 2048,
          "description": "The request path to match, optionally including a query string. Matching is exact."
        },
        "status": {
          "type": "integer",
          "description": "Redirect status. Defaults to 302.",
          "knownValues": [
            301,
            302,
            307,
            308
          ]
        }
      }
    },
    "resource": {
      "type": "object",
      "required": [
        "src"
      ],
      "properties": {
        "src": {
          "type": "blob",
          "description": "The blob holding this resource's bytes."
        },
        "status": {
          "type": "integer",
          "description": "Response status. Defaults to 200 for manifest entries and 404 for the notFound resource.",
          "knownValues": [
            200,
            404,
            410
          ]
        },
        "contentType": {
          "type": "string",
          "maxLength": 255,
          "description": "Serve the asset with this content type instead of the blob's mimeType."
        },
        "contentEncoding": {
          "type": "string",
          "description": "Declares the stored blob is already encoded with this algorithm; the origin serves it as-is with a matching Content-Encoding header.",
          "knownValues": [
            "gzip",
            "br",
            "zstd",
            "identity"
          ]
        }
      },
      "description": "A single addressable resource within a manifest."
    },
    "wellKnown": {
      "type": "object",
      "properties": {
        "rasl": {
          "type": "boolean",
          "description": "Serve GET /.well-known/rasl/{cid} for every CID this site references. Default true."
        },
        "atproto": {
          "type": "boolean",
          "description": "Serve GET /.well-known/atproto-did with the site's owning DID. Default true."
        },
        "standardSitePublication": {
          "type": "string",
          "format": "at-uri",
          "description": "Serve GET /.well-known/site.standard.publication with this AT-URI, so the domain proves a standard.site publication. It must name a site.standard.publication record in the site owner's own repository whose url host is this domain; bard checks both when it indexes the site record and refuses the record otherwise. A manifest entry at that path is refused while this is set."
        }
      },
      "description": "Controls the responses bard synthesizes under /.well-known/. The two flags default to true and exist only to turn things off; standardSitePublication is absent unless a publisher names one."
    },
    "spaceMembers": {
      "type": "object",
      "properties": {},
      "description": "The members of the space this site is held in, as its host answers for them. Valid only on a site served from a space; a site published to a repository has no space to ask about and the field is refused there rather than ignored. Carries no member list and names no identity: the space's own host is asked, and the answer is not part of the record."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}