From da1186ae639c8101f05e4350986fdab0b1bd3566 Mon Sep 17 00:00:00 2001
From: Jhon Honce <jhonce@redhat.com>
Date: Wed, 22 Jan 2020 10:41:35 -0700
Subject: Enable swagger validation for each PR

* Update swagger:operation's to pass validation
* 'name' path parameter now used throughout API
* Added #/response/ok for 200 returns, TBD values have been replaced
  with legal values.

Signed-off-by: Jhon Honce <jhonce@redhat.com>
---
 pkg/api/handlers/utils/errors.go | 22 ++++++++++++----------
 1 file changed, 12 insertions(+), 10 deletions(-)

(limited to 'pkg/api/handlers/utils/errors.go')

diff --git a/pkg/api/handlers/utils/errors.go b/pkg/api/handlers/utils/errors.go
index b6f125c58..9d2081cd8 100644
--- a/pkg/api/handlers/utils/errors.go
+++ b/pkg/api/handlers/utils/errors.go
@@ -27,34 +27,34 @@ func Error(w http.ResponseWriter, apiMessage string, code int, err error) {
 	WriteJSON(w, code, em)
 }
 
-func VolumeNotFound(w http.ResponseWriter, nameOrId string, err error) {
+func VolumeNotFound(w http.ResponseWriter, name string, err error) {
 	if errors.Cause(err) != define.ErrNoSuchVolume {
 		InternalServerError(w, err)
 	}
-	msg := fmt.Sprintf("No such volume: %s", nameOrId)
+	msg := fmt.Sprintf("No such volume: %s", name)
 	Error(w, msg, http.StatusNotFound, err)
 }
-func ContainerNotFound(w http.ResponseWriter, nameOrId string, err error) {
+func ContainerNotFound(w http.ResponseWriter, name string, err error) {
 	if errors.Cause(err) != define.ErrNoSuchCtr {
 		InternalServerError(w, err)
 	}
-	msg := fmt.Sprintf("No such container: %s", nameOrId)
+	msg := fmt.Sprintf("No such container: %s", name)
 	Error(w, msg, http.StatusNotFound, err)
 }
 
-func ImageNotFound(w http.ResponseWriter, nameOrId string, err error) {
+func ImageNotFound(w http.ResponseWriter, name string, err error) {
 	if errors.Cause(err) != define.ErrNoSuchImage {
 		InternalServerError(w, err)
 	}
-	msg := fmt.Sprintf("No such image: %s", nameOrId)
+	msg := fmt.Sprintf("No such image: %s", name)
 	Error(w, msg, http.StatusNotFound, err)
 }
 
-func PodNotFound(w http.ResponseWriter, nameOrId string, err error) {
+func PodNotFound(w http.ResponseWriter, name string, err error) {
 	if errors.Cause(err) != define.ErrNoSuchPod {
 		InternalServerError(w, err)
 	}
-	msg := fmt.Sprintf("No such pod: %s", nameOrId)
+	msg := fmt.Sprintf("No such pod: %s", name)
 	Error(w, msg, http.StatusNotFound, err)
 }
 
@@ -73,9 +73,11 @@ func BadRequest(w http.ResponseWriter, key string, value string, err error) {
 }
 
 type ErrorModel struct {
-	// root cause
+	// API root cause formatted for automated parsing
+	// example: API root cause
 	Because string `json:"cause"`
-	// error message
+	// human error message, formatted for a human to read
+	// example: human error message
 	Message string `json:"message"`
 }
 
-- 
cgit v1.2.3-54-g00ecf