mirror of
https://github.com/containers/podman.git
synced 2025-05-20 00:27:03 +08:00
5b79cf15a0
* 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 <jhonce@redhat.com>
18 lines
929 B
Go
18 lines
929 B
Go
// Package swagger defines the payloads used by the Podman API
|
|
//
|
|
// - errors.go: declares the errors used in the API. By embedding errors.ErrorModel, more meaningful
|
|
// comments can be provided for the developer documentation.
|
|
// - models.go: declares the models used in API requests.
|
|
// - responses.go: declares the responses used in the API responses.
|
|
//
|
|
//
|
|
// Notes:
|
|
// 1. As a developer of the Podman API, you are responsible for maintaining the associations between
|
|
// these models and responses, and the handler code.
|
|
// 2. There are a number of warnings produces when compiling the swagger yaml file. This is expected.
|
|
// Most are because embedded structs have been discovered but not used in the API declarations.
|
|
// 3. Response and model references that are exported (start with upper-case letter) imply that they
|
|
// exist outside this package and should be found in the entities package.
|
|
//
|
|
package swagger
|