You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by da...@apache.org on 2017/06/20 15:07:09 UTC
[02/11] incubator-trafficcontrol git commit: fix sphinx errors
fix sphinx errors
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/commit/5a67db37
Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/tree/5a67db37
Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/diff/5a67db37
Branch: refs/heads/master
Commit: 5a67db3786c4dc51a048e35fcb83205d1494b0ac
Parents: 6766ecf
Author: Derek Gelinas <de...@cable.comcast.com>
Authored: Fri May 12 12:31:16 2017 -0400
Committer: Dan Kirkwood <da...@gmail.com>
Committed: Tue Jun 20 09:06:44 2017 -0600
----------------------------------------------------------------------
.../traffic_ops_api/v12/configfiles_ats.rst | 136 +++++++++----------
1 file changed, 64 insertions(+), 72 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/blob/5a67db37/docs/source/development/traffic_ops_api/v12/configfiles_ats.rst
----------------------------------------------------------------------
diff --git a/docs/source/development/traffic_ops_api/v12/configfiles_ats.rst b/docs/source/development/traffic_ops_api/v12/configfiles_ats.rst
index c8cc7aa..3bbaa4e 100644
--- a/docs/source/development/traffic_ops_api/v12/configfiles_ats.rst
+++ b/docs/source/development/traffic_ops_api/v12/configfiles_ats.rst
@@ -22,7 +22,7 @@ Config Files and Config File Metadata
.. _to-api-v12-configfiles_ats-route:
/api/1.2/servers/:hostname/configfiles/ats
-+++++++++++++
+++++++++++++++++++++++++++++++++++++++++++
**GET /api/1.2/servers/:hostname/configfiles/ats**
**GET /api/1.2/servers/:host_id/configfiles/ats**
@@ -41,7 +41,7 @@ Config Files and Config File Metadata
+-------------------+--------+-------------------------------------------------------------------------+
| Parameter | Type | Description |
+===================+========+=========================================================================+
- | ``profileId`` | string | The ID of the profile assigned to the cache. |
+ | ``profileId`` | int | The ID of the profile assigned to the cache. |
+-------------------+--------+-------------------------------------------------------------------------+
| ``profileName`` | string | The name of the profile assigned to the cache. |
+-------------------+--------+-------------------------------------------------------------------------+
@@ -53,21 +53,13 @@ Config Files and Config File Metadata
+-------------------+--------+-------------------------------------------------------------------------+
| ``serverName`` | string | The cache's short form hostname. |
+-------------------+--------+-------------------------------------------------------------------------+
- | ``serverId`` | string | The cache's Traffic Ops ID. |
+ | ``serverId`` | int | The cache's Traffic Ops ID. |
+-------------------+--------+-------------------------------------------------------------------------+
- | ``cdnId`` | string | The ID of the cache's assigned CDN. |
+ | ``cdnId`` | int | The ID of the cache's assigned CDN. |
+-------------------+--------+-------------------------------------------------------------------------+
| ``cdnName`` | string | The name of the cache's assigned CDN. |
+-------------------+--------+-------------------------------------------------------------------------+
- | ``serverTcpPort`` | string | The configured port of the server's used by ATS. |
- +-------------------+--------+-------------------------------------------------------------------------+
- | ``serverTcpPort`` | string | The configured port of the server's used by ATS. |
- +-------------------+--------+-------------------------------------------------------------------------+
- | ``serverTcpPort`` | string | The configured port of the server's used by ATS. |
- +-------------------+--------+-------------------------------------------------------------------------+
- | ``serverTcpPort`` | string | The configured port of the server's used by ATS. |
- +-------------------+--------+-------------------------------------------------------------------------+
- | ``serverTcpPort`` | string | The configured port of the server's used by ATS. |
+ | ``serverTcpPort`` | int | The configured port of the server's used by ATS. |
+======================================================================================================+
| configFiles Section |
+-------------------+--------+-------------------------------------------------------------------------+
@@ -85,43 +77,43 @@ Config Files and Config File Metadata
**Response Example** ::
- {
- "info": {
- "profileId": 278,
- "toRevProxyUrl": "https://to.example.com:81",
- "toUrl": "https://to.example.com/",
- "serverIpv4": "192.168.1.5",
- "serverTcpPort": 80,
- "serverName": "cache-ats-01",
- "cdnId": 1,
- "cdnName": "CDN_1",
- "serverId": 21,
- "profileName": "EDGE_CDN_1_EXAMPLE"
- },
- "configFiles": [
- {
- "fnameOnDisk": "remap.config",
- "location": "/opt/trafficserver/etc/trafficserver",
- "apiUri": "/api/1.2/profiles/EDGE_CDN_1_EXAMPLE/configfiles/ats/remap.config",
- "scope": "profiles"
- },
- {
- "fnameOnDisk": "ssl_multicert.config",
- "location": "/opt/trafficserver/etc/trafficserver",
- "apiUri": "/api/1.2/cdns/CDN_1/configfiles/ats/ssl_multicert.config",
- "scope": "cdns"
+ {
+ "info": {
+ "profileId": 278,
+ "toRevProxyUrl": "https://to.example.com:81",
+ "toUrl": "https://to.example.com/",
+ "serverIpv4": "192.168.1.5",
+ "serverTcpPort": 80,
+ "serverName": "cache-ats-01",
+ "cdnId": 1,
+ "cdnName": "CDN_1",
+ "serverId": 21,
+ "profileName": "EDGE_CDN_1_EXAMPLE"
},
- {
- "fnameOnDisk": "parent.config",
- "location": "/opt/trafficserver/etc/trafficserver",
- "apiUri": "/api/1.2/servers/cache-ats-01/configfiles/ats/parent.config"
- }
- ]
- }
+ "configFiles": [
+ {
+ "fnameOnDisk": "remap.config",
+ "location": "/opt/trafficserver/etc/trafficserver",
+ "apiUri": "/api/1.2/profiles/EDGE_CDN_1_EXAMPLE/configfiles/ats/remap.config",
+ "scope": "profiles"
+ },
+ {
+ "fnameOnDisk": "ssl_multicert.config",
+ "location": "/opt/trafficserver/etc/trafficserver",
+ "apiUri": "/api/1.2/cdns/CDN_1/configfiles/ats/ssl_multicert.config",
+ "scope": "cdns"
+ },
+ {
+ "fnameOnDisk": "parent.config",
+ "location": "/opt/trafficserver/etc/trafficserver",
+ "apiUri": "/api/1.2/servers/cache-ats-01/configfiles/ats/parent.config"
+ }
+ ]
+ }
/api/1.2/servers/:hostname/configfiles/ats/:configfile
-+++++++++++++
+++++++++++++++++++++++++++++++++++++++++++++++++++++++
**GET /api/1.2/servers/:hostname/configfiles/ats/:configfile**
**GET /api/1.2/servers/:host_id/configfiles/ats/:configfile**
@@ -139,18 +131,18 @@ Config Files and Config File Metadata
**Response Example** ::
- {
- "alerts": [
- {
- "level": "error",
- "text": "Error - incorrect file scope for route used. Please use the profiles route."
- }
- ]
- }
+ {
+ "alerts": [
+ {
+ "level": "error",
+ "text": "Error - incorrect file scope for route used. Please use the profiles route."
+ }
+ ]
+ }
/api/1.2/profiles/:profile_name/configfiles/ats/:configfile
-+++++++++++++
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
**GET /api/1.2/profiles/:profile_name/configfiles/ats/:configfile**
**GET /api/1.2/profiles/:profile_id/configfiles/ats/:configfile**
@@ -168,18 +160,18 @@ Config Files and Config File Metadata
**Response Example** ::
- {
- "alerts": [
- {
- "level": "error",
- "text": "Error - incorrect file scope for route used. Please use the cdns route."
- }
- ]
- }
+ {
+ "alerts": [
+ {
+ "level": "error",
+ "text": "Error - incorrect file scope for route used. Please use the cdns route."
+ }
+ ]
+ }
/api/1.2/cdns/:cdn_name/configfiles/ats/:configfile
-+++++++++++++
++++++++++++++++++++++++++++++++++++++++++++++++++++
**GET /api/1.2/cdns/:cdn_name/configfiles/ats/:configfile**
**GET /api/1.2/cdns/:cdn_id/configfiles/ats/:configfile**
@@ -197,12 +189,12 @@ Config Files and Config File Metadata
**Response Example** ::
- {
- "alerts": [
- {
- "level": "error",
- "text": "Error - incorrect file scope for route used. Please use the servers route."
- }
- ]
- }
+ {
+ "alerts": [
+ {
+ "level": "error",
+ "text": "Error - incorrect file scope for route used. Please use the servers route."
+ }
+ ]
+ }