DM-51479: Create a preliminary design document for the bibliographic API #187
Conversation
This file contains hidden or 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
With the help of Copilot :)
DataCite uses relationship types to handle citations/relationships in addition to other types of relationships, so we'll do the same thing.
This means that all resource-to-resource relationships, even versioning, are now handled the same way.
This includes how resources can be integrated with the existing authors API.
We can onsider a release and products of the release as citeable resources as well.
These are better than UUIDs for APIs (see the book *API Design Patterns*).
This idea comes from the *API Design Patterns* book (ch 6, resource identification). The idea we can have consistent sort order between the database and the public IDs is very appealing.
Have the endpoints discussion at the end.
jonathansick
force-pushed
the
tickets/DM-51479
branch
from
70ab059 to
0d57cdd
Compare
jonathansick
force-pushed
the
tickets/DM-51479
branch
from
0d57cdd to
e1205b4
Compare
This was changed in the previous PR.
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.
This document explores what the database schema and REST API may look like for a bibliographic API in Ook.