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 openapi.yaml #1034

Merged
merged 7 commits into from
Nov 2, 2023
Merged

Updates to openapi.yaml #1034

merged 7 commits into from
Nov 2, 2023

Conversation

KellyStathis
Copy link
Collaborator

@KellyStathis KellyStathis commented Oct 25, 2023

Purpose

Approach

  • Changes the requestBody content type from application/vnd.api+json to application/json.
    • This results in cleaner code snippet generation in the ReadMe.io API Reference, because the content type is properly recognized as JSON.
  • Adds parameters to the GET /dois request:
    • funder-id
    • resource-type
    • disable-facets
    • client-type
    • detail
    • field[dois]
    • user-id
    • has-citations
    • has-references
    • has-parts
    • has-part-of
    • has-versions
    • has-version-of
    • has-views
    • has-downloads
    • has-person
    • has-affiliation
    • has-organization
    • has-funder
    • source
  • Updates the options for client-type to include igsnCatalog.

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.

@KellyStathis KellyStathis changed the title Updates to openapi.yamml Updates to openapi.yaml Oct 25, 2023
@KellyStathis KellyStathis marked this pull request as ready for review November 1, 2023 16:47
@svogt0511 svogt0511 self-requested a review November 2, 2023 15:49
@codycooperross codycooperross merged commit c71086d into master Nov 2, 2023
11 checks passed
@codycooperross codycooperross deleted the 202310_openapi_updates branch November 2, 2023 15:57
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.

3 participants