fix: openapi playground parsing #1487
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
|
added Changelog entry to 'changed' as the inital openapi change was merged without an entry. |
TheGreatRefrigerator
force-pushed
the
fix/openapi-playground-parsing
branch
from
d0131bb to
60f50f5
Compare
|
dropped the profile JSON ignore commit that was removing provfile from metadata.query.profile -> removing from request object was resolved by changing to |
MichaelsJP
requested changes
Jul 5, 2023
ors-api/src/main/java/org/heigit/ors/api/controllers/RoutingAPI.java
Outdated
Show resolved
Hide resolved
ors-api/src/main/java/org/heigit/ors/api/requests/export/ExportRequest.java
Show resolved
Hide resolved
ors-api/src/main/java/org/heigit/ors/api/requests/routing/RequestProfileParamsRestrictions.java
Show resolved
Hide resolved
TheGreatRefrigerator
force-pushed
the
fix/openapi-playground-parsing
branch
from
60f50f5 to
560989d
Compare
TheGreatRefrigerator
force-pushed
the
fix/openapi-playground-parsing
branch
from
560989d to
435e576
Compare
|
@TheGreatRefrigerator lgtm besides the failing test |
MichaelsJP
approved these changes
Jul 5, 2023
will have one more look today with jakob on the port thing, and if nothing works put it back to default 8082. |
TheGreatRefrigerator
force-pushed
the
fix/openapi-playground-parsing
branch
from
435e576 to
f1f9e2a
Compare
koebi
approved these changes
Jul 7, 2023
Due to the Operation annotation being wrapped in the RouterOperation annotation, the summary and description weren't generated properly in the OAS3 spec output. - add linebreaks for readability - remove redundant (POST/GET) from Routing endpoint summaries Co-authored-by: Jakob Schnell <jakob.schnell@heigit.org>
The swagger UI supports choosing the server to send requests
from the interactive docs to.
As we would like something similar for the Playground, we are
always adding server objects for
- api.openrouteservice.org
- localhost:{port}{baseUrl}
with the dynamic local server, the port and baseUrl can be
adjusted to the local configuration
this is redundant with the dynamic localhost server - remove redundant swagger_documentation_url default
this is used in the Playground, where other paths without V2 are listed as well.
there were some ominous accessMode Schema properties set to READ_ONLY that didn't make any sense. They were replaced with the correct property (hidden or required).
OAS 3 takes care of defaults via `defaultValue` and has an extension for the validWhen-key. This makes the CUSTOM_KEY unnecessary.
- use OAS version 3.0 for usage with ui and parameter type for object parameters - remove unused - adjust swagger ui path
although objects represented by a java class are returned,
the response schema was using the @ArraySchema annotation.
This resulted in
```yaml
content:
type: array
items:
$ref: ResponseObject
```
instead of the correct
```yaml
content:
$ref: ResponseObject
```
TheGreatRefrigerator
force-pushed
the
fix/openapi-playground-parsing
branch
from
f1f9e2a to
46c9d85
Compare
|
rebased on master |
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.
Pull Request Checklist
have been resolved.
[Unreleased] heading.
along with a short description of what it is for, and documented this in the Pull Request (below).
(at least Germany), and the graphs build without problems (i.e. no out-of-memory errors).
importer etc.), I have generated longer distance routes for the affected profiles with different options
(avoid features, max weight etc.) and compared these with the routes of the same parameters and start/end
points generated from the current live ORS.
If there are differences then the reasoning for these MUST be documented in the pull request.
and why the change was needed.
Information about the changes