You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@trafficcontrol.apache.org by GitBox <gi...@apache.org> on 2019/07/23 21:06:56 UTC
[GitHub] [trafficcontrol] alexluckerman commented on a change in pull
request #3740: Update docs for orderby, sortOrder,
limit & offset TO query params
alexluckerman commented on a change in pull request #3740: Update docs for orderby, sortOrder, limit & offset TO query params
URL: https://github.com/apache/trafficcontrol/pull/3740#discussion_r306533251
##########
File path: docs/source/api/asns.rst
##########
@@ -32,11 +32,20 @@ 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 descending ("desc") |
+ +------------+----------+-----------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the number of results to return |
Review comment:
Yes
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services