rimashah25 commented on code in PR #7079: URL: https://github.com/apache/trafficcontrol/pull/7079#discussion_r991379510
########## docs/source/api/v4/multiple_servers_capabilities.rst: ########## @@ -0,0 +1,190 @@ +.. +.. +.. 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-v4-multiple_servers_capabilities: + +********************************* +``multiple_servers_capabilities`` +********************************* + +.. versionadded:: 4.1 + +``POST`` +======== +Associates a list of :term:`Server Capability` to a server. The API call replaces all the server capabilities assigned to a server with the ones specified in the serverCapabilities field. +And also Associates a list of :term:`Servers` to a server capability. The API call replaces all the servers assigned to a server capability with the ones specified in the servers field. + +:Auth. Required: Yes +:Roles Required: "admin" or "operations" +:Permissions Required: SERVER:READ, SERVER:CREATE, SERVER-CAPABILITY:READ, SERVER-CAPABILITY:CREATE +:Response Type: Object + +Request Structure +----------------- +:serverIds: List of :term:`Server` ids ((integral, unique identifier) associated with a :term:`Server Capability` +:serverCapabilities: List of :term:`Server Capability`'s name to associate with a :term:`Server` id + + +.. code-block:: http + :caption: Request Example1 + + POST /api/4.1/multiple_servers_capabilities/ HTTP/1.1 + Host: trafficops.infra.ciab.test + User-Agent: curl/7.47.0 + Accept: */* + Cookie: mojolicious=... + Content-Length: 84 + Content-Type: application/json + + { + "serverIds": [1], + "serverCapabilities": ["test", "disk"] + } + +.. code-block:: http + :caption: Request Example2 + + POST /api/4.1/multiple_servers_capabilities/ HTTP/1.1 + Host: trafficops.infra.ciab.test + User-Agent: curl/7.47.0 + Accept: */* + Cookie: mojolicious=... + Content-Length: 84 + Content-Type: application/json + + { + "serverIds": [2, 3] + "serverCapabilities": ["eas"], + } + +Response Structure +------------------ +:serverId: List of :term:`Server` ids ((integral, unique identifier) associated with a server capability. +:serverCapabilities: List of :term:`Server Capability`'s name to be associated with a :term:`Server` id. + +.. code-block:: http Review Comment: Not really. -- 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. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
