lol.dids.sites.defs

ngerakines.me

Documentation

manifest object

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.

Properties

name string Optional

Bundle name. Required when the manifest is a tile's content; optional for an inline site source.

maxLength: 1000 bytesmaxGraphemes: 100 graphemes
resources unknown Required

Map of absolute request path (beginning with '/') to lol.dids.sites.defs#resource. Lexicon has no map type. A '/' entry is required for tile content and recommended for sites.

View raw schema 
{
  "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 lol.dids.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 object

No description available.

Properties

from string Required

The request path to match, optionally including a query string. Matching is exact.

maxLength: 2048 bytes
status integer Optional

Redirect status. Defaults to 302.

to string Required

Destination path. Must be an absolute path on this site that exists as a manifest key.

maxLength: 2048 bytes
View raw schema 
{
  "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 object

A single addressable resource within a manifest.

Properties

contentEncoding string Optional

Declares the stored blob is already encoded with this algorithm; the origin serves it as-is with a matching Content-Encoding header.

Known values: gzip, br, zstd, identity
contentType string Optional

Serve the asset with this content type instead of the blob's mimeType.

maxLength: 255 bytes
src blob Required

The blob holding this resource's bytes.

status integer Optional

Response status. Defaults to 200 for manifest entries and 404 for the notFound resource.

View raw schema 
{
  "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 object

Controls the responses bard synthesizes under /.well-known/. Every field defaults to true; the object exists only to turn things off.

Properties

atproto boolean Optional

Serve GET /.well-known/atproto-did with the site's owning DID. Default true.

rasl boolean Optional

Serve GET /.well-known/rasl/{cid} for every CID this site references. Default true.

View raw schema 
{
  "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."
    }
  },
  "description": "Controls the responses bard synthesizes under /.well-known/. Every field defaults to true; the object exists only to turn things off."
}

Lexicon Garden

@