summaryrefslogtreecommitdiff
path: root/pkg/api/server/swagger.go
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2020-01-22 17:43:57 -0500
committerGitHub <noreply@github.com>2020-01-22 17:43:57 -0500
commitac3a6b80b0ccd2f9592110811ccf6fd844110b9e (patch)
tree5f788ecb4b9a1f412c7b7ae0d61bdf0a6765b513 /pkg/api/server/swagger.go
parent8b377a79c240e4480339358db3b87263ec6cfef3 (diff)
parentda1186ae639c8101f05e4350986fdab0b1bd3566 (diff)
downloadpodman-ac3a6b80b0ccd2f9592110811ccf6fd844110b9e.tar.gz
podman-ac3a6b80b0ccd2f9592110811ccf6fd844110b9e.tar.bz2
podman-ac3a6b80b0ccd2f9592110811ccf6fd844110b9e.zip
Merge pull request #4936 from jwhonce/wip/swagger2
[CI:DOCS] Enable swagger validation for each PR
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
+ }
+}