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.

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

Updates to improve coverage of Usage Reports API reference #1253

Merged
merged 4 commits into from
Oct 2, 2024

Conversation

codycooperross
Copy link
Contributor

@codycooperross codycooperross commented Sep 25, 2024

Purpose

Updates to improve coverage of Usage Reports API reference. Many of the attributes in report-datasets in particular were not documented. Included descriptions from the SUSHI spec where possible: https://app.swaggerhub.com/apis/COUNTER/researchdata-sushi_1_0_api/1.0.0#/default/getReportsDSR

closes: https://github.com/datacite/product-backlog/issues/12

Approach

Cross-referenced the SUSHI spec and our existing documentation: https://support.datacite.org/docs/usage-reports-api-guide The SUSHI descriptions may be adjusted in the future to better match our attribute naming.

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:

  • Be humble in the language and feedback you give, ask don't tell.
  • Consider using positive language as opposed to neutral when offering feedback. This is to avoid the negative bias that can occur with neutral language appearing negative.
  • Offer suggestions on how to improve code e.g. simplification or expanding clarity.
  • Ensure you give reasons for the changes you are proposing.

@codycooperross
Copy link
Contributor Author

@KellyStathis I looked over this edit quite a bit, so just a quick scan would be great. The intent was to improve the coverage of the reference rather do a full rewrite just yet.

@codycooperross codycooperross merged commit b7de703 into master Oct 2, 2024
19 checks passed
@codycooperross codycooperross deleted the usage-reports-openapi branch October 2, 2024 19:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants