Render Named names as "internal route ID" in swagger UI.
#3319
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
|
|
zebot
added
the
ok-to-test
fisx
commented
May 26, 2023
(makes grepping for source code easier.)
... like `("put", Wire.API.Team.Feature.LegalholdConfig))`. oumphf.
fisx
commented
May 30, 2023
Comment on lines
51
to
52
| & allOperations . summary %~ (<> Just dscr) | ||
| & allOperations . description %~ (Just (dscr <> "\n\n") <>) |
There was a problem hiding this comment.
not sure we want both, but i can't decide which one to prefer?
There was a problem hiding this comment.
Let's keep the one in the description, not the summary
|
i also thought maybe we can make it a rule that the internal IDs are strings that can be fed to grep verbatim. and maybe document this in docs.wire.com somewhere, and link to those docs from the "internal route ID" label. |
smatting
approved these changes
May 31, 2023
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.
This should make jumping from swagger docs into the source code by grepping for the ID much easier.
Checklist
changelog.d