mhoppa commented on a change in pull request #4406: Only allow changing of
types based on useintable
URL: https://github.com/apache/trafficcontrol/pull/4406#discussion_r387682707
##########
File path: docs/source/api/v2/types_id.rst
##########
@@ -76,3 +76,138 @@ Response Structure
"useInTable": "cachegroup"
}
]}
+
+
+``PUT``
+=======
+Updates a type
+
+:Auth. Required: Yes
+:Roles Required: None
+:Response Type: Object
+
+Request Structure
+-----------------
+.. table:: Request Path Parameters
+
+ +------+-------------------------------------------------------------+
+ | Name | Description |
+ +======+=============================================================+
+ | ID | The integral, unique identifier of the type being inspected |
+ +------+-------------------------------------------------------------+
+
+:description: A short description of this type
+:name: The name of this type
+:useInTable: The name of the Traffic Ops database table that contains objects
which are grouped, identified, or described by this type.
+.. note:: Only types with useInTable set to 'server' are allowed to be updated.
+
+.. code-block:: http
+ :caption: Request Structure
+
+ PUT /api/2.0/type/3004
+ Host: trafficops.infra.ciab.test
+ User-Agent: curl/7.47.0
+ Accept: */*
+ Cookie: mojolicious=...
+ Content-Length: 68
+ Content-Type: application/json
+
+ {
+ "name": "Example01",
+ "description": "Example2",
+ "useInServer": "server"
+ }
+
+Response Structure
+------------------
+:description: A short description of this type
+:id: An integral, unique identifier for this type
+:lastUpdated: The date and time at which this type was last updated, in ISO
format
+:name: The name of this type
+:useInTable: The name of the Traffic Ops database table that contains objects
which are grouped, identified, or described by this type
+
+.. code-block:: http
+ :caption: Response Example
+
+ HTTP/1.1 200 OK
+ Access-Control-Allow-Credentials: true
+ Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type,
Accept, Set-Cookie, Cookie
+ Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
+ Access-Control-Allow-Origin: *
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54
GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512:
EH8jo8OrCu79Tz9xpgT3YRyKJ/p2NcTmbS3huwtqRByHz9H6qZLQjA59RIPaVSq3ZxsU6QhTaox5nBkQ9LPSAA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Wed, 26 Feb 2020 18:58:41 GMT
+ Content-Length: 172
+
+ {
+ "alerts": [
+ {
+ "text": "type was updated.",
+ "level": "success"
+ }],
+ "response": [
+ {
+ "id": 3004,
+ "lastUpdated": "2020-02-26 18:58:41+00",
+ "name": "Example02",
+ "description": "Example"
+ "useInTable": "server"
+ }]
+ }
+
+``DELETE``
+==========
+Deletes a type
+
+:Auth. Required: Yes
+:Roles Required: None
Review comment:
operations
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
