backend.routers.documents Namespace Reference

Classes
class	CreatePayload
class	ReleasePayload

Variables
dict	ui = {}
	store
	router = make_router(store, prefix="/api/engine/documents")

Detailed Description

Per-user engine designs with sharing, microversion history and named releases.

A thin binding of :mod:`stardesign.documents` -- the router shared by all three
design tools -- to this app's payload shape and route prefix. Everything of
substance, including ``_resolve_doc`` (the one place cross-user access is
granted), lives there.

The payload here is ``{"config": <dict>, "ui": <dict>}``; pid-designer's is
``{nodes, edges}``. That, the prefix, and the noun are the whole difference.

``ui`` carries the authored state that is not in ``PintleEngineConfig`` -- the
controller commands, the time-series pressure profiles, Layer 4's vehicle
definition, the layer run settings, the plot definition. It is opaque here, as
the config is: the frontend owns its shape (see frontend/src/lib/designState.ts).
It defaults to ``{}`` so every design stored before it existed still loads.

Variable Documentation

router

backend.routers.documents.router = make_router(store, prefix="/api/engine/documents")

Definition at line 73 of file documents.py.

store

backend.routers.documents.store

Initial value:

=  DesignStore(
    ud=userdata.store,
    backend=storage.backend,
    body_model=ConfigPayload,
    create_model=CreatePayload,
    release_model=ReleasePayload,
    to_data=lambda p: {
        "config": getattr(p, "config", None) or {},
        "ui": getattr(p, "ui", None) or {},
    },
    release_body=lambda p: (
        None if p.config is None else {"config": p.config, "ui": p.ui or {}}
    ),
    noun="design",
    default_slug="design",
    # Seconds between automatic microversion snapshots for one design while it
    # is being actively autosaved. The on-close /flush ignores this.
    micro_interval=int(os.environ.get("ENGINE_MICRO_INTERVAL", "300")),
    empty_payload=lambda: {"config": {}, "ui": {}},
)

Definition at line 52 of file documents.py.

ui

dict backend.routers.documents.ui = {}

Definition at line 37 of file documents.py.