[GitHub] [trafficcontrol] mattjackson220 commented on a change in pull request #6639: Added Traffic Portal page for CDNi config requests

[GitBox <gi...@apache.org>]

mattjackson220 commented on a change in pull request #6639:
URL: https://github.com/apache/trafficcontrol/pull/6639#discussion_r828064109



##########
File path: docs/source/api/v4/oc_fci_configuration_requests.rst
##########
@@ -0,0 +1,96 @@
+..
+..
+.. 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-oc-fci-configuration_requests:
+
+*********************************
+``OC/FCI/configuration/requests``
+*********************************
+
+``GET``
+=======
+Returns the requested updates for :abbr:`CDNi (Content Delivery Network Interconnect)` configurations. An optional ``id`` parameter will return only information for a specific request.
+
+:Auth. Required: Yes
+:Roles Required: "admin"
+:Permissions Required: CDNI-CAPACITY:ADMIN
+:Response Type:  Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+	+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+	| Name      | Required | Description                                                                                                   |
+	+===========+==========+===============================================================================================================+
+	| id        | no       | Return only the configuration requests identified by this integral, unique identifier                         |
+	+-----------+----------+---------------------------------------------------------------------------------------------------------------+
+
+Response Structure
+------------------
+:id:               An integral, unique identifier for the requested configuration updates.
+:ucdn:             The name of the :abbr:`uCDN (Upstream Content Delivery Network)` to which the requested changes apply.
+:data:             An array of generic :abbr:`FCI (Footprint and Capabilities Advertisement Interface)` base objects.
+:host:             The domain to which the requested changes apply.
+:request_type:     A string of the type of configuration update request.
+:async_status_id:  An integral, unique identifier for the associated asynchronous status.
+:capability-type:  A string of the type of base object.
+:capability-value: An array of the value for the base object.

Review comment:
       no it only specifies the capability-type and -value. i left the others like our normal but ill update them to match these for consistency




-- 
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: issues-unsubscribe@trafficcontrol.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org