From 1837ae8ac9a4b1606373abd289739c2d8eb11b8b Mon Sep 17 00:00:00 2001 From: Nguyen Date: Tue, 6 Jun 2023 11:04:36 -0600 Subject: [PATCH 1/3] changing docs for CDN locks response structure --- docs/source/api/v4/cdn_locks.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) 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 From 3a61e73938dcf32dc850a089d0ad64e385e521e1 Mon Sep 17 00:00:00 2001 From: heneriknguyen Date: Tue, 6 Jun 2023 12:21:57 -0600 Subject: [PATCH 2/3] changing docs for CDN locks (v4 and v5) response structure --- CHANGELOG.md | 1 + docs/source/api/v5/cdn_locks.rst | 8 +++++++- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9b8d8cd357..c3292352af 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 . - [#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/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 From 1dbcaf36b2401885522ec40f00221336cd3a304e Mon Sep 17 00:00:00 2001 From: heneriknguyen Date: Tue, 13 Jun 2023 10:55:01 -0600 Subject: [PATCH 3/3] Fixed CHANGELOG to include v5 --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c3292352af..5e153b4aac 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -57,7 +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 . +- [#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.