Skip to content

Commit f6aa316

Browse files
committed
updated verbiage in docstring for addCollectionItem
1 parent 992a5fb commit f6aa316

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

pyral/restapi.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
###################################################################################################
22
#
33
# pyral.restapi - Python Rally REST API module
4-
# round 20 support Python 3.11, 3.12, 2.13 and 3.14
4+
# round 20 support Python 3.12, 2.13 and 3.14
55
# notable dependency:
66
# requests v2.32.x or better
77
#
@@ -1205,6 +1205,8 @@ def addCollectionItems(self, target, collection_name, items):
12051205
the same _type, construct a valid Rally WSAPI collection url and
12061206
issue a POST request to that URL supplying the item refs in an appropriate
12071207
JSON structure as the payload.
1208+
Returns a newly retrieved target item which will have a reference to the
1209+
collection with the added item.
12081210
"""
12091211
if not items: return None
12101212
auth_token = self.obtainSecurityToken()
@@ -1223,7 +1225,7 @@ def addCollectionItems(self, target, collection_name, items):
12231225
context = self.contextHelper.currentContext()
12241226
response = RallyRESTResponse(self.session, context, resource, response, "shell", 0)
12251227
added_items = [item['Name'] for item in response.data['Results']]
1226-
#return added_items
1228+
12271229
upd_target = self.get(target_type, fetch=f"ObjectID,Name,FormattedID,{collection_name}",
12281230
query=f'ObjectID = {target.oid}',
12291231
instance=True)

0 commit comments

Comments
 (0)