place.wisp.subfs

wisp.place

Documentation

Virtual filesystem manifest for a Wisp site

main record

Virtual filesystem manifest for a Wisp site

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

fileCount integer Optional

No description available.

minimum: 0maximum: 1000
root ref #directory Required

No description available.

site string Required

No description available.

View raw schema 
{
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "site",
      "root",
      "createdAt"
    ],
    "properties": {
      "root": {
        "ref": "#directory",
        "type": "ref"
      },
      "site": {
        "type": "string"
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "fileCount": {
        "type": "integer",
        "maximum": 1000,
        "minimum": 0
      }
    }
  },
  "description": "Virtual filesystem manifest for a Wisp site"
}
directory object

No description available.

Properties

entries array of ref#entry Required

No description available.

maxLength: 500 items
type string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "type",
    "entries"
  ],
  "properties": {
    "type": {
      "type": "string",
      "const": "directory"
    },
    "entries": {
      "type": "array",
      "items": {
        "ref": "#entry",
        "type": "ref"
      },
      "maxLength": 500
    }
  }
}
entry object

No description available.

Properties

name string Required

No description available.

maxLength: 255 bytes
View raw schema 
{
  "type": "object",
  "required": [
    "name",
    "node"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 255
    },
    "node": {
      "refs": [
        "#file",
        "#directory",
        "#subfs"
      ],
      "type": "union"
    }
  }
}
file object

No description available.

Properties

base64 boolean Optional

True if blob content is base64-encoded (used to bypass PDS content sniffing)

blob blob Required

Content blob ref

maxSize: 1000.0 MB
encoding string Optional

Content encoding (e.g., gzip for compressed files)

mimeType string Optional

Original MIME type before compression

type string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "type",
    "blob"
  ],
  "properties": {
    "blob": {
      "type": "blob",
      "accept": [
        "*/*"
      ],
      "maxSize": 1000000000,
      "description": "Content blob ref"
    },
    "type": {
      "type": "string",
      "const": "file"
    },
    "base64": {
      "type": "boolean",
      "description": "True if blob content is base64-encoded (used to bypass PDS content sniffing)"
    },
    "encoding": {
      "enum": [
        "gzip"
      ],
      "type": "string",
      "description": "Content encoding (e.g., gzip for compressed files)"
    },
    "mimeType": {
      "type": "string",
      "description": "Original MIME type before compression"
    }
  }
}
subfs object

No description available.

Properties

flat boolean Optional

If true (default), the subfs record's root entries are merged (flattened) into the parent directory, replacing the subfs entry. If false, the subfs entries are placed in a subdirectory with the subfs entry's name. Flat merging is useful for splitting large directories across multiple records while maintaining a flat structure.

subject string at-uri Required

AT-URI pointing to a place.wisp.subfs record containing this subtree.

type string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "type",
    "subject"
  ],
  "properties": {
    "flat": {
      "type": "boolean",
      "description": "If true (default), the subfs record's root entries are merged (flattened) into the parent directory, replacing the subfs entry. If false, the subfs entries are placed in a subdirectory with the subfs entry's name. Flat merging is useful for splitting large directories across multiple records while maintaining a flat structure."
    },
    "type": {
      "type": "string",
      "const": "subfs"
    },
    "subject": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI pointing to a place.wisp.subfs record containing this subtree."
    }
  }
}

Lexicon Garden

@