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
4 changes: 2 additions & 2 deletions docs/source/api/v4/deliveryservice_stats.rst
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Request Structure
| | | Epoch, or in the same, proprietary format as the ``lastUpdated`` fields prevalent throughout the Traffic Ops API |
+---------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

.. _deliveryservice_stats-get-request-example:
.. _v4-deliveryservice_stats-get-request-example:
.. code-block:: http
:caption: Request Example

Expand All @@ -90,7 +90,7 @@ Request Structure

Content Format
""""""""""""""
It's important to note in :ref:`deliveryservice_stats-get-request-example` the use of a complex "Accept" header. This endpoint accepts two special media types in the "Accept" header that instruct it on how to format the timestamps associated with the returned data. Specifically, Traffic Ops will recognize the special, optional, non-standard parameter of :mimetype:`application/json`: ``timestamp``. The values of this parameter are restricted to one of
It's important to note in :ref:`v4-deliveryservice_stats-get-request-example` the use of a complex "Accept" header. This endpoint accepts two special media types in the "Accept" header that instruct it on how to format the timestamps associated with the returned data. Specifically, Traffic Ops will recognize the special, optional, non-standard parameter of :mimetype:`application/json`: ``timestamp``. The values of this parameter are restricted to one of

rfc
Returned timestamps will be formatted according to :rfc:`3339` (no sub-second precision).
Expand Down
4 changes: 1 addition & 3 deletions docs/source/api/v4/osversions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,6 @@ Request Structure
-----------------
No parameters available.

.. _response-structure:

Response Structure
------------------
This endpoint has no constant keys in its ``response``. Instead, each key in the ``response`` object is the name of an OS, and the value is a string that names the directory where the ISO source can be found. These directories sit under ``/var/www/files/`` on the Traffic Ops host machine by default, or at the location defined by the ``kickstart.files.location`` :term:`Parameter` of the Traffic Ops server's :term:`Profile`, if it is defined.
Expand Down Expand Up @@ -64,7 +62,7 @@ Configuration File
The data returned from the endpoint comes directly from a configuration file. By default, the file is located at ``/var/www/files/osversions.json``.
The **directory** of the file can be changed by creating a specific :term:`Parameter` named ``kickstart.files.location`` in configuration file ``mkisofs``.

The format of the file is a JSON object as described in :ref:`response-structure`.
The format of the file is a JSON object as described in `Response Structure`_.

.. code-block:: json
:caption: Example osversions.json file
Expand Down
4 changes: 1 addition & 3 deletions docs/source/api/v5/osversions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,6 @@ Request Structure
-----------------
No parameters available.

.. _response-structure:

Response Structure
------------------
This endpoint has no constant keys in its ``response``. Instead, each key in the ``response`` object is the name of an OS, and the value is a string that names the directory where the ISO source can be found. These directories sit under ``/var/www/files/`` on the Traffic Ops host machine by default, or at the location defined by the ``kickstart.files.location`` :term:`Parameter` of the Traffic Ops server's :term:`Profile`, if it is defined.
Expand Down Expand Up @@ -64,7 +62,7 @@ Configuration File
The data returned from the endpoint comes directly from a configuration file. By default, the file is located at ``/var/www/files/osversions.json``.
The **directory** of the file can be changed by creating a specific :term:`Parameter` named ``kickstart.files.location`` in configuration file ``mkisofs``.

The format of the file is a JSON object as described in :ref:`response-structure`.
The format of the file is a JSON object as described in `Response Structure`_.

.. code-block:: json
:caption: Example osversions.json file
Expand Down