summaryrefslogtreecommitdiff
path: root/docs/api-usage.rst
Commit message (Collapse)AuthorAgeFilesLines
* feat: allow cfg timeout to be overrided via kwargsAndrew Tergis2019-12-161-0/+17
| | | | | | | | | | | | | On startup, the `timeout` parameter is loaded from config and stored on the base gitlab object instance. This instance parameter is used as the timeout for all API requests (it's passed into the `session` object when making HTTP calls). This change allows any API method to specify a `timeout` argument to `**kwargs` that will override the global timeout value. This was somewhat needed / helpful for the `import_github` method. I have also updated the docs accordingly.
* feat: retry transient HTTP errorsMitar2019-12-121-0/+18
| | | | Fixes #970
* feat: add support for job tokenMathieu Parent2019-09-061-0/+4
| | | | See https://docs.gitlab.com/ee/api/jobs.html#get-job-artifacts for usage
* docs(api-usage): fix project group exampleNikolaos Pothitos2019-06-191-2/+2
| | | | Fixes #798
* docs: remove v3 supportno-more-v3Gauvain Pocentek2019-06-081-6/+1
|
* fix(api): avoid parameter conflicts with python and gitlabno-param-conflictsGauvain Pocentek2019-01-131-0/+19
| | | | | | | | | | Provide another way to send data to gitlab with a new `query_parameters` argument. This parameter can be used to explicitly define the dict of items to send to the server, so that **kwargs are only used to specify python-gitlab specific parameters. Closes #566 Closes #629
* fix: handle empty 'Retry-After' header from GitLabSrikanth Chelluri2019-01-081-1/+15
| | | | | | | | | When requests are throttled (HTTP response code 429), python-gitlab assumed that 'Retry-After' existed in the response headers. This is not always the case and so the request fails due to a KeyError. The change in this commit adds a rudimentary exponential backoff to the 'http_request' method, which defaults to 10 retries but can be set to -1 to retry without bound.
* [docs] add a warning about https://Gauvain Pocentek2018-09-051-0/+5
| | | | | http to https redirection cause problems. Make notes of this in the docs.
* [docs] fix cut and paste leftoverGauvain Pocentek2018-09-051-1/+1
|
* [docs] Fix the owned/starred usage documentationGauvain Pocentek2018-09-041-1/+1
| | | | Closes #579
* Minor doc updatesGauvain Pocentek2018-08-251-4/+4
|
* Correct session exampleStefan Crain2018-06-131-1/+1
|
* Document the global per_page settingGauvain Pocentek2018-05-261-0/+7
|
* Drop API v3 supportGauvain Pocentek2018-05-191-69/+23
| | | | Drop the code, the tests, and update the documentation.
* api-usage: bit more detail for listing with `all`Gauvain Pocentek2018-05-111-9/+10
|
* docs(api-usage): add rate limit documentationMax Wittig2018-04-181-0/+23
|
* Fix typos in documentationJakub Wilk2018-03-031-2/+2
|
* Default to API v4Gauvain Pocentek2018-02-051-7/+5
|
* Gitlab can be used as context managerGauvain Pocentek2018-02-051-0/+17
| | | | Fixes #371
* [docs] Add a note about password auth being removed from GitLabGauvain Pocentek2017-12-161-2/+17
| | | | | | | Provide a code snippet demonstrating how to use cookie-based authentication. Fixes #380
* Update pagination docs for ProjectCommitGauvain Pocentek2017-12-111-1/+1
| | | | | | In v3 pagination starts at page 0 instead of page 1. Fixes: #377
* Rework authentication args handlingGauvain Pocentek2017-11-101-2/+8
| | | | | | | | * Raise exceptions when conflicting arguments are used * Build the auth headers when instanciating Gitlab, not on each request * Enable anonymous Gitlab objects (#364) Add docs and unit tests
* [doc] Add sample code for client-side certificatesGauvain Pocentek2017-11-031-0/+23
| | | | Closes #23
* Pagination generators: expose more informationGauvain Pocentek2017-11-011-0/+9
| | | | | | | Expose the X-* pagination attributes returned by the Gitlab server when requesting lists. Closes #304
* Document the Gitlab session parameterGauvain Pocentek2017-10-211-0/+24
| | | | | | Provide a proxy setup example. Closes #341
* [docs] document `get_create_attrs` in the API tutorialGauvain Pocentek2017-10-211-27/+36
|
* Improve the docs to make v4 a first class citizenGauvain Pocentek2017-09-071-19/+75
|
* Add v4 support to docsGauvain Pocentek2017-05-241-0/+14
|
* s/correspnding/corresponding/Guillaume Delacour2017-04-051-1/+1
|
* Stop listing if recursion limit is hit (#234)Johan Brandhorst2017-03-231-1/+3
|
* document the dynamic aspect of objectsGauvain Pocentek2017-02-041-1/+12
|
* [docs] update pagination sectionGauvain Pocentek2016-12-241-1/+6
| | | | | | First page is page 1. Fixes #197
* docs: improve the pagination sectionGauvain Pocentek2016-08-301-2/+11
|
* doc: replace incorrect archive call()Gauvain Pocentek2016-08-041-2/+2
|
* Re-implement _custom_list in the Gitlab classGauvain Pocentek2016-02-181-1/+2
| | | | | | | | Rename the method _raw_list. This adds support for the ``all=True`` option to enable automatic recursion and avoid pagination if requested by the user. Fixes #93
* Add sudo supportGauvain Pocentek2016-01-301-0/+10
|
* Provide a getting started doc for the APIGauvain Pocentek2016-01-031-0/+119
View Lorry Controller Status