From 20dc482b1054f0c2e0a941db5321b671b83bc7fc Mon Sep 17 00:00:00 2001 From: Ben Firshman Date: Wed, 14 Dec 2016 12:00:04 +0000 Subject: [PATCH] Add display name for tags in swagger.yaml In #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 ( https://github.com/Rebilly/ReDoc/pull/152 ), so we can assign a more human-friendly name to the menu items. Signed-off-by: Ben Firshman (cherry picked from commit 0caa6c218c89147b2d61a1bbb87c48ad16495a11) Signed-off-by: Victor Vieux --- api/swagger.yaml | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/api/swagger.yaml b/api/swagger.yaml index 753dcb267e..00757b8a65 100644 --- a/api/swagger.yaml +++ b/api/swagger.yaml @@ -97,37 +97,49 @@ info: tags: # Primary objects - name: "Container" + x-displayName: "Containers" description: | Create and manage containers. - name: "Image" + x-displayName: "Images" - name: "Network" + x-displayName: "Networks" description: | Networks are user-defined networks that containers can be attached to. See the [networking documentation](https://docs.docker.com/engine/userguide/networking/) for more information. - name: "Volume" + x-displayName: "Volumes" description: | Create and manage persistent storage that can be attached to containers. - name: "Exec" + x-displayName: "Exec" description: | Run new commands inside running containers. See the [command-line reference](https://docs.docker.com/engine/reference/commandline/exec/) for more information. To exec a command in a container, you first need to create an exec instance, then start it. These two API endpoints are wrapped up in a single command-line command, `docker exec`. - name: "Secret" + x-displayName: "Secrets" # Swarm things - name: "Swarm" + x-displayName: "Swarm" description: | Engines can be clustered together in a swarm. See [the swarm mode documentation](https://docs.docker.com/engine/swarm/) for more information. - name: "Node" + x-displayName: "Nodes" description: | Nodes are instances of the Engine participating in a swarm. Swarm mode must be enabled for these endpoints to work. - name: "Service" + x-displayName: "Services" description: | Services are the definitions of tasks to run on a swarm. Swarm mode must be enabled for these endpoints to work. - name: "Task" + x-displayName: "Tasks" description: | A task is a container running on a swarm. It is the atomic scheduling unit of swarm. Swarm mode must be enabled for these endpoints to work. # System things - name: "Plugin" + x-displayName: "Plugins" - name: "System" + x-displayName: "System" definitions: Port: