You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@trafficcontrol.apache.org by GitBox <gi...@apache.org> on 2020/01/30 17:24:14 UTC
[GitHub] [trafficcontrol] mhoppa commented on a change in pull request
#4353: Deprecate /cdns/configs
mhoppa commented on a change in pull request #4353: Deprecate /cdns/configs
URL: https://github.com/apache/trafficcontrol/pull/4353#discussion_r373086195
##########
File path: docs/source/api/cdns_configs.rst
##########
@@ -34,9 +35,37 @@ No parameters available.
Response Properties
-------------------
-:config_file: Presumably the name of some configuration file\ [1]_
:id: The integral, unique identifier for this CDN
:name: The CDN's name
-:value: Presumably the content of some configuration file\ [1]_
-.. [1] These values are currently missing from this endpoint's output. **DO NOT count on this endpoint to provide this information**.
+.. code-block:: http
+ :caption: Response Example
+
+ HTTP/1.1 200 OK
+ Access-Control-Allow-Credentials: true
+ Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
+ Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
+ Access-Control-Allow-Origin: *
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: z9P1NkxGebPncUhaChDHtYKYI+XVZfhE6Y84TuwoASZFIMfISELwADLpvpPTN+wwnzBfREksLYn+0313QoBWhA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Wed, 14 Nov 2018 20:46:57 GMT
+ Content-Length: 237
+
+ { "response": [
+ {
+ "id": 1,
+ "name": "ALL"
+ },
+ {
+ "id": 2,
+ "name": "CDN-in-a-Box"
+ }
+ ],
+ "alerts": [
+ {
+ "text": "This endpoint is deprecated, please use GET /cdns instead",
+ "level": "warning"
+ }
+ ]}
Review comment:
man manual formatting documentation for API at this level is so incredibly painful, will fix.
----------------------------------------------------------------
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