@celigo/api-specs 0.2.30 → 0.2.32
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/enduser.yml +28 -6
- package/dist/mcp-server.yml +5 -2
- package/dist/sync.yml +60 -16
- package/package.json +1 -1
- package/schemas.json +2 -2
package/dist/enduser.yml
CHANGED
|
@@ -23,7 +23,11 @@ tags:
|
|
|
23
23
|
in bulk), list and revoke them, and inspect the effective MCP tool
|
|
24
24
|
access compiled from their grants, groups, and roles. An end user's
|
|
25
25
|
access record is an ashare, so editing its grants and suspending it
|
|
26
|
-
use the `/v1/ashares` routes shared with workspace users.
|
|
26
|
+
use the `/v1/ashares` routes shared with workspace users. The account
|
|
27
|
+
owner is never an end user: owners already have MCP access without an
|
|
28
|
+
end-user record, the invite refuses the owner's address
|
|
29
|
+
(`owner_self_invite_not_allowed`), and the owner never appears in
|
|
30
|
+
these lists.
|
|
27
31
|
|
|
28
32
|
## End user schema
|
|
29
33
|
|
|
@@ -59,7 +63,9 @@ paths:
|
|
|
59
63
|
Returns the account's end users with identity fields (`email`, `name`,
|
|
60
64
|
`lastSignIn`) joined from each user record, plus a computed
|
|
61
65
|
`hasWorkspaceShare` flag indicating whether the same person also holds a
|
|
62
|
-
workspace access record.
|
|
66
|
+
workspace access record. The account owner is never listed: owners
|
|
67
|
+
have MCP access without an end-user record, so none exists for them.
|
|
68
|
+
Requires account owner or administrator access.
|
|
63
69
|
parameters:
|
|
64
70
|
- name: provisionedBy
|
|
65
71
|
in: query
|
|
@@ -124,8 +130,11 @@ paths:
|
|
|
124
130
|
description: |-
|
|
125
131
|
Finds or creates the user by email, creates an end-user access record,
|
|
126
132
|
applies the requested group memberships and direct grants, and sends an
|
|
127
|
-
invite email.
|
|
128
|
-
|
|
133
|
+
invite email. The account owner cannot be invited as an end user
|
|
134
|
+
(`owner_self_invite_not_allowed`): owners already have MCP access
|
|
135
|
+
without an end-user record, so there is nothing to grant — test
|
|
136
|
+
end-user access with a different address. Requires account owner or
|
|
137
|
+
administrator access.
|
|
129
138
|
requestBody:
|
|
130
139
|
required: true
|
|
131
140
|
content:
|
|
@@ -163,7 +172,20 @@ paths:
|
|
|
163
172
|
_ashareId: 68b1c2d3e4f5a6b7c8d9e0f1
|
|
164
173
|
status: invited
|
|
165
174
|
'400':
|
|
166
|
-
|
|
175
|
+
description: |-
|
|
176
|
+
The email is missing or invalid (`email_invalid`), or it is the
|
|
177
|
+
account owner's address (`owner_self_invite_not_allowed` — the owner
|
|
178
|
+
already has MCP access without an end-user record).
|
|
179
|
+
content:
|
|
180
|
+
application/json:
|
|
181
|
+
schema:
|
|
182
|
+
$ref: '#/components/schemas/Error'
|
|
183
|
+
examples:
|
|
184
|
+
ownerSelfInvite:
|
|
185
|
+
value:
|
|
186
|
+
errors:
|
|
187
|
+
- code: owner_self_invite_not_allowed
|
|
188
|
+
message: Account owners cannot be invited as end-users. Owners already have MCP access without an end-user share.
|
|
167
189
|
'401':
|
|
168
190
|
$ref: '#/components/responses/401-unauthorized'
|
|
169
191
|
'403':
|
|
@@ -1403,7 +1425,7 @@ components:
|
|
|
1403
1425
|
x-enumDescriptions:
|
|
1404
1426
|
email_invalid: The email address is not valid
|
|
1405
1427
|
enduser_ashare_exists: An end-user record already exists for this user in the account
|
|
1406
|
-
owner_self_invite_not_allowed:
|
|
1428
|
+
owner_self_invite_not_allowed: The address is the account owner's — owners already have MCP access without an end-user record
|
|
1407
1429
|
validation_failed: The shared groupIds or grants failed validation for this item
|
|
1408
1430
|
invite_failed: An unexpected per-item error, caught so the batch can continue
|
|
1409
1431
|
description: Failure reason. Present when status is `failed`.
|
package/dist/mcp-server.yml
CHANGED
|
@@ -551,8 +551,11 @@ paths:
|
|
|
551
551
|
server and compiles each one's effective tool access with source
|
|
552
552
|
attribution — the union of direct grants, group grants, role grants, and
|
|
553
553
|
permission sets. The result is recomputed on every request rather than
|
|
554
|
-
cached.
|
|
555
|
-
|
|
554
|
+
cached. The account owner is never listed — owners have MCP access
|
|
555
|
+
without an end-user record, so there is no record to compile — and an
|
|
556
|
+
empty result therefore means no end user has been granted this server.
|
|
557
|
+
Requires account owner or administrator access. The per-user view of the
|
|
558
|
+
same compilation is `GET /v1/endusers/{_ashareId}/effective-access`
|
|
556
559
|
(End Users API).
|
|
557
560
|
parameters:
|
|
558
561
|
- name: _id
|
package/dist/sync.yml
CHANGED
|
@@ -2602,9 +2602,10 @@ paths:
|
|
|
2602
2602
|
summary: List supported sync destination applications
|
|
2603
2603
|
description: |-
|
|
2604
2604
|
Returns the catalog of applications that can be used as the **destination** of a sync — the
|
|
2605
|
-
data warehouse a sync loads records into.
|
|
2606
|
-
|
|
2607
|
-
|
|
2605
|
+
data warehouse a sync loads records into. A sync's destination application is the type of
|
|
2606
|
+
its destination connection (`rdbms.type` for warehouse connections), which must match one
|
|
2607
|
+
of the returned ids. Identifiers include `snowflake` (Snowflake), `nsaw` (NetSuite
|
|
2608
|
+
Analytics Warehouse), `bigquery` (Google BigQuery), and `mssql` (Microsoft SQL Server).
|
|
2608
2609
|
tags:
|
|
2609
2610
|
- Syncs
|
|
2610
2611
|
operationId: listSyncDestinations
|
|
@@ -2629,8 +2630,10 @@ paths:
|
|
|
2629
2630
|
examples:
|
|
2630
2631
|
default:
|
|
2631
2632
|
value:
|
|
2632
|
-
- id:
|
|
2633
|
+
- id: bigquery
|
|
2634
|
+
- id: mssql
|
|
2633
2635
|
- id: nsaw
|
|
2636
|
+
- id: snowflake
|
|
2634
2637
|
'401':
|
|
2635
2638
|
$ref: '#/components/responses/401-unauthorized'
|
|
2636
2639
|
/v1/di/metadata/connections/{_connectionId}/datasets:
|
|
@@ -3848,27 +3851,35 @@ components:
|
|
|
3848
3851
|
type: object
|
|
3849
3852
|
description: |-
|
|
3850
3853
|
Data warehouse the sync loads records into. Empty (`{}`) on a draft that has no
|
|
3851
|
-
destination yet.
|
|
3852
|
-
|
|
3853
|
-
|
|
3854
|
+
destination yet. The destination application is the connection's own type
|
|
3855
|
+
(`rdbms.type` for warehouse connections), so `database` and `schema` are read in that
|
|
3856
|
+
application's terms — Google BigQuery treats them as the GCP project and the dataset.
|
|
3857
|
+
Each source + destination host/database/schema combination must be unique across
|
|
3858
|
+
syncs — reusing one fails with `422 duplicate_destination_host` — and all syncs in an
|
|
3859
|
+
integration must target the same destination application type.
|
|
3854
3860
|
properties:
|
|
3855
3861
|
_connectionId:
|
|
3856
3862
|
type: string
|
|
3857
3863
|
format: objectId
|
|
3858
3864
|
x-celigo-refModel: connections
|
|
3859
3865
|
description: |-
|
|
3860
|
-
Connection to the destination warehouse.
|
|
3861
|
-
|
|
3866
|
+
Connection to the destination warehouse. Its application (`rdbms.type` such as
|
|
3867
|
+
`snowflake`, `bigquery` or `mssql`, or a NetSuite Analytics Warehouse JDBC
|
|
3868
|
+
connection) is one of the ids returned by `GET /v1/di/metadata/destinations`.
|
|
3862
3869
|
examples:
|
|
3863
3870
|
- 68d02dbe0839a514623c1d6d
|
|
3864
3871
|
database:
|
|
3865
3872
|
type: string
|
|
3866
|
-
description:
|
|
3873
|
+
description: |-
|
|
3874
|
+
Database in the destination warehouse the sync loads into. For Google BigQuery this
|
|
3875
|
+
is the GCP project id the tables are created in (`project.dataset.table`).
|
|
3867
3876
|
examples:
|
|
3868
3877
|
- ANALYTICS_DB
|
|
3869
3878
|
schema:
|
|
3870
3879
|
type: string
|
|
3871
|
-
description:
|
|
3880
|
+
description: |-
|
|
3881
|
+
Schema within `database` where the sync creates and loads tables. For Google
|
|
3882
|
+
BigQuery this is the dataset name, with case preserved.
|
|
3872
3883
|
examples:
|
|
3873
3884
|
- salesforce_raw
|
|
3874
3885
|
tablePrefix:
|
|
@@ -4017,27 +4028,60 @@ components:
|
|
|
4017
4028
|
description: |-
|
|
4018
4029
|
Data warehouse the sync loads records into. Omit while drafting; a complete
|
|
4019
4030
|
destination (connection, database, schema) is required before the sync can be
|
|
4020
|
-
enabled. The
|
|
4031
|
+
enabled. The destination application is the connection's own type (`rdbms.type`
|
|
4032
|
+
for warehouse connections), so `database` and `schema` are read in that
|
|
4033
|
+
application's terms — Google BigQuery treats them as the GCP project and the
|
|
4034
|
+
dataset. The source + destination host/database/schema combination must be unique
|
|
4021
4035
|
across syncs (`422 duplicate_destination_host`), and all syncs in an integration
|
|
4022
4036
|
must target the same destination application type.
|
|
4037
|
+
x-celigo-ai-guidance:
|
|
4038
|
+
- |-
|
|
4039
|
+
Send the block complete or not at all. A partial block is rejected in the destination's
|
|
4040
|
+
own vocabulary with 422 `invalid_destination_sync_config`: `GCP project is required on
|
|
4041
|
+
sync destination` / `BigQuery dataset is required on sync destination` (BigQuery),
|
|
4042
|
+
`SQL Server database is required on sync destination` / `SQL Server schema is required
|
|
4043
|
+
on sync destination` (Microsoft SQL Server). A partial Snowflake block is not caught
|
|
4044
|
+
by validation — the save reaches the warehouse and fails with Snowflake's own
|
|
4045
|
+
`002003` "Database 'UNDEFINED' does not exist" error.
|
|
4046
|
+
- |-
|
|
4047
|
+
Saving a complete destination connects to the warehouse to create the schema
|
|
4048
|
+
(dataset) when it is missing. An unreachable host or unusable credentials fail the
|
|
4049
|
+
save with the connection's error — 422 `invalid_host` for SQL Server,
|
|
4050
|
+
`big_query_unexpected_error` for BigQuery — and no sync document is created or
|
|
4051
|
+
updated; fix the connection rather than changing database or schema names.
|
|
4052
|
+
- |-
|
|
4053
|
+
Microsoft SQL Server validates `database` and `schema` as identifiers (start with a
|
|
4054
|
+
letter or underscore; letters, digits, underscore or `$`; at most 128 characters) and
|
|
4055
|
+
rejects others with 422 `invalid_destination_sync_config`
|
|
4056
|
+
(`SQL Server schema name is invalid: ...`).
|
|
4023
4057
|
properties:
|
|
4024
4058
|
_connectionId:
|
|
4025
4059
|
type: string
|
|
4026
4060
|
format: objectId
|
|
4027
4061
|
x-celigo-refModel: connections
|
|
4028
4062
|
description: |-
|
|
4029
|
-
Connection to the destination warehouse.
|
|
4030
|
-
|
|
4063
|
+
Connection to the destination warehouse. Its application (`rdbms.type` such as
|
|
4064
|
+
`snowflake`, `bigquery` or `mssql`, or a NetSuite Analytics Warehouse JDBC
|
|
4065
|
+
connection) must be one of the ids returned by `GET /v1/di/metadata/destinations`;
|
|
4066
|
+
any other connection fails with `422 invalid_destination_type`.
|
|
4031
4067
|
examples:
|
|
4032
4068
|
- 68d02dbe0839a514623c1d6d
|
|
4033
4069
|
database:
|
|
4034
4070
|
type: string
|
|
4035
|
-
description:
|
|
4071
|
+
description: |-
|
|
4072
|
+
Database in the destination warehouse the sync loads into; it must already exist.
|
|
4073
|
+
For Google BigQuery this is the GCP project id the tables are created in
|
|
4074
|
+
(`project.dataset.table`).
|
|
4075
|
+
x-celigo-ui-override: For a BigQuery destination the Create Sync wizard shows no database picker and fills this field with the selected connection's rdbms.bigquery.projectId (IO-195900).
|
|
4036
4076
|
examples:
|
|
4037
4077
|
- ANALYTICS_DB
|
|
4038
4078
|
schema:
|
|
4039
4079
|
type: string
|
|
4040
|
-
description:
|
|
4080
|
+
description: |-
|
|
4081
|
+
Schema within `database` where the sync creates and loads tables; created on save
|
|
4082
|
+
when it does not exist. For Google BigQuery this is the dataset name, with case
|
|
4083
|
+
preserved.
|
|
4084
|
+
x-celigo-ui-override: For a BigQuery destination the Create Sync wizard labels this field "dataset" and accepts only letters, digits and underscore (no $), starting with a letter or underscore, at most 1024 characters (IO-195900); Snowflake and NSAW validation is unchanged.
|
|
4041
4085
|
examples:
|
|
4042
4086
|
- salesforce_raw
|
|
4043
4087
|
tablePrefix:
|
package/package.json
CHANGED