forked from marimo-team/marimo
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi.yaml
More file actions
6235 lines (6206 loc) · 173 KB
/
api.yaml
File metadata and controls
6235 lines (6206 loc) · 173 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
components:
schemas:
AddPackageRequest:
description: 'This can be a remove package or a local package.
Supported formats:
httpx
httpx==0.27.0
httpx>=0.27.0
git+https://github.com/encode/httpx
https://files.pythonhosted.org/packages/5c/2d/3da5bdf4408b8b2800061c339f240c1802f2e82d55e50bd39c5a881f47f0/httpx-0.27.0.tar.gz
/example/foo-0.1.0-py3-none-any.whl'
properties:
group:
anyOf:
- type: string
- type: 'null'
default: null
package:
type: string
upgrade:
anyOf:
- type: boolean
- type: 'null'
default: false
required:
- package
title: AddPackageRequest
type: object
AiCompletionContext:
properties:
plainText:
default: ''
type: string
schema:
default: []
items:
$ref: '#/components/schemas/SchemaTable'
type: array
variables:
default: []
items:
anyOf:
- type: string
- $ref: '#/components/schemas/VariableContext'
type: array
required: []
title: AiCompletionContext
type: object
AiCompletionRequest:
description: 'UIMessages are expected to be AI SDK messages.
See pydantic_ai.ui.vercel_ai.request_types.UIMessage or Vercel AI SDK documentation.'
properties:
code:
type: string
context:
anyOf:
- type: 'null'
- $ref: '#/components/schemas/AiCompletionContext'
default: null
includeOtherCode:
type: string
language:
default: python
enum:
- markdown
- python
- sql
prompt:
type: string
selectedText:
anyOf:
- type: string
- type: 'null'
default: null
uiMessages:
default: []
items:
type: object
type: array
required:
- prompt
- includeOtherCode
- code
title: AiCompletionRequest
type: object
AiConfig:
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 - `inline_tooltip`: if `True`, enable inline AI tooltip suggestions\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 - `openrouter`: the OpenRouter config\n - `wandb`:\
\ the Weights & Biases config\n - `custom_providers`: a dict of custom\
\ OpenAI-compatible providers\n - `open_ai_compatible`: the OpenAI-compatible\
\ config (deprecated, use custom_providers)"
properties:
anthropic:
$ref: '#/components/schemas/AnthropicConfig'
azure:
$ref: '#/components/schemas/OpenAiConfig'
bedrock:
$ref: '#/components/schemas/BedrockConfig'
custom_providers:
additionalProperties:
$ref: '#/components/schemas/OpenAiConfig'
type: object
github:
$ref: '#/components/schemas/GitHubConfig'
google:
$ref: '#/components/schemas/GoogleAiConfig'
inline_tooltip:
type: boolean
max_tokens:
type: integer
mode:
enum:
- agent
- ask
- manual
models:
$ref: '#/components/schemas/AiModelConfig'
ollama:
$ref: '#/components/schemas/OpenAiConfig'
open_ai:
$ref: '#/components/schemas/OpenAiConfig'
open_ai_compatible:
$ref: '#/components/schemas/OpenAiConfig'
openrouter:
$ref: '#/components/schemas/OpenAiConfig'
rules:
type: string
wandb:
$ref: '#/components/schemas/OpenAiConfig'
required: []
title: AiConfig
type: object
AiInlineCompletionRequest:
properties:
language:
default: python
enum:
- markdown
- python
- sql
prefix:
type: string
suffix:
type: string
required:
- prefix
- suffix
title: AiInlineCompletionRequest
type: object
AiModelConfig:
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
chat_model:
type: string
custom_models:
items:
type: string
type: array
displayed_models:
items:
type: string
type: array
edit_model:
type: string
required:
- custom_models
- displayed_models
title: AiModelConfig
type: object
AlertNotification:
description: "User-facing alert message.\n\n Attributes:\n title:\
\ Alert title.\n description: Alert body (may contain HTML).\n \
\ variant: Visual variant (e.g., \"danger\")."
properties:
description:
type: string
op:
enum:
- alert
title:
type: string
variant:
anyOf:
- enum:
- danger
- type: 'null'
default: null
required:
- op
- title
- description
title: AlertNotification
type: object
AnthropicConfig:
description: "Configuration options for Anthropic.\n\n **Keys.**\n\n -\
\ `api_key`: the Anthropic API key"
properties:
api_key:
type: string
required: []
title: AnthropicConfig
type: object
BannerNotification:
description: "Persistent banner message at top of notebook.\n\n Attributes:\n\
\ title: Banner title.\n description: Banner body (may contain\
\ HTML).\n variant: Visual variant (e.g., \"danger\").\n action:\
\ Optional user action (e.g., \"restart\")."
properties:
action:
anyOf:
- enum:
- restart
- type: 'null'
default: null
description:
type: string
op:
enum:
- banner
title:
type: string
variant:
anyOf:
- enum:
- danger
- type: 'null'
default: null
required:
- op
- title
- description
title: BannerNotification
type: object
BaseResponse:
properties:
success:
type: boolean
required:
- success
title: BaseResponse
type: object
BasedpyrightServerConfig:
description: 'Configuration options for basedpyright Language Server.
basedpyright handles completion, hover, go-to-definition, and diagnostics,
but we only use it for diagnostics.'
properties:
enabled:
type: boolean
required: []
title: BasedpyrightServerConfig
type: object
BedrockConfig:
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
aws_secret_access_key:
type: string
profile_name:
type: string
region_name:
type: string
required: []
title: BedrockConfig
type: object
CacheClearedNotification:
description: "Execution cache cleared result.\n\n Attributes:\n bytes_freed:\
\ Bytes freed by clearing cache."
properties:
bytes_freed:
type: integer
op:
enum:
- cache-cleared
required:
- op
- bytes_freed
title: CacheClearedNotification
type: object
CacheInfoNotification:
description: "Execution cache statistics.\n\n Attributes:\n hits:\
\ Cache hits.\n misses: Cache misses.\n time: Time spent on\
\ cache operations (seconds).\n disk_to_free: Disk space that could\
\ be freed (bytes).\n disk_total: Total disk space used (bytes)."
properties:
disk_to_free:
type: integer
disk_total:
type: integer
hits:
type: integer
misses:
type: integer
op:
enum:
- cache-info
time:
type: number
required:
- op
- hits
- misses
- time
- disk_to_free
- disk_total
title: CacheInfoNotification
type: object
CellChannel:
description: The channel of a cell's output.
enum:
- marimo-error
- media
- output
- pdb
- stderr
- stdin
- stdout
title: CellChannel
CellConfig:
description: 'Internal representation of a cell''s configuration.
This is not part of the public API.'
properties:
column:
anyOf:
- type: integer
- type: 'null'
default: null
disabled:
default: false
type: boolean
hide_code:
default: false
type: boolean
required: []
title: CellConfig
type: object
CellNotification:
description: "Updates a cell's state in the frontend.\n\n Only fields that\
\ are set (not None) will update the cell state.\n Omitting a field leaves\
\ that aspect unchanged.\n\n Attributes:\n cell_id: Unique identifier\
\ of the cell being updated.\n output: Cell's output. Use CellOutput.empty()\
\ to clear.\n console: Console messages. Single/list appends, [] clears,\
\ None unchanged.\n status: Execution status (idle/running/stale/queued/disabled-transitively).\n\
\ stale_inputs: Whether cell has stale inputs from changed dependencies.\n\
\ run_id: Execution run ID for tracing. Auto-set from context.\n \
\ serialization: Serialization status (TopLevelHints).\n timestamp:\
\ Creation timestamp, auto-set."
properties:
cell_id:
type: string
console:
anyOf:
- items:
$ref: '#/components/schemas/CellOutput'
type: array
- type: 'null'
- $ref: '#/components/schemas/CellOutput'
default: null
op:
enum:
- cell-op
output:
anyOf:
- type: 'null'
- $ref: '#/components/schemas/CellOutput'
default: null
run_id:
anyOf:
- type: string
- type: 'null'
default: null
serialization:
anyOf:
- type: string
- type: 'null'
default: null
stale_inputs:
anyOf:
- type: boolean
- type: 'null'
default: null
status:
anyOf:
- enum:
- disabled-transitively
- idle
- queued
- running
- type: 'null'
default: null
timestamp:
type: number
required:
- op
- cell_id
title: CellNotification
type: object
CellOutput:
properties:
channel:
$ref: '#/components/schemas/CellChannel'
data:
anyOf:
- type: string
- items:
anyOf:
- $ref: '#/components/schemas/SetupRootError'
- $ref: '#/components/schemas/CycleError'
- $ref: '#/components/schemas/MultipleDefinitionError'
- $ref: '#/components/schemas/ImportStarError'
- $ref: '#/components/schemas/MarimoAncestorStoppedError'
- $ref: '#/components/schemas/MarimoAncestorPreventedError'
- $ref: '#/components/schemas/MarimoExceptionRaisedError'
- $ref: '#/components/schemas/MarimoStrictExecutionError'
- $ref: '#/components/schemas/MarimoInterruptionError'
- $ref: '#/components/schemas/MarimoSyntaxError'
- $ref: '#/components/schemas/MarimoInternalError'
- $ref: '#/components/schemas/MarimoSQLError'
- $ref: '#/components/schemas/UnknownError'
discriminator:
mapping:
ancestor-prevented: '#/components/schemas/MarimoAncestorPreventedError'
ancestor-stopped: '#/components/schemas/MarimoAncestorStoppedError'
cycle: '#/components/schemas/CycleError'
exception: '#/components/schemas/MarimoExceptionRaisedError'
import-star: '#/components/schemas/ImportStarError'
internal: '#/components/schemas/MarimoInternalError'
interruption: '#/components/schemas/MarimoInterruptionError'
multiple-defs: '#/components/schemas/MultipleDefinitionError'
setup-refs: '#/components/schemas/SetupRootError'
sql-error: '#/components/schemas/MarimoSQLError'
strict-exception: '#/components/schemas/MarimoStrictExecutionError'
syntax: '#/components/schemas/MarimoSyntaxError'
unknown: '#/components/schemas/UnknownError'
propertyName: type
type: array
- type: object
mimetype:
enum:
- application/json
- application/vnd.jupyter.widget-view+json
- application/vnd.marimo+error
- application/vnd.marimo+mimebundle
- application/vnd.marimo+traceback
- application/vnd.vega.v5+json
- application/vnd.vega.v6+json
- application/vnd.vegalite.v5+json
- application/vnd.vegalite.v6+json
- image/avif
- image/bmp
- image/gif
- image/jpeg
- image/png
- image/svg+xml
- image/tiff
- text/csv
- text/html
- text/latex
- text/markdown
- text/plain
- video/mp4
- video/mpeg
timestamp:
type: number
required:
- channel
- mimetype
- data
title: CellOutput
type: object
ChatAttachment:
properties:
content_type:
anyOf:
- type: string
- type: 'null'
default: null
name:
default: attachment
type: string
url:
type: string
required:
- url
title: ChatAttachment
type: object
ChatMessage:
description: A message in a chat.
properties:
attachments:
anyOf:
- items:
$ref: '#/components/schemas/ChatAttachment'
type: array
- type: 'null'
default: null
content: {}
id:
default: ''
type: string
metadata:
anyOf:
- {}
- type: 'null'
default: null
parts:
default: []
items:
type: object
type: array
role:
enum:
- assistant
- system
- user
required:
- role
- content
title: ChatMessage
type: object
ChatRequest:
description: 'UIMessages are expected to be AI SDK messages.
See pydantic_ai.ui.vercel_ai.request_types.UIMessage or Vercel AI SDK documentation.'
properties:
context:
$ref: '#/components/schemas/AiCompletionContext'
includeOtherCode:
type: string
model:
anyOf:
- type: string
- type: 'null'
default: null
tools:
anyOf:
- items:
$ref: '#/components/schemas/ToolDefinition'
type: array
- type: 'null'
default: null
uiMessages:
items:
type: object
type: array
variables:
anyOf:
- items:
anyOf:
- type: string
- $ref: '#/components/schemas/VariableContext'
type: array
- type: 'null'
default: null
required:
- context
- includeOtherCode
- uiMessages
title: ChatRequest
type: object
ClearCacheCommand:
description: "Clear all cached data.\n\n Clears all cache contexts, freeing\
\ memory and disk space.\n Affects all cells using the @cache decorator."
properties:
type:
enum:
- clear-cache
required:
- type
title: ClearCacheCommand
type: object
ClearCacheRequest:
properties: {}
required: []
title: ClearCacheRequest
type: object
CodeCompletionCommand:
description: "Request code completion suggestions.\n\n Sent when the user\
\ requests autocomplete. Provides code context up to\n the cursor position\
\ for the language server.\n\n Attributes:\n id: Unique identifier\
\ for this request.\n document: Source code up to the cursor position.\n\
\ cell_id: Cell where completion is requested."
properties:
cellId:
type: string
document:
type: string
id:
type: string
type:
enum:
- code-completion
required:
- type
- id
- document
- cellId
title: CodeCompletionCommand
type: object
CodeCompletionRequest:
properties:
cellId:
type: string
document:
type: string
id:
type: string
required:
- id
- document
- cellId
title: CodeCompletionRequest
type: object
ColumnStats:
description: Represents stats for a column in a data table.
properties:
'false':
anyOf:
- type: integer
- type: 'null'
default: null
max:
anyOf:
- {}
- type: 'null'
default: null
mean:
anyOf:
- {}
- type: 'null'
default: null
median:
anyOf:
- {}
- type: 'null'
default: null
min:
anyOf:
- {}
- type: 'null'
default: null
nulls:
anyOf:
- type: integer
- type: 'null'
default: null
p25:
anyOf:
- {}
- type: 'null'
default: null
p5:
anyOf:
- {}
- type: 'null'
default: null
p75:
anyOf:
- {}
- type: 'null'
default: null
p95:
anyOf:
- {}
- type: 'null'
default: null
std:
anyOf:
- {}
- type: 'null'
default: null
total:
anyOf:
- type: integer
- type: 'null'
default: null
'true':
anyOf:
- type: integer
- type: 'null'
default: null
unique:
anyOf:
- type: integer
- type: 'null'
default: null
required: []
title: ColumnStats
type: object
CompletedRunNotification:
description: Run of submitted cells and descendants completed.
properties:
op:
enum:
- completed-run
required:
- op
title: CompletedRunNotification
type: object
CompletionConfig:
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 - `signature_hint_on_typing`: if `False`,\
\ signature hint won't be shown when typing\n - `copilot`: one of `\"github\"\
`, `\"codeium\"`, or `\"custom\"`\n - `codeium_api_key`: the Codeium API\
\ key"
properties:
activate_on_typing:
type: boolean
api_key:
anyOf:
- type: string
- type: 'null'
base_url:
anyOf:
- type: string
- type: 'null'
codeium_api_key:
anyOf:
- type: string
- type: 'null'
copilot:
anyOf:
- type: boolean
- enum:
- codeium
- custom
- github
model:
anyOf:
- type: string
- type: 'null'
signature_hint_on_typing:
type: boolean
required:
- activate_on_typing
- copilot
- signature_hint_on_typing
title: CompletionConfig
type: object
CompletionOption:
properties:
completion_info:
anyOf:
- type: string
- type: 'null'
name:
type: string
type:
type: string
required:
- name
- type
- completion_info
title: CompletionOption
type: object
CompletionResultNotification:
description: "Code completion result from language server.\n\n Attributes:\n\
\ completion_id: Request ID this responds to.\n prefix_length:\
\ Length of prefix to replace.\n options: Completion options to display."
properties:
completion_id:
type: string
op:
enum:
- completion-result
options:
items:
$ref: '#/components/schemas/CompletionOption'
type: array
prefix_length:
type: integer
required:
- op
- completion_id
- prefix_length
- options
title: CompletionResultNotification
type: object
CopyNotebookRequest:
properties:
destination:
type: string
source:
type: string
required:
- source
- destination
title: CopyNotebookRequest
type: object
CreateNotebookCommand:
description: "Instantiate and initialize a notebook.\n\n Sent when a notebook\
\ is first loaded. Contains all cells and initial UI element values.\n\n \
\ Attributes:\n execution_requests: ExecuteCellCommand for each notebook\
\ cell.\n cell_ids: Initial cell IDs in the notebook.\n set_ui_element_value_request:\
\ Initial UI element values.\n auto_run: Whether to automatically execute\
\ cells on instantiation.\n request: HTTP request context if available."
properties:
autoRun:
type: boolean
cellIds:
items:
type: string
type: array
executionRequests:
items:
$ref: '#/components/schemas/ExecuteCellCommand'
type: array
request:
anyOf:
- $ref: '#/components/schemas/HTTPRequest'
- type: 'null'
default: null
setUiElementValueRequest:
$ref: '#/components/schemas/UpdateUIElementCommand'
type:
enum:
- create-notebook
required:
- type
- executionRequests
- cellIds
- setUiElementValueRequest
- autoRun
title: CreateNotebookCommand
type: object
CreateSecretRequest:
properties:
key:
type: string
name:
type: string
provider:
enum:
- dotenv
- env
value:
type: string
required:
- key
- value
- provider
- name
title: CreateSecretRequest
type: object
CycleError:
properties:
edges_with_vars:
items:
items: false
maxItems: 3
minItems: 3
prefixItems:
- type: string
- items:
type: string
type: array
- type: string
type: array
type: array
type:
enum:
- cycle
required:
- type
- edges_with_vars
title: CycleError
type: object
DataColumnPreviewNotification:
description: "Data column preview with stats and visualization.\n\n Inherits\
\ all ColumnPreview attributes.\n\n Attributes:\n table_name: Table\
\ containing the column.\n column_name: Column being previewed."
properties:
chart_code:
anyOf:
- type: string
- type: 'null'
default: null
chart_spec:
anyOf:
- type: string
- type: 'null'
default: null
column_name:
type: string
error:
anyOf:
- type: string
- type: 'null'
default: null
missing_packages:
anyOf:
- items:
type: string
type: array
- type: 'null'
default: null
op:
enum:
- data-column-preview
stats:
anyOf:
- type: 'null'
- $ref: '#/components/schemas/ColumnStats'
default: null
table_name:
type: string
required:
- op
- table_name
- column_name
title: DataColumnPreviewNotification
type: object
DataSourceConnection:
description: "Represents a data source connection.\n\nAttributes:\n source\
\ (str): The source of the data source connection. E.g 'postgres'.\n dialect\
\ (str): The dialect of the data source connection. E.g 'postgresql'.\n \
\ name (str): The name of the data source connection. E.g 'engine'.\n \
\ display_name (str): The display name of the data source connection. E.g\
\ 'PostgresQL (engine)'.\n databases (List[Database]): The databases in\
\ the data source connection.\n default_database (Optional[str]): The default\
\ database in the data source connection.\n default_schema (Optional[str]):\
\ The default schema in the data source connection."
properties:
databases:
items:
$ref: '#/components/schemas/Database'
type: array
default_database:
anyOf:
- type: string
- type: 'null'
default: null
default_schema:
anyOf:
- type: string
- type: 'null'
default: null
dialect:
type: string
display_name:
type: string
name:
type: string
source:
type: string
required:
- source
- dialect
- name
- display_name
- databases
title: DataSourceConnection
type: object
DataSourceConnectionsNotification:
description: "Available data source connections for SQL cells.\n\n Attributes:\n\
\ connections: Available data source connections."
properties:
connections:
items:
$ref: '#/components/schemas/DataSourceConnection'
type: array
op:
enum:
- data-source-connections
required:
- op