From 5b79cf15a0226dc3dad5053615ee652823376cd3 Mon Sep 17 00:00:00 2001 From: Jhon Honce Date: Thu, 19 May 2022 10:27:31 -0700 Subject: Swagger refactor/cleanup * Remove duplicate or unused types and constants * Move all documetation-only models and responses into swagger package * Remove all unecessary names, go-swagger will determine names from struct declarations * Use Libpod suffix to differentiate between compat and libpod models and responses. Taken from swagger:operation declarations. * Models and responses that start with lowercase are for swagger use only while uppercase are used "as is" in the code and swagger comments * Used gofumpt on new code ```release-note ``` Signed-off-by: Jhon Honce --- pkg/domain/entities/volumes.go | 140 ++--------------------------------------- 1 file changed, 5 insertions(+), 135 deletions(-) (limited to 'pkg/domain/entities/volumes.go') diff --git a/pkg/domain/entities/volumes.go b/pkg/domain/entities/volumes.go index f2e60a0db..84f85b83f 100644 --- a/pkg/domain/entities/volumes.go +++ b/pkg/domain/entities/volumes.go @@ -4,75 +4,10 @@ import ( "net/url" "github.com/containers/podman/v4/libpod/define" - docker_api_types "github.com/docker/docker/api/types" - docker_api_types_volume "github.com/docker/docker/api/types/volume" ) -// Volume volume -// swagger:model Volume -type volume struct { - - // Date/Time the volume was created. - CreatedAt string `json:"CreatedAt,omitempty"` - - // Name of the volume driver used by the volume. - // Required: true - Driver string `json:"Driver"` - - // User-defined key/value metadata. - // Required: true - Labels map[string]string `json:"Labels"` - - // Mount path of the volume on the host. - // Required: true - Mountpoint string `json:"Mountpoint"` - - // Name of the volume. - // Required: true - Name string `json:"Name"` - - // The driver specific options used when creating the volume. - // - // Required: true - Options map[string]string `json:"Options"` - - // The level at which the volume exists. Either `global` for cluster-wide, - // or `local` for machine level. - // - // Required: true - Scope string `json:"Scope"` - - // Low-level details about the volume, provided by the volume driver. - // Details are returned as a map with key/value pairs: - // `{"key":"value","key2":"value2"}`. - // - // The `Status` field is optional, and is omitted if the volume driver - // does not support this feature. - // - Status map[string]interface{} `json:"Status,omitempty"` - - // usage data - UsageData *VolumeUsageData `json:"UsageData,omitempty"` -} - -type VolumeUsageData struct { - - // The number of containers referencing this volume. This field - // is set to `-1` if the reference-count is not available. - // - // Required: true - RefCount int64 `json:"RefCount"` - - // Amount of disk space used by the volume (in bytes). This information - // is only available for volumes created with the `"local"` volume - // driver. For volumes created with other volume drivers, this field - // is set to `-1` ("not available") - // - // Required: true - Size int64 `json:"Size"` -} - -// swagger:model VolumeCreate +// VolumeCreateOptions provides details for creating volumes +// swagger:model type VolumeCreateOptions struct { // New volume's name. Can be left blank Name string `schema:"name"` @@ -86,11 +21,6 @@ type VolumeCreateOptions struct { Options map[string]string `schema:"opts"` } -type IDOrNameResponse struct { - // The Id or Name of an object - IDOrName string -} - type VolumeConfigResponse struct { define.InspectVolumeData } @@ -103,7 +33,7 @@ type VolumeRmOptions struct { type VolumeRmReport struct { Err error - Id string //nolint + Id string // nolint } type VolumeInspectReport struct { @@ -124,74 +54,14 @@ type VolumeListReport struct { VolumeConfigResponse } -// VolumeListBody Volume list response -// swagger:model VolumeListBody -type VolumeListBody struct { - Volumes []docker_api_types_volume.VolumeListOKBody -} - -// Volume list response -// swagger:response VolumeListResponse -type SwagVolumeListResponse struct { - // in:body - Body struct { - VolumeListBody - } -} - /* * Docker API compatibility types */ -// swagger:model DockerVolumeCreate -type DockerVolumeCreate VolumeCreateBody - -// This response definition is used for both the create and inspect endpoints -// swagger:response DockerVolumeInfoResponse -type SwagDockerVolumeInfoResponse struct { - // in:body - Body struct { - volume - } -} - -// Volume prune response -// swagger:response DockerVolumePruneResponse -type SwagDockerVolumePruneResponse struct { - // in:body - Body struct { - docker_api_types.VolumesPruneReport - } -} - -// VolumeCreateBody Volume configuration -// swagger:model VolumeCreateBody -type VolumeCreateBody struct { - - // Name of the volume driver to use. - // Required: true - Driver string `json:"Driver"` - - // A mapping of driver options and values. These options are - // passed directly to the driver and are driver specific. - // - // Required: true - DriverOpts map[string]string `json:"DriverOpts"` - - // User-defined key/value metadata. - // Required: true - Labels map[string]string `json:"Labels"` - - // The new volume's name. If not specified, Docker generates a name. - // - // Required: true - Name string `json:"Name"` -} - // VolumeMountReport describes the response from volume mount type VolumeMountReport struct { Err error - Id string //nolint + Id string // nolint Name string Path string } @@ -199,5 +69,5 @@ type VolumeMountReport struct { // VolumeUnmountReport describes the response from umounting a volume type VolumeUnmountReport struct { Err error - Id string //nolint + Id string // nolint } -- cgit v1.2.3-54-g00ecf