bayesline.api.equity.PortfolioSettingsMenu#

pydantic model bayesline.api.equity.PortfolioSettingsMenu#

Specifies the set of available options that can be used to create portfolio settings.

Show JSON schema
{
   "title": "PortfolioSettingsMenu",
   "description": "Specifies the set of available options that can be used to create portfolio settings.",
   "type": "object",
   "properties": {
      "sources": {
         "description": "The available sources (i.e. user uploaded portfolios or system uploaded portfolios).",
         "items": {
            "type": "string"
         },
         "title": "Sources",
         "type": "array"
      },
      "schemas": {
         "description": "The available schemas (i.e. names from the portfolio organizer).",
         "items": {
            "type": "string"
         },
         "title": "Schemas",
         "type": "array"
      }
   },
   "additionalProperties": false
}

Config:
  • frozen: bool = True

  • extra: str = forbid

Fields:
  • schemas (list[str])

  • sources (list[str])

field sources: list[str] [Optional]#

The available sources (i.e. user uploaded portfolios or system uploaded portfolios).

field schemas: list[str] [Optional]#

The available schemas (i.e. names from the portfolio organizer).

describe() str#

Describe the available options.

Returns#

str

A description of the available options.