summaryrefslogtreecommitdiff
path: root/pkg/api/server/swagger.go
diff options
context:
space:
mode:
authorJhon Honce <jhonce@redhat.com>2020-01-22 10:41:35 -0700
committerJhon Honce <jhonce@redhat.com>2020-01-22 15:17:14 -0700
commitda1186ae639c8101f05e4350986fdab0b1bd3566 (patch)
treedfc8a73189dc16f9f36b3cf9f56f571ccbc4cfc3 /pkg/api/server/swagger.go
parentc42383f70a7832faf1ba920d6c9e169a88b0e4d9 (diff)
downloadpodman-da1186ae639c8101f05e4350986fdab0b1bd3566.tar.gz
podman-da1186ae639c8101f05e4350986fdab0b1bd3566.tar.bz2
podman-da1186ae639c8101f05e4350986fdab0b1bd3566.zip
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>
Diffstat (limited to 'pkg/api/server/swagger.go')
-rw-r--r--pkg/api/server/swagger.go26
1 files changed, 23 insertions, 3 deletions
diff --git a/pkg/api/server/swagger.go b/pkg/api/server/swagger.go
index dbf499ce7..f6643600a 100644
--- a/pkg/api/server/swagger.go
+++ b/pkg/api/server/swagger.go
@@ -41,7 +41,7 @@ type swagErrNoSuchPod struct {
}
}
-// Internal error
+// Internal server error
// swagger:response InternalError
type swagInternalError struct {
// in:body
@@ -59,7 +59,7 @@ type swagGenericError struct {
}
}
-// Conflict error
+// Conflict error in operation
// swagger:response ConflictError
type swagConflictError struct {
// in:body
@@ -68,7 +68,7 @@ type swagConflictError struct {
}
}
-// Bad parameter
+// Bad parameter in request
// swagger:response BadParamError
type swagBadParamError struct {
// in:body
@@ -134,3 +134,23 @@ type swagListContainers struct {
// swagger:response tbd
type swagTBD struct {
}
+
+// Success
+// swagger:response
+type swag struct {
+ // in:body
+ Body struct {
+ // example: OK
+ ok string
+ }
+}
+
+// Success
+// swagger:response
+type ok struct {
+ // in:body
+ Body struct {
+ // example: OK
+ ok string
+ }
+}