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/05/17 02:35:05 UTC

[2/2] incubator-trafficcontrol-website git commit: Update docs from commit 3a5ccc5b6f19f1597f824d0b992e4ca9b004c9c4

Update docs from commit 3a5ccc5b6f19f1597f824d0b992e4ca9b004c9c4


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/9bef250f
Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/tree/9bef250f
Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/diff/9bef250f

Branch: refs/heads/asf-site
Commit: 9bef250f597585fcadfab43d18abfce14dce9259
Parents: 6546951
Author: jenkins <bu...@apache.org>
Authored: Thu May 17 02:35:01 2018 +0000
Committer: jenkins <bu...@apache.org>
Committed: Thu May 17 02:35:01 2018 +0000

----------------------------------------------------------------------
 .../_sources/api/v12/api_capability.rst.txt     | 26 +++++++++---------
 docs/master/api/v12/api_capability.html         | 29 ++++++++++----------
 docs/master/searchindex.js                      |  2 +-
 3 files changed, 28 insertions(+), 29 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/9bef250f/docs/master/_sources/api/v12/api_capability.rst.txt
----------------------------------------------------------------------
diff --git a/docs/master/_sources/api/v12/api_capability.rst.txt b/docs/master/_sources/api/v12/api_capability.rst.txt
index 794dd4f..618cd52 100644
--- a/docs/master/_sources/api/v12/api_capability.rst.txt
+++ b/docs/master/_sources/api/v12/api_capability.rst.txt
@@ -48,7 +48,7 @@ API-Capabilities
   +-------------------+--------+--------------------------------------------------+
   | ``httpMethod``    | enum   | One of: 'GET', 'POST', 'PUT', 'PATCH', 'DELETE'. |
   +-------------------+--------+--------------------------------------------------+
-  | ``route``         | string | API route.                                       |
+  | ``httpRoute``     | string | API route.                                       |
   +-------------------+--------+--------------------------------------------------+
   | ``capability``    | string | Capability name.                                 |
   +-------------------+--------+--------------------------------------------------+
@@ -62,14 +62,14 @@ API-Capabilities
            {
               "id": "6",
               "httpMethod": "GET",
-              "route": "/api/*/asns",
+              "httpRoute": "/api/*/asns",
               "capability": "asn-read",
               "lastUpdated": "2017-04-02 08:22:43"
            },
            {
               "id": "7",
               "httpMethod": "GET",
-              "route": "/api/*/asns/*",
+              "httpRoute": "/api/*/asns/*",
               "capability": "asn-read",
               "lastUpdated": "2017-04-02 08:22:43"
            }
@@ -103,7 +103,7 @@ API-Capabilities
   +-------------------+--------+--------------------------------------------------+
   | ``httpMethod``    | enum   | One of: 'GET', 'POST', 'PUT', 'PATCH', 'DELETE'. |
   +-------------------+--------+--------------------------------------------------+
-  | ``route``         | string | API route.                                       |
+  | ``httpRoute``     | string | API route.                                       |
   +-------------------+--------+--------------------------------------------------+
   | ``capability``    | string | Capability name.                                 |
   +-------------------+--------+--------------------------------------------------+
@@ -117,7 +117,7 @@ API-Capabilities
            {
               "id": "6",
               "httpMethod": "GET",
-              "route": "/api/*/asns",
+              "httpRoute": "/api/*/asns",
               "capability": "asn-read",
               "lastUpdated": "2017-04-02 08:22:43"
            }
@@ -141,7 +141,7 @@ API-Capabilities
   +================+==========+========+==================================================+
   | ``httpMethod`` | yes      | enum   | One of: 'GET', 'POST', 'PUT', 'PATCH', 'DELETE'. |
   +----------------+----------+--------+--------------------------------------------------+
-  | ``route``      | yes      | string | API route.                                       |
+  | ``httpRoute``  | yes      | string | API route.                                       |
   +----------------+----------+--------+--------------------------------------------------+
   | ``capability`` | yes      | string | Capability name                                  |
   +----------------+----------+--------+--------------------------------------------------+
