Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

ocrd-tool.json: allow more fine-grained parameter descriptions #206

Merged
merged 3 commits into from
May 23, 2022
Merged

ocrd-tool.json: allow more fine-grained parameter descriptions #206

merged 3 commits into from
May 23, 2022

Conversation

kba
Copy link
Member

@kba kba commented May 20, 2022

cf. OCR-D/core#848

Allows processor developers to describe numerical, object and array parameters in more detail.

Drops the pattern on input/output file groups since the naming convention is a SHOULD not a MUST.

@kba kba requested a review from bertsky May 20, 2022 12:01
@kba kba mentioned this pull request May 20, 2022
Open
bertsky
bertsky approved these changes May 20, 2022
View reviewed changes
Copy link
Collaborator

@bertsky bertsky left a comment

Choose a reason for hiding this comment

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

Will these be validated automatically by any chance?

@kba
Copy link
Member Author

kba commented May 23, 2022

Will these be validated automatically by any chance?

Yes, the OcrdToolValidator now allows those additional properties and the ParameterValidator only maps those required properties of the individual parameters to the parameter-level required list, otherwise the descriptions are passed directly into the JSON-Schema validation.

@kba
Merge branch 'ocrd-tool-enhanced-typing' of https://github.com/OCR-D/…
6108118 
…spec into ocrd-tool-enhanced-typing

# Conflicts:
#	ocrd_tool.md
#	ocrd_tool.schema.json
#	ocrd_tool.schema.yml
@kba kba merged commit 5ce548f into master May 23, 2022
@kba kba deleted the ocrd-tool-enhanced-typing branch May 23, 2022 10:00
kba added a commit to OCR-D/core that referenced this pull request May 23, 2022
@kba
json-schema: upgrade to draft6 to support OCR-D/spec#206
d7b2077
@bertsky bertsky mentioned this pull request Oct 13, 2022
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bertsky bertsky bertsky approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@kba @bertsky