You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by gi...@apache.org on 2018/04/18 21:28:10 UTC
[2/2] incubator-trafficcontrol-website git commit: Update docs from
commit 9acaac39d09ec7667e2fac5446aa664ea421a929
Update docs from commit 9acaac39d09ec7667e2fac5446aa664ea421a929
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/commit/384dcfdd
Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/tree/384dcfdd
Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/diff/384dcfdd
Branch: refs/heads/asf-site
Commit: 384dcfdd7086a280fdb3516c8041d24726873362
Parents: 10551f9
Author: jenkins <bu...@apache.org>
Authored: Wed Apr 18 21:28:05 2018 +0000
Committer: jenkins <bu...@apache.org>
Committed: Wed Apr 18 21:28:05 2018 +0000
----------------------------------------------------------------------
.../traffic_ops_api/v12/configfiles_ats.rst.txt | 13 +-
docs/master/development/traffic_ops.html | 5 +-
.../traffic_ops_api/v12/configfiles_ats.html | 132 ++++++++++++-------
docs/master/objects.inv | Bin 4962 -> 4975 bytes
docs/master/searchindex.js | 2 +-
5 files changed, 90 insertions(+), 62 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/384dcfdd/docs/master/_sources/development/traffic_ops_api/v12/configfiles_ats.rst.txt
----------------------------------------------------------------------
diff --git a/docs/master/_sources/development/traffic_ops_api/v12/configfiles_ats.rst.txt b/docs/master/_sources/development/traffic_ops_api/v12/configfiles_ats.rst.txt
index 3bbaa4e..f2b051a 100644
--- a/docs/master/_sources/development/traffic_ops_api/v12/configfiles_ats.rst.txt
+++ b/docs/master/_sources/development/traffic_ops_api/v12/configfiles_ats.rst.txt
@@ -17,7 +17,7 @@
.. _to-api-v12-configfiles_ats:
Config Files and Config File Metadata
-===
+=====================================
.. _to-api-v12-configfiles_ats-route:
@@ -25,8 +25,6 @@ Config Files and Config File Metadata
++++++++++++++++++++++++++++++++++++++++++
**GET /api/1.2/servers/:hostname/configfiles/ats**
-**GET /api/1.2/servers/:host_id/configfiles/ats**
-
Authentication Required: Yes
@@ -36,8 +34,8 @@ Config Files and Config File Metadata
**Response Properties**
- +======================================================================================================+
- | Info Section |
+ +-------------------+--------+-------------------------------------------------------------------------+
+ | | | Info Section |
+-------------------+--------+-------------------------------------------------------------------------+
| Parameter | Type | Description |
+===================+========+=========================================================================+
@@ -60,11 +58,7 @@ Config Files and Config File Metadata
| ``cdnName`` | string | The name of the cache's assigned CDN. |
+-------------------+--------+-------------------------------------------------------------------------+
| ``serverTcpPort`` | int | The configured port of the server's used by ATS. |
- +======================================================================================================+
- | configFiles Section |
+-------------------+--------+-------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +===================+========+=========================================================================+
| ``fnameOnDisk`` | string | The filename of the configuration file as stored on the cache. |
+-------------------+--------+-------------------------------------------------------------------------+
| ``location`` | string | The directory location of the configuration file as stored on the cache.|
@@ -73,7 +67,6 @@ Config Files and Config File Metadata
+-------------------+--------+-------------------------------------------------------------------------+
| ``scope`` | string | The scope of the configuration file. |
+-------------------+--------+-------------------------------------------------------------------------+
-
**Response Example** ::
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/384dcfdd/docs/master/development/traffic_ops.html
----------------------------------------------------------------------
diff --git a/docs/master/development/traffic_ops.html b/docs/master/development/traffic_ops.html
index 3b0e833..e6d64b8 100644
--- a/docs/master/development/traffic_ops.html
+++ b/docs/master/development/traffic_ops.html
@@ -799,10 +799,7 @@ Extensions::YourCustomExtension</p>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/capability.html">Capabilities</a></li>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/cdn.html">CDN</a></li>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/changelog.html">Change Logs</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/configfiles_ats.html">/api/1.2/servers/:hostname/configfiles/ats</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/configfiles_ats.html#api-1-2-servers-hostname-configfiles-ats-configfile">/api/1.2/servers/:hostname/configfiles/ats/:configfile</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/configfiles_ats.html#api-1-2-profiles-profile-name-configfiles-ats-configfile">/api/1.2/profiles/:profile_name/configfiles/ats/:configfile</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/configfiles_ats.html#api-1-2-cdns-cdn-name-configfiles-ats-configfile">/api/1.2/cdns/:cdn_name/configfiles/ats/:configfile</a></li>
+<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/configfiles_ats.html">Config Files and Config File Metadata</a></li>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/deliveryservice.html">Delivery Service</a></li>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/deliveryservice_regex.html">Delivery Service Regexes</a></li>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/deliveryservice_stats.html">Delivery Service Statistics</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/384dcfdd/docs/master/development/traffic_ops_api/v12/configfiles_ats.html
----------------------------------------------------------------------
diff --git a/docs/master/development/traffic_ops_api/v12/configfiles_ats.html b/docs/master/development/traffic_ops_api/v12/configfiles_ats.html
index 4983905..2c26483 100644
--- a/docs/master/development/traffic_ops_api/v12/configfiles_ats.html
+++ b/docs/master/development/traffic_ops_api/v12/configfiles_ats.html
@@ -9,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>/api/1.2/servers/:hostname/configfiles/ats — Traffic Control 2.2-dev documentation </title>
+ <title>Config Files and Config File Metadata — Traffic Control 2.2-dev documentation </title>
@@ -177,7 +177,7 @@
<li><a href="../../traffic_ops.html">Traffic Ops</a> »</li>
- <li>/api/1.2/servers/:hostname/configfiles/ats</li>
+ <li>Config Files and Config File Metadata</li>
<li class="wy-breadcrumbs-aside">
<a href="../../../_sources/development/traffic_ops_api/v12/configfiles_ats.rst.txt" rel="nofollow"> View page source</a>
@@ -198,54 +198,91 @@
<div role="main" class="document">
- <p>Config Files and Config File Metadata
-===</p>
+ <div class="section" id="config-files-and-config-file-metadata">
+<span id="to-api-v12-configfiles-ats"></span><h1>Config Files and Config File Metadata<a class="headerlink" href="#config-files-and-config-file-metadata" title="Permalink to this headline">¶</a></h1>
<div class="section" id="api-1-2-servers-hostname-configfiles-ats">
-<span id="to-api-v12-configfiles-ats-route"></span><h1>/api/1.2/servers/:hostname/configfiles/ats<a class="headerlink" href="#api-1-2-servers-hostname-configfiles-ats" title="Permalink to this headline">¶</a></h1>
-<p><strong>GET /api/1.2/servers/:hostname/configfiles/ats</strong>
-<strong>GET /api/1.2/servers/:host_id/configfiles/ats</strong></p>
+<span id="to-api-v12-configfiles-ats-route"></span><h2>/api/1.2/servers/:hostname/configfiles/ats<a class="headerlink" href="#api-1-2-servers-hostname-configfiles-ats" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/servers/:hostname/configfiles/ats</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: Operator</p>
<p><strong>Request Query Parameters</strong></p>
<p><strong>Response Properties</strong></p>
-<p>+======================================================================================================+
-| Info Section |
-+——————-+——–+————————————————————————-+
-| Parameter | Type | Description |
-+===================+========+=========================================================================+
-| <code class="docutils literal notranslate"><span class="pre">profileId</span></code> | int | The ID of the profile assigned to the cache. |
-+——————-+——–+————————————————————————-+
-| <code class="docutils literal notranslate"><span class="pre">profileName</span></code> | string | The name of the profile assigned to the cache. |
-+——————-+——–+————————————————————————-+
-| <code class="docutils literal notranslate"><span class="pre">toRevProxyUrl</span></code> | string | The configured reverse proxy cache for configfile requests. |
-+——————-+——–+————————————————————————-+
-| <code class="docutils literal notranslate"><span class="pre">toURL</span></code> | string | The configured URL for Traffic Ops. |
-+——————-+——–+————————————————————————-+
-| <code class="docutils literal notranslate"><span class="pre">serverIpv4</span></code> | string | The configured IP address of the cache. |
-+——————-+——–+————————————————————————-+
-| <code class="docutils literal notranslate"><span class="pre">serverName</span></code> | string | The cache’s short form hostname. |
-+——————-+——–+————————————————————————-+
-| <code class="docutils literal notranslate"><span class="pre">serverId</span></code> | int | The cache’s Traffic Ops ID. |
-+——————-+——–+————————————————————————-+
-| <code class="docutils literal notranslate"><span class="pre">cdnId</span></code> | int | The ID of the cache’s assigned CDN. |
-+——————-+——–+————————————————————————-+
-| <code class="docutils literal notranslate"><span class="pre">cdnName</span></code> | string | The name of the cache’s assigned CDN. |
-+——————-+——–+————————————————————————-+
-| <code class="docutils literal notranslate"><span class="pre">serverTcpPort</span></code> | int | The configured port of the server’s used by ATS. |
-+======================================================================================================+
-| configFiles Section |
-+——————-+——–+————————————————————————-+
-| Parameter | Type | Description |
-+===================+========+=========================================================================+
-| <code class="docutils literal notranslate"><span class="pre">fnameOnDisk</span></code> | string | The filename of the configuration file as stored on the cache. |
-+——————-+——–+————————————————————————-+
-| <code class="docutils literal notranslate"><span class="pre">location</span></code> | string | The directory location of the configuration file as stored on the cache.|
-+——————-+——–+————————————————————————-+
-| <code class="docutils literal notranslate"><span class="pre">apiUri</span></code> | string | The path to generate the configuration file from Traffic Ops. |
-+——————-+——–+————————————————————————-+
-| <code class="docutils literal notranslate"><span class="pre">scope</span></code> | string | The scope of the configuration file. |
-+——————-+——–+————————————————————————-+</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="19%" />
+<col width="8%" />
+<col width="73%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head"> </th>
+<th class="head"> </th>
+<th class="head">Info Section</th>
+</tr>
+<tr class="row-even"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profileId</span></code></td>
+<td>int</td>
+<td>The ID of the profile assigned to the cache.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profileName</span></code></td>
+<td>string</td>
+<td>The name of the profile assigned to the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">toRevProxyUrl</span></code></td>
+<td>string</td>
+<td>The configured reverse proxy cache for configfile requests.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">toURL</span></code></td>
+<td>string</td>
+<td>The configured URL for Traffic Ops.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">serverIpv4</span></code></td>
+<td>string</td>
+<td>The configured IP address of the cache.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">serverName</span></code></td>
+<td>string</td>
+<td>The cache’s short form hostname.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">serverId</span></code></td>
+<td>int</td>
+<td>The cache’s Traffic Ops ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdnId</span></code></td>
+<td>int</td>
+<td>The ID of the cache’s assigned CDN.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>The name of the cache’s assigned CDN.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">serverTcpPort</span></code></td>
+<td>int</td>
+<td>The configured port of the server’s used by ATS.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">fnameOnDisk</span></code></td>
+<td>string</td>
+<td>The filename of the configuration file as stored on the cache.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">location</span></code></td>
+<td>string</td>
+<td>The directory location of the configuration file as stored on the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">apiUri</span></code></td>
+<td>string</td>
+<td>The path to generate the configuration file from Traffic Ops.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">scope</span></code></td>
+<td>string</td>
+<td>The scope of the configuration file.</td>
+</tr>
+</tbody>
+</table>
<p><strong>Response Example</strong></p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span class="p">{</span>
<span class="s2">"info"</span><span class="p">:</span> <span class="p">{</span>
@@ -285,7 +322,7 @@
</div></blockquote>
</div>
<div class="section" id="api-1-2-servers-hostname-configfiles-ats-configfile">
-<h1>/api/1.2/servers/:hostname/configfiles/ats/:configfile<a class="headerlink" href="#api-1-2-servers-hostname-configfiles-ats-configfile" title="Permalink to this headline">¶</a></h1>
+<h2>/api/1.2/servers/:hostname/configfiles/ats/:configfile<a class="headerlink" href="#api-1-2-servers-hostname-configfiles-ats-configfile" title="Permalink to this headline">¶</a></h2>
<p><strong>GET /api/1.2/servers/:hostname/configfiles/ats/:configfile</strong>
<strong>GET /api/1.2/servers/:host_id/configfiles/ats/:configfile</strong></p>
<blockquote>
@@ -308,7 +345,7 @@
</div></blockquote>
</div>
<div class="section" id="api-1-2-profiles-profile-name-configfiles-ats-configfile">
-<h1>/api/1.2/profiles/:profile_name/configfiles/ats/:configfile<a class="headerlink" href="#api-1-2-profiles-profile-name-configfiles-ats-configfile" title="Permalink to this headline">¶</a></h1>
+<h2>/api/1.2/profiles/:profile_name/configfiles/ats/:configfile<a class="headerlink" href="#api-1-2-profiles-profile-name-configfiles-ats-configfile" title="Permalink to this headline">¶</a></h2>
<p><strong>GET /api/1.2/profiles/:profile_name/configfiles/ats/:configfile</strong>
<strong>GET /api/1.2/profiles/:profile_id/configfiles/ats/:configfile</strong></p>
<blockquote>
@@ -331,7 +368,7 @@
</div></blockquote>
</div>
<div class="section" id="api-1-2-cdns-cdn-name-configfiles-ats-configfile">
-<h1>/api/1.2/cdns/:cdn_name/configfiles/ats/:configfile<a class="headerlink" href="#api-1-2-cdns-cdn-name-configfiles-ats-configfile" title="Permalink to this headline">¶</a></h1>
+<h2>/api/1.2/cdns/:cdn_name/configfiles/ats/:configfile<a class="headerlink" href="#api-1-2-cdns-cdn-name-configfiles-ats-configfile" title="Permalink to this headline">¶</a></h2>
<p><strong>GET /api/1.2/cdns/:cdn_name/configfiles/ats/:configfile</strong>
<strong>GET /api/1.2/cdns/:cdn_id/configfiles/ats/:configfile</strong></p>
<blockquote>
@@ -353,6 +390,7 @@
</div>
</div></blockquote>
</div>
+</div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/384dcfdd/docs/master/objects.inv
----------------------------------------------------------------------
diff --git a/docs/master/objects.inv b/docs/master/objects.inv
index a7a06c9..985b301 100644
Binary files a/docs/master/objects.inv and b/docs/master/objects.inv differ