Use urls instead of url in Swagger UI#8
Open
mikaeldui wants to merge 2 commits into
Open
Conversation
mikaeldui
commented
Mar 23, 2022
Collaborator
Author
There was a problem hiding this comment.
I've never edited a diff before, so this might not be correct.
Yup, the actions says I failed: https://github.com/MingweiSamuel/lcu-schema/runs/5667284565?check_suite_focus=true#step:3:46
Owner
|
Best way is to generate a new diff:
|
Collaborator
Author
|
@MingweiSamuel, what do you think about adding lolgameapi-schema/openapi-lcd.json to the list of available definitions, as well as riotapi-schema/openapi-3.0.0.min.json etc., for easier discovery? |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Problem
Currently one needs to enter the path for the definition in order to view it. It's not obvious that there's a "swagger" version of the LCU API definition, neither that there are definitions for RCS available.
Solution
By using the
urlsproperty in Swagger, instead ofurl, it's possible to specify multiple API definitions for Swagger UI to show the user. It also enabled deep linking to a specific API definition.Below is an example from the test Swagger UI for Help2Swagger.
