@celigo/api-specs 0.2.85 → 0.2.87
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/filestorage.yml +81 -38
- package/dist/integration.yml +25 -14
- package/package.json +1 -1
- package/schemas.json +2 -2
package/dist/filestorage.yml
CHANGED
|
@@ -1658,6 +1658,11 @@ paths:
|
|
|
1658
1658
|
summary: Move to the account root
|
|
1659
1659
|
value:
|
|
1660
1660
|
_parentId: null
|
|
1661
|
+
renameOnMove:
|
|
1662
|
+
summary: Move into a folder and rename to avoid a collision
|
|
1663
|
+
value:
|
|
1664
|
+
_parentId: 684c3b1f2d4e6g002b0h9c34
|
|
1665
|
+
name: inv-001 (1).pdf
|
|
1661
1666
|
responses:
|
|
1662
1667
|
'200':
|
|
1663
1668
|
description: |-
|
|
@@ -1695,6 +1700,23 @@ paths:
|
|
|
1695
1700
|
x-celigo-refModel: storageitems
|
|
1696
1701
|
examples:
|
|
1697
1702
|
- - 684c3b1f2d4e6g002b0h9c34
|
|
1703
|
+
_integrationId:
|
|
1704
|
+
type:
|
|
1705
|
+
- string
|
|
1706
|
+
- 'null'
|
|
1707
|
+
format: objectId
|
|
1708
|
+
x-celigo-refModel: integrations
|
|
1709
|
+
description: |-
|
|
1710
|
+
The item's integration after the move — the destination's
|
|
1711
|
+
integration when it landed inside an integration's system
|
|
1712
|
+
folder tree, null when it landed outside one.
|
|
1713
|
+
examples:
|
|
1714
|
+
- 6ab1e7ab38d7733b4594d0d2
|
|
1715
|
+
name:
|
|
1716
|
+
type: string
|
|
1717
|
+
description: Name of the moved item.
|
|
1718
|
+
examples:
|
|
1719
|
+
- inv-001.pdf
|
|
1698
1720
|
examples:
|
|
1699
1721
|
default:
|
|
1700
1722
|
value:
|
|
@@ -1702,6 +1724,8 @@ paths:
|
|
|
1702
1724
|
_parentId: 684c3b1f2d4e6g002b0h9c34
|
|
1703
1725
|
__ancestorIds:
|
|
1704
1726
|
- 684c3b1f2d4e6g002b0h9c34
|
|
1727
|
+
_integrationId: null
|
|
1728
|
+
name: inv-001.pdf
|
|
1705
1729
|
'400':
|
|
1706
1730
|
$ref: '#/components/responses/400-bad-request'
|
|
1707
1731
|
'401':
|
|
@@ -2150,9 +2174,9 @@ paths:
|
|
|
2150
2174
|
x-internal: false
|
|
2151
2175
|
summary: Get storage usage by environment
|
|
2152
2176
|
description: |-
|
|
2153
|
-
Returns the
|
|
2154
|
-
|
|
2155
|
-
account's shared quota.
|
|
2177
|
+
Returns storage usage per environment, with the account-wide total and
|
|
2178
|
+
the quota figures `GET /v1/storage/usage` reports. Use it to see which
|
|
2179
|
+
environment is consuming the account's shared quota.
|
|
2156
2180
|
operationId: getStorageUsageByEnvironment
|
|
2157
2181
|
tags:
|
|
2158
2182
|
- File Storage
|
|
@@ -2177,18 +2201,18 @@ paths:
|
|
|
2177
2201
|
default:
|
|
2178
2202
|
value:
|
|
2179
2203
|
environments:
|
|
2180
|
-
-
|
|
2181
|
-
|
|
2204
|
+
- environment:
|
|
2205
|
+
_id: 60a1b2c3d4e5f6001a2b3c4d
|
|
2206
|
+
name: Production
|
|
2182
2207
|
activeUsage: 429496729
|
|
2183
2208
|
recycleBinUsage: 52428800
|
|
2184
2209
|
totalUsage: 481925529
|
|
2185
|
-
-
|
|
2186
|
-
|
|
2210
|
+
- environment:
|
|
2211
|
+
_id: 60a1b2c3d4e5f6001a2b3c4e
|
|
2212
|
+
name: Sandbox
|
|
2187
2213
|
activeUsage: 107374182
|
|
2188
2214
|
recycleBinUsage: 52428800
|
|
2189
2215
|
totalUsage: 159802982
|
|
2190
|
-
activeUsage: 536870912
|
|
2191
|
-
recycleBinUsage: 104857600
|
|
2192
2216
|
totalUsage: 641728512
|
|
2193
2217
|
maxAllowedUsage: 1073741824
|
|
2194
2218
|
isOverage: false
|
|
@@ -2831,6 +2855,19 @@ components:
|
|
|
2831
2855
|
type: string
|
|
2832
2856
|
format: objectId
|
|
2833
2857
|
x-celigo-refModel: storageitems
|
|
2858
|
+
_integrationId:
|
|
2859
|
+
type:
|
|
2860
|
+
- string
|
|
2861
|
+
- 'null'
|
|
2862
|
+
format: objectId
|
|
2863
|
+
x-celigo-refModel: integrations
|
|
2864
|
+
description: |-
|
|
2865
|
+
The item's integration after the move — the destination's
|
|
2866
|
+
integration when it landed inside an integration's system folder
|
|
2867
|
+
tree, null when it landed outside one. Present on success.
|
|
2868
|
+
name:
|
|
2869
|
+
type: string
|
|
2870
|
+
description: Name of the moved item (the new name when `name` was sent). Present on success.
|
|
2834
2871
|
type:
|
|
2835
2872
|
type: string
|
|
2836
2873
|
enum:
|
|
@@ -2970,6 +3007,15 @@ components:
|
|
|
2970
3007
|
the item itself or one of its descendants.
|
|
2971
3008
|
examples:
|
|
2972
3009
|
- 684c3b1f2d4e6g002b0h9c34
|
|
3010
|
+
name:
|
|
3011
|
+
type: string
|
|
3012
|
+
maxLength: 256
|
|
3013
|
+
description: |-
|
|
3014
|
+
New name applied to the item in the same write as the re-parent, so
|
|
3015
|
+
a name already taken in the destination can be resolved without a
|
|
3016
|
+
second call. Omit to keep the current name.
|
|
3017
|
+
examples:
|
|
3018
|
+
- inv-001 (1).pdf
|
|
2973
3019
|
CopyRequest:
|
|
2974
3020
|
type: object
|
|
2975
3021
|
description: Request body for copying a file.
|
|
@@ -3192,22 +3238,31 @@ components:
|
|
|
3192
3238
|
type: object
|
|
3193
3239
|
description: Storage usage for a single environment.
|
|
3194
3240
|
required:
|
|
3195
|
-
-
|
|
3241
|
+
- environment
|
|
3196
3242
|
- activeUsage
|
|
3197
3243
|
- recycleBinUsage
|
|
3198
3244
|
- totalUsage
|
|
3199
3245
|
properties:
|
|
3200
|
-
|
|
3201
|
-
type:
|
|
3202
|
-
|
|
3203
|
-
|
|
3204
|
-
|
|
3205
|
-
-
|
|
3206
|
-
|
|
3207
|
-
|
|
3208
|
-
|
|
3209
|
-
|
|
3210
|
-
|
|
3246
|
+
environment:
|
|
3247
|
+
type: object
|
|
3248
|
+
description: Environment the usage belongs to.
|
|
3249
|
+
required:
|
|
3250
|
+
- _id
|
|
3251
|
+
- name
|
|
3252
|
+
properties:
|
|
3253
|
+
_id:
|
|
3254
|
+
type: string
|
|
3255
|
+
format: objectId
|
|
3256
|
+
x-celigo-refModel: environments
|
|
3257
|
+
description: Environment id, as returned by `GET /v1/environments`.
|
|
3258
|
+
examples:
|
|
3259
|
+
- 60a1b2c3d4e5f6001a2b3c4d
|
|
3260
|
+
name:
|
|
3261
|
+
type: string
|
|
3262
|
+
description: Environment display name.
|
|
3263
|
+
examples:
|
|
3264
|
+
- Production
|
|
3265
|
+
- Sandbox
|
|
3211
3266
|
activeUsage:
|
|
3212
3267
|
type: integer
|
|
3213
3268
|
format: int64
|
|
@@ -3229,12 +3284,12 @@ components:
|
|
|
3229
3284
|
UsageEnvironments:
|
|
3230
3285
|
type: object
|
|
3231
3286
|
description: |-
|
|
3232
|
-
Per-environment usage breakdown alongside the
|
|
3233
|
-
returned by `GET /v1/storage/usage`.
|
|
3287
|
+
Per-environment usage breakdown alongside the account-wide quota
|
|
3288
|
+
figures returned by `GET /v1/storage/usage`. The active / recycle-bin
|
|
3289
|
+
split is reported per environment; the account-wide total is the sum
|
|
3290
|
+
of the rows.
|
|
3234
3291
|
required:
|
|
3235
3292
|
- environments
|
|
3236
|
-
- activeUsage
|
|
3237
|
-
- recycleBinUsage
|
|
3238
3293
|
- totalUsage
|
|
3239
3294
|
- maxAllowedUsage
|
|
3240
3295
|
- isOverage
|
|
@@ -3246,22 +3301,10 @@ components:
|
|
|
3246
3301
|
description: One entry per environment in the account.
|
|
3247
3302
|
items:
|
|
3248
3303
|
$ref: '#/components/schemas/EnvironmentUsage'
|
|
3249
|
-
activeUsage:
|
|
3250
|
-
type: integer
|
|
3251
|
-
format: int64
|
|
3252
|
-
description: Account-wide bytes consumed by active and pending files.
|
|
3253
|
-
examples:
|
|
3254
|
-
- 536870912
|
|
3255
|
-
recycleBinUsage:
|
|
3256
|
-
type: integer
|
|
3257
|
-
format: int64
|
|
3258
|
-
description: Account-wide bytes consumed by soft-deleted files.
|
|
3259
|
-
examples:
|
|
3260
|
-
- 104857600
|
|
3261
3304
|
totalUsage:
|
|
3262
3305
|
type: integer
|
|
3263
3306
|
format: int64
|
|
3264
|
-
description: Account-wide
|
|
3307
|
+
description: Account-wide bytes consumed by active, pending and soft-deleted files across every environment.
|
|
3265
3308
|
examples:
|
|
3266
3309
|
- 641728512
|
|
3267
3310
|
systemUsage:
|
package/dist/integration.yml
CHANGED
|
@@ -25,7 +25,9 @@ tags:
|
|
|
25
25
|
- **Standard integrations** — user-created containers that group custom flows.
|
|
26
26
|
- **Integration App installations** — created from a published connector/template,
|
|
27
27
|
with install/uninstall steps, settings forms, editions, and optional child
|
|
28
|
-
integrations.
|
|
28
|
+
integrations. `_connectorId` is what identifies one. The wizard fields (`mode`,
|
|
29
|
+
`install`, `installSteps`) also appear on a standard integration created by the
|
|
30
|
+
UI's clone-and-install, so they do not by themselves mean Integration App.
|
|
29
31
|
|
|
30
32
|
Integrations support **Integration Lifecycle Management (ILM)**: clone an integration
|
|
31
33
|
across environments, then use revisions (snapshot, pull, revert) to promote changes
|
|
@@ -99,8 +101,10 @@ paths:
|
|
|
99
101
|
summary: Create an integration
|
|
100
102
|
description: |-
|
|
101
103
|
Creates a new integration. Only `name` is required — the server populates all other
|
|
102
|
-
fields with defaults. Do not include
|
|
103
|
-
|
|
104
|
+
fields with defaults. Do not include `_connectorId` unless you are creating an
|
|
105
|
+
Integration App installation, or `_templateId` unless the integration is created from
|
|
106
|
+
a template; leave the install-wizard fields (`mode`, `install`, `installSteps`) to the
|
|
107
|
+
platform's installers.
|
|
104
108
|
operationId: createIntegration
|
|
105
109
|
tags:
|
|
106
110
|
- Integrations
|
|
@@ -3418,16 +3422,18 @@ components:
|
|
|
3418
3422
|
examples:
|
|
3419
3423
|
- 5c1a7b8d4f2e6a0011556677
|
|
3420
3424
|
description: |-
|
|
3421
|
-
|
|
3425
|
+
Marketplace template this integration was installed from. Absent on integrations built from scratch and on
|
|
3426
|
+
clones. It does not make the integration an Integration App — `_connectorId` does.
|
|
3422
3427
|
|
|
3423
3428
|
Omit unless you are creating/updating an integration from a template.
|
|
3424
3429
|
install:
|
|
3425
3430
|
type: array
|
|
3426
3431
|
description: |-
|
|
3427
|
-
Install "cards"
|
|
3432
|
+
Install "cards" an Integration App installer shows during installation — UI workflow metadata, not runtime
|
|
3433
|
+
configuration. The platform also writes it (empty) on a plain custom integration created by the UI's
|
|
3434
|
+
clone-and-install, so its presence does not indicate an Integration App.
|
|
3428
3435
|
|
|
3429
|
-
|
|
3430
|
-
omit this field.
|
|
3436
|
+
Unless you are explicitly modeling an install experience, omit this field.
|
|
3431
3437
|
items:
|
|
3432
3438
|
type: object
|
|
3433
3439
|
additionalProperties: true
|
|
@@ -3502,17 +3508,19 @@ components:
|
|
|
3502
3508
|
mode:
|
|
3503
3509
|
type: string
|
|
3504
3510
|
description: |-
|
|
3505
|
-
|
|
3511
|
+
Where the integration stands in its install or uninstall wizard. The platform writes it on a plain custom
|
|
3512
|
+
integration created by the UI's clone-and-install as much as on an Integration App, and leaves it set after
|
|
3513
|
+
the wizard completes, so it does not indicate an Integration App (`_connectorId` does).
|
|
3506
3514
|
|
|
3507
|
-
|
|
3515
|
+
Omit when creating an integration directly.
|
|
3508
3516
|
enum:
|
|
3509
3517
|
- install
|
|
3510
3518
|
- settings
|
|
3511
3519
|
- uninstall
|
|
3512
3520
|
x-enumDescriptions:
|
|
3513
|
-
install:
|
|
3514
|
-
settings:
|
|
3515
|
-
uninstall: The integration is being uninstalled
|
|
3521
|
+
install: Install steps are still pending and the UI shows the setup wizard
|
|
3522
|
+
settings: Setup is complete and the integration is in normal use
|
|
3523
|
+
uninstall: The integration is being uninstalled
|
|
3516
3524
|
examples:
|
|
3517
3525
|
- install
|
|
3518
3526
|
settings:
|
|
@@ -3634,9 +3642,12 @@ components:
|
|
|
3634
3642
|
installSteps:
|
|
3635
3643
|
type: array
|
|
3636
3644
|
description: |-
|
|
3637
|
-
Ordered
|
|
3645
|
+
Ordered steps of the install wizard that created this integration, each marked completed as it finishes.
|
|
3646
|
+
Written by the UI's clone-and-install of a plain custom integration (a `template_zip` step with `isClone`
|
|
3647
|
+
true) as well as by Integration App installers, and kept after completion — so a populated list does not
|
|
3648
|
+
indicate an Integration App.
|
|
3638
3649
|
|
|
3639
|
-
|
|
3650
|
+
Omit unless you are building an installer.
|
|
3640
3651
|
items:
|
|
3641
3652
|
type: object
|
|
3642
3653
|
additionalProperties: true
|
package/package.json
CHANGED