github.com/hanks177/podman/v4@v4.1.3-0.20220613032544-16d90015bc83/pkg/api/server/doc.go (about)

     1  // Package server supports a RESTful API for the Libpod library
     2  //
     3  // This documentation describes the Podman v2.x+ RESTful API. It consists of a Docker-compatible
     4  // API and a Libpod API providing support for Podman’s unique features such as pods.
     5  //
     6  // To start the service and keep it running for 5,000 seconds (-t 0 runs forever):
     7  //
     8  //    podman system service -t 5000 &
     9  //
    10  // You can then use cURL on the socket using requests documented below.
    11  //
    12  // NOTE: if you install the package podman-docker, it will create a symbolic
    13  // link for /run/docker.sock to /run/podman/podman.sock
    14  //
    15  // NOTE: Some fields in the API response JSON are encoded as omitempty, which means that
    16  // if said field has a zero value, they will not be encoded in the API response. This
    17  // is a feature to help reduce the size of the JSON responses returned via the API.
    18  //
    19  // NOTE: Due to the limitations of [go-swagger](https://github.com/go-swagger/go-swagger),
    20  // some field values that have a complex type show up as null in the docs as well as in the
    21  // API responses. This is because the zero value for the field type is null. The field
    22  // description in the docs will state what type the field is expected to be for such cases.
    23  //
    24  // See podman-service(1) for more information.
    25  //
    26  //  Quick Examples:
    27  //
    28  //   'podman info'
    29  //
    30  //      curl --unix-socket /run/podman/podman.sock http://d/v4.0.0/libpod/info
    31  //
    32  //   'podman pull quay.io/containers/podman'
    33  //
    34  //      curl -XPOST --unix-socket /run/podman/podman.sock -v 'http://d/v4.0.0/images/create?fromImage=quay.io%2Fcontainers%2Fpodman'
    35  //
    36  //   'podman list images'
    37  //
    38  //      curl --unix-socket /run/podman/podman.sock -v 'http://d/v4.0.0/libpod/images/json' | jq
    39  //
    40  // Terms Of Service:
    41  //
    42  // https://github.com/containers/podman/blob/913caaa9b1de2b63692c9bae15120208194c9eb3/LICENSE
    43  //
    44  //     Schemes: http, https
    45  //     Host: podman.io
    46  //     BasePath: /
    47  //     Version: 4.0.0
    48  //     License: Apache-2.0 https://opensource.org/licenses/Apache-2.0
    49  //     Contact: Podman <podman@lists.podman.io> https://podman.io/community/
    50  //
    51  //     InfoExtensions:
    52  //     x-logo:
    53  //       - url: https://raw.githubusercontent.com/containers/libpod/main/logo/podman-logo.png
    54  //       - altText: "Podman logo"
    55  //
    56  //     Produces:
    57  //     - application/json
    58  //     - application/octet-stream
    59  //     - text/plain
    60  //
    61  //     Consumes:
    62  //     - application/json
    63  //     - application/x-tar
    64  //
    65  // swagger:meta
    66  package server