summaryrefslogtreecommitdiff
path: root/pkg/api/handlers/swagger.go
diff options
context:
space:
mode:
authorValentin Rothberg <rothberg@redhat.com>2020-02-03 12:28:05 +0100
committerValentin Rothberg <rothberg@redhat.com>2020-02-04 10:45:54 +0100
commit84381df8105f94814e4f532542df9fda4152cbc4 (patch)
tree547adfcd03c1ee59179dea7cfff2fa731252b948 /pkg/api/handlers/swagger.go
parent54926d1b034efc6d8edad30dda6e85b8157145ed (diff)
downloadpodman-84381df8105f94814e4f532542df9fda4152cbc4.tar.gz
podman-84381df8105f94814e4f532542df9fda4152cbc4.tar.bz2
podman-84381df8105f94814e4f532542df9fda4152cbc4.zip
swagger: v2: libpod/images/{import,load,pull}
Note: this commit is merely adding swagger documentation and the golang stubs and types for the proposed endpoints. The implementation will follow in separate individual changes in the future. The ultimate goal is to prevent the libpod API from exposing the rather complex /images/create endpoint from Docker and split it into easier to implement, use and comprehend endpoints with a more narrow focus. # Import Add the v2 swagger documentation for the libpod/images/import endpoint. Note that we have intend to have separate backend and not mix it up with load since import allows for specifying a URL instead of a local tarball. # Load Complete the v2 swagger documentation for the libpod/images/load endpoint. Note that we are accounting for future plans to be able to load multiple images from one oci/docker archive by returning an array of image-load responses. Also move the (incomplete) implementation of the generic endpoint to the corresponding package and create a stub for the libpod handler, which will be implemented once there's an agreement on the proposed API. # Pull Add the v2 swagger documentation for the libpod/images/pull endpoint. Similar to the load endpoint, we return an array since more than one image can be pulled when the `all-tags` parameter is set. Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
Diffstat (limited to 'pkg/api/handlers/swagger.go')
-rw-r--r--pkg/api/handlers/swagger.go21
1 files changed, 21 insertions, 0 deletions
diff --git a/pkg/api/handlers/swagger.go b/pkg/api/handlers/swagger.go
index faae98798..bc75777aa 100644
--- a/pkg/api/handlers/swagger.go
+++ b/pkg/api/handlers/swagger.go
@@ -26,6 +26,27 @@ type swagImageInspect struct {
}
}
+// Load response
+// swagger:response DocsLibpodImagesLoadResponse
+type swagLibpodImagesLoadResponse struct {
+ // in:body
+ Body []LibpodImagesLoadReport
+}
+
+// Import response
+// swagger:response DocsLibpodImagesImportResponse
+type swagLibpodImagesImportResponse struct {
+ // in:body
+ Body LibpodImagesImportReport
+}
+
+// Pull response
+// swagger:response DocsLibpodImagesPullResponse
+type swagLibpodImagesPullResponse struct {
+ // in:body
+ Body LibpodImagesPullReport
+}
+
// Delete response
// swagger:response DocsImageDeleteResponse
type swagImageDeleteResponse struct {