github.com/hanks177/podman/v4@v4.1.3-0.20220613032544-16d90015bc83/pkg/api/handlers/swagger/responses.go (about)

     1  //nolint:deadcode,unused // these types are used to wire generated swagger to API code
     2  package swagger
     3  
     4  import (
     5  	"github.com/containers/common/libnetwork/types"
     6  	"github.com/containers/image/v5/manifest"
     7  	"github.com/hanks177/podman/v4/libpod/define"
     8  	"github.com/hanks177/podman/v4/pkg/api/handlers"
     9  	"github.com/hanks177/podman/v4/pkg/domain/entities"
    10  	"github.com/hanks177/podman/v4/pkg/domain/entities/reports"
    11  	"github.com/hanks177/podman/v4/pkg/inspect"
    12  	dockerAPI "github.com/docker/docker/api/types"
    13  	dockerVolume "github.com/docker/docker/api/types/volume"
    14  )
    15  
    16  // Image Tree
    17  // swagger:response
    18  type treeResponse struct {
    19  	// in:body
    20  	Body entities.ImageTreeReport
    21  }
    22  
    23  // Image History
    24  // swagger:response
    25  type history struct {
    26  	// in:body
    27  	Body handlers.HistoryResponse
    28  }
    29  
    30  // Image Inspect
    31  // swagger:response
    32  type imageInspect struct {
    33  	// in:body
    34  	Body handlers.ImageInspect
    35  }
    36  
    37  // Image Load
    38  // swagger:response
    39  type imagesLoadResponseLibpod struct {
    40  	// in:body
    41  	Body entities.ImageLoadReport
    42  }
    43  
    44  // Image Import
    45  // swagger:response
    46  type imagesImportResponseLibpod struct {
    47  	// in:body
    48  	Body entities.ImageImportReport
    49  }
    50  
    51  // Image Pull
    52  // swagger:response
    53  type imagesPullResponseLibpod struct {
    54  	// in:body
    55  	Body handlers.LibpodImagesPullReport
    56  }
    57  
    58  // Image Remove
    59  // swagger:response
    60  type imagesRemoveResponseLibpod struct {
    61  	// in:body
    62  	Body handlers.LibpodImagesRemoveReport
    63  }
    64  
    65  // PlayKube response
    66  // swagger:response
    67  type playKubeResponseLibpod struct {
    68  	// in:body
    69  	Body entities.PlayKubeReport
    70  }
    71  
    72  // Image Delete
    73  // swagger:response
    74  type imageDeleteResponse struct {
    75  	// in:body
    76  	Body []struct {
    77  		Untagged []string `json:"untagged"`
    78  		Deleted  string   `json:"deleted"`
    79  	}
    80  }
    81  
    82  // Registry Search
    83  // swagger:response
    84  type registrySearchResponse struct {
    85  	// in:body
    86  	Body struct {
    87  		// Index is the image index
    88  		// example: quay.io
    89  		Index string
    90  		// Name is the canonical name of the image
    91  		// example: docker.io/library/alpine"
    92  		Name string
    93  		// Description of the image.
    94  		Description string
    95  		// Stars is the number of stars of the image.
    96  		Stars int
    97  		// Official indicates if it's an official image.
    98  		Official string
    99  		// Automated indicates if the image was created by an automated build.
   100  		Automated string
   101  		// Tag is the image tag
   102  		Tag string
   103  	}
   104  }
   105  
   106  // Inspect Image
   107  // swagger:response
   108  type inspectImageResponseLibpod struct {
   109  	// in:body
   110  	Body inspect.ImageData
   111  }
   112  
   113  // Inspect container
   114  // swagger:response
   115  type containerInspectResponse struct {
   116  	// in:body
   117  	Body dockerAPI.ContainerJSON
   118  }
   119  
   120  // List processes in container
   121  // swagger:response
   122  type containerTopResponse struct {
   123  	// in:body
   124  	Body handlers.ContainerTopOKBody
   125  }
   126  
   127  // List processes in pod
   128  // swagger:response
   129  type podTopResponse struct {
   130  	// in:body
   131  	Body handlers.PodTopOKBody
   132  }
   133  
   134  // Pod Statistics
   135  // swagger:response
   136  type podStatsResponse struct {
   137  	// in:body
   138  	Body []entities.PodStatsReport
   139  }
   140  
   141  // Inspect container
   142  // swagger:response
   143  type containerInspectResponseLibpod struct {
   144  	// in:body
   145  	Body define.InspectContainerData
   146  }
   147  
   148  // List pods
   149  // swagger:response
   150  type podsListResponse struct {
   151  	// in:body
   152  	Body []entities.ListPodsReport
   153  }
   154  
   155  // Inspect pod
   156  // swagger:response
   157  type podInspectResponse struct {
   158  	// in:body
   159  	Body define.InspectPodData
   160  }
   161  
   162  // Volume details
   163  // swagger:response
   164  type volumeCreateResponse struct {
   165  	// in:body
   166  	Body entities.VolumeConfigResponse
   167  }
   168  
   169  // Healthcheck Results
   170  // swagger:response
   171  type healthCheck struct {
   172  	// in:body
   173  	Body define.HealthCheckResults
   174  }
   175  
   176  // Version
   177  // swagger:response
   178  type versionResponse struct {
   179  	// in:body
   180  	Body entities.ComponentVersion
   181  }
   182  
   183  // Disk usage
   184  // swagger:response
   185  type systemDiskUsage struct {
   186  	// in:body
   187  	Body entities.SystemDfReport
   188  }
   189  
   190  // System Prune results
   191  // swagger:response
   192  type systemPruneResponse struct {
   193  	// in:body
   194  	Body entities.SystemPruneReport
   195  }
   196  
   197  // Auth response
   198  // swagger:response
   199  type systemAuthResponse struct {
   200  	// in:body
   201  	Body entities.AuthReport
   202  }
   203  
   204  // Exec Session Inspect
   205  // swagger:response
   206  type execSessionInspect struct {
   207  	// in:body
   208  	Body define.InspectExecSession
   209  }
   210  
   211  // Image summary for compat API
   212  // swagger:response
   213  type imageList struct {
   214  	// in:body
   215  	Body []dockerAPI.ImageSummary
   216  }
   217  
   218  // Image summary for libpod API
   219  // swagger:response
   220  type imageListLibpod struct {
   221  	// in:body
   222  	Body []entities.ImageSummary
   223  }
   224  
   225  // List Containers
   226  // swagger:response
   227  type containersList struct {
   228  	// in:body
   229  	Body []handlers.Container
   230  }
   231  
   232  // This response definition is used for both the create and inspect endpoints
   233  // swagger:response
   234  type volumeInspect struct {
   235  	// in:body
   236  	Body dockerAPI.Volume
   237  }
   238  
   239  // Volume prune
   240  // swagger:response
   241  type volumePruneResponse struct {
   242  	// in:body
   243  	Body dockerAPI.VolumesPruneReport
   244  }
   245  
   246  // Volume List
   247  // swagger:response
   248  type volumeList struct {
   249  	// in:body
   250  	Body dockerVolume.VolumeListOKBody
   251  }
   252  
   253  // Volume list
   254  // swagger:response
   255  type volumeListLibpod struct {
   256  	// in:body
   257  	Body []entities.VolumeConfigResponse
   258  }
   259  
   260  // Image Prune
   261  // swagger:response
   262  type imagesPruneLibpod struct {
   263  	// in:body
   264  	Body []reports.PruneReport
   265  }
   266  
   267  // Remove Containers
   268  // swagger:response
   269  type containerRemoveLibpod struct {
   270  	// in: body
   271  	Body []handlers.LibpodContainersRmReport
   272  }
   273  
   274  // Prune Containers
   275  // swagger:response
   276  type containersPrune struct {
   277  	// in: body
   278  	Body []handlers.ContainersPruneReport
   279  }
   280  
   281  // Prune Containers
   282  // swagger:response
   283  type containersPruneLibpod struct {
   284  	// in: body
   285  	Body []handlers.ContainersPruneReportLibpod
   286  }
   287  
   288  // Get stats for one or more containers
   289  // swagger:response
   290  type containerStats struct {
   291  	// in:body
   292  	Body define.ContainerStats
   293  }
   294  
   295  // Volume Prune
   296  // swagger:response
   297  type volumePruneLibpod struct {
   298  	// in:body
   299  	Body []reports.PruneReport
   300  }
   301  
   302  // Create container
   303  // swagger:response
   304  type containerCreateResponse struct {
   305  	// in:body
   306  	Body entities.ContainerCreateResponse
   307  }
   308  
   309  // Wait container
   310  // swagger:response
   311  type containerWaitResponse struct {
   312  	// in:body
   313  	Body struct {
   314  		// container exit code
   315  		StatusCode int
   316  		Error      struct {
   317  			Message string
   318  		}
   319  	}
   320  }
   321  
   322  // Network inspect
   323  // swagger:response
   324  type networkInspectCompat struct {
   325  	// in:body
   326  	Body dockerAPI.NetworkResource
   327  }
   328  
   329  // Network list
   330  // swagger:response
   331  type networkListCompat struct {
   332  	// in:body
   333  	Body []dockerAPI.NetworkResource
   334  }
   335  
   336  // List Containers
   337  // swagger:response
   338  type containersListLibpod struct {
   339  	// in:body
   340  	Body []entities.ListContainer
   341  }
   342  
   343  // Inspect Manifest
   344  // swagger:response
   345  type manifestInspect struct {
   346  	// in:body
   347  	Body manifest.Schema2List
   348  }
   349  
   350  // Kill Pod
   351  // swagger:response
   352  type podKillResponse struct {
   353  	// in:body
   354  	Body entities.PodKillReport
   355  }
   356  
   357  // Pause pod
   358  // swagger:response
   359  type podPauseResponse struct {
   360  	// in:body
   361  	Body entities.PodPauseReport
   362  }
   363  
   364  // Unpause pod
   365  // swagger:response
   366  type podUnpauseResponse struct {
   367  	// in:body
   368  	Body entities.PodUnpauseReport
   369  }
   370  
   371  // Stop pod
   372  // swagger:response
   373  type podStopResponse struct {
   374  	// in:body
   375  	Body entities.PodStopReport
   376  }
   377  
   378  // Restart pod
   379  // swagger:response
   380  type podRestartResponse struct {
   381  	// in:body
   382  	Body entities.PodRestartReport
   383  }
   384  
   385  // Start pod
   386  // swagger:response
   387  type podStartResponse struct {
   388  	// in:body
   389  	Body entities.PodStartReport
   390  }
   391  
   392  // Prune pod
   393  // swagger:response
   394  type podPruneResponse struct {
   395  	// in:body
   396  	Body entities.PodPruneReport
   397  }
   398  
   399  // Rm pod
   400  // swagger:response
   401  type podRmResponse struct {
   402  	// in:body
   403  	Body entities.PodRmReport
   404  }
   405  
   406  // Info
   407  // swagger:response
   408  type infoResponse struct {
   409  	// in:body
   410  	Body define.Info
   411  }
   412  
   413  // Network Delete
   414  // swagger:response
   415  type networkRmResponse struct {
   416  	// in:body
   417  	Body []entities.NetworkRmReport
   418  }
   419  
   420  // Network inspect
   421  // swagger:response
   422  type networkInspectResponse struct {
   423  	// in:body
   424  	Body types.Network
   425  }
   426  
   427  // Network list
   428  // swagger:response
   429  type networkListLibpod struct {
   430  	// in:body
   431  	Body []types.Network
   432  }
   433  
   434  // Network create
   435  // swagger:model
   436  type networkCreateLibpod struct {
   437  	// in:body
   438  	types.Network
   439  }
   440  
   441  // Network create
   442  // swagger:response
   443  type networkCreateResponse struct {
   444  	// in:body
   445  	Body types.Network
   446  }
   447  
   448  // Network prune
   449  // swagger:response
   450  type networkPruneResponse struct {
   451  	// in:body
   452  	Body []entities.NetworkPruneReport
   453  }