diff --git a/CHANGELOG.md b/CHANGELOG.md index dffadde926..c83a70bb2f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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. - [#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 diff --git a/docs/source/api/v4/jobs.rst b/docs/source/api/v4/jobs.rst index f69651ae37..83d8ecc032 100644 --- a/docs/source/api/v4/jobs.rst +++ b/docs/source/api/v4/jobs.rst @@ -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 diff --git a/docs/source/api/v5/jobs.rst b/docs/source/api/v5/jobs.rst index 5fc8aba2e9..17ad26e1e5 100644 --- a/docs/source/api/v5/jobs.rst +++ b/docs/source/api/v5/jobs.rst @@ -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