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 02e7298a74 Fixed docs for roles and cdn locks description (#7265)
02e7298a74 is described below
commit 02e7298a741018f47827723183ce85f8b864f28e
Author: Joobi S B <[email protected]>
AuthorDate: Mon Jan 9 21:07:09 2023 +0530
Fixed docs for roles and cdn locks description (#7265)
* Fixed docs for roles and cdn locks description
* Updated cdn locks API v5 doc
---
CHANGELOG.md | 2 ++
docs/source/api/v4/cdn_locks.rst | 1 +
docs/source/api/v4/roles.rst | 2 --
docs/source/api/v5/cdn_locks.rst | 1 +
docs/source/api/v5/roles.rst | 2 --
5 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index c83a70bb2f..5689311de1 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -35,6 +35,8 @@ The format is based on [Keep a
Changelog](http://keepachangelog.com/en/1.0.0/).
- [#7120](https://github.com/apache/trafficcontrol/pull/7120) *Docs* Update
t3c documentation regarding parent.config parent_retry.
### Fixed
+- [#7221](https://github.com/apache/trafficcontrol/issues/7221) *Docs* Fixed
request structure spec in cdn locks description in APIv4.
+- [#7225](https://github.com/apache/trafficcontrol/issues/7225) *Docs* Fixed
docs for /roles response description in APIv4.
- [#7246](https://github.com/apache/trafficcontrol/issues/7246) *Docs* Fixed
docs for /jobs response description in APIv4 and APIv5.
- [#6229](https://github.com/apache/trafficcontrol/issues/6229) *Traffic Ops*
Fixed error message for assignment of non-existent parameters to a profile.
- [#7231](https://github.com/apache/trafficcontrol/pull/7231) *Traffic Ops,
Traffic Portal* Fixed `sharedUserNames` display while retrieving CDN locks.
diff --git a/docs/source/api/v4/cdn_locks.rst b/docs/source/api/v4/cdn_locks.rst
index 37b527e158..d7b28fceb7 100644
--- a/docs/source/api/v4/cdn_locks.rst
+++ b/docs/source/api/v4/cdn_locks.rst
@@ -82,6 +82,7 @@ Allows user to acquire a lock on a CDN.
Request Structure
-----------------
The request body must be a single ``CDN Lock`` object with the following keys:
+
:cdn: The name of the CDN for which the user wants to acquire a
lock.
:message: The message or reason for the user to acquire the lock. This
is an optional field.
:sharedUserNames: An array of the usernames that the creator of the lock wants
to share their lock with. This is an optional field.
diff --git a/docs/source/api/v4/roles.rst b/docs/source/api/v4/roles.rst
index 8d0e15ad2b..a0219bbd9c 100644
--- a/docs/source/api/v4/roles.rst
+++ b/docs/source/api/v4/roles.rst
@@ -66,7 +66,6 @@ Response Structure
------------------
:permissions: An array of the names of the Permissions given to this
:term:`Role`
:description: A description of the :term:`Role`
-:id: The integral, unique identifier for this :term:`Role`
:name: The name of the :term:`Role`
.. code-block:: http
@@ -171,7 +170,6 @@ Response Structure
.. tip:: This can be ``null`` *or* empty, depending on whether it was
present in the request body, or merely empty. Obviously, it can also be a
populated array.
:description: A description of the :term:`Role`
-:id: The integral, unique identifier for this :term:`Role`
:name: The name of the :term:`Role`
.. code-block:: http
diff --git a/docs/source/api/v5/cdn_locks.rst b/docs/source/api/v5/cdn_locks.rst
index 4645746d56..352625f82d 100644
--- a/docs/source/api/v5/cdn_locks.rst
+++ b/docs/source/api/v5/cdn_locks.rst
@@ -80,6 +80,7 @@ Allows user to acquire a lock on a CDN.
Request Structure
-----------------
The request body must be a single ``CDN Lock`` object with the following keys:
+
:cdn: The name of the CDN for which the user wants to acquire a
lock.
:message: The message or reason for the user to acquire the lock. This
is an optional field.
:sharedUserNames: An array of the usernames that the creator of the lock wants
to share their lock with. This is an optional field.
diff --git a/docs/source/api/v5/roles.rst b/docs/source/api/v5/roles.rst
index 9c66fcc11b..48c208ed0b 100644
--- a/docs/source/api/v5/roles.rst
+++ b/docs/source/api/v5/roles.rst
@@ -66,7 +66,6 @@ Response Structure
------------------
:permissions: An array of the names of the Permissions given to this
:term:`Role`
:description: A description of the :term:`Role`
-:id: The integral, unique identifier for this :term:`Role`
:name: The name of the :term:`Role`
.. code-block:: http
@@ -171,7 +170,6 @@ Response Structure
.. tip:: This can be ``null`` *or* empty, depending on whether it was
present in the request body, or merely empty. Obviously, it can also be a
populated array.
:description: A description of the :term:`Role`
-:id: The integral, unique identifier for this :term:`Role`
:name: The name of the :term:`Role`
.. code-block:: http
