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

Open API generator for Spring does not (?) support Open API 3 annotations #23

Open
aniewielska opened this issue Apr 12, 2021 · 1 comment

Comments

@aniewielska
Copy link
Contributor

The current situation of OpenAPI 3 vs 3 support:

  • TES spec is exclusively in OpenAPI 3
  • The current version of TESK uses a new version of OpenAPI Generator for Spring in the form of Maven Plugin
  • The generator and plugin accept specification in OpenAPI 3, but the generated annotations correspond to Swagger 2.
  • It does not seem at the moment to be possible to generate OpenAPI 3 models or at least it is not straightforward:
  • Issue 8703
  • Issue 5803
  • PR 6306
    and more.
    Additionally, there seems to be now an alternative to SpringFox in the form of SpringDoc
    Verdict: for now TESK will present OpenAPI 2 docs via UI and wait for support of OpenAPI3 in generator or an alternative solution.
@sofiakarb
Copy link

Hello! I am not sure if the issue you present here , has anything to do with the issue Im dealing with but it is worth asking , I guess :) We tried to build a new version of tesk-api with TES V1.1: https://github.com/ga4gh/task-execution-schemas/blob/v1.1/openapi/task_execution_service.openapi.yaml . And when we launched the image, Swagger returned this error message "Whitelabel Error Page
This application has no explicit mapping for /error, so you are seeing this as a fallback.

Fri Mar 03 18:22:28 GMT 2023
There was an unexpected error (type=Not Found, status=404)."

I found somehwere (https://community.opengroup.org/osdu/platform/home/-/issues/47) that maybe I needed to change the url from $HOST/swagger-ui.html to $HOST/swagger-ui/index.html but then the issue I get is {
"timestamp" : "2023-03-03T18:23:21.278+00:00",
"status" : 401,
"error" : "unauthorized",
"message" : "Full authentication is required to access this resource",
"path" : "/swagger-ui/index.html",
"error_description" : "Full authentication is required to access this resource"
}

Do you have any idea if what you presented above, may have anything to do with the errors we get?
Thanks in advance!

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

No branches or pull requests

2 participants