Commit80a68f9

Gauvain Pocentek

committed

[docs] Add/updates notes about read-only objects

MR and issues attached to the root API or groups are not editable.Provide notes describing how to manage this.

1 parentff6ca5d commit80a68f9Copy full SHA for 80a68f9

File tree

+32

-5

lines changed

+32

-5

lines changed

Lines changed: 22 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -30,6 +30,17 @@ Use the ``state`` and ``label`` parameters to filter the results. Use the
`30`	`30`	`closed_issues = gl.issues.list(state='closed')`
`31`	`31`	`tagged_issues = gl.issues.list(labels=['foo', 'bar'])`
`32`	`32`
	`33`	`+..note::`
	`34`	`+`
	`35`	`+ It is not possible to edit or delete Issue objects. You need to create a`
	`36`	`+ ProjectIssue object to perform changes::`
	`37`	`+`
	`38`	`+ issue = gl.issues.list()[0]`
	`39`	`+ project = gl.projects.get(issue.project_id, lazy=True)`
	`40`	`+ editable_issue = project.issues.get(issue.iid, lazy=True)`
	`41`	`+ editable_issue.title = updated_title`
	`42`	`+ editable_issue.save()`
	`43`	`+`
`33`	`44`	`Group issues`
`34`	`45`	`============`
`35`	`46`
`@@ -55,6 +66,17 @@ List the group issues::`
`55`	`66`	`# Order using the order_by and sort parameters`
`56`	`67`	`issues = group.issues.list(order_by='created_at', sort='desc')`
`57`	`68`
	`69`	`+..note::`
	`70`	`+`
	`71`	`+ It is not possible to edit or delete GroupIssue objects. You need to create`
	`72`	`+ a ProjectIssue object to perform changes::`
	`73`	`+`
	`74`	`+ issue = group.issues.list()[0]`
	`75`	`+ project = gl.projects.get(issue.project_id, lazy=True)`
	`76`	`+ editable_issue = project.issues.get(issue.iid, lazy=True)`
	`77`	`+ editable_issue.title = updated_title`
	`78`	`+ editable_issue.save()`
	`79`	`+`
`58`	`80`	`Project issues`
`59`	`81`	`==============`
`60`	`82`

Lines changed: 10 additions & 5 deletions

Original file line number	Diff line number	Diff line change
`@@ -37,12 +37,17 @@ List the merge requests for a group::`
`37`	`37`	`group = gl.groups.get('mygroup')`
`38`	`38`	`mrs = group.mergerequests.list()`
`39`	`39`
`40`		-To edit or delete a merge request, create a ``ProjectMergeRequest`` object
`41`		`-first::`
	`40`	`+..note::`
`42`	`41`
`43`		`- mr = group.mergerequests.list()[0] # pick the first MR`
`44`		`- project = gl.projects.get(mr.project_id, lazy=True)`
`45`		`- editable_mr = project.mergerequests.get(mr.iid)`
	`42`	+ It is not possible to edit or delete ``MergeRequest`` and
	`43`	+ ``GroupMergeRequest`` objects. You need to create a ``ProjectMergeRequest``
	`44`	`+ object to apply changes::`
	`45`	`+`
	`46`	`+ mr = group.mergerequests.list()[0]`
	`47`	`+ project = gl.projects.get(mr.project_id, lazy=True)`
	`48`	`+ editable_mr = project.mergerequests.get(mr.iid, lazy=True)`
	`49`	`+ editable_mr.title = updated_title`
	`50`	`+ editable_mr.save()`
`46`	`51`
`47`	`52`	`Project merge requests`
`48`	`53`	`======================`

Comments

(0)