ocket8888 commented on a change in pull request #4629: API Documentation for deliveryservice_requests URL: https://github.com/apache/trafficcontrol/pull/4629#discussion_r406872020
########## File path: docs/source/api/v1/deliveryservice_requests.rst ########## @@ -0,0 +1,972 @@ +.. +.. +.. Licensed under the Apache License, Version 2.0 (the "License"); +.. you may not use this file except in compliance with the License. +.. You may obtain a copy of the License at +.. +.. http://www.apache.org/licenses/LICENSE-2.0 +.. +.. Unless required by applicable law or agreed to in writing, software +.. distributed under the License is distributed on an "AS IS" BASIS, +.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +.. See the License for the specific language governing permissions and +.. limitations under the License. +.. + +.. _to-api-v1-deliveryservice_requests: + +**************************** +``deliveryservice_requests`` +**************************** + +``GET`` +======= +Retrieves :ref:`ds_requests` + +:Auth. Required: Yes +:Roles Required: None\ [#tenancy]_ +:Response Type: Array + +Request Structure +----------------- +.. table:: Request Query Parameters + + +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Required | Description | + +=============+==========+======================================================================================================================================+ + | assignee | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this text-based, unique identifier | + +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+ + | assigneeId | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this integral, unique identifier | + +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+ + | author | no | Show only the :ref:`ds_requests` created by this author identified by this text-based, unique identifier | + +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+ + | authorId | no | Show only the :ref:`ds_requests` created by this author identified by this integral, unique identifier | + +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+ + | changeType | no | Return only the :ref:`ds_requests` that have this changeType identified by this text-based, unique identifier | + +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+ + | id | no | Show only the :ref:`ds_requests` that has this integral, unique identifier | + +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+ + | status | no | Return only :ref:`ds_requests` that have this status identified by this text-based, unique identifier | + +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+ + | xmlId | no | Return only :ref:`ds_requests` that have this xmlId identified by 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 | + +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+ + | 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 | + +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+ + | page | no | Return the n\ :sup:`th` page of results, where "n" is the value of this parameter, pages are ``limit`` long and the first page is 1. | + | | | If ``offset`` was defined, this query parameter has no effect. ``limit`` must be defined to make use of ``page``. | + +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+ + +Response Structure +------------------ +:assigneeId: The integral, unique identifier of the assignee of this :ref:`ds_requests` +:assignee: Name of the assignee to which the :ref:`ds_requests` is assigned to +:authorId: The integral, unique identifier of the author of this :ref:`ds_requests` +:author: Name of the author who created this :ref:`ds_requests` +:changeType: The type of change made to the delivery service as described in this :ref:`ds_requests` +:createdAt: The date and time at which this :ref:`ds_requests` was created, in :rfc:`3339` format +:id: An integral, unique identifier for this :ref:`ds_requests` +:lastEditedBy: Name of the previous user to edit this :ref:`ds_requests` Review comment: Username or full name? ---------------------------------------------------------------- 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: [email protected] With regards, Apache Git Services
