Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[CI:DOCS] fix swagger api docs #7416

Merged
merged 1 commit into from
Aug 28, 2020
Merged

[CI:DOCS] fix swagger api docs #7416

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion hack/swagger-check
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ sub handle_handle {
}

# Special case: the following endpoints all get a custom tag
if ($endpoint =~ m!/(volumes|pods|manifests)/!) {
if ($endpoint =~ m!/(pods|manifests)/!) {
$tag = $1;
$operation =~ s/^libpod//;
$operation = lcfirst $operation;
Expand Down
2 changes: 1 addition & 1 deletion pkg/api/server/register_images.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -625,7 +625,7 @@ func (s *APIServer) registerImagesHandlers(r *mux.Router) error {
// swagger:operation POST /libpod/images/{name:.*}/push libpod libpodPushImage
// ---
// tags:
// - images (libpod)
// - images
// summary: Push Image
// description: Push an image to a container registry
// parameters:
Expand Down
38 changes: 29 additions & 9 deletions pkg/api/server/register_volumes.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,10 @@ import (
)

func (s *APIServer) registerVolumeHandlers(r *mux.Router) error {
// swagger:operation POST /libpod/volumes/create volumes libpodCreateVolume
// swagger:operation POST /libpod/volumes/create libpod libpodCreateVolume
// ---
// tags:
// - volumes
// summary: Create a volume
// parameters:
// - in: body
Expand All @@ -26,8 +28,10 @@ func (s *APIServer) registerVolumeHandlers(r *mux.Router) error {
// '500':
// "$ref": "#/responses/InternalError"
r.Handle(VersionedPath("/libpod/volumes/create"), s.APIHandler(libpod.CreateVolume)).Methods(http.MethodPost)
// swagger:operation GET /libpod/volumes/json volumes libpodListVolumes
// swagger:operation GET /libpod/volumes/json libpod libpodListVolumes
// ---
// tags:
// - volumes
// summary: List volumes
// description: Returns a list of volumes
// produces:
Expand All @@ -48,8 +52,10 @@ func (s *APIServer) registerVolumeHandlers(r *mux.Router) error {
// '500':
// "$ref": "#/responses/InternalError"
r.Handle(VersionedPath("/libpod/volumes/json"), s.APIHandler(libpod.ListVolumes)).Methods(http.MethodGet)
// swagger:operation POST /libpod/volumes/prune volumes libpodPruneVolumes
// swagger:operation POST /libpod/volumes/prune libpod libpodPruneVolumes
// ---
// tags:
// - volumes
// summary: Prune volumes
// produces:
// - application/json
Expand All @@ -59,8 +65,10 @@ func (s *APIServer) registerVolumeHandlers(r *mux.Router) error {
// '500':
// "$ref": "#/responses/InternalError"
r.Handle(VersionedPath("/libpod/volumes/prune"), s.APIHandler(libpod.PruneVolumes)).Methods(http.MethodPost)
// swagger:operation GET /libpod/volumes/{name}/json volumes libpodInspectVolume
// swagger:operation GET /libpod/volumes/{name}/json libpod libpodInspectVolume
// ---
// tags:
// - volumes
// summary: Inspect volume
// parameters:
// - in: path
Expand All @@ -78,8 +86,10 @@ func (s *APIServer) registerVolumeHandlers(r *mux.Router) error {
// '500':
// "$ref": "#/responses/InternalError"
r.Handle(VersionedPath("/libpod/volumes/{name}/json"), s.APIHandler(libpod.InspectVolume)).Methods(http.MethodGet)
// swagger:operation DELETE /libpod/volumes/{name} volumes libpodRemoveVolume
// swagger:operation DELETE /libpod/volumes/{name} libpod libpodRemoveVolume
// ---
// tags:
// - volumes
// summary: Remove volume
// parameters:
// - in: path
Expand Down Expand Up @@ -110,6 +120,8 @@ func (s *APIServer) registerVolumeHandlers(r *mux.Router) error {

// swagger:operation GET /volumes compat listVolumes
// ---
// tags:
// - volumes (compat)
// summary: List volumes
// description: Returns a list of volume
// produces:
Expand All @@ -134,8 +146,10 @@ func (s *APIServer) registerVolumeHandlers(r *mux.Router) error {
r.Handle(VersionedPath("/volumes"), s.APIHandler(compat.ListVolumes)).Methods(http.MethodGet)
r.Handle("/volumes", s.APIHandler(compat.ListVolumes)).Methods(http.MethodGet)

// swagger:operation POST /volumes/create volumes createVolume
// swagger:operation POST /volumes/create compat createVolume
// ---
// tags:
// - volumes (compat)
// summary: Create a volume
// parameters:
// - in: body
Expand All @@ -153,8 +167,10 @@ func (s *APIServer) registerVolumeHandlers(r *mux.Router) error {
r.Handle(VersionedPath("/volumes/create"), s.APIHandler(compat.CreateVolume)).Methods(http.MethodPost)
r.Handle("/volumes/create", s.APIHandler(compat.CreateVolume)).Methods(http.MethodPost)

// swagger:operation GET /volumes/{name} volumes inspectVolume
// swagger:operation GET /volumes/{name} compat inspectVolume
// ---
// tags:
// - volumes (compat)
// summary: Inspect volume
// parameters:
// - in: path
Expand All @@ -174,8 +190,10 @@ func (s *APIServer) registerVolumeHandlers(r *mux.Router) error {
r.Handle(VersionedPath("/volumes/{name}"), s.APIHandler(compat.InspectVolume)).Methods(http.MethodGet)
r.Handle("/volumes/{name}", s.APIHandler(compat.InspectVolume)).Methods(http.MethodGet)

// swagger:operation DELETE /volumes/{name} volumes removeVolume
// swagger:operation DELETE /volumes/{name} compat removeVolume
// ---
// tags:
// - volumes (compat)
// summary: Remove volume
// parameters:
// - in: path
Expand Down Expand Up @@ -204,8 +222,10 @@ func (s *APIServer) registerVolumeHandlers(r *mux.Router) error {
r.Handle(VersionedPath("/volumes/{name}"), s.APIHandler(compat.RemoveVolume)).Methods(http.MethodDelete)
r.Handle("/volumes/{name}", s.APIHandler(compat.RemoveVolume)).Methods(http.MethodDelete)

// swagger:operation POST /volumes/prune volumes pruneVolumes
// swagger:operation POST /volumes/prune compat pruneVolumes
// ---
// tags:
// - volumes (compat)
// summary: Prune volumes
// produces:
// - application/json
Expand Down
2 changes: 2 additions & 0 deletions pkg/api/tags.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,7 @@ tags:
description: Actions related to images for the compatibility endpoints
- name: networks (compat)
description: Actions related to compatibility networks
- name: volumes (compat)
description: Actions related to volumes for the compatibility endpoints
- name: system (compat)
description: Actions related to Podman and compatibility engines