Skip to content
This repository was archived by the owner on Nov 24, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions docs/source/api/v4/cdn_locks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Comment thread
joobisb marked this conversation as resolved.
: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.
Expand Down
2 changes: 0 additions & 2 deletions docs/source/api/v4/roles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/source/api/v5/cdn_locks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 0 additions & 2 deletions docs/source/api/v5/roles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down