@celigo/api-specs 0.2.71 → 0.2.72
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/script.yml +84 -16
- package/package.json +1 -1
- package/schemas.json +2 -2
package/dist/script.yml
CHANGED
|
@@ -361,10 +361,22 @@ paths:
|
|
|
361
361
|
/v1/scripts/{_id}/logs:
|
|
362
362
|
get:
|
|
363
363
|
x-internal: false
|
|
364
|
-
summary: Get
|
|
364
|
+
summary: Get execution logs for a script
|
|
365
365
|
description: |-
|
|
366
|
-
Returns
|
|
367
|
-
|
|
366
|
+
Returns the script's execution log — the entries its `console.*` calls wrote during
|
|
367
|
+
real runs of the flows, APIs and Tools whose steps use the script. `console.log`,
|
|
368
|
+
`console.info`, `console.warn` and `console.error` output is recorded on every real
|
|
369
|
+
run regardless of the parent's logging mode (a flow's log level, an API's request
|
|
370
|
+
logging, a Tool invoke without `x-log-mode`); `console.debug` output is recorded only
|
|
371
|
+
while the script's `debugUntil` is in the future. Entries stay readable after a debug window closes. Test runs
|
|
372
|
+
execute the script but write no entries.
|
|
373
|
+
|
|
374
|
+
The window is read from `time_lte` downward, one time slice at a time, and each
|
|
375
|
+
call returns one slice. A response with an empty `logs` array **and** a
|
|
376
|
+
`nextPageURL` means that slice held nothing while the rest of the window is still
|
|
377
|
+
unread — follow the cursor until a response arrives without one. Only an empty
|
|
378
|
+
`logs` array with no `nextPageURL` means the window holds no entries. To read a
|
|
379
|
+
known run in one call, set `time_lte` a few seconds after the run ended.
|
|
368
380
|
tags:
|
|
369
381
|
- Scripts
|
|
370
382
|
operationId: getScriptLogs
|
|
@@ -377,9 +389,47 @@ paths:
|
|
|
377
389
|
type: string
|
|
378
390
|
format: objectId
|
|
379
391
|
x-celigo-refModel: scripts
|
|
392
|
+
- name: time_lte
|
|
393
|
+
in: query
|
|
394
|
+
required: false
|
|
395
|
+
description: |-
|
|
396
|
+
Upper bound of the time window (inclusive), as epoch milliseconds. Defaults to now if
|
|
397
|
+
omitted. Reading starts here and proceeds backward.
|
|
398
|
+
schema:
|
|
399
|
+
type: integer
|
|
400
|
+
format: int64
|
|
401
|
+
- name: time_gt
|
|
402
|
+
in: query
|
|
403
|
+
required: false
|
|
404
|
+
description: Lower bound of the time window (exclusive), as epoch milliseconds.
|
|
405
|
+
schema:
|
|
406
|
+
type: integer
|
|
407
|
+
format: int64
|
|
408
|
+
- name: _flowId
|
|
409
|
+
in: query
|
|
410
|
+
required: false
|
|
411
|
+
description: |-
|
|
412
|
+
Restricts entries to hooks that ran inside this parent. Despite the name it matches
|
|
413
|
+
the containing flow, API, or Tool alike — pass whichever the hook step lives in.
|
|
414
|
+
schema:
|
|
415
|
+
type: string
|
|
416
|
+
format: objectId
|
|
417
|
+
- name: _resourceId
|
|
418
|
+
in: query
|
|
419
|
+
required: false
|
|
420
|
+
description: Restricts entries to hooks that ran on this export or import step.
|
|
421
|
+
schema:
|
|
422
|
+
type: string
|
|
423
|
+
format: objectId
|
|
424
|
+
- name: functionType
|
|
425
|
+
in: query
|
|
426
|
+
required: false
|
|
427
|
+
description: Restricts entries to one hook type (for example `preMap` or `postResponseMap`).
|
|
428
|
+
schema:
|
|
429
|
+
type: string
|
|
380
430
|
responses:
|
|
381
431
|
'200':
|
|
382
|
-
description:
|
|
432
|
+
description: One slice of the script's execution log.
|
|
383
433
|
content:
|
|
384
434
|
application/json:
|
|
385
435
|
schema:
|
|
@@ -387,18 +437,20 @@ paths:
|
|
|
387
437
|
properties:
|
|
388
438
|
logs:
|
|
389
439
|
type: array
|
|
390
|
-
description:
|
|
440
|
+
description: |-
|
|
441
|
+
Entries from the slice that was read, newest first. Empty when the slice held
|
|
442
|
+
nothing — check `nextPageURL` before treating that as an empty window.
|
|
391
443
|
items:
|
|
392
444
|
type: object
|
|
393
445
|
properties:
|
|
394
446
|
time:
|
|
395
447
|
type: string
|
|
396
|
-
description:
|
|
448
|
+
description: UTC timestamp when the entry was written.
|
|
397
449
|
examples:
|
|
398
450
|
- '2026-05-22 01:24:38.697'
|
|
399
451
|
functionType:
|
|
400
452
|
type: string
|
|
401
|
-
description: Hook type that produced the
|
|
453
|
+
description: Hook type that produced the entry.
|
|
402
454
|
examples:
|
|
403
455
|
- preSavePage
|
|
404
456
|
_resourceId:
|
|
@@ -409,23 +461,33 @@ paths:
|
|
|
409
461
|
- 6843b67b35b64c0bcba2fd69
|
|
410
462
|
logLevel:
|
|
411
463
|
type: string
|
|
412
|
-
description: Severity
|
|
464
|
+
description: Severity of the entry, derived from the `console` method that wrote it.
|
|
413
465
|
enum:
|
|
414
466
|
- INFO
|
|
415
467
|
- WARN
|
|
416
468
|
- ERROR
|
|
469
|
+
- DEBUG
|
|
417
470
|
x-enumDescriptions:
|
|
418
|
-
INFO: Output from `console.log()
|
|
419
|
-
WARN: Output from `console.warn()
|
|
420
|
-
ERROR: Output from `console.error()
|
|
471
|
+
INFO: Output from `console.log()` or `console.info()`
|
|
472
|
+
WARN: Output from `console.warn()`
|
|
473
|
+
ERROR: Output from `console.error()`
|
|
474
|
+
DEBUG: Output from `console.debug()`, recorded only while `debugUntil` is in the future
|
|
421
475
|
message:
|
|
422
476
|
type: string
|
|
423
477
|
description: Log message content.
|
|
424
478
|
examples:
|
|
425
479
|
- test log message from preSavePage
|
|
480
|
+
nextPageURL:
|
|
481
|
+
type: string
|
|
482
|
+
description: |-
|
|
483
|
+
Path of the next slice to read, carrying the same filters with `time_lte` moved
|
|
484
|
+
back to the slice boundary. Present whenever unread window remains — including
|
|
485
|
+
when `logs` is empty. Absent once the window is exhausted.
|
|
486
|
+
examples:
|
|
487
|
+
- /v1/scripts/6843b67b35b64c0bcba2fd69/logs?time_gt=1790869357487&time_lte=1790955400000
|
|
426
488
|
examples:
|
|
427
489
|
withLogs:
|
|
428
|
-
summary:
|
|
490
|
+
summary: Slice with entries
|
|
429
491
|
value:
|
|
430
492
|
logs:
|
|
431
493
|
- time: '2026-05-22 01:24:38.697'
|
|
@@ -438,8 +500,13 @@ paths:
|
|
|
438
500
|
_resourceId: 6843b67b35b64c0bcba2fd69
|
|
439
501
|
logLevel: INFO
|
|
440
502
|
message: test log message from preSavePage
|
|
503
|
+
emptySliceMoreToRead:
|
|
504
|
+
summary: Empty slice, window not exhausted — follow the cursor
|
|
505
|
+
value:
|
|
506
|
+
logs: []
|
|
507
|
+
nextPageURL: /v1/scripts/6843b67b35b64c0bcba2fd69/logs?time_gt=1790869357487&time_lte=1790955400000
|
|
441
508
|
empty:
|
|
442
|
-
summary:
|
|
509
|
+
summary: Window exhausted, no entries
|
|
443
510
|
value:
|
|
444
511
|
logs: []
|
|
445
512
|
'401':
|
|
@@ -451,10 +518,11 @@ paths:
|
|
|
451
518
|
operationId: deleteScriptLogs
|
|
452
519
|
tags:
|
|
453
520
|
- Scripts
|
|
454
|
-
summary: Delete
|
|
521
|
+
summary: Delete execution logs for a script
|
|
455
522
|
description: |-
|
|
456
|
-
Deletes
|
|
457
|
-
|
|
523
|
+
Deletes every entry in the script's execution log — the same action as the script
|
|
524
|
+
page's Clear logs. Synchronous and idempotent; succeeds when the script has no
|
|
525
|
+
entries. The only way, apart from account retention, that entries leave the log.
|
|
458
526
|
parameters:
|
|
459
527
|
- name: _id
|
|
460
528
|
in: path
|
package/package.json
CHANGED