Skip to content

A reactive notebook for Python — run reproducible experiments, query with SQL, execute as a script, deploy as an app, and version with git. Stored as pure Python. All in a modern, AI-native editor.

internal: fix api snapshot

Myles Scolnickd4cdc069728f
diff --git a/packages/openapi/api.yaml b/packages/openapi/api.yaml
index a9a07e4538..4201490617 100644
--- a/packages/openapi/api.yaml
+++ b/packages/openapi/api.yaml
@@ -86,35 +86,15 @@ components:
title: AiCompletionRequest
type: object
AiConfig:
- description: 'Configuration options for AI.
-
-
- **Keys.**
-
-
- - `rules`: custom rules to include in all AI completion prompts
-
- - `max_tokens`: the maximum number of tokens to use in AI completions
-
- - `mode`: the mode to use for AI completions. Can be one of: `"ask"` or `"manual"`
-
- - `models`: the models to use for AI completions
-
- - `open_ai`: the OpenAI config
-
- - `anthropic`: the Anthropic config
-
- - `google`: the Google AI config
-
- - `bedrock`: the Bedrock config
-
- - `azure`: the Azure config
-
- - `ollama`: the Ollama config
-
- - `github`: the GitHub config
-
- - `open_ai_compatible`: the OpenAI-compatible config'
+ description: "Configuration options for AI.\n\n **Keys.**\n\n - `rules`:\
+ \ custom rules to include in all AI completion prompts\n - `max_tokens`:\
+ \ the maximum number of tokens to use in AI completions\n - `mode`: the\
+ \ mode to use for AI completions. Can be one of: `\"ask\"` or `\"manual\"\
+ `\n - `models`: the models to use for AI completions\n - `open_ai`:\
+ \ the OpenAI config\n - `anthropic`: the Anthropic config\n - `google`:\
+ \ the Google AI config\n - `bedrock`: the Bedrock config\n - `azure`:\
+ \ the Azure config\n - `ollama`: the Ollama config\n - `github`: the\
+ \ GitHub config\n - `open_ai_compatible`: the OpenAI-compatible config"
properties:
anthropic:
$ref: '#/components/schemas/AnthropicConfig'
@@ -163,22 +143,12 @@ components:
title: AiInlineCompletionRequest
type: object
AiModelConfig:
- description: 'Configuration options for an AI model.
-
-
- **Keys.**
-
-
- - `chat_model`: the model to use for chat completions
-
- - `edit_model`: the model to use for edit completions
-
- - `autocomplete_model`: the model to use for code completion/autocomplete
-
- - `displayed_models`: a list of models to display in the UI
-
- - `custom_models`: a list of custom models to use that are not from the default
- list'
+ description: "Configuration options for an AI model.\n\n **Keys.**\n\n \
+ \ - `chat_model`: the model to use for chat completions\n - `edit_model`:\
+ \ the model to use for edit completions\n - `autocomplete_model`: the model\
+ \ to use for code completion/autocomplete\n - `displayed_models`: a list\
+ \ of models to display in the UI\n - `custom_models`: a list of custom\
+ \ models to use that are not from the default list"
properties:
autocomplete_model:
type: string
@@ -221,13 +191,8 @@ components:
title: Alert
type: object
AnthropicConfig:
- description: 'Configuration options for Anthropic.
-
-
- **Keys.**
-
-
- - `api_key`: the Anthropic API key'
+ description: "Configuration options for Anthropic.\n\n **Keys.**\n\n -\
+ \ `api_key`: the Anthropic API key"
properties:
api_key:
type: string
@@ -283,19 +248,10 @@ components:
title: BasedpyrightServerConfig
type: object
BedrockConfig:
- description: 'Configuration options for Bedrock.
-
-
- **Keys.**
-
-
- - `profile_name`: the AWS profile to use
-
- - `region_name`: the AWS region to use
-
- - `aws_access_key_id`: the AWS access key ID
-
- - `aws_secret_access_key`: the AWS secret access key'
+ description: "Configuration options for Bedrock.\n\n **Keys.**\n\n - `profile_name`:\
+ \ the AWS profile to use\n - `region_name`: the AWS region to use\n \
+ \ - `aws_access_key_id`: the AWS access key ID\n - `aws_secret_access_key`:\
+ \ the AWS secret access key"
properties:
aws_access_key_id:
type: string
@@ -339,14 +295,14 @@ components:
title: CellConfig
type: object
CellOp:
- description: "Op to transition a cell.\n\nA CellOp's data has some optional\
- \ fields:\n\noutput - a CellOutput\nconsole - a CellOutput (console\
- \ msg to append), or a list of\n CellOutputs\nstatus \
- \ - execution status\nstale_inputs - whether the cell has stale inputs (variables,\
- \ modules, ...)\nrun_id - the run associated with this cell.\nserialization\
- \ - the serialization status of the cell\n\nOmitting a field means that its\
- \ value should be unchanged!\n\nAnd one required field:\n\ncell_id - the cell\
- \ id"
+ description: "Op to transition a cell.\n\n A CellOp's data has some optional\
+ \ fields:\n\n output - a CellOutput\n console - a CellOutput\
+ \ (console msg to append), or a list of\n CellOutputs\n\
+ \ status - execution status\n stale_inputs - whether the cell\
+ \ has stale inputs (variables, modules, ...)\n run_id - the run\
+ \ associated with this cell.\n serialization - the serialization status\
+ \ of the cell\n\n Omitting a field means that its value should be unchanged!\n\
+ \n And one required field:\n\n cell_id - the cell id"
properties:
cell_id:
type: string
@@ -643,24 +599,12 @@ components:
title: CompletedRun
type: object
CompletionConfig:
- description: 'Configuration for code completion.
-
-
- A dict with key/value pairs configuring code completion in the marimo
-
- editor.
-
-
- **Keys.**
-
-
- - `activate_on_typing`: if `False`, completion won''t activate
-
- until the completion hotkey is entered
-
- - `copilot`: one of `"github"`, `"codeium"`, or `"custom"`
-
- - `codeium_api_key`: the Codeium API key'
+ description: "Configuration for code completion.\n\n A dict with key/value\
+ \ pairs configuring code completion in the marimo\n editor.\n\n **Keys.**\n\
+ \n - `activate_on_typing`: if `False`, completion won't activate\n until\
+ \ the completion hotkey is entered\n - `copilot`: one of `\"github\"`,\
+ \ `\"codeium\"`, or `\"custom\"`\n - `codeium_api_key`: the Codeium API\
+ \ key"
properties:
activate_on_typing:
type: boolean
@@ -1033,18 +977,11 @@ components:
title: Datasets
type: object
DatasourcesConfig:
- description: 'Configuration for datasources panel.
-
-
- **Keys.**
-
-
- - `auto_discover_schemas`: if `True`, include schemas in the datasource
-
- - `auto_discover_tables`: if `True`, include tables in the datasource
-
- - `auto_discover_columns`: if `True`, include columns & table metadata in
- the datasource'
+ description: "Configuration for datasources panel.\n\n **Keys.**\n\n -\
+ \ `auto_discover_schemas`: if `True`, include schemas in the datasource\n\
+ \ - `auto_discover_tables`: if `True`, include tables in the datasource\n\
+ \ - `auto_discover_columns`: if `True`, include columns & table metadata\
+ \ in the datasource"
properties:
auto_discover_columns:
anyOf:
@@ -1116,13 +1053,8 @@ components:
title: DependencyTreeResponse
type: object
DiagnosticsConfig:
- description: 'Configuration options for diagnostics.
-
-
- **Keys.**
-
-
- - `enabled`: if `True`, diagnostics will be shown in the editor'
+ description: "Configuration options for diagnostics.\n\n **Keys.**\n\n \
+ \ - `enabled`: if `True`, diagnostics will be shown in the editor"
properties:
enabled:
type: boolean
@@ -1130,31 +1062,16 @@ components:
title: DiagnosticsConfig
type: object
DisplayConfig:
- description: 'Configuration for display.
-
-
- **Keys.**
-
-
- - `theme`: `"light"`, `"dark"`, or `"system"`
-
- - `code_editor_font_size`: font size for the code editor
-
- - `cell_output`: `"above"` or `"below"`
-
- - `dataframes`: `"rich"` or `"plain"`
-
- - `custom_css`: list of paths to custom CSS files
-
- - `default_table_page_size`: default number of rows to display in tables
-
- - `default_table_max_columns`: default maximum number of columns to display
- in tables
-
- - `reference_highlighting`: if `True`, highlight reactive variable references
-
- - `locale`: locale for date formatting and internationalization (e.g., "en-US",
- "en-GB", "de-DE")'
+ description: "Configuration for display.\n\n **Keys.**\n\n - `theme`:\
+ \ `\"light\"`, `\"dark\"`, or `\"system\"`\n - `code_editor_font_size`:\
+ \ font size for the code editor\n - `cell_output`: `\"above\"` or `\"below\"\
+ `\n - `dataframes`: `\"rich\"` or `\"plain\"`\n - `custom_css`: list\
+ \ of paths to custom CSS files\n - `default_table_page_size`: default number\
+ \ of rows to display in tables\n - `default_table_max_columns`: default\
+ \ maximum number of columns to display in tables\n - `reference_highlighting`:\
+ \ if `True`, highlight reactive variable references\n - `locale`: locale\
+ \ for date formatting and internationalization (e.g., \"en-US\", \"en-GB\"\
+ , \"de-DE\")"
properties:
cell_output:
enum:
@@ -1592,13 +1509,8 @@ components:
title: FormatResponse
type: object
FormattingConfig:
- description: 'Configuration for code formatting.
-
-
- **Keys.**
-
-
- - `line_length`: max line length'
+ description: "Configuration for code formatting.\n\n **Keys.**\n\n - `line_length`:\
+ \ max line length"
properties:
line_length:
type: integer
@@ -1642,15 +1554,8 @@ components:
title: FunctionCallResult
type: object
GitHubConfig:
- description: 'Configuration options for GitHub.
-
-
- **Keys.**
-
-
- - `api_key`: the GitHub API token
-
- - `base_url`: the base URL for the API'
+ description: "Configuration options for GitHub.\n\n **Keys.**\n\n - `api_key`:\
+ \ the GitHub API token\n - `base_url`: the base URL for the API"
properties:
api_key:
type: string
@@ -1660,13 +1565,8 @@ components:
title: GitHubConfig
type: object
GoogleAiConfig:
- description: 'Configuration options for Google AI.
-
-
- **Keys.**
-
-
- - `api_key`: the Google AI API key'
+ description: "Configuration options for Google AI.\n\n **Keys.**\n\n -\
+ \ `api_key`: the Google AI API key"
properties:
api_key:
type: string
@@ -1930,19 +1830,11 @@ components:
title: KernelReady
type: object
KeymapConfig:
- description: 'Configuration for keymaps.
-
-
- **Keys.**
-
-
- - `preset`: one of `"default"` or `"vim"`
-
- - `overrides`: a dict of keymap actions to their keymap override
-
- - `vimrc`: path to a vimrc file to load keymaps from
-
- - `destructive_delete`: if `True`, allows deleting cells with content.'
+ description: "Configuration for keymaps.\n\n **Keys.**\n\n - `preset`:\
+ \ one of `\"default\"` or `\"vim\"`\n - `overrides`: a dict of keymap actions\
+ \ to their keymap override\n - `vimrc`: path to a vimrc file to load keymaps\
+ \ from\n - `destructive_delete`: if `True`, allows deleting cells with\
+ \ content."
properties:
destructive_delete:
type: boolean
@@ -2079,13 +1971,8 @@ components:
title: KnownUnions
type: object
LanguageServersConfig:
- description: 'Configuration options for language servers.
-
-
- **Keys.**
-
-
- - `pylsp`: the pylsp config'
+ description: "Configuration options for language servers.\n\n **Keys.**\n\
+ \n - `pylsp`: the pylsp config"
properties:
basedpyright:
$ref: '#/components/schemas/BasedpyrightServerConfig'
@@ -2413,27 +2300,15 @@ components:
title: MultipleDefinitionError
type: object
OpenAiConfig:
- description: 'Configuration options for OpenAI or OpenAI-compatible services.
-
-
- **Keys.**
-
-
- - `api_key`: the OpenAI API key
-
- - `base_url`: the base URL for the API
-
- - `ssl_verify` : Boolean argument for httpx passed to open ai client. httpx
- defaults to true, but some use cases to let users override to False in some
- testing scenarios
-
- - `ca_bundle_path`: custom ca bundle to be used for verifying SSL certificates.
- Used to create custom SSL context for httpx client
-
- - `client_pem` : custom path of a client .pem cert used for verifying identity
- of client server
-
- - `extra_headers`: extra headers to be passed to the OpenAI client'
+ description: "Configuration options for OpenAI or OpenAI-compatible services.\n\
+ \n **Keys.**\n\n - `api_key`: the OpenAI API key\n - `base_url`:\
+ \ the base URL for the API\n - `ssl_verify` : Boolean argument for httpx\
+ \ passed to open ai client. httpx defaults to true, but some use cases to\
+ \ let users override to False in some testing scenarios\n - `ca_bundle_path`:\
+ \ custom ca bundle to be used for verifying SSL certificates. Used to create\
+ \ custom SSL context for httpx client\n - `client_pem` : custom path of\
+ \ a client .pem cert used for verifying identity of client server\n - `extra_headers`:\
+ \ extra headers to be passed to the OpenAI client"
properties:
api_key:
type: string
@@ -2486,13 +2361,8 @@ components:
title: PackageDescription
type: object
PackageManagementConfig:
- description: 'Configuration options for package management.
-
-
- **Keys.**
-
-
- - `manager`: the package manager to use'
+ description: "Configuration options for package management.\n\n **Keys.**\n\
+ \n - `manager`: the package manager to use"
properties:
manager:
enum:
@@ -2793,35 +2663,37 @@ components:
title: RunningNotebooksResponse
type: object
RuntimeConfig:
- description: "Configuration for runtime.\n\n**Keys.**\n\n- `auto_instantiate`:\
- \ if `False`, cells won't automatically\n run on startup. This only applies\
- \ when editing a notebook,\n and not when running as an application.\n\
- \ The default is `True`.\n- `auto_reload`: if `lazy`, cells importing modified\
- \ modules will marked\n as stale; if `autorun`, affected cells will be automatically\
- \ run. similar\n to IPython's %autoreload extension but with more code intelligence.\n\
- - `reactive_tests`: if `True`, marimo will automatically run pytest on cells\
- \ containing only test functions and test classes.\n execution.\n- `on_cell_change`:\
- \ if `lazy`, cells will be marked stale when their\n ancestors run but won't\
- \ autorun; if `autorun`, cells will automatically\n run when their ancestors\
- \ run.\n- `execution_type`: if `relaxed`, marimo will not clone cell declarations;\n\
- \ if `strict` marimo will clone cell declarations by default, avoiding\n\
- \ hidden potential state build up.\n- `watcher_on_save`: how to handle file\
- \ changes when saving. `\"lazy\"` marks\n affected cells as stale, `\"\
- autorun\"` automatically runs affected cells.\n- `output_max_bytes`: the maximum\
- \ size in bytes of cell outputs; larger\n values may affect frontend performance\n\
- - `std_stream_max_bytes`: the maximum size in bytes of console outputs;\n\
- \ larger values may affect frontend performance\n- `pythonpath`: a list of\
- \ directories to add to the Python search path.\n Directories will be added\
- \ to the head of sys.path. Similar to the\n `PYTHONPATH` environment variable,\
- \ the directories will be included in\n where Python will look for imported\
- \ modules.\n- `dotenv`: a list of paths to `.env` files to load.\n If the\
- \ file does not exist, it will be silently ignored.\n The default is `[\"\
- .env\"]` if a pyproject.toml is found, otherwise `[]`.\n- `default_sql_output`:\
- \ the default output format for SQL queries. Can be one of:\n `\"auto\"\
- `, `\"native\"`, `\"polars\"`, `\"lazy-polars\"`, or `\"pandas\"`.\n The\
- \ default is `\"auto\"`.\n- `default_auto_download`: an Optional list of export\
- \ types to automatically snapshot your notebook as:\n `html`, `markdown`,\
- \ `ipynb`.\n The default is None."
+ description: "Configuration for runtime.\n\n **Keys.**\n\n - `auto_instantiate`:\
+ \ if `False`, cells won't automatically\n run on startup. This only\
+ \ applies when editing a notebook,\n and not when running as an application.\n\
+ \ The default is `True`.\n - `auto_reload`: if `lazy`, cells importing\
+ \ modified modules will marked\n as stale; if `autorun`, affected cells\
+ \ will be automatically run. similar\n to IPython's %autoreload extension\
+ \ but with more code intelligence.\n - `reactive_tests`: if `True`, marimo\
+ \ will automatically run pytest on cells containing only test functions and\
+ \ test classes.\n execution.\n - `on_cell_change`: if `lazy`, cells\
+ \ will be marked stale when their\n ancestors run but won't autorun;\
+ \ if `autorun`, cells will automatically\n run when their ancestors run.\n\
+ \ - `execution_type`: if `relaxed`, marimo will not clone cell declarations;\n\
+ \ if `strict` marimo will clone cell declarations by default, avoiding\n\
+ \ hidden potential state build up.\n - `watcher_on_save`: how to handle\
+ \ file changes when saving. `\"lazy\"` marks\n affected cells as stale,\
+ \ `\"autorun\"` automatically runs affected cells.\n - `output_max_bytes`:\
+ \ the maximum size in bytes of cell outputs; larger\n values may affect\
+ \ frontend performance\n - `std_stream_max_bytes`: the maximum size in\
+ \ bytes of console outputs;\n larger values may affect frontend performance\n\
+ \ - `pythonpath`: a list of directories to add to the Python search path.\n\
+ \ Directories will be added to the head of sys.path. Similar to the\n\
+ \ `PYTHONPATH` environment variable, the directories will be included\
+ \ in\n where Python will look for imported modules.\n - `dotenv`:\
+ \ a list of paths to `.env` files to load.\n If the file does not exist,\
+ \ it will be silently ignored.\n The default is `[\".env\"]` if a pyproject.toml\
+ \ is found, otherwise `[]`.\n - `default_sql_output`: the default output\
+ \ format for SQL queries. Can be one of:\n `\"auto\"`, `\"native\"\
+ `, `\"polars\"`, `\"lazy-polars\"`, or `\"pandas\"`.\n The default\
+ \ is `\"auto\"`.\n - `default_auto_download`: an Optional list of export\
+ \ types to automatically snapshot your notebook as:\n `html`, `markdown`,\
+ \ `ipynb`.\n The default is None."
properties:
auto_instantiate:
type: boolean
@@ -2932,17 +2804,10 @@ components:
title: SaveAppConfigurationRequest
type: object
SaveConfig:
- description: 'Configuration for saving.
-
-
- **Keys.**
-
-
- - `autosave`: one of `"off"` or `"after_delay"`
-
- - `delay`: number of milliseconds to wait before autosaving
-
- - `format_on_save`: if `True`, format the code on save'
+ description: "Configuration for saving.\n\n **Keys.**\n\n - `autosave`:\
+ \ one of `\"off\"` or `\"after_delay\"`\n - `delay`: number of milliseconds\
+ \ to wait before autosaving\n - `format_on_save`: if `True`, format the\
+ \ code on save"
properties:
autosave:
enum:
@@ -3109,10 +2974,10 @@ components:
title: SendUIElementMessage
type: object
ServerConfig:
- description: "Configuration for the server.\n\n**Keys.**\n\n- `browser`: the\
- \ web browser to use. `\"default\"` or a browser registered\n with Python's\
- \ webbrowser module (eg, `\"firefox\"` or `\"chrome\"`)\n- `follow_symlink`:\
- \ if true, the server will follow symlinks it finds\n inside its static\
+ description: "Configuration for the server.\n\n **Keys.**\n\n - `browser`:\
+ \ the web browser to use. `\"default\"` or a browser registered\n with\
+ \ Python's webbrowser module (eg, `\"firefox\"` or `\"chrome\"`)\n - `follow_symlink`:\
+ \ if true, the server will follow symlinks it finds\n inside its static\
\ assets directory."
properties:
browser:
@@ -3207,16 +3072,10 @@ components:
title: SetupRootError
type: object
SharingConfig:
- description: 'Configuration for sharing features.
-
-
- **Keys.**
-
-
- - `html`: if `False`, HTML sharing options will be hidden from the UI
-
- - `wasm`: if `False`, WebAssembly sharing options will be hidden from the
- UI'
+ description: "Configuration for sharing features.\n\n **Keys.**\n\n -\
+ \ `html`: if `False`, HTML sharing options will be hidden from the UI\n \
+ \ - `wasm`: if `False`, WebAssembly sharing options will be hidden from the\
+ \ UI"
properties:
html:
type: boolean
@@ -3275,13 +3134,8 @@ components:
title: Snippets
type: object
SnippetsConfig:
- description: 'Configuration for snippets.
-
-
- **Keys.**
-
-
- - `custom_path`: the path to the custom snippets directory'
+ description: "Configuration for snippets.\n\n **Keys.**\n\n - `custom_path`:\
+ \ the path to the custom snippets directory"
properties:
custom_paths:
items:
@@ -3568,12 +3422,8 @@ components:
title: WorkspaceFilesResponse
type: object
_AppConfig:
- description: 'Program-specific configuration.
-
-
- Configuration for frontends or runtimes that is specific to
-
- a single marimo program.'
+ description: "Program-specific configuration.\n\n Configuration for frontends\
+ \ or runtimes that is specific to\n a single marimo program."
properties:
app_title:
anyOf:
@@ -3623,7 +3473,7 @@ components:
type: object
info:
title: marimo API
- version: 0.16.1
+ version: 0.16.2
openapi: 3.1.0
paths:
/@file/{filename_and_length}:
diff --git a/packages/openapi/src/api.ts b/packages/openapi/src/api.ts
index 513872f3ac..9428c4c8b6 100644
--- a/packages/openapi/src/api.ts
+++ b/packages/openapi/src/api.ts
@@ -2673,20 +2673,20 @@ export interface components {
* AiConfig
* @description Configuration options for AI.
*
- * **Keys.**
+ * **Keys.**
*
- * - `rules`: custom rules to include in all AI completion prompts
- * - `max_tokens`: the maximum number of tokens to use in AI completions
- * - `mode`: the mode to use for AI completions. Can be one of: `"ask"` or `"manual"`
- * - `models`: the models to use for AI completions
- * - `open_ai`: the OpenAI config
- * - `anthropic`: the Anthropic config
- * - `google`: the Google AI config
- * - `bedrock`: the Bedrock config
- * - `azure`: the Azure config
- * - `ollama`: the Ollama config
- * - `github`: the GitHub config
- * - `open_ai_compatible`: the OpenAI-compatible config
+ * - `rules`: custom rules to include in all AI completion prompts
+ * - `max_tokens`: the maximum number of tokens to use in AI completions
+ * - `mode`: the mode to use for AI completions. Can be one of: `"ask"` or `"manual"`
+ * - `models`: the models to use for AI completions
+ * - `open_ai`: the OpenAI config
+ * - `anthropic`: the Anthropic config
+ * - `google`: the Google AI config
+ * - `bedrock`: the Bedrock config
+ * - `azure`: the Azure config
+ * - `ollama`: the Ollama config
+ * - `github`: the GitHub config
+ * - `open_ai_compatible`: the OpenAI-compatible config
*/
AiConfig: {
anthropic?: components["schemas"]["AnthropicConfig"];
@@ -2717,13 +2717,13 @@ export interface components {
* AiModelConfig
* @description Configuration options for an AI model.
*
- * **Keys.**
+ * **Keys.**
*
- * - `chat_model`: the model to use for chat completions
- * - `edit_model`: the model to use for edit completions
- * - `autocomplete_model`: the model to use for code completion/autocomplete
- * - `displayed_models`: a list of models to display in the UI
- * - `custom_models`: a list of custom models to use that are not from the default list
+ * - `chat_model`: the model to use for chat completions
+ * - `edit_model`: the model to use for edit completions
+ * - `autocomplete_model`: the model to use for code completion/autocomplete
+ * - `displayed_models`: a list of models to display in the UI
+ * - `custom_models`: a list of custom models to use that are not from the default list
*/
AiModelConfig: {
autocomplete_model?: string;
@@ -2745,9 +2745,9 @@ export interface components {
* AnthropicConfig
* @description Configuration options for Anthropic.
*
- * **Keys.**
+ * **Keys.**
*
- * - `api_key`: the Anthropic API key
+ * - `api_key`: the Anthropic API key
*/
AnthropicConfig: {
api_key?: string;
@@ -2781,12 +2781,12 @@ export interface components {
* BedrockConfig
* @description Configuration options for Bedrock.
*
- * **Keys.**
+ * **Keys.**
*
- * - `profile_name`: the AWS profile to use
- * - `region_name`: the AWS region to use
- * - `aws_access_key_id`: the AWS access key ID
- * - `aws_secret_access_key`: the AWS secret access key
+ * - `profile_name`: the AWS profile to use
+ * - `region_name`: the AWS region to use
+ * - `aws_access_key_id`: the AWS access key ID
+ * - `aws_secret_access_key`: the AWS secret access key
*/
BedrockConfig: {
aws_access_key_id?: string;
@@ -2824,21 +2824,21 @@ export interface components {
* CellOp
* @description Op to transition a cell.
*
- * A CellOp's data has some optional fields:
+ * A CellOp's data has some optional fields:
*
- * output - a CellOutput
- * console - a CellOutput (console msg to append), or a list of
- * CellOutputs
- * status - execution status
- * stale_inputs - whether the cell has stale inputs (variables, modules, ...)
- * run_id - the run associated with this cell.
- * serialization - the serialization status of the cell
+ * output - a CellOutput
+ * console - a CellOutput (console msg to append), or a list of
+ * CellOutputs
+ * status - execution status
+ * stale_inputs - whether the cell has stale inputs (variables, modules, ...)
+ * run_id - the run associated with this cell.
+ * serialization - the serialization status of the cell
*
- * Omitting a field means that its value should be unchanged!
+ * Omitting a field means that its value should be unchanged!
*
- * And one required field:
+ * And one required field:
*
- * cell_id - the cell id
+ * cell_id - the cell id
*/
CellOp: {
cell_id: string;
@@ -2990,15 +2990,15 @@ export interface components {
* CompletionConfig
* @description Configuration for code completion.
*
- * A dict with key/value pairs configuring code completion in the marimo
- * editor.
+ * A dict with key/value pairs configuring code completion in the marimo
+ * editor.
*
- * **Keys.**
+ * **Keys.**
*
- * - `activate_on_typing`: if `False`, completion won't activate
- * until the completion hotkey is entered
- * - `copilot`: one of `"github"`, `"codeium"`, or `"custom"`
- * - `codeium_api_key`: the Codeium API key
+ * - `activate_on_typing`: if `False`, completion won't activate
+ * until the completion hotkey is entered
+ * - `copilot`: one of `"github"`, `"codeium"`, or `"custom"`
+ * - `codeium_api_key`: the Codeium API key
*/
CompletionConfig: {
activate_on_typing: boolean;
@@ -3191,11 +3191,11 @@ export interface components {
* DatasourcesConfig
* @description Configuration for datasources panel.
*
- * **Keys.**
+ * **Keys.**
*
- * - `auto_discover_schemas`: if `True`, include schemas in the datasource
- * - `auto_discover_tables`: if `True`, include tables in the datasource
- * - `auto_discover_columns`: if `True`, include columns & table metadata in the datasource
+ * - `auto_discover_schemas`: if `True`, include schemas in the datasource
+ * - `auto_discover_tables`: if `True`, include tables in the datasource
+ * - `auto_discover_columns`: if `True`, include columns & table metadata in the datasource
*/
DatasourcesConfig: {
auto_discover_columns?: boolean | "auto";
@@ -3227,9 +3227,9 @@ export interface components {
* DiagnosticsConfig
* @description Configuration options for diagnostics.
*
- * **Keys.**
+ * **Keys.**
*
- * - `enabled`: if `True`, diagnostics will be shown in the editor
+ * - `enabled`: if `True`, diagnostics will be shown in the editor
*/
DiagnosticsConfig: {
enabled?: boolean;
@@ -3238,17 +3238,17 @@ export interface components {
* DisplayConfig
* @description Configuration for display.
*
- * **Keys.**
+ * **Keys.**
*
- * - `theme`: `"light"`, `"dark"`, or `"system"`
- * - `code_editor_font_size`: font size for the code editor
- * - `cell_output`: `"above"` or `"below"`
- * - `dataframes`: `"rich"` or `"plain"`
- * - `custom_css`: list of paths to custom CSS files
- * - `default_table_page_size`: default number of rows to display in tables
- * - `default_table_max_columns`: default maximum number of columns to display in tables
- * - `reference_highlighting`: if `True`, highlight reactive variable references
- * - `locale`: locale for date formatting and internationalization (e.g., "en-US", "en-GB", "de-DE")
+ * - `theme`: `"light"`, `"dark"`, or `"system"`
+ * - `code_editor_font_size`: font size for the code editor
+ * - `cell_output`: `"above"` or `"below"`
+ * - `dataframes`: `"rich"` or `"plain"`
+ * - `custom_css`: list of paths to custom CSS files
+ * - `default_table_page_size`: default number of rows to display in tables
+ * - `default_table_max_columns`: default maximum number of columns to display in tables
+ * - `reference_highlighting`: if `True`, highlight reactive variable references
+ * - `locale`: locale for date formatting and internationalization (e.g., "en-US", "en-GB", "de-DE")
*/
DisplayConfig: {
/** @enum {unknown} */
@@ -3447,9 +3447,9 @@ export interface components {
* FormattingConfig
* @description Configuration for code formatting.
*
- * **Keys.**
+ * **Keys.**
*
- * - `line_length`: max line length
+ * - `line_length`: max line length
*/
FormattingConfig: {
line_length: number;
@@ -3476,10 +3476,10 @@ export interface components {
* GitHubConfig
* @description Configuration options for GitHub.
*
- * **Keys.**
+ * **Keys.**
*
- * - `api_key`: the GitHub API token
- * - `base_url`: the base URL for the API
+ * - `api_key`: the GitHub API token
+ * - `base_url`: the base URL for the API
*/
GitHubConfig: {
api_key?: string;
@@ -3489,9 +3489,9 @@ export interface components {
* GoogleAiConfig
* @description Configuration options for Google AI.
*
- * **Keys.**
+ * **Keys.**
*
- * - `api_key`: the Google AI API key
+ * - `api_key`: the Google AI API key
*/
GoogleAiConfig: {
api_key?: string;
@@ -3626,12 +3626,12 @@ export interface components {
* KeymapConfig
* @description Configuration for keymaps.
*
- * **Keys.**
+ * **Keys.**
*
- * - `preset`: one of `"default"` or `"vim"`
- * - `overrides`: a dict of keymap actions to their keymap override
- * - `vimrc`: path to a vimrc file to load keymaps from
- * - `destructive_delete`: if `True`, allows deleting cells with content.
+ * - `preset`: one of `"default"` or `"vim"`
+ * - `overrides`: a dict of keymap actions to their keymap override
+ * - `vimrc`: path to a vimrc file to load keymaps from
+ * - `destructive_delete`: if `True`, allows deleting cells with content.
*/
KeymapConfig: {
destructive_delete?: boolean;
@@ -3705,9 +3705,9 @@ export interface components {
* LanguageServersConfig
* @description Configuration options for language servers.
*
- * **Keys.**
+ * **Keys.**
*
- * - `pylsp`: the pylsp config
+ * - `pylsp`: the pylsp config
*/
LanguageServersConfig: {
basedpyright?: components["schemas"]["BasedpyrightServerConfig"];
@@ -3863,14 +3863,14 @@ export interface components {
* OpenAiConfig
* @description Configuration options for OpenAI or OpenAI-compatible services.
*
- * **Keys.**
+ * **Keys.**
*
- * - `api_key`: the OpenAI API key
- * - `base_url`: the base URL for the API
- * - `ssl_verify` : Boolean argument for httpx passed to open ai client. httpx defaults to true, but some use cases to let users override to False in some testing scenarios
- * - `ca_bundle_path`: custom ca bundle to be used for verifying SSL certificates. Used to create custom SSL context for httpx client
- * - `client_pem` : custom path of a client .pem cert used for verifying identity of client server
- * - `extra_headers`: extra headers to be passed to the OpenAI client
+ * - `api_key`: the OpenAI API key
+ * - `base_url`: the base URL for the API
+ * - `ssl_verify` : Boolean argument for httpx passed to open ai client. httpx defaults to true, but some use cases to let users override to False in some testing scenarios
+ * - `ca_bundle_path`: custom ca bundle to be used for verifying SSL certificates. Used to create custom SSL context for httpx client
+ * - `client_pem` : custom path of a client .pem cert used for verifying identity of client server
+ * - `extra_headers`: extra headers to be passed to the OpenAI client
*/
OpenAiConfig: {
api_key?: string;
@@ -3908,9 +3908,9 @@ export interface components {
* PackageManagementConfig
* @description Configuration options for package management.
*
- * **Keys.**
+ * **Keys.**
*
- * - `manager`: the package manager to use
+ * - `manager`: the package manager to use
*/
PackageManagementConfig: {
/** @enum {unknown} */
@@ -4064,42 +4064,42 @@ export interface components {
* RuntimeConfig
* @description Configuration for runtime.
*
- * **Keys.**
+ * **Keys.**
*
- * - `auto_instantiate`: if `False`, cells won't automatically
- * run on startup. This only applies when editing a notebook,
- * and not when running as an application.
- * The default is `True`.
- * - `auto_reload`: if `lazy`, cells importing modified modules will marked
- * as stale; if `autorun`, affected cells will be automatically run. similar
- * to IPython's %autoreload extension but with more code intelligence.
- * - `reactive_tests`: if `True`, marimo will automatically run pytest on cells containing only test functions and test classes.
- * execution.
- * - `on_cell_change`: if `lazy`, cells will be marked stale when their
- * ancestors run but won't autorun; if `autorun`, cells will automatically
- * run when their ancestors run.
- * - `execution_type`: if `relaxed`, marimo will not clone cell declarations;
- * if `strict` marimo will clone cell declarations by default, avoiding
- * hidden potential state build up.
- * - `watcher_on_save`: how to handle file changes when saving. `"lazy"` marks
- * affected cells as stale, `"autorun"` automatically runs affected cells.
- * - `output_max_bytes`: the maximum size in bytes of cell outputs; larger
- * values may affect frontend performance
- * - `std_stream_max_bytes`: the maximum size in bytes of console outputs;
- * larger values may affect frontend performance
- * - `pythonpath`: a list of directories to add to the Python search path.
- * Directories will be added to the head of sys.path. Similar to the
- * `PYTHONPATH` environment variable, the directories will be included in
- * where Python will look for imported modules.
- * - `dotenv`: a list of paths to `.env` files to load.
- * If the file does not exist, it will be silently ignored.
- * The default is `[".env"]` if a pyproject.toml is found, otherwise `[]`.
- * - `default_sql_output`: the default output format for SQL queries. Can be one of:
- * `"auto"`, `"native"`, `"polars"`, `"lazy-polars"`, or `"pandas"`.
- * The default is `"auto"`.
- * - `default_auto_download`: an Optional list of export types to automatically snapshot your notebook as:
- * `html`, `markdown`, `ipynb`.
- * The default is None.
+ * - `auto_instantiate`: if `False`, cells won't automatically
+ * run on startup. This only applies when editing a notebook,
+ * and not when running as an application.
+ * The default is `True`.
+ * - `auto_reload`: if `lazy`, cells importing modified modules will marked
+ * as stale; if `autorun`, affected cells will be automatically run. similar
+ * to IPython's %autoreload extension but with more code intelligence.
+ * - `reactive_tests`: if `True`, marimo will automatically run pytest on cells containing only test functions and test classes.
+ * execution.
+ * - `on_cell_change`: if `lazy`, cells will be marked stale when their
+ * ancestors run but won't autorun; if `autorun`, cells will automatically
+ * run when their ancestors run.
+ * - `execution_type`: if `relaxed`, marimo will not clone cell declarations;
+ * if `strict` marimo will clone cell declarations by default, avoiding
+ * hidden potential state build up.
+ * - `watcher_on_save`: how to handle file changes when saving. `"lazy"` marks
+ * affected cells as stale, `"autorun"` automatically runs affected cells.
+ * - `output_max_bytes`: the maximum size in bytes of cell outputs; larger
+ * values may affect frontend performance
+ * - `std_stream_max_bytes`: the maximum size in bytes of console outputs;
+ * larger values may affect frontend performance
+ * - `pythonpath`: a list of directories to add to the Python search path.
+ * Directories will be added to the head of sys.path. Similar to the
+ * `PYTHONPATH` environment variable, the directories will be included in
+ * where Python will look for imported modules.
+ * - `dotenv`: a list of paths to `.env` files to load.
+ * If the file does not exist, it will be silently ignored.
+ * The default is `[".env"]` if a pyproject.toml is found, otherwise `[]`.
+ * - `default_sql_output`: the default output format for SQL queries. Can be one of:
+ * `"auto"`, `"native"`, `"polars"`, `"lazy-polars"`, or `"pandas"`.
+ * The default is `"auto"`.
+ * - `default_auto_download`: an Optional list of export types to automatically snapshot your notebook as:
+ * `html`, `markdown`, `ipynb`.
+ * The default is None.
*/
RuntimeConfig: {
auto_instantiate: boolean;
@@ -4156,11 +4156,11 @@ export interface components {
* SaveConfig
* @description Configuration for saving.
*
- * **Keys.**
+ * **Keys.**
*
- * - `autosave`: one of `"off"` or `"after_delay"`
- * - `delay`: number of milliseconds to wait before autosaving
- * - `format_on_save`: if `True`, format the code on save
+ * - `autosave`: one of `"off"` or `"after_delay"`
+ * - `delay`: number of milliseconds to wait before autosaving
+ * - `format_on_save`: if `True`, format the code on save
*/
SaveConfig: {
/** @enum {unknown} */
@@ -4234,12 +4234,12 @@ export interface components {
* ServerConfig
* @description Configuration for the server.
*
- * **Keys.**
+ * **Keys.**
*
- * - `browser`: the web browser to use. `"default"` or a browser registered
- * with Python's webbrowser module (eg, `"firefox"` or `"chrome"`)
- * - `follow_symlink`: if true, the server will follow symlinks it finds
- * inside its static assets directory.
+ * - `browser`: the web browser to use. `"default"` or a browser registered
+ * with Python's webbrowser module (eg, `"firefox"` or `"chrome"`)
+ * - `follow_symlink`: if true, the server will follow symlinks it finds
+ * inside its static assets directory.
*/
ServerConfig: {
browser: "default" | string;
@@ -4280,10 +4280,10 @@ export interface components {
* SharingConfig
* @description Configuration for sharing features.
*
- * **Keys.**
+ * **Keys.**
*
- * - `html`: if `False`, HTML sharing options will be hidden from the UI
- * - `wasm`: if `False`, WebAssembly sharing options will be hidden from the UI
+ * - `html`: if `False`, HTML sharing options will be hidden from the UI
+ * - `wasm`: if `False`, WebAssembly sharing options will be hidden from the UI
*/
SharingConfig: {
html?: boolean;
@@ -4314,9 +4314,9 @@ export interface components {
* SnippetsConfig
* @description Configuration for snippets.
*
- * **Keys.**
+ * **Keys.**
*
- * - `custom_path`: the path to the custom snippets directory
+ * - `custom_path`: the path to the custom snippets directory
*/
SnippetsConfig: {
custom_paths?: string[];
@@ -4462,8 +4462,8 @@ export interface components {
* _AppConfig
* @description Program-specific configuration.
*
- * Configuration for frontends or runtimes that is specific to
- * a single marimo program.
+ * Configuration for frontends or runtimes that is specific to
+ * a single marimo program.
*/
_AppConfig: {
/** @default null */