@celigo/api-specs 0.2.86 → 0.2.88
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/integration.yml +25 -14
- package/package.json +1 -1
- package/schemas.json +2 -2
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