This is an automated email from the ASF dual-hosted git repository.
mitchell852 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 1df853c Added missing xmlId parameter to the docs (#4578)
1df853c is described below
commit 1df853c8869f4e574b4c00c3db4df7f175ee5fae
Author: Eric Holguin <[email protected]>
AuthorDate: Mon Apr 6 08:32:44 2020 -0600
Added missing xmlId parameter to the docs (#4578)
* added missing xmlId parameter to the docs
* Corrected parameter description
Co-authored-by: eholgu401 <[email protected]>
---
docs/source/api/v1/deliveryservices.rst | 2 ++
docs/source/api/v2/deliveryservices.rst | 2 ++
2 files changed, 4 insertions(+)
diff --git a/docs/source/api/v1/deliveryservices.rst
b/docs/source/api/v1/deliveryservices.rst
index f095e0d..fdafde1 100644
--- a/docs/source/api/v1/deliveryservices.rst
+++ b/docs/source/api/v1/deliveryservices.rst
@@ -46,6 +46,8 @@ Request Structure
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
| type | no | Return only :term:`Delivery Services` of the
:term:`Delivery Service` :ref:`ds-types` identified by this integral, unique
identifier |
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | xmlId | no | Show only the :term:`Delivery Service` that
has this text-based, 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
|
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
diff --git a/docs/source/api/v2/deliveryservices.rst
b/docs/source/api/v2/deliveryservices.rst
index b5e4f77..7fdde7b 100644
--- a/docs/source/api/v2/deliveryservices.rst
+++ b/docs/source/api/v2/deliveryservices.rst
@@ -48,6 +48,8 @@ Request Structure
+--------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------+
| accessibleTo | no | Return the :term:`Delivery Services`
accessible from a :term:`Tenant` *or it's children* identified by this
integral, unique identifier |
+--------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | xmlId | no | Show only the :term:`Delivery Service` that
has this text-based, 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
|
+--------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------+
