[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes

[GitBox <gi...@apache.org>]

zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r409158141
 
 

 ##########
 File path: docs/source/api/v2/deliveryservices_id_urlkeys.rst
 ##########
 @@ -0,0 +1,93 @@
+..
+..
+.. 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-deliveryservices-id-urlkeys:
+
+***********************************
+``deliveryservices/{{ID}}/urlkeys``
+***********************************
+
+``GET``
+=======
+.. seealso:: :ref:`to-api-deliveryservices-xmlid-xmlid-urlkeys`
+
+Retrieves URL signing keys for a :term:`Delivery Service`.
+
+.. caution:: This method will return the :term:`Delivery Service`'s **PRIVATE** URL signing keys! Be wary of using this endpoint and **NEVER** share the output with anyone who would be unable to see it on their own.
+
+:Auth. Required: Yes
+:Roles Required: None
+:Response Type:  Object
+
+Request Structure
+-----------------
+.. table:: Request Path Parameters
+
+	+------+----------------------------------------------------------------------------------------+
+	| Name | Description                                                                            |
+	+======+========================================================================================+
+	| id   | Filter for the :term:`Delivery Service` identified by this integral, unique identifier |
+	+------+----------------------------------------------------------------------------------------+
+
+.. code-block:: http
+	:caption: Request Example
+
+	GET /api/2.0/deliveryservices/1/urlkeys HTTP/1.1
+	User-Agent: python-requests/2.22.0
+	Accept-Encoding: gzip, deflate
+	Accept: */*
+	Connection: keep-alive
+	Cookie: mojolicious=...
+
+Response Structure
+------------------
+:key<N>: The private URL signing key for this :term:`Delivery Service` as a base-64-encoded string, where ``<N>`` is the "generation" of the key e.g. the first key will always be named ``"key0"``. Up to 16 concurrent generations are retained at any time (``<N>`` is always on the interval [0,16])
 
 Review comment:
   > Did you copy that from another endpoint? It looks familiar, so it might be wrong there, too.
   
   Yep, ripped straight from [deliveryservices_xmlid_xmlid_urlkeys.rst](https://github.com/apache/trafficcontrol/blob/93520432ec/docs/source/api/v2/deliveryservices_xmlid_xmlid_urlkeys.rst#response-structure).

----------------------------------------------------------------
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