You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by de...@apache.org on 2018/05/03 20:06:10 UTC
[incubator-trafficcontrol] 03/04: Add Location API reference doc
This is an automated email from the ASF dual-hosted git repository.
dewrich pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-trafficcontrol.git
commit 4ba11bf289d5ce47d59e48efe1594a56fd049227
Author: Rawlin Peters <ra...@comcast.com>
AuthorDate: Wed Apr 11 16:44:24 2018 -0600
Add Location API reference doc
---
CHANGELOG.md | 1 +
.../development/traffic_ops_api/v13/location.rst | 272 +++++++++++++++++++++
2 files changed, 273 insertions(+)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 54f6450..13bbbb3 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -22,6 +22,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
- /api/1.3/deliveryservice_requests `(GET,POST,PUT,DELETE)`
- /api/1.3/divisions `(GET,POST,PUT,DELETE)`
- /api/1.3/hwinfos `(GET)`
+ - /api/1.3/locations `(GET,POST,PUT,DELETE)`
- /api/1.3/parameters `(GET,POST,PUT,DELETE)`
- /api/1.3/profileparameters `(GET,POST,PUT,DELETE)`
- /api/1.3/phys_locations `(GET,POST,PUT,DELETE)`
diff --git a/docs/source/development/traffic_ops_api/v13/location.rst b/docs/source/development/traffic_ops_api/v13/location.rst
new file mode 100644
index 0000000..807dad3
--- /dev/null
+++ b/docs/source/development/traffic_ops_api/v13/location.rst
@@ -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-location:
+
+Location
+========
+
+.. _to-api-v13-locations-route:
+
+/api/1.3/locations
+++++++++++++++++++
+
+**GET /api/1.3/locations**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | ``id`` | no | Filter Locations by ID. |
+ +-----------------+----------+---------------------------------------------------+
+ | ``name`` | no | Filter Locations by name. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================================+========+==========================================================================+
+ | ``id`` | int | Local unique identifier for the Location |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this entry was last updated |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``latitude`` | float | Latitude of the Location |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``longitude`` | float | Longitude of the Location |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``name`` | string | The name of the Location |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+
+ **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/locations**
+
+ Create Location.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Parameters**
+
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=================================+==========+===================================================================+
+ | ``name`` | yes | The name of the Location entry |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``latitude`` | no | Latitude of the Location |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``longitude`` | no | Longitude of the Location |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "my_location",
+ "latitude": 1.2,
+ "longitude": 4.5,
+ }
+
+ **Response Properties**
+
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================================+========+===================================================================+
+ | ``id`` | int | The id of the Location |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``name`` | string | The name of the Location |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``latitude`` | float | Latitude of the Location |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``longitude`` | float | Longitude of the Location |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``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": "location was created"
+ }
+ ],
+ "response": {
+ 'longitude' : 4.5,
+ 'lastUpdated' : '2016-01-25 13:55:30',
+ 'name' : 'my_location',
+ 'latitude' : 1.2,
+ 'id' : 1,
+ }
+ }
+
+|
+
+**PUT /api/1.3/locations**
+
+ Update location.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Query Parameters**
+
+ +------+----------+------------------------------------+
+ | Name | Required | Description |
+ +======+==========+====================================+
+ | id | yes | The id of the location to edit. |
+ +------+----------+------------------------------------+
+
+ **Request Parameters**
+
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=================================+==========+===================================================================+
+ | ``id`` | yes | The id of the Location |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``name`` | yes | The name of the Location entry |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``latitude`` | no | Latitude of the Location |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``longitude`` | no | Longitude of the Location |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "id": 1,
+ "name": "my_location",
+ "latitude": 12,
+ "longitude": 45,
+ }
+
+ **Response Properties**
+
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================================+========+===================================================================+
+ | ``id`` | int | The id of the Location |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``name`` | string | The name of the Location |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``latitude`` | float | Latitude of the Location |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``longitude`` | float | Longitude of the Location |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``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": "location was updated"
+ }
+ ],
+ "response": {
+ 'longitude' : 45,
+ 'lastUpdated' : '2016-01-25 13:55:30',
+ 'name' : 'my_location',
+ 'latitude' : 12,
+ 'id' : 1,
+ }
+ }
+
+|
+
+**DELETE /api/1.3/locations**
+
+ Delete location.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Query Parameters**
+
+ +------+----------+--------------------------------------+
+ | Name | Required | Description |
+ +======+==========+======================================+
+ | id | yes | The id of the location 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": "location was deleted"
+ }
+ ],
+ }
+
+|
+
--
To stop receiving notification emails like this one, please contact
dewrich@apache.org.