Improve Swagger typings for getAll #622
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
ibacher
changed the title
ibacher
reviewed
Sep 10, 2024
...n/src/main/java/org/openmrs/module/webservices/docs/swagger/SwaggerSpecificationCreator.java
Outdated
Show resolved
Hide resolved
Comment on lines
+1072
to
+1074
| operation.addResponse("200", | ||
| response200.schema(new ArrayProperty( | ||
| new RefProperty(getSchemaRef(resourceName, resourceParentName, OperationEnum.get))))); |
There was a problem hiding this comment.
I'm not deeply familiar with Swagger. Could you leave a comment with a brief description of how this changes things? Is it replacing the definition of the return value with something that matches the GET request?
There was a problem hiding this comment.
Currently, the getAll operation on a resouce is not properly typed in swagger. It returns a generic type called FetchAll, which has no typing information of the actual array being returned. (For example, getAll on patients should return PatientGet[]). This change should fix that.
Here's the typing for getAll on Patient currently:
ibacher
approved these changes
Sep 10, 2024
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.
Description of what I changed
Issue I worked on
see https://issues.openmrs.org/browse/RESTWS-
Checklist: I completed these to help reviewers :)
My IDE is configured to follow the code style of this project.
No? Unsure? -> configure your IDE, format the code and add the changes with
git add . && git commit --amendI have added tests to cover my changes. (If you refactored
existing code that was well tested you do not have to add tests)
No? -> write tests and add them to this commit
git add . && git commit --amendI ran
mvn clean packageright before creating this pull request andadded all formatting changes to my commit.
No? -> execute above command
All new and existing tests passed.
No? -> figure out why and add the fix to your commit. It is your responsibility to make sure your code works.
My pull request is based on the latest changes of the master branch.
No? Unsure? -> execute command
git pull --rebase upstream master