@@ -150,7 +150,7 @@ API-Capabilities
 
     {
         "httpMethod": "POST",
-        "route": "/api/*/cdns",
+        "httpRoute": "/api/*/cdns",
         "capability": "cdn-write"
     }
 
@@ -165,7 +165,7 @@ API-Capabilities
   +--------------------+--------+--------------------------------------------------+
   | ``>httpMethod``    | enum   | One of: 'GET', 'POST', 'PUT', 'PATCH', 'DELETE'. |
   +--------------------+--------+--------------------------------------------------+
-  | ``>route``         | string | API route.                                       |
+  | ``>httpRoute``     | string | API route.                                       |
   +--------------------+--------+--------------------------------------------------+
   | ``>capability``    | string | Capability name                                  |
   +--------------------+--------+--------------------------------------------------+
@@ -185,7 +185,7 @@ API-Capabilities
         "response":{
               "id": "6",
               "httpMethod": "POST",
-              "route": "/api/*/cdns",
+              "httpRoute": "/api/*/cdns",
               "capability": "cdn-write",
               "lastUpdated": "2017-04-02 08:22:43"
         },
@@ -222,7 +222,7 @@ API-Capabilities
   +===================+========+==================================================+
   | ``httpMethod``    | enum   | One of: 'GET', 'POST', 'PUT', 'PATCH', 'DELETE'. |
   +-------------------+--------+--------------------------------------------------+
-  | ``route``         | string | API route.                                       |
+  | ``httpRoute``     | string | API route.                                       |
   +-------------------+--------+--------------------------------------------------+
   | ``capability``    | string | Capability name                                  |
   +-------------------+--------+--------------------------------------------------+
@@ -232,7 +232,7 @@ API-Capabilities
 
     {
         "httpMethod": "GET",
-        "route": "/api/*/cdns",
+        "httpRoute": "/api/*/cdns",
         "capability": "cdn-read"
     }
 
@@ -247,7 +247,7 @@ API-Capabilities
   +--------------------+--------+--------------------------------------------------+
   | ``>httpMethod``    | enum   | One of: 'GET', 'POST', 'PUT', 'PATCH', 'DELETE'. |
   +--------------------+--------+--------------------------------------------------+
-  | ``>route``         | string | API route.                                       |
+  | ``>httpRoute``     | string | API route.                                       |
   +--------------------+--------+--------------------------------------------------+
   | ``>capability``    | string | Capability name                                  |
   +--------------------+--------+--------------------------------------------------+
@@ -266,7 +266,7 @@ API-Capabilities
         "response":{
               "id": "6",
               "httpMethod": "GET",
-              "route": "/api/*/cdns",
+              "httpRoute": "/api/*/cdns",
               "capability": "cdn-read",
               "lastUpdated": "2017-04-02 08:22:43"
         },

http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/9bef250f/docs/master/api/v12/api_capability.html
----------------------------------------------------------------------
diff --git a/docs/master/api/v12/api_capability.html b/docs/master/api/v12/api_capability.html
index e538f30..801b2b6 100644
--- a/docs/master/api/v12/api_capability.html
+++ b/docs/master/api/v12/api_capability.html
@@ -100,7 +100,6 @@
 <li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_server.html">Traffic Server</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
 </ul>
 </li>
@@ -134,7 +133,6 @@
 <li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_server.html">Traffic Server</a></li>
 </ul>
 </li>
 </ul>
@@ -144,6 +142,7 @@
 <li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
 <li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
 </ul>
 </li>
 </ul>
@@ -260,7 +259,7 @@
 <td>enum</td>
 <td>One of: ‘GET’, ‘POST’, ‘PUT’, ‘PATCH’, ‘DELETE’.</td>
 </tr>
-<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">route</span></code></td>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">httpRoute</span></code></td>
 <td>string</td>
 <td>API route.</td>
 </tr>
