@celigo/api-specs 0.2.4 → 0.2.6
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/filedefinition.yml +30 -0
- package/dist/job.yml +8 -0
- package/package.json +1 -1
- package/schemas.json +2 -2
package/dist/filedefinition.yml
CHANGED
|
@@ -578,8 +578,38 @@ components:
|
|
|
578
578
|
profile, e.g. `{{{ediProfile.isa01}}}` or
|
|
579
579
|
`{{{ediProfile.tpInterchangeId}}}`.
|
|
580
580
|
|
|
581
|
+
The linked EDI profile's fields resolve under
|
|
582
|
+
`ediProfile.*`. X12 profiles: `isa01`, `isa02`, `isa03`,
|
|
583
|
+
`isa04`, `tpIdQualifier`, `tpInterchangeId`, `myIdQualifier`,
|
|
584
|
+
`myInterchangeId`, `isa11`, `isa12`, `isa14`, `isa15`,
|
|
585
|
+
`isa16`, `tpGroupId`, `myGroupId`, `gs07`, `gs08`. EDIFACT
|
|
586
|
+
profiles: `unb010_0001`, `unb010_0002`, `tpIdQualifier`,
|
|
587
|
+
`myIdQualifier`, `tpInterchangeId`, `myInterchangeId`,
|
|
588
|
+
`versionNumber`, `releaseNumber`, `controllingAgency`. Both
|
|
589
|
+
standards also expose the profile's `name`, `description`,
|
|
590
|
+
`fileType`, and `controlNumber` (the rolling interchange
|
|
591
|
+
control number — for generate-direction control-number
|
|
592
|
+
positions such as ISA13). There are no `isa05`–`isa08`
|
|
593
|
+
keys: the sender/receiver qualifier and ID positions bind to
|
|
594
|
+
`tpIdQualifier` / `tpInterchangeId` / `myIdQualifier` /
|
|
595
|
+
`myInterchangeId` (`tp*` is the trading partner's identity,
|
|
596
|
+
`my*` is yours — which pair lands in ISA05/06 vs ISA07/08
|
|
597
|
+
depends on who sends the document). Field meanings are
|
|
598
|
+
documented in the EDI Profiles spec.
|
|
599
|
+
|
|
581
600
|
Use triple-stash (`{{{...}}}`) to avoid HTML escaping for
|
|
582
601
|
EDI control characters.
|
|
602
|
+
x-celigo-ai-guidance:
|
|
603
|
+
- |-
|
|
604
|
+
Never extrapolate positional profile keys: ISA05-ISA08 have no
|
|
605
|
+
isaNN key — bind them to tpIdQualifier, tpInterchangeId,
|
|
606
|
+
myIdQualifier, myInterchangeId, choosing the tp*/my* pair by
|
|
607
|
+
document direction (tp* = trading partner's identity).
|
|
608
|
+
- |-
|
|
609
|
+
A referenceValue naming a key outside the profile's field set
|
|
610
|
+
saves without error but fails at parse/preview time with
|
|
611
|
+
"Handlebar expression pattern is incorrect. Please correct it
|
|
612
|
+
to an appropriate pattern for : <key>".
|
|
583
613
|
examples:
|
|
584
614
|
- '{{{ediProfile.isa01}}}'
|
|
585
615
|
- '{{{ediProfile.tpInterchangeId}}}'
|
package/dist/job.yml
CHANGED
|
@@ -1707,8 +1707,16 @@ components:
|
|
|
1707
1707
|
Omitting `time_gt` does not mean "all history" — the endpoint falls back to the dashboard's
|
|
1708
1708
|
default window (approximately the last 24 hours), and runs older than that silently drop out
|
|
1709
1709
|
of every aggregate. Send `time_gt` (epoch milliseconds) explicitly for any other range.
|
|
1710
|
+
|
|
1711
|
+
`time_lte` must not be later than the current time: a future value is rejected with
|
|
1712
|
+
`400 invalid_filter_request_body` (unlike `POST /v1/jobs/current`, which accepts it). Omit
|
|
1713
|
+
`time_lte` to end the window at now. When both bounds are sent they must be at least one hour
|
|
1714
|
+
apart (`time_lte - time_gt >= 3600000`), or the request is rejected with
|
|
1715
|
+
`400 invalid_time_filter`; a window with `time_gt` alone has no minimum span.
|
|
1710
1716
|
x-celigo-ai-guidance:
|
|
1711
1717
|
- Always send an explicit time_gt matching the window you intend to report, and never present the aggregates as covering a longer period than the time filter you sent. Without time_gt the default window (~24 hours) applies — an empty result then means "nothing ran recently", never "no runs exist".
|
|
1718
|
+
- For a window that runs through the present, omit time_lte rather than computing an end bound — a value even seconds ahead of the server clock (a rounded-up "now", end of today) fails the whole request with 400 invalid_filter_request_body.
|
|
1719
|
+
- A closed window narrower than one hour cannot be queried; widen time_lte to time_gt + one hour (and say so when reporting) rather than sending the narrower range.
|
|
1712
1720
|
- A flow absent from stats[] had no runs in the window; it does not mean the flow does not exist. numOpenError counts errors open NOW, which may predate the window.
|
|
1713
1721
|
FlowRunStatsEntry:
|
|
1714
1722
|
type: object
|
package/package.json
CHANGED