ocket8888 commented on a change in pull request #4444: Document undocumented
Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384053763
##########
File path: docs/source/api/v2/asns.rst
##########
@@ -169,3 +169,132 @@ Response Structure
"lastUpdated": "2019-12-02 21:49:08+00"
}}
+``PUT``
+=======
+Updates an existing :abbr:`ASN (Autonomous System Number)`.
+
+:Auth. Required: Yes
+:Roles Required: "admin" or "operations"
+:Response Type: Object
+
+Request Structure
+-----------------
+
+--------------+----------+---------------------------------------------------------------------------------+
+ | Name | Required | Description
|
+
+==============+==========+=================================================================================+
+ | asn | Yes | The value of the new :abbr:`ASN (Autonomous
System Number)`. |
+
+--------------+----------+---------------------------------------------------------------------------------+
+ | cachegroup | Yes | A string that specifies the
:ref:`cache-group-name` of a :term:`Cache Group` to |
+ | | | which this :abbr:`ASN (Autonomous System
Number)` will be assigned. If you do |
+ | | | not pass this field, the cachegroup will be
``null``. For that reason, we list |
+ | | | it as required.
|
+
+--------------+----------+---------------------------------------------------------------------------------+
+ | cachegroupId | Yes | The integral, unique identifier of the
status of the cache group. |
Review comment:
You don't have to link it again (though that'd be great), but it should be
"Cache Group" not "cache group".
----------------------------------------------------------------
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
