bayesline.api.equity.ReportSettings

pydantic model bayesline.api.equity.ReportSettings

Concrete settings for a report.

Subclasses must override report_type with a Literal type for polymorphic deserialization via the discriminated union AnyReportSettings.

Show JSON schema

{
   "title": "ReportSettings",
   "description": "Concrete settings for a report.\n\nSubclasses must override `report_type` with a Literal type for polymorphic\ndeserialization via the discriminated union `AnyReportSettings`.",
   "type": "object",
   "properties": {
      "report_type": {
         "description": "Discriminator field for report type",
         "title": "Report Type",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "report_type"
   ]
}

Config:

• frozen: bool = True

• extra: str = forbid

Fields:

• report_type (str)

Validators:

field report_type: str [Required]

Discriminator field for report type

Validated by:

• _strip_unknown_on_load

property menu_type: type[ReportSettingsMenu]

The menu type for this settings object.