Draft
Conversation
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.
TLDR
The TEA Publisher OpenAPI specification has inconsistencies with the consumer API
and documentation, causing potential integration issues and confusion for implementers in the upcoming Beta 1 hackathon on May 28th.
This PR is focussed on the Publisher API spec, that was mostly unchanged since my last contrinution. I noticed it needed significant updates to align with the latest architecture documentation and all the updated that had been given to the consumer API spec (how would consumers consume things that weren't able to be published? This had to be fixed!)
Incompatibilities with consumer spec
Consumer: Uses
urlin artifact formatPublisher: Uses
artifact_urlin artifact formatConsumer: Uses
id-type/id-valuefor product queriesPublisher: Uses direct filter parameters
/release/{uuid}/collection for latest collection/release/{uuid}/collections for all collections/artifact/{uuid} for artifact metadataConsumer requires
versionsfield in component schemaPublisher's component doesn't match this requirement
Changes
Before:
leafendpoints and schemas in publisher APIAfter:
/componentand/releaseendpointsWhy: Consistent terminology across consumer/publisher APIs prevents integration errors.
Before:
After:
tei_urnsarray to product schema^urn:tei:[a-zA-Z0-9]+:[a-zA-Z0-9\\.-]+:.+$Why: TEI URNs are the primary discovery mechanism according to documentation.
Before:
After:
collection_update_reasonschema with values from docs:/collection/{uuid}/{version}endpointWhy: Matches documented collection versioning requirements.
Before:
objectsAfter:
formatsarrayWhy: Allows full interoperability between consumer/publisher systems.
Before:
After:
Why: Matches documented model and enables proper artifact organization.