diff options
author | Brent Baude <bbaude@redhat.com> | 2020-02-04 16:47:03 -0600 |
---|---|---|
committer | Brent Baude <bbaude@redhat.com> | 2020-02-05 14:16:25 -0600 |
commit | c0b14ee29ad5feb4ce0599c8b45a0191c82ebcd7 (patch) | |
tree | 38b7d54955f2cf5a18b93c70028684933bccacca /pkg/api/server | |
parent | fc0673f5612368e0d90173bb061f4b257d08b885 (diff) | |
download | podman-c0b14ee29ad5feb4ce0599c8b45a0191c82ebcd7.tar.gz podman-c0b14ee29ad5feb4ce0599c8b45a0191c82ebcd7.tar.bz2 podman-c0b14ee29ad5feb4ce0599c8b45a0191c82ebcd7.zip |
fix swagger docs and make sure docs validation runs
Signed-off-by: Brent Baude <bbaude@redhat.com>
Diffstat (limited to 'pkg/api/server')
-rw-r--r-- | pkg/api/server/register_images.go | 72 |
1 files changed, 35 insertions, 37 deletions
diff --git a/pkg/api/server/register_images.go b/pkg/api/server/register_images.go index 2959e604a..4a46b6ee6 100644 --- a/pkg/api/server/register_images.go +++ b/pkg/api/server/register_images.go @@ -638,25 +638,24 @@ func (s *APIServer) registerImagesHandlers(r *mux.Router) error { // summary: Load image // description: Load an image (oci-archive or docker-archive) stream. // parameters: - // - in: query - // name: change - // description: "Apply the following possible instructions to the created image (default []): CMD | ENTRYPOINT | ENV | EXPOSE | LABEL | STOPSIGNAL | USER | VOLUME | WORKDIR. JSON encoded string" - // type: string - // - in: query - // name: message - // description: Set commit message for imported image - // type: string - // - in: body - // name: request - // description: tarball of container image - // required: true - // schema: - // type: string + // - in: query + // name: change + // description: "Apply the following possible instructions to the created image (default []): CMD | ENTRYPOINT | ENV | EXPOSE | LABEL | STOPSIGNAL | USER | VOLUME | WORKDIR. JSON encoded string" + // type: string + // - in: query + // name: message + // description: Set commit message for imported image + // type: string + // - in: formData + // name: upload + // description: tarball of container image + // type: file + // required: true // produces: // - application/json // responses: // 200: - // $ref: "#/response/LibpodImagesLoadResponse" + // $ref: "#/responses/DocsLibpodImagesLoadResponse" // 500: // $ref: '#/responses/InternalError' r.Handle(VersionedPath("/libpod/images/load"), APIHandler(s.Context, libpod.ImagesLoad)).Methods(http.MethodPost) @@ -665,31 +664,30 @@ func (s *APIServer) registerImagesHandlers(r *mux.Router) error { // tags: // - images // summary: Import image - // description: Import a previosly exported tarball as an image. + // description: Import a previously exported tarball as an image. // parameters: - // - in: query - // name: change - // description: "Apply the following possible instructions to the created image (default []): CMD | ENTRYPOINT | ENV | EXPOSE | LABEL | STOPSIGNAL | USER | VOLUME | WORKDIR. JSON encoded string" - // type: string - // - in: query - // name: message - // description: Set commit message for imported image - // type: string - // - in: query - // name: url - // description: Specify a URL instead of a tarball - // type: bool - // - in: body - // name: request - // description: Tarball of (or URL to) container image - // required: true - // schema: - // type: string + // - in: query + // name: change + // description: "Apply the following possible instructions to the created image (default []): CMD | ENTRYPOINT | ENV | EXPOSE | LABEL | STOPSIGNAL | USER | VOLUME | WORKDIR. JSON encoded string" + // type: string + // - in: query + // name: message + // description: Set commit message for imported image + // type: string + // - in: query + // name: url + // description: Specify a URL instead of a tarball + // type: boolean + // - in: formData + // name: upload + // type: file + // required: true + // description: tarball for imported image // produces: // - application/json // responses: // 200: - // $ref: "#/response/LibpodImagesImportResponse" + // $ref: "#/responses/DocsLibpodImagesImportResponse" // 500: // $ref: '#/responses/InternalError' 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 // name: tls-verify // description: Require TLS verification. - // type: bool + // type: boolean // default: true // produces: // - application/json // responses: // 200: - // $ref: "#/response/LibpodImagesPullResponse" + // $ref: "#/responses/DocsLibpodImagesPullResponse" // 500: // $ref: '#/responses/InternalError' r.Handle(VersionedPath("/libpod/images/pull"), APIHandler(s.Context, libpod.ImagesPull)).Methods(http.MethodPost) |