Github user mitchell852 commented on a diff in the pull request:
https://github.com/apache/incubator-trafficcontrol/pull/544#discussion_r115856573
--- Diff: docs/source/development/traffic_ops_api/v12/capability.rst ---
@@ -0,0 +1,271 @@
+..
+..
+.. 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-v12-capability:
+
+Capabilities
+============
+
+.. _to-api-v12-capability-route:
+
+/api/1.2/capabilities
++++++++++++++
+
+**GET /api/1.2/capabilities**
+
+ Get all capabilities.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+
+-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description
|
+
+===================+========+=================================================+
+ | ``name`` | string | Capability name.
|
+
+-------------------+--------+-------------------------------------------------+
+ | ``description`` | string | Describing the APIs covered by the
capability. |
+
+-------------------+--------+-------------------------------------------------+
+ | ``lastUpdated`` | string |
|
+
+-------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "name": "cdn-read",
+ "description": "View CDN configuration",
+ "lastUpdated": "2017-04-02 08:22:43"
+ },
+ {
+ "name": "cdn-write",
+ "description": "Create, edit or delete CDN configuration",
+ "lastUpdated": "2017-04-02 08:22:43"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/capabilities/:name**
+
+ Get a capability by name.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-------------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+=============================================+
+ | ``name`` | yes | Capability name. |
+ +-------------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+
+-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description
|
+
+===================+========+=================================================+
+ | ``name`` | string | Capability name.
|
+
+-------------------+--------+-------------------------------------------------+
+ | ``description`` | string | Describing the APIs covered by the
capability. |
+
+-------------------+--------+-------------------------------------------------+
+ | ``lastUpdated`` | string |
|
+
+-------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "name": "cdn-read",
+ "description": "View CDN configuration",
+ "lastUpdated": "2017-04-02 08:22:43"
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/capabilities**
+
+ Create a capability.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Parameters**
+
+
+-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description
|
--- End diff --
can you add a required column here too?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
