This is an automated email from the ASF dual-hosted git repository.
ocket8888 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficcontrol.git
The following commit(s) were added to refs/heads/master by this push:
new b1e79d0 Update docs for orderby, sortOrder, limit, offset & page TO
query params (#3740)
b1e79d0 is described below
commit b1e79d01013d513d7ea39dd6b37cc9b5aa2643de
Author: Alex Luckerman <[email protected]>
AuthorDate: Fri Aug 16 09:43:46 2019 -0600
Update docs for orderby, sortOrder, limit, offset & page TO query params
(#3740)
* Update docs for orderby, sortOrder, limit & offset
* Update docs for requested PR changes
---
docs/source/api/asns.rst | 20 +++++++---
docs/source/api/cachegroups.rst | 19 ++++++---
docs/source/api/cachegroups_id.rst | 15 ++++++++
docs/source/api/cdns.rst | 18 ++++++++-
docs/source/api/cdns_name_federations.rst | 19 ++++++---
docs/source/api/cdns_name_federations_id.rst | 23 +++++++----
docs/source/api/coordinates.rst | 23 +++++++----
docs/source/api/deliveryservices.rst | 39 +++++++++++--------
docs/source/api/deliveryservices_id.rst | 37 ++++++++++--------
docs/source/api/deliveryservices_request.rst | 15 ++++++++
docs/source/api/divisions.rst | 23 +++++++----
docs/source/api/divisions_id.rst | 15 ++++++++
docs/source/api/hwinfo.rst | 39 +++++++++++--------
docs/source/api/origins.rst | 49 ++++++++++++++----------
docs/source/api/parameters.rst | 33 +++++++++++-----
docs/source/api/parameters_id.rst | 29 +++++++++++---
docs/source/api/phys_locations.rst | 27 ++++++++-----
docs/source/api/phys_locations_id.rst | 15 ++++++++
docs/source/api/profileparameters.rst | 17 +++++++-
docs/source/api/regions.rst | 27 ++++++++-----
docs/source/api/roles.rst | 16 +++++++-
docs/source/api/servers.rst | 20 ++++++----
docs/source/api/servers_id.rst | 19 ++++++++-
docs/source/api/servers_id_deliveryservices.rst | 25 +++++++++---
docs/source/api/staticdnsentries.rst | 26 ++++++++-----
docs/source/api/statuses.rst | 28 +++++++++-----
docs/source/api/statuses_id.rst | 19 ++++++++-
docs/source/api/steering_id_targets.rst | 18 ++++++---
docs/source/api/steering_id_targets_targetID.rst | 13 ++++++-
docs/source/api/tenants.rst | 29 +++++++++-----
docs/source/api/users.rst | 28 +++++++++-----
31 files changed, 546 insertions(+), 197 deletions(-)
diff --git a/docs/source/api/asns.rst b/docs/source/api/asns.rst
index 8c9b84a..26f755a 100644
--- a/docs/source/api/asns.rst
+++ b/docs/source/api/asns.rst
@@ -32,11 +32,21 @@ Request Structure
-----------------
.. table:: Request Query Parameters
-
+----------------+----------+-----------------------------------------------------------------------------------------------------+
- | Parameter | Required |
Description |
-
+================+==========+=====================================================================================================+
- | cachegroup | no | An integral, unique identifier for a
Cache Group - only ANSs for this Cache Group will be returned. |
-
+----------------+----------+-----------------------------------------------------------------------------------------------------+
+
+------------+----------+-----------------------------------------------------------------------------------------------------+
+ | Parameter | Required | Description
|
+
+============+==========+=====================================================================================================+
+ | cachegroup | no | An integral, unique identifier for a Cache
Group - only ANSs for this Cache Group will be returned. |
+
+------------+----------+-----------------------------------------------------------------------------------------------------+
+ | orderby | no | Choose the ordering of the results - must be
the name of one of the fields of the objects in the |
+ | | | ``response`` array
|
+
+------------+----------+-----------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either
ascending (default or "asc") or descending ("desc") |
+
+------------+----------+-----------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to
return |
+
+------------+----------+-----------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before
beginning to return results. Must use in conjunction with |
+ | | | limit
|
+
+------------+----------+-----------------------------------------------------------------------------------------------------+
Response Structure
------------------
diff --git a/docs/source/api/cachegroups.rst b/docs/source/api/cachegroups.rst
index c64b6d7..ff58e45 100644
--- a/docs/source/api/cachegroups.rst
+++ b/docs/source/api/cachegroups.rst
@@ -31,11 +31,20 @@ Request Structure
-----------------
.. table:: Request Query Parameters
-
+------+----------+--------------------------------------------------------------------------------------------------------+
- | Name | Required | Description
|
-
+======+==========+========================================================================================================+
- | type | no | Return only :term:`Cache Group`\ s that are of the
type identified by this integral, unique identifier |
-
+------+----------+--------------------------------------------------------------------------------------------------------+
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description
|
+
+===========+==========+===============================================================================================================+
+ | type | no | Return only :term:`Cache Group`\ s that are of
the type identified by this integral, unique identifier |
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | orderby | no | Choose the ordering of the results - must be
the name of one of the fields of the objects in the ``response`` |
+ | | | array
|
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either ascending
(default or "asc") or descending ("desc") |
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to return
|
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before beginning
to return results. Must use in conjunction with limit |
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
.. code-block:: http
:caption: Request Example
diff --git a/docs/source/api/cachegroups_id.rst
b/docs/source/api/cachegroups_id.rst
index e38490f..6b6a4fa 100644
--- a/docs/source/api/cachegroups_id.rst
+++ b/docs/source/api/cachegroups_id.rst
@@ -28,6 +28,21 @@ Extracts information about a single :term:`Cache Group`
Request Structure
-----------------
+.. table:: Request Query Parameters
+
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description
|
+
+===========+==========+===============================================================================================================+
+ | orderby | no | Choose the ordering of the results - must be
the name of one of the fields of the objects in the ``response`` |
+ | | | array
|
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either ascending
(default or "asc") or descending ("desc") |
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to return
|
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before beginning
to return results. Must use in conjunction with limit |
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+
.. table:: Request Path Parameters
+--------------+---------------------------------------------------------------+
diff --git a/docs/source/api/cdns.rst b/docs/source/api/cdns.rst
index 357570c..b0f4058 100644
--- a/docs/source/api/cdns.rst
+++ b/docs/source/api/cdns.rst
@@ -28,7 +28,23 @@ Extract information about all CDNs
Request Structure
-----------------
-No parameters available
+
+.. :table:: Request Query Parameters
+
+
+-----------+----------+-----------------------------------------------------------------------------------+
+ | Parameter | Required | Description
|
+
+===========+==========+===================================================================================+
+ | orderby | no | Choose the ordering of the results - must be
the name of one of the fields of the |
+ | | | objects in the ``response`` array
|
+
+-----------+----------+-----------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either ascending
(default or "asc") or descending |
+ | | | ("desc")
|
+
+-----------+----------+-----------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to return
|
+
+-----------+----------+-----------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before beginning
to return results. Must use in |
+ | | | conjunction with limit
|
+
+-----------+----------+-----------------------------------------------------------------------------------+
Response Structure
------------------
diff --git a/docs/source/api/cdns_name_federations.rst
b/docs/source/api/cdns_name_federations.rst
index 2526c20..ab992a7 100644
--- a/docs/source/api/cdns_name_federations.rst
+++ b/docs/source/api/cdns_name_federations.rst
@@ -31,11 +31,20 @@ Request Structure
-----------------
.. table:: Request Path Parameters
- +------+----------------------------------------------------------+
- | Name | Description |
- +======+==========================================================+
- | name | The name of the CDN for which federations will be listed |
- +------+----------------------------------------------------------+
+
+-----------+---------------------------------------------------------------------------------------------------------------+
+ | Name | Description
|
+
+===========+===============================================================================================================+
+ | name | The name of the CDN for which federations will be listed
|
+
+-----------+---------------------------------------------------------------------------------------------------------------+
+ | orderby | Choose the ordering of the results - must be the name of
one of the fields of the objects in the ``response`` |
+ | | array
|
+
+-----------+---------------------------------------------------------------------------------------------------------------+
+ | sortOrder | Changes the order of sorting. Either ascending (default
or "asc") or descending ("desc") |
+
+-----------+---------------------------------------------------------------------------------------------------------------+
+ | limit | Choose the maximum number of results to return
|
+
+-----------+---------------------------------------------------------------------------------------------------------------+
+ | offset | The number of results to skip before beginning to return
results. Must use in conjunction with limit |
+
+-----------+---------------------------------------------------------------------------------------------------------------+
.. code-block:: http
:caption: Request Example
diff --git a/docs/source/api/cdns_name_federations_id.rst
b/docs/source/api/cdns_name_federations_id.rst
index 3d3c9b4..6dc9214 100644
--- a/docs/source/api/cdns_name_federations_id.rst
+++ b/docs/source/api/cdns_name_federations_id.rst
@@ -31,13 +31,22 @@ Request Structure
-----------------
.. table:: Request Path Parameters
-
+------+-------------------------------------------------------------------------------------+
- | Name | Description
|
-
+======+=====================================================================================+
- | name | The name of the CDN for which the federation identified by
``ID`` will be inspected |
-
+------+-------------------------------------------------------------------------------------+
- | ID | An integral, unique identifier for the federation to be
inspected |
-
+------+-------------------------------------------------------------------------------------+
+
+-----------+---------------------------------------------------------------------------------------------------------------+
+ | Name | Description
|
+
+===========+===============================================================================================================+
+ | name | The name of the CDN for which the federation identified
by ``ID`` will be inspected |
+
+-----------+---------------------------------------------------------------------------------------------------------------+
+ | ID | An integral, unique identifier for the federation to be
inspected |
+
+-----------+---------------------------------------------------------------------------------------------------------------+
+ | orderby | Choose the ordering of the results - must be the name of
one of the fields of the objects in the ``response`` |
+ | | array
|
+
+-----------+---------------------------------------------------------------------------------------------------------------+
+ | sortOrder | Changes the order of sorting. Either ascending (default
or "asc") or descending ("desc") |
+
+-----------+---------------------------------------------------------------------------------------------------------------+
+ | limit | Choose the maximum number of results to return
|
+
+-----------+---------------------------------------------------------------------------------------------------------------+
+ | offset | The number of results to skip before beginning to return
results. Must use in conjunction with limit |
+
+-----------+---------------------------------------------------------------------------------------------------------------+
.. code-block:: http
:caption: Request Example
diff --git a/docs/source/api/coordinates.rst b/docs/source/api/coordinates.rst
index c96bd8e..d8c5b8b 100644
--- a/docs/source/api/coordinates.rst
+++ b/docs/source/api/coordinates.rst
@@ -32,13 +32,22 @@ Request Structure
-----------------
.. table:: Request Query Parameters
-
+------+----------+---------------------------------------------------------------------+
- | Name | Required | Description
|
-
+======+==========+=====================================================================+
- | id | no | Return only coordinates that have this integral,
unique identifier |
-
+------+----------+---------------------------------------------------------------------+
- | name | no | Return only coordinates with this name
|
-
+------+----------+---------------------------------------------------------------------+
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description
|
+
+===========+==========+===============================================================================================================+
+ | id | no | Return only coordinates that have this
integral, unique identifier |
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | name | no | Return only coordinates with this name
|
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | orderby | no | Choose the ordering of the results - must be
the name of one of the fields of the objects in the ``response`` |
+ | | | array
|
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either ascending
(default or "asc") or descending ("desc") |
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to return
|
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before beginning
to return results. Must use in conjunction with limit |
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
Response Structure
------------------
diff --git a/docs/source/api/deliveryservices.rst
b/docs/source/api/deliveryservices.rst
index bf1309c..d5b58ce 100644
--- a/docs/source/api/deliveryservices.rst
+++ b/docs/source/api/deliveryservices.rst
@@ -31,21 +31,30 @@ Request Structure
-----------------
.. table:: Request Query Parameters
-
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
- | Name | Required | Description
|
-
+=============+==========+============================================================================================================================================+
- | cdn | no | Show only the :term:`Delivery Services`
belonging to the :ref:`ds-cdn` identified by this integral, unique identifier
|
-
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
- | id | no | Show only the :term:`Delivery Service` that
has this integral, unique identifier
|
-
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
- | logsEnabled | no | Show only the :term:`Delivery Services` that
have :ref:`ds-logs-enabled` set or not based on this boolean
|
-
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
- | profile | no | Return only :term:`Delivery Services` using
the :term:`Profile` that has this :ref:`profile-id`
|
-
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
- | tenant | no | Show only the :term:`Delivery Services`
belonging to the :term:`Tenant` identified by this integral, unique identifier
|
-
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
- | type | no | Return only :term:`Delivery Services` of the
:term:`Delivery Service` :ref:`ds-types` identified by this integral, unique
identifier |
-
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
+
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description
|
+
+=============+==========+======================================================================================================================================+
+ | cdn | no | Show only the :term:`Delivery Services`
belonging to the :ref:`ds-cdn` identified by this integral, unique identifier
|
+
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Show only the :term:`Delivery Service` that
has this integral, unique identifier
|
+
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | logsEnabled | no | Show only the :term:`Delivery Services` that
have :ref:`ds-logs-enabled` set or not based on this boolean
|
+
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | profile | no | Return only :term:`Delivery Services` using
the :term:`Profile` that has this :ref:`profile-id`
|
+
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | tenant | no | Show only the :term:`Delivery Services`
belonging to the :term:`Tenant` identified by this integral, unique identifier
|
+
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | type | no | Return only :term:`Delivery Services` of the
:term:`Delivery Service` :ref:`ds-types` identified by this integral, unique
identifier |
+
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | orderby | no | Choose the ordering of the results - must be
the name of one of the fields of the objects in the ``response``
|
+ | | | array
|
+
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either
ascending (default or "asc") or descending ("desc")
|
+
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to
return
|
+
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before
beginning to return results. Must use in conjunction with limit
|
+
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
Response Structure
------------------
diff --git a/docs/source/api/deliveryservices_id.rst
b/docs/source/api/deliveryservices_id.rst
index 31c713c..1aa466c 100644
--- a/docs/source/api/deliveryservices_id.rst
+++ b/docs/source/api/deliveryservices_id.rst
@@ -34,21 +34,28 @@ Request Structure
-----------------
.. table:: Request Query Parameters
-
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
- | Name | Required | Description
|
-
+=============+==========+============================================================================================================================================+
- | cdn | no | Show only the :term:`Delivery Services`
belonging to the CDN identified by this integral, unique identifier
|
-
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
- | logsEnabled | no | If true, return only :term:`Delivery
Services` with logging enabled, otherwise return only :term:`Delivery Services`
with logging disabled |
-
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
- | profile | no | Return only :term:`Delivery Services` using
the :term:`Profile` with this :ref:`profile-id`
|
-
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
- | tenant | no | Show only the :term:`Delivery Services`
belonging to the tenant identified by this integral, unique identifier
|
-
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
- | type | no | Return only :term:`Delivery Services` of the
:ref:`Delivery Service Type <ds-types>` identified by this integral, unique
identifier |
-
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
-
-.. tip:: Since this method of this endpoint by definition should only ever
return one :term:`Delivery Service`, using these query parameters is typically
useless. Unless for some reason the only desired information is the value of
one of these specific fields.
+
+-------------+----------+------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description
|
+
+=============+==========+================================================================================================================================================+
+ | cdn | no | Show only the :term:`Delivery Service`\ s
belonging to the CDN identified by this integral, unique identifier
|
+
+-------------+----------+------------------------------------------------------------------------------------------------------------------------------------------------+
+ | logsEnabled | no | If true, return only :term:`Delivery
Service`\ s with logging enabled, otherwise return only :term:`Delivery
Service`\ s with logging disabled |
+
+-------------+----------+------------------------------------------------------------------------------------------------------------------------------------------------+
+ | profile | no | Return only :term:`Delivery Service`\ s
using the profile identified by this integral, unique identifier
|
+
+-------------+----------+------------------------------------------------------------------------------------------------------------------------------------------------+
+ | tenant | no | Show only the :term:`Delivery Service`\ s
belonging to the tenant identified by this integral, unique identifier
|
+
+-------------+----------+------------------------------------------------------------------------------------------------------------------------------------------------+
+ | type | no | Return only :term:`Delivery Service`\ s of
the :term:`Delivery Service` type identified by this integral, unique
identifier |
+
+-------------+----------+------------------------------------------------------------------------------------------------------------------------------------------------+
+ | orderby | no | Choose the ordering of the results - must be
the name of one of the fields of the objects in the ``response``
|
+ | | | array
|
+
+-------------+----------+------------------------------------------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either
ascending (default or "asc") or descending ("desc")
|
+
+-------------+----------+------------------------------------------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to
return
|
+
+-------------+----------+------------------------------------------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before
beginning to return results. Must use in conjunction with limit
|
+
+-------------+----------+------------------------------------------------------------------------------------------------------------------------------------------------+
.. table:: Request Path Parameters
diff --git a/docs/source/api/deliveryservices_request.rst
b/docs/source/api/deliveryservices_request.rst
index 8c2cf47..c87bf3b 100644
--- a/docs/source/api/deliveryservices_request.rst
+++ b/docs/source/api/deliveryservices_request.rst
@@ -31,6 +31,21 @@ Allows a user to submit Delivery Service Requests.
Request Structure
-----------------
+.. table:: Request Query Parameters
+
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description
|
+
+===========+==========+===============================================================================================================+
+ | orderby | no | Choose the ordering of the results - must be
the name of one of the fields of the objects in the ``response`` |
+ | | | array
|
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either ascending
(default or "asc") or descending ("desc") |
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to return
|
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before beginning
to return results. Must use in conjunction with limit |
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+
:details: An object describing the actual parameters for the Delivery Service
request
:customer: Name of the customer associated with the
:term:`Delivery Service`
diff --git a/docs/source/api/divisions.rst b/docs/source/api/divisions.rst
index d87d7d4..d9169cd 100644
--- a/docs/source/api/divisions.rst
+++ b/docs/source/api/divisions.rst
@@ -31,13 +31,22 @@ Request Structure
-----------------
.. table:: Request Query Parameters
- +------+--------------------------------------------------------------+
- | Name | Description |
- +======+==============================================================+
- | id | Filter for divisions having this integral, unique identifier |
- +------+--------------------------------------------------------------+
- | name | Filter for divisions with this name |
- +------+--------------------------------------------------------------+
+
+-----------+---------------------------------------------------------------------------------------------------------------+
+ | Name | Description
|
+
+===========+===============================================================================================================+
+ | id | Filter for divisions having this integral, unique
identifier |
+
+-----------+---------------------------------------------------------------------------------------------------------------+
+ | name | Filter for divisions with this name
|
+
+-----------+---------------------------------------------------------------------------------------------------------------+
+ | orderby | Choose the ordering of the results - must be the name of
one of the fields of the objects in the ``response`` |
+ | | array
|
+
+-----------+---------------------------------------------------------------------------------------------------------------+
+ | sortOrder | Changes the order of sorting. Either ascending (default
or "asc") or descending ("desc") |
+
+-----------+---------------------------------------------------------------------------------------------------------------+
+ | limit | Choose the maximum number of results to return
|
+
+-----------+---------------------------------------------------------------------------------------------------------------+
+ | offset | The number of results to skip before beginning to return
results. Must use in conjunction with limit |
+
+-----------+---------------------------------------------------------------------------------------------------------------+
Response Structure
------------------
diff --git a/docs/source/api/divisions_id.rst b/docs/source/api/divisions_id.rst
index b873dd3..c53f9c6 100644
--- a/docs/source/api/divisions_id.rst
+++ b/docs/source/api/divisions_id.rst
@@ -32,6 +32,21 @@ Get a specific Division.
Request Structure
-----------------
+.. table:: Request Query Parameters
+
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description
|
+
+===========+==========+===============================================================================================================+
+ | orderby | no | Choose the ordering of the results - must be
the name of one of the fields of the objects in the ``response`` |
+ | | | array
|
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either ascending
(default or "asc") or descending ("desc") |
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to return
|
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before beginning
to return results. Must use in conjunction with limit |
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+
.. table:: Request Path Parameters
+------+-----------------------------------------------------------+
diff --git a/docs/source/api/hwinfo.rst b/docs/source/api/hwinfo.rst
index f587dde..1c514a6 100644
--- a/docs/source/api/hwinfo.rst
+++ b/docs/source/api/hwinfo.rst
@@ -31,21 +31,30 @@ Request Structure:
------------------
.. table:: Request Query Parameters
-
+----------------+----------+-----------------------------------------------------------------------------------------------------------+
- | Name | Required | Description
|
-
+================+==========+===========================================================================================================+
- | id | no | An integral, unique identifier of a
specific hwinfo object which will be retrieved |
-
+----------------+----------+-----------------------------------------------------------------------------------------------------------+
- | serverHostName | no | The name of the server for which hwinfo
objects will be retrieved |
-
+----------------+----------+-----------------------------------------------------------------------------------------------------------+
- | serverId | no | The integral, unique identifier of a
server for which hwinfo objects will be retrieved |
-
+----------------+----------+-----------------------------------------------------------------------------------------------------------+
- | description | no | The description of a hwinfo object; only
hwinfo objects with descriptions matching this will be retrieved |
-
+----------------+----------+-----------------------------------------------------------------------------------------------------------+
- | val | no | The value of a hwinfo object; only hwinfo
objects with values matching this will be retrieved |
-
+----------------+----------+-----------------------------------------------------------------------------------------------------------+
- | lastUpdated | no | Only hwinfo objects that were last
updated at this ISO-format date and time will be retrieved |
-
+----------------+----------+-----------------------------------------------------------------------------------------------------------+
+
+----------------+----------+---------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description
|
+
+================+==========+===============================================================================================================+
+ | id | no | An integral, unique identifier of a
specific hwinfo object which will be retrieved |
+
+----------------+----------+---------------------------------------------------------------------------------------------------------------+
+ | serverHostName | no | The name of the server for which hwinfo
objects will be retrieved |
+
+----------------+----------+---------------------------------------------------------------------------------------------------------------+
+ | serverId | no | The integral, unique identifier of a
server for which hwinfo objects will be retrieved |
+
+----------------+----------+---------------------------------------------------------------------------------------------------------------+
+ | description | no | The description of a hwinfo object; only
hwinfo objects with descriptions matching this will be retrieved |
+
+----------------+----------+---------------------------------------------------------------------------------------------------------------+
+ | val | no | The value of a hwinfo object; only hwinfo
objects with values matching this will be retrieved |
+
+----------------+----------+---------------------------------------------------------------------------------------------------------------+
+ | lastUpdated | no | Only hwinfo objects that were last
updated at this ISO-format date and time will be retrieved |
+
+----------------+----------+---------------------------------------------------------------------------------------------------------------+
+ | orderby | no | Choose the ordering of the results - must
be the name of one of the fields of the objects in the ``response`` |
+ | | | array
|
+
+----------------+----------+---------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either
ascending (default or "asc") or descending ("desc") |
+
+----------------+----------+---------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to
return |
+
+----------------+----------+---------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before
beginning to return results. Must use in conjunction with limit |
+
+----------------+----------+---------------------------------------------------------------------------------------------------------------+
.. caution:: The ``lastUpdated`` query parameter doesn't seem to work
properly, and its use is therefore discouraged.
diff --git a/docs/source/api/origins.rst b/docs/source/api/origins.rst
index bbd93db..609e4e5 100644
--- a/docs/source/api/origins.rst
+++ b/docs/source/api/origins.rst
@@ -32,26 +32,35 @@ Request Structure
-----------------
.. table:: Request Query Parameters
-
+-----------------+----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | Name | Required | Description
|
-
+=================+==========+===================================================================================================================================================================+
- | cachegroup | no | Return only :term:`origins` within the
:term:`Cache Group` identified by this integral, unique identifier
|
-
+-----------------+----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | coordinate | no | Return only :term:`origins` located at
the geographic coordinates identified by this integral, unique identifier
|
-
+-----------------+----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | deliveryservice | no | Return only :term:`origins` that belong
to the :term:`Delivery Service` identified by this integral, unique identifier
|
-
+-----------------+----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | id | no | Return only the :term:`origin` that has
this integral, unique identifier
|
-
+-----------------+----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | name | no | Return only :term:`origins` by this name
|
-
+-----------------+----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | profileId | no | Return only :term:`origins` which use
the :term:`Profile` that has this :ref:`profile-id`
|
-
+-----------------+----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | primary | no | If ``true``, return only :term:`origins`
which are the the primary :term:`origin` of the :term:`Delivery Service` to
which they belong - if ``false`` return only |
- | | | :term:`origins` which are *not* the
primary :term:`origin` of the :term:`Delivery Service` to which they belong
|
-
+-----------------+----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | tenant | no | Return only :term:`origins` belonging to
the tenant identified by this integral, unique identifier
|
-
+-----------------+----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+-----------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description
|
+
+=================+==========+=====================================================================================================================================================================+
+ | cachegroup | no | Return only :term:`origin`\ s within the
:term:`Cache Group` identified by this integral, unique identifier
|
+
+-----------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | coordinate | no | Return only :term:`origin`\ s located at
the geographic coordinates identified by this integral, unique identifier
|
+
+-----------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | deliveryservice | no | Return only :term:`origin`\ s that
belong to the :term:`Delivery Service` identified by this integral, unique
identifier |
+
+-----------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Return only the :term:`origin` that has
this integral, unique identifier
|
+
+-----------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | name | no | Return only :term:`origin`\ s by this
name
|
+
+-----------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | profileId | no | Return only :term:`origin`\ s which use
the :term:`Profile` identified by this integral, unique identifier
|
+
+-----------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | primary | no | If ``true``, return only :term:`origin`\
s which are the the primary :term:`origin` of the :term:`Delivery Service` to
which they belong - if ``false`` return only |
+ | | | :term:`origin`\ s which are *not* the
primary :term:`origin` of the :term:`Delivery Service` to which they belong
|
+
+-----------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | tenant | no | Return only :term:`origin`\ s belonging
to the tenant identified by this integral, unique identifier
|
+
+-----------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | orderby | no | Choose the ordering of the results -
must be the name of one of the fields of the objects in the ``response``
|
+ | | | array
|
+
+-----------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either
ascending (default or "asc") or descending ("desc")
|
+
+-----------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to
return
|
+
+-----------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before
beginning to return results. Must use in conjunction with limit
|
+
+-----------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. note:: Several fields of origin definitions which are filterable by Query
Parameters are allowed to be ``null``. ``null`` values in these fields will be
filtered *out* appropriately by such Query Parameters, but do note that
``null`` is not a valid value accepted by any of these Query Parameters, and
attempting to pass it will result in an error.
diff --git a/docs/source/api/parameters.rst b/docs/source/api/parameters.rst
index 33257cd..6200928 100644
--- a/docs/source/api/parameters.rst
+++ b/docs/source/api/parameters.rst
@@ -31,15 +31,30 @@ Request Structure
-----------------
.. table:: Request Query Parameters
-
+------------+----------+-----------------------------------------------------------+
- | Name | Required | Description
|
-
+============+==========+===========================================================+
- | id | no | Filter :term:`Parameters` by
:ref:`parameter-id` |
-
+------------+----------+-----------------------------------------------------------+
- | name | no | Filter :term:`Parameters` by
:ref:`parameter-name` |
-
+------------+----------+-----------------------------------------------------------+
- | configFile | no | Filter :term:`Parameters` by
:ref:`parameter-config-file` |
-
+------------+----------+-----------------------------------------------------------+
+
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description
|
+
+=============+==========+======================================================================================================================================+
+ | cdn | no | Show only the :term:`Delivery Services`
belonging to the :ref:`ds-cdn` identified by this integral, unique identifier
|
+
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Show only the :term:`Delivery Service` that
has this integral, unique identifier
|
+
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | logsEnabled | no | Show only the :term:`Delivery Services` that
have :ref:`ds-logs-enabled` set or not based on this boolean
|
+
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | profile | no | Return only :term:`Delivery Services` using
the :term:`Profile` that has this :ref:`profile-id`
|
+
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | tenant | no | Show only the :term:`Delivery Services`
belonging to the :term:`Tenant` identified by this integral, unique identifier
|
+
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | type | no | Return only :term:`Delivery Services` of the
:term:`Delivery Service` :ref:`ds-types` identified by this integral, unique
identifier |
+
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | orderby | no | Choose the ordering of the results - must be
the name of one of the fields of the objects in the ``response``
|
+ | | | array
|
+
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either
ascending (default or "asc") or descending ("desc")
|
+
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to
return
|
+
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before
beginning to return results. Must use in conjunction with limit.
|
+
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
.. code-block:: http
:caption: Request Example
diff --git a/docs/source/api/parameters_id.rst
b/docs/source/api/parameters_id.rst
index 426c1dd..eb5e176 100644
--- a/docs/source/api/parameters_id.rst
+++ b/docs/source/api/parameters_id.rst
@@ -34,11 +34,30 @@ Request Structure
-----------------
.. table:: Request Path Parameters
-
+------+------------------------------------------------------------------------+
- | Name | Description
|
-
+======+========================================================================+
- | ID | The :ref:`parameter-id` of the :term:`Parameter` which will be
deleted |
-
+------+------------------------------------------------------------------------+
+
+-------------+---------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required
| Description
|
+
+=============+===============================================================================================================+======================================================================================================================================+
+ | cdn | no
| Show only the
:term:`Delivery Services` belonging to the :ref:`ds-cdn` identified by this
integral, unique identifier |
+
+-------------+---------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no
| Show only the
:term:`Delivery Service` that has this integral, unique identifier
|
+
+-------------+---------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | logsEnabled | no
| Show only the
:term:`Delivery Services` that have :ref:`ds-logs-enabled` set or not based on
this boolean |
+
+-------------+---------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | profile | no
| Return only
:term:`Delivery Services` using the :term:`Profile` that has this
:ref:`profile-id` |
+
+-------------+---------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | tenant | no
| Show only the
:term:`Delivery Services` belonging to the :term:`Tenant` identified by this
integral, unique identifier |
+
+-------------+---------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | type | no
| Return only
:term:`Delivery Services` of the :term:`Delivery Service` :ref:`ds-types`
identified by this integral, unique identifier |
+
+-------------+---------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | orderby | Choose the ordering of the results - must be the name
of one of the fields of the objects in the ``response`` |
|
+ | | array
|
|
+
+-------------+---------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | sortOrder | Changes the order of sorting. Either ascending (default
or "asc") or descending ("desc") |
|
+
+-------------+---------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | limit | Choose the maximum number of results to return
|
|
+
+-------------+---------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | offset | The number of results to skip before beginning to
return results. Must use in conjunction with limit |
|
+
+-------------+---------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
.. code-block:: http
:caption: Request Example
diff --git a/docs/source/api/phys_locations.rst
b/docs/source/api/phys_locations.rst
index 1f7dee1..3a4b4f0 100644
--- a/docs/source/api/phys_locations.rst
+++ b/docs/source/api/phys_locations.rst
@@ -31,15 +31,24 @@ Request Structure
-----------------
.. table:: Request Query Parameters
- +--------+------------------------------------------------------------+
- | Name | Description |
- +========+============================================================+
- | id | Filter by integral, unique identifier |
- +--------+------------------------------------------------------------+
- | region | Filter by integral, unique identifier of containing region |
- +--------+------------------------------------------------------------+
- | name | Filter by name |
- +--------+------------------------------------------------------------+
+
+-----------+---------------------------------------------------------------------------------------------------------------+
+ | Name | Description
|
+
+===========+===============================================================================================================+
+ | id | Filter by integral, unique identifier
|
+
+-----------+---------------------------------------------------------------------------------------------------------------+
+ | region | Filter by integral, unique identifier of containing
region |
+
+-----------+---------------------------------------------------------------------------------------------------------------+
+ | name | Filter by name
|
+
+-----------+---------------------------------------------------------------------------------------------------------------+
+ | orderby | Choose the ordering of the results - must be the name of
one of the fields of the objects in the ``response`` |
+ | | array
|
+
+-----------+---------------------------------------------------------------------------------------------------------------+
+ | sortOrder | Changes the order of sorting. Either ascending (default
or "asc") or descending ("desc") |
+
+-----------+---------------------------------------------------------------------------------------------------------------+
+ | limit | Choose the maximum number of results to return
|
+
+-----------+---------------------------------------------------------------------------------------------------------------+
+ | offset | The number of results to skip before beginning to return
results. Must use in conjunction with limit |
+
+-----------+---------------------------------------------------------------------------------------------------------------+
.. code-block:: http
:caption: Request Example
diff --git a/docs/source/api/phys_locations_id.rst
b/docs/source/api/phys_locations_id.rst
index 12c4c9f..f39e149 100644
--- a/docs/source/api/phys_locations_id.rst
+++ b/docs/source/api/phys_locations_id.rst
@@ -32,6 +32,21 @@ Retrieves information about a specific physical location
Request Structure
-----------------
+.. table:: Request Query Parameters
+
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description
|
+
+===========+==========+===============================================================================================================+
+ | orderby | no | Choose the ordering of the results - must be
the name of one of the fields of the objects in the ``response`` |
+ | | | array
|
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either ascending
(default or "asc") or descending ("desc") |
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to return
|
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before beginning
to return results. Must use in conjunction with limit |
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+
.. table:: Request Path Parameters
+------+--------------------------------------------------------------------------+
diff --git a/docs/source/api/profileparameters.rst
b/docs/source/api/profileparameters.rst
index 949c8a7..732a629 100644
--- a/docs/source/api/profileparameters.rst
+++ b/docs/source/api/profileparameters.rst
@@ -32,8 +32,21 @@ Retrieves all :term:`Parameter`/:term:`Profile` assignments.
Request Structure
-----------------
-No parameters available
-
+.. table:: Request Query Parameters
+
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description
|
+
+===========+==========+===============================================================================================================+
+ | orderby | no | Choose the ordering of the results - must be
the name of one of the fields of the objects in the ``response`` |
+ | | | array
|
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either ascending
(default or "asc") or descending ("desc") |
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to return
|
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before beginning
to return results. Must use in conjunction with limit |
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+
Response Structure
------------------
:lastUpdated: The date and time at which this
:term:`Profile`/:term:`Parameter` association was last modified, in an ISO-like
format
diff --git a/docs/source/api/regions.rst b/docs/source/api/regions.rst
index 3297b2b..25e1124 100644
--- a/docs/source/api/regions.rst
+++ b/docs/source/api/regions.rst
@@ -31,15 +31,24 @@ Request Structure
-----------------
.. table:: Request Query Parameters
-
+----------+----------+---------------------------------------------------------------------------------------+
- | Name | Required | Description
|
-
+==========+==========+=======================================================================================+
- | division | no | Filter regions by the integral, unique
identifier of the division which contains them |
-
+----------+----------+---------------------------------------------------------------------------------------+
- | id | no | Filter regions by integral, unique identifier
|
-
+----------+----------+---------------------------------------------------------------------------------------+
- | name | no | Filter regions by name
|
-
+----------+----------+---------------------------------------------------------------------------------------+
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description
|
+
+===========+==========+===============================================================================================================+
+ | division | no | Filter regions by the integral, unique
identifier of the division which contains them |
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | id | no | Filter regions by integral, unique identifier
|
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | name | no | Filter regions by name
|
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | orderby | no | Choose the ordering of the results - must be
the name of one of the fields of the objects in the ``response`` |
+ | | | array
|
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either ascending
(default or "asc") or descending ("desc") |
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to return
|
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before beginning
to return results. Must use in conjunction with limit |
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
.. code-block:: http
:caption: Request Example
diff --git a/docs/source/api/roles.rst b/docs/source/api/roles.rst
index d2eca12..1aa7ca6 100644
--- a/docs/source/api/roles.rst
+++ b/docs/source/api/roles.rst
@@ -29,7 +29,21 @@ Retrieves all user roles.
Request Structure
-----------------
-No parameters available.
+.. table:: Request Query Parameters
+
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description
|
+
+===========+==========+===============================================================================================================+
+ | orderby | no | Choose the ordering of the results - must be
the name of one of the fields of the objects in the ``response`` |
+ | | | array
|
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either ascending
(default or "asc") or descending ("desc") |
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to return
|
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before beginning
to return results. Must use in conjunction with limit |
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+
Response Structure
------------------
diff --git a/docs/source/api/servers.rst b/docs/source/api/servers.rst
index a9765ad..83a37ef 100644
--- a/docs/source/api/servers.rst
+++ b/docs/source/api/servers.rst
@@ -32,21 +32,27 @@ Request Structure
.. table:: Request Query Parameters
+------------+----------+-------------------------------------------------------------------------------------------------------------------+
- | Name | Required |
Description |
+ | Name | Required | Description
|
+============+==========+===================================================================================================================+
| cachegroup | no | Return only those servers within the
:term:`Cache Group` identified by this integral, unique identifier |
+------------+----------+-------------------------------------------------------------------------------------------------------------------+
- | dsId | no | Return only those servers assigned to the
:term:`Delivery Service` identified by this integral, unique identifier |
+ | dsId | no | Return only those servers assigned to the
:term:`Delivery Service` identified by this integral, unique identifier |
+------------+----------+-------------------------------------------------------------------------------------------------------------------+
- | hostName | no | Return only those servers that have this
(short) hostname |
+ | hostName | no | Return only those servers that have this
(short) hostname |
+------------+----------+-------------------------------------------------------------------------------------------------------------------+
- | id | no | Return only the server with this integral,
unique identifier |
+ | id | no | Return only the server with this integral,
unique identifier |
+------------+----------+-------------------------------------------------------------------------------------------------------------------+
- | profileId | no | Return only those servers that are using the
:term:`Profile` that has this :ref:`profile-id` |
+ | profileId | no | Return only those servers that are using the
:term:`Profile` that has this :ref:`profile-id` |
+------------+----------+-------------------------------------------------------------------------------------------------------------------+
- | status | no | Return only those servers with this status -
see :ref:`health-proto` |
+ | status | no | Return only those servers with this status -
see :ref:`health-proto` |
+------------+----------+-------------------------------------------------------------------------------------------------------------------+
- | type | no | Return only servers of this 'type'
|
+ | type | no | Return only servers of this 'type'
|
+
+------------+----------+-------------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either
ascending (default or "asc") or descending ("desc") |
+
+------------+----------+-------------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to
return |
+
+------------+----------+-------------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before
beginning to return results. Must use in conjunction with limit |
+------------+----------+-------------------------------------------------------------------------------------------------------------------+
.. code-block:: http
diff --git a/docs/source/api/servers_id.rst b/docs/source/api/servers_id.rst
index ad98e56..aa78fa7 100644
--- a/docs/source/api/servers_id.rst
+++ b/docs/source/api/servers_id.rst
@@ -37,9 +37,24 @@ Request Structure
+------+---------------------------------------------+
| Name | Description |
+======+=============================================+
- | ID | The integral, unique identifier of a server |
+ | ID | The integral, unique identifier of a server |
+------+---------------------------------------------+
-
+
+.. table:: Request Query Parameters
+
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description
|
+
+===========+==========+===============================================================================================================+
+ | orderby | no | Choose the ordering of the results - must be
the name of one of the fields of the objects in the ``response`` |
+ | | | array
|
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either ascending
(default or "asc") or descending ("desc") |
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to return
|
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before beginning
to return results. Must use in conjunction with limit |
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+
.. code-block:: http
:caption: Request Example
diff --git a/docs/source/api/servers_id_deliveryservices.rst
b/docs/source/api/servers_id_deliveryservices.rst
index fa4d1b3..ce7cbc9 100644
--- a/docs/source/api/servers_id_deliveryservices.rst
+++ b/docs/source/api/servers_id_deliveryservices.rst
@@ -31,11 +31,26 @@ Request Structure
-----------------
.. table:: Request Path Parameters
-
+------+------------------------------------------------------------------------------------------------------------+
- | Name | Description
|
-
+======+============================================================================================================+
- | ID | The integral, unique identifier of the server for which
assigned :term:`Delivery Services` shall be listed |
-
+------+------------------------------------------------------------------------------------------------------------+
+
+------+--------------------------------------------------------------------------------------------------------------+
+ | Name | Description
|
+
+======+==============================================================================================================+
+ | ID | The integral, unique identifier of the server for which
assigned :term:`Delivery Service`\ s shall be listed |
+
+------+--------------------------------------------------------------------------------------------------------------+
+
+.. table:: Request Query Parameters
+
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description
|
+
+===========+==========+===============================================================================================================+
+ | orderby | no | Choose the ordering of the results - must be
the name of one of the fields of the objects in the ``response`` |
+ | | | array
|
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either ascending
(default or "asc") or descending ("desc") |
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to return
|
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before beginning
to return results. Must use in conjunction with limit |
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
.. code-block:: http
:caption: Request Example
diff --git a/docs/source/api/staticdnsentries.rst
b/docs/source/api/staticdnsentries.rst
index 6a3d901..8842ef9 100644
--- a/docs/source/api/staticdnsentries.rst
+++ b/docs/source/api/staticdnsentries.rst
@@ -32,27 +32,33 @@ Request Structure
.. table:: Request Query Parameters
+-------------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
- | Name | Required | Description
|
+ | Name | Required | Description
|
+===================+==========+============================================================================================================================================+
- | address | no | Return only static DNS entries that
operate on this address/:abbr:`CNAME (Canonical Name)`
|
+ | address | no | Return only static DNS entries that
operate on this address/:abbr:`CNAME (Canonical Name)`
|
+-------------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
- | cachegroup | no | Return only static DNS entries
assigned to this :term:`Cache Group`
|
+ | cachegroup | no | Return only static DNS entries
assigned to this :term:`Cache Group`
|
+-------------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
- | cachegroupId | no | Return only static DNS entries
assigned to the :term:`Cache Group` identified by this integral, unique
identifier |
+ | cachegroupId | no | Return only static DNS entries
assigned to the :term:`Cache Group` identified by this integral, unique
identifier |
+-------------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
- | deliveryservice | no | Return only static DNS entries that
apply within the domain of the :term:`Delivery Service` with this 'xml_id'
|
+ | deliveryservice | no | Return only static DNS entries that
apply within the domain of the :term:`Delivery Service` with this 'xml_id'
|
+-------------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
| deliveryserviceId | no | Return only static DNS entries that
apply within the domain of the :term:`Delivery Service` identified by this
integral, unique identifier |
+-------------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
- | host | no | Return only static DNS entries that
resolve this :abbr:`FQDN (Fully Qualified Domain Name)`
|
+ | host | no | Return only static DNS entries that
resolve this :abbr:`FQDN (Fully Qualified Domain Name)`
|
+-------------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
- | id | no | Return only the static DNS entry with
this integral, unique identifier
|
+ | id | no | Return only the static DNS entry with
this integral, unique identifier
|
+-------------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
- | ttl | no | Return only static DNS entries with
this :abbr:`TTL (Time To Live)`
|
+ | ttl | no | Return only static DNS entries with
this :abbr:`TTL (Time To Live)`
|
+-------------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
- | type | no | Return only static DNS entries of this
type
|
+ | type | no | Return only static DNS entries of this
type
|
+-------------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
- | typeId | no | Return only static DNS entries of the
type identified by this integral, unique identifier
|
+ | typeId | no | Return only static DNS entries of the
type identified by this integral, unique identifier
|
+
+-------------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either
ascending (default or "asc") or descending ("desc")
|
+
+-------------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results
to return
|
+
+-------------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before
beginning to return results. Must use in conjunction with limit
|
+-------------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
.. code-block:: http
diff --git a/docs/source/api/statuses.rst b/docs/source/api/statuses.rst
index ad3ef12..ab42b93 100644
--- a/docs/source/api/statuses.rst
+++ b/docs/source/api/statuses.rst
@@ -31,15 +31,25 @@ Request Structure
-----------------
.. table:: Request Query Parameters
-
+-------------+----------+--------------------------------------------------------------+
- | Name | Required | Description
|
-
+=============+==========+==============================================================+
- | description | no | Return only statuses with this *exact*
description |
-
+-------------+----------+--------------------------------------------------------------+
- | id | no | Return only the status with this integral,
unique identifier |
-
+-------------+----------+--------------------------------------------------------------+
- | name | no | Return only statuses with this name
|
-
+-------------+----------+--------------------------------------------------------------+
+
+-------------+----------+------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description
|
+
+=============+==========+======================================================================================================+
+ | description | no | Return only statuses with this *exact*
description |
+
+-------------+----------+------------------------------------------------------------------------------------------------------+
+ | id | no | Return only the status with this integral,
unique identifier |
+
+-------------+----------+------------------------------------------------------------------------------------------------------+
+ | name | no | Return only statuses with this name
|
+
+-------------+----------+------------------------------------------------------------------------------------------------------+
+ | orderby | no | Choose the ordering of the results - must be
the name of one |
+ | | | of the fields of the objects in the
``response`` array |
+
+-------------+----------+------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either
ascending (default or "asc") or |
+ | | | descending ("desc")
|
+
+-------------+----------+------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to
return |
+
+-------------+----------+------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before
beginning to return results. Must use in conjunction with limit |
+
+-------------+----------+------------------------------------------------------------------------------------------------------+
.. code-block:: http
:caption: Request Example
diff --git a/docs/source/api/statuses_id.rst b/docs/source/api/statuses_id.rst
index 2025927..b127463 100644
--- a/docs/source/api/statuses_id.rst
+++ b/docs/source/api/statuses_id.rst
@@ -34,11 +34,26 @@ Request Structure
.. table:: Request Path Parameters
+------+---------------------------------------------------------------+
- | Name | Description |
+ | Name | Description |
+======+===============================================================+
- | ID | The integral, unique identifier of the status being inspected |
+ | ID | The integral, unique identifier of the status being inspected |
+------+---------------------------------------------------------------+
+.. table:: Request Query Parameters
+
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description
|
+
+===========+==========+===============================================================================================================+
+ | orderby | no | Choose the ordering of the results - must be
the name of one of the fields of the objects in the ``response`` |
+ | | | array
|
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either ascending
(default or "asc") or descending ("desc") |
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to return
|
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before beginning
to return results. Must use in conjunction with limit |
+
+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+
.. code-block:: http
:caption: Request Example
diff --git a/docs/source/api/steering_id_targets.rst
b/docs/source/api/steering_id_targets.rst
index 1362758..ba97752 100644
--- a/docs/source/api/steering_id_targets.rst
+++ b/docs/source/api/steering_id_targets.rst
@@ -39,11 +39,19 @@ Request Structure
.. table:: Request Query Parameters
-
+--------+-------------------------------------------------------------------------------------------------------------------------+
- | Name | Description
|
-
+========+=========================================================================================================================+
- | target | Return only the target mappings that target the
:term:`Delivery Service` identified by this integral, unique identifier |
-
+--------+-------------------------------------------------------------------------------------------------------------------------+
+
+-----------+-------------------------------------------------------------------------------------------------------------------------+
+ | Name | Description
|
+
+===========+=========================================================================================================================+
+ | target | Return only the target mappings that target the
:term:`Delivery Service` identified by this integral, unique identifier |
+
+-----------+-------------------------------------------------------------------------------------------------------------------------+
+ | orderby | Choose the ordering of the results - must be the name of
one of the fields of the objects in the ``response`` array |
+
+-----------+-------------------------------------------------------------------------------------------------------------------------+
+ | sortOrder | Changes the order of sorting. Either ascending (default
or "asc") or descending ("desc") |
+
+-----------+-------------------------------------------------------------------------------------------------------------------------+
+ | limit | Choose the maximum number of results to return
|
+
+-----------+-------------------------------------------------------------------------------------------------------------------------+
+ | offset | The number of results to skip before beginning to return
results. Must use in conjunction with limit |
+
+-----------+-------------------------------------------------------------------------------------------------------------------------+
.. code-block:: http
:caption: Request Structure
diff --git a/docs/source/api/steering_id_targets_targetID.rst
b/docs/source/api/steering_id_targets_targetID.rst
index a8a1525..ac5dba5 100644
--- a/docs/source/api/steering_id_targets_targetID.rst
+++ b/docs/source/api/steering_id_targets_targetID.rst
@@ -35,12 +35,21 @@ Request Structure
.. table:: Request Path Parameters
+----------+--------------------------------------------------------------------------------------------------------------------------------------+
- | Name | Description
|
+ | Name | Description
|
+==========+======================================================================================================================================+
- | ID | The integral, unique identifier of a steering
:term:`Delivery Service`
|
+ | ID | The integral, unique identifier of a steering
:term:`Delivery Service`
|
+----------+--------------------------------------------------------------------------------------------------------------------------------------+
| targetID | The integral, unique identifier of a :term:`Delivery
Service` which is a target of the :term:`Delivery Service` identified by ``ID``
|
+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | orderby | Choose the ordering of the results - must be the name of
one of the fields of the objects in the ``response`` array |
+
+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | sortOrde | Changes the order of sorting. Either ascending (default or
"asc") or descending ("desc") |
+ | r |
|
+
+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | limit | Choose the maximum number of results to return
|
+
+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | offset | The number of results to skip before beginning to return
results. Must use in conjunction with limit |
+
+----------+--------------------------------------------------------------------------------------------------------------------------------------+
.. code-block:: http
:caption: Request Example
diff --git a/docs/source/api/tenants.rst b/docs/source/api/tenants.rst
index 5d91bcd..c03e9b6 100644
--- a/docs/source/api/tenants.rst
+++ b/docs/source/api/tenants.rst
@@ -31,15 +31,26 @@ Request Structure
-----------------
.. table:: Request Query Parameters
-
+--------+------------------------------------------------------------------------------------+
- | Name | Description
|
-
+========+====================================================================================+
- | active | If ``true``, return only active tenants; if ``false`` return
only inactive tenants |
-
+--------+------------------------------------------------------------------------------------+
- | id | Return only tenants with this integral, unique identifier
|
-
+--------+------------------------------------------------------------------------------------+
- | name | Return only tenants with this name
|
-
+--------+------------------------------------------------------------------------------------+
+
+-----------+------------------------------------------------------------------------------------+
+ | Name | Description
|
+
+===========+====================================================================================+
+ | active | If ``true``, return only active tenants; if ``false``
return only inactive tenants |
+
+-----------+------------------------------------------------------------------------------------+
+ | id | Return only tenants with this integral, unique identifier
|
+
+-----------+------------------------------------------------------------------------------------+
+ | name | Return only tenants with this name
|
+
+-----------+------------------------------------------------------------------------------------+
+ | orderby | Choose the ordering of the results - must be the name of
one of the fields of the |
+ | | objects in the ``response`` array
|
+
+-----------+------------------------------------------------------------------------------------+
+ | sortOrder | Changes the order of sorting. Either ascending (default
or "asc") or descending |
+ | | ("desc")
|
+
+-----------+------------------------------------------------------------------------------------+
+ | limit | Choose the maximum number of results to return
|
+
+-----------+------------------------------------------------------------------------------------+
+ | offset | The number of results to skip before beginning to return
results. Must use in |
+ | | conjunction with limit
|
+
+-----------+------------------------------------------------------------------------------------+
.. code-block:: http
:caption: Request Example
diff --git a/docs/source/api/users.rst b/docs/source/api/users.rst
index 9445f70..8538942 100644
--- a/docs/source/api/users.rst
+++ b/docs/source/api/users.rst
@@ -31,15 +31,25 @@ Request Structure
-----------------
.. table:: Request Query Parameters
-
+----------+----------+------------------------------------------------------------------------------------------+
- | Name | Required | Description
|
-
+==========+==========+==========================================================================================+
- | id | no | Return only the user identified by this
integral, unique identifier |
-
+----------+----------+------------------------------------------------------------------------------------------+
- | tenant | no | Return only users belonging to the tenant
identified by this integral, unique identifier |
-
+----------+----------+------------------------------------------------------------------------------------------+
- | username | no | Return only the user with this username
|
-
+----------+----------+------------------------------------------------------------------------------------------+
+
+-----------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description
|
+
+===========+==========+==========================================================================================+
+ | id | no | Return only the user identified by this
integral, unique identifier |
+
+-----------+----------+------------------------------------------------------------------------------------------+
+ | tenant | no | Return only users belonging to the tenant
identified by this integral, unique identifier |
+
+-----------+----------+------------------------------------------------------------------------------------------+
+ | username | no | Return only the user with this username
|
+
+-----------+----------+------------------------------------------------------------------------------------------+
+ | orderby | no | Choose the ordering of the results - must be
the name of one of the fields of the |
+ | | | objects in the ``response`` array
|
+
+-----------+----------+------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either ascending
(default or "asc") or descending ("desc") |
+
+-----------+----------+------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to return
|
+
+-----------+----------+------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before beginning
to return results. Must use in |
+ | | | conjunction with limit
|
+
+-----------+----------+------------------------------------------------------------------------------------------+
.. versionadded:: 1.4
The ``id`` and ``username`` query parameters were added in the 1.4 API.
