mitchell852 commented on a change in pull request #2029: Implements https://github.com/apache/incubator-trafficcontrol/issues/… URL: https://github.com/apache/incubator-trafficcontrol/pull/2029#discussion_r177819840
########## File path: docs/source/development/traffic_ops_api/v12/cachegroup_fallbacks.rst ########## @@ -0,0 +1,266 @@ +.. +.. +.. 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-cachegroupfallbacks: + +Cache Group Fallback +==================== + +.. _to-api-v12-cachegroupfallbacks-route: + +/api/1.2/cachegroups/fallbacks +++++++++++++++++++++++++++++++ + +**GET /api/1.2/cachegroups/:id/fallbacks** + + Authentication Required: Yes + + Role(s) Required: None + + **Response Properties** + + +-----------------------------------+--------+--------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===================================+========+==========================================================================+ + | ``fallbacks`` | string | JSON key to parse fallback list | + +-----------------------------------+--------+--------------------------------------------------------------------------+ + | ``name`` | string | Fallback cache group name | + +-----------------------------------+--------+--------------------------------------------------------------------------+ + | ``order`` | int | Ordering list in the list of backups | + +-----------------------------------+--------+--------------------------------------------------------------------------+ + + **Response Example** :: + + { + "alerts": [ + { + "level": "success", + "text": "Backup configuration for 51 successful." + } + ], + "response": { + "GROUP1": + { + "fallbacks": + { + "list": + [ + { + "order": -1, "name" :"GROUP2" + }, + { + "order": -1, "name" :"GROUP2" + } + ] + } + } + } + } + + +| + +**POST /api/1.2/cachegroups/:id/fallbacks** + + Create cache group. + + Authentication Required: Yes + + Role(s) Required: admin or oper + + **Request Parameters** + + +-----------------------------------+--------+--------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===================================+========+==========================================================================+ + | ``fallbacks`` | string | JSON key to parse fallback list | + +-----------------------------------+--------+--------------------------------------------------------------------------+ + | ``name`` | string | Fallback cache group name | + +-----------------------------------+--------+--------------------------------------------------------------------------+ + | ``order`` | int | Ordering list in the list of backups | + +-----------------------------------+--------+--------------------------------------------------------------------------+ + + **Request Example** :: + + { + "fallbacks": + [ + { + "name": "GROUP2", "order": 1 + }, + { + "name": "GROUP3", "order": 2 + } + ] + } + + **Response Properties** + + +-----------------------------------+--------+--------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===================================+========+==========================================================================+ + | ``fallbacks`` | string | JSON key to parse fallback list | + +-----------------------------------+--------+--------------------------------------------------------------------------+ + | ``name`` | string | Fallback cache group name | + +-----------------------------------+--------+--------------------------------------------------------------------------+ + | ``order`` | int | Ordering list in the list of backups | + +-----------------------------------+--------+--------------------------------------------------------------------------+ + + **Response Example** :: + + { + "alerts": [ + { + "level":"success", + "text":"Backup configuration for 51 successful." + } + ], + "response":{ + "GROUP1":{ + "fallbacks":{ + "list":[ + { + "order":1,"name":"GROUP2" + }, + { + "order":2,"name":"GROUP3" + + } + ] + } + } + } + } + +| + +**PUT /api/1.2/cachegroups/:id/fallbacks** + + Create cache group. Review comment: can you add a description of what this route is used for. It is not clear to me what a PUT does. Does it replace all existing fallbacks? ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
