DocumentLast updated on
Last updated on
An artifact for static documents
A Document is a static document. It is the simplest artifact in OpenForm.
Documents are used for disclosures, pamphlets, statutory notices, or any other static content.
Properties
kind: "document"
Literal "document" discriminator
name: string
Unique identifier; must follow slug constraints
version?: string
Artifact version (semantic versioning)
title?: string
Human-friendly name presented to end users
description?: string
Long-form description or context
code?: string
Internal code or reference number
releaseDate?: string
ISO date string indicating when the artifact was released
metadata?: Metadata
Custom metadata map (keys must be alphanumeric with hyphens)
layers?: Record<string, Layer>
Named layers for rendering this document into different formats
defaultLayer?: string
Key of the default layer to use when none specified
Examples
kind: document
name: lead-paint-disclosure
version: "1.0.0"
title: Lead Paint Disclosure
description: Required disclosure for properties built before 1978
layers:
pdf:
kind: file
mimeType: application/pdf
path: /disclosures/lead-paint.pdf
title: PDF Version
markdown:
kind: inline
mimeType: text/markdown
text: |
# Lead Paint Disclosure
This property was built before 1978 and may contain lead-based paint.
# Important Information
Lead from paint, paint chips, and dust can pose health hazards...
defaultLayer: pdfRelated
- Layer - Layer specification details