You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@trafficcontrol.apache.org by GitBox <gi...@apache.org> on 2022/05/03 20:07:40 UTC
[GitHub] [trafficcontrol] ocket8888 commented on a diff in pull request #6803: Documentation fixes
ocket8888 commented on code in PR #6803:
URL: https://github.com/apache/trafficcontrol/pull/6803#discussion_r864166463
##########
docs/source/api/v3/deliveryservice_requests_id_assign.rst:
##########
@@ -29,7 +29,7 @@ Assign a :term:`Delivery Service Request` to a user.
Request Structure
-----------------
:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
-:assignee: The username of the user to whom the :term:`Delivery Service Request` is assigned.
+:assigneeId: The username of the user to whom the :term:`Delivery Service Request` is assigned.
Review Comment:
This description needs to be changed; the value is the user's *ID*, not the username.
##########
docs/source/api/v3/deliveryservice_requests_id_assign.rst:
##########
@@ -43,13 +43,12 @@ Request Structure
Content-Length: 28
{
- "id": 1,
"assigneeId": 2
}
Response Structure
------------------
-:assignee: The username of the user to whom the :term:`Delivery Service Request` is assigned.
+:assigneeId: The username of the user to whom the :term:`Delivery Service Request` is assigned.
Review Comment:
`assigneeId` needs to be added here, but `assignee` should not be removed as it is actually present in the response.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org