Skip to content

Commit a8faca6

Browse files
committed
Update compose and env examples.
1 parent 85e2dfd commit a8faca6

File tree

3 files changed

+10
-5
lines changed

3 files changed

+10
-5
lines changed

doc_api/.env_example

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,8 @@ JOB_MAX_ATTEMPTS=3
5353

5454
# validate uploaded files configuration (valid XML and IMAGE decodable by OpenCV is always checked)
5555
RESULT_ZIP_VALIDATION=true
56+
ARTIFACTS_ZIP_VALIDATION=true
57+
ENGINE_FILES_ZIP_VALIDATION=true
5658

5759
ALTO_VALIDATE_ROOT=true
5860
ALTO_VALIDATE_NAMESPACE=false

doc_api/api/schemas/base_objects.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ class JobProper(BaseModel):
184184
class JobWithEngine(JobProper):
185185
engine_name: Optional[str] = Field(
186186
None,
187-
examples=["OCR Engine X"],
187+
examples=["Engine A"],
188188
description="Name of the engine assigned to this job."
189189
)
190190
engine_version: Optional[str] = Field(
@@ -462,7 +462,7 @@ class Engine(BaseModel):
462462
name: str = Field(
463463
...,
464464
description="Name of the engine.",
465-
examples=["OCR Engine X"],
465+
examples=["Engine A"],
466466
)
467467
version: str = Field(
468468
...,
@@ -512,7 +512,7 @@ class EngineNew(BaseModel):
512512
name: str = Field(
513513
...,
514514
description="Name of the engine.",
515-
examples=["OCR Engine X"],
515+
examples=["Engine A"],
516516
)
517517
version: str = Field(
518518
...,
@@ -547,7 +547,7 @@ class EngineUpdate(BaseModel):
547547
name: Optional[str] = Field(
548548
None,
549549
description="Name of the engine.",
550-
examples=["OCR Engine X"],
550+
examples=["Engine A"],
551551
)
552552
version: Optional[str] = Field(
553553
None,

doc_api/compose.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ services:
2727
The images must have specified extensions (e.g., `.jpg`, `.png`) in their names.
2828
2929
Do not use `alto_required` together with `page_required`, unless your processing worker supports both formats.
30+
31+
Optionally, you can specify `engine_name` to select a specific processing engine. Default engine will be used if not specified.
3032
JOB_DEFINITION_EXAMPLES: |
3133
{
3234
"IMAGE job": {
@@ -39,7 +41,8 @@ services:
3941
],
4042
"meta_json_required": false,
4143
"alto_required": false,
42-
"page_required": false
44+
"page_required": false,
45+
"engine_name": "Engine A"
4346
}
4447
}
4548
}

0 commit comments

Comments
 (0)