diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/api-usage.rst | 3 | ||||
-rw-r--r-- | docs/cli-usage.rst | 3 |
2 files changed, 6 insertions, 0 deletions
diff --git a/docs/api-usage.rst b/docs/api-usage.rst index 764f294..2a40cfa 100644 --- a/docs/api-usage.rst +++ b/docs/api-usage.rst @@ -26,6 +26,9 @@ To connect to a GitLab server, create a ``gitlab.Gitlab`` object: # anonymous gitlab instance, read-only for public resources gl = gitlab.Gitlab('http://10.0.0.1') + # Define your own custom user agent for requests + gl = gitlab.Gitlab('http://10.0.0.1', user_agent='my-package/1.0.0') + # make an API request to create the gl.user object. This is mandatory if you # use the username/password authentication. gl.auth() diff --git a/docs/cli-usage.rst b/docs/cli-usage.rst index 21a4baf..1c24824 100644 --- a/docs/cli-usage.rst +++ b/docs/cli-usage.rst @@ -78,6 +78,9 @@ parameters. You can override the values in each GitLab server section. - Integer between 1 and 100 - The number of items to return in listing queries. GitLab limits the value at 100. + * - ``user_agent`` + - ``str`` + - A string defining a custom user agent to use when ``gitlab`` makes requests. You must define the ``url`` in each GitLab server section. |