ocket8888 commented on a change in pull request #3971: Add server_capabilities API docs URL: https://github.com/apache/trafficcontrol/pull/3971#discussion_r334590260
########## File path: docs/source/api/server_capabilities.rst ########## @@ -0,0 +1,190 @@ +.. +.. +.. 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-server_capabilities: + +*********************** +``server_capabilities`` +*********************** + +``GET`` +======= +Retrieves server capabilities. + +:Auth. Required: Yes +:Roles Required: "read-only" +:Response Type: Array + +Request Structure +----------------- +.. table:: Request Query Parameters + + +------------+----------+--------------------------------------------------------------------------------------------------------------------------------+ + | Name | Required | Description | + +============+==========+================================================================================================================================+ + | name | no | Return the server capability with this name | + +------------+----------+--------------------------------------------------------------------------------------------------------------------------------+ + +.. code-block:: http + :caption: Request Structure + + GET /api/1.4/server_capabilities?name=RAM HTTP/1.1 + Host: trafficops.infra.ciab.test + User-Agent: curl/7.47.0 + Accept: */* + Cookie: mojolicious=... + +Response Structure +------------------ +:name: The name of this server capability +:lastUpdated: The date and time at which this server capability was last updated, in ISO format Review comment: It's not actually compliant with ISO 8601, so I've been saying "ISO-like". ---------------------------------------------------------------- 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
