@celigo/api-specs 0.2.174 → 0.2.175
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/filedefinitionrules.yml +18 -10
- package/package.json +1 -1
- package/schemas.json +1 -1
|
@@ -359,16 +359,20 @@ components:
|
|
|
359
359
|
type: string
|
|
360
360
|
description: |-
|
|
361
361
|
Base64-encoded EDI specification PDF. Must decode to a text-bearing
|
|
362
|
-
PDF
|
|
363
|
-
`
|
|
364
|
-
with `
|
|
362
|
+
PDF: a scanned or image-only document is accepted, and the job then
|
|
363
|
+
fails with `DETECTION_FAILED`. A value that isn't base64 or doesn't
|
|
364
|
+
decode to a PDF is rejected with `422 PDF_EXTRACTION_FAILED`, and
|
|
365
|
+
encoded payloads over 50 MB with `413 PAYLOAD_TOO_LARGE`.
|
|
365
366
|
documentType:
|
|
366
367
|
type: integer
|
|
367
368
|
description: |-
|
|
368
369
|
X12 transaction set number (e.g. 850), or 0 to auto-detect an
|
|
369
370
|
EDIFACT specification from the PDF contents. Values outside the
|
|
370
371
|
supported set fail with `400 INVALID_DOCUMENT_TYPE`; discover the
|
|
371
|
-
supported set via `GET /v1/filedefinitionrules/document-types`.
|
|
372
|
+
supported set via `GET /v1/filedefinitionrules/document-types`. A
|
|
373
|
+
supported value that names a different transaction set than the PDF
|
|
374
|
+
(an 850 guide submitted as 810) is accepted, and the job then fails
|
|
375
|
+
with `INVALID_DOCUMENT_TYPE`.
|
|
372
376
|
examples:
|
|
373
377
|
- 850
|
|
374
378
|
ErrorCode:
|
|
@@ -388,7 +392,7 @@ components:
|
|
|
388
392
|
- GENERATION_FAILED
|
|
389
393
|
- SERVICE_UNAVAILABLE
|
|
390
394
|
x-enumDescriptions:
|
|
391
|
-
INVALID_DOCUMENT_TYPE: documentType is not 0 and not a supported X12 set
|
|
395
|
+
INVALID_DOCUMENT_TYPE: documentType is not 0 and not a supported X12 set (400), or a failed job's PDF is not the submitted documentType
|
|
392
396
|
INVALID_REQUEST: Request body failed schema validation
|
|
393
397
|
UNAUTHORIZED: Missing or non-Bearer Authorization header
|
|
394
398
|
FORBIDDEN: Invalid, expired, or insufficient token or AShare
|
|
@@ -397,7 +401,7 @@ components:
|
|
|
397
401
|
RATE_LIMIT_EXCEEDED: Caller exceeded the endpoint token bucket
|
|
398
402
|
PDF_EXTRACTION_FAILED: pdf is not valid base64 or not a PDF
|
|
399
403
|
UNSUPPORTED_TYPE: Worker could not generate an FDR for the detected type
|
|
400
|
-
DETECTION_FAILED: Worker could not classify the PDF as X12 or EDIFACT
|
|
404
|
+
DETECTION_FAILED: Worker could not classify the PDF as X12 or EDIFACT, including a PDF with no text (a scanned or image-only one)
|
|
401
405
|
GENERATION_FAILED: Unexpected pipeline or server failure
|
|
402
406
|
SERVICE_UNAVAILABLE: Job store or PDF storage is unavailable
|
|
403
407
|
ErrorItem:
|
|
@@ -499,8 +503,10 @@ components:
|
|
|
499
503
|
code:
|
|
500
504
|
type: string
|
|
501
505
|
description: |-
|
|
502
|
-
Failure code — typically
|
|
503
|
-
|
|
506
|
+
Failure code — typically DETECTION_FAILED (no text to read, as in
|
|
507
|
+
a scanned or image-only PDF, or not recognizably X12 or EDIFACT),
|
|
508
|
+
INVALID_DOCUMENT_TYPE (the PDF is for a different transaction set
|
|
509
|
+
than `documentType`), UNSUPPORTED_TYPE, or GENERATION_FAILED.
|
|
504
510
|
examples:
|
|
505
511
|
- UNSUPPORTED_TYPE
|
|
506
512
|
message:
|
|
@@ -567,8 +573,10 @@ components:
|
|
|
567
573
|
code:
|
|
568
574
|
type: string
|
|
569
575
|
description: |-
|
|
570
|
-
Failure code — typically
|
|
571
|
-
|
|
576
|
+
Failure code — typically DETECTION_FAILED (no text to read, as in
|
|
577
|
+
a scanned or image-only PDF, or not recognizably X12 or EDIFACT),
|
|
578
|
+
INVALID_DOCUMENT_TYPE (the PDF is for a different transaction set
|
|
579
|
+
than `documentType`), UNSUPPORTED_TYPE, or GENERATION_FAILED.
|
|
572
580
|
message:
|
|
573
581
|
type: string
|
|
574
582
|
description: Human-readable failure reason.
|
package/package.json
CHANGED