summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
...
* docs: documentation updates to reflect addition of mutually exclusive attributesWalter Rowe2022-06-052-10/+23
|
* feat(client): introduce `iterator=True` and deprecate `as_list=False` in ↵John L. Villalovos2022-05-293-12/+16
| | | | | | | | | | | `list()` `as_list=False` is confusing as it doesn't explain what is being returned. Replace it with `iterator=True` which more clearly explains to the user that an iterator/generator will be returned. This maintains backward compatibility with `as_list` but does issue a DeprecationWarning if `as_list` is set.
* docs: use `as_list=False` or `all=True` in Getting startedJohn L. Villalovos2022-05-291-5/+13
| | | | | | | | | In the "Getting started with the API" section of the documentation, use either `as_list=False` or `all=True` in the example usages of the `list()` method. Also add a warning about the fact that `list()` by default does not return all items.
* feat(objects): support get project storage endpointNejc Habjan2022-05-271-0/+27
|
* docs: update issue example and extend API usage docsMichael Sweikata2022-05-242-0/+22
|
* docs(merge_requests): add new possible merge request state and link to the ↵Carlos Duelo2022-05-041-2/+5
| | | | | | upstream docs The actual documentation do not mention the locked state for a merge request
* Merge pull request #1963 from python-gitlab/feat/deploy-token-getMax Wittig2022-04-131-0/+8
|\ | | | | feat(objects): support getting project/group deploy tokens by id
| * feat(objects): support getting project/group deploy tokens by idNejc Habjan2022-04-041-0/+8
| |
* | feat(user): support getting user SSH key by idNejc Habjan2022-04-011-1/+5
|/
* feat(api): re-add topic delete endpointNejc Habjan2022-04-011-0/+7
| | | | This reverts commit e3035a799a484f8d6c460f57e57d4b59217cd6de.
* docs(api-docs): docs fix for application scopeswacuuu2022-03-301-1/+1
|
* docs: fix typo and incorrect stylekinbald2022-03-091-2/+2
|
* docs: add pipeline test report summary supportkinbald2022-03-071-0/+24
|
* docs: enable gitter chat directly in docsNejc Habjan2022-02-192-1/+12
|
* feat(merge_request_approvals): add support for deleting MR approval rulesNejc Habjan2022-02-131-0/+8
|
* docs: add delete methods for runners and project artifactsNejc Habjan2022-02-102-0/+8
|
* docs: add retry_transient infosNolan Emirot2022-02-041-3/+3
| | | Co-authored-by: Nejc Habjan <hab.nejc@gmail.com>
* docs: add transient errors retry infoNolan Emirot2022-02-031-0/+1
|
* docs(artifacts): deprecate artifacts() and artifact() methodsNejc Habjan2022-02-011-3/+13
|
* docs: revert "chore: add temporary banner for v3" (#1864)Wadim Klincov2022-01-291-4/+1
| | | | | This reverts commit a349793307e3a975bb51f864b48e5e9825f70182. Co-authored-by: Wadim Klincov <wadim.klincov@siemens.com>
* style: use f-strings where applicableNejc Habjan2022-01-231-2/+2
|
* chore: don't explicitly pass args to super()Nejc Habjan2022-01-231-3/+1
|
* docs: enhance release docs for CI_JOB_TOKEN usageMatthieu Rigal2022-01-211-0/+9
|
* feat: add support for Group Access Token APIFabio Huser2022-01-092-0/+35
| | | | See https://docs.gitlab.com/ee/api/group_access_tokens.html
* docs: update project access token API reference linkFabio Huser2022-01-091-1/+1
|
* Merge pull request #1812 from python-gitlab/jlvillal/pprintNejc Habjan2022-01-091-0/+14
|\ | | | | chore: add `pprint()` and `pformat()` methods to RESTObject
| * chore: add `pprint()` and `pformat()` methods to RESTObjectJohn L. Villalovos2022-01-081-0/+14
| | | | | | | | | | This is useful in debugging and testing. As can easily print out the values from an instance in a more human-readable form.
* | docs(cli): make examples more easily navigable by generating TOCNejc Habjan2022-01-081-0/+27
| |
* | chore(docs): use admonitions consistentlyNejc Habjan2022-01-082-3/+3
|/
* chore: add temporary banner for v3Nejc Habjan2022-01-051-1/+4
|
* docs: switch to Furo and refresh introduction pagesNejc Habjan2022-01-046-248/+184
|
* chore: fix typo in MR documentationMarkus Legner2022-01-041-1/+1
|
* feat(cli): allow options from args and environment variablesNejc Habjan2022-01-021-7/+50
| | | | | | | | BREAKING-CHANGE: The gitlab CLI will now accept CLI arguments and environment variables for its global options in addition to configuration file options. This may change behavior for some workflows such as running inside GitLab CI and with certain environment variables configured.
* fix: handle situation where GitLab does not return valuesjlvillal/paginationJohn L. Villalovos2021-12-301-2/+11
| | | | | | | | | | | | | | | | If a query returns more than 10,000 records than the following values are NOT returned: x.total_pages x.total Modify the code to allow no value to be set for these values. If there is not a value returned the functions will now return None. Update unit test so no longer `xfail` https://docs.gitlab.com/ee/user/gitlab_com/index.html#pagination-response-headers Closes #1686
* docs: correct documentation for updating discussion noteHailiang2021-12-251-1/+1
| | | | Closes #1777
* chore: add and document optional parameters for get MRjlvillal/rebase_in_progressJohn L. Villalovos2021-12-231-0/+8
| | | | | | | Add and document (some of the) optional parameters that can be done for a `project.merge_requests.get()` Closes #1775
* docs: rename documentation files to match names of code filesJohn L. Villalovos2021-12-233-2/+2
| | | | | | | | | Rename the merge request related documentation files to match the code files. This will make it easier to find the documentation quickly. Rename: `docs/gl_objects/mrs.rst -> `docs/gl_objects/merge_requests.rst` `docs/gl_objects/mr_approvals.rst -> `docs/gl_objects/merge_request_approvals.rst`
* feat(api): support file format for repository archiveMax Ludwig2021-12-211-0/+8
|
* docs(project): remove redundant encoding parameterShashwat Kumar2021-12-191-1/+0
|
* feat(cli): do not require config file to run CLIfeat/cli-without-config-fileNejc Habjan2021-12-131-3/+11
| | | | | | | | | | | BREAKING CHANGE: A config file is no longer needed to run the CLI. python-gitlab will default to https://gitlab.com with no authentication if there is no config file provided. python-gitlab will now also only look for configuration in the provided PYTHON_GITLAB_CFG path, instead of merging it with user- and system-wide config files. If the environment variable is defined and the file cannot be opened, python-gitlab will now explicitly fail.
* chore(api): temporarily remove topic delete endpointNejc Habjan2021-12-111-7/+0
| | | | It is not yet available upstream.
* feat(api): add support for Topics APINejc Habjan2021-12-112-0/+49
|
* feat: add delete on package_file objectSimon Hébert-Deschamps2021-12-091-1/+1
|
* Merge pull request #1709 from python-gitlab/docs/sphinx-annotationsNejc Habjan2021-12-012-1/+3
|\ | | | | docs: only use type annotations for documentation
| * chore(docs): link to main, not masterNejc Habjan2021-11-281-1/+1
| |
| * chore(docs): use builtin autodoc hintsNejc Habjan2021-11-281-1/+2
| |
| * chore(docs): load autodoc-typehints moduleNejc Habjan2021-11-281-0/+1
| |
* | Merge pull request #1702 from python-gitlab/jlvillal/attribute_helpNejc Habjan2021-12-011-0/+12
|\ \ | | | | | | chore: attempt to be more informative for missing attributes
| * | chore: attempt to be more informative for missing attributesjlvillal/attribute_helpJohn L. Villalovos2021-11-301-0/+12
| |/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | A commonly reported issue from users on Gitter is that they get an AttributeError for an attribute that should be present. This is often caused due to the fact that they used the `list()` method to retrieve the object and objects retrieved this way often only have a subset of the full data. Add more details in the AttributeError message that explains the situation to users. This will hopefully allow them to resolve the issue. Update the FAQ in the docs to add a section discussing the issue. Closes #1138
* | docs: update docs to use gitlab.const for constantsjlvillal/const_explicitJohn L. Villalovos2021-11-307-50/+50
|/ | | | Update the docs to use gitlab.const to access constants.