Merge pull request #4936 from jwhonce/wip/swagger2

[CI:DOCS] Enable swagger validation for each PR

1 files changed, 118 insertions, 110 deletions

diff --git a/pkg/api/server/register_pods.go b/pkg/api/server/register_pods.go
index 4018cfbe8..1ef14b58c 100644
--- a/pkg/api/server/register_pods.go
+++ b/pkg/api/server/register_pods.go
@@ -16,17 +16,15 @@ func (s *APIServer) registerPodsHandlers(r *mux.Router) error {
 	// parameters:
 	// - in: query
 	//   name: filters
-	//   descriptions: needs description and plumbing for filters
+	//   type: string
+	//   description: needs description and plumbing for filters
 	// responses:
-	//   '200':
-	//       properties:
-	//        items:
-	//          $ref: "#/responses/ListPodsResponse"
-	//        type: array
-	//   '400':
-	//      $ref: "#/responses/BadParamError"
-	//   '500':
-	//      $ref: "#/responses/InternalError"
+	//   200:
+	//     $ref: "#/responses/ListPodsResponse"
+	//   400:
+	//     $ref: "#/responses/BadParamError"
+	//   500:
+	//     $ref: "#/responses/InternalError"
 	r.Handle(VersionedPath("/libpod/pods/json"), APIHandler(s.Context, libpod.Pods)).Methods(http.MethodGet)
 	r.Handle(VersionedPath("/libpod/pods/create"), APIHandler(s.Context, libpod.PodCreate)).Methods(http.MethodPost)
 	// swagger:operation POST /libpod/pods/prune pods PrunePods
@@ -36,61 +34,63 @@ func (s *APIServer) registerPodsHandlers(r *mux.Router) error {
 	//  - in: query
 	//    name: force
 	//    description: force delete
-	//    type: bool
+	//    type: boolean
 	//    default: false
 	// produces:
 	// - application/json
 	// responses:
-	//   '204':
-	//      description: no error
-	//   '400':
-	//      $ref: "#/responses/BadParamError"
-	//   '500':
-	//      $ref: "#/responses/InternalError"
+	//   204:
+	//     description: no error
+	//   400:
+	//     $ref: "#/responses/BadParamError"
+	//   500:
+	//     $ref: "#/responses/InternalError"
 	r.Handle(VersionedPath("/libpod/pods/prune"), APIHandler(s.Context, libpod.PodPrune)).Methods(http.MethodPost)
-	// swagger:operation DELETE /libpod/pods/{nameOrID} pods removePod
+	// swagger:operation DELETE /libpod/pods/{name} pods removePod
 	// ---
 	// summary: Remove pod
 	// produces:
 	// - application/json
 	// parameters:
 	//  - in: path
-	//    name: nameOrID
+	//    name: name
+	//    type: string
 	//    required: true
 	//    description: the name or ID of the pod
 	//  - in: query
 	//    name: force
-	//    type: bool
+	//    type: boolean
 	//    description: force delete
 	// responses:
-	//   '204':
-	//      description: no error
-	//   '400':
-	//      $ref: "#/responses/BadParamError"
-	//   '404':
-	//      $ref: "#/responses/NoSuchPod"
-	//   '500':
-	//      $ref: "#/responses/InternalError"
-	r.Handle(VersionedPath("/libpod/pods/{name:..*}"), APIHandler(s.Context, libpod.PodDelete)).Methods(http.MethodDelete)
-	// swagger:operation GET /libpod/pods/{nameOrID}/json pods inspectPod
+	//   204:
+	//     description: no error
+	//   400:
+	//     $ref: "#/responses/BadParamError"
+	//   404:
+	//     $ref: "#/responses/NoSuchPod"
+	//   500:
+	//     $ref: "#/responses/InternalError"
+	r.Handle(VersionedPath("/libpod/pods/{name}"), APIHandler(s.Context, libpod.PodDelete)).Methods(http.MethodDelete)
+	// swagger:operation GET /libpod/pods/{name}/json pods inspectPod
 	// ---
 	// summary: Inspect pod
 	// produces:
 	// - application/json
 	// parameters:
 	//  - in: path
-	//    name: nameOrID
+	//    name: name
+	//    type: string
 	//    required: true
 	//    description: the name or ID of the pod
 	// responses:
-	//   '200':
-	//      $ref: "#/responses/InspectPodResponse"
-	//   '404':
+	//   200:
+	//     $ref: "#/responses/InspectPodResponse"
+	//   404:
 	//      $ref: "#/responses/NoSuchPod"
-	//   '500':
+	//   500:
 	//      $ref: "#/responses/InternalError"
-	r.Handle(VersionedPath("/libpod/pods/{name:..*}/json"), APIHandler(s.Context, libpod.PodInspect)).Methods(http.MethodGet)
-	// swagger:operation GET /libpod/pods/{nameOrID}/exists pods podExists
+	r.Handle(VersionedPath("/libpod/pods/{name}/json"), APIHandler(s.Context, libpod.PodInspect)).Methods(http.MethodGet)
+	// swagger:operation GET /libpod/pods/{name}/exists pods podExists
 	// ---
 	// summary: Pod exists
 	// description: Check if a pod exists by name or ID
@@ -98,25 +98,27 @@ func (s *APIServer) registerPodsHandlers(r *mux.Router) error {
 	// - application/json
 	// parameters:
 	//  - in: path
-	//    name: nameOrID
+	//    name: name
+	//    type: string
 	//    required: true
 	//    description: the name or ID of the pod
 	// responses:
-	//   '204':
-	//      description: pod exists
-	//   '404':
-	//      $ref: "#/responses/NoSuchPod"
-	//   '500':
-	//      $ref: "#/responses/InternalError"
-	r.Handle(VersionedPath("/libpod/pods/{name:..*}/exists"), APIHandler(s.Context, libpod.PodExists)).Methods(http.MethodGet)
-	// swagger:operation POST /libpod/pods/{nameOrID}/kill pods killPod
+	//   204:
+	//     description: pod exists
+	//   404:
+	//     $ref: "#/responses/NoSuchPod"
+	//   500:
+	//     $ref: "#/responses/InternalError"
+	r.Handle(VersionedPath("/libpod/pods/{name}/exists"), APIHandler(s.Context, libpod.PodExists)).Methods(http.MethodGet)
+	// swagger:operation POST /libpod/pods/{name}/kill pods killPod
 	// ---
 	// summary: Kill a pod
 	// produces:
 	// - application/json
 	// parameters:
 	//  - in: path
-	//    name: nameOrID
+	//    name: name
+	//    type: string
 	//    required: true
 	//    description: the name or ID of the pod
 	//  - in: query
@@ -125,116 +127,122 @@ func (s *APIServer) registerPodsHandlers(r *mux.Router) error {
 	//    description: signal to be sent to pod
 	//    default: SIGKILL
 	// responses:
-	//   '204':
-	//      description: no error
-	//   '400':
-	//      $ref: "#/responses/BadParamError"
-	//   '404':
-	//      $ref: "#/responses/NoSuchPod"
-	//   '409':
-	//      $ref: "#/responses/ConflictError"
-	//   '500':
-	//      $ref: "#/responses/InternalError"
-	r.Handle(VersionedPath("/libpod/pods/{name:..*}/kill"), APIHandler(s.Context, libpod.PodKill)).Methods(http.MethodPost)
-	// swagger:operation POST /libpod/pods/{nameOrID}/pause pods pausePod
+	//   204:
+	//     description: no error
+	//   400:
+	//     $ref: "#/responses/BadParamError"
+	//   404:
+	//     $ref: "#/responses/NoSuchPod"
+	//   409:
+	//     $ref: "#/responses/ConflictError"
+	//   500:
+	//     $ref: "#/responses/InternalError"
+	r.Handle(VersionedPath("/libpod/pods/{name}/kill"), APIHandler(s.Context, libpod.PodKill)).Methods(http.MethodPost)
+	// swagger:operation POST /libpod/pods/{name}/pause pods pausePod
 	// ---
 	// summary: Pause a pod
+	// description: Pause a pod
 	// produces:
 	// - application/json
 	// parameters:
 	//  - in: path
-	//    name: nameOrID
+	//    name: name
+	//    type: string
 	//    required: true
 	//    description: the name or ID of the pod
 	// responses:
-	//   '204':
-	//      description: no error
-	//   '404':
-	//      $ref: "#/responses/NoSuchPod"
-	//   '500':
-	//      $ref: "#/responses/InternalError"
-	r.Handle(VersionedPath("/libpod/pods/{name:..*}/pause"), APIHandler(s.Context, libpod.PodPause)).Methods(http.MethodPost)
-	// swagger:operation POST /libpod/pods/{nameOrID}/restart pods restartPod
+	//   204:
+	//     description: no error
+	//   404:
+	//     $ref: "#/responses/NoSuchPod"
+	//   500:
+	//     $ref: "#/responses/InternalError"
+	r.Handle(VersionedPath("/libpod/pods/{name}/pause"), APIHandler(s.Context, libpod.PodPause)).Methods(http.MethodPost)
+	// swagger:operation POST /libpod/pods/{name}/restart pods restartPod
 	// ---
 	// summary: Restart a pod
 	// produces:
 	// - application/json
 	// parameters:
 	//  - in: path
-	//    name: nameOrID
+	//    name: name
+	//    type: string
 	//    required: true
 	//    description: the name or ID of the pod
 	// responses:
-	//   '204':
-	//      description: no error
-	//   '404':
-	//      $ref: "#/responses/NoSuchPod"
-	//   '500':
-	//      $ref: "#/responses/InternalError"
-	r.Handle(VersionedPath("/libpod/pods/{name:..*}/restart"), APIHandler(s.Context, libpod.PodRestart)).Methods(http.MethodPost)
-	// swagger:operation POST /libpod/pods/{nameOrID}/start pods startPod
+	//   204:
+	//     description: no error
+	//   404:
+	//     $ref: "#/responses/NoSuchPod"
+	//   500:
+	//     $ref: "#/responses/InternalError"
+	r.Handle(VersionedPath("/libpod/pods/{name}/restart"), APIHandler(s.Context, libpod.PodRestart)).Methods(http.MethodPost)
+	// swagger:operation POST /libpod/pods/{name}/start pods startPod
 	// ---
 	// summary: Start a pod
 	// produces:
 	// - application/json
 	// parameters:
 	//  - in: path
-	//    name: nameOrID
+	//    name: name
+	//    type: string
 	//    required: true
 	//    description: the name or ID of the pod
 	// responses:
-	//   '204':
-	//      description: no error
-	//   '304':
-	//      $ref: "#/responses/PodAlreadyStartedError"
-	//   '404':
-	//      $ref: "#/responses/NoSuchPod"
-	//   '500':
-	//      $ref: "#/responses/InternalError"
-	r.Handle(VersionedPath("/libpod/pods/{name:..*}/start"), APIHandler(s.Context, libpod.PodStart)).Methods(http.MethodPost)
-	// swagger:operation POST /libpod/pods/{nameOrID}/stop pods stopPod
+	//   204:
+	//     description: no error
+	//   304:
+	//     $ref: "#/responses/PodAlreadyStartedError"
+	//   404:
+	//     $ref: "#/responses/NoSuchPod"
+	//   500:
+	//     $ref: "#/responses/InternalError"
+	r.Handle(VersionedPath("/libpod/pods/{name}/start"), APIHandler(s.Context, libpod.PodStart)).Methods(http.MethodPost)
+	// swagger:operation POST /libpod/pods/{name}/stop pods stopPod
 	// ---
 	// summary: Stop a pod
 	// produces:
 	// - application/json
 	// parameters:
 	//  - in: path
-	//    name: nameOrID
+	//    name: name
+	//    type: string
 	//    required: true
 	//    description: the name or ID of the pod
 	//  - in: query
 	//    name: t
-	//    type: int
+	//    type: integer
 	//    description: timeout
 	// responses:
-	//   '204':
-	//      description: no error
-	//   '304':
-	//      $ref: "#/responses/PodAlreadyStoppedError"
-	//   '400':
-	//      $ref: "#/responses/BadParamError"
-	//   '404':
-	//      $ref: "#/responses/NoSuchPod"
-	//   '500':
-	//      $ref: "#/responses/InternalError"
-	r.Handle(VersionedPath("/libpod/pods/{name:..*}/stop"), APIHandler(s.Context, libpod.PodStop)).Methods(http.MethodPost)
-	// swagger:operation POST /libpod/pods/{nameOrID}/unpause pods unpausePod
+	//   204:
+	//     description: no error
+	//   304:
+	//     $ref: "#/responses/PodAlreadyStoppedError"
+	//   400:
+	//     $ref: "#/responses/BadParamError"
+	//   404:
+	//     $ref: "#/responses/NoSuchPod"
+	//   500:
+	//     $ref: "#/responses/InternalError"
+	r.Handle(VersionedPath("/libpod/pods/{name}/stop"), APIHandler(s.Context, libpod.PodStop)).Methods(http.MethodPost)
+	// swagger:operation POST /libpod/pods/{name}/unpause pods unpausePod
 	// ---
 	// summary: Unpause a pod
 	// produces:
 	// - application/json
 	// parameters:
 	//  - in: path
-	//    name: nameOrID
+	//    name: name
+	//    type: string
 	//    required: true
 	//    description: the name or ID of the pod
 	// responses:
-	//   '204':
-	//      description: no error
-	//   '404':
-	//      $ref: "#/responses/NoSuchPod"
-	//   '500':
-	//      $ref: "#/responses/InternalError"
-	r.Handle(VersionedPath("/libpod/pods/{name:..*}/unpause"), APIHandler(s.Context, libpod.PodUnpause)).Methods(http.MethodPost)
+	//   204:
+	//     description: no error
+	//   404:
+	//     $ref: "#/responses/NoSuchPod"
+	//   500:
+	//     $ref: "#/responses/InternalError"
+	r.Handle(VersionedPath("/libpod/pods/{name}/unpause"), APIHandler(s.Context, libpod.PodUnpause)).Methods(http.MethodPost)
 	return nil
 }