206 fix open api docs #211
Merged
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
…fix-open-api-docs # Conflicts: # src/main/kotlin/dk/cachet/carp/webservices/common/configuration/swagger/OpenApi30Config.kt
…fix-open-api-docs # Conflicts: # src/main/kotlin/dk/cachet/carp/webservices/common/configuration/swagger/OpenApi30Config.kt
|
the final version is the one using json files. It has the advantage that the controller itself remains pretty clean (without many annotations there). The downside is that we need to manually update those json files in case something changes. there is also a commit with annotations only 68e44bb. The downside is that the controller classes contain all the documentation for the rpc calls. But, we don't have to maintain the json files. All json files for non-rpc endpoints have been deleted as it is pretty straightforward what they do anyway. |
# Conflicts: # src/main/kotlin/dk/cachet/carp/webservices/file/controller/FileController.kt # src/main/resources/openapi/consentDocument/create.json # src/main/resources/openapi/file/create.json
yuanchen233
approved these changes
Feb 10, 2025
yuanchen233
pushed a commit
that referenced
this pull request
Feb 10, 2025
* updated controllers that are using rpc calls + removed some files * version with rpc docs directly in controller * refactored version with docs directly in controller * formatting to version with docs directly in controller * version with json
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.
No description provided.