Skip to content
Roboto
Esc
↑↓navigate↵open⌘Jpreview
On this page

roboto.domain.views.operations

Module Contents

CreateViewRequest

class roboto.domain.views.operations.CreateViewRequest(/, **data)#View Source

Bases: pydantic.BaseModel

Request payload to create a View.

Parameters

data Any

Attributes

CreateViewRequest.definition

The query and presentation state to save.

CreateViewRequest.name

name str = None #

Display name. Need not be unique.

CreateViewRequest.target

The resource type this View searches. Cannot be changed afterwards.

CreateViewRequest.visibility

Who the View is visible to once created.

Private by default. A View is a saved search someone arrived at while working, and most are of no interest to anyone else; publishing every one of them to the whole org on the author’s behalf is the harder default to undo, since by the time they notice, their colleagues have already seen it. Sharing afterwards is one call to the access endpoint, and is reserved to the author.

Only these two tiers exist at creation. Granting one named colleague access is a per-user grant, which the access endpoint handles and which no create-time field could express without duplicating it.

MAX_VIEW_NAME_LENGTH

roboto.domain.views.operations.MAX_VIEW_NAME_LENGTH: Final[int] = 120#View Source

Longest permitted View name, matching the limit layouts uses.

UpdateViewRequest

class roboto.domain.views.operations.UpdateViewRequest(/, **data)#View Source

Bases: pydantic.BaseModel

Request payload to update a View.

Omitted fields are left unchanged. target is absent by design: a View’s conditions are written against one resource type, so retargeting it would leave them referring to fields the new target does not have. Create a new View instead.

Parameters

data Any

Attributes

UpdateViewRequest.definition

Replacement query and presentation state, or NotSet to leave it alone.

Replaces the definition wholesale rather than merging, so a caller changing one filter must send the whole definition back.

UpdateViewRequest.model_config

model_config #

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

UpdateViewRequest.name

name str | roboto.sentinels.NotSetType = None #

New display name, or NotSet to leave it alone.

Was this page helpful?