Fix initialization of SpringDoc so that it does not use null servername and null version #7575
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
…me and null version Modified OpenApi object so that it is a static object that is shared with all context. This helped fix initial api setting so that it was not set to null://null:80/geonetwork/srv/api Also update SiteApi so that if the server properties are changed then it will update the OpenApi object without requiring an application restart.
ianwallen
force-pushed
the
springdoc_initilization_fix
branch
from
61a5367
to
5baa54d
Compare
josegar74
reviewed
Dec 22, 2023
… no static values are changed directly in the bean.
I update the code so that the bean called the static method to make the changes. |
fxprunayre
approved these changes
Jan 2, 2024
josegar74
pushed a commit
that referenced
this pull request
Jan 2, 2024
…vername and null version (#7575) * Fix initialization of SpringDoc so that it does not use null servername and null version Modified OpenApi object so that it is a static object that is shared with all context. This helped fix initial api setting so that it was not set to null://null:80/geonetwork/srv/api Also update SiteApi so that if the server properties are changed then it will update the OpenApi object without requiring an application restart. * Update OpenAPI bean so that it calls the static method to ensure that no static values are changed directly in the bean.
Closed
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.
Fix initialization of SpringDoc so that it does not use null servername and null version
Before this fix. The initial deployment of geonetwork in a new database would cause Spring Doc api to look like the following
Also if checking the yaml api on https://editor.swagger.io/, we would see the following error because the version was not set.
The issue was mostly caused by 2 contexts being used.
JeevesApplicationContext was being loaded first and at that time, the database was not initialized with the data and ended up returning a null servername and null version from the settings manager.
Then it would later initialize WebApplicationContext and this would initialized the correct version. But when going to /doc/api/ it was using the JeevesApplicationContext version which was incorrect.
This fix modified OpenApi object so that it is a static object that is shared with all context. This helped fix initial api setting so that it was not set to null://null:80/geonetwork/srv/api
After this fix, a new installation of geonetwork will show the following:
Also as part of this fix, SiteApi was updated so that if the server url is changed then it will update the static OpenApi object without requiring an application restart.
Checklist
mainbranch, backports managed with labelREADME.mdfilespom.xmldependency management. Update build documentation with intended library use and library tutorials or documentation