@@ -280,14 +279,14 @@
        <span class="p">{</span>
           <span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;6&quot;</span><span class="p">,</span>
           <span class="s2">&quot;httpMethod&quot;</span><span class="p">:</span> <span class="s2">&quot;GET&quot;</span><span class="p">,</span>
-          <span class="s2">&quot;route&quot;</span><span class="p">:</span> <span class="s2">&quot;/api/*/asns&quot;</span><span class="p">,</span>
+          <span class="s2">&quot;httpRoute&quot;</span><span class="p">:</span> <span class="s2">&quot;/api/*/asns&quot;</span><span class="p">,</span>
           <span class="s2">&quot;capability&quot;</span><span class="p">:</span> <span class="s2">&quot;asn-read&quot;</span><span class="p">,</span>
           <span class="s2">&quot;lastUpdated&quot;</span><span class="p">:</span> <span class="s2">&quot;2017-04-02 08:22:43&quot;</span>
        <span class="p">},</span>
        <span class="p">{</span>
           <span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;7&quot;</span><span class="p">,</span>
           <span class="s2">&quot;httpMethod&quot;</span><span class="p">:</span> <span class="s2">&quot;GET&quot;</span><span class="p">,</span>
-          <span class="s2">&quot;route&quot;</span><span class="p">:</span> <span class="s2">&quot;/api/*/asns/*&quot;</span><span class="p">,</span>
+          <span class="s2">&quot;httpRoute&quot;</span><span class="p">:</span> <span class="s2">&quot;/api/*/asns/*&quot;</span><span class="p">,</span>
           <span class="s2">&quot;capability&quot;</span><span class="p">:</span> <span class="s2">&quot;asn-read&quot;</span><span class="p">,</span>
           <span class="s2">&quot;lastUpdated&quot;</span><span class="p">:</span> <span class="s2">&quot;2017-04-02 08:22:43&quot;</span>
        <span class="p">}</span>
@@ -349,7 +348,7 @@
 <td>enum</td>
 <td>One of: ‘GET’, ‘POST’, ‘PUT’, ‘PATCH’, ‘DELETE’.</td>
 </tr>
-<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">route</span></code></td>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">httpRoute</span></code></td>
 <td>string</td>
 <td>API route.</td>
 </tr>
@@ -369,7 +368,7 @@
        <span class="p">{</span>
           <span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;6&quot;</span><span class="p">,</span>
           <span class="s2">&quot;httpMethod&quot;</span><span class="p">:</span> <span class="s2">&quot;GET&quot;</span><span class="p">,</span>
-          <span class="s2">&quot;route&quot;</span><span class="p">:</span> <span class="s2">&quot;/api/*/asns&quot;</span><span class="p">,</span>
+          <span class="s2">&quot;httpRoute&quot;</span><span class="p">:</span> <span class="s2">&quot;/api/*/asns&quot;</span><span class="p">,</span>
           <span class="s2">&quot;capability&quot;</span><span class="p">:</span> <span class="s2">&quot;asn-read&quot;</span><span class="p">,</span>
           <span class="s2">&quot;lastUpdated&quot;</span><span class="p">:</span> <span class="s2">&quot;2017-04-02 08:22:43&quot;</span>
        <span class="p">}</span>
@@ -407,7 +406,7 @@
 <td>enum</td>
 <td>One of: ‘GET’, ‘POST’, ‘PUT’, ‘PATCH’, ‘DELETE’.</td>
 </tr>
-<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">route</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">httpRoute</span></code></td>
 <td>yes</td>
 <td>string</td>
 <td>API route.</td>
@@ -422,7 +421,7 @@
 <p><strong>Request Example</strong></p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span class="p">{</span>
     <span class="s2">&quot;httpMethod&quot;</span><span class="p">:</span> <span class="s2">&quot;POST&quot;</span><span class="p">,</span>
-    <span class="s2">&quot;route&quot;</span><span class="p">:</span> <span class="s2">&quot;/api/*/cdns&quot;</span><span class="p">,</span>
+    <span class="s2">&quot;httpRoute&quot;</span><span class="p">:</span> <span class="s2">&quot;/api/*/cdns&quot;</span><span class="p">,</span>
     <span class="s2">&quot;capability&quot;</span><span class="p">:</span> <span class="s2">&quot;cdn-write&quot;</span>
 <span class="p">}</span>
 </pre></div>
@@ -453,7 +452,7 @@
 <td>enum</td>
 <td>One of: ‘GET’, ‘POST’, ‘PUT’, ‘PATCH’, ‘DELETE’.</td>
 </tr>
-<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">&gt;route</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">&gt;httpRoute</span></code></td>
 <td>string</td>
 <td>API route.</td>
 </tr>
@@ -484,7 +483,7 @@
     <span class="s2">&quot;response&quot;</span><span class="p">:{</span>
           <span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;6&quot;</span><span class="p">,</span>
           <span class="s2">&quot;httpMethod&quot;</span><span class="p">:</span> <span class="s2">&quot;POST&quot;</span><span class="p">,</span>
-          <span class="s2">&quot;route&quot;</span><span class="p">:</span> <span class="s2">&quot;/api/*/cdns&quot;</span><span class="p">,</span>
+          <span class="s2">&quot;httpRoute&quot;</span><span class="p">:</span> <span class="s2">&quot;/api/*/cdns&quot;</span><span class="p">,</span>
           <span class="s2">&quot;capability&quot;</span><span class="p">:</span> <span class="s2">&quot;cdn-write&quot;</span><span class="p">,</span>
           <span class="s2">&quot;lastUpdated&quot;</span><span class="p">:</span> <span class="s2">&quot;2017-04-02 08:22:43&quot;</span>
     <span class="p">},</span>
@@ -547,7 +546,7 @@
 <td>enum</td>
 <td>One of: ‘GET’, ‘POST’, ‘PUT’, ‘PATCH’, ‘DELETE’.</td>
 </tr>
-<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">route</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">httpRoute</span></code></td>
 <td>string</td>
 <td>API route.</td>
 </tr>
@@ -560,7 +559,7 @@
 <p><strong>Request Example</strong></p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span class="p">{</span>
     <span class="s2">&quot;httpMethod&quot;</span><span class="p">:</span> <span class="s2">&quot;GET&quot;</span><span class="p">,</span>
-    <span class="s2">&quot;route&quot;</span><span class="p">:</span> <span class="s2">&quot;/api/*/cdns&quot;</span><span class="p">,</span>
+    <span class="s2">&quot;httpRoute&quot;</span><span class="p">:</span> <span class="s2">&quot;/api/*/cdns&quot;</span><span class="p">,</span>
     <span class="s2">&quot;capability&quot;</span><span class="p">:</span> <span class="s2">&quot;cdn-read&quot;</span>
 <span class="p">}</span>
 </pre></div>
@@ -591,7 +590,7 @@
 <td>enum</td>
 <td>One of: ‘GET’, ‘POST’, ‘PUT’, ‘PATCH’, ‘DELETE’.</td>
 </tr>
-<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">&gt;route</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">&gt;httpRoute</span></code></td>
 <td>string</td>
 <td>API route.</td>
 </tr>
@@ -622,7 +621,7 @@
     <span class="s2">&quot;response&quot;</span><span class="p">:{</span>
           <span class="s2">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;6&quot;</span><span class="p">,</span>
           <span class="s2">&quot;httpMethod&quot;</span><span class="p">:</span> <span class="s2">&quot;GET&quot;</span><span class="p">,</span>
-          <span class="s2">&quot;route&quot;</span><span class="p">:</span> <span class="s2">&quot;/api/*/cdns&quot;</span><span class="p">,</span>
+          <span class="s2">&quot;httpRoute&quot;</span><span class="p">:</span> <span class="s2">&quot;/api/*/cdns&quot;</span><span class="p">,</span>
           <span class="s2">&quot;capability&quot;</span><span class="p">:</span> <span class="s2">&quot;cdn-read&quot;</span><span class="p">,</span>
           <span class="s2">&quot;lastUpdated&quot;</span><span class="p">:</span> <span class="s2">&quot;2017-04-02 08:22:43&quot;</span>
     <span class="p">},</span>