Blueprints
Blueprints glossary
Definitions of the core Blueprints terms: stacks, scopes, values, deletion policies, and more.
Definitions of the core Blueprints terms. For a narrative introduction, see the Blueprints introduction.
| Term | Definition |
|---|---|
| Application | A Sanity App SDK app deployed as a blueprint resource with defineApplication. Groups views and web workers. |
| Asset source view | A view that renders as a picker when a user selects an asset source, declared with defineAssetSourceView. |
| Attach / detach | Bring an existing resource under Blueprints management (attach), or stop managing it without deleting it (detach). |
| Blueprint config file | .sanity/blueprint.config.json. Links a local blueprint file to a remote stack and records the scope. Gitignored by default; not secret. |
| Blueprint file | The file you edit, sanity.blueprint.ts, declaring your desired resources. Also called the manifest. See the Blueprint configuration reference. |
| Blueprints | Sanity's infrastructure-as-code system for managing resources from a file in your repo. |
| Definer | A typed function such as defineCorsOrigin or defineRole that declares a resource and checks your input as you write it. |
| Deletion policy | A per-resource setting (allow, retain, replace, protect) controlling what happens when a resource is removed or a stack is destroyed. |
| Deploy | Applying the blueprint file to a stack so resources match it. The command is blueprints deploy. |
| Destroy | Removing a stack's resources, subject to their deletion policies. The command is blueprints destroy. |
| Dock | The vertical rail on the left edge of the Dashboard. It lists an item for each app window and panel, grouped into system, applications, and user areas. |
| Media Library configuration | A singleton config resource that configures Media Library as code with defineMediaLibraryConfig. |
| Organization scope | A stack scoped to an organization. Unlocks org-scoped resource types and spans multiple projects. See the Blueprints scopes reference. |
| Panel view | A narrow, persistent column that opens between the dock and the window, declared with definePanelView. The same surface Notifications and Content Agent use. An app can have several. |
| Plan | The read-only, deterministic diff between your blueprint file and a stack's current state. The command is blueprints plan. |
| Project scope | A stack scoped to a single project. |
| Promotion | Converting a project-scoped stack to organization scope. One-way and safe. See Promote a stack to organization scope. |
| Reference ($ syntax) | In-file pointers: $.values.<key> for a constant, $.resources.<name> for another resource (which creates a dependency edge). See The resource graph. |
| Resource | A single thing Blueprints manages: a dataset, CORS origin, webhook, role, robot token, or function. Has a unique name. |
| Rollback | Blueprints' best-effort attempt to undo completed changes, in reverse, when a deploy fails partway. See Errors and rollbacks. |
| Scope | The boundary a stack operates within: project or organization. |
| Singleton config | A one-per-organization configuration deployed as a blueprint resource, such as the Media Library configuration. |
| Stack | The deployed counterpart to a blueprint file: the live resources on Sanity's side. One file can deploy to many stacks. |
| Tile view | A compact view rendered on the Dashboard home page, declared with defineTileView. |
| Value | A reusable, file-level constant (always a string) defined in the values block and referenced with $.values.<key>. |
| View | A UI surface of an application: a window, panel, tile, or asset source, declared with a view definer. See the individual entries for each type. |
| Web worker | A background process in an application declared with defineWebWorker, running off the main thread while the app is open. |
| Window view | An app's main, full-page view, filling the area to the right of the dock and any open panel, declared with defineWindowView. The surface a traditional App SDK app renders into. An application can have at most one. |
Related
Blueprints introduction
Learn what Blueprints are, how they work, and how to get started.
Stacks and scope
How one blueprint file maps to many stacks, and what project versus organization scope means.
The resource graph
How resources reference each other with the $ syntax, and why a blueprint file is a connected system.
Errors and rollbacks
How Blueprints catches mistakes early and what happens when a deploy fails.
Was this page helpful?
Feedback submitted, thanks for helping us improve the docs. Have you tried these alternatives?