Commitfd1f8fb

Cristiano Casella

committed

feat: Added additional parameter to project/group iteration search

1 parente923542 commitfd1f8fbCopy full SHA for fd1f8fb

File tree

+36

-2

lines changed

+36

-2

lines changed

Lines changed: 10 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -31,3 +31,13 @@ List iterations for a project's ancestor groups::`
`31`	`31`	`List iterations for a group::`
`32`	`32`
`33`	`33`	`iterations = group.iterations.list()`
	`34`	`+`
	`35`	`+Unavailable filters or filters conflicts::`
	`36`	`+`
	`37`	`+ In case you are trying to pass a parameter that collides with a python`
	`38`	+ keyword (i.e. `in`) or with python-gitlab's internal arguments, you'll have
	`39`	+ to use the `query_parameters` argument:
	`40`	`+`
	`41`	+ ```
	`42`	`+ group.iterations.list(query_parameters={"in": "title"})`
	`43`	+ ```

Lines changed: 26 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -16,11 +16,35 @@ class GroupIterationManager(ListMixin, RESTManager):`
`16`	`16`	`_path="/groups/{group_id}/iterations"`
`17`	`17`	`_obj_cls=GroupIteration`
`18`	`18`	`_from_parent_attrs= {"group_id":"id"}`
`19`		`-_list_filters= ("state","search","in","include_ancestors")`
	`19`	`+# When using the API, the "in" keyword collides with python's "in" keyword`
	`20`	`+# raising a SyntaxError.`
	`21`	`+# For this reason, we have to use the query_parameters argument:`
	`22`	`+# group.iterations.list(query_parameters={"in": "title"})`
	`23`	`+_list_filters= (`
	`24`	`+"include_ancestors",`
	`25`	`+"include_descendants",`
	`26`	`+"in",`
	`27`	`+"search",`
	`28`	`+"state",`
	`29`	`+"updated_after",`
	`30`	`+"updated_before",`
	`31`	`+ )`
`20`	`32`
`21`	`33`
`22`	`34`	`classProjectIterationManager(ListMixin,RESTManager):`
`23`	`35`	`_path="/projects/{project_id}/iterations"`
`24`	`36`	`_obj_cls=GroupIteration`
`25`	`37`	`_from_parent_attrs= {"project_id":"id"}`
`26`		`-_list_filters= ("state","search","in","include_ancestors")`
	`38`	`+# When using the API, the "in" keyword collides with python's "in" keyword`
	`39`	`+# raising a SyntaxError.`
	`40`	`+# For this reason, we have to use the query_parameters argument:`
	`41`	`+# group.iterations.list(query_parameters={"in": "title"})`
	`42`	`+_list_filters= (`
	`43`	`+"include_ancestors",`
	`44`	`+"include_descendants",`
	`45`	`+"in",`
	`46`	`+"search",`
	`47`	`+"state",`
	`48`	`+"updated_after",`
	`49`	`+"updated_before",`
	`50`	`+ )`

Comments

(0)