Use singular tag names in swagger.yaml #29071
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
This is required to make the type generation put things in the correct directory, but unfortunately makes the names in the documentation menu look a bit crap. I think the best solution would be to add a `x-display-name` extension to tags to determine how the tags show up in the menu, rather than it depend on the name of the tag. I shall do this in a follow-up PR - for now, let's fix the breakage. Fixes moby#29045 Signed-off-by: Ben Firshman <ben@firshman.co.uk>
thaJeztah
added
process/cherry-pick
status/2-code-review
and removed
status/0-triage
labels
thaJeztah
approved these changes
Dec 2, 2016
|
Also – /cc @dnephin |
Yes that was my first thought. I realize now that it only checks for changes in |
bfirsh
added a commit
to bfirsh/docker
that referenced
this pull request
Dec 14, 2016
In moby#29071, we made the tags the correct name for generating types, at the expense of the menu in the documentation looking good. ReDoc now has support for tag display names ( Redocly/redoc#152 ), so we can assign a more human-friendly name to the menu items. Signed-off-by: Ben Firshman <ben@firshman.co.uk>
vieux
pushed a commit
to vieux/docker
that referenced
this pull request
Dec 14, 2016
In moby#29071, we made the tags the correct name for generating types, at the expense of the menu in the documentation looking good. ReDoc now has support for tag display names ( Redocly/redoc#152 ), so we can assign a more human-friendly name to the menu items. Signed-off-by: Ben Firshman <ben@firshman.co.uk> (cherry picked from commit 0caa6c2) Signed-off-by: Victor Vieux <vieux@docker.com>
xianlubird
pushed a commit
to xianlubird/docker
that referenced
this pull request
Dec 23, 2016
In moby#29071, we made the tags the correct name for generating types, at the expense of the menu in the documentation looking good. ReDoc now has support for tag display names ( Redocly/redoc#152 ), so we can assign a more human-friendly name to the menu items. Signed-off-by: Ben Firshman <ben@firshman.co.uk>
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 is required to make the type generation put things in the
correct directory, but unfortunately makes the names in the
documentation menu look a bit crap.
I think the best solution would be to add a
x-display-nameextension to tags to determine how the tags show up in the menu,
rather than it depend on the name of the tag. I shall do this in
a follow-up PR - for now, let's fix the breakage.
Fixes #29045
Signed-off-by: Ben Firshman ben@firshman.co.uk