You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@trafficcontrol.apache.org by "Rohith-Raju (via GitHub)" <gi...@apache.org> on 2023/03/14 05:15:46 UTC
[GitHub] [trafficcontrol] Rohith-Raju commented on a diff in pull request #7393: [Docs] Change Role to Api Name
Rohith-Raju commented on code in PR #7393:
URL: https://github.com/apache/trafficcontrol/pull/7393#discussion_r1134968268
##########
docs/source/api/v4/users_register.rst:
##########
@@ -31,7 +31,7 @@ Register a user and send registration email.
Request Structure
-----------------
:email: Email address of the new user The given email is validated (circuitously) by `GitHub user asaskevich's regular expression <https://github.com/asaskevich/govalidator/blob/9a090521c4893a35ca9a228628abf8ba93f63108/patterns.go#L7>`_ . Note that it can't actually distinguish a valid, deliverable, email address but merely ensure the email is in a commonly-found format.
-:role: The integral, unique identifier of the highest permissions :term:`Role` which will be afforded to the new user. It restricts the allowed values to identifiers for :term:`Roles` with at most the same permissions level as the requesting user.
+:role: The name of the :term:`Role` which will be afforded to the new user. It restricts the allowed values to identifiers for :term:`Roles` with at most the same permissions level as the requesting user.
Review Comment:
Makes Sense
##########
docs/source/api/v4/users_register.rst:
##########
@@ -31,7 +31,7 @@ Register a user and send registration email.
Request Structure
-----------------
:email: Email address of the new user The given email is validated (circuitously) by `GitHub user asaskevich's regular expression <https://github.com/asaskevich/govalidator/blob/9a090521c4893a35ca9a228628abf8ba93f63108/patterns.go#L7>`_ . Note that it can't actually distinguish a valid, deliverable, email address but merely ensure the email is in a commonly-found format.
-:role: The integral, unique identifier of the highest permissions :term:`Role` which will be afforded to the new user. It restricts the allowed values to identifiers for :term:`Roles` with at most the same permissions level as the requesting user.
+:role: The name of the :term:`Role` which will be afforded to the new user. It restricts the allowed values to identifiers for :term:`Roles` with at most the same permissions level as the requesting user.
Review Comment:
Makes Sense !!
--
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