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

Improve machine-readability of openapi.yaml #426

Merged
merged 1 commit into from
Aug 22, 2024

Conversation

rinkp
Copy link
Member

@rinkp rinkp commented Jul 24, 2024

Description

  • Fixes one inconsistency in the API response
  • Improves machine-readability of openapi.yaml by giving objects titles, reusing objects and reducing the number of models

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)
  • Documentation improvement (no changes to code)
  • Other (please specify)

@rinkp
Copy link
Member Author

rinkp commented Jul 24, 2024

@JustSamuel, can you verify this works with your typescript client? I think this will make the method names less prone to change as well.

Copy link
Member

@tomudding tomudding left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am merely a human, so I wondered whether I was in the best position to review the spec's machine-readability. As such, I asked a computer program to check the specs too, and we both agreed that it could successfully produce an API client (and is thus correctly formatted and interpreted).

@tomudding tomudding requested a review from JustSamuel July 26, 2024 20:07
@rinkp rinkp requested review from JustSamuel and Yoronex and removed request for JustSamuel August 9, 2024 12:04
@tomudding
Copy link
Member

@JustSamuel @Yoronex please review...

Copy link
Member

@Yoronex Yoronex left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm, but I am not familiar with the GEWISDB-SudoSOS integration, so I prefer @JustSamuel to also take a look.

@tomudding tomudding merged commit aac9a8e into GEWIS:main Aug 22, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants