search

dockstore / dockstore

Our VM/Docker sharing infrastructure and management component
https://dockstore.org/
Apache License 2.0
116 stars 27 forks source link

Add missing OpenAPI annotations #5864

Open coverbeck opened 2 months ago

coverbeck commented 2 months ago

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 https://github.com/dockstore/dockstore/pull/5862#discussion_r1552346474_

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

unito-bot commented 2 months ago

➤ 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 commented 2 months ago

➤ 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 commented 1 month ago

➤ Charles Overbeck commented:

Setting fix version just to test GitHub/JIRA sync