v1.0.0

pkg/cloudbroker/image/list.go

@@ -6,13 +6,26 @@ import (
 	"net/http"
 )
 
+// Request struct for get list available images
 type ListRequest struct {
-	SepID      uint64 `url:"sepId,omitempty"`
+	// Filter images by storage endpoint provider ID
+	// Required: false
+	SepID uint64 `url:"sepId,omitempty"`
+
+	// Filter images by account ID availability
+	// Required: false
 	SharedWith uint64 `url:"sharedWith,omitempty"`
-	Page       uint64 `url:"page,omitempty"`
-	Size       uint64 `url:"size,omitempty"`
+
+	// Page number
+	// Required: false
+	Page uint64 `url:"page,omitempty"`
+
+	// Page size
+	// Required: false
+	Size uint64 `url:"size,omitempty"`
 }
 
+// List gets list of information about images
 func (i Image) List(ctx context.Context, req ListRequest) (ListImages, error) {
 	url := "/cloudbroker/image/list"