First draft of OCR-D Web API #173
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mweidling
reviewed
Feb 24, 2022
mweidling
reviewed
Mar 3, 2022
mweidling
reviewed
Mar 3, 2022
mweidling
reviewed
Mar 3, 2022
mweidling
reviewed
Mar 3, 2022
kba
commented
Mar 4, 2022
kba
commented
Mar 4, 2022
kba
commented
Mar 4, 2022
kba
commented
Mar 4, 2022
Co-authored-by: mweidling <13831557+mweidling@users.noreply.github.com>
Co-authored-by: Konstantin Baierer <kba@users.noreply.github.com>
|
We will omit the JSON-LD part for now. |
kba
commented
Apr 4, 2022
mweidling
reviewed
Apr 4, 2022
This was referenced Apr 4, 2022
Closed
Co-authored-by: mweidling <13831557+mweidling@users.noreply.github.com>
Co-authored-by: mweidling <13831557+mweidling@users.noreply.github.com>
Co-authored-by: mweidling <13831557+mweidling@users.noreply.github.com>
Co-authored-by: mweidling <13831557+mweidling@users.noreply.github.com>
|
@kba Since all discussions are resolved, are we ready to merge this? Or do we have any dependencies/things we have to do before? |
🚀🚢 No I think we can release an initial |
|
✨ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Here's an initial draft of the HTTP API for OCR-D processing servers. Much more still needs to be fleshed out, obviously. But since this subject is of interest for many in OCR-D, I want to share early so we can agree on the direction we should take with the API.
The API is defined as OpenAPI 3 YAML. Resources follow the JSON-LD convention of assigning the resource URL as
@idattribute. Media types are described in the preamble, emphasis is placed on a consistent data model. The requests are grouped by tag, so that implementers can choose whether to implement specific areas (e.g. the "OCR-D processing API v1").You can explore the API in a GUI on SwaggerHub.
TODO:
Document JSON-LD convention for(see Add JSON-LD to WebAPI #194)@idConsider distributed services and how they interact to retrieve data in a sensible and low-bandwidth way (this is non-normative and could be covered by a best practice section on the website)(see WebAPI: Best practices #195)Mechanism for actively signalling events (Web Hooks, Web Sockers, AQMP...) (this will be part of a reference implementation and is not part of the API)(see WebAPI: Event notifications #196 )