containers
/
podman
mirror of https://github.com/containers/podman.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[CI:DOCS] Update swagger definition of inspect manifest 

* Changed reference in swagger to correct struture that was being
  returned.
* Added summary to ManifestAddLibpod to clean up generated web site
* Added serve target to Makefile, to aid in debugging generated
  web site

Signed-off-by: Jhon Honce <jhonce@redhat.com>
This commit is contained in:
Jhon Honce 2021-04-07 09:18:23 -07:00
parent 51b23be38b
commit 9b35262ca2
3 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
pkg/api/Makefile
View File

@ -5,6 +5,9 @@ SWAGGER_OUT ?= swagger.yaml
validate: ${SWAGGER_OUT} validate: ${SWAGGER_OUT}
swagger validate ${SWAGGER_OUT} swagger validate ${SWAGGER_OUT}
serve: ${SWAGGER_OUT}
swagger serve -F redoc -p=8080 swagger.yaml
.PHONY: ${SWAGGER_OUT} .PHONY: ${SWAGGER_OUT}
${SWAGGER_OUT}: ${SWAGGER_OUT}:
# generate doesn't remove file on error # generate doesn't remove file on error

2
pkg/api/handlers/libpod/swagger.go
View File

@ -25,7 +25,7 @@ type swagInspectPodResponse struct {
// swagger:response InspectManifest // swagger:response InspectManifest
type swagInspectManifestResponse struct { type swagInspectManifestResponse struct {
// in:body // in:body
Body manifest.List Body manifest.Schema2List
} }
// Kill Pod // Kill Pod

1
pkg/api/server/register_manifest.go
View File

@ -81,6 +81,7 @@ func (s *APIServer) registerManifestHandlers(r *mux.Router) error {
r.Handle(VersionedPath("/libpod/manifests/{name:.*}/json"), s.APIHandler(libpod.ManifestInspect)).Methods(http.MethodGet) r.Handle(VersionedPath("/libpod/manifests/{name:.*}/json"), s.APIHandler(libpod.ManifestInspect)).Methods(http.MethodGet)
// swagger:operation POST /libpod/manifests/{name:.*}/add manifests ManifestAddLibpod // swagger:operation POST /libpod/manifests/{name:.*}/add manifests ManifestAddLibpod
// --- // ---
// summary: Add image
// description: Add an image to a manifest list // description: Add an image to a manifest list
// produces: // produces:
// - application/json // - application/json