@malloy-publisher/app 0.0.195 → 0.0.196
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api-doc.yaml +213 -214
- package/dist/assets/EnvironmentPage-1j6QDWAy.js +1 -0
- package/dist/assets/HomePage-DMop21VG.js +1 -0
- package/dist/assets/MainPage-BbE8ETz1.js +2 -0
- package/dist/assets/ModelPage-D2jvfe3t.js +1 -0
- package/dist/assets/PackagePage-BbnhGoD3.js +1 -0
- package/dist/assets/{RouteError-DefbDO7F.js → RouteError-D3LGEZ3i.js} +1 -1
- package/dist/assets/WorkbookPage-DttVIj4u.js +1 -0
- package/dist/assets/{core-BrfQApxh.es-DnvCX4oH.js → core-w79IMXAG.es-Bd0UlzOL.js} +1 -1
- package/dist/assets/{index-Bu0ub036.js → index-5K9YjIxF.js} +117 -117
- package/dist/assets/{index-CkzK3JIl.js → index-C513UodQ.js} +1 -1
- package/dist/assets/{index-CoA6HIGS.js → index-DIgzgp69.js} +1 -1
- package/dist/assets/{index.umd-B6Ms2PpL.js → index.umd-BMeMPq_9.js} +1 -1
- package/dist/index.html +1 -1
- package/package.json +6 -3
- package/dist/assets/HomePage-DbZS0N7G.js +0 -1
- package/dist/assets/MainPage-CBuWkbmr.js +0 -2
- package/dist/assets/ModelPage-Bt37smot.js +0 -1
- package/dist/assets/PackagePage-DLZe50WG.js +0 -1
- package/dist/assets/ProjectPage-FQTEPXP4.js +0 -1
- package/dist/assets/WorkbookPage-CkAo16ar.js +0 -1
package/dist/api-doc.yaml
CHANGED
|
@@ -8,7 +8,7 @@ info:
|
|
|
8
8
|
|
|
9
9
|
## Key Features
|
|
10
10
|
|
|
11
|
-
- **
|
|
11
|
+
- **Environment Management**: Create and manage environments with their associated packages and connections
|
|
12
12
|
- **Package Lifecycle**: Full CRUD operations for Malloy packages and their versions
|
|
13
13
|
- **Model & Notebook Access**: Retrieve and execute Malloy models and notebooks
|
|
14
14
|
- **Connection Management**: Secure database connection configuration and testing
|
|
@@ -19,7 +19,7 @@ info:
|
|
|
19
19
|
|
|
20
20
|
The API follows a hierarchical resource structure:
|
|
21
21
|
```
|
|
22
|
-
|
|
22
|
+
Environments
|
|
23
23
|
├── Connections
|
|
24
24
|
└── Packages
|
|
25
25
|
├── Models
|
|
@@ -37,9 +37,9 @@ servers:
|
|
|
37
37
|
tags:
|
|
38
38
|
- name: publisher
|
|
39
39
|
description: Publisher status and health check operations
|
|
40
|
-
- name:
|
|
41
|
-
description:
|
|
42
|
-
deletion of data modeling
|
|
40
|
+
- name: environments
|
|
41
|
+
description: Environment lifecycle management including creation, configuration,
|
|
42
|
+
and deletion of data modeling environments
|
|
43
43
|
- name: connections
|
|
44
44
|
description: Database connection management for secure data source configuration
|
|
45
45
|
and access
|
|
@@ -68,7 +68,7 @@ paths:
|
|
|
68
68
|
summary: Get server status and health information
|
|
69
69
|
description: |
|
|
70
70
|
Returns the current status of the Malloy Publisher server, including initialization state,
|
|
71
|
-
available
|
|
71
|
+
available environments, and server timestamp. This endpoint is useful for health checks and
|
|
72
72
|
monitoring server availability.
|
|
73
73
|
responses:
|
|
74
74
|
"200":
|
|
@@ -79,26 +79,25 @@ paths:
|
|
|
79
79
|
$ref: "#/components/schemas/ServerStatus"
|
|
80
80
|
"503":
|
|
81
81
|
$ref: "#/components/responses/ServiceUnavailable"
|
|
82
|
-
|
|
83
|
-
/projects:
|
|
82
|
+
/environments:
|
|
84
83
|
get:
|
|
85
84
|
tags:
|
|
86
|
-
-
|
|
87
|
-
operationId: list-
|
|
88
|
-
summary: List all available
|
|
85
|
+
- environments
|
|
86
|
+
operationId: list-environments
|
|
87
|
+
summary: List all available environments
|
|
89
88
|
description: |
|
|
90
|
-
Retrieves a list of all
|
|
91
|
-
Each
|
|
92
|
-
This endpoint is typically used to discover available
|
|
89
|
+
Retrieves a list of all environments currently hosted on this Malloy Publisher server.
|
|
90
|
+
Each environment contains metadata about its packages, connections, and configuration.
|
|
91
|
+
This endpoint is typically used to discover available environments and their basic information.
|
|
93
92
|
responses:
|
|
94
93
|
"200":
|
|
95
|
-
description: A list of all available
|
|
94
|
+
description: A list of all available environments
|
|
96
95
|
content:
|
|
97
96
|
application/json:
|
|
98
97
|
schema:
|
|
99
98
|
type: array
|
|
100
99
|
items:
|
|
101
|
-
$ref: "#/components/schemas/
|
|
100
|
+
$ref: "#/components/schemas/Environment"
|
|
102
101
|
"401":
|
|
103
102
|
$ref: "#/components/responses/Unauthorized"
|
|
104
103
|
"500":
|
|
@@ -107,26 +106,26 @@ paths:
|
|
|
107
106
|
$ref: "#/components/responses/ServiceUnavailable"
|
|
108
107
|
post:
|
|
109
108
|
tags:
|
|
110
|
-
-
|
|
111
|
-
operationId: create-
|
|
112
|
-
summary: Create a new
|
|
109
|
+
- environments
|
|
110
|
+
operationId: create-environment
|
|
111
|
+
summary: Create a new environment
|
|
113
112
|
description: |
|
|
114
|
-
Creates a new Malloy
|
|
115
|
-
container for packages, connections, and other resources. The
|
|
113
|
+
Creates a new Malloy environment with the specified configuration. An environment serves as a
|
|
114
|
+
container for packages, connections, and other resources. The environment will be initialized
|
|
116
115
|
with the provided metadata and can immediately accept packages and connections.
|
|
117
116
|
requestBody:
|
|
118
117
|
required: true
|
|
119
118
|
content:
|
|
120
119
|
application/json:
|
|
121
120
|
schema:
|
|
122
|
-
$ref: "#/components/schemas/
|
|
121
|
+
$ref: "#/components/schemas/Environment"
|
|
123
122
|
responses:
|
|
124
123
|
"200":
|
|
125
|
-
description: Returns the
|
|
124
|
+
description: Returns the environment created
|
|
126
125
|
content:
|
|
127
126
|
application/json:
|
|
128
127
|
schema:
|
|
129
|
-
$ref: "#/components/schemas/
|
|
128
|
+
$ref: "#/components/schemas/Environment"
|
|
130
129
|
"401":
|
|
131
130
|
$ref: "#/components/responses/Unauthorized"
|
|
132
131
|
"500":
|
|
@@ -134,36 +133,36 @@ paths:
|
|
|
134
133
|
"503":
|
|
135
134
|
$ref: "#/components/responses/ServiceUnavailable"
|
|
136
135
|
|
|
137
|
-
/
|
|
136
|
+
/environments/{environmentName}:
|
|
138
137
|
get:
|
|
139
138
|
tags:
|
|
140
|
-
-
|
|
141
|
-
operationId: get-
|
|
142
|
-
summary: Get
|
|
139
|
+
- environments
|
|
140
|
+
operationId: get-environment
|
|
141
|
+
summary: Get environment details and metadata
|
|
143
142
|
description: |
|
|
144
|
-
Retrieves detailed information about a specific
|
|
143
|
+
Retrieves detailed information about a specific environment, including its packages,
|
|
145
144
|
connections, configuration, and metadata. The reload parameter can be used to
|
|
146
|
-
refresh the
|
|
145
|
+
refresh the environment state from disk before returning the information.
|
|
147
146
|
parameters:
|
|
148
|
-
- name:
|
|
147
|
+
- name: environmentName
|
|
149
148
|
in: path
|
|
150
|
-
description: Name of the
|
|
149
|
+
description: Name of the environment
|
|
151
150
|
required: true
|
|
152
151
|
schema:
|
|
153
152
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
154
153
|
- name: reload
|
|
155
154
|
in: query
|
|
156
|
-
description: Load / reload the
|
|
155
|
+
description: Load / reload the environment before returning result
|
|
157
156
|
required: false
|
|
158
157
|
schema:
|
|
159
158
|
type: boolean
|
|
160
159
|
responses:
|
|
161
160
|
"200":
|
|
162
|
-
description:
|
|
161
|
+
description: Environment details and metadata
|
|
163
162
|
content:
|
|
164
163
|
application/json:
|
|
165
164
|
schema:
|
|
166
|
-
$ref: "#/components/schemas/
|
|
165
|
+
$ref: "#/components/schemas/Environment"
|
|
167
166
|
"401":
|
|
168
167
|
$ref: "#/components/responses/Unauthorized"
|
|
169
168
|
"404":
|
|
@@ -174,17 +173,17 @@ paths:
|
|
|
174
173
|
$ref: "#/components/responses/ServiceUnavailable"
|
|
175
174
|
patch:
|
|
176
175
|
tags:
|
|
177
|
-
-
|
|
178
|
-
operationId: update-
|
|
179
|
-
summary: Update
|
|
176
|
+
- environments
|
|
177
|
+
operationId: update-environment
|
|
178
|
+
summary: Update environment configuration
|
|
180
179
|
description: |
|
|
181
|
-
Updates the configuration and metadata of an existing
|
|
182
|
-
modify
|
|
183
|
-
|
|
180
|
+
Updates the configuration and metadata of an existing environment. This allows you to
|
|
181
|
+
modify environment settings, update the README, change the location, or update other
|
|
182
|
+
environment-level properties. The environment must exist and be accessible.
|
|
184
183
|
parameters:
|
|
185
|
-
- name:
|
|
184
|
+
- name: environmentName
|
|
186
185
|
in: path
|
|
187
|
-
description: Name of the
|
|
186
|
+
description: Name of the environment
|
|
188
187
|
required: true
|
|
189
188
|
schema:
|
|
190
189
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -193,14 +192,14 @@ paths:
|
|
|
193
192
|
content:
|
|
194
193
|
application/json:
|
|
195
194
|
schema:
|
|
196
|
-
$ref: "#/components/schemas/
|
|
195
|
+
$ref: "#/components/schemas/Environment"
|
|
197
196
|
responses:
|
|
198
197
|
"200":
|
|
199
|
-
description: Returns the
|
|
198
|
+
description: Returns the environment updated
|
|
200
199
|
content:
|
|
201
200
|
application/json:
|
|
202
201
|
schema:
|
|
203
|
-
$ref: "#/components/schemas/
|
|
202
|
+
$ref: "#/components/schemas/Environment"
|
|
204
203
|
"401":
|
|
205
204
|
$ref: "#/components/responses/Unauthorized"
|
|
206
205
|
"500":
|
|
@@ -209,27 +208,27 @@ paths:
|
|
|
209
208
|
$ref: "#/components/responses/ServiceUnavailable"
|
|
210
209
|
delete:
|
|
211
210
|
tags:
|
|
212
|
-
-
|
|
213
|
-
operationId: delete-
|
|
214
|
-
summary: Delete
|
|
211
|
+
- environments
|
|
212
|
+
operationId: delete-environment
|
|
213
|
+
summary: Delete an environment
|
|
215
214
|
description: |
|
|
216
|
-
Permanently deletes
|
|
215
|
+
Permanently deletes an environment and all its associated resources including packages,
|
|
217
216
|
connections, and metadata. This operation cannot be undone, so use with caution.
|
|
218
|
-
The
|
|
217
|
+
The environment must exist and be accessible for deletion.
|
|
219
218
|
parameters:
|
|
220
|
-
- name:
|
|
219
|
+
- name: environmentName
|
|
221
220
|
in: path
|
|
222
|
-
description: Name of the
|
|
221
|
+
description: Name of the environment
|
|
223
222
|
required: true
|
|
224
223
|
schema:
|
|
225
224
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
226
225
|
responses:
|
|
227
226
|
"200":
|
|
228
|
-
description: Returns the
|
|
227
|
+
description: Returns the environment deleted
|
|
229
228
|
content:
|
|
230
229
|
application/json:
|
|
231
230
|
schema:
|
|
232
|
-
$ref: "#/components/schemas/
|
|
231
|
+
$ref: "#/components/schemas/Environment"
|
|
233
232
|
"401":
|
|
234
233
|
$ref: "#/components/responses/Unauthorized"
|
|
235
234
|
"404":
|
|
@@ -239,26 +238,26 @@ paths:
|
|
|
239
238
|
"503":
|
|
240
239
|
$ref: "#/components/responses/ServiceUnavailable"
|
|
241
240
|
|
|
242
|
-
/
|
|
241
|
+
/environments/{environmentName}/connections:
|
|
243
242
|
get:
|
|
244
243
|
tags:
|
|
245
244
|
- connections
|
|
246
245
|
operationId: list-connections
|
|
247
|
-
summary: List
|
|
246
|
+
summary: List environment database connections
|
|
248
247
|
description: |
|
|
249
|
-
Retrieves a list of all database connections configured for the specified
|
|
248
|
+
Retrieves a list of all database connections configured for the specified environment.
|
|
250
249
|
Each connection includes its configuration, type, and status information. This endpoint
|
|
251
|
-
is useful for discovering available data sources within
|
|
250
|
+
is useful for discovering available data sources within an environment.
|
|
252
251
|
parameters:
|
|
253
|
-
- name:
|
|
252
|
+
- name: environmentName
|
|
254
253
|
in: path
|
|
255
|
-
description: Name of the
|
|
254
|
+
description: Name of the environment
|
|
256
255
|
required: true
|
|
257
256
|
schema:
|
|
258
257
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
259
258
|
responses:
|
|
260
259
|
"200":
|
|
261
|
-
description: A list of database connections in the
|
|
260
|
+
description: A list of database connections in the environment
|
|
262
261
|
content:
|
|
263
262
|
application/json:
|
|
264
263
|
schema:
|
|
@@ -272,20 +271,20 @@ paths:
|
|
|
272
271
|
"503":
|
|
273
272
|
$ref: "#/components/responses/ServiceUnavailable"
|
|
274
273
|
|
|
275
|
-
/
|
|
274
|
+
/environments/{environmentName}/connections/{connectionName}:
|
|
276
275
|
get:
|
|
277
276
|
tags:
|
|
278
277
|
- connections
|
|
279
278
|
operationId: get-connection
|
|
280
279
|
summary: Get connection details
|
|
281
280
|
description: |
|
|
282
|
-
Retrieves detailed information about a specific database connection within
|
|
281
|
+
Retrieves detailed information about a specific database connection within an environment.
|
|
283
282
|
This includes connection configuration, credentials (if accessible), and metadata.
|
|
284
283
|
Useful for inspecting connection settings and troubleshooting connectivity issues.
|
|
285
284
|
parameters:
|
|
286
|
-
- name:
|
|
285
|
+
- name: environmentName
|
|
287
286
|
in: path
|
|
288
|
-
description: Name of the
|
|
287
|
+
description: Name of the environment
|
|
289
288
|
required: true
|
|
290
289
|
schema:
|
|
291
290
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -316,11 +315,11 @@ paths:
|
|
|
316
315
|
operationId: create-connection
|
|
317
316
|
summary: Create a new database connection
|
|
318
317
|
description: |
|
|
319
|
-
Creates a new database connection in the specified
|
|
318
|
+
Creates a new database connection in the specified environment.
|
|
320
319
|
parameters:
|
|
321
|
-
- name:
|
|
320
|
+
- name: environmentName
|
|
322
321
|
in: path
|
|
323
|
-
description: Name of the
|
|
322
|
+
description: Name of the environment
|
|
324
323
|
required: true
|
|
325
324
|
schema:
|
|
326
325
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -373,9 +372,9 @@ paths:
|
|
|
373
372
|
description: |
|
|
374
373
|
Updates the configuration of an existing database connection.
|
|
375
374
|
parameters:
|
|
376
|
-
- name:
|
|
375
|
+
- name: environmentName
|
|
377
376
|
in: path
|
|
378
|
-
description: Name of the
|
|
377
|
+
description: Name of the environment
|
|
379
378
|
required: true
|
|
380
379
|
schema:
|
|
381
380
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -436,11 +435,11 @@ paths:
|
|
|
436
435
|
operationId: delete-connection
|
|
437
436
|
summary: Delete a database connection
|
|
438
437
|
description: |
|
|
439
|
-
Permanently deletes a database connection from the
|
|
438
|
+
Permanently deletes a database connection from the environment.
|
|
440
439
|
parameters:
|
|
441
|
-
- name:
|
|
440
|
+
- name: environmentName
|
|
442
441
|
in: path
|
|
443
|
-
description: Name of the
|
|
442
|
+
description: Name of the environment
|
|
444
443
|
required: true
|
|
445
444
|
schema:
|
|
446
445
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -469,7 +468,7 @@ paths:
|
|
|
469
468
|
"503":
|
|
470
469
|
$ref: "#/components/responses/ServiceUnavailable"
|
|
471
470
|
|
|
472
|
-
/
|
|
471
|
+
/environments/{environmentName}/connections/{connectionName}/schemas:
|
|
473
472
|
get:
|
|
474
473
|
tags:
|
|
475
474
|
- connections
|
|
@@ -480,9 +479,9 @@ paths:
|
|
|
480
479
|
Each schema includes metadata such as name, description, and whether it's the default schema.
|
|
481
480
|
This endpoint is useful for exploring the database structure and discovering available data sources.
|
|
482
481
|
parameters:
|
|
483
|
-
- name:
|
|
482
|
+
- name: environmentName
|
|
484
483
|
in: path
|
|
485
|
-
description: Name of the
|
|
484
|
+
description: Name of the environment
|
|
486
485
|
required: true
|
|
487
486
|
schema:
|
|
488
487
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -510,7 +509,7 @@ paths:
|
|
|
510
509
|
"503":
|
|
511
510
|
$ref: "#/components/responses/ServiceUnavailable"
|
|
512
511
|
|
|
513
|
-
/
|
|
512
|
+
/environments/{environmentName}/connections/{connectionName}/schemas/{schemaName}/tables:
|
|
514
513
|
get:
|
|
515
514
|
tags:
|
|
516
515
|
- connections
|
|
@@ -521,9 +520,9 @@ paths:
|
|
|
521
520
|
This endpoint is useful for discovering available data sources and exploring the database
|
|
522
521
|
structure. The schema must exist in the connection for this operation to succeed.
|
|
523
522
|
parameters:
|
|
524
|
-
- name:
|
|
523
|
+
- name: environmentName
|
|
525
524
|
in: path
|
|
526
|
-
description: Name of the
|
|
525
|
+
description: Name of the environment
|
|
527
526
|
required: true
|
|
528
527
|
schema:
|
|
529
528
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -567,7 +566,7 @@ paths:
|
|
|
567
566
|
"503":
|
|
568
567
|
$ref: "#/components/responses/ServiceUnavailable"
|
|
569
568
|
|
|
570
|
-
/
|
|
569
|
+
/environments/{environmentName}/connections/{connectionName}/schemas/{schemaName}/tables/{tablePath}:
|
|
571
570
|
get:
|
|
572
571
|
tags:
|
|
573
572
|
- connections
|
|
@@ -579,9 +578,9 @@ paths:
|
|
|
579
578
|
structure. The schema must exist in the connection for this operation to succeed.
|
|
580
579
|
The tablePath is the full path to the table, including the schema name.
|
|
581
580
|
parameters:
|
|
582
|
-
- name:
|
|
581
|
+
- name: environmentName
|
|
583
582
|
in: path
|
|
584
|
-
description: Name of the
|
|
583
|
+
description: Name of the environment
|
|
585
584
|
required: true
|
|
586
585
|
schema:
|
|
587
586
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -620,7 +619,7 @@ paths:
|
|
|
620
619
|
$ref: "#/components/responses/ServiceUnavailable"
|
|
621
620
|
|
|
622
621
|
# TODO: Remove this endpoint.
|
|
623
|
-
/
|
|
622
|
+
/environments/{environmentName}/connections/{connectionName}/sqlSource:
|
|
624
623
|
get:
|
|
625
624
|
tags:
|
|
626
625
|
- connections
|
|
@@ -634,9 +633,9 @@ paths:
|
|
|
634
633
|
Creates a Malloy source from a SQL statement using the specified connection.
|
|
635
634
|
The SQL statement is executed to generate a source definition that can be used in Malloy models.
|
|
636
635
|
parameters:
|
|
637
|
-
- name:
|
|
636
|
+
- name: environmentName
|
|
638
637
|
in: path
|
|
639
|
-
description: Name of the
|
|
638
|
+
description: Name of the environment
|
|
640
639
|
required: true
|
|
641
640
|
schema:
|
|
642
641
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -677,9 +676,9 @@ paths:
|
|
|
677
676
|
Creates a Malloy source from a SQL statement using the specified database connection.
|
|
678
677
|
The SQL statement is executed to generate a source definition that can be used in Malloy models.
|
|
679
678
|
parameters:
|
|
680
|
-
- name:
|
|
679
|
+
- name: environmentName
|
|
681
680
|
in: path
|
|
682
|
-
description: Name of the
|
|
681
|
+
description: Name of the environment
|
|
683
682
|
required: true
|
|
684
683
|
schema:
|
|
685
684
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -715,7 +714,7 @@ paths:
|
|
|
715
714
|
"503":
|
|
716
715
|
$ref: "#/components/responses/ServiceUnavailable"
|
|
717
716
|
|
|
718
|
-
/
|
|
717
|
+
/environments/{environmentName}/connections/{connectionName}/sqlQuery:
|
|
719
718
|
post:
|
|
720
719
|
tags:
|
|
721
720
|
- connections
|
|
@@ -725,9 +724,9 @@ paths:
|
|
|
725
724
|
Executes a SQL statement against the specified database connection and returns the results.
|
|
726
725
|
The results include data, metadata, and execution information.
|
|
727
726
|
parameters:
|
|
728
|
-
- name:
|
|
727
|
+
- name: environmentName
|
|
729
728
|
in: path
|
|
730
|
-
description: Name of the
|
|
729
|
+
description: Name of the environment
|
|
731
730
|
required: true
|
|
732
731
|
schema:
|
|
733
732
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -773,7 +772,7 @@ paths:
|
|
|
773
772
|
"503":
|
|
774
773
|
$ref: "#/components/responses/ServiceUnavailable"
|
|
775
774
|
|
|
776
|
-
/
|
|
775
|
+
/environments/{environmentName}/connections/{connectionName}/sqlTemporaryTable:
|
|
777
776
|
post:
|
|
778
777
|
tags:
|
|
779
778
|
- connections
|
|
@@ -783,9 +782,9 @@ paths:
|
|
|
783
782
|
Creates a temporary table from a SQL statement using the specified database connection.
|
|
784
783
|
Temporary tables are useful for storing intermediate results during complex queries and data processing workflows.
|
|
785
784
|
parameters:
|
|
786
|
-
- name:
|
|
785
|
+
- name: environmentName
|
|
787
786
|
in: path
|
|
788
|
-
description: Name of the
|
|
787
|
+
description: Name of the environment
|
|
789
788
|
required: true
|
|
790
789
|
schema:
|
|
791
790
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -822,7 +821,7 @@ paths:
|
|
|
822
821
|
$ref: "#/components/responses/ServiceUnavailable"
|
|
823
822
|
|
|
824
823
|
# TODO: Remove this endpoint.
|
|
825
|
-
/
|
|
824
|
+
/environments/{environmentName}/connections/{connectionName}/temporaryTable:
|
|
826
825
|
get:
|
|
827
826
|
tags:
|
|
828
827
|
- connections
|
|
@@ -836,9 +835,9 @@ paths:
|
|
|
836
835
|
Creates a temporary table from a SQL statement using the specified connection.
|
|
837
836
|
Temporary tables are useful for storing intermediate results during complex queries.
|
|
838
837
|
parameters:
|
|
839
|
-
- name:
|
|
838
|
+
- name: environmentName
|
|
840
839
|
in: path
|
|
841
|
-
description: Name of the
|
|
840
|
+
description: Name of the environment
|
|
842
841
|
required: true
|
|
843
842
|
schema:
|
|
844
843
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -871,7 +870,7 @@ paths:
|
|
|
871
870
|
$ref: "#/components/responses/ServiceUnavailable"
|
|
872
871
|
|
|
873
872
|
# TODO: Remove this endpoint.
|
|
874
|
-
/
|
|
873
|
+
/environments/{environmentName}/connections/{connectionName}/queryData:
|
|
875
874
|
get:
|
|
876
875
|
tags:
|
|
877
876
|
- connections
|
|
@@ -885,9 +884,9 @@ paths:
|
|
|
885
884
|
Executes a SQL statement against the specified database connection and returns the results.
|
|
886
885
|
The query results include data, metadata, and execution information.
|
|
887
886
|
parameters:
|
|
888
|
-
- name:
|
|
887
|
+
- name: environmentName
|
|
889
888
|
in: path
|
|
890
|
-
description: Name of the
|
|
889
|
+
description: Name of the environment
|
|
891
890
|
required: true
|
|
892
891
|
schema:
|
|
893
892
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -930,12 +929,12 @@ paths:
|
|
|
930
929
|
# `:memory:` DuckDB rooted at the package's path), so any data-plane
|
|
931
930
|
# call against `connectionName="duckdb"` needs a package context.
|
|
932
931
|
# Non-`duckdb` names resolve through the package's MalloyConfig
|
|
933
|
-
# wrapper, which delegates to the
|
|
934
|
-
# the same routes also work for
|
|
932
|
+
# wrapper, which delegates to the environment's connection registry, so
|
|
933
|
+
# the same routes also work for environment-level connections looked up
|
|
935
934
|
# in a package context.
|
|
936
935
|
# ──────────────────────────────────────────────────────────────────
|
|
937
936
|
|
|
938
|
-
/
|
|
937
|
+
/environments/{environmentName}/packages/{packageName}/connections/{connectionName}/schemas:
|
|
939
938
|
get:
|
|
940
939
|
tags:
|
|
941
940
|
- connections
|
|
@@ -945,11 +944,11 @@ paths:
|
|
|
945
944
|
Retrieves a list of all schemas (databases) available in the specified
|
|
946
945
|
connection, resolved in the context of the named package. Required for
|
|
947
946
|
`connectionName="duckdb"`, which is per-package; works for any other
|
|
948
|
-
connection name as well (resolution falls through to the
|
|
947
|
+
connection name as well (resolution falls through to the environment).
|
|
949
948
|
parameters:
|
|
950
|
-
- name:
|
|
949
|
+
- name: environmentName
|
|
951
950
|
in: path
|
|
952
|
-
description: Name of the
|
|
951
|
+
description: Name of the environment
|
|
953
952
|
required: true
|
|
954
953
|
schema:
|
|
955
954
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -983,7 +982,7 @@ paths:
|
|
|
983
982
|
"503":
|
|
984
983
|
$ref: "#/components/responses/ServiceUnavailable"
|
|
985
984
|
|
|
986
|
-
/
|
|
985
|
+
/environments/{environmentName}/packages/{packageName}/connections/{connectionName}/schemas/{schemaName}/tables:
|
|
987
986
|
get:
|
|
988
987
|
tags:
|
|
989
988
|
- connections
|
|
@@ -993,9 +992,9 @@ paths:
|
|
|
993
992
|
Retrieves a list of all tables and views available in the specified
|
|
994
993
|
database schema, resolved in the context of the named package.
|
|
995
994
|
parameters:
|
|
996
|
-
- name:
|
|
995
|
+
- name: environmentName
|
|
997
996
|
in: path
|
|
998
|
-
description: Name of the
|
|
997
|
+
description: Name of the environment
|
|
999
998
|
required: true
|
|
1000
999
|
schema:
|
|
1001
1000
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -1045,7 +1044,7 @@ paths:
|
|
|
1045
1044
|
"503":
|
|
1046
1045
|
$ref: "#/components/responses/ServiceUnavailable"
|
|
1047
1046
|
|
|
1048
|
-
/
|
|
1047
|
+
/environments/{environmentName}/packages/{packageName}/connections/{connectionName}/schemas/{schemaName}/tables/{tablePath}:
|
|
1049
1048
|
get:
|
|
1050
1049
|
tags:
|
|
1051
1050
|
- connections
|
|
@@ -1055,9 +1054,9 @@ paths:
|
|
|
1055
1054
|
Retrieves a table from the specified database schema, resolved in
|
|
1056
1055
|
the context of the named package.
|
|
1057
1056
|
parameters:
|
|
1058
|
-
- name:
|
|
1057
|
+
- name: environmentName
|
|
1059
1058
|
in: path
|
|
1060
|
-
description: Name of the
|
|
1059
|
+
description: Name of the environment
|
|
1061
1060
|
required: true
|
|
1062
1061
|
schema:
|
|
1063
1062
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -1102,7 +1101,7 @@ paths:
|
|
|
1102
1101
|
$ref: "#/components/responses/ServiceUnavailable"
|
|
1103
1102
|
|
|
1104
1103
|
# TODO: Remove the GET (deprecated) form once clients migrate.
|
|
1105
|
-
/
|
|
1104
|
+
/environments/{environmentName}/packages/{packageName}/connections/{connectionName}/sqlSource:
|
|
1106
1105
|
get:
|
|
1107
1106
|
tags:
|
|
1108
1107
|
- connections
|
|
@@ -1115,9 +1114,9 @@ paths:
|
|
|
1115
1114
|
Creates a Malloy source from a SQL statement using the specified
|
|
1116
1115
|
connection, resolved in the context of the named package.
|
|
1117
1116
|
parameters:
|
|
1118
|
-
- name:
|
|
1117
|
+
- name: environmentName
|
|
1119
1118
|
in: path
|
|
1120
|
-
description: Name of the
|
|
1119
|
+
description: Name of the environment
|
|
1121
1120
|
required: true
|
|
1122
1121
|
schema:
|
|
1123
1122
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -1164,9 +1163,9 @@ paths:
|
|
|
1164
1163
|
Creates a Malloy source from a SQL statement using the specified
|
|
1165
1164
|
connection, resolved in the context of the named package.
|
|
1166
1165
|
parameters:
|
|
1167
|
-
- name:
|
|
1166
|
+
- name: environmentName
|
|
1168
1167
|
in: path
|
|
1169
|
-
description: Name of the
|
|
1168
|
+
description: Name of the environment
|
|
1170
1169
|
required: true
|
|
1171
1170
|
schema:
|
|
1172
1171
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -1208,7 +1207,7 @@ paths:
|
|
|
1208
1207
|
"503":
|
|
1209
1208
|
$ref: "#/components/responses/ServiceUnavailable"
|
|
1210
1209
|
|
|
1211
|
-
/
|
|
1210
|
+
/environments/{environmentName}/packages/{packageName}/connections/{connectionName}/sqlQuery:
|
|
1212
1211
|
post:
|
|
1213
1212
|
tags:
|
|
1214
1213
|
- connections
|
|
@@ -1218,9 +1217,9 @@ paths:
|
|
|
1218
1217
|
Executes a SQL statement against the specified database connection,
|
|
1219
1218
|
resolved in the context of the named package, and returns the results.
|
|
1220
1219
|
parameters:
|
|
1221
|
-
- name:
|
|
1220
|
+
- name: environmentName
|
|
1222
1221
|
in: path
|
|
1223
|
-
description: Name of the
|
|
1222
|
+
description: Name of the environment
|
|
1224
1223
|
required: true
|
|
1225
1224
|
schema:
|
|
1226
1225
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -1272,7 +1271,7 @@ paths:
|
|
|
1272
1271
|
"503":
|
|
1273
1272
|
$ref: "#/components/responses/ServiceUnavailable"
|
|
1274
1273
|
|
|
1275
|
-
/
|
|
1274
|
+
/environments/{environmentName}/packages/{packageName}/connections/{connectionName}/sqlTemporaryTable:
|
|
1276
1275
|
post:
|
|
1277
1276
|
tags:
|
|
1278
1277
|
- connections
|
|
@@ -1282,9 +1281,9 @@ paths:
|
|
|
1282
1281
|
Creates a temporary table from a SQL statement using the specified
|
|
1283
1282
|
database connection, resolved in the context of the named package.
|
|
1284
1283
|
parameters:
|
|
1285
|
-
- name:
|
|
1284
|
+
- name: environmentName
|
|
1286
1285
|
in: path
|
|
1287
|
-
description: Name of the
|
|
1286
|
+
description: Name of the environment
|
|
1288
1287
|
required: true
|
|
1289
1288
|
schema:
|
|
1290
1289
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -1327,7 +1326,7 @@ paths:
|
|
|
1327
1326
|
$ref: "#/components/responses/ServiceUnavailable"
|
|
1328
1327
|
|
|
1329
1328
|
# TODO: Remove this endpoint.
|
|
1330
|
-
/
|
|
1329
|
+
/environments/{environmentName}/packages/{packageName}/connections/{connectionName}/temporaryTable:
|
|
1331
1330
|
get:
|
|
1332
1331
|
tags:
|
|
1333
1332
|
- connections
|
|
@@ -1340,9 +1339,9 @@ paths:
|
|
|
1340
1339
|
Creates a temporary table from a SQL statement using the specified
|
|
1341
1340
|
connection, resolved in the context of the named package.
|
|
1342
1341
|
parameters:
|
|
1343
|
-
- name:
|
|
1342
|
+
- name: environmentName
|
|
1344
1343
|
in: path
|
|
1345
|
-
description: Name of the
|
|
1344
|
+
description: Name of the environment
|
|
1346
1345
|
required: true
|
|
1347
1346
|
schema:
|
|
1348
1347
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -1381,7 +1380,7 @@ paths:
|
|
|
1381
1380
|
$ref: "#/components/responses/ServiceUnavailable"
|
|
1382
1381
|
|
|
1383
1382
|
# TODO: Remove this endpoint.
|
|
1384
|
-
/
|
|
1383
|
+
/environments/{environmentName}/packages/{packageName}/connections/{connectionName}/queryData:
|
|
1385
1384
|
get:
|
|
1386
1385
|
tags:
|
|
1387
1386
|
- connections
|
|
@@ -1394,9 +1393,9 @@ paths:
|
|
|
1394
1393
|
Executes a SQL statement against the specified database connection,
|
|
1395
1394
|
resolved in the context of the named package, and returns the results.
|
|
1396
1395
|
parameters:
|
|
1397
|
-
- name:
|
|
1396
|
+
- name: environmentName
|
|
1398
1397
|
in: path
|
|
1399
|
-
description: Name of the
|
|
1398
|
+
description: Name of the environment
|
|
1400
1399
|
required: true
|
|
1401
1400
|
schema:
|
|
1402
1401
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -1438,26 +1437,26 @@ paths:
|
|
|
1438
1437
|
"500":
|
|
1439
1438
|
$ref: "#/components/responses/InternalServerError"
|
|
1440
1439
|
|
|
1441
|
-
/
|
|
1440
|
+
/environments/{environmentName}/packages:
|
|
1442
1441
|
get:
|
|
1443
1442
|
tags:
|
|
1444
1443
|
- packages
|
|
1445
1444
|
operationId: list-packages
|
|
1446
|
-
summary: List
|
|
1445
|
+
summary: List environment packages
|
|
1447
1446
|
description: |
|
|
1448
|
-
Retrieves a list of all Malloy packages within the specified
|
|
1447
|
+
Retrieves a list of all Malloy packages within the specified environment. Each package
|
|
1449
1448
|
contains models, notebooks, databases, and other resources. This endpoint is useful
|
|
1450
1449
|
for discovering available packages and their basic metadata.
|
|
1451
1450
|
parameters:
|
|
1452
|
-
- name:
|
|
1451
|
+
- name: environmentName
|
|
1453
1452
|
in: path
|
|
1454
|
-
description: Name of the
|
|
1453
|
+
description: Name of the environment
|
|
1455
1454
|
required: true
|
|
1456
1455
|
schema:
|
|
1457
1456
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
1458
1457
|
responses:
|
|
1459
1458
|
"200":
|
|
1460
|
-
description: A list of all packages in the
|
|
1459
|
+
description: A list of all packages in the environment
|
|
1461
1460
|
content:
|
|
1462
1461
|
application/json:
|
|
1463
1462
|
schema:
|
|
@@ -1478,13 +1477,13 @@ paths:
|
|
|
1478
1477
|
operationId: create-package
|
|
1479
1478
|
summary: Create a new package
|
|
1480
1479
|
description: |
|
|
1481
|
-
Creates a new Malloy package within the specified
|
|
1480
|
+
Creates a new Malloy package within the specified environment. A package serves as a
|
|
1482
1481
|
container for models, notebooks, embedded databases, and other resources. The package
|
|
1483
1482
|
will be initialized with the provided metadata and can immediately accept content.
|
|
1484
1483
|
parameters:
|
|
1485
|
-
- name:
|
|
1484
|
+
- name: environmentName
|
|
1486
1485
|
in: path
|
|
1487
|
-
description: Name of the
|
|
1486
|
+
description: Name of the environment
|
|
1488
1487
|
required: true
|
|
1489
1488
|
schema:
|
|
1490
1489
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -1520,7 +1519,7 @@ paths:
|
|
|
1520
1519
|
"503":
|
|
1521
1520
|
$ref: "#/components/responses/ServiceUnavailable"
|
|
1522
1521
|
|
|
1523
|
-
/
|
|
1522
|
+
/environments/{environmentName}/packages/{packageName}:
|
|
1524
1523
|
get:
|
|
1525
1524
|
tags:
|
|
1526
1525
|
- packages
|
|
@@ -1532,9 +1531,9 @@ paths:
|
|
|
1532
1531
|
from disk before returning the information. The versionId parameter allows access to
|
|
1533
1532
|
specific package versions.
|
|
1534
1533
|
parameters:
|
|
1535
|
-
- name:
|
|
1534
|
+
- name: environmentName
|
|
1536
1535
|
in: path
|
|
1537
|
-
description: Name of the
|
|
1536
|
+
description: Name of the environment
|
|
1538
1537
|
required: true
|
|
1539
1538
|
schema:
|
|
1540
1539
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -1583,9 +1582,9 @@ paths:
|
|
|
1583
1582
|
modify package settings, update the description, change the location, or update other
|
|
1584
1583
|
package-level properties. The package must exist and be accessible.
|
|
1585
1584
|
parameters:
|
|
1586
|
-
- name:
|
|
1585
|
+
- name: environmentName
|
|
1587
1586
|
in: path
|
|
1588
|
-
description: Name of the
|
|
1587
|
+
description: Name of the environment
|
|
1589
1588
|
required: true
|
|
1590
1589
|
schema:
|
|
1591
1590
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -1628,9 +1627,9 @@ paths:
|
|
|
1628
1627
|
notebooks, databases, and metadata. This operation cannot be undone, so use with caution.
|
|
1629
1628
|
The package must exist and be accessible for deletion.
|
|
1630
1629
|
parameters:
|
|
1631
|
-
- name:
|
|
1630
|
+
- name: environmentName
|
|
1632
1631
|
in: path
|
|
1633
|
-
description: Name of the
|
|
1632
|
+
description: Name of the environment
|
|
1634
1633
|
required: true
|
|
1635
1634
|
schema:
|
|
1636
1635
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -1658,7 +1657,7 @@ paths:
|
|
|
1658
1657
|
"503":
|
|
1659
1658
|
$ref: "#/components/responses/ServiceUnavailable"
|
|
1660
1659
|
|
|
1661
|
-
/
|
|
1660
|
+
/environments/{environmentName}/packages/{packageName}/models:
|
|
1662
1661
|
get:
|
|
1663
1662
|
tags:
|
|
1664
1663
|
- models
|
|
@@ -1669,9 +1668,9 @@ paths:
|
|
|
1669
1668
|
includes the relative path, package name, and any compilation errors. This endpoint
|
|
1670
1669
|
is useful for discovering available models and checking their status.
|
|
1671
1670
|
parameters:
|
|
1672
|
-
- name:
|
|
1671
|
+
- name: environmentName
|
|
1673
1672
|
in: path
|
|
1674
|
-
description: Name of the
|
|
1673
|
+
description: Name of the environment
|
|
1675
1674
|
required: true
|
|
1676
1675
|
schema:
|
|
1677
1676
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -1707,7 +1706,7 @@ paths:
|
|
|
1707
1706
|
"503":
|
|
1708
1707
|
$ref: "#/components/responses/ServiceUnavailable"
|
|
1709
1708
|
|
|
1710
|
-
/
|
|
1709
|
+
/environments/{environmentName}/packages/{packageName}/models/{path}:
|
|
1711
1710
|
get:
|
|
1712
1711
|
tags:
|
|
1713
1712
|
- models
|
|
@@ -1718,9 +1717,9 @@ paths:
|
|
|
1718
1717
|
The model is compiled using the specified version of the Malloy compiler. This endpoint
|
|
1719
1718
|
provides access to the model's structure, sources, and named queries for use in applications.
|
|
1720
1719
|
parameters:
|
|
1721
|
-
- name:
|
|
1720
|
+
- name: environmentName
|
|
1722
1721
|
in: path
|
|
1723
|
-
description: Name of the
|
|
1722
|
+
description: Name of the environment
|
|
1724
1723
|
required: true
|
|
1725
1724
|
schema:
|
|
1726
1725
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -1760,7 +1759,7 @@ paths:
|
|
|
1760
1759
|
"501":
|
|
1761
1760
|
$ref: "#/components/responses/NotImplemented"
|
|
1762
1761
|
|
|
1763
|
-
/
|
|
1762
|
+
/environments/{environmentName}/packages/{packageName}/models/{path}/query:
|
|
1764
1763
|
post:
|
|
1765
1764
|
tags:
|
|
1766
1765
|
- models
|
|
@@ -1772,9 +1771,9 @@ paths:
|
|
|
1772
1771
|
supports both ad-hoc queries and predefined model queries, making it flexible for various
|
|
1773
1772
|
use cases including data exploration, reporting, and application integration.
|
|
1774
1773
|
parameters:
|
|
1775
|
-
- name:
|
|
1774
|
+
- name: environmentName
|
|
1776
1775
|
in: path
|
|
1777
|
-
description: Name of the
|
|
1776
|
+
description: Name of the environment
|
|
1778
1777
|
required: true
|
|
1779
1778
|
schema:
|
|
1780
1779
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -1816,7 +1815,7 @@ paths:
|
|
|
1816
1815
|
"503":
|
|
1817
1816
|
$ref: "#/components/responses/ServiceUnavailable"
|
|
1818
1817
|
|
|
1819
|
-
/
|
|
1818
|
+
/environments/{environmentName}/packages/{packageName}/models/{path}/compile:
|
|
1820
1819
|
post:
|
|
1821
1820
|
tags:
|
|
1822
1821
|
- models
|
|
@@ -1829,9 +1828,9 @@ paths:
|
|
|
1829
1828
|
Relative imports resolve correctly against sibling model files.
|
|
1830
1829
|
Returns compilation status and any problems (errors or warnings) found.
|
|
1831
1830
|
parameters:
|
|
1832
|
-
- name:
|
|
1831
|
+
- name: environmentName
|
|
1833
1832
|
in: path
|
|
1834
|
-
description: Name of the
|
|
1833
|
+
description: Name of the environment
|
|
1835
1834
|
required: true
|
|
1836
1835
|
schema:
|
|
1837
1836
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -1870,7 +1869,7 @@ paths:
|
|
|
1870
1869
|
"503":
|
|
1871
1870
|
$ref: "#/components/responses/ServiceUnavailable"
|
|
1872
1871
|
|
|
1873
|
-
/
|
|
1872
|
+
/environments/{environmentName}/packages/{packageName}/notebooks:
|
|
1874
1873
|
get:
|
|
1875
1874
|
tags:
|
|
1876
1875
|
- notebooks
|
|
@@ -1881,9 +1880,9 @@ paths:
|
|
|
1881
1880
|
includes the relative path, package name, and any compilation errors. This endpoint
|
|
1882
1881
|
is useful for discovering available notebooks and checking their status.
|
|
1883
1882
|
parameters:
|
|
1884
|
-
- name:
|
|
1883
|
+
- name: environmentName
|
|
1885
1884
|
in: path
|
|
1886
|
-
description: Name of the
|
|
1885
|
+
description: Name of the environment
|
|
1887
1886
|
required: true
|
|
1888
1887
|
schema:
|
|
1889
1888
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -1919,7 +1918,7 @@ paths:
|
|
|
1919
1918
|
"503":
|
|
1920
1919
|
$ref: "#/components/responses/ServiceUnavailable"
|
|
1921
1920
|
|
|
1922
|
-
/
|
|
1921
|
+
/environments/{environmentName}/packages/{packageName}/notebooks/{path}:
|
|
1923
1922
|
get:
|
|
1924
1923
|
tags:
|
|
1925
1924
|
- notebooks
|
|
@@ -1929,9 +1928,9 @@ paths:
|
|
|
1929
1928
|
Retrieves a Malloy notebook with its raw cell contents (markdown and code).
|
|
1930
1929
|
Cell execution should be done separately via the execute-notebook-cell endpoint.
|
|
1931
1930
|
parameters:
|
|
1932
|
-
- name:
|
|
1931
|
+
- name: environmentName
|
|
1933
1932
|
in: path
|
|
1934
|
-
description: Name of the
|
|
1933
|
+
description: Name of the environment
|
|
1935
1934
|
required: true
|
|
1936
1935
|
schema:
|
|
1937
1936
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -1969,7 +1968,7 @@ paths:
|
|
|
1969
1968
|
"501":
|
|
1970
1969
|
$ref: "#/components/responses/NotImplemented"
|
|
1971
1970
|
|
|
1972
|
-
/
|
|
1971
|
+
/environments/{environmentName}/packages/{packageName}/notebooks/{path}/cells/{cellIndex}:
|
|
1973
1972
|
get:
|
|
1974
1973
|
tags:
|
|
1975
1974
|
- notebooks
|
|
@@ -1980,9 +1979,9 @@ paths:
|
|
|
1980
1979
|
and runs the Malloy code, returning query results and any new sources defined.
|
|
1981
1980
|
For markdown cells, this simply returns the cell content.
|
|
1982
1981
|
parameters:
|
|
1983
|
-
- name:
|
|
1982
|
+
- name: environmentName
|
|
1984
1983
|
in: path
|
|
1985
|
-
description: Name of the
|
|
1984
|
+
description: Name of the environment
|
|
1986
1985
|
required: true
|
|
1987
1986
|
schema:
|
|
1988
1987
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -2045,7 +2044,7 @@ paths:
|
|
|
2045
2044
|
"503":
|
|
2046
2045
|
$ref: "#/components/responses/ServiceUnavailable"
|
|
2047
2046
|
|
|
2048
|
-
/
|
|
2047
|
+
/environments/{environmentName}/packages/{packageName}/databases:
|
|
2049
2048
|
get:
|
|
2050
2049
|
tags:
|
|
2051
2050
|
- databases
|
|
@@ -2056,9 +2055,9 @@ paths:
|
|
|
2056
2055
|
DuckDB databases stored as .parquet files that provide local data storage for the package.
|
|
2057
2056
|
Each database entry includes metadata about the database structure and content.
|
|
2058
2057
|
parameters:
|
|
2059
|
-
- name:
|
|
2058
|
+
- name: environmentName
|
|
2060
2059
|
in: path
|
|
2061
|
-
description: Name of the
|
|
2060
|
+
description: Name of the environment
|
|
2062
2061
|
required: true
|
|
2063
2062
|
schema:
|
|
2064
2063
|
$ref: "#/components/schemas/IdentifierPattern"
|
|
@@ -2101,9 +2100,9 @@ paths:
|
|
|
2101
2100
|
operationId: test-connection-configuration
|
|
2102
2101
|
summary: Test database connection configuration
|
|
2103
2102
|
description: |
|
|
2104
|
-
Validates a database connection configuration without adding it to any
|
|
2103
|
+
Validates a database connection configuration without adding it to any environment.
|
|
2105
2104
|
This endpoint allows you to test connection parameters, credentials, and network
|
|
2106
|
-
connectivity before committing the connection to
|
|
2105
|
+
connectivity before committing the connection to an environment. Useful for troubleshooting
|
|
2107
2106
|
connection issues and validating configurations during setup.
|
|
2108
2107
|
requestBody:
|
|
2109
2108
|
required: true
|
|
@@ -2137,7 +2136,7 @@ paths:
|
|
|
2137
2136
|
summary: Get watch mode status
|
|
2138
2137
|
description: |
|
|
2139
2138
|
Retrieves the current status of the file watching system. This includes whether watch mode
|
|
2140
|
-
is enabled, which
|
|
2139
|
+
is enabled, which environment is being watched, and the path being monitored. Useful for
|
|
2141
2140
|
monitoring the development workflow and ensuring file changes are being detected.
|
|
2142
2141
|
responses:
|
|
2143
2142
|
"200":
|
|
@@ -2160,9 +2159,9 @@ paths:
|
|
|
2160
2159
|
operationId: start-watching
|
|
2161
2160
|
summary: Start file watching
|
|
2162
2161
|
description: |
|
|
2163
|
-
Initiates file watching for the specified
|
|
2164
|
-
file changes within the
|
|
2165
|
-
during development. Only one
|
|
2162
|
+
Initiates file watching for the specified environment. This enables real-time monitoring of
|
|
2163
|
+
file changes within the environment directory, allowing for automatic reloading and updates
|
|
2164
|
+
during development. Only one environment can be watched at a time.
|
|
2166
2165
|
requestBody:
|
|
2167
2166
|
required: true
|
|
2168
2167
|
content:
|
|
@@ -2188,7 +2187,7 @@ paths:
|
|
|
2188
2187
|
description: |
|
|
2189
2188
|
Stops the current file watching session. This disables real-time monitoring of file changes
|
|
2190
2189
|
and releases system resources. Use this when development is complete or when switching
|
|
2191
|
-
to a different
|
|
2190
|
+
to a different environment.
|
|
2192
2191
|
responses:
|
|
2193
2192
|
"200":
|
|
2194
2193
|
description: Watch mode stopped successfully.
|
|
@@ -2199,7 +2198,7 @@ paths:
|
|
|
2199
2198
|
"503":
|
|
2200
2199
|
$ref: "#/components/responses/ServiceUnavailable"
|
|
2201
2200
|
|
|
2202
|
-
/
|
|
2201
|
+
/environments/{environmentName}/packages/{packageName}/materializations:
|
|
2203
2202
|
post:
|
|
2204
2203
|
tags:
|
|
2205
2204
|
- materializations
|
|
@@ -2209,7 +2208,7 @@ paths:
|
|
|
2209
2208
|
Creates a new materialization in PENDING state for all persist sources across all
|
|
2210
2209
|
models in the package. Use POST .../materializations/{materializationId}?action=start to begin execution.
|
|
2211
2210
|
parameters:
|
|
2212
|
-
- $ref: "#/components/parameters/
|
|
2211
|
+
- $ref: "#/components/parameters/environmentName"
|
|
2213
2212
|
- $ref: "#/components/parameters/packageName"
|
|
2214
2213
|
requestBody:
|
|
2215
2214
|
content:
|
|
@@ -2239,7 +2238,7 @@ paths:
|
|
|
2239
2238
|
description: Returns the materialization history for the package, ordered by
|
|
2240
2239
|
most recent first.
|
|
2241
2240
|
parameters:
|
|
2242
|
-
- $ref: "#/components/parameters/
|
|
2241
|
+
- $ref: "#/components/parameters/environmentName"
|
|
2243
2242
|
- $ref: "#/components/parameters/packageName"
|
|
2244
2243
|
- name: limit
|
|
2245
2244
|
in: query
|
|
@@ -2267,14 +2266,14 @@ paths:
|
|
|
2267
2266
|
"404":
|
|
2268
2267
|
$ref: "#/components/responses/NotFound"
|
|
2269
2268
|
|
|
2270
|
-
/
|
|
2269
|
+
/environments/{environmentName}/packages/{packageName}/materializations/{materializationId}:
|
|
2271
2270
|
get:
|
|
2272
2271
|
tags:
|
|
2273
2272
|
- materializations
|
|
2274
2273
|
operationId: get-materialization
|
|
2275
2274
|
summary: Get a specific materialization
|
|
2276
2275
|
parameters:
|
|
2277
|
-
- $ref: "#/components/parameters/
|
|
2276
|
+
- $ref: "#/components/parameters/environmentName"
|
|
2278
2277
|
- $ref: "#/components/parameters/packageName"
|
|
2279
2278
|
- $ref: "#/components/parameters/materializationId"
|
|
2280
2279
|
responses:
|
|
@@ -2297,7 +2296,7 @@ paths:
|
|
|
2297
2296
|
* `start` - Transitions a PENDING materialization to RUNNING and begins execution in the background. Returns 202.
|
|
2298
2297
|
* `stop` - Cancels a PENDING or RUNNING materialization. Returns 200.
|
|
2299
2298
|
parameters:
|
|
2300
|
-
- $ref: "#/components/parameters/
|
|
2299
|
+
- $ref: "#/components/parameters/environmentName"
|
|
2301
2300
|
- $ref: "#/components/parameters/packageName"
|
|
2302
2301
|
- $ref: "#/components/parameters/materializationId"
|
|
2303
2302
|
- name: action
|
|
@@ -2340,7 +2339,7 @@ paths:
|
|
|
2340
2339
|
description: Deletes a terminal (SUCCESS, FAILED, or CANCELLED) materialization
|
|
2341
2340
|
record.
|
|
2342
2341
|
parameters:
|
|
2343
|
-
- $ref: "#/components/parameters/
|
|
2342
|
+
- $ref: "#/components/parameters/environmentName"
|
|
2344
2343
|
- $ref: "#/components/parameters/packageName"
|
|
2345
2344
|
- $ref: "#/components/parameters/materializationId"
|
|
2346
2345
|
responses:
|
|
@@ -2355,7 +2354,7 @@ paths:
|
|
|
2355
2354
|
schema:
|
|
2356
2355
|
$ref: "#/components/schemas/Error"
|
|
2357
2356
|
|
|
2358
|
-
/
|
|
2357
|
+
/environments/{environmentName}/packages/{packageName}/manifest:
|
|
2359
2358
|
get:
|
|
2360
2359
|
tags:
|
|
2361
2360
|
- manifests
|
|
@@ -2365,7 +2364,7 @@ paths:
|
|
|
2365
2364
|
Returns the current build manifest containing buildId-to-tableName mappings
|
|
2366
2365
|
for all materialized sources in the package.
|
|
2367
2366
|
parameters:
|
|
2368
|
-
- $ref: "#/components/parameters/
|
|
2367
|
+
- $ref: "#/components/parameters/environmentName"
|
|
2369
2368
|
- $ref: "#/components/parameters/packageName"
|
|
2370
2369
|
responses:
|
|
2371
2370
|
"200":
|
|
@@ -2391,7 +2390,7 @@ paths:
|
|
|
2391
2390
|
workers that did not themselves run the build; the endpoint does
|
|
2392
2391
|
not write anything *into* storage.
|
|
2393
2392
|
parameters:
|
|
2394
|
-
- $ref: "#/components/parameters/
|
|
2393
|
+
- $ref: "#/components/parameters/environmentName"
|
|
2395
2394
|
- $ref: "#/components/parameters/packageName"
|
|
2396
2395
|
- name: action
|
|
2397
2396
|
in: query
|
|
@@ -2489,11 +2488,11 @@ components:
|
|
|
2489
2488
|
timestamp:
|
|
2490
2489
|
type: number
|
|
2491
2490
|
description: Unix timestamp of the status check
|
|
2492
|
-
|
|
2491
|
+
environments:
|
|
2493
2492
|
type: array
|
|
2494
|
-
description: List of available
|
|
2493
|
+
description: List of available environments
|
|
2495
2494
|
items:
|
|
2496
|
-
$ref: "#/components/schemas/
|
|
2495
|
+
$ref: "#/components/schemas/Environment"
|
|
2497
2496
|
initialized:
|
|
2498
2497
|
type: boolean
|
|
2499
2498
|
description: Whether the server is fully initialized and ready to serve requests
|
|
@@ -2501,7 +2500,7 @@ components:
|
|
|
2501
2500
|
type: string
|
|
2502
2501
|
enum: [ "initializing", "serving", "draining" ]
|
|
2503
2502
|
description: Status of the server; initializing when the server is loading
|
|
2504
|
-
|
|
2503
|
+
environments, packages and connections, serving when the server is
|
|
2505
2504
|
initialized and ready to serve requests, and draining when the
|
|
2506
2505
|
server is going to shut down
|
|
2507
2506
|
frozenConfig:
|
|
@@ -2509,32 +2508,32 @@ components:
|
|
|
2509
2508
|
description: Whether the server configuration is frozen (read-only mode). When
|
|
2510
2509
|
true, all mutation operations are disabled.
|
|
2511
2510
|
|
|
2512
|
-
|
|
2511
|
+
Environment:
|
|
2513
2512
|
type: object
|
|
2514
|
-
description: Represents a Malloy
|
|
2515
|
-
other resources
|
|
2513
|
+
description: Represents a Malloy environment containing packages, connections,
|
|
2514
|
+
and other resources
|
|
2516
2515
|
properties:
|
|
2517
2516
|
resource:
|
|
2518
2517
|
type: string
|
|
2519
|
-
description: Resource path to the
|
|
2518
|
+
description: Resource path to the environment
|
|
2520
2519
|
name:
|
|
2521
2520
|
type: string
|
|
2522
|
-
description:
|
|
2521
|
+
description: Environment name
|
|
2523
2522
|
readme:
|
|
2524
2523
|
type: string
|
|
2525
|
-
description:
|
|
2524
|
+
description: Environment README content
|
|
2526
2525
|
location:
|
|
2527
2526
|
type: string
|
|
2528
|
-
description:
|
|
2529
|
-
gcs, etc.)
|
|
2527
|
+
description: Environment location, can be an absolute path or URI (e.g. github,
|
|
2528
|
+
s3, gcs, etc.)
|
|
2530
2529
|
connections:
|
|
2531
2530
|
type: array
|
|
2532
|
-
description: List of database connections configured for this
|
|
2531
|
+
description: List of database connections configured for this environment
|
|
2533
2532
|
items:
|
|
2534
2533
|
$ref: "#/components/schemas/Connection"
|
|
2535
2534
|
packages:
|
|
2536
2535
|
type: array
|
|
2537
|
-
description: List of Malloy packages in this
|
|
2536
|
+
description: List of Malloy packages in this environment
|
|
2538
2537
|
items:
|
|
2539
2538
|
$ref: "#/components/schemas/Package"
|
|
2540
2539
|
materializationStorage:
|
|
@@ -3267,9 +3266,9 @@ components:
|
|
|
3267
3266
|
DuckDB database connection configuration. Publisher intentionally
|
|
3268
3267
|
exposes only data-source intent here. Database files, working
|
|
3269
3268
|
directories, filesystem/network policy, extension loading, setup SQL,
|
|
3270
|
-
temp directories, and resource knobs are owned by Publisher so
|
|
3271
|
-
configs cannot widen deployment policy through low-level
|
|
3272
|
-
settings.
|
|
3269
|
+
temp directories, and resource knobs are owned by Publisher so
|
|
3270
|
+
environment configs cannot widen deployment policy through low-level
|
|
3271
|
+
DuckDB settings.
|
|
3273
3272
|
properties:
|
|
3274
3273
|
attachedDatabases:
|
|
3275
3274
|
type: array
|
|
@@ -3413,27 +3412,27 @@ components:
|
|
|
3413
3412
|
enabled:
|
|
3414
3413
|
type: boolean
|
|
3415
3414
|
description: Whether file watching is currently active
|
|
3416
|
-
|
|
3415
|
+
environmentName:
|
|
3417
3416
|
type: string
|
|
3418
|
-
description: Name of the
|
|
3417
|
+
description: Name of the environment being watched for file changes
|
|
3419
3418
|
watchingPath:
|
|
3420
3419
|
type: string
|
|
3421
3420
|
description: The file system path being monitored for changes, null if not
|
|
3422
3421
|
watching
|
|
3423
3422
|
required:
|
|
3424
3423
|
- enabled
|
|
3425
|
-
-
|
|
3424
|
+
- environmentName
|
|
3426
3425
|
- watchingPath
|
|
3427
3426
|
|
|
3428
3427
|
StartWatchRequest:
|
|
3429
3428
|
type: object
|
|
3430
|
-
description: Request to start file watching for
|
|
3429
|
+
description: Request to start file watching for an environment
|
|
3431
3430
|
properties:
|
|
3432
|
-
|
|
3431
|
+
environmentName:
|
|
3433
3432
|
type: string
|
|
3434
|
-
description: Name of the
|
|
3433
|
+
description: Name of the environment to start watching for file changes
|
|
3435
3434
|
required:
|
|
3436
|
-
-
|
|
3435
|
+
- environmentName
|
|
3437
3436
|
|
|
3438
3437
|
ConnectionStatus:
|
|
3439
3438
|
type: object
|
|
@@ -3528,7 +3527,7 @@ components:
|
|
|
3528
3527
|
properties:
|
|
3529
3528
|
id:
|
|
3530
3529
|
type: string
|
|
3531
|
-
|
|
3530
|
+
environmentId:
|
|
3532
3531
|
type: string
|
|
3533
3532
|
packageName:
|
|
3534
3533
|
type: string
|
|
@@ -3577,11 +3576,11 @@ components:
|
|
|
3577
3576
|
description: Name of the materialized table
|
|
3578
3577
|
|
|
3579
3578
|
parameters:
|
|
3580
|
-
|
|
3581
|
-
name:
|
|
3579
|
+
environmentName:
|
|
3580
|
+
name: environmentName
|
|
3582
3581
|
in: path
|
|
3583
3582
|
required: true
|
|
3584
|
-
description: Name of the
|
|
3583
|
+
description: Name of the environment
|
|
3585
3584
|
schema:
|
|
3586
3585
|
type: string
|
|
3587
3586
|
packageName:
|