You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by oc...@apache.org on 2023/03/14 14:35:22 UTC
[trafficcontrol] branch master updated: [Docs] Change Role to Api Name (#7393)
This is an automated email from the ASF dual-hosted git repository.
ocket8888 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficcontrol.git
The following commit(s) were added to refs/heads/master by this push:
new 88d38c51e5 [Docs] Change Role to Api Name (#7393)
88d38c51e5 is described below
commit 88d38c51e5354885c25b0f82d257228e4ea6f17f
Author: Rohith Raju <55...@users.noreply.github.com>
AuthorDate: Tue Mar 14 20:05:16 2023 +0530
[Docs] Change Role to Api Name (#7393)
* Changed Role Field to Api Name
Signed-off-by: Rohith-Raju <ro...@gmail.com>
* changes to the description
Signed-off-by: Rohith-Raju <ro...@gmail.com>
* made changes as per review request
Signed-off-by: Rohith-Raju <ro...@gmail.com>
---------
Signed-off-by: Rohith-Raju <ro...@gmail.com>
---
docs/source/api/v4/users_register.rst | 4 ++--
docs/source/api/v5/users_register.rst | 4 ++--
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/docs/source/api/v4/users_register.rst b/docs/source/api/v4/users_register.rst
index 97ca295141..53b714113c 100644
--- a/docs/source/api/v4/users_register.rst
+++ b/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 only Permissions the requesting user has.
:tenantId: A field containing the integral, unique identifier of the :term:`Tenant` to which the new user will belong. It restricts the allowed values to identifiers for :term:`Tenants` within the requesting user's :term:`Tenant`'s permissions.
.. code-block:: http
@@ -47,7 +47,7 @@ Request Structure
{
"email": "test@example.com",
- "role": 3,
+ "role": "admin",
"tenantId": 1
}
diff --git a/docs/source/api/v5/users_register.rst b/docs/source/api/v5/users_register.rst
index 3fc72bf1ce..ba9d7912dc 100644
--- a/docs/source/api/v5/users_register.rst
+++ b/docs/source/api/v5/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 only Permissions the requesting user has.
:tenantId: A field containing the integral, unique identifier of the :term:`Tenant` to which the new user will belong. It restricts the allowed values to identifiers for :term:`Tenants` within the requesting user's :term:`Tenant`'s permissions.
.. code-block:: http
@@ -47,7 +47,7 @@ Request Structure
{
"email": "test@example.com",
- "role": 3,
+ "role": "admin",
"tenantId": 1
}