RESTWS-963: Remove the manual methods used for generating the swagger documentation #637
Conversation
This file contains hidden or 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
mherman22
changed the title
mherman22
changed the title
dkayiwa
reviewed
Dec 6, 2024
| public Model getGETModel(Representation rep) { | ||
| getGETCalled = true; | ||
| return super.getGETModel(rep); | ||
| public DelegatingResourceDescription getRepresentationDescription(Representation rep) { |
There was a problem hiding this comment.
Did you intentionally change these methods?
There was a problem hiding this comment.
yes i did, because we are getting rid of those methods so i had to replace them with methods used for creating the rest api
mherman22
force-pushed
the
RESTWS-963
branch
3 times, most recently
from
00701af to
82eff3a
Compare
5 tasks
Comment on lines
112
to
116
| description.addProperty("drug"); | ||
| return description; | ||
| } | ||
|
|
||
| public Model getGETModel(Representation rep) { | ||
| ModelImpl modelImpl = (ModelImpl) super.getGETModel(rep); | ||
| if (rep instanceof DefaultRepresentation) { | ||
| modelImpl.property("display", new StringProperty()).property("uuid", new StringProperty()) | ||
| .property("drug", new RefProperty("#/definitions/DrugGetRef")) | ||
| .property("conceptReferenceTerm", new RefProperty("#/definitions/ConceptreferencetermGetRef")) | ||
| .property("conceptMapType", new RefProperty("#/definitions/ConceptmaptypeGetRef")); | ||
| } else if (rep instanceof FullRepresentation) { | ||
| modelImpl.property("display", new StringProperty()).property("uuid", new StringProperty()) | ||
| .property("auditInfo", new StringProperty()).property("drug", new RefProperty("#/definitions/DrugGet")) | ||
| .property("conceptReferenceTerm", new RefProperty("#/definitions/ConceptreferencetermGet")) | ||
| .property("conceptMapType", new RefProperty("#/definitions/ConceptmaptypeGet")); | ||
| } | ||
| return modelImpl; | ||
| } | ||
|
|
||
| @Override | ||
| public Model getCREATEModel(Representation rep) { | ||
| return new ModelImpl().property("conceptReferenceTerm", new StringProperty().example("uuid")) | ||
| .property("conceptMapType", new StringProperty().example("uuid")) | ||
| .property("drug", new StringProperty().example("uuid")); | ||
| } | ||
|
|
||
| } |
There was a problem hiding this comment.
good improvements:
Well-structured with correct use of Swagger models.
Logical separation for different representations.
Needs Improvement:
Remove redundant code using a helper method.
Improve method naming for clarity.
Add error handling for edge cases.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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-963
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