@celigo/api-specs 0.2.203 → 0.2.205
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/connection.yml +3 -1
- package/dist/mcp-server.yml +72 -33
- package/dist/storagequery.yml +155 -9
- package/package.json +1 -1
- package/schemas.json +3 -2
package/dist/connection.yml
CHANGED
|
@@ -1185,7 +1185,9 @@ paths:
|
|
|
1185
1185
|
- |-
|
|
1186
1186
|
Soft-deletes the connection into the recycle bin (restorable for 30 days). Check
|
|
1187
1187
|
`GET /v1/connections/{_id}/dependencies` first — a connection still referenced by flows,
|
|
1188
|
-
exports, imports,
|
|
1188
|
+
exports, imports, a borrowing connection, or MCP servers (a tool override, or a
|
|
1189
|
+
`connections[]` entry that requires end-user credentials) is rejected with 422
|
|
1190
|
+
`dependencies_not_deleted`.
|
|
1189
1191
|
/v1/connections/{_id}/ping:
|
|
1190
1192
|
get:
|
|
1191
1193
|
x-internal: false
|
package/dist/mcp-server.yml
CHANGED
|
@@ -20,7 +20,7 @@ info:
|
|
|
20
20
|
- Carries **permission sets** ("Capability Sets" in the UI) — named bundles of its tools, APIs, prompts, and resources granted to end users via `pset:<_id>` capability strings on end-user, group, and role resource grants
|
|
21
21
|
- Carries optional **traffic limits** (`policies[]`) — a server-level rate limit, a per-user rate limit for OAuth end users, and a usage quota — enforced before a tool runs; a rejected call gets HTTP 429 with `Retry-After`
|
|
22
22
|
- Can proxy **upstream MCP servers** (`upstreamMcpConnections[]`, attached through `mcp`-type connections) and whitelist which of their tools, prompts, and resources it exposes
|
|
23
|
-
- Lists the **connections**
|
|
23
|
+
- Lists the **connections** each end user must supply their own credentials for (`connections[]`); only entries with `requiresEndUserCredentials: true` are kept
|
|
24
24
|
- Can be pinned to a **network policy** (`_networkPolicyId`) that restricts which IP ranges may reach it
|
|
25
25
|
servers:
|
|
26
26
|
- url: https://api.integrator.io
|
|
@@ -220,6 +220,7 @@ paths:
|
|
|
220
220
|
policies: []
|
|
221
221
|
createdAt: '2026-04-24T16:52:05.607Z'
|
|
222
222
|
lastModified: '2026-04-24T16:52:05.607Z'
|
|
223
|
+
enabledItemCount: 0
|
|
223
224
|
'400':
|
|
224
225
|
$ref: '#/components/responses/400-bad-request'
|
|
225
226
|
'401':
|
|
@@ -347,8 +348,8 @@ paths:
|
|
|
347
348
|
prompts, resources, connections, upstream MCP connections, and OAuth
|
|
348
349
|
settings. Each upstream connection row is enriched with the connection's
|
|
349
350
|
current `name` and each upstream capability with its effective `title`,
|
|
350
|
-
`annotations`, and (when overridden) `name
|
|
351
|
-
computed
|
|
351
|
+
`annotations`, and (when overridden) `name`, and `enabledItemCount` is
|
|
352
|
+
computed. The list, POST, and PUT responses carry the same enrichment.
|
|
352
353
|
operationId: getMcpServerById
|
|
353
354
|
tags:
|
|
354
355
|
- MCP Servers
|
|
@@ -596,6 +597,7 @@ paths:
|
|
|
596
597
|
useCeligoOauth: true
|
|
597
598
|
createdAt: '2026-04-24T16:52:05.607Z'
|
|
598
599
|
lastModified: '2026-05-07T15:22:16.985Z'
|
|
600
|
+
enabledItemCount: 3
|
|
599
601
|
'400':
|
|
600
602
|
$ref: '#/components/responses/400-bad-request'
|
|
601
603
|
'401':
|
|
@@ -2466,17 +2468,23 @@ components:
|
|
|
2466
2468
|
ServerConnection:
|
|
2467
2469
|
type: object
|
|
2468
2470
|
description: |-
|
|
2469
|
-
One connection
|
|
2470
|
-
|
|
2471
|
-
|
|
2472
|
-
`GET /v1/mcpservers/{_id}/connections` lists.
|
|
2471
|
+
One connection each end user must supply their own credentials for.
|
|
2472
|
+
Connections named here and in `tools[].overrides.connections[]`
|
|
2473
|
+
together form the set that `GET /v1/mcpservers/{_id}/connections` lists.
|
|
2473
2474
|
x-celigo-ai-guidance:
|
|
2474
2475
|
- |-
|
|
2475
2476
|
Reference a live connection owned by this account: an unknown id fails
|
|
2476
2477
|
with 422 "resource_not_found" and the same connection listed twice with
|
|
2477
|
-
422 "resource_invalid"
|
|
2478
|
+
422 "resource_invalid" — even on an entry sent with the flag false, which
|
|
2479
|
+
is then dropped.
|
|
2480
|
+
- |-
|
|
2481
|
+
A stored entry makes the connection a dependency of the server:
|
|
2482
|
+
DELETE /v1/connections/{_id} fails with 422 "dependencies_not_deleted"
|
|
2483
|
+
("mcpserver <id> must be deleted before you can delete connection <id>")
|
|
2484
|
+
until a PUT removes the entry or clears its flag.
|
|
2478
2485
|
required:
|
|
2479
2486
|
- _connectionId
|
|
2487
|
+
- requiresEndUserCredentials
|
|
2480
2488
|
properties:
|
|
2481
2489
|
_connectionId:
|
|
2482
2490
|
type: string
|
|
@@ -2491,14 +2499,15 @@ components:
|
|
|
2491
2499
|
- 6ab1ebb94db5688fd8c7189f
|
|
2492
2500
|
requiresEndUserCredentials:
|
|
2493
2501
|
type: boolean
|
|
2494
|
-
default: false
|
|
2495
2502
|
description: |-
|
|
2496
2503
|
When true, each end user must supply their own values for the fields
|
|
2497
2504
|
the connection's `endUserProvidedFields` names (through the MCP setup
|
|
2498
2505
|
page) before calling tools that use it; those values are stored as a
|
|
2499
|
-
per-user `mcpChild` connection.
|
|
2500
|
-
|
|
2501
|
-
|
|
2506
|
+
per-user `mcpChild` connection. Only `true` is stored — an entry sent
|
|
2507
|
+
with `false` is dropped on save, so clearing the flag removes the
|
|
2508
|
+
entry. The platform contract is that clearing the flag, or dropping
|
|
2509
|
+
the connection from every server that set it, invalidates the end
|
|
2510
|
+
users' `mcpChild` connections for it.
|
|
2502
2511
|
examples:
|
|
2503
2512
|
- true
|
|
2504
2513
|
Annotations:
|
|
@@ -3704,11 +3713,6 @@ components:
|
|
|
3704
3713
|
resources combined: the 501st row fails the whole PUT with 422
|
|
3705
3714
|
"mcp_upstream_max_capabilities" on upstreamMcpConnections[{index}].
|
|
3706
3715
|
The cap is per attachment, so a second connection gets its own 500.
|
|
3707
|
-
- |-
|
|
3708
|
-
Set alias explicitly when the connection name is longer than 32
|
|
3709
|
-
characters: the alias derived from the name on first attach fails the
|
|
3710
|
-
PUT with 422 "size_limit_exceeded" on upstreamMcpConnections.{index}.alias,
|
|
3711
|
-
the same response an explicit alias of 33 or more characters gets.
|
|
3712
3716
|
required:
|
|
3713
3717
|
- _connectionId
|
|
3714
3718
|
properties:
|
|
@@ -3719,6 +3723,20 @@ components:
|
|
|
3719
3723
|
description: |-
|
|
3720
3724
|
Connection of type `mcp` that holds the upstream server URL and
|
|
3721
3725
|
credentials. Each connection can be attached to a server once.
|
|
3726
|
+
When the upstream server rejects a proxied `tools/call`, `prompts/get`,
|
|
3727
|
+
or `resources/read`, the MCP client gets a JSON-RPC error with HTTP
|
|
3728
|
+
status 200: -32008 `Upstream server denied access` for an upstream 403,
|
|
3729
|
+
-32004 `Upstream rate limit exceeded` for a 429, and for a 401 either
|
|
3730
|
+
-32007 `Upstream connection requires re-authorization` or -32603. A
|
|
3731
|
+
`token` or `custom` connection answers -32007. An `oauth` connection
|
|
3732
|
+
first refreshes its token and retries once: -32007 when the connection
|
|
3733
|
+
can't be refreshed (for example, it holds no refresh token), when the
|
|
3734
|
+
token endpoint rejects the grant (for example, with 400), or when the
|
|
3735
|
+
retry is still 401; -32603 when the refresh fails any other way, such
|
|
3736
|
+
as the token endpoint answering 5xx. -32007, -32008, and -32004 carry
|
|
3737
|
+
this id in
|
|
3738
|
+
`error.data._connectionId`; -32603, which an upstream 5xx also answers,
|
|
3739
|
+
carries no `error.data`.
|
|
3722
3740
|
examples:
|
|
3723
3741
|
- 6a6655fce52f3c30d0a53926
|
|
3724
3742
|
alias:
|
|
@@ -3728,11 +3746,14 @@ components:
|
|
|
3728
3746
|
description: |-
|
|
3729
3747
|
Short handle that namespaces the upstream's capabilities on this
|
|
3730
3748
|
server. Lowercased on save and unique per server (case-insensitive) —
|
|
3731
|
-
a duplicate is rejected with 422 `mcp_upstream_duplicate_alias
|
|
3732
|
-
invalid character with 422 `mcp_upstream_invalid_alias_charset
|
|
3733
|
-
|
|
3734
|
-
|
|
3735
|
-
|
|
3749
|
+
a duplicate is rejected with 422 `mcp_upstream_duplicate_alias` and an
|
|
3750
|
+
invalid character with 422 `mcp_upstream_invalid_alias_charset`.
|
|
3751
|
+
Derived from the connection name when omitted on the first attach,
|
|
3752
|
+
with every character other than a letter, digit, `-`, or `_` turned
|
|
3753
|
+
into `_`. POST, PUT, and PATCH shorten a sent or derived value over 32
|
|
3754
|
+
characters to 32 instead of rejecting it: the cut drops trailing `_`
|
|
3755
|
+
(and, for a sent value, trailing `-`), and a `_2`, `_3`, … suffix
|
|
3756
|
+
within the 32 settles a collision with another alias on the server.
|
|
3736
3757
|
examples:
|
|
3737
3758
|
- deepwiki
|
|
3738
3759
|
- crm_tools
|
|
@@ -3741,7 +3762,7 @@ components:
|
|
|
3741
3762
|
readOnly: true
|
|
3742
3763
|
description: |-
|
|
3743
3764
|
Current display name of the attached connection, joined from the
|
|
3744
|
-
connection record on GET and
|
|
3765
|
+
connection record on GET, list, POST, and PUT responses.
|
|
3745
3766
|
examples:
|
|
3746
3767
|
- DeepWiki MCP
|
|
3747
3768
|
discoveryStatus:
|
|
@@ -4140,13 +4161,17 @@ components:
|
|
|
4140
4161
|
- Order Processing Server
|
|
4141
4162
|
relativeURI:
|
|
4142
4163
|
type: string
|
|
4143
|
-
maxLength:
|
|
4164
|
+
maxLength: 128
|
|
4144
4165
|
pattern: ^\/[a-zA-Z0-9_\-]+$
|
|
4145
4166
|
description: |-
|
|
4146
4167
|
URI path segment for the MCP server endpoint. Must be unique per account —
|
|
4147
4168
|
duplicates are rejected with 422 `mcp_server_duplicate_relative_uri`. Only letters,
|
|
4148
4169
|
numbers, dashes, and underscores after the leading slash (the server's error message
|
|
4149
|
-
also claims colons and dots are allowed, but they are rejected in practice).
|
|
4170
|
+
also claims colons and dots are allowed, but they are rejected in practice). The
|
|
4171
|
+
length limit counts the leading slash; a longer value is rejected with 422
|
|
4172
|
+
`mcp_server_relative_uri_too_long`. `/registry`, `/oidc`, and `/portal`, in any letter
|
|
4173
|
+
case, are reserved for platform endpoints under the account alias and are rejected
|
|
4174
|
+
with 422 `mcp_server_reserved_relative_uri`. PUT applies both checks too. Creation
|
|
4150
4175
|
also requires the account to have an account alias set (422
|
|
4151
4176
|
`mcp_server_account_alias_required` otherwise).
|
|
4152
4177
|
x-celigo-ai-guidance:
|
|
@@ -4188,11 +4213,19 @@ components:
|
|
|
4188
4213
|
connections:
|
|
4189
4214
|
type: array
|
|
4190
4215
|
description: |-
|
|
4191
|
-
Connections
|
|
4192
|
-
|
|
4193
|
-
|
|
4194
|
-
|
|
4216
|
+
Connections each end user must supply their own credentials for. Only
|
|
4217
|
+
entries with `requiresEndUserCredentials: true` are kept — any other
|
|
4218
|
+
entry is validated, then dropped on save. Always returned (an empty
|
|
4219
|
+
array when none is listed) and cleared when omitted on PUT; together
|
|
4220
|
+
with `tools[].overrides.connections[]` it forms the set
|
|
4195
4221
|
`GET /v1/mcpservers/{_id}/connections` reports.
|
|
4222
|
+
x-celigo-ai-guidance:
|
|
4223
|
+
- |-
|
|
4224
|
+
List a connection here only to make each end user supply their own credentials
|
|
4225
|
+
for it, with requiresEndUserCredentials set to true. A connection the tools run on
|
|
4226
|
+
the account's own credentials needs no entry: an entry sent with the flag false
|
|
4227
|
+
still gets 201/200, but it is absent from the response and from every later
|
|
4228
|
+
GET — do not resend it.
|
|
4196
4229
|
items:
|
|
4197
4230
|
$ref: '#/components/schemas/ServerConnection'
|
|
4198
4231
|
tools:
|
|
@@ -4419,9 +4452,9 @@ components:
|
|
|
4419
4452
|
description: |-
|
|
4420
4453
|
Number of capabilities currently served — enabled `tools`, `apis`,
|
|
4421
4454
|
`prompts`, and `resources` plus every enabled and available upstream
|
|
4422
|
-
tool, prompt, and resource row. Computed on GET
|
|
4423
|
-
|
|
4424
|
-
|
|
4455
|
+
tool, prompt, and resource row. Computed on GET, list, POST, and
|
|
4456
|
+
PUT responses, and reported even when `include` omits the arrays
|
|
4457
|
+
it counts.
|
|
4425
4458
|
examples:
|
|
4426
4459
|
- 5
|
|
4427
4460
|
draft:
|
|
@@ -11196,7 +11229,13 @@ components:
|
|
|
11196
11229
|
type:
|
|
11197
11230
|
- string
|
|
11198
11231
|
- 'null'
|
|
11199
|
-
description:
|
|
11232
|
+
description: |-
|
|
11233
|
+
Category of the failure. Null when the request succeeded or was blocked.
|
|
11234
|
+
For a proxied request, `authentication` when the upstream connection needs
|
|
11235
|
+
re-authorization (JSON-RPC -32007) or the upstream server denied access
|
|
11236
|
+
(-32008), `rateLimit` when it answered HTTP 429 (-32004), `upstreamError`
|
|
11237
|
+
for another upstream failure such as a 5xx (-32603), and `internal` when an
|
|
11238
|
+
`oauth` connection's token refresh failed (-32603).
|
|
11200
11239
|
examples:
|
|
11201
11240
|
- null
|
|
11202
11241
|
traceId:
|
package/dist/storagequery.yml
CHANGED
|
@@ -74,6 +74,9 @@ paths:
|
|
|
74
74
|
total bytes a statement may read are each capped; the 422 that reports an exceeded
|
|
75
75
|
cap names the current limit. Requires the account's license to include the Storage
|
|
76
76
|
Query entitlement (`filesql`).
|
|
77
|
+
parameters:
|
|
78
|
+
- $ref: '#/components/parameters/AShareIdHeader'
|
|
79
|
+
- $ref: '#/components/parameters/EnvIdHeader'
|
|
77
80
|
requestBody:
|
|
78
81
|
required: true
|
|
79
82
|
content:
|
|
@@ -150,8 +153,13 @@ paths:
|
|
|
150
153
|
'403':
|
|
151
154
|
description: |-
|
|
152
155
|
The account's license does not include the Storage Query entitlement
|
|
153
|
-
(`STORAGE_QUERY_NOT_ENTITLED`)
|
|
154
|
-
|
|
156
|
+
(`STORAGE_QUERY_NOT_ENTITLED`), or the account context is refused: the caller
|
|
157
|
+
has accepted an account share but sent no `integrator-ashareid`
|
|
158
|
+
(`STORAGE_QUERY_ASHARE_HEADER_REQUIRED`), `integrator-ashareid` and
|
|
159
|
+
`integrator-envid` were both sent (`STORAGE_QUERY_CONFLICTING_ACCOUNT_HEADERS`),
|
|
160
|
+
`integrator-envid` is not an environment of the caller's account
|
|
161
|
+
(`STORAGE_QUERY_INVALID_ENVIRONMENT`), or `integrator-ashareid` is not a share
|
|
162
|
+
accepted by the caller (`STORAGE_QUERY_ACCESS_REFUSED`).
|
|
155
163
|
content:
|
|
156
164
|
application/json:
|
|
157
165
|
schema:
|
|
@@ -162,6 +170,30 @@ paths:
|
|
|
162
170
|
errors:
|
|
163
171
|
- code: STORAGE_QUERY_NOT_ENTITLED
|
|
164
172
|
message: Storage query is not enabled for this account
|
|
173
|
+
ashareHeaderRequired:
|
|
174
|
+
summary: Caller has an accepted share but sent no integrator-ashareid
|
|
175
|
+
value:
|
|
176
|
+
errors:
|
|
177
|
+
- code: STORAGE_QUERY_ASHARE_HEADER_REQUIRED
|
|
178
|
+
message: This account is shared with you; resend the query with the integrator-ashareid header
|
|
179
|
+
conflictingAccountHeaders:
|
|
180
|
+
summary: integrator-ashareid and integrator-envid sent together
|
|
181
|
+
value:
|
|
182
|
+
errors:
|
|
183
|
+
- code: STORAGE_QUERY_CONFLICTING_ACCOUNT_HEADERS
|
|
184
|
+
message: integrator-ashareid and integrator-envid cannot be combined; send only the one that names the account for this query
|
|
185
|
+
invalidEnvironment:
|
|
186
|
+
summary: integrator-envid is not an environment of this account
|
|
187
|
+
value:
|
|
188
|
+
errors:
|
|
189
|
+
- code: STORAGE_QUERY_INVALID_ENVIRONMENT
|
|
190
|
+
message: The requested environment is not available for this account
|
|
191
|
+
accessRefused:
|
|
192
|
+
summary: integrator-ashareid is not a share accepted by the caller
|
|
193
|
+
value:
|
|
194
|
+
errors:
|
|
195
|
+
- code: STORAGE_QUERY_ACCESS_REFUSED
|
|
196
|
+
message: Your role, environment or account sharing does not permit this query
|
|
165
197
|
'404':
|
|
166
198
|
description: |-
|
|
167
199
|
A referenced storage path did not resolve to a file the caller can read
|
|
@@ -189,16 +221,18 @@ paths:
|
|
|
189
221
|
whose first argument is not a literal path or list of paths
|
|
190
222
|
(`STORAGE_QUERY_READER_PATH_NOT_LITERAL`); a reader that does not match the
|
|
191
223
|
file's format (`STORAGE_QUERY_READER_FORMAT_MISMATCH`); a row generator with no
|
|
192
|
-
file reference (`STORAGE_QUERY_NO_STORAGE_REFERENCE`)
|
|
193
|
-
|
|
224
|
+
file reference (`STORAGE_QUERY_NO_STORAGE_REFERENCE`), one whose arguments are
|
|
225
|
+
not all whole-number literals (`STORAGE_QUERY_GENERATOR_ARGUMENT_NOT_LITERAL`),
|
|
226
|
+
or one that would generate more rows than allowed
|
|
227
|
+
(`STORAGE_QUERY_GENERATOR_TOO_LARGE`); a schema- or
|
|
194
228
|
catalog-qualified table name, or a path carrying a wildcard
|
|
195
229
|
(`STORAGE_QUERY_INVALID_SOURCE`); a folder path without its trailing slash
|
|
196
230
|
(`STORAGE_NOT_A_FILE`) or a file path with one (`STORAGE_ITEM_NOT_FOLDER`); an
|
|
197
231
|
unsupported file type (`STORAGE_QUERY_UNSUPPORTED_FILE_TYPE`) — a compressed
|
|
198
232
|
file is refused too, with "Querying `<name>` is not supported; supported formats
|
|
199
|
-
are CSV, JSON, NDJSON, and Parquet"; a file still uploading
|
|
200
|
-
is not yet complete"); a folder
|
|
201
|
-
empty, mixes formats, or holds too many files (`STORAGE_QUERY_FOLDER_EMPTY`,
|
|
233
|
+
are CSV, JSON, NDJSON, and Parquet"; a file still uploading
|
|
234
|
+
(`STORAGE_ITEM_NOT_ACTIVE`, "Upload for `<path>` is not yet complete"); a folder
|
|
235
|
+
that is empty, mixes formats, or holds too many files (`STORAGE_QUERY_FOLDER_EMPTY`,
|
|
202
236
|
`STORAGE_QUERY_MIXED_FORMAT_FOLDER`, `STORAGE_QUERY_FOLDER_TOO_MANY_FILES`); too
|
|
203
237
|
many distinct files (`STORAGE_QUERY_TOO_MANY_SOURCES`); or more input bytes than
|
|
204
238
|
the cap (`STORAGE_QUERY_INPUT_TOO_LARGE`).
|
|
@@ -243,6 +277,18 @@ paths:
|
|
|
243
277
|
errors:
|
|
244
278
|
- code: STORAGE_QUERY_NO_STORAGE_REFERENCE
|
|
245
279
|
message: A query that generates rows must read at least one Celigo Storage file; only constant expressions may omit a file reference
|
|
280
|
+
generatorArgumentNotLiteral:
|
|
281
|
+
summary: Row generator argument that is an expression
|
|
282
|
+
value:
|
|
283
|
+
errors:
|
|
284
|
+
- code: STORAGE_QUERY_GENERATOR_ARGUMENT_NOT_LITERAL
|
|
285
|
+
message: Every argument of generate_series must be a whole-number literal so the row count can be checked before the query runs
|
|
286
|
+
fileStillUploading:
|
|
287
|
+
summary: File whose upload has not finished
|
|
288
|
+
value:
|
|
289
|
+
errors:
|
|
290
|
+
- code: STORAGE_ITEM_NOT_ACTIVE
|
|
291
|
+
message: Upload for "/orders/2026/batch-07.csv" is not yet complete
|
|
246
292
|
wildcardPath:
|
|
247
293
|
summary: Wildcard in a storage path
|
|
248
294
|
value:
|
|
@@ -311,6 +357,8 @@ paths:
|
|
|
311
357
|
format: objectId
|
|
312
358
|
examples:
|
|
313
359
|
- 6ab5a7d0c772d334c44701be
|
|
360
|
+
- $ref: '#/components/parameters/AShareIdHeader'
|
|
361
|
+
- $ref: '#/components/parameters/EnvIdHeader'
|
|
314
362
|
responses:
|
|
315
363
|
'200':
|
|
316
364
|
description: Current state of the job.
|
|
@@ -376,7 +424,15 @@ paths:
|
|
|
376
424
|
'401':
|
|
377
425
|
$ref: '#/components/responses/401-unauthorized'
|
|
378
426
|
'403':
|
|
379
|
-
description:
|
|
427
|
+
description: |-
|
|
428
|
+
The account's license does not include the Storage Query entitlement
|
|
429
|
+
(`STORAGE_QUERY_NOT_ENTITLED`), or the account context is refused: the caller
|
|
430
|
+
has accepted an account share but sent no `integrator-ashareid`
|
|
431
|
+
(`STORAGE_QUERY_ASHARE_HEADER_REQUIRED`), `integrator-ashareid` and
|
|
432
|
+
`integrator-envid` were both sent (`STORAGE_QUERY_CONFLICTING_ACCOUNT_HEADERS`),
|
|
433
|
+
`integrator-envid` is not an environment of the caller's account
|
|
434
|
+
(`STORAGE_QUERY_INVALID_ENVIRONMENT`), or `integrator-ashareid` is not a share
|
|
435
|
+
accepted by the caller (`STORAGE_QUERY_ACCESS_REFUSED`).
|
|
380
436
|
content:
|
|
381
437
|
application/json:
|
|
382
438
|
schema:
|
|
@@ -387,6 +443,30 @@ paths:
|
|
|
387
443
|
errors:
|
|
388
444
|
- code: STORAGE_QUERY_NOT_ENTITLED
|
|
389
445
|
message: Storage query is not enabled for this account
|
|
446
|
+
ashareHeaderRequired:
|
|
447
|
+
summary: Caller has an accepted share but sent no integrator-ashareid
|
|
448
|
+
value:
|
|
449
|
+
errors:
|
|
450
|
+
- code: STORAGE_QUERY_ASHARE_HEADER_REQUIRED
|
|
451
|
+
message: This account is shared with you; resend the query with the integrator-ashareid header
|
|
452
|
+
conflictingAccountHeaders:
|
|
453
|
+
summary: integrator-ashareid and integrator-envid sent together
|
|
454
|
+
value:
|
|
455
|
+
errors:
|
|
456
|
+
- code: STORAGE_QUERY_CONFLICTING_ACCOUNT_HEADERS
|
|
457
|
+
message: integrator-ashareid and integrator-envid cannot be combined; send only the one that names the account for this query
|
|
458
|
+
invalidEnvironment:
|
|
459
|
+
summary: integrator-envid is not an environment of this account
|
|
460
|
+
value:
|
|
461
|
+
errors:
|
|
462
|
+
- code: STORAGE_QUERY_INVALID_ENVIRONMENT
|
|
463
|
+
message: The requested environment is not available for this account
|
|
464
|
+
accessRefused:
|
|
465
|
+
summary: integrator-ashareid is not a share accepted by the caller
|
|
466
|
+
value:
|
|
467
|
+
errors:
|
|
468
|
+
- code: STORAGE_QUERY_ACCESS_REFUSED
|
|
469
|
+
message: Your role, environment or account sharing does not permit this query
|
|
390
470
|
'404':
|
|
391
471
|
description: No job with this id is visible to the caller (`STORAGE_QUERY_JOB_NOT_FOUND`) — unknown, expired, or submitted by another account.
|
|
392
472
|
content:
|
|
@@ -446,6 +526,8 @@ paths:
|
|
|
446
526
|
format: objectId
|
|
447
527
|
examples:
|
|
448
528
|
- 6ab5a7d0c772d334c44701be
|
|
529
|
+
- $ref: '#/components/parameters/AShareIdHeader'
|
|
530
|
+
- $ref: '#/components/parameters/EnvIdHeader'
|
|
449
531
|
- name: page
|
|
450
532
|
in: query
|
|
451
533
|
required: false
|
|
@@ -510,7 +592,15 @@ paths:
|
|
|
510
592
|
'401':
|
|
511
593
|
$ref: '#/components/responses/401-unauthorized'
|
|
512
594
|
'403':
|
|
513
|
-
description:
|
|
595
|
+
description: |-
|
|
596
|
+
The account's license does not include the Storage Query entitlement
|
|
597
|
+
(`STORAGE_QUERY_NOT_ENTITLED`), or the account context is refused: the caller
|
|
598
|
+
has accepted an account share but sent no `integrator-ashareid`
|
|
599
|
+
(`STORAGE_QUERY_ASHARE_HEADER_REQUIRED`), `integrator-ashareid` and
|
|
600
|
+
`integrator-envid` were both sent (`STORAGE_QUERY_CONFLICTING_ACCOUNT_HEADERS`),
|
|
601
|
+
`integrator-envid` is not an environment of the caller's account
|
|
602
|
+
(`STORAGE_QUERY_INVALID_ENVIRONMENT`), or `integrator-ashareid` is not a share
|
|
603
|
+
accepted by the caller (`STORAGE_QUERY_ACCESS_REFUSED`).
|
|
514
604
|
content:
|
|
515
605
|
application/json:
|
|
516
606
|
schema:
|
|
@@ -521,6 +611,30 @@ paths:
|
|
|
521
611
|
errors:
|
|
522
612
|
- code: STORAGE_QUERY_NOT_ENTITLED
|
|
523
613
|
message: Storage query is not enabled for this account
|
|
614
|
+
ashareHeaderRequired:
|
|
615
|
+
summary: Caller has an accepted share but sent no integrator-ashareid
|
|
616
|
+
value:
|
|
617
|
+
errors:
|
|
618
|
+
- code: STORAGE_QUERY_ASHARE_HEADER_REQUIRED
|
|
619
|
+
message: This account is shared with you; resend the query with the integrator-ashareid header
|
|
620
|
+
conflictingAccountHeaders:
|
|
621
|
+
summary: integrator-ashareid and integrator-envid sent together
|
|
622
|
+
value:
|
|
623
|
+
errors:
|
|
624
|
+
- code: STORAGE_QUERY_CONFLICTING_ACCOUNT_HEADERS
|
|
625
|
+
message: integrator-ashareid and integrator-envid cannot be combined; send only the one that names the account for this query
|
|
626
|
+
invalidEnvironment:
|
|
627
|
+
summary: integrator-envid is not an environment of this account
|
|
628
|
+
value:
|
|
629
|
+
errors:
|
|
630
|
+
- code: STORAGE_QUERY_INVALID_ENVIRONMENT
|
|
631
|
+
message: The requested environment is not available for this account
|
|
632
|
+
accessRefused:
|
|
633
|
+
summary: integrator-ashareid is not a share accepted by the caller
|
|
634
|
+
value:
|
|
635
|
+
errors:
|
|
636
|
+
- code: STORAGE_QUERY_ACCESS_REFUSED
|
|
637
|
+
message: Your role, environment or account sharing does not permit this query
|
|
524
638
|
'404':
|
|
525
639
|
description: No job with this id is visible to the caller (`STORAGE_QUERY_JOB_NOT_FOUND`) — unknown, expired, or submitted by another account.
|
|
526
640
|
content:
|
|
@@ -575,6 +689,38 @@ components:
|
|
|
575
689
|
bearerAuth:
|
|
576
690
|
type: http
|
|
577
691
|
scheme: bearer
|
|
692
|
+
parameters:
|
|
693
|
+
AShareIdHeader:
|
|
694
|
+
name: integrator-ashareid
|
|
695
|
+
in: header
|
|
696
|
+
required: false
|
|
697
|
+
description: |-
|
|
698
|
+
Account share to run the call as. Required when the caller has accepted a share
|
|
699
|
+
of any account: without it every Storage Query route answers
|
|
700
|
+
`403 STORAGE_QUERY_ASHARE_HEADER_REQUIRED`. A value that is not a share the caller
|
|
701
|
+
has accepted answers `403 STORAGE_QUERY_ACCESS_REFUSED`. Cannot be sent together
|
|
702
|
+
with `integrator-envid`.
|
|
703
|
+
schema:
|
|
704
|
+
type: string
|
|
705
|
+
format: objectId
|
|
706
|
+
x-celigo-refModel: ashares
|
|
707
|
+
examples:
|
|
708
|
+
- 6ab5a7d0c772d334c44701aa
|
|
709
|
+
EnvIdHeader:
|
|
710
|
+
name: integrator-envid
|
|
711
|
+
in: header
|
|
712
|
+
required: false
|
|
713
|
+
description: |-
|
|
714
|
+
Environment of the caller's own account to run the call in. Omit it to use the
|
|
715
|
+
environment the token belongs to. An id that is malformed or not an environment
|
|
716
|
+
of the caller's account answers `403 STORAGE_QUERY_INVALID_ENVIRONMENT`. Cannot be
|
|
717
|
+
sent together with `integrator-ashareid`.
|
|
718
|
+
schema:
|
|
719
|
+
type: string
|
|
720
|
+
format: objectId
|
|
721
|
+
x-celigo-refModel: environments
|
|
722
|
+
examples:
|
|
723
|
+
- 6ab5a7d0c772d334c44701bb
|
|
578
724
|
schemas:
|
|
579
725
|
StorageQueryRequest:
|
|
580
726
|
type: object
|
package/package.json
CHANGED
package/schemas.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"provenance": {
|
|
3
3
|
"repo": "celigo/integrator-api-specs",
|
|
4
|
-
"iasCommit": "
|
|
4
|
+
"iasCommit": "c89a0221",
|
|
5
5
|
"generatedAt": "2026-10-28"
|
|
6
6
|
},
|
|
7
7
|
"roots": {
|
|
@@ -8332,7 +8332,8 @@
|
|
|
8332
8332
|
"requiresEndUserCredentials": 8
|
|
8333
8333
|
},
|
|
8334
8334
|
"r": [
|
|
8335
|
-
"_connectionId"
|
|
8335
|
+
"_connectionId",
|
|
8336
|
+
"requiresEndUserCredentials"
|
|
8336
8337
|
]
|
|
8337
8338
|
},
|
|
8338
8339
|
{
|