@celigo/api-specs 0.2.44 → 0.2.46
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 +122 -2
- package/package.json +1 -1
- package/schemas.json +1 -1
package/dist/integration.yml
CHANGED
|
@@ -725,7 +725,9 @@ paths:
|
|
|
725
725
|
'400':
|
|
726
726
|
description: |-
|
|
727
727
|
Revision is not in a diffable state. Error code `invalid_revision_state`. Occurs on
|
|
728
|
-
snapshot revisions (no source to diff against), `canceled` revisions (diff dropped),
|
|
728
|
+
snapshot revisions (no source to diff against), `canceled` revisions (diff dropped),
|
|
729
|
+
`failed` revisions (read their cause from
|
|
730
|
+
`GET /v1/integrations/{_id}/revisions/{_revisionId}/errors` instead), and
|
|
729
731
|
`inprogress` revisions whose install steps haven't materialized yet.
|
|
730
732
|
content:
|
|
731
733
|
application/json:
|
|
@@ -741,6 +743,79 @@ paths:
|
|
|
741
743
|
$ref: '#/components/responses/401-unauthorized'
|
|
742
744
|
'404':
|
|
743
745
|
$ref: '#/components/responses/404-not-found'
|
|
746
|
+
/v1/integrations/{_id}/revisions/{_revisionId}/errors:
|
|
747
|
+
get:
|
|
748
|
+
x-internal: false
|
|
749
|
+
operationId: listIntegrationRevisionErrors
|
|
750
|
+
tags:
|
|
751
|
+
- Integrations
|
|
752
|
+
summary: List a failed revision's errors
|
|
753
|
+
description: |-
|
|
754
|
+
Returns the error records recorded while a `pull` or `revert` revision was being applied — the
|
|
755
|
+
same list the Revisions tab shows for a `failed` revision. Read this, not the diff, to learn why
|
|
756
|
+
a revision failed: `GET /v1/integrations/{_id}/revisions/{_revisionId}/diff` rejects `failed`
|
|
757
|
+
revisions with `invalid_revision_state`. Only `failed` revisions have error records; every
|
|
758
|
+
other state is rejected with the same `invalid_revision_state` code.
|
|
759
|
+
|
|
760
|
+
Each record names the resource the apply step rejected. Ids inside a message use the revision's
|
|
761
|
+
change-set keys: a `LifeCycleError` of the form `<type> - <id> references a deleted resource:
|
|
762
|
+
<type> - <id>.deleted` reports that the merged document still points at an entry the same change
|
|
763
|
+
set marks `.deleted`. The suffix is that marker, not the resource's state in the account — the
|
|
764
|
+
resource may still exist there.
|
|
765
|
+
parameters:
|
|
766
|
+
- name: _id
|
|
767
|
+
in: path
|
|
768
|
+
required: true
|
|
769
|
+
description: Integration id.
|
|
770
|
+
schema:
|
|
771
|
+
type: string
|
|
772
|
+
format: objectId
|
|
773
|
+
x-celigo-refModel: integrations
|
|
774
|
+
examples:
|
|
775
|
+
- 6842261335b64c0bcb308e4f
|
|
776
|
+
- name: _revisionId
|
|
777
|
+
in: path
|
|
778
|
+
required: true
|
|
779
|
+
description: Revision id. Must be a revision in `failed` state.
|
|
780
|
+
schema:
|
|
781
|
+
type: string
|
|
782
|
+
format: objectId
|
|
783
|
+
examples:
|
|
784
|
+
- 6a28d2af6d42eb08f8e863e7
|
|
785
|
+
responses:
|
|
786
|
+
'200':
|
|
787
|
+
description: Error records for the failed revision.
|
|
788
|
+
content:
|
|
789
|
+
application/json:
|
|
790
|
+
schema:
|
|
791
|
+
$ref: '#/components/schemas/RevisionErrorsResponse'
|
|
792
|
+
examples:
|
|
793
|
+
deleted_reference:
|
|
794
|
+
summary: Pull rejected because the merged integration references a removed lookup cache
|
|
795
|
+
value:
|
|
796
|
+
- _id: 6aaceb3c8b19ac878dd7cd41
|
|
797
|
+
code: LifeCycleError
|
|
798
|
+
message: integration - 6a90467b117405485e64787e references a deleted resource:lookupcache - 6aa912fd3ec91536bee07e41.deleted.
|
|
799
|
+
createdAt: '2026-09-18T07:41:37.675Z'
|
|
800
|
+
'400':
|
|
801
|
+
description: |-
|
|
802
|
+
Revision is not in `failed` state, so it has no error records. Error code
|
|
803
|
+
`invalid_revision_state` — returned for `completed`, `canceled`, and `inprogress` revisions
|
|
804
|
+
of every type, including snapshots.
|
|
805
|
+
content:
|
|
806
|
+
application/json:
|
|
807
|
+
schema:
|
|
808
|
+
$ref: '#/components/schemas/Error'
|
|
809
|
+
examples:
|
|
810
|
+
invalid_revision_state:
|
|
811
|
+
value:
|
|
812
|
+
errors:
|
|
813
|
+
- message: Failed to perform operation. Revision is in an invalid state
|
|
814
|
+
code: invalid_revision_state
|
|
815
|
+
'401':
|
|
816
|
+
$ref: '#/components/responses/401-unauthorized'
|
|
817
|
+
'404':
|
|
818
|
+
$ref: '#/components/responses/404-not-found'
|
|
744
819
|
/v1/integrations/{_id}/errors:
|
|
745
820
|
get:
|
|
746
821
|
x-internal: false
|
|
@@ -4515,7 +4590,7 @@ components:
|
|
|
4515
4590
|
x-enumDescriptions:
|
|
4516
4591
|
inprogress: The revision is currently being prepared and can be diffed, applied, or canceled.
|
|
4517
4592
|
completed: The revision has been finalized and applied successfully.
|
|
4518
|
-
failed: The revision
|
|
4593
|
+
failed: The apply step rejected the revision; the recorded errors are returned by `GET /v1/integrations/{_id}/revisions/{_revisionId}/errors`.
|
|
4519
4594
|
canceled: The revision was aborted before being applied.
|
|
4520
4595
|
description:
|
|
4521
4596
|
type: string
|
|
@@ -4541,6 +4616,14 @@ components:
|
|
|
4541
4616
|
`revert` revisions.
|
|
4542
4617
|
examples:
|
|
4543
4618
|
- 7d9e2b4a1c3f5068ab82d4e0fc16937255ab8c40
|
|
4619
|
+
errorFileKey:
|
|
4620
|
+
type: string
|
|
4621
|
+
readOnly: true
|
|
4622
|
+
description: |-
|
|
4623
|
+
Storage key of the error file written when the apply step fails. Present only on `failed`
|
|
4624
|
+
revisions; the file's records are read through `GET /v1/integrations/{_id}/revisions/{_revisionId}/errors`.
|
|
4625
|
+
examples:
|
|
4626
|
+
- a574f7e1294645f68e141ac6ab4eed92
|
|
4544
4627
|
_revertToRevisionId:
|
|
4545
4628
|
type: string
|
|
4546
4629
|
format: objectId
|
|
@@ -4615,6 +4698,43 @@ components:
|
|
|
4615
4698
|
before/after blocks. Treated as an opaque envelope here; specific field layout is not guaranteed
|
|
4616
4699
|
stable across platform versions.
|
|
4617
4700
|
additionalProperties: true
|
|
4701
|
+
RevisionError:
|
|
4702
|
+
type: object
|
|
4703
|
+
description: One error recorded while a revision was being applied.
|
|
4704
|
+
required:
|
|
4705
|
+
- code
|
|
4706
|
+
- message
|
|
4707
|
+
properties:
|
|
4708
|
+
_id:
|
|
4709
|
+
type: string
|
|
4710
|
+
format: objectId
|
|
4711
|
+
description: Error record id; the Revisions tab uses it to open the record's detail view.
|
|
4712
|
+
examples:
|
|
4713
|
+
- 6aaceb3c8b19ac878dd7cd41
|
|
4714
|
+
code:
|
|
4715
|
+
type: string
|
|
4716
|
+
description: Error class assigned by the apply step, such as `LifeCycleError` for change-set consistency failures.
|
|
4717
|
+
examples:
|
|
4718
|
+
- LifeCycleError
|
|
4719
|
+
message:
|
|
4720
|
+
type: string
|
|
4721
|
+
description: |-
|
|
4722
|
+
Human-readable cause. Resource references inside it use the change set's own ids, so a
|
|
4723
|
+
`<id>.deleted` suffix identifies an entry of the revision, not the state of the resource in
|
|
4724
|
+
the account.
|
|
4725
|
+
examples:
|
|
4726
|
+
- integration - 6a90467b117405485e64787e references a deleted resource:lookupcache - 6aa912fd3ec91536bee07e41.deleted.
|
|
4727
|
+
createdAt:
|
|
4728
|
+
type: string
|
|
4729
|
+
format: date-time
|
|
4730
|
+
description: When the error was recorded.
|
|
4731
|
+
examples:
|
|
4732
|
+
- '2026-09-18T07:41:37.675Z'
|
|
4733
|
+
RevisionErrorsResponse:
|
|
4734
|
+
type: array
|
|
4735
|
+
description: Error records for one revision, oldest first.
|
|
4736
|
+
items:
|
|
4737
|
+
$ref: '#/components/schemas/RevisionError'
|
|
4618
4738
|
IntegrationErrorsResponse:
|
|
4619
4739
|
type: array
|
|
4620
4740
|
description: |-
|
package/package.json
CHANGED