Chore – Add OpenAPI documentation #214
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…pe-heatmap-endpoint
Otherwise we sometimes see this: ``` Err:1 http://security.debian.org/debian-security bullseye-security InRelease Connection timed out [IP: 151.101.18.132 80] Err:2 http://deb.debian.org/debian bullseye InRelease Connection timed out [IP: 199.232.174.132 80] ``` And Jenkins fails :(
…pe-heatmap-endpoint # Conflicts: # atlas-web-core
…e often than not)
…cell-type-wheel-cell-type-heatmap-endpoint-build # Conflicts: # atlas-web-core
…n of OpenAPI docs and Swagger UI with springdoc-openapi
alfonsomunozpomer
requested review from
haideriqbal,
upendrakumbham and
lingyun1010
|
Bad branch history. Superseded by #215. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The best thing would be to read
openapi/README.mdand give it a go to see that you can generate the docs and start the Swager UI server. I have changed several variables in Docker Compose to make things more flexible and less tied in to a specific directory layout in our host machines.@upendrakumbham I’m very interested in your thoughts regarding this solution as compared to RestDocs, which you used in your API project.
@haideriqbal @lingyun1010 Please have a look at this since I’d like to document the whole application with this approach.
Accompanied by ebi-gene-expression-group/atlas-web-core#76.