diff options
| author | Gauvain Pocentek <gauvain@pocentek.net> | 2019-01-13 13:12:17 +0100 |
|---|---|---|
| committer | Gauvain Pocentek <gauvain@pocentek.net> | 2019-01-13 17:20:34 +0100 |
| commit | 4bd027aac41c41f7e22af93c7be0058d2faf7fb4 (patch) | |
| tree | 314b738f699f5138d91b79841a53bd17f0e62cc5 /RELEASE_NOTES.rst | |
| parent | 89679ce5ee502e57dbe7cec2b78f4f70b85fd3a5 (diff) | |
| download | gitlab-no-param-conflicts.tar.gz | |
fix(api): avoid parameter conflicts with python and gitlabno-param-conflicts
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
Diffstat (limited to 'RELEASE_NOTES.rst')
| -rw-r--r-- | RELEASE_NOTES.rst | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/RELEASE_NOTES.rst b/RELEASE_NOTES.rst index 1e53a88..6abb980 100644 --- a/RELEASE_NOTES.rst +++ b/RELEASE_NOTES.rst @@ -4,6 +4,25 @@ Release notes This page describes important changes between python-gitlab releases. +Changes from 1.7 to 1.8 +======================= + +* You can now use the ``query_parameters`` argument in method calls to define + arguments to send to the GitLab server. This allows to avoid conflicts + between python-gitlab and GitLab server variables, and allows to use the + python reserved keywords as GitLab arguments. + + The following examples make the same GitLab request with the 2 syntaxes:: + + projects = gl.projects.list(owned=True, starred=True) + projects = gl.projects.list(query_parameters={'owned': True, 'starred': True}) + + The following example only works with the new parameter:: + + activities = gl.user_activities.list( + query_parameters={'from': '2019-01-01'}, + all=True) + Changes from 1.5 to 1.6 ======================= |