You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by ne...@apache.org on 2017/01/14 22:05:48 UTC
[58/75] incubator-trafficcontrol-website git commit: add master docs
to latest'
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52a20853/docs/latest/development/traffic_ops_api/v12/phys_location.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/phys_location.html b/docs/latest/development/traffic_ops_api/v12/phys_location.html
index bd4f778..b1c91b2 100644
--- a/docs/latest/development/traffic_ops_api/v12/phys_location.html
+++ b/docs/latest/development/traffic_ops_api/v12/phys_location.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Physical Location — Traffic Control 1.7 documentation </title>
+ <title>Physical Location — Traffic Control master documentation </title>
@@ -33,7 +33,7 @@
- <link rel="top" title="Traffic Control 1.7 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control master documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Profiles" href="profile.html"/>
<link rel="prev" title="Parameter" href="parameter.html"/>
@@ -58,7 +58,7 @@
- <img src="../../../_static/tc_logo.png" class="logo" />
+ <img src="../../../_static/tc_logo_c_only.png" class="logo" />
</a>
@@ -159,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.7</a> »</li>
+ <li><a href="../../../index.html">Traffic Control master</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -194,6 +194,26 @@
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="20%" />
+<col width="14%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">region</span></code></td>
+<td>no</td>
+<td>Filter by Region ID.</td>
+</tr>
+</tbody>
+</table>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
@@ -267,39 +287,39 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
- <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
- <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
- <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
- <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
- <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
- <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
- <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
+ <span class="s">"region"</span><span class="p">:</span> <span class="s">"Mile High"</span><span class="p">,</span>
+ <span class="s">"region"</span><span class="p">:</span> <span class="s">"4"</span><span class="p">,</span>
+ <span class="s">"poc"</span><span class="p">:</span> <span class="s">"Jane Doe"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-10-02 08:22:43"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"comments"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s">"state"</span><span class="p">:</span> <span class="s">"NM"</span><span class="p">,</span>
+ <span class="s">"email"</span><span class="p">:</span> <span class="s">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s">"city"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"zip"</span><span class="p">:</span> <span class="s">"87107"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
+ <span class="s">"address"</span><span class="p">:</span> <span class="s">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"Albuquerque"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
- <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
- <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
- <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
- <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
- <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
- <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
- <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
+ <span class="s">"region"</span><span class="p">:</span> <span class="s">"Mile High"</span><span class="p">,</span>
+ <span class="s">"region"</span><span class="p">:</span> <span class="s">"4"</span><span class="p">,</span>
+ <span class="s">"poc"</span><span class="p">:</span> <span class="s">"Jane Doe"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-10-02 08:22:43"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"comments"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s">"state"</span><span class="p">:</span> <span class="s">"NM"</span><span class="p">,</span>
+ <span class="s">"email"</span><span class="p">:</span> <span class="s">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s">"city"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"zip"</span><span class="p">:</span> <span class="s">"87107"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
+ <span class="s">"address"</span><span class="p">:</span> <span class="s">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"Albuquerque"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -334,13 +354,13 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Ashburn"</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Ashburn"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -447,23 +467,23 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
- <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
- <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
- <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
- <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
- <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
- <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
- <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
+ <span class="s">"region"</span><span class="p">:</span> <span class="s">"Mile High"</span><span class="p">,</span>
+ <span class="s">"region"</span><span class="p">:</span> <span class="s">"4"</span><span class="p">,</span>
+ <span class="s">"poc"</span><span class="p">:</span> <span class="s">"Jane Doe"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-10-02 08:22:43"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"comments"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s">"state"</span><span class="p">:</span> <span class="s">"NM"</span><span class="p">,</span>
+ <span class="s">"email"</span><span class="p">:</span> <span class="s">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s">"city"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"zip"</span><span class="p">:</span> <span class="s">"87107"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
+ <span class="s">"address"</span><span class="p">:</span> <span class="s">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"Albuquerque"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -559,18 +579,18 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"regionId"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
- <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doesssss"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
- <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
- <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
- <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
- <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 9rd St"</span><span class="p">,</span>
- <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
+<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"regionId"</span><span class="p">:</span> <span class="s">"1"</span><span class="p">,</span>
+ <span class="s">"poc"</span><span class="p">:</span> <span class="s">"Jane Doesssss"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"comments"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s">"state"</span><span class="p">:</span> <span class="s">"NM"</span><span class="p">,</span>
+ <span class="s">"email"</span><span class="p">:</span> <span class="s">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s">"city"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"zip"</span><span class="p">:</span> <span class="s">"87107"</span><span class="p">,</span>
+ <span class="s">"address"</span><span class="p">:</span> <span class="s">"123 East 9rd St"</span><span class="p">,</span>
+ <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"Albuquerque"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -653,29 +673,29 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
- <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Physical location update was successful."</span>
+ <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
+ <span class="s">"text"</span><span class="p">:</span> <span class="s">"Physical location update was successful."</span>
<span class="p">}</span>
<span class="p">],</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
- <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
- <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
- <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
- <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
- <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
- <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
- <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
+ <span class="s">"region"</span><span class="p">:</span> <span class="s">"Mile High"</span><span class="p">,</span>
+ <span class="s">"region"</span><span class="p">:</span> <span class="s">"4"</span><span class="p">,</span>
+ <span class="s">"poc"</span><span class="p">:</span> <span class="s">"Jane Doe"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-10-02 08:22:43"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"comments"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s">"state"</span><span class="p">:</span> <span class="s">"NM"</span><span class="p">,</span>
+ <span class="s">"email"</span><span class="p">:</span> <span class="s">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s">"city"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"zip"</span><span class="p">:</span> <span class="s">"87107"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
+ <span class="s">"address"</span><span class="p">:</span> <span class="s">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"Albuquerque"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -768,14 +788,14 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"name"</span> <span class="p">:</span> <span class="s2">"my physical location1"</span><span class="p">,</span>
- <span class="s2">"shortName"</span> <span class="p">:</span> <span class="s2">"myphylocation1"</span><span class="p">,</span>
- <span class="s2">"address"</span> <span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"city"</span> <span class="p">:</span> <span class="s2">"Shanghai"</span><span class="p">,</span>
- <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"SH"</span><span class="p">,</span>
- <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"200000"</span><span class="p">,</span>
- <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"this is physical location1"</span>
+<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"name"</span> <span class="p">:</span> <span class="s">"my physical location1"</span><span class="p">,</span>
+ <span class="s">"shortName"</span> <span class="p">:</span> <span class="s">"myphylocation1"</span><span class="p">,</span>
+ <span class="s">"address"</span> <span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"city"</span> <span class="p">:</span> <span class="s">"Shanghai"</span><span class="p">,</span>
+ <span class="s">"state"</span><span class="p">:</span> <span class="s">"SH"</span><span class="p">,</span>
+ <span class="s">"zip"</span><span class="p">:</span> <span class="s">"200000"</span><span class="p">,</span>
+ <span class="s">"comments"</span><span class="p">:</span> <span class="s">"this is physical location1"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -854,23 +874,23 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span> <span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s1">'shortName'</span><span class="p">:</span> <span class="s1">'myphylocati'</span><span class="p">,</span>
- <span class="s1">'regionName'</span><span class="p">:</span> <span class="s1">'myregion1'</span><span class="p">,</span>
- <span class="s1">'name'</span><span class="p">:</span> <span class="s1">'my physical location1'</span><span class="p">,</span>
- <span class="s1">'poc'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
- <span class="s1">'phone'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
- <span class="s1">'comments'</span><span class="p">:</span> <span class="s1">'this is physical location1'</span><span class="p">,</span>
- <span class="s1">'state'</span><span class="p">:</span> <span class="s1">'SH'</span><span class="p">,</span>
- <span class="s1">'email'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
- <span class="s1">'zip'</span><span class="p">:</span> <span class="s1">'20000'</span><span class="p">,</span>
- <span class="s1">'region_id'</span><span class="p">:</span> <span class="s1">'20'</span><span class="p">,</span>
- <span class="s1">'city'</span><span class="p">:</span> <span class="s1">'Shanghai'</span><span class="p">,</span>
- <span class="s1">'address'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
- <span class="s1">'id'</span><span class="p">:</span> <span class="s1">'200'</span>
- <span class="p">}</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre> {
+ "response": {
+ 'shortName': 'myphylocati',
+ 'regionName': 'myregion1',
+ 'name': 'my physical location1',
+ 'poc': '',
+ 'phone': '',
+ 'comments': 'this is physical location1',
+ 'state': 'SH',
+ 'email': '',
+ 'zip': '20000',
+ 'region_id': '20',
+ 'city': 'Shanghai',
+ 'address': '',
+ 'id': '200'
+ }
+}
</pre></div>
</div>
</div></blockquote>
@@ -918,7 +938,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.7',
+ VERSION:'master',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52a20853/docs/latest/development/traffic_ops_api/v12/profile.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/profile.html b/docs/latest/development/traffic_ops_api/v12/profile.html
index 9e7db37..5c5f435 100644
--- a/docs/latest/development/traffic_ops_api/v12/profile.html
+++ b/docs/latest/development/traffic_ops_api/v12/profile.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Profiles — Traffic Control 1.7 documentation </title>
+ <title>Profiles — Traffic Control master documentation </title>
@@ -33,7 +33,7 @@
- <link rel="top" title="Traffic Control 1.7 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control master documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Profile parameters" href="profile_parameter.html"/>
<link rel="prev" title="Physical Location" href="phys_location.html"/>
@@ -58,7 +58,7 @@
- <img src="../../../_static/tc_logo.png" class="logo" />
+ <img src="../../../_static/tc_logo_c_only.png" class="logo" />
</a>
@@ -159,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.7</a> »</li>
+ <li><a href="../../../index.html">Traffic Control master</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -249,13 +249,13 @@
</table>
</div></blockquote>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-10-08 19:34:45"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_TOP"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
- <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Content Router for top.foobar.net"</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-10-08 19:34:45"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR_TOP"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"8"</span><span class="p">,</span>
+ <span class="s">"description"</span><span class="p">:</span> <span class="s">"Content Router for top.foobar.net"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -292,10 +292,10 @@
</table>
</div></blockquote>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_TOP"</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR_TOP"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -364,13 +364,13 @@
</table>
</div></blockquote>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-10-08 19:34:45"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_TOP"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
- <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Content Router for top.foobar.net"</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-10-08 19:34:45"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR_TOP"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"8"</span><span class="p">,</span>
+ <span class="s">"description"</span><span class="p">:</span> <span class="s">"Content Router for top.foobar.net"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -414,9 +414,9 @@
</div></blockquote>
</div></blockquote>
<p><strong>Request Example</strong></p>
-<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_COPY"</span><span class="p">,</span>
- <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"CCR_COPY description"</span><span class="p">,</span>
+<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR_COPY"</span><span class="p">,</span>
+ <span class="s">"description"</span><span class="p">:</span> <span class="s">"CCR_COPY description"</span><span class="p">,</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -457,12 +457,12 @@
</table>
</div></blockquote>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"66"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_COPY"</span><span class="p">,</span>
- <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"CCR_COPY description"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"66"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR_COPY"</span><span class="p">,</span>
+ <span class="s">"description"</span><span class="p">:</span> <span class="s">"CCR_COPY description"</span><span class="p">,</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -542,14 +542,14 @@
</div></blockquote>
</div></blockquote>
<p><strong>Response Example</strong></p>
-<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"66"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_COPY"</span><span class="p">,</span>
- <span class="s2">"profileCopyFrom"</span><span class="p">:</span> <span class="s2">"CCR1"</span><span class="p">,</span>
- <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"CCR_COPY description"</span><span class="p">,</span>
- <span class="s2">"idCopyFrom"</span><span class="p">:</span> <span class="s2">"3"</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"66"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR_COPY"</span><span class="p">,</span>
+ <span class="s">"profileCopyFrom"</span><span class="p">:</span> <span class="s">"CCR1"</span><span class="p">,</span>
+ <span class="s">"description"</span><span class="p">:</span> <span class="s">"CCR_COPY description"</span><span class="p">,</span>
+ <span class="s">"idCopyFrom"</span><span class="p">:</span> <span class="s">"3"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -614,7 +614,7 @@
</div></blockquote>
</div></blockquote>
<p><strong>Request Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>{
+<div class="highlight-python"><div class="highlight"><pre>{
"name": "CCR_UPDATE",
"description": "CCR_UPDATE description"
}
@@ -643,19 +643,19 @@
</pre></div>
</div>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"219"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_UPDATE"</span><span class="p">,</span>
- <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"CCR_UPDATE description"</span>
- <span class="p">}</span>
- <span class="s2">"alerts"</span><span class="p">:[</span>
- <span class="p">{</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
- <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Profile was updated: 219"</span>
- <span class="p">}</span>
- <span class="p">]</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "response":{
+ "id": "219",
+ "name": "CCR_UPDATE",
+ "description": "CCR_UPDATE description"
+ }
+ "alerts":[
+ {
+ "level": "success",
+ "text": "Profile was updated: 219"
+ }
+ ]
+}
</pre></div>
</div>
</div></blockquote>
@@ -722,11 +722,11 @@
</table>
</div></blockquote>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
- <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Profile was deleted."</span>
+ <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
+ <span class="s">"text"</span><span class="p">:</span> <span class="s">"Profile was deleted."</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -777,7 +777,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.7',
+ VERSION:'master',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52a20853/docs/latest/development/traffic_ops_api/v12/profile_parameter.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/profile_parameter.html b/docs/latest/development/traffic_ops_api/v12/profile_parameter.html
index d22618c..e9d3a68 100644
--- a/docs/latest/development/traffic_ops_api/v12/profile_parameter.html
+++ b/docs/latest/development/traffic_ops_api/v12/profile_parameter.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Profile parameters — Traffic Control 1.7 documentation </title>
+ <title>Profile parameters — Traffic Control master documentation </title>
@@ -33,7 +33,7 @@
- <link rel="top" title="Traffic Control 1.7 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control master documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="InfluxDB" href="influxdb.html"/>
<link rel="prev" title="Profiles" href="profile.html"/>
@@ -58,7 +58,7 @@
- <img src="../../../_static/tc_logo.png" class="logo" />
+ <img src="../../../_static/tc_logo_c_only.png" class="logo" />
</a>
@@ -159,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.7</a> »</li>
+ <li><a href="../../../index.html">Traffic Control master</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -254,7 +254,7 @@ This accept two formats: single profile-parameter, profile-parameter array.</p>
</div></blockquote>
</div></blockquote>
<p><strong>Request Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>Single profile-parameter format:
+<div class="highlight-python"><div class="highlight"><pre>Single profile-parameter format:
{
"profileId": 2,
@@ -300,28 +300,28 @@ Profile-parameter array format:
</pre></div>
</div>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:[</span>
- <span class="p">{</span>
- <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
- <span class="s2">"parameterId"</span><span class="p">:</span> <span class="s2">"6"</span>
- <span class="p">},</span>
- <span class="p">{</span>
- <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
- <span class="s2">"parameterId"</span><span class="p">:</span> <span class="s2">"7"</span>
- <span class="p">},</span>
- <span class="p">{</span>
- <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
- <span class="s2">"parameterId"</span><span class="p">:</span> <span class="s2">"6"</span>
- <span class="p">}</span>
- <span class="p">]</span>
- <span class="s2">"alerts"</span><span class="p">:[</span>
- <span class="p">{</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
- <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Profile parameter associations were created."</span>
- <span class="p">}</span>
- <span class="p">]</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "response":[
+ {
+ "profileId": "2",
+ "parameterId": "6"
+ },
+ {
+ "profileId": "2",
+ "parameterId": "7"
+ },
+ {
+ "profileId": "3",
+ "parameterId": "6"
+ }
+ ]
+ "alerts":[
+ {
+ "level": "success",
+ "text": "Profile parameter associations were created."
+ }
+ ]
+}
</pre></div>
</div>
</div></blockquote>
@@ -394,11 +394,11 @@ Profile-parameter array format:
</div></blockquote>
</div></blockquote>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"alerts"</span><span class="p">:[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"alerts"</span><span class="p">:[</span>
<span class="p">{</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
- <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Profile parameter association was deleted."</span>
+ <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
+ <span class="s">"text"</span><span class="p">:</span> <span class="s">"Profile parameter association was deleted."</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -522,33 +522,33 @@ The request properties accept 2 formats, both single paramter and parameters arr
</table>
</div></blockquote>
<p><strong>Request Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mf">1.</span> <span class="n">single</span> <span class="n">parameter</span> <span class="nb">format</span> <span class="n">exampe</span><span class="p">:</span>
-<span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span>
- <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span><span class="p">,</span>
- <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span>
- <span class="s2">"secure"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre>1. single parameter format exampe:
+{
+ "name":"param1",
+ "configFile":"configFile1",
+ "value":"value1",
+ "secure":0,
+}
-<span class="mf">2.</span> <span class="n">array</span> <span class="nb">format</span> <span class="n">example</span><span class="p">:</span>
-<span class="p">[</span>
- <span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span>
- <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span><span class="p">,</span>
- <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span>
- <span class="s2">"secure"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span>
- <span class="p">},</span>
- <span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param2"</span><span class="p">,</span>
- <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile2"</span><span class="p">,</span>
- <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value2"</span><span class="p">,</span>
- <span class="s2">"secure"</span><span class="p">:</span><span class="mi">1</span><span class="p">,</span>
- <span class="p">}</span>
-<span class="p">]</span>
+2. array format example:
+[
+ {
+ "name":"param1",
+ "configFile":"configFile1",
+ "value":"value1",
+ "secure":0,
+ },
+ {
+ "name":"param2",
+ "configFile":"configFile2",
+ "value":"value2",
+ "secure":1,
+ }
+]
</pre></div>
</div>
<p><strong>Response Properties</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>+------------------+---------+--------------------------------------------------------------------------------------+
+<div class="highlight-python"><div class="highlight"><pre>+------------------+---------+--------------------------------------------------------------------------------------+
| Name | Type | Description |
+==================+=========+======================================================================================+
| ``response`` | | Parameters associated with the profile. |
@@ -580,32 +580,32 @@ The request properties accept 2 formats, both single paramter and parameters arr
</pre></div>
</div>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:{</span>
- <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"CCR1"</span><span class="p">,</span>
- <span class="s2">"profileId"</span> <span class="p">:</span> <span class="s2">"12"</span><span class="p">,</span>
- <span class="s2">"parameters"</span><span class="p">:[</span>
- <span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span>
- <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span>
- <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span>
- <span class="s2">"secure"</span><span class="p">:</span><span class="s2">"0"</span><span class="p">,</span>
- <span class="p">},</span>
- <span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param2"</span><span class="p">,</span>
- <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile2"</span>
- <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value2"</span><span class="p">,</span>
- <span class="s2">"secure"</span><span class="p">:</span><span class="s2">"1"</span><span class="p">,</span>
- <span class="p">}</span>
- <span class="p">]</span>
- <span class="p">}</span>
- <span class="s2">"alerts"</span><span class="p">:[</span>
- <span class="p">{</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
- <span class="s2">"text"</span><span class="p">:</span> <span class="s2">""</span><span class="n">Assign</span> <span class="n">parameters</span> <span class="n">successfully</span> <span class="n">to</span> <span class="n">profile</span> <span class="n">CCR1</span><span class="s2">"</span>
- <span class="p">}</span>
- <span class="p">]</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "response":{
+ "profileName": "CCR1",
+ "profileId" : "12",
+ "parameters":[
+ {
+ "name":"param1",
+ "configFile":"configFile1"
+ "value":"value1",
+ "secure":"0",
+ },
+ {
+ "name":"param2",
+ "configFile":"configFile2"
+ "value":"value2",
+ "secure":"1",
+ }
+ ]
+ }
+ "alerts":[
+ {
+ "level": "success",
+ "text": ""Assign parameters successfully to profile CCR1"
+ }
+ ]
+}
</pre></div>
</div>
</div></blockquote>
@@ -726,33 +726,33 @@ The request properties accept 2 formats, both single paramter and parameters arr
</table>
</div></blockquote>
<p><strong>Request Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mf">1.</span> <span class="n">single</span> <span class="n">parameter</span> <span class="nb">format</span> <span class="n">exampe</span><span class="p">:</span>
-<span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span>
- <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span><span class="p">,</span>
- <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span>
- <span class="s2">"secure"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre>1. single parameter format exampe:
+{
+ "name":"param1",
+ "configFile":"configFile1",
+ "value":"value1",
+ "secure":0,
+}
-<span class="mf">2.</span> <span class="n">array</span> <span class="nb">format</span> <span class="n">example</span><span class="p">:</span>
-<span class="p">[</span>
- <span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span>
- <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span><span class="p">,</span>
- <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span>
- <span class="s2">"secure"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span>
- <span class="p">},</span>
- <span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param2"</span><span class="p">,</span>
- <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile2"</span><span class="p">,</span>
- <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value2"</span><span class="p">,</span>
- <span class="s2">"secure"</span><span class="p">:</span><span class="mi">1</span><span class="p">,</span>
- <span class="p">}</span>
-<span class="p">]</span>
+2. array format example:
+[
+ {
+ "name":"param1",
+ "configFile":"configFile1",
+ "value":"value1",
+ "secure":0,
+ },
+ {
+ "name":"param2",
+ "configFile":"configFile2",
+ "value":"value2",
+ "secure":1,
+ }
+]
</pre></div>
</div>
<p><strong>Response Properties</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>+------------------+---------+--------------------------------------------------------------------------------------+
+<div class="highlight-python"><div class="highlight"><pre>+------------------+---------+--------------------------------------------------------------------------------------+
| Name | Type | Description |
+==================+=========+======================================================================================+
| ``response`` | | Parameters associated with the profile. |
@@ -784,32 +784,32 @@ The request properties accept 2 formats, both single paramter and parameters arr
</pre></div>
</div>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:{</span>
- <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"CCR1"</span><span class="p">,</span>
- <span class="s2">"profileId"</span> <span class="p">:</span> <span class="s2">"12"</span><span class="p">,</span>
- <span class="s2">"parameters"</span><span class="p">:[</span>
- <span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span>
- <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span>
- <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span>
- <span class="s2">"secure"</span><span class="p">:</span><span class="s2">"0"</span><span class="p">,</span>
- <span class="p">},</span>
- <span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param2"</span><span class="p">,</span>
- <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile2"</span>
- <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value2"</span><span class="p">,</span>
- <span class="s2">"secure"</span><span class="p">:</span><span class="s2">"1"</span><span class="p">,</span>
- <span class="p">}</span>
- <span class="p">]</span>
- <span class="p">}</span>
- <span class="s2">"alerts"</span><span class="p">:[</span>
- <span class="p">{</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
- <span class="s2">"text"</span><span class="p">:</span> <span class="s2">""</span><span class="n">Assign</span> <span class="n">parameters</span> <span class="n">successfully</span> <span class="n">to</span> <span class="n">profile</span> <span class="n">CCR1</span><span class="s2">"</span>
- <span class="p">}</span>
- <span class="p">]</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "response":{
+ "profileName": "CCR1",
+ "profileId" : "12",
+ "parameters":[
+ {
+ "name":"param1",
+ "configFile":"configFile1"
+ "value":"value1",
+ "secure":"0",
+ },
+ {
+ "name":"param2",
+ "configFile":"configFile2"
+ "value":"value2",
+ "secure":"1",
+ }
+ ]
+ }
+ "alerts":[
+ {
+ "level": "success",
+ "text": ""Assign parameters successfully to profile CCR1"
+ }
+ ]
+}
</pre></div>
</div>
</div></blockquote>
@@ -857,7 +857,7 @@ The request properties accept 2 formats, both single paramter and parameters arr
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.7',
+ VERSION:'master',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52a20853/docs/latest/development/traffic_ops_api/v12/region.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/region.html b/docs/latest/development/traffic_ops_api/v12/region.html
index b3b1570..c73f4ec 100644
--- a/docs/latest/development/traffic_ops_api/v12/region.html
+++ b/docs/latest/development/traffic_ops_api/v12/region.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Regions — Traffic Control 1.7 documentation </title>
+ <title>Regions — Traffic Control master documentation </title>
@@ -33,7 +33,7 @@
- <link rel="top" title="Traffic Control 1.7 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control master documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Roles" href="role.html"/>
<link rel="prev" title="InfluxDB" href="influxdb.html"/>
@@ -58,7 +58,7 @@
- <img src="../../../_static/tc_logo.png" class="logo" />
+ <img src="../../../_static/tc_logo_c_only.png" class="logo" />
</a>
@@ -159,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.7</a> »</li>
+ <li><a href="../../../index.html">Traffic Control master</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -194,6 +194,26 @@
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="14%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">division</span></code></td>
+<td>no</td>
+<td>Filter regions by Division ID.</td>
+</tr>
+</tbody>
+</table>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
@@ -227,19 +247,19 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Atlanta"</span><span class="p">,</span>
- <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
- <span class="s2">"divisionName"</span><span class="p">:</span> <span class="s2">"West"</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"6"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Atlanta"</span><span class="p">,</span>
+ <span class="s">"division"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
+ <span class="s">"divisionName"</span><span class="p">:</span> <span class="s">"West"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"7"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span>
- <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
- <span class="s2">"divisionName"</span><span class="p">:</span> <span class="s2">"West"</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"7"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Denver"</span><span class="p">,</span>
+ <span class="s">"division"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
+ <span class="s">"divisionName"</span><span class="p">:</span> <span class="s">"West"</span>
<span class="p">},</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -303,13 +323,13 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Atlanta"</span><span class="p">,</span>
- <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
- <span class="s2">"divisionName"</span><span class="p">:</span> <span class="s2">"West"</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"6"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Atlanta"</span><span class="p">,</span>
+ <span class="s">"division"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
+ <span class="s">"divisionName"</span><span class="p">:</span> <span class="s">"West"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -366,9 +386,9 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"myregion1"</span><span class="p">,</span>
- <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"4"</span>
+<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"myregion1"</span><span class="p">,</span>
+ <span class="s">"division"</span><span class="p">:</span> <span class="s">"4"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -415,19 +435,19 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
- <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Region update was successful."</span>
+ <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
+ <span class="s">"text"</span><span class="p">:</span> <span class="s">"Region update was successful."</span>
<span class="p">}</span>
<span class="p">],</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-03-18 08:57:39"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"myregion1"</span><span class="p">,</span>
- <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
- <span class="s2">"divisionName"</span><span class="p">:</span> <span class="s2">"mydivision1"</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"1"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-03-18 08:57:39"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"myregion1"</span><span class="p">,</span>
+ <span class="s">"division"</span><span class="p">:</span> <span class="s">"4"</span><span class="p">,</span>
+ <span class="s">"divisionName"</span><span class="p">:</span> <span class="s">"mydivision1"</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -483,8 +503,8 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"myregion1"</span><span class="p">,</span>
+<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"myregion1"</span><span class="p">,</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -527,12 +547,12 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s1">'divisionName'</span><span class="p">:</span> <span class="s1">'mydivision1'</span><span class="p">,</span>
- <span class="s1">'divsionId'</span><span class="p">:</span> <span class="s1">'4'</span><span class="p">,</span>
- <span class="s1">'name'</span><span class="p">:</span> <span class="s1">'myregion1'</span><span class="p">,</span>
- <span class="s1">'id'</span><span class="p">:</span> <span class="s1">'19'</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">'divisionName'</span><span class="p">:</span> <span class="s">'mydivision1'</span><span class="p">,</span>
+ <span class="s">'divsionId'</span><span class="p">:</span> <span class="s">'4'</span><span class="p">,</span>
+ <span class="s">'name'</span><span class="p">:</span> <span class="s">'myregion1'</span><span class="p">,</span>
+ <span class="s">'id'</span><span class="p">:</span> <span class="s">'19'</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -582,7 +602,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.7',
+ VERSION:'master',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52a20853/docs/latest/development/traffic_ops_api/v12/role.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/role.html b/docs/latest/development/traffic_ops_api/v12/role.html
index 8cfd265..33dc57c 100644
--- a/docs/latest/development/traffic_ops_api/v12/role.html
+++ b/docs/latest/development/traffic_ops_api/v12/role.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Roles — Traffic Control 1.7 documentation </title>
+ <title>Roles — Traffic Control master documentation </title>
@@ -33,7 +33,7 @@
- <link rel="top" title="Traffic Control 1.7 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control master documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Server" href="server.html"/>
<link rel="prev" title="Regions" href="region.html"/>
@@ -58,7 +58,7 @@
- <img src="../../../_static/tc_logo.png" class="logo" />
+ <img src="../../../_static/tc_logo_c_only.png" class="logo" />
</a>
@@ -159,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.7</a> »</li>
+ <li><a href="../../../index.html">Traffic Control master</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -227,13 +227,13 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"read-only"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
- <span class="s2">"privLevel"</span><span class="p">:</span> <span class="s2">"10"</span><span class="p">,</span>
- <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"read-only user"</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"read-only"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
+ <span class="s">"privLevel"</span><span class="p">:</span> <span class="s">"10"</span><span class="p">,</span>
+ <span class="s">"description"</span><span class="p">:</span> <span class="s">"read-only user"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -284,7 +284,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.7',
+ VERSION:'master',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true