Skip to content

WEB-2373 Update OPEN_OCR_SCANNER spec - #243

Merged
atabel merged 4 commits into
masterfrom
update-open-ocr-scanner-spec
Jan 28, 2026
Merged

WEB-2373 Update OPEN_OCR_SCANNER spec#243
atabel merged 4 commits into
masterfrom
update-open-ocr-scanner-spec

Conversation

@yamal-alm

Copy link
Copy Markdown
Contributor

Update OPEN_OCR_SCANNER so we can distinguish between:

  • Method returned some scanned text
  • No text was scanned because user manually closed the scanner
  • No text was scanned because the scanner closed automatically after some timeout was reached

Comment thread README.md
Comment on lines -1845 to +1846
- `scannedText`: The scanned text matching the regex pattern, or `null` if the
user closed the scanner before any text was found
- `scannedText`: The scanned text matching the regex pattern.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we could have just added a new error code for the timeout case and keep this field nullable, however I preferred to avoid nulls as much as possible and give more semantic to each scenario. WDYT

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok

@yamal-alm
yamal-alm marked this pull request as ready for review January 27, 2026 08:23
Comment thread README.md
Comment on lines -1845 to +1846
- `scannedText`: The scanned text matching the regex pattern, or `null` if the
user closed the scanner before any text was found
- `scannedText`: The scanned text matching the regex pattern.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok

@atabel
atabel merged commit e1831f5 into master Jan 28, 2026
2 checks passed
@atabel
atabel deleted the update-open-ocr-scanner-spec branch January 28, 2026 11:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants