vibe-sketcherDocumentation

vibesketcher.server.guest_loading

REST routes for reproducible guest loading into periodic hosts (#203).

A preview reads the current document and changes nothing; applying is checked against the document revision (and optionally the previewed host digest) and recorded as an edit; an applied loading has an undo route that refuses when the loaded model changed since.

Functions

router(store)

Classes

LoadingPreviewRequest(*, loading)

LoadingRequest(*[, actor, client, source_sha256])

LoadingUndoRequest(*[, actor, client])

class vibesketcher.server.guest_loading.LoadingPreviewRequest(*, loading)[source]

Bases: BaseModel

Parameters:

loading (dict[str, Any])

model_config = {'extra': 'forbid'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

loading: dict[str, Any]
class vibesketcher.server.guest_loading.LoadingRequest(*, actor='agent', client='rest', revision, loading, source_sha256=None)[source]

Bases: RevisionRequest

Parameters:
  • actor (Literal['human', 'agent', 'system'])

  • client (Annotated[str, _PydanticGeneralMetadata(pattern='^[a-z0-9][a-z0-9_.:+-]{0,63}$')])

  • revision (int)

  • loading (dict[str, Any])

  • source_sha256 (Annotated[str | None, _PydanticGeneralMetadata(pattern='^[0-9a-f]{64}$')])

loading: dict[str, Any]
source_sha256: str | None
model_config = {'extra': 'forbid'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class vibesketcher.server.guest_loading.LoadingUndoRequest(*, actor='agent', client='rest', revision, structure)[source]

Bases: RevisionRequest

Parameters:
  • actor (Literal['human', 'agent', 'system'])

  • client (Annotated[str, _PydanticGeneralMetadata(pattern='^[a-z0-9][a-z0-9_.:+-]{0,63}$')])

  • revision (int)

  • structure (str)

structure: str
model_config = {'extra': 'forbid'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

vibesketcher.server.guest_loading.router(store)[source]
Parameters:

store (Store)

Return type:

APIRouter