ocket8888 commented on code in PR #7023:
URL: https://github.com/apache/trafficcontrol/pull/7023#discussion_r954347586
##########
docs/source/api/v4/servers.rst:
##########
@@ -159,6 +164,8 @@ Response Structure
:updPending: A boolean value which, if ``true``, indicates that the server has
updates of some kind pending, typically to be acted upon by Traffic Control
Cache Config (:term:`t3c`, formerly ORT)
:xmppId: A system-generated UUID used to generate a server hashId for use
in Traffic Router's consistent hashing algorithm. This value is set when a
server is created and cannot be changed afterwards.
:xmppPasswd: The password used in XMPP communications with the server
+:asns: The :abbr:`ASN (Autonomous System Number)` associated with the
cachegroups of the current server.
+ .. versionadded:: 4.1
Review Comment:
Indentation isn't sufficient to put this "under" the field list item. Right
now, it's rendering as the literal text ".. versionadded:: 4.1". So in HTML:
```html
<dd class="field-even"><p>The <abbr title="Autonomous System
Number">ASN</abbr> associated with the cachegroups of the current server.
.. versionadded:: 4.1</p>
</dd>
```
To get it to render properly, add a blank line between the directive and the
field with which it's associated.
##########
docs/source/api/v4/servers.rst:
##########
@@ -69,6 +69,11 @@ Request Structure
| | | the first page is 1. If ``offset`` was
defined, this query parameter has no effect. ``limit`` must be defined to |
| | | make use of ``page``.
|
+----------------+----------+-------------------------------------------------------------------------------------------------------------------+
+ | asn | no | Return only the servers that have a
cachegroup matching the provided ASN. |
+ | | |
|
+ | | |.. versionadded:: 4.1
|
Review Comment:
I was expecting this to result in a malformed table, but the GHA would show
a warning somewhere if that was true, so I was thrown for a bit of a loop.
I'm not sure why, but the table isn't malformed. Instead, this is causing
the above text ("Return only the servers that have a cachegroup matching the
provided ASN.") to be rendered as a block quote.
The `.. versionadded:: 4.1` directive needs a space between it and the `|`.
Again, idk why that's causing this specific issue, but I confirmed that adding
the space does indeed fix it.
##########
docs/source/api/v4/servers.rst:
##########
@@ -159,6 +164,8 @@ Response Structure
:updPending: A boolean value which, if ``true``, indicates that the server has
updates of some kind pending, typically to be acted upon by Traffic Control
Cache Config (:term:`t3c`, formerly ORT)
:xmppId: A system-generated UUID used to generate a server hashId for use
in Traffic Router's consistent hashing algorithm. This value is set when a
server is created and cannot be changed afterwards.
:xmppPasswd: The password used in XMPP communications with the server
+:asns: The :abbr:`ASN (Autonomous System Number)` associated with the
cachegroups of the current server.
Review Comment:
All of the other fields are in alphabetical order. This should be at the top
of the list.
--
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.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
