Relabel "Query Parameters" to "Query String Parameters" #2712
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
✅ Deploy Preview for stoplight-elements ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for stoplight-elements-demo ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
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.
Elements Default PR Template
In general, make sure you have: (check the boxes to acknowledge you've followed this template)
CONTRIBUTING.mdHi, I noticed that your section label says "Query Parameters". However, it seems more accurate to refer to this as "Query String Parameters". I realize the OpenAPI spec sometimes refers to the parameter object location as "query", so from that perspective, there is a thing called "query parameter". However, the audience for documentation shown in Elements is more broad than that, and so being more clear that these parameters should be placed in the query string seems useful.
It's the difference between picking a display label for folks who are very aware of OpenAPI-isms, vs picking a display label which works better for general web principles independent of OpenAPI.