summaryrefslogtreecommitdiff
path: root/pkg/api/handlers/generic/swagger.go
diff options
context:
space:
mode:
authorbaude <bbaude@redhat.com>2020-01-10 08:25:12 -0600
committerbaude <bbaude@redhat.com>2020-01-13 14:33:47 -0600
commitda4b8d3c645d69ee34b31adf029c7ba1e38c1bba (patch)
tree1d53676b32d1db0eeea558214f530d5c24c57f58 /pkg/api/handlers/generic/swagger.go
parente1ffac6cc73eb36640cbaf6a1a28ba44749a96d9 (diff)
downloadpodman-da4b8d3c645d69ee34b31adf029c7ba1e38c1bba.tar.gz
podman-da4b8d3c645d69ee34b31adf029c7ba1e38c1bba.tar.bz2
podman-da4b8d3c645d69ee34b31adf029c7ba1e38c1bba.zip
swagger documentation updates
adhere closer to the spec by using description and summary fields and also ensuring that the id is unique to avoid collision between generic and libpod endpoints. also, make swagger output work with redoc which seems to display our information better for our needs. Signed-off-by: baude <bbaude@redhat.com>
Diffstat (limited to 'pkg/api/handlers/generic/swagger.go')
-rw-r--r--pkg/api/handlers/generic/swagger.go24
1 files changed, 24 insertions, 0 deletions
diff --git a/pkg/api/handlers/generic/swagger.go b/pkg/api/handlers/generic/swagger.go
new file mode 100644
index 000000000..8df961b94
--- /dev/null
+++ b/pkg/api/handlers/generic/swagger.go
@@ -0,0 +1,24 @@
+package generic
+
+// Create container
+// swagger:response ContainerCreateResponse
+type swagCtrCreateResponse struct {
+ // in:body
+ Body struct {
+ ContainerCreateResponse
+ }
+}
+
+// Wait container
+// swagger:response ContainerWaitResponse
+type swagCtrWaitResponse struct {
+ // in:body
+ Body struct {
+ // container exit code
+ StatusCode int
+ error message
+ Error struct {
+ Message string
+ }
+ }
+}