Skip to content

Old default value for API version in documentation #1522

@lachmanfrantisek

Description

@lachmanfrantisek

In documentation, there is old default value for API version (1.24), but in constants.py there is DEFAULT_DOCKER_API_VERSION = '1.26' (which is actually used as a default).

documentation latest/client:

 from_env()
    Return a client configured from environment variables.
    The environment variables used are the same as those used by the Docker command-line client. They are:
    DOCKER_HOST
        The URL to the Docker host.
    DOCKER_TLS_VERIFY
        Verify the host against a CA certificate.
    DOCKER_CERT_PATH
        A path to a directory containing TLS certificates to use when connecting to the Docker host.
    Parameters:	
        version (str) – The version of the API to use. Set to auto to automatically detect the server’s version. Default: 1.24

client.py:

 @classmethod
    def from_env(cls, **kwargs):
        """
        Return a client configured from environment variables.
        The environment variables used are the same as those used by the
        Docker command-line client. They are:
        .. envvar:: DOCKER_HOST
            The URL to the Docker host.
        .. envvar:: DOCKER_TLS_VERIFY
            Verify the host against a CA certificate.
        .. envvar:: DOCKER_CERT_PATH
            A path to a directory containing TLS certificates to use when
            connecting to the Docker host.
        Args:
            version (str): The version of the API to use. Set to ``auto`` to
                automatically detect the server's version. Default: ``1.24``
            timeout (int): Default timeout for API calls, in seconds.
            ssl_version (int): A valid `SSL version`_.
            assert_hostname (bool): Verify the hostname of the server.
            environment (dict): The environment to read environment variables
                from. Default: the value of ``os.environ``

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions