This is an automated email from the ASF dual-hosted git repository.
srijeet0406 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 8f764715f6 Changing docs for CDN locks for DELETE response structure
APIv4 and APIv5 (#7556)
8f764715f6 is described below
commit 8f764715f695dd13e89a7cc922589a3fda63002a
Author: heneriknguyen <[email protected]>
AuthorDate: Tue Jun 13 11:05:22 2023 -0600
Changing docs for CDN locks for DELETE response structure APIv4 and APIv5
(#7556)
* changing docs for CDN locks response structure
* changing docs for CDN locks (v4 and v5) response structure
* Fixed CHANGELOG to include v5
---------
Co-authored-by: Nguyen <[email protected]>
---
CHANGELOG.md | 1 +
docs/source/api/v4/cdn_locks.rst | 8 +++++++-
docs/source/api/v5/cdn_locks.rst | 8 +++++++-
3 files changed, 15 insertions(+), 2 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 2e876cd0e5..11abdb17a7 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -57,6 +57,7 @@ The format is based on [Keep a
Changelog](http://keepachangelog.com/en/1.0.0/).
- [#7469](https://github.com/apache/trafficcontrol/pull/7469) *Traffic Ops*
Changed logic to not report empty or missing cookies into TO error.log.
### Fixed
+- [#7312](https://github.com/apache/trafficcontrol/issues/7312) *Docs*
Changing docs for CDN locks for DELETE response structure v4 and v5.
- [#7539](https://github.com/apache/trafficcontrol/pull/7539) *Traffic
Monitor* Use stats_over_http timestamp to calculate bandwidth for TM's health.
- [#7542](https://github.com/apache/trafficcontrol/pull/7542) *Traffic Ops*
Fixed `CDN Locks` documentation to reflect the correct RFC3339 timestamps.
- [#6340](https://github.com/apache/trafficcontrol/issues/6340) *Traffic Ops*
Fixed alert messages for POST and PUT invalidation job APIs.
diff --git a/docs/source/api/v4/cdn_locks.rst b/docs/source/api/v4/cdn_locks.rst
index a35274d718..17b87be432 100644
--- a/docs/source/api/v4/cdn_locks.rst
+++ b/docs/source/api/v4/cdn_locks.rst
@@ -150,7 +150,7 @@ Response Structure
}}
``DELETE``
-----------
+==========
Deletes an existing ``CDN Lock``.
:Auth. Required: Yes
@@ -182,6 +182,12 @@ Request Structure
Response Structure
------------------
+:userName: The username for which the lock was created.
+:cdn: The name of the CDN for which the lock was created.
+:message: The message or reason that the user specified while
acquiring the lock.
+:soft: Whether or not this is a soft(shared) lock.
+:sharedUserNames: An array of the usernames that the creator of the lock has
shared their lock with.
+:lastUpdated: Time that this lock was last updated(created).
.. code-block:: http
:caption: Response Example
diff --git a/docs/source/api/v5/cdn_locks.rst b/docs/source/api/v5/cdn_locks.rst
index eabab92b57..94d13143db 100644
--- a/docs/source/api/v5/cdn_locks.rst
+++ b/docs/source/api/v5/cdn_locks.rst
@@ -148,7 +148,7 @@ Response Structure
}}
``DELETE``
-----------
+==========
Deletes an existing ``CDN Lock``.
:Auth. Required: Yes
@@ -180,6 +180,12 @@ Request Structure
Response Structure
------------------
+:userName: The username for which the lock was created.
+:cdn: The name of the CDN for which the lock was created.
+:message: The message or reason that the user specified while
acquiring the lock.
+:soft: Whether or not this is a soft(shared) lock.
+:sharedUserNames: An array of the usernames that the creator of the lock has
shared their lock with.
+:lastUpdated: Time that this lock was last updated(created).
.. code-block:: http
:caption: Response Example
