opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-06-09 09:04:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

fix swagger docs and make sure docs validation runs

Browse Source 
Signed-off-by: Brent Baude <bbaude@redhat.com>
This commit is contained in:
Brent Baude
2020-02-04 16:47:03 -06:00
parent fc0673f561
commit c0b14ee29a
2 changed files with 36 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.cirrus.yml
View File

@ -683,9 +683,7 @@ docs_task:
# Only run this for PRs on mention, and after merge # Only run this for PRs on mention, and after merge
only_if: >- only_if: >-
$CIRRUS_BRANCH == $DEST_BRANCH && $CIRRUS_BRANCH != $DEST_BRANCH
$CIRRUS_CHANGE_MESSAGE !=~ '.*CI:IMG.*' &&
$CIRRUS_CHANGE_MESSAGE =~ '.*CI:DOCS.*'
depends_on: depends_on:
- "gating" - "gating"

28
pkg/api/server/register_images.go
View File

@ -646,17 +646,16 @@ func (s *APIServer) registerImagesHandlers(r *mux.Router) error {
// name: message // name: message
// description: Set commit message for imported image // description: Set commit message for imported image
// type: string // type: string
// - in: body // - in: formData
// name: request // name: upload
// description: tarball of container image // description: tarball of container image
// type: file
// required: true // required: true
// schema:
// type: string
// produces: // produces:
// - application/json // - application/json
// responses: // responses:
// 200: // 200:
// $ref: "#/response/LibpodImagesLoadResponse" // $ref: "#/responses/DocsLibpodImagesLoadResponse"
// 500: // 500:
// $ref: '#/responses/InternalError' // $ref: '#/responses/InternalError'
r.Handle(VersionedPath("/libpod/images/load"), APIHandler(s.Context, libpod.ImagesLoad)).Methods(http.MethodPost) r.Handle(VersionedPath("/libpod/images/load"), APIHandler(s.Context, libpod.ImagesLoad)).Methods(http.MethodPost)
@ -665,7 +664,7 @@ func (s *APIServer) registerImagesHandlers(r *mux.Router) error {
// tags: // tags:
// - images // - images
// summary: Import image // summary: Import image
// description: Import a previosly exported tarball as an image. // description: Import a previously exported tarball as an image.
// parameters: // parameters:
// - in: query // - in: query
// name: change // name: change
@ -678,18 +677,17 @@ func (s *APIServer) registerImagesHandlers(r *mux.Router) error {
// - in: query // - in: query
// name: url // name: url
// description: Specify a URL instead of a tarball // description: Specify a URL instead of a tarball
// type: bool // type: boolean
// - in: body // - in: formData
// name: request // name: upload
// description: Tarball of (or URL to) container image // type: file
// required: true // required: true
// schema: // description: tarball for imported image
// type: string
// produces: // produces:
// - application/json // - application/json
// responses: // responses:
// 200: // 200:
// $ref: "#/response/LibpodImagesImportResponse" // $ref: "#/responses/DocsLibpodImagesImportResponse"
// 500: // 500:
// $ref: '#/responses/InternalError' // $ref: '#/responses/InternalError'
r.Handle(VersionedPath("/libpod/images/import"), APIHandler(s.Context, libpod.ImagesImport)).Methods(http.MethodPost) r.Handle(VersionedPath("/libpod/images/import"), APIHandler(s.Context, libpod.ImagesImport)).Methods(http.MethodPost)
@ -711,13 +709,13 @@ func (s *APIServer) registerImagesHandlers(r *mux.Router) error {
// - in: query // - in: query
// name: tls-verify // name: tls-verify
// description: Require TLS verification. // description: Require TLS verification.
// type: bool // type: boolean
// default: true // default: true
// produces: // produces:
// - application/json // - application/json
// responses: // responses:
// 200: // 200:
// $ref: "#/response/LibpodImagesPullResponse" // $ref: "#/responses/DocsLibpodImagesPullResponse"
// 500: // 500:
// $ref: '#/responses/InternalError' // $ref: '#/responses/InternalError'
r.Handle(VersionedPath("/libpod/images/pull"), APIHandler(s.Context, libpod.ImagesPull)).Methods(http.MethodPost) r.Handle(VersionedPath("/libpod/images/pull"), APIHandler(s.Context, libpod.ImagesPull)).Methods(http.MethodPost)