MODLD-602: Updated TitleFieldRequest & TitleFieldResponse to avoid oneOf at the top level #57
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
pkjacob
force-pushed
the
pjacob/MODLD-602_2
branch
from
d840692 to
ddc5c83
Compare
pkjacob
force-pushed
the
pjacob/MODLD-602_2
branch
from
ddc5c83 to
e78c307
Compare
pkjacob
changed the title
pkjacob
force-pushed
the
pjacob/MODLD-602_2
branch
from
fae54bd to
d8e5c7f
Compare
pkjacob
force-pushed
the
pjacob/MODLD-602_2
branch
from
0406954 to
a411d5d
Compare
|
PBobylev
approved these changes
Nov 25, 2024
askhat-abishev
approved these changes
Nov 25, 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.
Problem:
When
oneOfis at the top level (as in TitleFieldRequest.json), then you have to give the full path inrefelement in line 10, 21 & 32. If relative path is used, maven openapi plugin will fail. This problem do not occur ifallOfis in the top level as in this file. So, I believe it is a bug in the plugin.However, if you give full path, then the python script used by jenkins to generate api-doc will fail with error
Error: Invalid JSON pointer: schema/resource/common/title/PrimaryTitle.json. See this failed build (build is shown Green even though it actually failed). Expand "Do api-doc" to see the failure.Fix given in this ticket:
I rearranged the JSON schemas so that "oneOf" element do not appear in the top level. This way, we can give relative paths in "$ref" element. This will make the python script &
mvn clean installpass. See this java doc generation using this branch.