[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 <[email protected]>
mheon · Apr 16, 2021 · 1df7f8e · 1df7f8e
1 parent 3338901
commit 1df7f8e
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 1 deletion.
diff --git a/pkg/api/Makefile b/pkg/api/Makefile
@@ -5,6 +5,9 @@ SWAGGER_OUT ?= swagger.yaml
 validate: ${SWAGGER_OUT}
 	swagger validate ${SWAGGER_OUT}
 
+serve: ${SWAGGER_OUT}
+	swagger serve -F redoc -p=8080 swagger.yaml
+
 .PHONY: ${SWAGGER_OUT}
 ${SWAGGER_OUT}:
 	# generate doesn't remove file on error

diff --git a/pkg/api/handlers/libpod/swagger.go b/pkg/api/handlers/libpod/swagger.go
@@ -25,7 +25,7 @@ type swagInspectPodResponse struct {
 // swagger:response InspectManifest
 type swagInspectManifestResponse struct {
 	// in:body
-	Body manifest.List
+	Body manifest.Schema2List
 }
 
 // Kill Pod

diff --git a/pkg/api/server/register_manifest.go b/pkg/api/server/register_manifest.go
@@ -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)
 	// swagger:operation POST /libpod/manifests/{name:.*}/add manifests AddManifest
 	// ---
+	// summary: Add image
 	// description: Add an image to a manifest list
 	// produces:
 	// - application/json