From 8f81bb92a3e528d0b5facadd55738aefc279caf8 Mon Sep 17 00:00:00 2001 From: Daniel Nephin Date: Fri, 14 Oct 2016 12:46:39 -0400 Subject: [PATCH] Update to inline comments. Signed-off-by: Daniel Nephin --- api/server/types/volume/volumes_create.go | 30 ++++++++--------------- api/server/types/volume/volumes_list.go | 18 +++++--------- api/templates/server/operation.gotmpl | 5 ++-- api/types/error_response.go | 12 +++------ 4 files changed, 22 insertions(+), 43 deletions(-) diff --git a/api/server/types/volume/volumes_create.go b/api/server/types/volume/volumes_create.go index 98c12b9b10..5f9513a227 100644 --- a/api/server/types/volume/volumes_create.go +++ b/api/server/types/volume/volumes_create.go @@ -7,33 +7,23 @@ package volume // See hack/swagger-gen.sh // ---------------------------------------------------------------------------- -/*VolumesCreateBody volumes create body - -swagger:model VolumesCreateBody -*/ +// VolumesCreateBody volumes create body +// swagger:model VolumesCreateBody type VolumesCreateBody struct { - /* Name of the volume driver to use. - - Required: true - */ + // Name of the volume driver to use. + // Required: true Driver string `json:"Driver"` - /* A mapping of driver options and values. These options are passed directly to the driver and are driver specific. - - Required: true - */ + // A mapping of driver options and values. These options are passed directly to the driver and are driver specific. + // Required: true DriverOpts map[string]string `json:"DriverOpts"` - /* A mapping of arbitrary key/value data to set on the volume. - - Required: true - */ + // A mapping of arbitrary key/value data to set on the volume. + // Required: true Labels map[string]string `json:"Labels"` - /* The new volume's name. If not specified, Docker generates a name. - - Required: true - */ + // The new volume's name. If not specified, Docker generates a name. + // Required: true Name string `json:"Name"` } diff --git a/api/server/types/volume/volumes_list.go b/api/server/types/volume/volumes_list.go index f5cf443ffb..7770bcb8fc 100644 --- a/api/server/types/volume/volumes_list.go +++ b/api/server/types/volume/volumes_list.go @@ -9,21 +9,15 @@ package volume import "github.com/docker/docker/api/types" -/*VolumesListOKBody volumes list o k body - -swagger:model VolumesListOKBody -*/ +// VolumesListOKBody volumes list o k body +// swagger:model VolumesListOKBody type VolumesListOKBody struct { - /* List of volumes - - Required: true - */ + // List of volumes + // Required: true Volumes []*types.Volume `json:"Volumes"` - /* Warnings that occurred when fetching the list of volumes - - Required: true - */ + // Warnings that occurred when fetching the list of volumes + // Required: true Warnings []string `json:"Warnings"` } diff --git a/api/templates/server/operation.gotmpl b/api/templates/server/operation.gotmpl index 19c0e80a7a..3a3d7527da 100644 --- a/api/templates/server/operation.gotmpl +++ b/api/templates/server/operation.gotmpl @@ -20,8 +20,7 @@ import ( {{ range .ExtraSchemas }} -/*{{ .Name }} {{ template "docstring" . }} -swagger:model {{ .Name }} -*/ +// {{ .Name }} {{ template "docstring" . }} +// swagger:model {{ .Name }} {{ template "schema" . }} {{ end }} diff --git a/api/types/error_response.go b/api/types/error_response.go index bbe0cf0821..dc942d9d9e 100644 --- a/api/types/error_response.go +++ b/api/types/error_response.go @@ -3,15 +3,11 @@ package types // This file was generated by the swagger tool. // Editing this file might prove futile when you re-run the swagger generate command -/*ErrorResponse Represents an error. - -swagger:model ErrorResponse -*/ +// ErrorResponse Represents an error. +// swagger:model ErrorResponse type ErrorResponse struct { - /* The error message. - - Required: true - */ + // The error message. + // Required: true Message string `json:"message"` }