trafficcontrol-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From hbea...@apache.org
Subject [45/51] [partial] incubator-trafficcontrol-website git commit: adds 2.1.x documentation
Date Mon, 22 Jan 2018 15:57:53 GMT
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/24ff8964/docs/2.1.x/_sources/development/traffic_ops_api/v11/changelog.rst.txt
----------------------------------------------------------------------
diff --git a/docs/2.1.x/_sources/development/traffic_ops_api/v11/changelog.rst.txt b/docs/2.1.x/_sources/development/traffic_ops_api/v11/changelog.rst.txt
new file mode 100644
index 0000000..22b1ff1
--- /dev/null
+++ b/docs/2.1.x/_sources/development/traffic_ops_api/v11/changelog.rst.txt
@@ -0,0 +1,154 @@
+.. 
+.. 
+.. 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-v11-change-logs:
+
+Change Logs
+===========
+
+.. _to-api-v11-change-logs-route:
+
+/api/1.1/logs
++++++++++++++
+
+**GET /api/1.1/logs.json**
+
+  Authentication Required: Yes
+
+  Role(s) Required: None
+
+  **Response Properties**
+
+  +-----------------+--------+--------------------------------------------------------------------------+
+  | Parameter       | Type   | Description                                              
               |
+  +=================+========+==========================================================================+
+  | ``ticketNum``   | string | Optional field to cross reference with any bug tracking systems
         |
+  +-----------------+--------+--------------------------------------------------------------------------+
+  | ``level``       | string | Log categories for each entry, examples: 'UICHANGE', 'OPER',
'APICHANGE'.|
+  +-----------------+--------+--------------------------------------------------------------------------+
+  | ``lastUpdated`` | string | Local unique identifier for the Log                      
               |
+  +-----------------+--------+--------------------------------------------------------------------------+
+  | ``user``        | string | Current user who made the change that was logged         
               |
+  +-----------------+--------+--------------------------------------------------------------------------+
+  | ``id``          | string | Local unique identifier for the Log entry                
               |
+  +-----------------+--------+--------------------------------------------------------------------------+
+  | ``message``     | string | Log detail about what occurred                           
               |
+  +-----------------+--------+--------------------------------------------------------------------------+
+
+  **Response Example** ::
+
+    {
+     "response": [
+        {
+           "ticketNum": null,
+           "level": "OPER",
+           "lastUpdated": "2015-02-04 22:59:13",
+           "user": "userid852",
+           "id": "22661",
+           "message": "Snapshot CRConfig created."
+        },
+        {
+           "ticketNum": null,
+           "level": "APICHANGE",
+           "lastUpdated": "2015-02-03 17:04:20",
+           "user": "userid853",
+           "id": "22658",
+           "message": "Update server odol-atsec-nyc-23.kbaletown.net status=REPORTED"
+        },
+     ],
+    }
+
+|
+
+**GET /api/1.1/logs/:days/days.json**
+
+  Authentication Required: Yes
+
+  Role(s) Required: None
+
+  **Request Route Parameters**
+
+  +----------+----------+-----------------+
+  |   Name   | Required |   Description   |
+  +==========+==========+=================+
+  | ``days`` | yes      | Number of days. |
+  +----------+----------+-----------------+
+
+  **Response Properties**
+
+  +----------------------+--------+------------------------------------------------+
+  | Parameter            | Type   | Description                                    |
+  +======================+========+================================================+
+  |``ticketNum``         | string |                                                |
+  +----------------------+--------+------------------------------------------------+
+  |``level``             | string |                                                |
+  +----------------------+--------+------------------------------------------------+
+  |``lastUpdated``       | string |                                                |
+  +----------------------+--------+------------------------------------------------+
+  |``user``              | string |                                                |
+  +----------------------+--------+------------------------------------------------+
+  |``id``                | string |                                                |
+  +----------------------+--------+------------------------------------------------+
+  |``message``           | string |                                                |
+  +----------------------+--------+------------------------------------------------+
+
+  **Response Example** ::
+
+    {
+     "response": [
+        {
+           "ticketNum": null,
+           "level": "OPER",
+           "lastUpdated": "2015-02-04 22:59:13",
+           "user": "userid852",
+           "id": "22661",
+           "message": "Snapshot CRConfig created."
+        },
+        {
+           "ticketNum": null,
+           "level": "APICHANGE",
+           "lastUpdated": "2015-02-03 17:04:20",
+           "user": "userid853",
+           "id": "22658",
+           "message": "Update server odol-atsec-nyc-23.kabletown.net status=REPORTED"
+        }
+     ],
+    }
+
+|
+
+**GET /api/1.1/logs/newcount.json**
+
+  Authentication Required: Yes
+
+  Role(s) Required: None
+
+  **Response Properties**
+
+  +----------------------+--------+------------------------------------------------+
+  | Parameter            | Type   | Description                                    |
+  +======================+========+================================================+
+  |``newLogcount``       |  int   |                                                |
+  +----------------------+--------+------------------------------------------------+
+
+  **Response Example** ::
+
+    {
+         "response": {
+            "newLogcount": 0
+         }
+    }
+


Mime
View raw message