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

Add missing OpenAPI annotations #5864

Open
coverbeck opened this issue Apr 4, 2024 · 3 comments
Open

Add missing OpenAPI annotations #5864

coverbeck opened this issue Apr 4, 2024 · 3 comments
Milestone

Comments

@coverbeck
Copy link
Contributor

coverbeck commented Apr 4, 2024

In the PR comment noted below, some parameters only had Swagger annotations, which don't show up in our OpenAPI.

We should go through the code base and either:

  1. Ensure all Swagger annotations have corresponding OpenAPI annotations.
  2. Or, just convert the Swagger annotations to OpenAPI annotations, i.e., remove the Swagger annotations.
    Originally posted by coverbeck in SEAB-6173: Fix miscellaneous "fuzzing bugs" #5862 (comment)

┆Issue is synchronized with this Jira Story
┆Fix Versions: Dockstore 1.17
┆Issue Number: DOCK-2520
┆Sprint: Backlog
┆Issue Type: Story

@unito-bot
Copy link

➤ Steve Von Worley commented:

Would prefer if we exorcised the Swagger-specific annotations, we don’t use them anymore, they make the code harder to read, and it’s easy for them to fall out of sync with the OpenAPI equivalents.

@unito-bot
Copy link

➤ Steve Von Worley commented:

Also, if we can come up with a more readable way to format the argument blocks, that would be great. Maybe one argument per line?

@unito-bot
Copy link

➤ Charles Overbeck commented:

Setting fix version just to test GitHub/JIRA sync

@coverbeck coverbeck added this to the 1.17 milestone May 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants