tangl.service response¶

Typed response and envelope models returned by canonical service methods.

Related design docs

Response Type Decision Matrix

Related notes

v38 Cutover Log

Response models¶

class RuntimeInfo(*, status, code=None, message=None, cursor_id=None, step=None, details=None)[source]¶: Service runtime acknowledgement payload.

class InfoModel[source]¶: Marker base for service information payloads.

class RuntimeEnvelope(*, cursor_id=None, step=None, fragments=<factory>, last_redirect=None, redirect_trace=<factory>, metadata=<factory>)[source]¶: Ordered-fragment runtime payload for vm/story clients.

class ProjectedState(*, sections=<factory>)[source]¶: Canonical ordered projected-state payload for runtime surfaces.

class UserInfo(*, user_id, user_secret, created_dt, last_played_dt=None, worlds_played, stories_finished=0, turns_played=0, achievements=None)[source]¶

class WorldInfo(*, label, title=None, author=None)[source]¶

class SystemInfo(*, engine, version, uptime, worlds, num_users, homepage_url='https://github.com/derekmerck/storytangl')[source]¶

class UserSecret(*, api_key, user_secret, user_id=None)[source]¶: API-key material returned for user bootstrap and secret rotation.

class ProjectedSection(*, section_id, title, kind=None, value, hints=None)[source]¶: One ordered projected runtime-state section.

class ScalarValue(*, value_type='scalar', value)[source]¶: Single scalar projected-state payload.

class KvListValue(*, value_type='kv_list', items)[source]¶: Ordered key-value payload.

class ItemListValue(*, value_type='item_list', items)[source]¶: Ordered projected item list.

class TableValue(*, value_type='table', columns, rows)[source]¶: Tabular projected-state payload.

class BadgeListValue(*, value_type='badges', items)[source]¶: Badge or label collection payload.