Update docs from commit ce3326291714a259a7e8d313dd25100786f01803
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/52f19784 Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/tree/52f19784 Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/diff/52f19784 Branch: refs/heads/asf-site Commit: 52f19784ebdedaa69042dbd9c0772da31d33ba8d Parents: efead5c Author: jenkins <bui...@apache.org> Authored: Thu May 3 20:16:08 2018 +0000 Committer: jenkins <bui...@apache.org> Committed: Thu May 3 20:16:08 2018 +0000 ---------------------------------------------------------------------- docs/master/_sources/api/index.rst.txt | 1 + docs/master/_sources/api/v13/coordinate.rst.txt | 272 +++++++ docs/master/_sources/api/v13/index.rst.txt | 24 + docs/master/api/index.html | 13 +- docs/master/api/v13/coordinate.html | 705 +++++++++++++++++++ docs/master/api/v13/index.html | 302 ++++++++ docs/master/genindex.html | 1 + docs/master/index.html | 5 + docs/master/objects.inv | Bin 4872 -> 4927 bytes docs/master/search.html | 1 + docs/master/searchindex.js | 2 +- 11 files changed, 1320 insertions(+), 6 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52f19784/docs/master/_sources/api/index.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/api/index.rst.txt b/docs/master/_sources/api/index.rst.txt index cd619bc..6cdf32e 100644 --- a/docs/master/_sources/api/index.rst.txt +++ b/docs/master/_sources/api/index.rst.txt @@ -24,4 +24,5 @@ A guide to external RESTful APIs for Traffic Ops routes v11/index v12/index + v13/index http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52f19784/docs/master/_sources/api/v13/coordinate.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/api/v13/coordinate.rst.txt b/docs/master/_sources/api/v13/coordinate.rst.txt new file mode 100644 index 0000000..5a18e50 --- /dev/null +++ b/docs/master/_sources/api/v13/coordinate.rst.txt @@ -0,0 +1,272 @@ +.. +.. +.. Licensed under the Apache License, Version 2.0 (the "License"); +.. you may not use this file except in compliance with the License. +.. You may obtain a copy of the License at +.. +.. http://www.apache.org/licenses/LICENSE-2.0 +.. +.. Unless required by applicable law or agreed to in writing, software +.. distributed under the License is distributed on an "AS IS" BASIS, +.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +.. See the License for the specific language governing permissions and +.. limitations under the License. +.. + +.. _to-api-v13-coordinate: + +Coordinate +========== + +.. _to-api-v13-coordinates-route: + +/api/1.3/coordinates +++++++++++++++++++++ + +**GET /api/1.3/coordinates** + + Authentication Required: Yes + + Role(s) Required: None + + **Request Query Parameters** + + +-----------------+----------+---------------------------------------------------+ + | Name | Required | Description | + +=================+==========+===================================================+ + | ``id`` | no | Filter Coordinates by ID. | + +-----------------+----------+---------------------------------------------------+ + | ``name`` | no | Filter Coordinates by name. | + +-----------------+----------+---------------------------------------------------+ + + **Response Properties** + + +-----------------------------------+--------+--------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===================================+========+==========================================================================+ + | ``id`` | int | Local unique identifier for the Coordinate | + +-----------------------------------+--------+--------------------------------------------------------------------------+ + | ``lastUpdated`` | string | The Time / Date this entry was last updated | + +-----------------------------------+--------+--------------------------------------------------------------------------+ + | ``latitude`` | float | Latitude of the Coordinate | + +-----------------------------------+--------+--------------------------------------------------------------------------+ + | ``longitude`` | float | Longitude of the Coordinate | + +-----------------------------------+--------+--------------------------------------------------------------------------+ + | ``name`` | string | The name of the Coordinate | + +-----------------------------------+--------+--------------------------------------------------------------------------+ + + **Response Example** :: + + { + "response": [ + { + "id": 21, + "lastUpdated": "2012-09-25 20:27:28", + "latitude": 0, + "longitude": 0, + "name": "dc-chicago" + }, + { + "id": 22, + "lastUpdated": "2012-09-25 20:27:28", + "latitude": 0, + "longitude": 0, + "name": "dc-chicago-1" + } + ] + } + +| + +**POST /api/1.3/coordinates** + + Create Coordinate. + + Authentication Required: Yes + + Role(s) Required: admin or oper + + **Request Parameters** + + +---------------------------------+----------+-------------------------------------------------------------------+ + | Name | Required | Description | + +=================================+==========+===================================================================+ + | ``name`` | yes | The name of the Coordinate entry | + +---------------------------------+----------+-------------------------------------------------------------------+ + | ``latitude`` | no | Latitude of the Coordinate | + +---------------------------------+----------+-------------------------------------------------------------------+ + | ``longitude`` | no | Longitude of the Coordinate | + +---------------------------------+----------+-------------------------------------------------------------------+ + + **Request Example** :: + + { + "name": "my_coordinate", + "latitude": 1.2, + "longitude": 4.5 + } + + **Response Properties** + + +------------------------------------+--------+-------------------------------------------------------------------+ + | Parameter | Type | Description | + +====================================+========+===================================================================+ + | ``id`` | int | The id of the Coordinate | + +------------------------------------+--------+-------------------------------------------------------------------+ + | ``name`` | string | The name of the Coordinate | + +------------------------------------+--------+-------------------------------------------------------------------+ + | ``latitude`` | float | Latitude of the Coordinate | + +------------------------------------+--------+-------------------------------------------------------------------+ + | ``longitude`` | float | Longitude of the Coordinate | + +------------------------------------+--------+-------------------------------------------------------------------+ + | ``lastUpdated`` | string | The Time / Date this entry was last updated | + +------------------------------------+--------+-------------------------------------------------------------------+ + | ``alerts`` | array | A collection of alert messages. | + +------------------------------------+--------+-------------------------------------------------------------------+ + | ``>level`` | string | Success, info, warning or error. | + +------------------------------------+--------+-------------------------------------------------------------------+ + | ``>text`` | string | Alert message. | + +------------------------------------+--------+-------------------------------------------------------------------+ + + **Response Example** :: + + { + "alerts": [ + { + "level": "success", + "text": "coordinate was created" + } + ], + "response": { + 'longitude' : 4.5, + 'lastUpdated' : '2016-01-25 13:55:30', + 'name' : 'my_coordinate', + 'latitude' : 1.2, + 'id' : 1 + } + } + +| + +**PUT /api/1.3/coordinates** + + Update coordinate. + + Authentication Required: Yes + + Role(s) Required: admin or oper + + **Request Query Parameters** + + +------+----------+------------------------------------+ + | Name | Required | Description | + +======+==========+====================================+ + | id | yes | The id of the coordinate to edit. | + +------+----------+------------------------------------+ + + **Request Parameters** + + +---------------------------------+----------+-------------------------------------------------------------------+ + | Name | Required | Description | + +=================================+==========+===================================================================+ + | ``id`` | yes | The id of the Coordinate | + +---------------------------------+----------+-------------------------------------------------------------------+ + | ``name`` | yes | The name of the Coordinate entry | + +---------------------------------+----------+-------------------------------------------------------------------+ + | ``latitude`` | no | Latitude of the Coordinate | + +---------------------------------+----------+-------------------------------------------------------------------+ + | ``longitude`` | no | Longitude of the Coordinate | + +---------------------------------+----------+-------------------------------------------------------------------+ + + **Request Example** :: + + { + "id": 1, + "name": "my_coordinate", + "latitude": 12, + "longitude": 45 + } + + **Response Properties** + + +------------------------------------+--------+-------------------------------------------------------------------+ + | Parameter | Type | Description | + +====================================+========+===================================================================+ + | ``id`` | int | The id of the Coordinate | + +------------------------------------+--------+-------------------------------------------------------------------+ + | ``name`` | string | The name of the Coordinate | + +------------------------------------+--------+-------------------------------------------------------------------+ + | ``latitude`` | float | Latitude of the Coordinate | + +------------------------------------+--------+-------------------------------------------------------------------+ + | ``longitude`` | float | Longitude of the Coordinate | + +------------------------------------+--------+-------------------------------------------------------------------+ + | ``lastUpdated`` | string | The Time / Date this entry was last updated | + +------------------------------------+--------+-------------------------------------------------------------------+ + | ``alerts`` | array | A collection of alert messages. | + +------------------------------------+--------+-------------------------------------------------------------------+ + | ``>level`` | string | Success, info, warning or error. | + +------------------------------------+--------+-------------------------------------------------------------------+ + | ``>text`` | string | Alert message. | + +------------------------------------+--------+-------------------------------------------------------------------+ + + **Response Example** :: + + { + "alerts": [ + { + "level": "success", + "text": "coordinate was updated" + } + ], + "response": { + 'longitude' : 45, + 'lastUpdated' : '2016-01-25 13:55:30', + 'name' : 'my_coordinate', + 'latitude' : 12, + 'id' : 1 + } + } + +| + +**DELETE /api/1.3/coordinates** + + Delete coordinate. + + Authentication Required: Yes + + Role(s) Required: admin or oper + + **Request Query Parameters** + + +------+----------+--------------------------------------+ + | Name | Required | Description | + +======+==========+======================================+ + | id | yes | The id of the coordinate to delete. | + +------+----------+--------------------------------------+ + + **Response Properties** + + +-------------+--------+----------------------------------+ + | Parameter | Type | Description | + +=============+========+==================================+ + | ``alerts`` | array | A collection of alert messages. | + +-------------+--------+----------------------------------+ + | ``>level`` | string | Success, info, warning or error. | + +-------------+--------+----------------------------------+ + | ``>text`` | string | Alert message. | + +-------------+--------+----------------------------------+ + + **Response Example** :: + + { + "alerts": [ + { + "level": "success", + "text": "coordinate was deleted" + } + ] + } + +| + http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52f19784/docs/master/_sources/api/v13/index.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/api/v13/index.rst.txt b/docs/master/_sources/api/v13/index.rst.txt new file mode 100644 index 0000000..4624560 --- /dev/null +++ b/docs/master/_sources/api/v13/index.rst.txt @@ -0,0 +1,24 @@ +.. +.. +.. Licensed under the Apache License, Version 2.0 (the "License"); +.. you may not use this file except in compliance with the License. +.. You may obtain a copy of the License at +.. +.. http://www.apache.org/licenses/LICENSE-2.0 +.. +.. Unless required by applicable law or agreed to in writing, software +.. distributed under the License is distributed on an "AS IS" BASIS, +.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +.. See the License for the specific language governing permissions and +.. limitations under the License. +.. + + +API 1.3 Reference +***************** +Traffic Ops API V1.3 + +.. toctree:: + :maxdepth: 1 + + coordinate http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52f19784/docs/master/api/index.html ---------------------------------------------------------------------- diff --git a/docs/master/api/index.html b/docs/master/api/index.html index d5f155e..8b93c64 100644 --- a/docs/master/api/index.html +++ b/docs/master/api/index.html @@ -40,7 +40,7 @@ <link rel="search" title="Search" href="../search.html"/> <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/> <link rel="next" title="API Overview" href="traffic_ops_api.html"/> - <link rel="prev" title="Traffic Server" href="../development/traffic_server.html"/> + <link rel="prev" title="Traffic Stats" href="../development/traffic_stats.html"/> <script src="_static/js/modernizr.min.js"></script> @@ -99,7 +99,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> @@ -133,7 +132,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> @@ -143,6 +141,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"><a class="reference internal" href="v12/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> @@ -195,7 +194,7 @@ <a href="traffic_ops_api.html" class="btn btn-neutral float-right" title="API Overview">Next <span class="fa fa-arrow-circle-right"></span></a> - <a href="../development/traffic_server.html" class="btn btn-neutral" title="Traffic Server"><span class="fa fa-arrow-circle-left"></span> Previous</a> + <a href="../development/traffic_stats.html" class="btn btn-neutral" title="Traffic Stats"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> @@ -276,6 +275,10 @@ <li class="toctree-l2"><a class="reference internal" href="v12/topology.html">Snapshot CRConfig</a></li> </ul> </li> +<li class="toctree-l1"><a class="reference internal" href="v13/index.html">API 1.3 Reference</a><ul> +<li class="toctree-l2"><a class="reference internal" href="v13/coordinate.html">Coordinate</a></li> +</ul> +</li> </ul> </div> </div> @@ -289,7 +292,7 @@ <a href="traffic_ops_api.html" class="btn btn-neutral float-right" title="API Overview">Next <span class="fa fa-arrow-circle-right"></span></a> - <a href="../development/traffic_server.html" class="btn btn-neutral" title="Traffic Server"><span class="fa fa-arrow-circle-left"></span> Previous</a> + <a href="../development/traffic_stats.html" class="btn btn-neutral" title="Traffic Stats"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52f19784/docs/master/api/v13/coordinate.html ---------------------------------------------------------------------- diff --git a/docs/master/api/v13/coordinate.html b/docs/master/api/v13/coordinate.html new file mode 100644 index 0000000..775932e --- /dev/null +++ b/docs/master/api/v13/coordinate.html @@ -0,0 +1,705 @@ + + + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Coordinate — Traffic Control 2.2-dev documentation </title> + + + + + <link rel="shortcut icon" href="../../_static/favicon.ico"/> + + + + + + + + + + + + + <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> + + + + <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" /> + + + + <link rel="index" title="Index" + href="../../genindex.html"/> + <link rel="search" title="Search" href="../../search.html"/> + <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/> + <link rel="up" title="API 1.3 Reference" href="index.html"/> + <link rel="next" title="FAQ" href="../../faq/index.html"/> + <link rel="prev" title="API 1.3 Reference" href="index.html"/> + + + <script src="_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + <div class="wy-grid-for-nav"> + + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-nav-search"> + + + + <a href="/" class="icon icon-home"> Traffic Control + + + + + <img src="../../_static/tc_logo_c_only.png" class="logo" /> + + </a> + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + <ul> +<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li> +<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_vault.html">Traffic Vault</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administratorâs Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developerâs Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li> +<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> +</ul> +</li> +</ul> +<ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li> +<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"><a class="reference internal" href="../v12/index.html">API 1.2 Reference</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.3 Reference</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li> +</ul> + + + + </div> + + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../index.html">Traffic Control</a> + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li> + + <li><a href="../index.html">APIs</a> »</li> + + <li><a href="index.html">API 1.3 Reference</a> »</li> + + <li>Coordinate</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../_sources/api/v13/coordinate.rst.txt" rel="nofollow"> View page source</a> + + </li> + </ul> + <hr/> +</div> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="../../faq/index.html" class="btn btn-neutral float-right" title="FAQ">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="index.html" class="btn btn-neutral" title="API 1.3 Reference"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="coordinate"> +<span id="to-api-v13-coordinate"></span><h1>Coordinate<a class="headerlink" href="#coordinate" title="Permalink to this headline">¶</a></h1> +<div class="section" id="api-1-3-coordinates"> +<span id="to-api-v13-coordinates-route"></span><h2>/api/1.3/coordinates<a class="headerlink" href="#api-1-3-coordinates" title="Permalink to this headline">¶</a></h2> +<p><strong>GET /api/1.3/coordinates</strong></p> +<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="22%" /> +<col width="13%" /> +<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 notranslate"><span class="pre">id</span></code></td> +<td>no</td> +<td>Filter Coordinates by ID.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td> +<td>no</td> +<td>Filter Coordinates by name.</td> +</tr> +</tbody> +</table> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="30%" /> +<col width="7%" /> +<col width="63%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td> +<td>int</td> +<td>Local unique identifier for the Coordinate</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td> +<td>string</td> +<td>The Time / Date this entry was last updated</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">latitude</span></code></td> +<td>float</td> +<td>Latitude of the Coordinate</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">longitude</span></code></td> +<td>float</td> +<td>Longitude of the Coordinate</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td> +<td>string</td> +<td>The name of the Coordinate</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">"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="mi">21</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-25 20:27:28"</span><span class="p">,</span> + <span class="s2">"latitude"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> + <span class="s2">"longitude"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="mi">22</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-25 20:27:28"</span><span class="p">,</span> + <span class="s2">"latitude"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> + <span class="s2">"longitude"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago-1"</span> + <span class="p">}</span> + <span class="p">]</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<p><strong>POST /api/1.3/coordinates</strong></p> +<blockquote> +<div><p>Create Coordinate.</p> +<p>Authentication Required: Yes</p> +<p>Role(s) Required: admin or oper</p> +<p><strong>Request Parameters</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="30%" /> +<col width="9%" /> +<col width="61%" /> +</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 notranslate"><span class="pre">name</span></code></td> +<td>yes</td> +<td>The name of the Coordinate entry</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">latitude</span></code></td> +<td>no</td> +<td>Latitude of the Coordinate</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">longitude</span></code></td> +<td>no</td> +<td>Longitude of the Coordinate</td> +</tr> +</tbody> +</table> +<p><strong>Request Example</strong></p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span class="p">{</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"my_coordinate"</span><span class="p">,</span> + <span class="s2">"latitude"</span><span class="p">:</span> <span class="mf">1.2</span><span class="p">,</span> + <span class="s2">"longitude"</span><span class="p">:</span> <span class="mf">4.5</span> +<span class="p">}</span> +</pre></div> +</div> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="32%" /> +<col width="7%" /> +<col width="60%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td> +<td>int</td> +<td>The id of the Coordinate</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td> +<td>string</td> +<td>The name of the Coordinate</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">latitude</span></code></td> +<td>float</td> +<td>Latitude of the Coordinate</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">longitude</span></code></td> +<td>float</td> +<td>Longitude of the Coordinate</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td> +<td>string</td> +<td>The Time / Date this entry was last updated</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td> +<td>array</td> +<td>A collection of alert messages.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td> +<td>string</td> +<td>Success, info, warning or error.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td> +<td>string</td> +<td>Alert message.</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">"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">"coordinate was created"</span> + <span class="p">}</span> + <span class="p">],</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span> + <span class="s1">'longitude'</span> <span class="p">:</span> <span class="mf">4.5</span><span class="p">,</span> + <span class="s1">'lastUpdated'</span> <span class="p">:</span> <span class="s1">'2016-01-25 13:55:30'</span><span class="p">,</span> + <span class="s1">'name'</span> <span class="p">:</span> <span class="s1">'my_coordinate'</span><span class="p">,</span> + <span class="s1">'latitude'</span> <span class="p">:</span> <span class="mf">1.2</span><span class="p">,</span> + <span class="s1">'id'</span> <span class="p">:</span> <span class="mi">1</span> + <span class="p">}</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<p><strong>PUT /api/1.3/coordinates</strong></p> +<blockquote> +<div><p>Update coordinate.</p> +<p>Authentication Required: Yes</p> +<p>Role(s) Required: admin or oper</p> +<p><strong>Request Query Parameters</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="12%" /> +<col width="19%" /> +<col width="69%" /> +</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>id</td> +<td>yes</td> +<td>The id of the coordinate to edit.</td> +</tr> +</tbody> +</table> +<p><strong>Request Parameters</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="30%" /> +<col width="9%" /> +<col width="61%" /> +</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 notranslate"><span class="pre">id</span></code></td> +<td>yes</td> +<td>The id of the Coordinate</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td> +<td>yes</td> +<td>The name of the Coordinate entry</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">latitude</span></code></td> +<td>no</td> +<td>Latitude of the Coordinate</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">longitude</span></code></td> +<td>no</td> +<td>Longitude of the Coordinate</td> +</tr> +</tbody> +</table> +<p><strong>Request Example</strong></p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span class="p">{</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"my_coordinate"</span><span class="p">,</span> + <span class="s2">"latitude"</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span> + <span class="s2">"longitude"</span><span class="p">:</span> <span class="mi">45</span> +<span class="p">}</span> +</pre></div> +</div> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="32%" /> +<col width="7%" /> +<col width="60%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td> +<td>int</td> +<td>The id of the Coordinate</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td> +<td>string</td> +<td>The name of the Coordinate</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">latitude</span></code></td> +<td>float</td> +<td>Latitude of the Coordinate</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">longitude</span></code></td> +<td>float</td> +<td>Longitude of the Coordinate</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td> +<td>string</td> +<td>The Time / Date this entry was last updated</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td> +<td>array</td> +<td>A collection of alert messages.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td> +<td>string</td> +<td>Success, info, warning or error.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td> +<td>string</td> +<td>Alert message.</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">"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">"coordinate was updated"</span> + <span class="p">}</span> + <span class="p">],</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span> + <span class="s1">'longitude'</span> <span class="p">:</span> <span class="mi">45</span><span class="p">,</span> + <span class="s1">'lastUpdated'</span> <span class="p">:</span> <span class="s1">'2016-01-25 13:55:30'</span><span class="p">,</span> + <span class="s1">'name'</span> <span class="p">:</span> <span class="s1">'my_coordinate'</span><span class="p">,</span> + <span class="s1">'latitude'</span> <span class="p">:</span> <span class="mi">12</span><span class="p">,</span> + <span class="s1">'id'</span> <span class="p">:</span> <span class="mi">1</span> + <span class="p">}</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<p><strong>DELETE /api/1.3/coordinates</strong></p> +<blockquote> +<div><p>Delete coordinate.</p> +<p>Authentication Required: Yes</p> +<p>Role(s) Required: admin or oper</p> +<p><strong>Request Query Parameters</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="11%" /> +<col width="19%" /> +<col width="70%" /> +</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>id</td> +<td>yes</td> +<td>The id of the coordinate to delete.</td> +</tr> +</tbody> +</table> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="24%" /> +<col width="15%" /> +<col width="62%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td> +<td>array</td> +<td>A collection of alert messages.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td> +<td>string</td> +<td>Success, info, warning or error.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td> +<td>string</td> +<td>Alert message.</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">"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">"coordinate was deleted"</span> + <span class="p">}</span> + <span class="p">]</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +</div> +</div> + + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="../../faq/index.html" class="btn btn-neutral float-right" title="FAQ">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="index.html" class="btn btn-neutral" title="API 1.3 Reference"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + </p> + </div> + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> + <span class="rst-current-version" data-toggle="rst-current-version"> + <span class="fa fa-book">Apache Traffic Control (Incubating)</span> + v: + <span class="fa fa-caret-down"></span> + </span> + <div class="rst-other-versions"> + <dl> + <dt>Versions</dt> + <dd><a href="/docs/master/">latest</a></dd> + <dd><a href="/docs/2.0/">2.0</a></dd> + <dd><a href="/docs/1.8.1/">1.8</a></dd> + <dd><a href="/docs/1.7.0/">1.7</a></dd> + </dl> + <hr/> + Free document hosting provided by <a href="http://www.readthedocs.org";>Read the Docs</a>. + + </div> + </div> + + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../../', + VERSION:'2.2-dev', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' + }; + </script> + <script type="text/javascript" src="../../_static/jquery.js"></script> + <script type="text/javascript" src="../../_static/underscore.js"></script> + <script type="text/javascript" src="../../_static/doctools.js"></script> + + + + + + <script type="text/javascript" src="../../_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52f19784/docs/master/api/v13/index.html ---------------------------------------------------------------------- diff --git a/docs/master/api/v13/index.html b/docs/master/api/v13/index.html new file mode 100644 index 0000000..aef9923 --- /dev/null +++ b/docs/master/api/v13/index.html @@ -0,0 +1,302 @@ + + + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>API 1.3 Reference — Traffic Control 2.2-dev documentation </title> + + + + + <link rel="shortcut icon" href="../../_static/favicon.ico"/> + + + + + + + + + + + + + <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> + + + + <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" /> + + + + <link rel="index" title="Index" + href="../../genindex.html"/> + <link rel="search" title="Search" href="../../search.html"/> + <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/> + <link rel="up" title="APIs" href="../index.html"/> + <link rel="next" title="Coordinate" href="coordinate.html"/> + <link rel="prev" title="Snapshot CRConfig" href="../v12/topology.html"/> + + + <script src="_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + <div class="wy-grid-for-nav"> + + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-nav-search"> + + + + <a href="/" class="icon icon-home"> Traffic Control + + + + + <img src="../../_static/tc_logo_c_only.png" class="logo" /> + + </a> + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + <ul> +<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li> +<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_vault.html">Traffic Vault</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administratorâs Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developerâs Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li> +<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> +</ul> +</li> +</ul> +<ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li> +<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"><a class="reference internal" href="../v12/index.html">API 1.2 Reference</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">API 1.3 Reference</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li> +</ul> + + + + </div> + + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../index.html">Traffic Control</a> + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li> + + <li><a href="../index.html">APIs</a> »</li> + + <li>API 1.3 Reference</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../_sources/api/v13/index.rst.txt" rel="nofollow"> View page source</a> + + </li> + </ul> + <hr/> +</div> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="coordinate.html" class="btn btn-neutral float-right" title="Coordinate">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="../v12/topology.html" class="btn btn-neutral" title="Snapshot CRConfig"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="api-1-3-reference"> +<h1>API 1.3 Reference<a class="headerlink" href="#api-1-3-reference" title="Permalink to this headline">¶</a></h1> +<p>Traffic Ops API V1.3</p> +<div class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="coordinate.html">Coordinate</a></li> +</ul> +</div> +</div> + + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="coordinate.html" class="btn btn-neutral float-right" title="Coordinate">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="../v12/topology.html" class="btn btn-neutral" title="Snapshot CRConfig"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + </p> + </div> + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> + <span class="rst-current-version" data-toggle="rst-current-version"> + <span class="fa fa-book">Apache Traffic Control (Incubating)</span> + v: + <span class="fa fa-caret-down"></span> + </span> + <div class="rst-other-versions"> + <dl> + <dt>Versions</dt> + <dd><a href="/docs/master/">latest</a></dd> + <dd><a href="/docs/2.0/">2.0</a></dd> + <dd><a href="/docs/1.8.1/">1.8</a></dd> + <dd><a href="/docs/1.7.0/">1.7</a></dd> + </dl> + <hr/> + Free document hosting provided by <a href="http://www.readthedocs.org";>Read the Docs</a>. + + </div> + </div> + + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../../', + VERSION:'2.2-dev', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' + }; + </script> + <script type="text/javascript" src="../../_static/jquery.js"></script> + <script type="text/javascript" src="../../_static/underscore.js"></script> + <script type="text/javascript" src="../../_static/doctools.js"></script> + + + + + + <script type="text/javascript" src="../../_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52f19784/docs/master/genindex.html ---------------------------------------------------------------------- diff --git a/docs/master/genindex.html b/docs/master/genindex.html index 62c6b1f..5388bb2 100644 --- a/docs/master/genindex.html +++ b/docs/master/genindex.html @@ -140,6 +140,7 @@ <li class="toctree-l2"><a class="reference internal" href="api/routes.html">API Routes</a></li> <li class="toctree-l2"><a class="reference internal" href="api/v11/index.html">API 1.1 Reference</a></li> <li class="toctree-l2"><a class="reference internal" href="api/v12/index.html">API 1.2 Reference</a></li> +<li class="toctree-l2"><a class="reference internal" href="api/v13/index.html">API 1.3 Reference</a></li> </ul> </li> </ul> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52f19784/docs/master/index.html ---------------------------------------------------------------------- diff --git a/docs/master/index.html b/docs/master/index.html index 90ca8ef..1616150 100644 --- a/docs/master/index.html +++ b/docs/master/index.html @@ -140,6 +140,7 @@ <li class="toctree-l2"><a class="reference internal" href="api/routes.html">API Routes</a></li> <li class="toctree-l2"><a class="reference internal" href="api/v11/index.html">API 1.1 Reference</a></li> <li class="toctree-l2"><a class="reference internal" href="api/v12/index.html">API 1.2 Reference</a></li> +<li class="toctree-l2"><a class="reference internal" href="api/v13/index.html">API 1.3 Reference</a></li> </ul> </li> </ul> @@ -515,6 +516,10 @@ <li class="toctree-l3"><a class="reference internal" href="api/v12/topology.html">Snapshot CRConfig</a></li> </ul> </li> +<li class="toctree-l2"><a class="reference internal" href="api/v13/index.html">API 1.3 Reference</a><ul> +<li class="toctree-l3"><a class="reference internal" href="api/v13/coordinate.html">Coordinate</a></li> +</ul> +</li> </ul> </li> </ul> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52f19784/docs/master/objects.inv ---------------------------------------------------------------------- diff --git a/docs/master/objects.inv b/docs/master/objects.inv index d1df644..ff67cc8 100644 Binary files a/docs/master/objects.inv and b/docs/master/objects.inv differ http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52f19784/docs/master/search.html ---------------------------------------------------------------------- diff --git a/docs/master/search.html b/docs/master/search.html index 6849a39..b3c0a5b 100644 --- a/docs/master/search.html +++ b/docs/master/search.html @@ -139,6 +139,7 @@ <li class="toctree-l2"><a class="reference internal" href="api/routes.html">API Routes</a></li> <li class="toctree-l2"><a class="reference internal" href="api/v11/index.html">API 1.1 Reference</a></li> <li class="toctree-l2"><a class="reference internal" href="api/v12/index.html">API 1.2 Reference</a></li> +<li class="toctree-l2"><a class="reference internal" href="api/v13/index.html">API 1.3 Reference</a></li> </ul> </li> </ul>
