-
Notifications
You must be signed in to change notification settings - Fork 8
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.
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
Refresh openapi.yaml to reflect parameter capabilities #1229
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
…published) with support for multiple years
… and prefix with descriptions and examples
…to support multiple selections (comma-separated)
… for multiple values
…=true description
…nd indicate repeatability
I also opened #1230 with some more ideas for future work, particularly for DOI registration/updates. |
digitaldogsbody
approved these changes
Aug 23, 2024
Thanks for the review @digitaldogsbody and @codycooperross! I refreshed the docs on ReadMe: https://support.datacite.org/reference/get_dois |
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.
Purpose
The purpose of this update is to refresh openapi.yaml (which powers https://support.datacite.org/reference/introduction) to reflect the full capabilities of our filter parameters for retrieving information, with a focus on the
/dois
endpoint. Better documentation of these parameters supports users in discovering their functionality.closes: #1188
Approach
This update:
created
,registered
,published
) to a string with a regex pattern because these parameters support multiple years, for example2024,2023
./dois
and others but I did not review all endpoints.publisher
parameter to/dois
.page[size]
param where it was missing fromprovider-prefixes
.governmentAgency
frommember_types
(this was a typo as it is one of our organization types).state
parameter from/prefixes/totals
because this is ignored.Open Questions and Pre-Merge TODOs
Learning
Types of changes
Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Reviewer, please remember our guidelines: