Fix serverUrl in OpenAPI document #133
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
tfr42
added
enhancement
dstenger
approved these changes
Nov 11, 2024
tfr42
approved these changes
Nov 20, 2024
stephanr
approved these changes
Nov 20, 2024
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Before this PR the context path was used as start of the relative serverUrl, followed by "dataset/{datasetId}". If an Apache Webserver or NGINX is used and the configuration does not include the context path the serverUrl was wrong.
Example:
Requesting the OpenAPI document with https://ogc-api.server.de/datasets/test/api the OpenAPI document contains the serverUrl 'deegree-ogcapi/datasets/test/api'. The execution of requests with the Swagger UI results in invalid URLs: https://ogc-api.server.de/deegree-ogcapi/datasets/test/collections
This PR fixes the serverUrl in the OpenAPI document. Instead of the relative url an absolute url is used. Using the example above the serverUrl results in https://ogc-api.server.de/datasets/test/ and execution of request with the Swagger UI is possible.