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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ 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
- [#7246](https://github.com/apache/trafficcontrol/issues/7246) *Docs* Fixed docs for /jobs response description in APIv4 and APIv5.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically you didn't need to mention APIv5 since that's not released and therefore won't actually be "changed" in whatever release does include this fix, but it's not hurting anything.

- [#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.
- [#7216](https://github.com/apache/trafficcontrol/pull/7216) *Traffic Portal* Fixed sort for Server's Capabilities Table
Expand Down
18 changes: 7 additions & 11 deletions docs/source/api/v4/jobs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,17 +67,13 @@ Request Structure

Response Structure
------------------
:assetUrl: A regular expression - matching URLs will be operated upon according to ``keyword``
:createdBy: The username of the user who initiated the job
:deliveryService: The :ref:`ds-xmlid` of the :term:`Delivery Service` on which this job operates
:id: An integral, unique identifier for this job
:keyword: A keyword that represents the operation being performed by the job:

PURGE
This job will prevent caching of URLs matching the ``assetUrl`` until it is removed (or its Time to Live expires)

:parameters: A string containing key/value pairs representing parameters associated with the job - currently only uses Time to Live e.g. ``"TTL:48h"``
:startTime: The date and time at which the job began, in a non-standard format
:id: The :ref:`job-id`
:assetUrl: The :ref:`job-asset-url`
:createdBy: The :ref:`job-created-by`
:deliveryService: The :ref:`job-ds`
:ttlHours: The :ref:`job-ttl`
:invalidationType: The :ref:`job-invalidation-type`
:startTime: The :ref:`job-start-time`

.. code-block:: http
:caption: Response Example
Expand Down
18 changes: 7 additions & 11 deletions docs/source/api/v5/jobs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,17 +67,13 @@ Request Structure

Response Structure
------------------
:assetUrl: A regular expression - matching URLs will be operated upon according to ``keyword``
:createdBy: The username of the user who initiated the job
:deliveryService: The :ref:`ds-xmlid` of the :term:`Delivery Service` on which this job operates
:id: An integral, unique identifier for this job
:keyword: A keyword that represents the operation being performed by the job:

PURGE
This job will prevent caching of URLs matching the ``assetUrl`` until it is removed (or its Time to Live expires)

:parameters: A string containing key/value pairs representing parameters associated with the job - currently only uses Time to Live e.g. ``"TTL:48h"``
:startTime: The date and time at which the job began, in a non-standard format
:id: The :ref:`job-id`
:assetUrl: The :ref:`job-asset-url`
:createdBy: The :ref:`job-created-by`
:deliveryService: The :ref:`job-ds`
:ttlHours: The :ref:`job-ttl`
:invalidationType: The :ref:`job-invalidation-type`
:startTime: The :ref:`job-start-time`

.. code-block:: http
:caption: Response Example
Expand Down