ocket8888 commented on a change in pull request #3935: Rewrite POST servercheck
to GO
URL: https://github.com/apache/trafficcontrol/pull/3935#discussion_r328234506
##########
File path: docs/source/api/servercheck.rst
##########
@@ -18,20 +18,21 @@
***************
``servercheck``
***************
-.. caution:: This page is a stub! Much of it may be missing or just downright
wrong - it needs a lot of love from people with the domain knowledge required
to update it.
+
+Updates the resulting value from running a given check extension on a server.
``POST``
========
Post a server check result to the "serverchecks" table.
:Auth. Required: Yes
:Roles Required: None\ [1]_
-:Response Type: ``undefined``
+:Response Type: Object
Request Structure
-----------------
-:host_name: The hostname of the server to which this
"servercheck" refers
-:id: An integral, unique identifier for this "servercheck"
+:host_name: The hostname of the server to which this
"servercheck" refers. This is not required if id is defined.
+:id: The id of the server to which this "servercheck"
refers. This is not required if host_name is defined.
Review comment:
can you put "host_name" and "id" in double grave accents ('backticks':
<kbd>\`</kbd>)? I just think it makes it more clear that it's part of the
request payload, and not saying e.g. "This isn't required if the server has an
ID".
----------------------------------------------------------------
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
