Display params in a nested format also in the API doc HTML. #691
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
|
Is there a way to get this merged? |
ofedoren
force-pushed
the
master
branch
2 times, most recently
from
69442b9
to
8215e30
Compare
|
@joshio1 @DavertMik I think this would require a settings, so its OFF by default and people can opt in, if that's what they prefer. |
Closed
|
Although I agree with @mathieujobin here, I'd say that at first we better give users an option to switch this off and have it switched off by default, but mention this in the release notes as well as in README, so users can be actually aware of that. I like the proposed way, but it also seems like an experiment. In the future we could switch to this by default if more and more people will find this more useful. |
|
@PanosCodes What do you think of this? |
mathieujobin
added
Stale
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.
Currently, if the parameters are deeply nested, it is very difficult to understand and comprehend the structure of the request and response params when viewing the API doc in the HTML format. This pull request is an attempt to display these nested parameters in a better way so that we can understand its structure in one go.
Current:
Proposed:
Note that the current structure is still there in the HTML. I have just supplemented that with this nested HTML structure having an hyperlink to the "normal" params.
Also, I have added tooltips which display the description of the params.
The entire idea is to grasp the entire request / response schema in one go. Please let me know what you think.