roboto.domain.dashboards.operations
Module Contents
CreateDashboardRequest
Bases: pydantic.BaseModel
Request body for POST /v1/metrics/dashboards/create.
Parameters
data AnyAttributes
CreateDashboardRequest.accessibility
Whether the dashboard is org-wide or personal. The server derives owner_principal_id from this — the org principal for organization, the creator’s user principal for user — and ownership is the stored source of truth; this field is not persisted separately.
CreateDashboardRequest.dashboard_definition
The dashboard definition as a JSON object. Stored verbatim and never interpreted by the platform; it carries its own schema version for the clients that read it.
UpdateDashboardRequest
Bases: pydantic.BaseModel
Request body for PUT /v1/metrics/dashboards/id/<dashboard_id>.
Parameters
data AnyAttributes
UpdateDashboardRequest.accessibility
accessibility roboto.Whether the dashboard should become org-wide or personal. The server re-derives owner_principal_id from this — to the org principal for organization, back to the creator’s user principal for user; ownership is the stored source of truth.
UpdateDashboardRequest.base_revision
The revision you loaded — not the revision you want.
Required when dashboard_definition is present, and rejected otherwise. The server compares it against the stored revision and rejects the write if the definition has been replaced in the meantime, so a save built on a stale copy cannot silently erase someone else’s edit. A rename or accessibility change carries no base revision: neither touches the definition, so neither can clobber it.
UpdateDashboardRequest.dashboard_definition
The dashboard definition as a JSON object. Replaces the stored definition wholesale; it carries its own schema version, so no separate version field accompanies it.
UpdateDashboardRequest.model_config
model_config #Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
UpdateDashboardRequest.name
The name of the dashboard.
UpdateDashboardRequest.validate_base_revision_with_definition()
Require a base revision for definition writes, and only for definition writes.
The presence checks use NotSetType rather than truthiness: base_revision=0 is the commonest real value — a dashboard whose definition has never been rewritten — and a falsy test would reject exactly that.
Return type