summaryrefslogtreecommitdiff
path: root/pkg/api/server/server.go
diff options
context:
space:
mode:
authorJhon Honce <jhonce@redhat.com>2020-01-16 10:33:43 -0700
committerJhon Honce <jhonce@redhat.com>2020-01-21 14:19:42 -0700
commit68896b18e579d70822543748a2f5d95a55daaca1 (patch)
tree2765dda0be9330629c40370141bc1a7750015993 /pkg/api/server/server.go
parentf467bb20bd1c98b1706fa3c4448857800395c169 (diff)
downloadpodman-68896b18e579d70822543748a2f5d95a55daaca1.tar.gz
podman-68896b18e579d70822543748a2f5d95a55daaca1.tar.bz2
podman-68896b18e579d70822543748a2f5d95a55daaca1.zip
Update build images
* Add swagger annotations for all the query and response parameters for buildimages * Improve populating the BuildOptions struct * Improve swagger.json generation, removing tags.xml and move tag definiation into the swagger:meta block * Update Makefile to be more robust, added target for validation * TODO once validation passes add that step to the generation step Signed-off-by: Jhon Honce <jhonce@redhat.com>
Diffstat (limited to 'pkg/api/server/server.go')
-rw-r--r--pkg/api/server/server.go22
1 files changed, 14 insertions, 8 deletions
diff --git a/pkg/api/server/server.go b/pkg/api/server/server.go
index 9abedb359..a64995a26 100644
--- a/pkg/api/server/server.go
+++ b/pkg/api/server/server.go
@@ -1,6 +1,6 @@
-// Package serviceapi Provides a Container compatible interface (EXPERIMENTAL)
+// Package api Provides a container compatible interface.
//
-// This documentation describes the HTTP LibPod interface. It is to be consider
+// This documentation describes the HTTP Libpod interface. It is to be consider
// only as experimental as this point. The endpoints, parameters, inputs, and
// return values can all change.
//
@@ -25,12 +25,18 @@
// - text/html
//
// tags:
-// - name: "Containers"
-// description: manage containers
-// - name: "Images"
-// description: manage images
-// - name: "System"
-// description: manage system resources
+// - name: containers
+// description: Actions related to containers
+// - name: images
+// description: Actions related to images
+// - name: pods
+// description: Actions related to pods
+// - name: volumes
+// description: Actions related to volumes
+// - name: containers (compat)
+// description: Actions related to containers for the compatibility endpoints
+// - name: images (compat)
+// description: Actions related to images for the compatibility endpoints
//
// swagger:meta
package server