You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@trafficcontrol.apache.org by GitBox <gi...@apache.org> on 2020/02/25 13:37:58 UTC
[GitHub] [trafficcontrol] zrhoffman opened a new pull request #4444:
Document undocumented Traffic Ops routes
zrhoffman opened a new pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444
<!--
************ STOP!! ************
If this Pull Request is intended to fix a security vulnerability, DO NOT submit it! Instead, contact
the Apache Software Foundation Security Team at security@trafficcontrol.apache.org and follow the
guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
-->
## What does this PR (Pull Request) do?
<!-- Explain the changes you made here. If this fixes an Issue, identify it by
replacing the text in the checkbox item with the Issue number e.g.
- [x] This PR fixes #9001 OR is not related to any Issue
^ This will automatically close Issue number 9001 when the Pull Request is
merged (The '#' is important).
Be sure you check the box properly, see the "The following criteria are ALL
met by this PR" section for details.
-->
This PR:
- [x] fixes #4290 by documenting the remaining routes listed
- [x] adds POST cdns/dnsseckeys/generate and GET, POST, PUT, and DELETE deliveryservice_requests to the Python client for Traffic Ops
## Which Traffic Control components are affected by this PR?
<!-- Please delete all components from this list that are NOT affected by this
Pull Request. Also, feel free to add the name of a tool or script that is
affected but not on the list.
Additionally, if this Pull Request does NOT affect documentation, please
explain why documentation is not required. -->
- Documentation
- Traffic Control Client - Python
## What is the best way to verify this PR?
<!-- Please include here ALL the steps necessary to test your Pull Request. If
it includes tests (and most should), outline here the steps needed to run the
tests. If not, lay out the manual testing procedure and please explain why
tests are unnecessary for this Pull Request. -->
Testing can be performed in 3 steps:
* Ensure that the docs build without errors or warnings
* Check whether the docs are accurate and easy to follow
* Test out the Python client for Traffic Ops to see if requests to the added routes work
## If this is a bug fix, what versions of Traffic Control are affected?
<!-- If this PR fixes a bug, please list here all of the affected versions - to
the best of your knowledge. It's also pretty helpful to include a commit hash
of where 'master' is at the time this PR is opened (if it affects master),
because what 'master' means will change over time. For example, if this PR
fixes a bug that's present in master (at commit hash '2697ebac'), in v3.0.0,
and in the current 3.0.1 Release candidate (e.g. RC1), then this list would
look like:
- master (2697ebac)
- 3.0.0
- 3.0.1 (RC1)
If you don't know what other versions might have this bug, AND don't know how
to find the commit hash of 'master', then feel free to leave this section
blank (or, preferably, delete it entirely).
-->
- master (df7a3a3d1c)
- 3.1.0
- 4.0.0 (RC4)
## The following criteria are ALL met by this PR
<!-- Check the boxes to signify that the associated statement is true. To
"check a box", replace the space inside of the square brackets with an 'x'.
e.g.
- [ x] <- Wrong
- [x ] <- Wrong
- [] <- Wrong
- [*] <- Wrong
- [x] <- Correct!
-->
- [x] I have explained why tests are unnecessary
- [x] This PR includes documentation
- [x] An update to CHANGELOG.md is not necessary
- [x] This PR includes any and all required license headers
- [x] This PR ensures that database migration sequence is correct OR this PR does not include a database migration
- [x] This PR **DOES NOT FIX A SERIOUS SECURITY VULNERABILITY** (see [the Apache Software Foundation's security guidelines](https://www.apache.org/security/) for details)
## Additional Information
<!-- If you would like to include any additional information on the PR for
potential reviewers please put it here.
Some examples of this would be:
- Before and after screenshots/gifs of the Traffic Portal if it is affected
- Links to other dependent Pull Requests
- References to relevant context (e.g. new/updates to dependent libraries,
mailing list records, blueprints)
Feel free to leave this section blank (or, preferably, delete it entirely).
-->
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you 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.
-->
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r409165757
##########
File path: docs/source/api/v2/deliveryservice_requests_id_assign.rst
##########
@@ -0,0 +1,260 @@
+..
+..
+.. 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-deliveryservice_requests-id-assign:
+
+******************************************
+``deliveryservice_requests/{{ID}}/assign``
+******************************************
+Assign a :term:`Delivery Service Request` to a user.
+
+``PUT``
+=======
+:Auth. Required: Yes
+:Roles Required: "admin" or "operations"
+:Response Type: Object
+
+Request Structure
+-----------------
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:assignee: The username of the user to whom the :term:`Delivery Service Request` is assigned.
+:assignee: The username of the user to whom the :term:`Delivery Service Request` is assigned.
Review comment:
Removed duplicate line in 208e57910.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386163966
##########
File path: docs/source/api/v2/deliveryservice_requests_id_status.rst
##########
@@ -0,0 +1,177 @@
+..
+..
+.. 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-deliveryservice_requests-id-status:
+
+******************************************
+``deliveryservice_requests/{{ID}}/assign``
+******************************************
+Sets the status of a :term:`Delivery Service Request`.
+
+``PUT``
+=======
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+
+.. code-block:: http
+ :caption: Request Example
+
+ PUT /api/2.0/deliveryservice_requests/1/status HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 28
+
+ {
+ "id": 1,
+ "status": "rejected"
+ }
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
Review comment:
Term linked in 6d4154ac02.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386157890
##########
File path: docs/source/api/v2/ping.rst
##########
@@ -0,0 +1,62 @@
+..
+..
+.. 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-ping:
+
+********
+``ping``
+********
+Checks whether Traffic Ops is online.
+
+``GET``
+=======
+:Auth. Required: No
+:Response Type: Object
Review comment:
Response type changed in 8fe4ab7d06.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386173461
##########
File path: docs/source/api/v2/steering.rst
##########
@@ -0,0 +1,97 @@
+..
+..
+.. 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-steering:
+
+************
+``steering``
+************
+
+``GET``
+=======
+Gets a list of all :ref:`Steering Targets <steering-qht>` in the Traffic Ops database.
+
+:Auth. Required: Yes
+:Roles Required: "Portal", "Steering", "Federation", "operations" or "admin"
+:Response Type: Array
+
+Request Structure
+-----------------
+No parameters available.
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/steering HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:deliveryService: A string that is the :ref:`ds-xmlid` of the steering :term:`Delivery Service`
+:clientSteering: Whether this is a :ref:`client steering <ds-client-steering>` delivery service.
Review comment:
Capitalized Delivery Service in 0647ea4845.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384063731
##########
File path: docs/source/api/v2/ping.rst
##########
@@ -0,0 +1,62 @@
+..
+..
+.. 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-ping:
+
+********
+``ping``
+********
+Checks whether Traffic Ops is online.
+
+``GET``
+=======
+:Auth. Required: No
+:Response Type: Object
Review comment:
Response type is actually "<code>\`\`undefined\`\`</code>" since there's no `response` key.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] rawlinp commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
rawlinp commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384097211
##########
File path: traffic_control/clients/python/trafficops/tosession.py
##########
@@ -866,6 +866,17 @@ def assign_deliveryservice_servers_by_names(self, xml_id=None, data=None):
:raises: Union[LoginError, OperationError]
"""
+ @api_request(u'post', u'deliveryservice_requests', ('2.0',))
Review comment:
This change probably belongs in its own PR IMO -- it has nothing to do with "Document undocumented Traffic Ops routes".
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384053763
##########
File path: docs/source/api/v2/asns.rst
##########
@@ -169,3 +169,132 @@ Response Structure
"lastUpdated": "2019-12-02 21:49:08+00"
}}
+``PUT``
+=======
+Updates an existing :abbr:`ASN (Autonomous System Number)`.
+
+:Auth. Required: Yes
+:Roles Required: "admin" or "operations"
+:Response Type: Object
+
+Request Structure
+-----------------
+ +--------------+----------+---------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +==============+==========+=================================================================================+
+ | asn | Yes | The value of the new :abbr:`ASN (Autonomous System Number)`. |
+ +--------------+----------+---------------------------------------------------------------------------------+
+ | cachegroup | Yes | A string that specifies the :ref:`cache-group-name` of a :term:`Cache Group` to |
+ | | | which this :abbr:`ASN (Autonomous System Number)` will be assigned. If you do |
+ | | | not pass this field, the cachegroup will be ``null``. For that reason, we list |
+ | | | it as required. |
+ +--------------+----------+---------------------------------------------------------------------------------+
+ | cachegroupId | Yes | The integral, unique identifier of the status of the cache group. |
Review comment:
You don't have to link it again (though that'd be great), but it should be "Cache Group" not "cache group".
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] mhoppa commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
mhoppa commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r383908140
##########
File path: docs/source/api/v2/deliveryservice_requests_id_status.rst
##########
@@ -0,0 +1,177 @@
+..
+..
+.. 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-deliveryservice_requests-id-status:
+
+******************************************
+``deliveryservice_requests/{{ID}}/assign``
+******************************************
+Sets the status of a :term:`Delivery Service Request`.
+
+``GET``
Review comment:
should this be a PUT
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384055726
##########
File path: docs/source/api/v2/deliveryservice_request_comments.rst
##########
@@ -0,0 +1,296 @@
+..
+..
+.. 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-deliveryservice_request_comments:
+
+************************************
+``deliveryservice_request_comments``
+************************************
+
+``GET``
+=======
+Gets delivery service request comments.
+
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+
+.. table:: Request Query Parameters
+
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +==========================+==========+=====================================================================================================================================================+
+ | author | no | Filter for :ref:`Delivery Service Request <ds_requests>` comments submitted by the user identified by this username |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Filter for :ref:`Delivery Service Request <ds_requests>` comments submitted by the user identified by this integral, unique identifier |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | deliveryServiceRequestId | no | Filter for :ref:`Delivery Service Request <ds_requests>` comments submitted for the delivery service identified by this integral, unique identifier |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Filter for the :ref:`Delivery Service Request <ds_requests>` comment identified by this integral, unique identifier |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservice_request_comments HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 21:00:26 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: RaJZS1XFJ4oIxVKyyDjTuoQY7gPOmm5EuIL4AgHpyQpuaaNviw0XhGC4V/AKf/Ws6zXLgIUc4OyvMsTxnrilww==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 20:00:26 GMT
+ Content-Length: 207
+
+ {
+ "response": [
+ {
+ "authorId": 2,
+ "author": "admin",
+ "deliveryServiceRequestId": 2,
+ "id": 3,
+ "lastUpdated": "2020-02-24 19:59:46+00",
+ "value": "Changing to a different origin for now.",
+ "xmlId": "demo1"
+ },
+ {
+ "authorId": 2,
+ "author": "admin",
+ "deliveryServiceRequestId": 2,
+ "id": 4,
+ "lastUpdated": "2020-02-24 19:59:55+00",
+ "value": "Using HTTPS.",
+ "xmlId": "demo1"
+ }
+ ]
+ }
+
+``POST``
+========
+Allows user to create a :term:`Delivery Service Request` comment.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+
+.. code-block:: http
+ :caption: Request Example
+
+ POST /api/2.0/deliveryservice_request_comments HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 111
+
+ {
+ "deliveryServiceRequestId": 2,
+ "value": "Does anyone have time to review my delivery service request?"
+ }
+
+Response Structure
+------------------
+
Review comment:
Response field definitions?
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] mhoppa commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
mhoppa commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r383924362
##########
File path: traffic_control/clients/python/trafficops/tosession.py
##########
@@ -866,6 +866,17 @@ def assign_deliveryservice_servers_by_names(self, xml_id=None, data=None):
:raises: Union[LoginError, OperationError]
"""
+ @api_request(u'post', u'deliveryservice_requests', (u'1.1', u'1.2', u'1.3', u'1.4', u'1.5'))
Review comment:
this should just be 2.0 the client is documented not to support any 1.x versions now
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384066803
##########
File path: docs/source/api/v2/servers_id_deliveryservices.rst
##########
@@ -239,3 +239,81 @@ Response Structure
.. [#tenancy] Only the :term:`Delivery Services` visible to the requesting user's :term:`Tenant` will appear, regardless of their :term:`Role` or the :term:`Delivery Services`' actual 'server assignment' status.
+
+``POST``
+========
+Assign an arbitrary number of delivery services to a single server.
+
+:Auth. Required: Yes
+:Roles Required: "admin" or "operations"
+:Response Type: Object
+
+Request Structure
+-----------------
+.. table:: Request Path Parameters
+
+ +------+----------+---------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +------+----------+---------------------------------------------------------------------------------------------+
+ | id | Yes | The integral, unique identifier of the server that you want to assign delivery services to. |
+ +------+----------+---------------------------------------------------------------------------------------------+
+
+.. table:: Request Query Parameters
+
+ +---------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=========+==========+==========================================================================================+
+ | replace | Yes | Must be a 1, true, 0, or false. Although this query parameter is required, it is unused. |
Review comment:
Is that true? I think TP may be relying on that.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384060575
##########
File path: docs/source/api/v2/deliveryservice_requests.rst
##########
@@ -0,0 +1,767 @@
+..
+..
+.. 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-deliveryservice-requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`.
+
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+==========================================================================================+
+ | assignee | no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this username. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | assigneeId| no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | author | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this username |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | authorId | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | changeType| no | Filter for :ref:`ds_requests` of the change type specified. |
+ | | | Can be ``create``, ``update``, or ``delete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | id | no | Filter for the :ref:`Delivery Service Request <ds_requests>` identified by this |
+ | | | integral, unique identifier. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | status | no | Filter for :ref:`ds_requests` whose status is the status |
+ | | | specified. The status can be ``draft``, ``submitted``, ``pending``, ``rejected``, or |
+ | | | ``complete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | xmlId | no | Filter for :ref:`ds_requests` that have the given |
+ | | | :ref:`ds-xmlid`. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservice_requests?status=draft HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:lastUpdated: The date and time at which the :term:`DSR <Delivery Service Request>` was last updated, in ISO format.
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 20:14:07 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: UBp3nklJr2x2cAW/TKbhXMVJH6+OduxUaEBGbX4P7IahDk3VkaTd9LsQj01zgFEnZLwHrikpwFfNlUO32RAZOA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 19:14:07 GMT
+ Content-Length: 872
+
+ {
+ "response": [
+ {
+ "authorId": 2,
+ "author": "admin",
+ "changeType": "update",
+ "createdAt": "2020-02-24 19:11:12+00",
+ "id": 1,
+ "lastEditedBy": "admin",
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-24 19:11:12+00",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "0001-01-01 00:00:00+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "draft"
+ }
+ ]
+ }
+
+.. _to-api-deliveryservice-requests-post:
+
+``POST``
+========
+
+.. note:: This route does NOT do the same thing as :ref:`POST deliveryservices/request <to-api-deliveryservices-request>`.
+
+Creates a new :term:`Delivery Service Request`.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+:changeType: The action that you want to perform on the delivery service. It can be "create", "update", or "delete".
+:status: The status of your request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+:deliveryService: The :term:`Delivery Service` that you have submitted for review as part of this request.
+
+.. code-block:: http
+ :caption: Request Example
+
+ POST /api/2.0/deliveryservice_requests HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 1979
+
+ {
+ "changeType": "update",
+ "status": "draft",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2020-02-13 16:43:54+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ }
+ }
+
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:lastUpdated: The date and time at which the :term:`DSR <Delivery Service Request>` was last updated, in ISO format.
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 20:11:12 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: aWIrFTwUGnLq56WNZPL/FgOi/NwAVUtOy4iqjFPwx4gj7RMZ6+nd++bQKIiasBl8ytAY0WmFvNnmm30Fq9mLpA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 19:11:12 GMT
+ Content-Length: 901
+
+ {
+ "alerts": [
+ {
+ "text": "deliveryservice_request was created.",
+ "level": "success"
+ }
+ ],
+ "response": {
+ "authorId": 2,
+ "author": null,
+ "changeType": "update",
+ "createdAt": null,
+ "id": 1,
+ "lastEditedBy": null,
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-24 19:11:12+00",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "0001-01-01 00:00:00+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "draft"
+ }
+ }
+
+``PUT``
+=======
+
+Updates an existing :ref:`Delivery Service Request <ds_requests>`.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
Review comment:
sub-property definitions?
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386152988
##########
File path: docs/source/api/v2/deliveryservice_request_comments.rst
##########
@@ -0,0 +1,296 @@
+..
+..
+.. 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-deliveryservice_request_comments:
+
+************************************
+``deliveryservice_request_comments``
+************************************
+
+``GET``
+=======
+Gets delivery service request comments.
+
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+
+.. table:: Request Query Parameters
+
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +==========================+==========+=====================================================================================================================================================+
+ | author | no | Filter for :ref:`Delivery Service Request <ds_requests>` comments submitted by the user identified by this username |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Filter for :ref:`Delivery Service Request <ds_requests>` comments submitted by the user identified by this integral, unique identifier |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | deliveryServiceRequestId | no | Filter for :ref:`Delivery Service Request <ds_requests>` comments submitted for the delivery service identified by this integral, unique identifier |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Filter for the :ref:`Delivery Service Request <ds_requests>` comment identified by this integral, unique identifier |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservice_request_comments HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 21:00:26 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: RaJZS1XFJ4oIxVKyyDjTuoQY7gPOmm5EuIL4AgHpyQpuaaNviw0XhGC4V/AKf/Ws6zXLgIUc4OyvMsTxnrilww==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 20:00:26 GMT
+ Content-Length: 207
+
+ {
+ "response": [
+ {
+ "authorId": 2,
+ "author": "admin",
+ "deliveryServiceRequestId": 2,
+ "id": 3,
+ "lastUpdated": "2020-02-24 19:59:46+00",
+ "value": "Changing to a different origin for now.",
+ "xmlId": "demo1"
+ },
+ {
+ "authorId": 2,
+ "author": "admin",
+ "deliveryServiceRequestId": 2,
+ "id": 4,
+ "lastUpdated": "2020-02-24 19:59:55+00",
+ "value": "Using HTTPS.",
+ "xmlId": "demo1"
+ }
+ ]
+ }
+
+``POST``
+========
+Allows user to create a :term:`Delivery Service Request` comment.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+
Review comment:
Field definitions added in 6d4154ac02.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386153008
##########
File path: docs/source/api/v2/deliveryservice_request_comments.rst
##########
@@ -0,0 +1,296 @@
+..
+..
+.. 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-deliveryservice_request_comments:
+
+************************************
+``deliveryservice_request_comments``
+************************************
+
+``GET``
+=======
+Gets delivery service request comments.
+
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+
+.. table:: Request Query Parameters
+
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +==========================+==========+=====================================================================================================================================================+
+ | author | no | Filter for :ref:`Delivery Service Request <ds_requests>` comments submitted by the user identified by this username |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Filter for :ref:`Delivery Service Request <ds_requests>` comments submitted by the user identified by this integral, unique identifier |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | deliveryServiceRequestId | no | Filter for :ref:`Delivery Service Request <ds_requests>` comments submitted for the delivery service identified by this integral, unique identifier |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Filter for the :ref:`Delivery Service Request <ds_requests>` comment identified by this integral, unique identifier |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservice_request_comments HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 21:00:26 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: RaJZS1XFJ4oIxVKyyDjTuoQY7gPOmm5EuIL4AgHpyQpuaaNviw0XhGC4V/AKf/Ws6zXLgIUc4OyvMsTxnrilww==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 20:00:26 GMT
+ Content-Length: 207
+
+ {
+ "response": [
+ {
+ "authorId": 2,
+ "author": "admin",
+ "deliveryServiceRequestId": 2,
+ "id": 3,
+ "lastUpdated": "2020-02-24 19:59:46+00",
+ "value": "Changing to a different origin for now.",
+ "xmlId": "demo1"
+ },
+ {
+ "authorId": 2,
+ "author": "admin",
+ "deliveryServiceRequestId": 2,
+ "id": 4,
+ "lastUpdated": "2020-02-24 19:59:55+00",
+ "value": "Using HTTPS.",
+ "xmlId": "demo1"
+ }
+ ]
+ }
+
+``POST``
+========
+Allows user to create a :term:`Delivery Service Request` comment.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+
+.. code-block:: http
+ :caption: Request Example
+
+ POST /api/2.0/deliveryservice_request_comments HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 111
+
+ {
+ "deliveryServiceRequestId": 2,
+ "value": "Does anyone have time to review my delivery service request?"
+ }
+
+Response Structure
+------------------
+
Review comment:
Field definitions added in 6d4154ac02.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386152931
##########
File path: docs/source/api/v2/riak_ping.rst
##########
@@ -0,0 +1,66 @@
+..
+..
+.. 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-riak-ping:
+
+*************
+``riak/ping``
+*************
+Checks whether :ref:`tv-overview` is online.
+
+``GET``
+=======
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Object
+
+Request Structure
+-----------------
+No parameters available.
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/riak/ping HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+.. code-block:: http
Review comment:
Field definitions added in 6d4154ac02.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r409158141
##########
File path: docs/source/api/v2/deliveryservices_id_urlkeys.rst
##########
@@ -0,0 +1,93 @@
+..
+..
+.. 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-deliveryservices-id-urlkeys:
+
+***********************************
+``deliveryservices/{{ID}}/urlkeys``
+***********************************
+
+``GET``
+=======
+.. seealso:: :ref:`to-api-deliveryservices-xmlid-xmlid-urlkeys`
+
+Retrieves URL signing keys for a :term:`Delivery Service`.
+
+.. caution:: This method will return the :term:`Delivery Service`'s **PRIVATE** URL signing keys! Be wary of using this endpoint and **NEVER** share the output with anyone who would be unable to see it on their own.
+
+:Auth. Required: Yes
+:Roles Required: None
+:Response Type: Object
+
+Request Structure
+-----------------
+.. table:: Request Path Parameters
+
+ +------+----------------------------------------------------------------------------------------+
+ | Name | Description |
+ +======+========================================================================================+
+ | id | Filter for the :term:`Delivery Service` identified by this integral, unique identifier |
+ +------+----------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservices/1/urlkeys HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:key<N>: The private URL signing key for this :term:`Delivery Service` as a base-64-encoded string, where ``<N>`` is the "generation" of the key e.g. the first key will always be named ``"key0"``. Up to 16 concurrent generations are retained at any time (``<N>`` is always on the interval [0,16])
Review comment:
> Did you copy that from another endpoint? It looks familiar, so it might be wrong there, too.
Yep, ripped straight from [deliveryservices_xmlid_xmlid_urlkeys.rst](https://github.com/apache/trafficcontrol/blob/93520432ec/docs/source/api/v2/deliveryservices_xmlid_xmlid_urlkeys.rst#response-structure).
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384060471
##########
File path: docs/source/api/v2/deliveryservice_requests.rst
##########
@@ -0,0 +1,767 @@
+..
+..
+.. 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-deliveryservice-requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`.
+
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+==========================================================================================+
+ | assignee | no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this username. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | assigneeId| no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | author | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this username |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | authorId | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | changeType| no | Filter for :ref:`ds_requests` of the change type specified. |
+ | | | Can be ``create``, ``update``, or ``delete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | id | no | Filter for the :ref:`Delivery Service Request <ds_requests>` identified by this |
+ | | | integral, unique identifier. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | status | no | Filter for :ref:`ds_requests` whose status is the status |
+ | | | specified. The status can be ``draft``, ``submitted``, ``pending``, ``rejected``, or |
+ | | | ``complete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | xmlId | no | Filter for :ref:`ds_requests` that have the given |
+ | | | :ref:`ds-xmlid`. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservice_requests?status=draft HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:lastUpdated: The date and time at which the :term:`DSR <Delivery Service Request>` was last updated, in ISO format.
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 20:14:07 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: UBp3nklJr2x2cAW/TKbhXMVJH6+OduxUaEBGbX4P7IahDk3VkaTd9LsQj01zgFEnZLwHrikpwFfNlUO32RAZOA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 19:14:07 GMT
+ Content-Length: 872
+
+ {
+ "response": [
+ {
+ "authorId": 2,
+ "author": "admin",
+ "changeType": "update",
+ "createdAt": "2020-02-24 19:11:12+00",
+ "id": 1,
+ "lastEditedBy": "admin",
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-24 19:11:12+00",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "0001-01-01 00:00:00+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "draft"
+ }
+ ]
+ }
+
+.. _to-api-deliveryservice-requests-post:
+
+``POST``
+========
+
+.. note:: This route does NOT do the same thing as :ref:`POST deliveryservices/request <to-api-deliveryservices-request>`.
+
+Creates a new :term:`Delivery Service Request`.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+:changeType: The action that you want to perform on the delivery service. It can be "create", "update", or "delete".
+:status: The status of your request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+:deliveryService: The :term:`Delivery Service` that you have submitted for review as part of this request.
+
+.. code-block:: http
+ :caption: Request Example
+
+ POST /api/2.0/deliveryservice_requests HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 1979
+
+ {
+ "changeType": "update",
+ "status": "draft",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2020-02-13 16:43:54+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ }
+ }
+
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:lastUpdated: The date and time at which the :term:`DSR <Delivery Service Request>` was last updated, in ISO format.
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 20:11:12 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: aWIrFTwUGnLq56WNZPL/FgOi/NwAVUtOy4iqjFPwx4gj7RMZ6+nd++bQKIiasBl8ytAY0WmFvNnmm30Fq9mLpA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 19:11:12 GMT
+ Content-Length: 901
+
+ {
+ "alerts": [
+ {
+ "text": "deliveryservice_request was created.",
+ "level": "success"
+ }
+ ],
+ "response": {
+ "authorId": 2,
+ "author": null,
+ "changeType": "update",
+ "createdAt": null,
+ "id": 1,
+ "lastEditedBy": null,
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-24 19:11:12+00",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "0001-01-01 00:00:00+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "draft"
+ }
+ }
+
+``PUT``
+=======
+
+Updates an existing :ref:`Delivery Service Request <ds_requests>`.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
Review comment:
nit but alignment is off on these fields
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384066140
##########
File path: docs/source/api/v2/servers_id_deliveryservices.rst
##########
@@ -239,3 +239,81 @@ Response Structure
.. [#tenancy] Only the :term:`Delivery Services` visible to the requesting user's :term:`Tenant` will appear, regardless of their :term:`Role` or the :term:`Delivery Services`' actual 'server assignment' status.
+
+``POST``
+========
+Assign an arbitrary number of delivery services to a single server.
Review comment:
Doesn't need to be linked again, but should be "Delivery Services" not "delivery services"
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386157009
##########
File path: docs/source/api/v2/steering.rst
##########
@@ -0,0 +1,97 @@
+..
+..
+.. 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-steering:
+
+************
+``steering``
+************
+
+``GET``
+=======
+Gets a list of all :ref:`Steering Targets <steering-qht>` in the Traffic Ops database.
+
+:Auth. Required: Yes
+:Roles Required: "Portal", "Steering", "Federation", "operations" or "admin"
+:Response Type: Array
+
+Request Structure
+-----------------
+No parameters available.
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/steering HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:deliveryService: A string that is the :ref:`ds-xmlid` of the steering :term:`Delivery Service`
+:clientSteering: Whether this is a :ref:`client steering <ds-client-steering>` delivery service.
+:targets: The delivery services that the steering delivery service targets.
+:filters: Filters of type :ref:`STEERING_REGEXP <ds-steering-regexp>` that exist on either of the targets.
Review comment:
Sub-property definitions added in dd903c8f01.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] mhoppa commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
mhoppa commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r383923674
##########
File path: docs/source/api/v2/riak_ping.rst
##########
@@ -0,0 +1,66 @@
+..
+..
+.. 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-riak-ping:
+
+*********************************************
+``riak/ping``
+*********************************************
Review comment:
same here
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384054850
##########
File path: docs/source/api/v2/cdns_dnsseckeys_generate.rst
##########
@@ -0,0 +1,79 @@
+..
+..
+.. 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-cdns-dnsseckeys-generate:
+
+****************************
+``cdns/dnsseckeys/generate``
+****************************
+
+``POST``
+========
+Generates :abbr:`ZSK (Zone-Signing Key)` and :abbr:`KSK (Key-Signing Key)` keypairs for a CDN and all associated :term:`Delivery Services`.
+
+:Auth. Required: Yes
+:Roles Required: "admin"
+:Response Type: Object (string)
+
+Request Structure
+-----------------
+:effectiveDate: UNIX epoch start date for the signing keys
Review comment:
nit but this should align with the other fields
also, is this in seconds, milliseconds, or nanoseconds? It's also missing from the request example - optional? If so, what's the default?
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r383951233
##########
File path: docs/source/api/v2/about.rst
##########
@@ -0,0 +1,73 @@
+..
+..
+.. 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-about:
+
+***********
+``about``
+***********
+
+``GET``
+=======
+
+.. versionadded:: 1.3
Review comment:
Removed versionadded in aa00b978b0.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386121887
##########
File path: docs/source/api/v2/cdns_dnsseckeys_generate.rst
##########
@@ -0,0 +1,79 @@
+..
+..
+.. 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-cdns-dnsseckeys-generate:
+
+****************************
+``cdns/dnsseckeys/generate``
+****************************
+
+``POST``
+========
+Generates :abbr:`ZSK (Zone-Signing Key)` and :abbr:`KSK (Key-Signing Key)` keypairs for a CDN and all associated :term:`Delivery Services`.
+
+:Auth. Required: Yes
+:Roles Required: "admin"
+:Response Type: Object (string)
+
+Request Structure
+-----------------
+:effectiveDate: UNIX epoch start date for the signing keys
Review comment:
Field aligned in 8d99deb8fd.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386177250
##########
File path: docs/source/api/v2/riak_bucket_bucket_key_key_values.rst
##########
@@ -0,0 +1,84 @@
+..
+..
+.. 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-riak-bucket-bucket-key-key-values:
+
+*********************************************
+``riak/bucket/{{bucket}}/key/{{key}}/values``
+*********************************************
+Retrieves the `object <https://docs.riak.com/riak/kv/latest/learn/concepts/keys-and-objects/index.html#objects>`_ stored under a given `key <https://docs.riak.com/riak/kv/latest/learn/concepts/keys-and-objects/index.html#keys>`_ from a given `bucket <https://docs.riak.com/riak/kv/latest/learn/concepts/buckets/index.html>`_ in :ref:`tv-overview`.
+
+``GET``
+=======
+:Auth. Required: Yes
+:Roles Required: "admin"
+:Response Type: Object
+
+Request Structure
+-----------------
+.. table:: Request Path Parameters
+
+ +--------+------------------------------------------+
+ | Name | Description |
+ +========+==========================================+
+ | bucket | The bucket that the key is stored under |
+ +--------+------------------------------------------+
+ | key | The key that the object is stored under |
+ +--------+------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/riak/bucket/ssl/key/demo1-latest/values HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+The response structure varies according to what is stored.
Review comment:
Specified restrictions in 0d68da42bd.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384060251
##########
File path: docs/source/api/v2/deliveryservice_requests.rst
##########
@@ -0,0 +1,767 @@
+..
+..
+.. 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-deliveryservice-requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`.
+
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+==========================================================================================+
+ | assignee | no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this username. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | assigneeId| no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | author | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this username |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | authorId | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | changeType| no | Filter for :ref:`ds_requests` of the change type specified. |
+ | | | Can be ``create``, ``update``, or ``delete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | id | no | Filter for the :ref:`Delivery Service Request <ds_requests>` identified by this |
+ | | | integral, unique identifier. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | status | no | Filter for :ref:`ds_requests` whose status is the status |
+ | | | specified. The status can be ``draft``, ``submitted``, ``pending``, ``rejected``, or |
+ | | | ``complete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | xmlId | no | Filter for :ref:`ds_requests` that have the given |
+ | | | :ref:`ds-xmlid`. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservice_requests?status=draft HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:lastUpdated: The date and time at which the :term:`DSR <Delivery Service Request>` was last updated, in ISO format.
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 20:14:07 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: UBp3nklJr2x2cAW/TKbhXMVJH6+OduxUaEBGbX4P7IahDk3VkaTd9LsQj01zgFEnZLwHrikpwFfNlUO32RAZOA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 19:14:07 GMT
+ Content-Length: 872
+
+ {
+ "response": [
+ {
+ "authorId": 2,
+ "author": "admin",
+ "changeType": "update",
+ "createdAt": "2020-02-24 19:11:12+00",
+ "id": 1,
+ "lastEditedBy": "admin",
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-24 19:11:12+00",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "0001-01-01 00:00:00+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "draft"
+ }
+ ]
+ }
+
+.. _to-api-deliveryservice-requests-post:
+
+``POST``
+========
+
+.. note:: This route does NOT do the same thing as :ref:`POST deliveryservices/request <to-api-deliveryservices-request>`.
+
+Creates a new :term:`Delivery Service Request`.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+:changeType: The action that you want to perform on the delivery service. It can be "create", "update", or "delete".
+:status: The status of your request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+:deliveryService: The :term:`Delivery Service` that you have submitted for review as part of this request.
+
+.. code-block:: http
+ :caption: Request Example
+
+ POST /api/2.0/deliveryservice_requests HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 1979
+
+ {
+ "changeType": "update",
+ "status": "draft",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2020-02-13 16:43:54+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ }
+ }
+
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
Review comment:
sub-property definitions?
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386152963
##########
File path: docs/source/api/v2/servers_details.rst
##########
@@ -0,0 +1,117 @@
+..
+..
+.. 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-servers-details:
+
+*******************
+``servers/details``
+*******************
+Retrieves details of :ref:`tp-configure-servers`.
+
+
+``GET``
+=======
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +----------------+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +================+========================================+================================================================================================================================================================+
+ | hostName | Required if no physLocationID provided | Return only the servers with this (short) hostname. Capitalization of "hostName" is important. |
+ +----------------+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | physLocationID | Required if no hostName provided | Return only servers with this integral, unique identifier for the physical location where the server resides. Capitalization of "physLocationID" is important. |
+ +----------------+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/servers/details?hostName=edge HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+
Review comment:
Field definitions and non-response properties added in 6d4154ac02.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384059761
##########
File path: docs/source/api/v2/deliveryservice_requests.rst
##########
@@ -0,0 +1,767 @@
+..
+..
+.. 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-deliveryservice-requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`.
+
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+==========================================================================================+
+ | assignee | no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this username. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | assigneeId| no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | author | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this username |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | authorId | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | changeType| no | Filter for :ref:`ds_requests` of the change type specified. |
+ | | | Can be ``create``, ``update``, or ``delete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | id | no | Filter for the :ref:`Delivery Service Request <ds_requests>` identified by this |
+ | | | integral, unique identifier. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | status | no | Filter for :ref:`ds_requests` whose status is the status |
+ | | | specified. The status can be ``draft``, ``submitted``, ``pending``, ``rejected``, or |
+ | | | ``complete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | xmlId | no | Filter for :ref:`ds_requests` that have the given |
+ | | | :ref:`ds-xmlid`. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservice_requests?status=draft HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:lastUpdated: The date and time at which the :term:`DSR <Delivery Service Request>` was last updated, in ISO format.
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 20:14:07 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: UBp3nklJr2x2cAW/TKbhXMVJH6+OduxUaEBGbX4P7IahDk3VkaTd9LsQj01zgFEnZLwHrikpwFfNlUO32RAZOA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 19:14:07 GMT
+ Content-Length: 872
+
+ {
+ "response": [
+ {
+ "authorId": 2,
+ "author": "admin",
+ "changeType": "update",
+ "createdAt": "2020-02-24 19:11:12+00",
+ "id": 1,
+ "lastEditedBy": "admin",
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-24 19:11:12+00",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "0001-01-01 00:00:00+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "draft"
+ }
+ ]
+ }
+
+.. _to-api-deliveryservice-requests-post:
+
+``POST``
+========
+
+.. note:: This route does NOT do the same thing as :ref:`POST deliveryservices/request <to-api-deliveryservices-request>`.
+
+Creates a new :term:`Delivery Service Request`.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+:changeType: The action that you want to perform on the delivery service. It can be "create", "update", or "delete".
+:status: The status of your request. Can be "draft", "submitted", "rejected", "pending", or "complete".
Review comment:
nit but alignment is off here
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386121955
##########
File path: docs/source/api/v2/deliveryservice_requests.rst
##########
@@ -0,0 +1,767 @@
+..
+..
+.. 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-deliveryservice-requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`.
+
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+==========================================================================================+
+ | assignee | no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this username. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | assigneeId| no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | author | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this username |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | authorId | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | changeType| no | Filter for :ref:`ds_requests` of the change type specified. |
+ | | | Can be ``create``, ``update``, or ``delete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | id | no | Filter for the :ref:`Delivery Service Request <ds_requests>` identified by this |
+ | | | integral, unique identifier. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | status | no | Filter for :ref:`ds_requests` whose status is the status |
+ | | | specified. The status can be ``draft``, ``submitted``, ``pending``, ``rejected``, or |
+ | | | ``complete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | xmlId | no | Filter for :ref:`ds_requests` that have the given |
+ | | | :ref:`ds-xmlid`. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservice_requests?status=draft HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:lastUpdated: The date and time at which the :term:`DSR <Delivery Service Request>` was last updated, in ISO format.
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 20:14:07 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: UBp3nklJr2x2cAW/TKbhXMVJH6+OduxUaEBGbX4P7IahDk3VkaTd9LsQj01zgFEnZLwHrikpwFfNlUO32RAZOA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 19:14:07 GMT
+ Content-Length: 872
+
+ {
+ "response": [
+ {
+ "authorId": 2,
+ "author": "admin",
+ "changeType": "update",
+ "createdAt": "2020-02-24 19:11:12+00",
+ "id": 1,
+ "lastEditedBy": "admin",
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-24 19:11:12+00",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "0001-01-01 00:00:00+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "draft"
+ }
+ ]
+ }
+
+.. _to-api-deliveryservice-requests-post:
+
+``POST``
+========
+
+.. note:: This route does NOT do the same thing as :ref:`POST deliveryservices/request <to-api-deliveryservices-request>`.
+
+Creates a new :term:`Delivery Service Request`.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+:changeType: The action that you want to perform on the delivery service. It can be "create", "update", or "delete".
+:status: The status of your request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+:deliveryService: The :term:`Delivery Service` that you have submitted for review as part of this request.
+
+.. code-block:: http
+ :caption: Request Example
+
+ POST /api/2.0/deliveryservice_requests HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 1979
+
+ {
+ "changeType": "update",
+ "status": "draft",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2020-02-13 16:43:54+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ }
+ }
+
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:lastUpdated: The date and time at which the :term:`DSR <Delivery Service Request>` was last updated, in ISO format.
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 20:11:12 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: aWIrFTwUGnLq56WNZPL/FgOi/NwAVUtOy4iqjFPwx4gj7RMZ6+nd++bQKIiasBl8ytAY0WmFvNnmm30Fq9mLpA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 19:11:12 GMT
+ Content-Length: 901
+
+ {
+ "alerts": [
+ {
+ "text": "deliveryservice_request was created.",
+ "level": "success"
+ }
+ ],
+ "response": {
+ "authorId": 2,
+ "author": null,
+ "changeType": "update",
+ "createdAt": null,
+ "id": 1,
+ "lastEditedBy": null,
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-24 19:11:12+00",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "0001-01-01 00:00:00+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "draft"
+ }
+ }
+
+``PUT``
+=======
+
+Updates an existing :ref:`Delivery Service Request <ds_requests>`.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+
+.. table:: Request Query Parameters
+
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+==========================================================================================+
+ | id | yes | The integral, unique identifier of the :ref:`Delivery Service Request <ds_requests>` that|
+ | | | you want to update. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ PUT /api/2.0/deliveryservice_requests?id=1 HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 2256
+
+ {
+ "authorId": 2,
+ "author": "admin",
+ "changeType": "update",
+ "createdAt": "2020-02-24 19:11:12+00",
+ "id": 1,
+ "lastEditedBy": "admin",
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-24 19:33:26+00",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "0001-01-01 00:00:00+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": "",
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "submitted"
+ }
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:lastUpdated: The date and time at which the :term:`DSR <Delivery Service Request>` was last updated, in ISO format.
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
Review comment:
Fields aligned in 8d99deb8fd.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384056339
##########
File path: docs/source/api/v2/deliveryservice_request_comments.rst
##########
@@ -0,0 +1,296 @@
+..
+..
+.. 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-deliveryservice_request_comments:
+
+************************************
+``deliveryservice_request_comments``
+************************************
+
+``GET``
+=======
+Gets delivery service request comments.
+
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+
+.. table:: Request Query Parameters
+
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +==========================+==========+=====================================================================================================================================================+
+ | author | no | Filter for :ref:`Delivery Service Request <ds_requests>` comments submitted by the user identified by this username |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Filter for :ref:`Delivery Service Request <ds_requests>` comments submitted by the user identified by this integral, unique identifier |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | deliveryServiceRequestId | no | Filter for :ref:`Delivery Service Request <ds_requests>` comments submitted for the delivery service identified by this integral, unique identifier |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Filter for the :ref:`Delivery Service Request <ds_requests>` comment identified by this integral, unique identifier |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservice_request_comments HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 21:00:26 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: RaJZS1XFJ4oIxVKyyDjTuoQY7gPOmm5EuIL4AgHpyQpuaaNviw0XhGC4V/AKf/Ws6zXLgIUc4OyvMsTxnrilww==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 20:00:26 GMT
+ Content-Length: 207
+
+ {
+ "response": [
+ {
+ "authorId": 2,
+ "author": "admin",
+ "deliveryServiceRequestId": 2,
+ "id": 3,
+ "lastUpdated": "2020-02-24 19:59:46+00",
+ "value": "Changing to a different origin for now.",
+ "xmlId": "demo1"
+ },
+ {
+ "authorId": 2,
+ "author": "admin",
+ "deliveryServiceRequestId": 2,
+ "id": 4,
+ "lastUpdated": "2020-02-24 19:59:55+00",
+ "value": "Using HTTPS.",
+ "xmlId": "demo1"
+ }
+ ]
+ }
+
+``POST``
+========
+Allows user to create a :term:`Delivery Service Request` comment.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+
+.. code-block:: http
+ :caption: Request Example
+
+ POST /api/2.0/deliveryservice_request_comments HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 111
+
+ {
+ "deliveryServiceRequestId": 2,
+ "value": "Does anyone have time to review my delivery service request?"
+ }
+
+Response Structure
+------------------
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 21:02:20 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: LiakFP6L7PrnFO5kLXftx7WQoKn3bGpIJT5N15PvNG2sHridRMV3k23eRJM66ET0LcRfMOrQgRiydE+XgA8h0A==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 20:02:20 GMT
+ Content-Length: 223
+
+ {
+ "alerts": [
+ {
+ "text": "deliveryservice_request_comment was created.",
+ "level": "success"
+ }
+ ],
+ "response": {
+ "authorId": 2,
+ "author": null,
+ "deliveryServiceRequestId": 2,
+ "id": 6,
+ "lastUpdated": "2020-02-24 20:02:20+00",
+ "value": "Does anyone have time to review my delivery service request?",
+ "xmlId": null
+ }
+ }
+
+``PUT``
+=======
+
+Updates a delivery service request comment.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+
+Request Structure
+-----------------
+
+.. table:: Request Query Parameters
+
+ +-----------+----------+-----------------------------------------------------------------------------------+
+ | Parameter | Required | Description |
+ +===========+==========+===================================================================================+
+ | id | yes | The integral, unique identifier of the delivery service comment that you wish to |
+ | | | update. |
+ +-----------+----------+-----------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ PUT /api/2.0/deliveryservice_request_comments?id=6 HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 166
+
+ {
+ "deliveryServiceRequestId": 2,
+ "value": "Update: We no longer need this, feel free to reject.\n\nDoes anyone have time to review my delivery service request?"
+ }
+
+Response Structure
+------------------
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 21:05:46 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: RalS34imPw7c42nlnu5eTuv6FSxuGcAvxEdeIyNma1zpE3ZojAMFbhj8qi1s+hOVDYybfFPzMz82c+xc1qrMHg==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 20:05:46 GMT
+ Content-Length: 255
+
+ {
+ "alerts": [
+ {
+ "text": "deliveryservice_request_comment was updated.",
+ "level": "success"
+ }
+ ],
+ "response": {
+ "authorId": null,
+ "author": null,
+ "deliveryServiceRequestId": 2,
+ "id": 6,
+ "lastUpdated": "2020-02-24 20:05:46+00",
+ "value": "Update: We no longer need this, feel free to reject.\n\nDoes anyone have time to review my delivery service request?",
+ "xmlId": null
+ }
+ }
+
+``DELETE``
+==========
+
+Deletes a delivery service request comment.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: ``undefined``
+
+Request Structure
+-----------------
+
+.. code-block:: http
+ :caption: Request Example
+
+ DELETE /api/2.0/deliveryservice_request_comments?id=6 HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 0
+
+Response Structure
+------------------
+
+.. table:: Request Query Parameters
Review comment:
Request query parameters should go in the "Request Structure" section
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384059281
##########
File path: docs/source/api/v2/deliveryservice_requests.rst
##########
@@ -0,0 +1,767 @@
+..
+..
+.. 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-deliveryservice-requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`.
+
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+==========================================================================================+
+ | assignee | no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this username. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | assigneeId| no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | author | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this username |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | authorId | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | changeType| no | Filter for :ref:`ds_requests` of the change type specified. |
+ | | | Can be ``create``, ``update``, or ``delete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | id | no | Filter for the :ref:`Delivery Service Request <ds_requests>` identified by this |
+ | | | integral, unique identifier. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | status | no | Filter for :ref:`ds_requests` whose status is the status |
+ | | | specified. The status can be ``draft``, ``submitted``, ``pending``, ``rejected``, or |
+ | | | ``complete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | xmlId | no | Filter for :ref:`ds_requests` that have the given |
+ | | | :ref:`ds-xmlid`. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservice_requests?status=draft HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:lastUpdated: The date and time at which the :term:`DSR <Delivery Service Request>` was last updated, in ISO format.
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
Review comment:
nit but alignment is off here
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386157001
##########
File path: docs/source/api/v2/deliveryservice_requests.rst
##########
@@ -0,0 +1,767 @@
+..
+..
+.. 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-deliveryservice-requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`.
+
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+==========================================================================================+
+ | assignee | no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this username. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | assigneeId| no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | author | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this username |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | authorId | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | changeType| no | Filter for :ref:`ds_requests` of the change type specified. |
+ | | | Can be ``create``, ``update``, or ``delete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | id | no | Filter for the :ref:`Delivery Service Request <ds_requests>` identified by this |
+ | | | integral, unique identifier. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | status | no | Filter for :ref:`ds_requests` whose status is the status |
+ | | | specified. The status can be ``draft``, ``submitted``, ``pending``, ``rejected``, or |
+ | | | ``complete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | xmlId | no | Filter for :ref:`ds_requests` that have the given |
+ | | | :ref:`ds-xmlid`. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservice_requests?status=draft HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:lastUpdated: The date and time at which the :term:`DSR <Delivery Service Request>` was last updated, in ISO format.
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 20:14:07 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: UBp3nklJr2x2cAW/TKbhXMVJH6+OduxUaEBGbX4P7IahDk3VkaTd9LsQj01zgFEnZLwHrikpwFfNlUO32RAZOA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 19:14:07 GMT
+ Content-Length: 872
+
+ {
+ "response": [
+ {
+ "authorId": 2,
+ "author": "admin",
+ "changeType": "update",
+ "createdAt": "2020-02-24 19:11:12+00",
+ "id": 1,
+ "lastEditedBy": "admin",
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-24 19:11:12+00",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "0001-01-01 00:00:00+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "draft"
+ }
+ ]
+ }
+
+.. _to-api-deliveryservice-requests-post:
+
+``POST``
+========
+
+.. note:: This route does NOT do the same thing as :ref:`POST deliveryservices/request <to-api-deliveryservices-request>`.
+
+Creates a new :term:`Delivery Service Request`.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+:changeType: The action that you want to perform on the delivery service. It can be "create", "update", or "delete".
+:status: The status of your request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+:deliveryService: The :term:`Delivery Service` that you have submitted for review as part of this request.
+
+.. code-block:: http
+ :caption: Request Example
+
+ POST /api/2.0/deliveryservice_requests HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 1979
+
+ {
+ "changeType": "update",
+ "status": "draft",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2020-02-13 16:43:54+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ }
+ }
+
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:lastUpdated: The date and time at which the :term:`DSR <Delivery Service Request>` was last updated, in ISO format.
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 20:11:12 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: aWIrFTwUGnLq56WNZPL/FgOi/NwAVUtOy4iqjFPwx4gj7RMZ6+nd++bQKIiasBl8ytAY0WmFvNnmm30Fq9mLpA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 19:11:12 GMT
+ Content-Length: 901
+
+ {
+ "alerts": [
+ {
+ "text": "deliveryservice_request was created.",
+ "level": "success"
+ }
+ ],
+ "response": {
+ "authorId": 2,
+ "author": null,
+ "changeType": "update",
+ "createdAt": null,
+ "id": 1,
+ "lastEditedBy": null,
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-24 19:11:12+00",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "0001-01-01 00:00:00+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "draft"
+ }
+ }
+
+``PUT``
+=======
+
+Updates an existing :ref:`Delivery Service Request <ds_requests>`.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+
+.. table:: Request Query Parameters
+
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+==========================================================================================+
+ | id | yes | The integral, unique identifier of the :ref:`Delivery Service Request <ds_requests>` that|
+ | | | you want to update. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ PUT /api/2.0/deliveryservice_requests?id=1 HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 2256
+
+ {
+ "authorId": 2,
+ "author": "admin",
+ "changeType": "update",
+ "createdAt": "2020-02-24 19:11:12+00",
+ "id": 1,
+ "lastEditedBy": "admin",
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-24 19:33:26+00",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "0001-01-01 00:00:00+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": "",
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "submitted"
+ }
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
Review comment:
Sub-property definitions added in dd903c8f01.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386120591
##########
File path: traffic_control/clients/python/trafficops/tosession.py
##########
@@ -866,6 +866,17 @@ def assign_deliveryservice_servers_by_names(self, xml_id=None, data=None):
:raises: Union[LoginError, OperationError]
"""
+ @api_request(u'post', u'deliveryservice_requests', ('2.0',))
Review comment:
Okay, removed in 91194ac018. The only real change to the Python client for TO is the route and docs reference rename in eaeeba7fce to avoid the "undefined label" warning that you would otherwise get building the docs:
```
/home/zrhoffman/go/src/github.com/apache/trafficcontrol/traffic_control/clients/python/trafficops/tosession.py:docstring of trafficops.TOSession.create_cdn_dns_sec_keys:1: WARNING: undefined label: to-api-deliveryservices-dnsseckeys-generate (if the link has no caption the label must precede a section header)
```
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384068001
##########
File path: docs/source/api/v2/steering.rst
##########
@@ -0,0 +1,97 @@
+..
+..
+.. 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-steering:
+
+************
+``steering``
+************
+
+``GET``
+=======
+Gets a list of all :ref:`Steering Targets <steering-qht>` in the Traffic Ops database.
+
+:Auth. Required: Yes
+:Roles Required: "Portal", "Steering", "Federation", "operations" or "admin"
+:Response Type: Array
+
+Request Structure
+-----------------
+No parameters available.
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/steering HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:deliveryService: A string that is the :ref:`ds-xmlid` of the steering :term:`Delivery Service`
+:clientSteering: Whether this is a :ref:`client steering <ds-client-steering>` delivery service.
+:targets: The delivery services that the steering delivery service targets.
+:filters: Filters of type :ref:`STEERING_REGEXP <ds-steering-regexp>` that exist on either of the targets.
Review comment:
nit but this field list isn't aligned
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r383951359
##########
File path: docs/source/api/v2/deliveryservice_requests_id_status.rst
##########
@@ -0,0 +1,177 @@
+..
+..
+.. 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-deliveryservice_requests-id-status:
+
+******************************************
+``deliveryservice_requests/{{ID}}/assign``
+******************************************
+Sets the status of a :term:`Delivery Service Request`.
+
+``GET``
Review comment:
Updated section heading to PUT in aa00b978b0.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r399464083
##########
File path: docs/source/api/v2/asns.rst
##########
@@ -133,11 +133,11 @@ Request Structure
Response Structure
------------------
-:asn: An :abbr:`ASN (Autonomous System Number)` as specified by IANA for identifying a service provider
-:cachegroup: A string that is the :ref:`cache-group-name` of the :term:`Cache Group` that is associated with this :abbr:`ASN (Autonomous System Number)`
-:cachegroupId: An integer that is the :ref:`cache-group-id` of the :term:`Cache Group` that is associated with this :abbr:`ASN (Autonomous System Number)`
-:id: An integral, unique identifier for this association between an :abbr:`ASN (Autonomous System Number)` and a :term:`Cache Group`
-:lastUpdated: The time and date this server entry was last updated in an ISO-like format
+:asn: An :abbr:`ASN (Autonomous System Number)` as specified by IANA for identifying a service provider
+:cachegroup: A string that is the :ref:`cache-group-name` of the :term:`Cache Group` that is associated with this :abbr:`ASN (Autonomous System Number)`
+:cachegroupId: An integer that is the :ref:`cache-group-id` of the :term:`Cache Group` that is associated with this :abbr:`ASN (Autonomous System Number)`
+:id: An integral, unique identifier for this association between an :abbr:`ASN (Autonomous System Number)` and a :term:`Cache Group`
+:lastUpdated: The time and date this server entry was last updated in an ISO-like format
Review comment:
... and here. I'm just gonna stop pointing it out because I get the feeling this review will become insanely long.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386157938
##########
File path: docs/source/api/v2/types.rst
##########
@@ -82,3 +82,70 @@ Response Structure
"useInTable": "cachegroup"
}
]}
+
+========
Review comment:
Removed heading overline in 8fe4ab7d06.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384055481
##########
File path: docs/source/api/v2/deliveryservice_request_comments.rst
##########
@@ -0,0 +1,296 @@
+..
+..
+.. 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-deliveryservice_request_comments:
+
+************************************
+``deliveryservice_request_comments``
+************************************
+
+``GET``
+=======
+Gets delivery service request comments.
+
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+
+.. table:: Request Query Parameters
+
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +==========================+==========+=====================================================================================================================================================+
+ | author | no | Filter for :ref:`Delivery Service Request <ds_requests>` comments submitted by the user identified by this username |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Filter for :ref:`Delivery Service Request <ds_requests>` comments submitted by the user identified by this integral, unique identifier |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | deliveryServiceRequestId | no | Filter for :ref:`Delivery Service Request <ds_requests>` comments submitted for the delivery service identified by this integral, unique identifier |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Filter for the :ref:`Delivery Service Request <ds_requests>` comment identified by this integral, unique identifier |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservice_request_comments HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 21:00:26 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: RaJZS1XFJ4oIxVKyyDjTuoQY7gPOmm5EuIL4AgHpyQpuaaNviw0XhGC4V/AKf/Ws6zXLgIUc4OyvMsTxnrilww==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 20:00:26 GMT
+ Content-Length: 207
+
+ {
+ "response": [
+ {
+ "authorId": 2,
+ "author": "admin",
+ "deliveryServiceRequestId": 2,
+ "id": 3,
+ "lastUpdated": "2020-02-24 19:59:46+00",
+ "value": "Changing to a different origin for now.",
+ "xmlId": "demo1"
+ },
+ {
+ "authorId": 2,
+ "author": "admin",
+ "deliveryServiceRequestId": 2,
+ "id": 4,
+ "lastUpdated": "2020-02-24 19:59:55+00",
+ "value": "Using HTTPS.",
+ "xmlId": "demo1"
+ }
+ ]
+ }
+
+``POST``
+========
+Allows user to create a :term:`Delivery Service Request` comment.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+
Review comment:
Request field definitions?
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386152969
##########
File path: docs/source/api/v2/servers_id_deliveryservices.rst
##########
@@ -239,3 +239,81 @@ Response Structure
.. [#tenancy] Only the :term:`Delivery Services` visible to the requesting user's :term:`Tenant` will appear, regardless of their :term:`Role` or the :term:`Delivery Services`' actual 'server assignment' status.
+
+``POST``
+========
+Assign an arbitrary number of delivery services to a single server.
+
+:Auth. Required: Yes
+:Roles Required: "admin" or "operations"
+:Response Type: Object
+
+Request Structure
+-----------------
+.. table:: Request Path Parameters
+
+ +------+----------+---------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +------+----------+---------------------------------------------------------------------------------------------+
+ | id | Yes | The integral, unique identifier of the server that you want to assign delivery services to. |
+ +------+----------+---------------------------------------------------------------------------------------------+
+
+.. table:: Request Query Parameters
+
+ +---------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=========+==========+==========================================================================================+
+ | replace | Yes | Must be a 1, true, 0, or false. Although this query parameter is required, it is unused. |
+ +---------+----------+------------------------------------------------------------------------------------------+
+
+The request body is an array of IDs of delivery services that you want to assign to the server. The array can be empty, but it must be provided.
+
+.. code-block:: http
+ :caption: Request Example
+
+ POST /api/2.0/servers/6/deliveryservices?replace=1 HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 3
+
+ [
+ 1
+ ]
+
+Response Structure
+------------------
+
Review comment:
Field definitions added in 6d4154ac02.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r409164755
##########
File path: docs/source/api/v2/ping.rst
##########
@@ -0,0 +1,63 @@
+..
+..
+.. 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-ping:
+
+********
+``ping``
+********
+Checks whether Traffic Ops is online.
+
+``GET``
+=======
+:Auth. Required: No
+:Response Type: ``undefined``
+
+Request Structure
+-----------------
+No parameters available.
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/ping HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:ping: Returns an object containing only the ``"ping" property, which always has the value ``"pong"``.
Review comment:
Added the missing <kbd>`</kbd> in ed7fdd15d5.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r409200593
##########
File path: docs/source/api/v2/deliveryservices_id_urlkeys.rst
##########
@@ -0,0 +1,93 @@
+..
+..
+.. 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-deliveryservices-id-urlkeys:
+
+***********************************
+``deliveryservices/{{ID}}/urlkeys``
+***********************************
+
+``GET``
+=======
+.. seealso:: :ref:`to-api-deliveryservices-xmlid-xmlid-urlkeys`
+
+Retrieves URL signing keys for a :term:`Delivery Service`.
+
+.. caution:: This method will return the :term:`Delivery Service`'s **PRIVATE** URL signing keys! Be wary of using this endpoint and **NEVER** share the output with anyone who would be unable to see it on their own.
+
+:Auth. Required: Yes
+:Roles Required: None
+:Response Type: Object
+
+Request Structure
+-----------------
+.. table:: Request Path Parameters
+
+ +------+----------------------------------------------------------------------------------------+
+ | Name | Description |
+ +======+========================================================================================+
+ | id | Filter for the :term:`Delivery Service` identified by this integral, unique identifier |
+ +------+----------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservices/1/urlkeys HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:key<N>: The private URL signing key for this :term:`Delivery Service` as a base-64-encoded string, where ``<N>`` is the "generation" of the key e.g. the first key will always be named ``"key0"``. Up to 16 concurrent generations are retained at any time (``<N>`` is always on the interval [0,16])
Review comment:
Changed to `[0, 15]` in cb4e3b56e.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r399474646
##########
File path: docs/source/api/v2/ping.rst
##########
@@ -0,0 +1,63 @@
+..
+..
+.. 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-ping:
+
+********
+``ping``
+********
+Checks whether Traffic Ops is online.
+
+``GET``
+=======
+:Auth. Required: No
+:Response Type: ``undefined``
+
+Request Structure
+-----------------
+No parameters available.
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/ping HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:ping: Returns an object containing only the ``"ping" property, which always has the value ``"pong"``.
Review comment:
You're missing an ending double-grave accent (<kbd>\`</kbd>) after `"ping"` which is causing some weird interpretations of the rest of the file, along with a compile-time warning.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386156969
##########
File path: docs/source/api/v2/deliveryservice_requests.rst
##########
@@ -0,0 +1,767 @@
+..
+..
+.. 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-deliveryservice-requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`.
+
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+==========================================================================================+
+ | assignee | no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this username. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | assigneeId| no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | author | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this username |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | authorId | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | changeType| no | Filter for :ref:`ds_requests` of the change type specified. |
+ | | | Can be ``create``, ``update``, or ``delete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | id | no | Filter for the :ref:`Delivery Service Request <ds_requests>` identified by this |
+ | | | integral, unique identifier. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | status | no | Filter for :ref:`ds_requests` whose status is the status |
+ | | | specified. The status can be ``draft``, ``submitted``, ``pending``, ``rejected``, or |
+ | | | ``complete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | xmlId | no | Filter for :ref:`ds_requests` that have the given |
+ | | | :ref:`ds-xmlid`. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservice_requests?status=draft HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:lastUpdated: The date and time at which the :term:`DSR <Delivery Service Request>` was last updated, in ISO format.
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 20:14:07 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: UBp3nklJr2x2cAW/TKbhXMVJH6+OduxUaEBGbX4P7IahDk3VkaTd9LsQj01zgFEnZLwHrikpwFfNlUO32RAZOA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 19:14:07 GMT
+ Content-Length: 872
+
+ {
+ "response": [
+ {
+ "authorId": 2,
+ "author": "admin",
+ "changeType": "update",
+ "createdAt": "2020-02-24 19:11:12+00",
+ "id": 1,
+ "lastEditedBy": "admin",
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-24 19:11:12+00",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "0001-01-01 00:00:00+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "draft"
+ }
+ ]
+ }
+
+.. _to-api-deliveryservice-requests-post:
+
+``POST``
+========
+
+.. note:: This route does NOT do the same thing as :ref:`POST deliveryservices/request <to-api-deliveryservices-request>`.
+
+Creates a new :term:`Delivery Service Request`.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+:changeType: The action that you want to perform on the delivery service. It can be "create", "update", or "delete".
+:status: The status of your request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+:deliveryService: The :term:`Delivery Service` that you have submitted for review as part of this request.
Review comment:
Sub-property definitions added in dd903c8f01.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386164409
##########
File path: docs/source/api/v2/deliveryservice_request_comments.rst
##########
@@ -0,0 +1,296 @@
+..
+..
+.. 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-deliveryservice_request_comments:
+
+************************************
+``deliveryservice_request_comments``
+************************************
+
+``GET``
+=======
+Gets delivery service request comments.
+
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+
+.. table:: Request Query Parameters
+
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +==========================+==========+=====================================================================================================================================================+
+ | author | no | Filter for :ref:`Delivery Service Request <ds_requests>` comments submitted by the user identified by this username |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Filter for :ref:`Delivery Service Request <ds_requests>` comments submitted by the user identified by this integral, unique identifier |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | deliveryServiceRequestId | no | Filter for :ref:`Delivery Service Request <ds_requests>` comments submitted for the delivery service identified by this integral, unique identifier |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Filter for the :ref:`Delivery Service Request <ds_requests>` comment identified by this integral, unique identifier |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservice_request_comments HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 21:00:26 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: RaJZS1XFJ4oIxVKyyDjTuoQY7gPOmm5EuIL4AgHpyQpuaaNviw0XhGC4V/AKf/Ws6zXLgIUc4OyvMsTxnrilww==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 20:00:26 GMT
+ Content-Length: 207
+
+ {
+ "response": [
+ {
+ "authorId": 2,
+ "author": "admin",
+ "deliveryServiceRequestId": 2,
+ "id": 3,
+ "lastUpdated": "2020-02-24 19:59:46+00",
+ "value": "Changing to a different origin for now.",
+ "xmlId": "demo1"
+ },
+ {
+ "authorId": 2,
+ "author": "admin",
+ "deliveryServiceRequestId": 2,
+ "id": 4,
+ "lastUpdated": "2020-02-24 19:59:55+00",
+ "value": "Using HTTPS.",
+ "xmlId": "demo1"
+ }
+ ]
+ }
+
+``POST``
+========
+Allows user to create a :term:`Delivery Service Request` comment.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+
+.. code-block:: http
+ :caption: Request Example
+
+ POST /api/2.0/deliveryservice_request_comments HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 111
+
+ {
+ "deliveryServiceRequestId": 2,
+ "value": "Does anyone have time to review my delivery service request?"
+ }
+
+Response Structure
+------------------
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 21:02:20 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: LiakFP6L7PrnFO5kLXftx7WQoKn3bGpIJT5N15PvNG2sHridRMV3k23eRJM66ET0LcRfMOrQgRiydE+XgA8h0A==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 20:02:20 GMT
+ Content-Length: 223
+
+ {
+ "alerts": [
+ {
+ "text": "deliveryservice_request_comment was created.",
+ "level": "success"
+ }
+ ],
+ "response": {
+ "authorId": 2,
+ "author": null,
+ "deliveryServiceRequestId": 2,
+ "id": 6,
+ "lastUpdated": "2020-02-24 20:02:20+00",
+ "value": "Does anyone have time to review my delivery service request?",
+ "xmlId": null
+ }
+ }
+
+``PUT``
+=======
+
+Updates a delivery service request comment.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+
+Request Structure
+-----------------
+
+.. table:: Request Query Parameters
+
+ +-----------+----------+-----------------------------------------------------------------------------------+
+ | Parameter | Required | Description |
+ +===========+==========+===================================================================================+
+ | id | yes | The integral, unique identifier of the delivery service comment that you wish to |
+ | | | update. |
+ +-----------+----------+-----------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ PUT /api/2.0/deliveryservice_request_comments?id=6 HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 166
+
+ {
+ "deliveryServiceRequestId": 2,
+ "value": "Update: We no longer need this, feel free to reject.\n\nDoes anyone have time to review my delivery service request?"
+ }
+
+Response Structure
+------------------
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 21:05:46 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: RalS34imPw7c42nlnu5eTuv6FSxuGcAvxEdeIyNma1zpE3ZojAMFbhj8qi1s+hOVDYybfFPzMz82c+xc1qrMHg==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 20:05:46 GMT
+ Content-Length: 255
+
+ {
+ "alerts": [
+ {
+ "text": "deliveryservice_request_comment was updated.",
+ "level": "success"
+ }
+ ],
+ "response": {
+ "authorId": null,
+ "author": null,
+ "deliveryServiceRequestId": 2,
+ "id": 6,
+ "lastUpdated": "2020-02-24 20:05:46+00",
+ "value": "Update: We no longer need this, feel free to reject.\n\nDoes anyone have time to review my delivery service request?",
+ "xmlId": null
+ }
+ }
+
+``DELETE``
+==========
+
+Deletes a delivery service request comment.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: ``undefined``
+
+Request Structure
+-----------------
+
+.. code-block:: http
+ :caption: Request Example
+
+ DELETE /api/2.0/deliveryservice_request_comments?id=6 HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 0
+
+Response Structure
+------------------
+
+.. table:: Request Query Parameters
Review comment:
Moved to the correct section in 6d4154ac02.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386159047
##########
File path: docs/source/api/v2/deliveryservice_requests_id_status.rst
##########
@@ -0,0 +1,177 @@
+..
+..
+.. 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-deliveryservice_requests-id-status:
+
+******************************************
+``deliveryservice_requests/{{ID}}/assign``
+******************************************
+Sets the status of a :term:`Delivery Service Request`.
+
+``PUT``
+=======
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+
+.. code-block:: http
+ :caption: Request Example
+
+ PUT /api/2.0/deliveryservice_requests/1/status HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 28
+
+ {
+ "id": 1,
+ "status": "rejected"
+ }
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
Review comment:
Sub-property definitions added in 7bf700720b.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384099383
##########
File path: traffic_control/clients/python/trafficops/tosession.py
##########
@@ -866,6 +866,17 @@ def assign_deliveryservice_servers_by_names(self, xml_id=None, data=None):
:raises: Union[LoginError, OperationError]
"""
+ @api_request(u'post', u'deliveryservice_requests', ('2.0',))
Review comment:
Yeah, that's fair too.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r383951475
##########
File path: traffic_control/clients/python/trafficops/tosession.py
##########
@@ -866,6 +866,17 @@ def assign_deliveryservice_servers_by_names(self, xml_id=None, data=None):
:raises: Union[LoginError, OperationError]
"""
+ @api_request(u'post', u'deliveryservice_requests', (u'1.1', u'1.2', u'1.3', u'1.4', u'1.5'))
Review comment:
Unsupported in aa00b978b0.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384066498
##########
File path: docs/source/api/v2/servers_id_deliveryservices.rst
##########
@@ -239,3 +239,81 @@ Response Structure
.. [#tenancy] Only the :term:`Delivery Services` visible to the requesting user's :term:`Tenant` will appear, regardless of their :term:`Role` or the :term:`Delivery Services`' actual 'server assignment' status.
+
+``POST``
+========
+Assign an arbitrary number of delivery services to a single server.
+
+:Auth. Required: Yes
+:Roles Required: "admin" or "operations"
+:Response Type: Object
+
+Request Structure
+-----------------
+.. table:: Request Path Parameters
+
+ +------+----------+---------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +------+----------+---------------------------------------------------------------------------------------------+
+ | id | Yes | The integral, unique identifier of the server that you want to assign delivery services to. |
Review comment:
path parameter is listed as "ID" not "id"
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384058649
##########
File path: docs/source/api/v2/deliveryservice_requests_id_assign.rst
##########
@@ -0,0 +1,177 @@
+..
+..
+.. 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-deliveryservice_requests-id-assign:
+
+******************************************
+``deliveryservice_requests/{{ID}}/assign``
+******************************************
+Assign a :term:`Delivery Service Request` to a user.
+
+``PUT``
+=======
+:Auth. Required: Yes
+:Roles Required: "admin" or "operations"
+:Response Type: Object
+
+Request Structure
+-----------------
+
+.. code-block:: http
+ :caption: Request Example
+
+ PUT /api/2.0/deliveryservice_requests/1/assign HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 28
+
+ {
+ "id": 1,
+ "assigneeId": 2
+ }
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
Review comment:
"Delivery Service" is a `:term:`, should be linked at least the first time it appears on a page
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384056925
##########
File path: docs/source/api/v2/deliveryservice_requests_id_status.rst
##########
@@ -0,0 +1,177 @@
+..
+..
+.. 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-deliveryservice_requests-id-status:
+
+******************************************
+``deliveryservice_requests/{{ID}}/assign``
Review comment:
The section label, file name, descriptions and examples are all for `/deliveryservice_requests/{{ID}}/status`, not `/deliveryservice_requests/{{ID}}/assign`
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384064692
##########
File path: docs/source/api/v2/riak_bucket_bucket_key_key_values.rst
##########
@@ -0,0 +1,84 @@
+..
+..
+.. 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-riak-bucket-bucket-key-key-values:
+
+*********************************************
+``riak/bucket/{{bucket}}/key/{{key}}/values``
+*********************************************
+Retrieves the `object <https://docs.riak.com/riak/kv/latest/learn/concepts/keys-and-objects/index.html#objects>`_ stored under a given `key <https://docs.riak.com/riak/kv/latest/learn/concepts/keys-and-objects/index.html#keys>`_ from a given `bucket <https://docs.riak.com/riak/kv/latest/learn/concepts/buckets/index.html>`_ in :ref:`tv-overview`.
+
+``GET``
+=======
+:Auth. Required: Yes
+:Roles Required: "admin"
+:Response Type: Object
+
+Request Structure
+-----------------
+.. table:: Request Path Parameters
+
+ +--------+------------------------------------------+
+ | Name | Description |
+ +========+==========================================+
+ | bucket | The bucket that the key is stored under |
+ +--------+------------------------------------------+
+ | key | The key that the object is stored under |
+ +--------+------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/riak/bucket/ssl/key/demo1-latest/values HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+The response structure varies according to what is stored.
Review comment:
are there any restrictions, or is the set of response structures unbounded?
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384059860
##########
File path: docs/source/api/v2/deliveryservice_requests.rst
##########
@@ -0,0 +1,767 @@
+..
+..
+.. 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-deliveryservice-requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`.
+
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+==========================================================================================+
+ | assignee | no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this username. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | assigneeId| no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | author | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this username |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | authorId | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | changeType| no | Filter for :ref:`ds_requests` of the change type specified. |
+ | | | Can be ``create``, ``update``, or ``delete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | id | no | Filter for the :ref:`Delivery Service Request <ds_requests>` identified by this |
+ | | | integral, unique identifier. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | status | no | Filter for :ref:`ds_requests` whose status is the status |
+ | | | specified. The status can be ``draft``, ``submitted``, ``pending``, ``rejected``, or |
+ | | | ``complete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | xmlId | no | Filter for :ref:`ds_requests` that have the given |
+ | | | :ref:`ds-xmlid`. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservice_requests?status=draft HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:lastUpdated: The date and time at which the :term:`DSR <Delivery Service Request>` was last updated, in ISO format.
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 20:14:07 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: UBp3nklJr2x2cAW/TKbhXMVJH6+OduxUaEBGbX4P7IahDk3VkaTd9LsQj01zgFEnZLwHrikpwFfNlUO32RAZOA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 19:14:07 GMT
+ Content-Length: 872
+
+ {
+ "response": [
+ {
+ "authorId": 2,
+ "author": "admin",
+ "changeType": "update",
+ "createdAt": "2020-02-24 19:11:12+00",
+ "id": 1,
+ "lastEditedBy": "admin",
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-24 19:11:12+00",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "0001-01-01 00:00:00+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "draft"
+ }
+ ]
+ }
+
+.. _to-api-deliveryservice-requests-post:
+
+``POST``
+========
+
+.. note:: This route does NOT do the same thing as :ref:`POST deliveryservices/request <to-api-deliveryservices-request>`.
+
+Creates a new :term:`Delivery Service Request`.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+:changeType: The action that you want to perform on the delivery service. It can be "create", "update", or "delete".
+:status: The status of your request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+:deliveryService: The :term:`Delivery Service` that you have submitted for review as part of this request.
Review comment:
sub-property definitions?
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386164107
##########
File path: docs/source/api/v2/deliveryservice_requests_id_assign.rst
##########
@@ -0,0 +1,177 @@
+..
+..
+.. 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-deliveryservice_requests-id-assign:
+
+******************************************
+``deliveryservice_requests/{{ID}}/assign``
+******************************************
+Assign a :term:`Delivery Service Request` to a user.
+
+``PUT``
+=======
+:Auth. Required: Yes
+:Roles Required: "admin" or "operations"
+:Response Type: Object
+
+Request Structure
+-----------------
+
+.. code-block:: http
+ :caption: Request Example
+
+ PUT /api/2.0/deliveryservice_requests/1/assign HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 28
+
+ {
+ "id": 1,
+ "assigneeId": 2
+ }
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
Review comment:
Term linkedin 8d99deb8fd.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386165781
##########
File path: docs/source/api/v2/servers_details.rst
##########
@@ -0,0 +1,117 @@
+..
+..
+.. 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-servers-details:
+
+*******************
+``servers/details``
+*******************
+Retrieves details of :ref:`tp-configure-servers`.
+
+
+``GET``
+=======
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +----------------+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +================+========================================+================================================================================================================================================================+
+ | hostName | Required if no physLocationID provided | Return only the servers with this (short) hostname. Capitalization of "hostName" is important. |
+ +----------------+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | physLocationID | Required if no hostName provided | Return only servers with this integral, unique identifier for the physical location where the server resides. Capitalization of "physLocationID" is important. |
Review comment:
I might be inclined to capitalize it `physLocationId`, which is how GET `deliveryservices/{{ID}}/servers/eligible`, GET `deliveryservices/{{ID}}/servers`, GET `deliveryservices/{{ID}}/unassigned_servers`, GET `servers/{{ID}}`, and GET `servers` all capitalize it. This is the only route in Traffic Ops that capitalizes it this way.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386173367
##########
File path: docs/source/api/v2/deliveryservice_requests.rst
##########
@@ -0,0 +1,767 @@
+..
+..
+.. 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-deliveryservice-requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`.
+
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+==========================================================================================+
+ | assignee | no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this username. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | assigneeId| no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | author | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this username |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | authorId | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | changeType| no | Filter for :ref:`ds_requests` of the change type specified. |
+ | | | Can be ``create``, ``update``, or ``delete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | id | no | Filter for the :ref:`Delivery Service Request <ds_requests>` identified by this |
+ | | | integral, unique identifier. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | status | no | Filter for :ref:`ds_requests` whose status is the status |
+ | | | specified. The status can be ``draft``, ``submitted``, ``pending``, ``rejected``, or |
+ | | | ``complete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | xmlId | no | Filter for :ref:`ds_requests` that have the given |
+ | | | :ref:`ds-xmlid`. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservice_requests?status=draft HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
Review comment:
Field definition rephrased in 0647ea4845.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386153019
##########
File path: docs/source/api/v2/deliveryservice_request_comments.rst
##########
@@ -0,0 +1,296 @@
+..
+..
+.. 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-deliveryservice_request_comments:
+
+************************************
+``deliveryservice_request_comments``
+************************************
+
+``GET``
+=======
+Gets delivery service request comments.
+
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+
+.. table:: Request Query Parameters
+
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +==========================+==========+=====================================================================================================================================================+
+ | author | no | Filter for :ref:`Delivery Service Request <ds_requests>` comments submitted by the user identified by this username |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Filter for :ref:`Delivery Service Request <ds_requests>` comments submitted by the user identified by this integral, unique identifier |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | deliveryServiceRequestId | no | Filter for :ref:`Delivery Service Request <ds_requests>` comments submitted for the delivery service identified by this integral, unique identifier |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Filter for the :ref:`Delivery Service Request <ds_requests>` comment identified by this integral, unique identifier |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservice_request_comments HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 21:00:26 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: RaJZS1XFJ4oIxVKyyDjTuoQY7gPOmm5EuIL4AgHpyQpuaaNviw0XhGC4V/AKf/Ws6zXLgIUc4OyvMsTxnrilww==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 20:00:26 GMT
+ Content-Length: 207
+
+ {
+ "response": [
+ {
+ "authorId": 2,
+ "author": "admin",
+ "deliveryServiceRequestId": 2,
+ "id": 3,
+ "lastUpdated": "2020-02-24 19:59:46+00",
+ "value": "Changing to a different origin for now.",
+ "xmlId": "demo1"
+ },
+ {
+ "authorId": 2,
+ "author": "admin",
+ "deliveryServiceRequestId": 2,
+ "id": 4,
+ "lastUpdated": "2020-02-24 19:59:55+00",
+ "value": "Using HTTPS.",
+ "xmlId": "demo1"
+ }
+ ]
+ }
+
+``POST``
+========
+Allows user to create a :term:`Delivery Service Request` comment.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+
+.. code-block:: http
+ :caption: Request Example
+
+ POST /api/2.0/deliveryservice_request_comments HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 111
+
+ {
+ "deliveryServiceRequestId": 2,
+ "value": "Does anyone have time to review my delivery service request?"
+ }
+
+Response Structure
+------------------
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 21:02:20 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: LiakFP6L7PrnFO5kLXftx7WQoKn3bGpIJT5N15PvNG2sHridRMV3k23eRJM66ET0LcRfMOrQgRiydE+XgA8h0A==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 20:02:20 GMT
+ Content-Length: 223
+
+ {
+ "alerts": [
+ {
+ "text": "deliveryservice_request_comment was created.",
+ "level": "success"
+ }
+ ],
+ "response": {
+ "authorId": 2,
+ "author": null,
+ "deliveryServiceRequestId": 2,
+ "id": 6,
+ "lastUpdated": "2020-02-24 20:02:20+00",
+ "value": "Does anyone have time to review my delivery service request?",
+ "xmlId": null
+ }
+ }
+
+``PUT``
+=======
+
+Updates a delivery service request comment.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+
+Request Structure
+-----------------
+
+.. table:: Request Query Parameters
+
+ +-----------+----------+-----------------------------------------------------------------------------------+
+ | Parameter | Required | Description |
+ +===========+==========+===================================================================================+
+ | id | yes | The integral, unique identifier of the delivery service comment that you wish to |
+ | | | update. |
+ +-----------+----------+-----------------------------------------------------------------------------------+
+
Review comment:
Field definitions added in 6d4154ac02.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386156994
##########
File path: docs/source/api/v2/deliveryservice_requests.rst
##########
@@ -0,0 +1,767 @@
+..
+..
+.. 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-deliveryservice-requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`.
+
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+==========================================================================================+
+ | assignee | no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this username. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | assigneeId| no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | author | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this username |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | authorId | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | changeType| no | Filter for :ref:`ds_requests` of the change type specified. |
+ | | | Can be ``create``, ``update``, or ``delete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | id | no | Filter for the :ref:`Delivery Service Request <ds_requests>` identified by this |
+ | | | integral, unique identifier. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | status | no | Filter for :ref:`ds_requests` whose status is the status |
+ | | | specified. The status can be ``draft``, ``submitted``, ``pending``, ``rejected``, or |
+ | | | ``complete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | xmlId | no | Filter for :ref:`ds_requests` that have the given |
+ | | | :ref:`ds-xmlid`. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservice_requests?status=draft HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:lastUpdated: The date and time at which the :term:`DSR <Delivery Service Request>` was last updated, in ISO format.
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 20:14:07 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: UBp3nklJr2x2cAW/TKbhXMVJH6+OduxUaEBGbX4P7IahDk3VkaTd9LsQj01zgFEnZLwHrikpwFfNlUO32RAZOA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 19:14:07 GMT
+ Content-Length: 872
+
+ {
+ "response": [
+ {
+ "authorId": 2,
+ "author": "admin",
+ "changeType": "update",
+ "createdAt": "2020-02-24 19:11:12+00",
+ "id": 1,
+ "lastEditedBy": "admin",
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-24 19:11:12+00",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "0001-01-01 00:00:00+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "draft"
+ }
+ ]
+ }
+
+.. _to-api-deliveryservice-requests-post:
+
+``POST``
+========
+
+.. note:: This route does NOT do the same thing as :ref:`POST deliveryservices/request <to-api-deliveryservices-request>`.
+
+Creates a new :term:`Delivery Service Request`.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+:changeType: The action that you want to perform on the delivery service. It can be "create", "update", or "delete".
+:status: The status of your request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+:deliveryService: The :term:`Delivery Service` that you have submitted for review as part of this request.
+
+.. code-block:: http
+ :caption: Request Example
+
+ POST /api/2.0/deliveryservice_requests HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 1979
+
+ {
+ "changeType": "update",
+ "status": "draft",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2020-02-13 16:43:54+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ }
+ }
+
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:lastUpdated: The date and time at which the :term:`DSR <Delivery Service Request>` was last updated, in ISO format.
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 20:11:12 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: aWIrFTwUGnLq56WNZPL/FgOi/NwAVUtOy4iqjFPwx4gj7RMZ6+nd++bQKIiasBl8ytAY0WmFvNnmm30Fq9mLpA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 19:11:12 GMT
+ Content-Length: 901
+
+ {
+ "alerts": [
+ {
+ "text": "deliveryservice_request was created.",
+ "level": "success"
+ }
+ ],
+ "response": {
+ "authorId": 2,
+ "author": null,
+ "changeType": "update",
+ "createdAt": null,
+ "id": 1,
+ "lastEditedBy": null,
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-24 19:11:12+00",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "0001-01-01 00:00:00+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "draft"
+ }
+ }
+
+``PUT``
+=======
+
+Updates an existing :ref:`Delivery Service Request <ds_requests>`.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
Review comment:
Sub-property definitions added in dd903c8f01.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r399469525
##########
File path: docs/source/api/v2/deliveryservice_requests_id_assign.rst
##########
@@ -0,0 +1,260 @@
+..
+..
+.. 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-deliveryservice_requests-id-assign:
+
+******************************************
+``deliveryservice_requests/{{ID}}/assign``
+******************************************
+Assign a :term:`Delivery Service Request` to a user.
+
+``PUT``
+=======
+:Auth. Required: Yes
+:Roles Required: "admin" or "operations"
+:Response Type: Object
+
+Request Structure
+-----------------
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:assignee: The username of the user to whom the :term:`Delivery Service Request` is assigned.
+:assignee: The username of the user to whom the :term:`Delivery Service Request` is assigned.
Review comment:
duplicate line
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384064877
##########
File path: docs/source/api/v2/riak_ping.rst
##########
@@ -0,0 +1,66 @@
+..
+..
+.. 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-riak-ping:
+
+*************
+``riak/ping``
+*************
+Checks whether :ref:`tv-overview` is online.
+
+``GET``
+=======
+:Auth. Required: Yes
+:Roles Required: "read-only"
Review comment:
Same as above RE: read-only vs None
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384069629
##########
File path: traffic_control/clients/python/trafficops/tosession.py
##########
@@ -866,6 +866,17 @@ def assign_deliveryservice_servers_by_names(self, xml_id=None, data=None):
:raises: Union[LoginError, OperationError]
"""
+ @api_request(u'post', u'deliveryservice_requests', ('2.0',))
Review comment:
You don't need those `u`s in there, they don't do anything.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384068609
##########
File path: docs/source/api/v2/types.rst
##########
@@ -82,3 +82,70 @@ Response Structure
"useInTable": "cachegroup"
}
]}
+
+========
Review comment:
Heading shouldn't have an overline
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384060827
##########
File path: docs/source/api/v2/deliveryservice_requests.rst
##########
@@ -0,0 +1,767 @@
+..
+..
+.. 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-deliveryservice-requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`.
+
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+==========================================================================================+
+ | assignee | no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this username. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | assigneeId| no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | author | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this username |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | authorId | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | changeType| no | Filter for :ref:`ds_requests` of the change type specified. |
+ | | | Can be ``create``, ``update``, or ``delete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | id | no | Filter for the :ref:`Delivery Service Request <ds_requests>` identified by this |
+ | | | integral, unique identifier. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | status | no | Filter for :ref:`ds_requests` whose status is the status |
+ | | | specified. The status can be ``draft``, ``submitted``, ``pending``, ``rejected``, or |
+ | | | ``complete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | xmlId | no | Filter for :ref:`ds_requests` that have the given |
+ | | | :ref:`ds-xmlid`. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservice_requests?status=draft HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:lastUpdated: The date and time at which the :term:`DSR <Delivery Service Request>` was last updated, in ISO format.
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 20:14:07 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: UBp3nklJr2x2cAW/TKbhXMVJH6+OduxUaEBGbX4P7IahDk3VkaTd9LsQj01zgFEnZLwHrikpwFfNlUO32RAZOA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 19:14:07 GMT
+ Content-Length: 872
+
+ {
+ "response": [
+ {
+ "authorId": 2,
+ "author": "admin",
+ "changeType": "update",
+ "createdAt": "2020-02-24 19:11:12+00",
+ "id": 1,
+ "lastEditedBy": "admin",
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-24 19:11:12+00",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "0001-01-01 00:00:00+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "draft"
+ }
+ ]
+ }
+
+.. _to-api-deliveryservice-requests-post:
+
+``POST``
+========
+
+.. note:: This route does NOT do the same thing as :ref:`POST deliveryservices/request <to-api-deliveryservices-request>`.
+
+Creates a new :term:`Delivery Service Request`.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+:changeType: The action that you want to perform on the delivery service. It can be "create", "update", or "delete".
+:status: The status of your request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+:deliveryService: The :term:`Delivery Service` that you have submitted for review as part of this request.
+
+.. code-block:: http
+ :caption: Request Example
+
+ POST /api/2.0/deliveryservice_requests HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 1979
+
+ {
+ "changeType": "update",
+ "status": "draft",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2020-02-13 16:43:54+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ }
+ }
+
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:lastUpdated: The date and time at which the :term:`DSR <Delivery Service Request>` was last updated, in ISO format.
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 20:11:12 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: aWIrFTwUGnLq56WNZPL/FgOi/NwAVUtOy4iqjFPwx4gj7RMZ6+nd++bQKIiasBl8ytAY0WmFvNnmm30Fq9mLpA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 19:11:12 GMT
+ Content-Length: 901
+
+ {
+ "alerts": [
+ {
+ "text": "deliveryservice_request was created.",
+ "level": "success"
+ }
+ ],
+ "response": {
+ "authorId": 2,
+ "author": null,
+ "changeType": "update",
+ "createdAt": null,
+ "id": 1,
+ "lastEditedBy": null,
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-24 19:11:12+00",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "0001-01-01 00:00:00+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "draft"
+ }
+ }
+
+``PUT``
+=======
+
+Updates an existing :ref:`Delivery Service Request <ds_requests>`.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+
+.. table:: Request Query Parameters
+
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+==========================================================================================+
+ | id | yes | The integral, unique identifier of the :ref:`Delivery Service Request <ds_requests>` that|
+ | | | you want to update. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ PUT /api/2.0/deliveryservice_requests?id=1 HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 2256
+
+ {
+ "authorId": 2,
+ "author": "admin",
+ "changeType": "update",
+ "createdAt": "2020-02-24 19:11:12+00",
+ "id": 1,
+ "lastEditedBy": "admin",
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-24 19:33:26+00",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "0001-01-01 00:00:00+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": "",
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "submitted"
+ }
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
Review comment:
username, right?
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384068529
##########
File path: docs/source/api/v2/types.rst
##########
@@ -24,7 +24,7 @@
Retrieves all of the :term:`Types` of things configured in Traffic Ops. Yes, that is as specific as a description of a 'type' can be.
:Auth. Required: Yes
-:Roles Required: None
+:Roles Required: "read-only"
Review comment:
Same as above RE: read-only vs None
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384067800
##########
File path: docs/source/api/v2/steering.rst
##########
@@ -0,0 +1,97 @@
+..
+..
+.. 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-steering:
+
+************
+``steering``
+************
+
+``GET``
+=======
+Gets a list of all :ref:`Steering Targets <steering-qht>` in the Traffic Ops database.
+
+:Auth. Required: Yes
+:Roles Required: "Portal", "Steering", "Federation", "operations" or "admin"
+:Response Type: Array
+
+Request Structure
+-----------------
+No parameters available.
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/steering HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:deliveryService: A string that is the :ref:`ds-xmlid` of the steering :term:`Delivery Service`
+:clientSteering: Whether this is a :ref:`client steering <ds-client-steering>` delivery service.
+:targets: The delivery services that the steering delivery service targets.
Review comment:
Doesn't need to be linked again but should be "Delivery Services" and "Delivery Service" not "delivery services" and "delivery service"
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384057051
##########
File path: docs/source/api/v2/deliveryservice_requests_id_status.rst
##########
@@ -0,0 +1,177 @@
+..
+..
+.. 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-deliveryservice_requests-id-status:
+
+******************************************
+``deliveryservice_requests/{{ID}}/assign``
+******************************************
+Sets the status of a :term:`Delivery Service Request`.
+
+``PUT``
+=======
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+
Review comment:
Request field definitions?
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r383951301
##########
File path: docs/source/api/v2/cdns_dnsseckeys_generate.rst
##########
@@ -13,10 +13,10 @@
.. limitations under the License.
..
-.. _to-api-deliveryservices-dnsseckeys-generate:
+.. _to-api-cdns-dnsseckeys-generate:
****************************************
-``deliveryservices/dnsseckeys/generate``
+``cdns/dnsseckeys/generate``
****************************************
Review comment:
Line length matched in aa00b978b0.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384059424
##########
File path: docs/source/api/v2/deliveryservice_requests.rst
##########
@@ -0,0 +1,767 @@
+..
+..
+.. 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-deliveryservice-requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`.
+
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+==========================================================================================+
+ | assignee | no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this username. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | assigneeId| no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | author | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this username |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | authorId | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | changeType| no | Filter for :ref:`ds_requests` of the change type specified. |
+ | | | Can be ``create``, ``update``, or ``delete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | id | no | Filter for the :ref:`Delivery Service Request <ds_requests>` identified by this |
+ | | | integral, unique identifier. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | status | no | Filter for :ref:`ds_requests` whose status is the status |
+ | | | specified. The status can be ``draft``, ``submitted``, ``pending``, ``rejected``, or |
+ | | | ``complete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | xmlId | no | Filter for :ref:`ds_requests` that have the given |
+ | | | :ref:`ds-xmlid`. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservice_requests?status=draft HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
Review comment:
username, right?
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384065271
##########
File path: docs/source/api/v2/servers_details.rst
##########
@@ -0,0 +1,117 @@
+..
+..
+.. 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-servers-details:
+
+*******************
+``servers/details``
+*******************
+Retrieves details of :ref:`tp-configure-servers`.
+
+
+``GET``
+=======
+:Auth. Required: Yes
+:Roles Required: "read-only"
Review comment:
Same as above RE: read-only vs None
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386121929
##########
File path: docs/source/api/v2/deliveryservice_requests.rst
##########
@@ -0,0 +1,767 @@
+..
+..
+.. 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-deliveryservice-requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`.
+
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+==========================================================================================+
+ | assignee | no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this username. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | assigneeId| no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | author | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this username |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | authorId | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | changeType| no | Filter for :ref:`ds_requests` of the change type specified. |
+ | | | Can be ``create``, ``update``, or ``delete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | id | no | Filter for the :ref:`Delivery Service Request <ds_requests>` identified by this |
+ | | | integral, unique identifier. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | status | no | Filter for :ref:`ds_requests` whose status is the status |
+ | | | specified. The status can be ``draft``, ``submitted``, ``pending``, ``rejected``, or |
+ | | | ``complete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | xmlId | no | Filter for :ref:`ds_requests` that have the given |
+ | | | :ref:`ds-xmlid`. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservice_requests?status=draft HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:lastUpdated: The date and time at which the :term:`DSR <Delivery Service Request>` was last updated, in ISO format.
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 20:14:07 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: UBp3nklJr2x2cAW/TKbhXMVJH6+OduxUaEBGbX4P7IahDk3VkaTd9LsQj01zgFEnZLwHrikpwFfNlUO32RAZOA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 19:14:07 GMT
+ Content-Length: 872
+
+ {
+ "response": [
+ {
+ "authorId": 2,
+ "author": "admin",
+ "changeType": "update",
+ "createdAt": "2020-02-24 19:11:12+00",
+ "id": 1,
+ "lastEditedBy": "admin",
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-24 19:11:12+00",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "0001-01-01 00:00:00+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "draft"
+ }
+ ]
+ }
+
+.. _to-api-deliveryservice-requests-post:
+
+``POST``
+========
+
+.. note:: This route does NOT do the same thing as :ref:`POST deliveryservices/request <to-api-deliveryservices-request>`.
+
+Creates a new :term:`Delivery Service Request`.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+:changeType: The action that you want to perform on the delivery service. It can be "create", "update", or "delete".
+:status: The status of your request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+:deliveryService: The :term:`Delivery Service` that you have submitted for review as part of this request.
+
+.. code-block:: http
+ :caption: Request Example
+
+ POST /api/2.0/deliveryservice_requests HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 1979
+
+ {
+ "changeType": "update",
+ "status": "draft",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2020-02-13 16:43:54+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ }
+ }
+
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:lastUpdated: The date and time at which the :term:`DSR <Delivery Service Request>` was last updated, in ISO format.
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 20:11:12 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: aWIrFTwUGnLq56WNZPL/FgOi/NwAVUtOy4iqjFPwx4gj7RMZ6+nd++bQKIiasBl8ytAY0WmFvNnmm30Fq9mLpA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 19:11:12 GMT
+ Content-Length: 901
+
+ {
+ "alerts": [
+ {
+ "text": "deliveryservice_request was created.",
+ "level": "success"
+ }
+ ],
+ "response": {
+ "authorId": 2,
+ "author": null,
+ "changeType": "update",
+ "createdAt": null,
+ "id": 1,
+ "lastEditedBy": null,
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-24 19:11:12+00",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "0001-01-01 00:00:00+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "draft"
+ }
+ }
+
+``PUT``
+=======
+
+Updates an existing :ref:`Delivery Service Request <ds_requests>`.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
Review comment:
Fields aligned in 8d99deb8fd.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386154242
##########
File path: docs/source/api/v2/types.rst
##########
@@ -24,7 +24,7 @@
Retrieves all of the :term:`Types` of things configured in Traffic Ops. Yes, that is as specific as a description of a 'type' can be.
:Auth. Required: Yes
-:Roles Required: None
+:Roles Required: "read-only"
Review comment:
Changed to None in 98a96c343c.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r399473130
##########
File path: docs/source/api/v2/deliveryservices_id_urlkeys.rst
##########
@@ -0,0 +1,93 @@
+..
+..
+.. 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-deliveryservices-id-urlkeys:
+
+***********************************
+``deliveryservices/{{ID}}/urlkeys``
+***********************************
+
+``GET``
+=======
+.. seealso:: :ref:`to-api-deliveryservices-xmlid-xmlid-urlkeys`
+
+Retrieves URL signing keys for a :term:`Delivery Service`.
+
+.. caution:: This method will return the :term:`Delivery Service`'s **PRIVATE** URL signing keys! Be wary of using this endpoint and **NEVER** share the output with anyone who would be unable to see it on their own.
+
+:Auth. Required: Yes
+:Roles Required: None
+:Response Type: Object
+
+Request Structure
+-----------------
+.. table:: Request Path Parameters
+
+ +------+----------------------------------------------------------------------------------------+
+ | Name | Description |
+ +======+========================================================================================+
+ | id | Filter for the :term:`Delivery Service` identified by this integral, unique identifier |
+ +------+----------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservices/1/urlkeys HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:key<N>: The private URL signing key for this :term:`Delivery Service` as a base-64-encoded string, where ``<N>`` is the "generation" of the key e.g. the first key will always be named ``"key0"``. Up to 16 concurrent generations are retained at any time (``<N>`` is always on the interval [0,16])
Review comment:
I think this interval is actually `[0,15]` - or, equivalently in the ℤ domain (and we're implicitly in ℕ which is a subset of ℤ), `[0, 16)`.
Did you copy that from another endpoint? It looks familiar, so it might be wrong there, too.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386177312
##########
File path: docs/source/api/v2/cdns_dnsseckeys_generate.rst
##########
@@ -0,0 +1,79 @@
+..
+..
+.. 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-cdns-dnsseckeys-generate:
+
+****************************
+``cdns/dnsseckeys/generate``
+****************************
+
+``POST``
+========
+Generates :abbr:`ZSK (Zone-Signing Key)` and :abbr:`KSK (Key-Signing Key)` keypairs for a CDN and all associated :term:`Delivery Services`.
+
+:Auth. Required: Yes
+:Roles Required: "admin"
+:Response Type: Object (string)
+
+Request Structure
+-----------------
+:effectiveDate: UNIX epoch start date for the signing keys
Review comment:
Clarified whether it is optional and the format it unmarshals in 0d68da42bd.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386157899
##########
File path: docs/source/api/v2/ping.rst
##########
@@ -0,0 +1,62 @@
+..
+..
+.. 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-ping:
+
+********
+``ping``
+********
+Checks whether Traffic Ops is online.
+
+``GET``
+=======
+:Auth. Required: No
+:Response Type: Object
+
+Request Structure
+-----------------
+No parameters available.
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/ping HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+
Review comment:
Updated definition in 8fe4ab7d06.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386163928
##########
File path: docs/source/api/v2/deliveryservice_requests_id_status.rst
##########
@@ -0,0 +1,177 @@
+..
+..
+.. 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-deliveryservice_requests-id-status:
+
+******************************************
+``deliveryservice_requests/{{ID}}/assign``
+******************************************
+Sets the status of a :term:`Delivery Service Request`.
+
+``PUT``
+=======
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+
+.. code-block:: http
+ :caption: Request Example
+
+ PUT /api/2.0/deliveryservice_requests/1/status HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 28
+
+ {
+ "id": 1,
+ "status": "rejected"
+ }
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:lastUpdated: The date and time at which the :term:`DSR <Delivery Service Request>` was last updated, in ISO format.
Review comment:
DSR added to the glossary in e1a903abca.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386147939
##########
File path: docs/source/api/v2/steering.rst
##########
@@ -0,0 +1,97 @@
+..
+..
+.. 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-steering:
+
+************
+``steering``
+************
+
+``GET``
+=======
+Gets a list of all :ref:`Steering Targets <steering-qht>` in the Traffic Ops database.
+
+:Auth. Required: Yes
+:Roles Required: "Portal", "Steering", "Federation", "operations" or "admin"
+:Response Type: Array
+
+Request Structure
+-----------------
+No parameters available.
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/steering HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:deliveryService: A string that is the :ref:`ds-xmlid` of the steering :term:`Delivery Service`
+:clientSteering: Whether this is a :ref:`client steering <ds-client-steering>` delivery service.
+:targets: The delivery services that the steering delivery service targets.
Review comment:
Changed to Steering Delivery Services in cfbcfe347a.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on issue #4444: Document
undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on issue #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#issuecomment-614258057
Oh, the commits had them being removed. But maybe that's just GH's interface messing me up.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386147985
##########
File path: docs/source/api/v2/servers_id_deliveryservices.rst
##########
@@ -239,3 +239,81 @@ Response Structure
.. [#tenancy] Only the :term:`Delivery Services` visible to the requesting user's :term:`Tenant` will appear, regardless of their :term:`Role` or the :term:`Delivery Services`' actual 'server assignment' status.
+
+``POST``
+========
+Assign an arbitrary number of delivery services to a single server.
+
+:Auth. Required: Yes
+:Roles Required: "admin" or "operations"
+:Response Type: Object
+
+Request Structure
+-----------------
+.. table:: Request Path Parameters
+
+ +------+----------+---------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +------+----------+---------------------------------------------------------------------------------------------+
+ | id | Yes | The integral, unique identifier of the server that you want to assign delivery services to. |
+ +------+----------+---------------------------------------------------------------------------------------------+
+
+.. table:: Request Query Parameters
+
+ +---------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=========+==========+==========================================================================================+
+ | replace | Yes | Must be a 1, true, 0, or false. Although this query parameter is required, it is unused. |
+ +---------+----------+------------------------------------------------------------------------------------------+
+
+The request body is an array of IDs of delivery services that you want to assign to the server. The array can be empty, but it must be provided.
Review comment:
Changed to Delivery Services in cfbcfe347a.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384068816
##########
File path: docs/source/api/v2/types.rst
##########
@@ -82,3 +82,70 @@ Response Structure
"useInTable": "cachegroup"
}
]}
+
+========
+``POST``
+========
+Creates a new :term:`Type`.
+
+:Auth. Required: Yes
+:Roles Required: "admin" or "operations"
+:Response Type: Object
+
+Request Structure
+-----------------
+:name: The name of this type
+:description: A short description 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: Request Example
+
+ POST /api/2.0/types HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 77
+
+ {
+ "name": "GRAFANA",
+ "description": "Grafana Service",
+ "useInTable": "server"
+ }
+
+Response Structure
+------------------
+
Review comment:
Response field definitions?
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384062315
##########
File path: docs/source/api/v2/deliveryservices_xmlid_xmlid_urlkeys.rst
##########
@@ -21,12 +21,14 @@
``GET``
=======
+.. seealso:: :ref:`to-api-deliveryservices-id-urlkeys`
+
Retrieves URL signing keys for a :term:`Delivery Service`.
.. caution:: This method will return the :term:`Delivery Service`'s **PRIVATE** URL signing keys! Be wary of using this endpoint and **NEVER** share the output with anyone who would be unable to see it on their own.
:Auth. Required: Yes
-:Roles Required: None
+:Roles Required: "read-only"
Review comment:
using "None" instead of "read-only" is pretty standard. Changing it would be an improvement, but I think it'd be better to keep consistency for now and change it everywhere in a different PR.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384058178
##########
File path: docs/source/api/v2/deliveryservice_requests_id_status.rst
##########
@@ -0,0 +1,177 @@
+..
+..
+.. 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-deliveryservice_requests-id-status:
+
+******************************************
+``deliveryservice_requests/{{ID}}/assign``
+******************************************
+Sets the status of a :term:`Delivery Service Request`.
+
+``PUT``
+=======
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+
+.. code-block:: http
+ :caption: Request Example
+
+ PUT /api/2.0/deliveryservice_requests/1/status HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 28
+
+ {
+ "id": 1,
+ "status": "rejected"
+ }
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
Review comment:
sub-property field definitions?
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386154212
##########
File path: docs/source/api/v2/riak_ping.rst
##########
@@ -0,0 +1,66 @@
+..
+..
+.. 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-riak-ping:
+
+*************
+``riak/ping``
+*************
+Checks whether :ref:`tv-overview` is online.
+
+``GET``
+=======
+:Auth. Required: Yes
+:Roles Required: "read-only"
Review comment:
Changed to None in 98a96c343c.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384057600
##########
File path: docs/source/api/v2/deliveryservice_requests_id_status.rst
##########
@@ -0,0 +1,177 @@
+..
+..
+.. 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-deliveryservice_requests-id-status:
+
+******************************************
+``deliveryservice_requests/{{ID}}/assign``
+******************************************
+Sets the status of a :term:`Delivery Service Request`.
+
+``PUT``
+=======
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+
+.. code-block:: http
+ :caption: Request Example
+
+ PUT /api/2.0/deliveryservice_requests/1/status HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 28
+
+ {
+ "id": 1,
+ "status": "rejected"
+ }
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
Review comment:
"Delivery Service" is a `:term:`, should be linked at least the first time it appears on the page.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on issue #4444: Document
undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on issue #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#issuecomment-614223271
> `POST /types` and `/servers/details` still exist in 2.x
`POST /types` was documented in #4406. `GET /servers/details` was documented in #4512. The list in #4290 is up-to-date.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384067169
##########
File path: docs/source/api/v2/servers_id_deliveryservices.rst
##########
@@ -239,3 +239,81 @@ Response Structure
.. [#tenancy] Only the :term:`Delivery Services` visible to the requesting user's :term:`Tenant` will appear, regardless of their :term:`Role` or the :term:`Delivery Services`' actual 'server assignment' status.
+
+``POST``
+========
+Assign an arbitrary number of delivery services to a single server.
+
+:Auth. Required: Yes
+:Roles Required: "admin" or "operations"
+:Response Type: Object
+
+Request Structure
+-----------------
+.. table:: Request Path Parameters
+
+ +------+----------+---------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +------+----------+---------------------------------------------------------------------------------------------+
+ | id | Yes | The integral, unique identifier of the server that you want to assign delivery services to. |
+ +------+----------+---------------------------------------------------------------------------------------------+
+
+.. table:: Request Query Parameters
+
+ +---------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=========+==========+==========================================================================================+
+ | replace | Yes | Must be a 1, true, 0, or false. Although this query parameter is required, it is unused. |
+ +---------+----------+------------------------------------------------------------------------------------------+
+
+The request body is an array of IDs of delivery services that you want to assign to the server. The array can be empty, but it must be provided.
+
+.. code-block:: http
+ :caption: Request Example
+
+ POST /api/2.0/servers/6/deliveryservices?replace=1 HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 3
+
+ [
+ 1
+ ]
+
+Response Structure
+------------------
+
Review comment:
Response field definitions?
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r399463642
##########
File path: docs/source/api/v2/asns.rst
##########
@@ -66,11 +66,11 @@ Request Structure
Response Structure
------------------
-:asn: An :abbr:`ASN (Autonomous System Number)` as specified by IANA for identifying a service provider
-:cachegroup: A string that is the :ref:`cache-group-name` of the :term:`Cache Group` that is associated with this :abbr:`ASN (Autonomous System Number)`
-:cachegroupId: An integer that is the :ref:`cache-group-id` of the :term:`Cache Group` that is associated with this :abbr:`ASN (Autonomous System Number)`
-:id: An integral, unique identifier for this association between an :abbr:`ASN (Autonomous System Number)` and a :term:`Cache Group`
-:lastUpdated: The time and date this server entry was last updated in an ISO-like format
+:asn: An :abbr:`ASN (Autonomous System Number)` as specified by IANA for identifying a service provider
+:cachegroup: A string that is the :ref:`cache-group-name` of the :term:`Cache Group` that is associated with this :abbr:`ASN (Autonomous System Number)`
+:cachegroupId: An integer that is the :ref:`cache-group-id` of the :term:`Cache Group` that is associated with this :abbr:`ASN (Autonomous System Number)`
+:id: An integral, unique identifier for this association between an :abbr:`ASN (Autonomous System Number)` and a :term:`Cache Group`
+:lastUpdated: The time and date this server entry was last updated in an ISO-like format
Review comment:
These looked to all be aligned, why de-align them?
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384064989
##########
File path: docs/source/api/v2/riak_ping.rst
##########
@@ -0,0 +1,66 @@
+..
+..
+.. 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-riak-ping:
+
+*************
+``riak/ping``
+*************
+Checks whether :ref:`tv-overview` is online.
+
+``GET``
+=======
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Object
+
+Request Structure
+-----------------
+No parameters available.
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/riak/ping HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+.. code-block:: http
Review comment:
response field definitions?
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r409195630
##########
File path: docs/source/api/v2/asns.rst
##########
@@ -110,12 +110,12 @@ Creates a new :abbr:`ASN (Autonomous System Number)`.
Request Structure
-----------------
-:asn: The value of the new :abbr:`ASN (Autonomous System Number)`
-:cachegroup: An optional field which, if present, is a string that specifies the :ref:`cache-group-name` of a :term:`Cache Group` to which this :abbr:`ASN (Autonomous System Number)` will be assigned
+:asn: The value of the new :abbr:`ASN (Autonomous System Number)`
+:cachegroup: An optional field which, if present, is a string that specifies the :ref:`cache-group-name` of a :term:`Cache Group` to which this :abbr:`ASN (Autonomous System Number)` will be assigned
Review comment:
Aligned fields with spaces in c2b73f08e9.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386156980
##########
File path: docs/source/api/v2/deliveryservice_requests.rst
##########
@@ -0,0 +1,767 @@
+..
+..
+.. 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-deliveryservice-requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`.
+
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+==========================================================================================+
+ | assignee | no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this username. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | assigneeId| no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | author | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this username |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | authorId | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | changeType| no | Filter for :ref:`ds_requests` of the change type specified. |
+ | | | Can be ``create``, ``update``, or ``delete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | id | no | Filter for the :ref:`Delivery Service Request <ds_requests>` identified by this |
+ | | | integral, unique identifier. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | status | no | Filter for :ref:`ds_requests` whose status is the status |
+ | | | specified. The status can be ``draft``, ``submitted``, ``pending``, ``rejected``, or |
+ | | | ``complete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | xmlId | no | Filter for :ref:`ds_requests` that have the given |
+ | | | :ref:`ds-xmlid`. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservice_requests?status=draft HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:lastUpdated: The date and time at which the :term:`DSR <Delivery Service Request>` was last updated, in ISO format.
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 20:14:07 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: UBp3nklJr2x2cAW/TKbhXMVJH6+OduxUaEBGbX4P7IahDk3VkaTd9LsQj01zgFEnZLwHrikpwFfNlUO32RAZOA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 19:14:07 GMT
+ Content-Length: 872
+
+ {
+ "response": [
+ {
+ "authorId": 2,
+ "author": "admin",
+ "changeType": "update",
+ "createdAt": "2020-02-24 19:11:12+00",
+ "id": 1,
+ "lastEditedBy": "admin",
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-24 19:11:12+00",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "0001-01-01 00:00:00+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "draft"
+ }
+ ]
+ }
+
+.. _to-api-deliveryservice-requests-post:
+
+``POST``
+========
+
+.. note:: This route does NOT do the same thing as :ref:`POST deliveryservices/request <to-api-deliveryservices-request>`.
+
+Creates a new :term:`Delivery Service Request`.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+:changeType: The action that you want to perform on the delivery service. It can be "create", "update", or "delete".
+:status: The status of your request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+:deliveryService: The :term:`Delivery Service` that you have submitted for review as part of this request.
+
+.. code-block:: http
+ :caption: Request Example
+
+ POST /api/2.0/deliveryservice_requests HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 1979
+
+ {
+ "changeType": "update",
+ "status": "draft",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2020-02-13 16:43:54+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ }
+ }
+
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
Review comment:
Sub-property definitions added in dd903c8f01.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384055902
##########
File path: docs/source/api/v2/deliveryservice_request_comments.rst
##########
@@ -0,0 +1,296 @@
+..
+..
+.. 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-deliveryservice_request_comments:
+
+************************************
+``deliveryservice_request_comments``
+************************************
+
+``GET``
+=======
+Gets delivery service request comments.
+
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+
+.. table:: Request Query Parameters
+
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +==========================+==========+=====================================================================================================================================================+
+ | author | no | Filter for :ref:`Delivery Service Request <ds_requests>` comments submitted by the user identified by this username |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Filter for :ref:`Delivery Service Request <ds_requests>` comments submitted by the user identified by this integral, unique identifier |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | deliveryServiceRequestId | no | Filter for :ref:`Delivery Service Request <ds_requests>` comments submitted for the delivery service identified by this integral, unique identifier |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Filter for the :ref:`Delivery Service Request <ds_requests>` comment identified by this integral, unique identifier |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservice_request_comments HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 21:00:26 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: RaJZS1XFJ4oIxVKyyDjTuoQY7gPOmm5EuIL4AgHpyQpuaaNviw0XhGC4V/AKf/Ws6zXLgIUc4OyvMsTxnrilww==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 20:00:26 GMT
+ Content-Length: 207
+
+ {
+ "response": [
+ {
+ "authorId": 2,
+ "author": "admin",
+ "deliveryServiceRequestId": 2,
+ "id": 3,
+ "lastUpdated": "2020-02-24 19:59:46+00",
+ "value": "Changing to a different origin for now.",
+ "xmlId": "demo1"
+ },
+ {
+ "authorId": 2,
+ "author": "admin",
+ "deliveryServiceRequestId": 2,
+ "id": 4,
+ "lastUpdated": "2020-02-24 19:59:55+00",
+ "value": "Using HTTPS.",
+ "xmlId": "demo1"
+ }
+ ]
+ }
+
+``POST``
+========
+Allows user to create a :term:`Delivery Service Request` comment.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+
+.. code-block:: http
+ :caption: Request Example
+
+ POST /api/2.0/deliveryservice_request_comments HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 111
+
+ {
+ "deliveryServiceRequestId": 2,
+ "value": "Does anyone have time to review my delivery service request?"
+ }
+
+Response Structure
+------------------
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 21:02:20 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: LiakFP6L7PrnFO5kLXftx7WQoKn3bGpIJT5N15PvNG2sHridRMV3k23eRJM66ET0LcRfMOrQgRiydE+XgA8h0A==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 20:02:20 GMT
+ Content-Length: 223
+
+ {
+ "alerts": [
+ {
+ "text": "deliveryservice_request_comment was created.",
+ "level": "success"
+ }
+ ],
+ "response": {
+ "authorId": 2,
+ "author": null,
+ "deliveryServiceRequestId": 2,
+ "id": 6,
+ "lastUpdated": "2020-02-24 20:02:20+00",
+ "value": "Does anyone have time to review my delivery service request?",
+ "xmlId": null
+ }
+ }
+
+``PUT``
+=======
+
+Updates a delivery service request comment.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+
+Request Structure
+-----------------
+
+.. table:: Request Query Parameters
+
+ +-----------+----------+-----------------------------------------------------------------------------------+
+ | Parameter | Required | Description |
+ +===========+==========+===================================================================================+
+ | id | yes | The integral, unique identifier of the delivery service comment that you wish to |
+ | | | update. |
+ +-----------+----------+-----------------------------------------------------------------------------------+
+
Review comment:
Request field definitions?
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r383951387
##########
File path: docs/source/api/v2/federations_all.rst
##########
@@ -0,0 +1,88 @@
+..
+..
+.. 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-federations-all:
+
+***************************
+``federations/all``
+***************************
Review comment:
Line length matched in aa00b978b0.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386164467
##########
File path: docs/source/api/v2/deliveryservice_requests_id_status.rst
##########
@@ -0,0 +1,177 @@
+..
+..
+.. 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-deliveryservice_requests-id-status:
+
+******************************************
+``deliveryservice_requests/{{ID}}/assign``
Review comment:
Corrected title in 6d4154ac02.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384059521
##########
File path: docs/source/api/v2/deliveryservice_requests.rst
##########
@@ -0,0 +1,767 @@
+..
+..
+.. 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-deliveryservice-requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`.
+
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+==========================================================================================+
+ | assignee | no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this username. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | assigneeId| no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | author | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this username |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | authorId | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | changeType| no | Filter for :ref:`ds_requests` of the change type specified. |
+ | | | Can be ``create``, ``update``, or ``delete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | id | no | Filter for the :ref:`Delivery Service Request <ds_requests>` identified by this |
+ | | | integral, unique identifier. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | status | no | Filter for :ref:`ds_requests` whose status is the status |
+ | | | specified. The status can be ``draft``, ``submitted``, ``pending``, ``rejected``, or |
+ | | | ``complete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | xmlId | no | Filter for :ref:`ds_requests` that have the given |
+ | | | :ref:`ds-xmlid`. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservice_requests?status=draft HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
Review comment:
sub-property definitions?
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r409195568
##########
File path: docs/source/api/v2/asns.rst
##########
@@ -66,11 +66,11 @@ Request Structure
Response Structure
------------------
-:asn: An :abbr:`ASN (Autonomous System Number)` as specified by IANA for identifying a service provider
-:cachegroup: A string that is the :ref:`cache-group-name` of the :term:`Cache Group` that is associated with this :abbr:`ASN (Autonomous System Number)`
-:cachegroupId: An integer that is the :ref:`cache-group-id` of the :term:`Cache Group` that is associated with this :abbr:`ASN (Autonomous System Number)`
-:id: An integral, unique identifier for this association between an :abbr:`ASN (Autonomous System Number)` and a :term:`Cache Group`
-:lastUpdated: The time and date this server entry was last updated in an ISO-like format
+:asn: An :abbr:`ASN (Autonomous System Number)` as specified by IANA for identifying a service provider
+:cachegroup: A string that is the :ref:`cache-group-name` of the :term:`Cache Group` that is associated with this :abbr:`ASN (Autonomous System Number)`
+:cachegroupId: An integer that is the :ref:`cache-group-id` of the :term:`Cache Group` that is associated with this :abbr:`ASN (Autonomous System Number)`
+:id: An integral, unique identifier for this association between an :abbr:`ASN (Autonomous System Number)` and a :term:`Cache Group`
+:lastUpdated: The time and date this server entry was last updated in an ISO-like format
Review comment:
Aligned fields with spaces in c2b73f08e9.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386152977
##########
File path: docs/source/api/v2/types.rst
##########
@@ -82,3 +82,70 @@ Response Structure
"useInTable": "cachegroup"
}
]}
+
+========
+``POST``
+========
+Creates a new :term:`Type`.
+
+:Auth. Required: Yes
+:Roles Required: "admin" or "operations"
+:Response Type: Object
+
+Request Structure
+-----------------
+:name: The name of this type
+:description: A short description 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: Request Example
+
+ POST /api/2.0/types HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 77
+
+ {
+ "name": "GRAFANA",
+ "description": "Grafana Service",
+ "useInTable": "server"
+ }
+
+Response Structure
+------------------
+
Review comment:
Field definitions added in 6d4154ac02.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386147959
##########
File path: docs/source/api/v2/asns.rst
##########
@@ -169,3 +169,132 @@ Response Structure
"lastUpdated": "2019-12-02 21:49:08+00"
}}
+``PUT``
+=======
+Updates an existing :abbr:`ASN (Autonomous System Number)`.
+
+:Auth. Required: Yes
+:Roles Required: "admin" or "operations"
+:Response Type: Object
+
+Request Structure
+-----------------
+ +--------------+----------+---------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +==============+==========+=================================================================================+
+ | asn | Yes | The value of the new :abbr:`ASN (Autonomous System Number)`. |
+ +--------------+----------+---------------------------------------------------------------------------------+
+ | cachegroup | Yes | A string that specifies the :ref:`cache-group-name` of a :term:`Cache Group` to |
+ | | | which this :abbr:`ASN (Autonomous System Number)` will be assigned. If you do |
+ | | | not pass this field, the cachegroup will be ``null``. For that reason, we list |
+ | | | it as required. |
+ +--------------+----------+---------------------------------------------------------------------------------+
+ | cachegroupId | Yes | The integral, unique identifier of the status of the cache group. |
Review comment:
Changed to Cache Group in cfbcfe347a.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r399463753
##########
File path: docs/source/api/v2/asns.rst
##########
@@ -110,12 +110,12 @@ Creates a new :abbr:`ASN (Autonomous System Number)`.
Request Structure
-----------------
-:asn: The value of the new :abbr:`ASN (Autonomous System Number)`
-:cachegroup: An optional field which, if present, is a string that specifies the :ref:`cache-group-name` of a :term:`Cache Group` to which this :abbr:`ASN (Autonomous System Number)` will be assigned
+:asn: The value of the new :abbr:`ASN (Autonomous System Number)`
+:cachegroup: An optional field which, if present, is a string that specifies the :ref:`cache-group-name` of a :term:`Cache Group` to which this :abbr:`ASN (Autonomous System Number)` will be assigned
Review comment:
Same question here
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386173407
##########
File path: docs/source/api/v2/deliveryservice_requests.rst
##########
@@ -0,0 +1,767 @@
+..
+..
+.. 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-deliveryservice-requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`.
+
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+==========================================================================================+
+ | assignee | no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this username. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | assigneeId| no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | author | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this username |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | authorId | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | changeType| no | Filter for :ref:`ds_requests` of the change type specified. |
+ | | | Can be ``create``, ``update``, or ``delete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | id | no | Filter for the :ref:`Delivery Service Request <ds_requests>` identified by this |
+ | | | integral, unique identifier. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | status | no | Filter for :ref:`ds_requests` whose status is the status |
+ | | | specified. The status can be ``draft``, ``submitted``, ``pending``, ``rejected``, or |
+ | | | ``complete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | xmlId | no | Filter for :ref:`ds_requests` that have the given |
+ | | | :ref:`ds-xmlid`. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservice_requests?status=draft HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:lastUpdated: The date and time at which the :term:`DSR <Delivery Service Request>` was last updated, in ISO format.
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 20:14:07 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: UBp3nklJr2x2cAW/TKbhXMVJH6+OduxUaEBGbX4P7IahDk3VkaTd9LsQj01zgFEnZLwHrikpwFfNlUO32RAZOA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 19:14:07 GMT
+ Content-Length: 872
+
+ {
+ "response": [
+ {
+ "authorId": 2,
+ "author": "admin",
+ "changeType": "update",
+ "createdAt": "2020-02-24 19:11:12+00",
+ "id": 1,
+ "lastEditedBy": "admin",
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-24 19:11:12+00",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "0001-01-01 00:00:00+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "draft"
+ }
+ ]
+ }
+
+.. _to-api-deliveryservice-requests-post:
+
+``POST``
+========
+
+.. note:: This route does NOT do the same thing as :ref:`POST deliveryservices/request <to-api-deliveryservices-request>`.
+
+Creates a new :term:`Delivery Service Request`.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+:changeType: The action that you want to perform on the delivery service. It can be "create", "update", or "delete".
+:status: The status of your request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+:deliveryService: The :term:`Delivery Service` that you have submitted for review as part of this request.
+
+.. code-block:: http
+ :caption: Request Example
+
+ POST /api/2.0/deliveryservice_requests HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 1979
+
+ {
+ "changeType": "update",
+ "status": "draft",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2020-02-13 16:43:54+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ }
+ }
+
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:lastUpdated: The date and time at which the :term:`DSR <Delivery Service Request>` was last updated, in ISO format.
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 20:11:12 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: aWIrFTwUGnLq56WNZPL/FgOi/NwAVUtOy4iqjFPwx4gj7RMZ6+nd++bQKIiasBl8ytAY0WmFvNnmm30Fq9mLpA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 19:11:12 GMT
+ Content-Length: 901
+
+ {
+ "alerts": [
+ {
+ "text": "deliveryservice_request was created.",
+ "level": "success"
+ }
+ ],
+ "response": {
+ "authorId": 2,
+ "author": null,
+ "changeType": "update",
+ "createdAt": null,
+ "id": 1,
+ "lastEditedBy": null,
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-24 19:11:12+00",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "0001-01-01 00:00:00+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "draft"
+ }
+ }
+
+``PUT``
+=======
+
+Updates an existing :ref:`Delivery Service Request <ds_requests>`.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+
+.. table:: Request Query Parameters
+
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+==========================================================================================+
+ | id | yes | The integral, unique identifier of the :ref:`Delivery Service Request <ds_requests>` that|
+ | | | you want to update. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ PUT /api/2.0/deliveryservice_requests?id=1 HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 2256
+
+ {
+ "authorId": 2,
+ "author": "admin",
+ "changeType": "update",
+ "createdAt": "2020-02-24 19:11:12+00",
+ "id": 1,
+ "lastEditedBy": "admin",
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-24 19:33:26+00",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "0001-01-01 00:00:00+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": "",
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "submitted"
+ }
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
Review comment:
Field definition rephrased in 0647ea4845.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384068281
##########
File path: docs/source/api/v2/steering.rst
##########
@@ -0,0 +1,97 @@
+..
+..
+.. 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-steering:
+
+************
+``steering``
+************
+
+``GET``
+=======
+Gets a list of all :ref:`Steering Targets <steering-qht>` in the Traffic Ops database.
+
+:Auth. Required: Yes
+:Roles Required: "Portal", "Steering", "Federation", "operations" or "admin"
+:Response Type: Array
+
+Request Structure
+-----------------
+No parameters available.
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/steering HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:deliveryService: A string that is the :ref:`ds-xmlid` of the steering :term:`Delivery Service`
+:clientSteering: Whether this is a :ref:`client steering <ds-client-steering>` delivery service.
+:targets: The delivery services that the steering delivery service targets.
Review comment:
Sub-property definitions?
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384060089
##########
File path: docs/source/api/v2/deliveryservice_requests.rst
##########
@@ -0,0 +1,767 @@
+..
+..
+.. 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-deliveryservice-requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`.
+
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+==========================================================================================+
+ | assignee | no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this username. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | assigneeId| no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | author | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this username |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | authorId | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | changeType| no | Filter for :ref:`ds_requests` of the change type specified. |
+ | | | Can be ``create``, ``update``, or ``delete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | id | no | Filter for the :ref:`Delivery Service Request <ds_requests>` identified by this |
+ | | | integral, unique identifier. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | status | no | Filter for :ref:`ds_requests` whose status is the status |
+ | | | specified. The status can be ``draft``, ``submitted``, ``pending``, ``rejected``, or |
+ | | | ``complete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | xmlId | no | Filter for :ref:`ds_requests` that have the given |
+ | | | :ref:`ds-xmlid`. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservice_requests?status=draft HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:lastUpdated: The date and time at which the :term:`DSR <Delivery Service Request>` was last updated, in ISO format.
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 20:14:07 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: UBp3nklJr2x2cAW/TKbhXMVJH6+OduxUaEBGbX4P7IahDk3VkaTd9LsQj01zgFEnZLwHrikpwFfNlUO32RAZOA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 19:14:07 GMT
+ Content-Length: 872
+
+ {
+ "response": [
+ {
+ "authorId": 2,
+ "author": "admin",
+ "changeType": "update",
+ "createdAt": "2020-02-24 19:11:12+00",
+ "id": 1,
+ "lastEditedBy": "admin",
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-24 19:11:12+00",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "0001-01-01 00:00:00+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "draft"
+ }
+ ]
+ }
+
+.. _to-api-deliveryservice-requests-post:
+
+``POST``
+========
+
+.. note:: This route does NOT do the same thing as :ref:`POST deliveryservices/request <to-api-deliveryservices-request>`.
+
+Creates a new :term:`Delivery Service Request`.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+:changeType: The action that you want to perform on the delivery service. It can be "create", "update", or "delete".
+:status: The status of your request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+:deliveryService: The :term:`Delivery Service` that you have submitted for review as part of this request.
+
+.. code-block:: http
+ :caption: Request Example
+
+ POST /api/2.0/deliveryservice_requests HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 1979
+
+ {
+ "changeType": "update",
+ "status": "draft",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2020-02-13 16:43:54+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ }
+ }
+
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
Review comment:
nit but alignment is off in a few of these
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] mhoppa commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
mhoppa commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r383902038
##########
File path: docs/source/api/v2/about.rst
##########
@@ -0,0 +1,73 @@
+..
+..
+.. 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-about:
+
+***********
+``about``
+***********
+
+``GET``
+=======
+
+.. versionadded:: 1.3
Review comment:
dont need versionadded in 2.0 docs
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384056025
##########
File path: docs/source/api/v2/deliveryservice_request_comments.rst
##########
@@ -0,0 +1,296 @@
+..
+..
+.. 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-deliveryservice_request_comments:
+
+************************************
+``deliveryservice_request_comments``
+************************************
+
+``GET``
+=======
+Gets delivery service request comments.
+
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+
+.. table:: Request Query Parameters
+
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +==========================+==========+=====================================================================================================================================================+
+ | author | no | Filter for :ref:`Delivery Service Request <ds_requests>` comments submitted by the user identified by this username |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Filter for :ref:`Delivery Service Request <ds_requests>` comments submitted by the user identified by this integral, unique identifier |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | deliveryServiceRequestId | no | Filter for :ref:`Delivery Service Request <ds_requests>` comments submitted for the delivery service identified by this integral, unique identifier |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Filter for the :ref:`Delivery Service Request <ds_requests>` comment identified by this integral, unique identifier |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservice_request_comments HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 21:00:26 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: RaJZS1XFJ4oIxVKyyDjTuoQY7gPOmm5EuIL4AgHpyQpuaaNviw0XhGC4V/AKf/Ws6zXLgIUc4OyvMsTxnrilww==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 20:00:26 GMT
+ Content-Length: 207
+
+ {
+ "response": [
+ {
+ "authorId": 2,
+ "author": "admin",
+ "deliveryServiceRequestId": 2,
+ "id": 3,
+ "lastUpdated": "2020-02-24 19:59:46+00",
+ "value": "Changing to a different origin for now.",
+ "xmlId": "demo1"
+ },
+ {
+ "authorId": 2,
+ "author": "admin",
+ "deliveryServiceRequestId": 2,
+ "id": 4,
+ "lastUpdated": "2020-02-24 19:59:55+00",
+ "value": "Using HTTPS.",
+ "xmlId": "demo1"
+ }
+ ]
+ }
+
+``POST``
+========
+Allows user to create a :term:`Delivery Service Request` comment.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+
+.. code-block:: http
+ :caption: Request Example
+
+ POST /api/2.0/deliveryservice_request_comments HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 111
+
+ {
+ "deliveryServiceRequestId": 2,
+ "value": "Does anyone have time to review my delivery service request?"
+ }
+
+Response Structure
+------------------
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 21:02:20 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: LiakFP6L7PrnFO5kLXftx7WQoKn3bGpIJT5N15PvNG2sHridRMV3k23eRJM66ET0LcRfMOrQgRiydE+XgA8h0A==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 20:02:20 GMT
+ Content-Length: 223
+
+ {
+ "alerts": [
+ {
+ "text": "deliveryservice_request_comment was created.",
+ "level": "success"
+ }
+ ],
+ "response": {
+ "authorId": 2,
+ "author": null,
+ "deliveryServiceRequestId": 2,
+ "id": 6,
+ "lastUpdated": "2020-02-24 20:02:20+00",
+ "value": "Does anyone have time to review my delivery service request?",
+ "xmlId": null
+ }
+ }
+
+``PUT``
+=======
+
+Updates a delivery service request comment.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+
+Request Structure
+-----------------
+
+.. table:: Request Query Parameters
+
+ +-----------+----------+-----------------------------------------------------------------------------------+
+ | Parameter | Required | Description |
+ +===========+==========+===================================================================================+
+ | id | yes | The integral, unique identifier of the delivery service comment that you wish to |
+ | | | update. |
+ +-----------+----------+-----------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ PUT /api/2.0/deliveryservice_request_comments?id=6 HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 166
+
+ {
+ "deliveryServiceRequestId": 2,
+ "value": "Update: We no longer need this, feel free to reject.\n\nDoes anyone have time to review my delivery service request?"
+ }
+
+Response Structure
+------------------
+
Review comment:
response field definitions?
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386154204
##########
File path: docs/source/api/v2/deliveryservices_xmlid_xmlid_urlkeys.rst
##########
@@ -21,12 +21,14 @@
``GET``
=======
+.. seealso:: :ref:`to-api-deliveryservices-id-urlkeys`
+
Retrieves URL signing keys for a :term:`Delivery Service`.
.. caution:: This method will return the :term:`Delivery Service`'s **PRIVATE** URL signing keys! Be wary of using this endpoint and **NEVER** share the output with anyone who would be unable to see it on their own.
:Auth. Required: Yes
-:Roles Required: None
+:Roles Required: "read-only"
Review comment:
Changed to None in 98a96c343c.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386159113
##########
File path: docs/source/api/v2/deliveryservice_requests_id_assign.rst
##########
@@ -0,0 +1,177 @@
+..
+..
+.. 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-deliveryservice_requests-id-assign:
+
+******************************************
+``deliveryservice_requests/{{ID}}/assign``
+******************************************
+Assign a :term:`Delivery Service Request` to a user.
+
+``PUT``
+=======
+:Auth. Required: Yes
+:Roles Required: "admin" or "operations"
+:Response Type: Object
+
+Request Structure
+-----------------
+
+.. code-block:: http
+ :caption: Request Example
+
+ PUT /api/2.0/deliveryservice_requests/1/assign HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 28
+
+ {
+ "id": 1,
+ "assigneeId": 2
+ }
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
Review comment:
Sub-property definitions added in 7bf700720b.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386147977
##########
File path: docs/source/api/v2/servers_id_deliveryservices.rst
##########
@@ -239,3 +239,81 @@ Response Structure
.. [#tenancy] Only the :term:`Delivery Services` visible to the requesting user's :term:`Tenant` will appear, regardless of their :term:`Role` or the :term:`Delivery Services`' actual 'server assignment' status.
+
+``POST``
+========
+Assign an arbitrary number of delivery services to a single server.
Review comment:
Changed to Delivery Services in cfbcfe347a.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384057799
##########
File path: docs/source/api/v2/deliveryservice_requests_id_status.rst
##########
@@ -0,0 +1,177 @@
+..
+..
+.. 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-deliveryservice_requests-id-status:
+
+******************************************
+``deliveryservice_requests/{{ID}}/assign``
+******************************************
+Sets the status of a :term:`Delivery Service Request`.
+
+``PUT``
+=======
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+
+.. code-block:: http
+ :caption: Request Example
+
+ PUT /api/2.0/deliveryservice_requests/1/status HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 28
+
+ {
+ "id": 1,
+ "status": "rejected"
+ }
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:lastUpdated: The date and time at which the :term:`DSR <Delivery Service Request>` was last updated, in ISO format.
Review comment:
If you want you can add "DSR" to the glossary. Don't have to though, this is fine.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386121935
##########
File path: docs/source/api/v2/steering.rst
##########
@@ -0,0 +1,97 @@
+..
+..
+.. 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-steering:
+
+************
+``steering``
+************
+
+``GET``
+=======
+Gets a list of all :ref:`Steering Targets <steering-qht>` in the Traffic Ops database.
+
+:Auth. Required: Yes
+:Roles Required: "Portal", "Steering", "Federation", "operations" or "admin"
+:Response Type: Array
+
+Request Structure
+-----------------
+No parameters available.
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/steering HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:deliveryService: A string that is the :ref:`ds-xmlid` of the steering :term:`Delivery Service`
+:clientSteering: Whether this is a :ref:`client steering <ds-client-steering>` delivery service.
+:targets: The delivery services that the steering delivery service targets.
+:filters: Filters of type :ref:`STEERING_REGEXP <ds-steering-regexp>` that exist on either of the targets.
Review comment:
Field aligned in 8d99deb8fd.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386173394
##########
File path: docs/source/api/v2/deliveryservice_requests.rst
##########
@@ -0,0 +1,767 @@
+..
+..
+.. 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-deliveryservice-requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`.
+
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+==========================================================================================+
+ | assignee | no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this username. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | assigneeId| no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | author | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this username |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | authorId | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | changeType| no | Filter for :ref:`ds_requests` of the change type specified. |
+ | | | Can be ``create``, ``update``, or ``delete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | id | no | Filter for the :ref:`Delivery Service Request <ds_requests>` identified by this |
+ | | | integral, unique identifier. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | status | no | Filter for :ref:`ds_requests` whose status is the status |
+ | | | specified. The status can be ``draft``, ``submitted``, ``pending``, ``rejected``, or |
+ | | | ``complete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | xmlId | no | Filter for :ref:`ds_requests` that have the given |
+ | | | :ref:`ds-xmlid`. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservice_requests?status=draft HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
Review comment:
Sub-property definitions added in dd903c8f01.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386157910
##########
File path: docs/source/api/v2/servers_id_deliveryservices.rst
##########
@@ -239,3 +239,81 @@ Response Structure
.. [#tenancy] Only the :term:`Delivery Services` visible to the requesting user's :term:`Tenant` will appear, regardless of their :term:`Role` or the :term:`Delivery Services`' actual 'server assignment' status.
+
+``POST``
+========
+Assign an arbitrary number of delivery services to a single server.
+
+:Auth. Required: Yes
+:Roles Required: "admin" or "operations"
+:Response Type: Object
+
+Request Structure
+-----------------
+.. table:: Request Path Parameters
+
+ +------+----------+---------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +------+----------+---------------------------------------------------------------------------------------------+
+ | id | Yes | The integral, unique identifier of the server that you want to assign delivery services to. |
Review comment:
Capitalized path parameter in 8fe4ab7d06.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384064064
##########
File path: docs/source/api/v2/ping.rst
##########
@@ -0,0 +1,62 @@
+..
+..
+.. 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-ping:
+
+********
+``ping``
+********
+Checks whether Traffic Ops is online.
+
+``GET``
+=======
+:Auth. Required: No
+:Response Type: Object
+
+Request Structure
+-----------------
+No parameters available.
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/ping HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+
Review comment:
This should just say something like "returns an object containing only the `"ping"` property which always has the value `"pong"`.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384053287
##########
File path: docs/source/api/v2/about.rst
##########
@@ -0,0 +1,71 @@
+..
+..
+.. 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-about:
+
+***********
+``about``
+***********
+
+``GET``
+=======
+
+Returns info about the Traffic Ops build that is currently running, generated at startup. The output will be the same until the Traffic Ops :ref:`version changes <to-upgrading>`.
+
+:Auth. Required: Yes
+:Roles Required: None
+:Response Type: Object
+
+Request Structure
+-----------------
+No parameters available.
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/about HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+.. code-block:: http
Review comment:
Response field definitions?
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384060955
##########
File path: docs/source/api/v2/deliveryservice_requests.rst
##########
@@ -0,0 +1,767 @@
+..
+..
+.. 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-deliveryservice-requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`.
+
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+==========================================================================================+
+ | assignee | no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this username. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | assigneeId| no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | author | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this username |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | authorId | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | changeType| no | Filter for :ref:`ds_requests` of the change type specified. |
+ | | | Can be ``create``, ``update``, or ``delete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | id | no | Filter for the :ref:`Delivery Service Request <ds_requests>` identified by this |
+ | | | integral, unique identifier. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | status | no | Filter for :ref:`ds_requests` whose status is the status |
+ | | | specified. The status can be ``draft``, ``submitted``, ``pending``, ``rejected``, or |
+ | | | ``complete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | xmlId | no | Filter for :ref:`ds_requests` that have the given |
+ | | | :ref:`ds-xmlid`. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservice_requests?status=draft HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:lastUpdated: The date and time at which the :term:`DSR <Delivery Service Request>` was last updated, in ISO format.
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 20:14:07 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: UBp3nklJr2x2cAW/TKbhXMVJH6+OduxUaEBGbX4P7IahDk3VkaTd9LsQj01zgFEnZLwHrikpwFfNlUO32RAZOA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 19:14:07 GMT
+ Content-Length: 872
+
+ {
+ "response": [
+ {
+ "authorId": 2,
+ "author": "admin",
+ "changeType": "update",
+ "createdAt": "2020-02-24 19:11:12+00",
+ "id": 1,
+ "lastEditedBy": "admin",
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-24 19:11:12+00",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "0001-01-01 00:00:00+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "draft"
+ }
+ ]
+ }
+
+.. _to-api-deliveryservice-requests-post:
+
+``POST``
+========
+
+.. note:: This route does NOT do the same thing as :ref:`POST deliveryservices/request <to-api-deliveryservices-request>`.
+
+Creates a new :term:`Delivery Service Request`.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+:changeType: The action that you want to perform on the delivery service. It can be "create", "update", or "delete".
+:status: The status of your request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+:deliveryService: The :term:`Delivery Service` that you have submitted for review as part of this request.
+
+.. code-block:: http
+ :caption: Request Example
+
+ POST /api/2.0/deliveryservice_requests HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 1979
+
+ {
+ "changeType": "update",
+ "status": "draft",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2020-02-13 16:43:54+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ }
+ }
+
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:lastUpdated: The date and time at which the :term:`DSR <Delivery Service Request>` was last updated, in ISO format.
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 20:11:12 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: aWIrFTwUGnLq56WNZPL/FgOi/NwAVUtOy4iqjFPwx4gj7RMZ6+nd++bQKIiasBl8ytAY0WmFvNnmm30Fq9mLpA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 19:11:12 GMT
+ Content-Length: 901
+
+ {
+ "alerts": [
+ {
+ "text": "deliveryservice_request was created.",
+ "level": "success"
+ }
+ ],
+ "response": {
+ "authorId": 2,
+ "author": null,
+ "changeType": "update",
+ "createdAt": null,
+ "id": 1,
+ "lastEditedBy": null,
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-24 19:11:12+00",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "0001-01-01 00:00:00+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "draft"
+ }
+ }
+
+``PUT``
+=======
+
+Updates an existing :ref:`Delivery Service Request <ds_requests>`.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+
+.. table:: Request Query Parameters
+
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+==========================================================================================+
+ | id | yes | The integral, unique identifier of the :ref:`Delivery Service Request <ds_requests>` that|
+ | | | you want to update. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ PUT /api/2.0/deliveryservice_requests?id=1 HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 2256
+
+ {
+ "authorId": 2,
+ "author": "admin",
+ "changeType": "update",
+ "createdAt": "2020-02-24 19:11:12+00",
+ "id": 1,
+ "lastEditedBy": "admin",
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-24 19:33:26+00",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "0001-01-01 00:00:00+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": "",
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "submitted"
+ }
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:lastUpdated: The date and time at which the :term:`DSR <Delivery Service Request>` was last updated, in ISO format.
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
Review comment:
nit but the alignment is off in this field list
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386152982
##########
File path: docs/source/api/v2/about.rst
##########
@@ -0,0 +1,71 @@
+..
+..
+.. 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-about:
+
+***********
+``about``
+***********
+
+``GET``
+=======
+
+Returns info about the Traffic Ops build that is currently running, generated at startup. The output will be the same until the Traffic Ops :ref:`version changes <to-upgrading>`.
+
+:Auth. Required: Yes
+:Roles Required: None
+:Response Type: Object
+
+Request Structure
+-----------------
+No parameters available.
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/about HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+.. code-block:: http
Review comment:
Field definitions added in 6d4154ac02.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386121863
##########
File path: docs/source/api/v2/deliveryservice_requests.rst
##########
@@ -0,0 +1,767 @@
+..
+..
+.. 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-deliveryservice-requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`.
+
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+==========================================================================================+
+ | assignee | no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this username. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | assigneeId| no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | author | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this username |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | authorId | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | changeType| no | Filter for :ref:`ds_requests` of the change type specified. |
+ | | | Can be ``create``, ``update``, or ``delete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | id | no | Filter for the :ref:`Delivery Service Request <ds_requests>` identified by this |
+ | | | integral, unique identifier. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | status | no | Filter for :ref:`ds_requests` whose status is the status |
+ | | | specified. The status can be ``draft``, ``submitted``, ``pending``, ``rejected``, or |
+ | | | ``complete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | xmlId | no | Filter for :ref:`ds_requests` that have the given |
+ | | | :ref:`ds-xmlid`. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservice_requests?status=draft HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:lastUpdated: The date and time at which the :term:`DSR <Delivery Service Request>` was last updated, in ISO format.
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 20:14:07 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: UBp3nklJr2x2cAW/TKbhXMVJH6+OduxUaEBGbX4P7IahDk3VkaTd9LsQj01zgFEnZLwHrikpwFfNlUO32RAZOA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 19:14:07 GMT
+ Content-Length: 872
+
+ {
+ "response": [
+ {
+ "authorId": 2,
+ "author": "admin",
+ "changeType": "update",
+ "createdAt": "2020-02-24 19:11:12+00",
+ "id": 1,
+ "lastEditedBy": "admin",
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-24 19:11:12+00",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "0001-01-01 00:00:00+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "draft"
+ }
+ ]
+ }
+
+.. _to-api-deliveryservice-requests-post:
+
+``POST``
+========
+
+.. note:: This route does NOT do the same thing as :ref:`POST deliveryservices/request <to-api-deliveryservices-request>`.
+
+Creates a new :term:`Delivery Service Request`.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+:changeType: The action that you want to perform on the delivery service. It can be "create", "update", or "delete".
+:status: The status of your request. Can be "draft", "submitted", "rejected", "pending", or "complete".
Review comment:
Field aligned in 8d99deb8fd.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384058765
##########
File path: docs/source/api/v2/deliveryservice_requests_id_assign.rst
##########
@@ -0,0 +1,177 @@
+..
+..
+.. 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-deliveryservice_requests-id-assign:
+
+******************************************
+``deliveryservice_requests/{{ID}}/assign``
+******************************************
+Assign a :term:`Delivery Service Request` to a user.
+
+``PUT``
+=======
+:Auth. Required: Yes
+:Roles Required: "admin" or "operations"
+:Response Type: Object
+
+Request Structure
+-----------------
+
Review comment:
request field definitions?
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386153049
##########
File path: docs/source/api/v2/deliveryservice_requests_id_status.rst
##########
@@ -0,0 +1,177 @@
+..
+..
+.. 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-deliveryservice_requests-id-status:
+
+******************************************
+``deliveryservice_requests/{{ID}}/assign``
+******************************************
+Sets the status of a :term:`Delivery Service Request`.
+
+``PUT``
+=======
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+
Review comment:
Field definitions added in 6d4154ac02.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384068153
##########
File path: docs/source/api/v2/steering.rst
##########
@@ -0,0 +1,97 @@
+..
+..
+.. 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-steering:
+
+************
+``steering``
+************
+
+``GET``
+=======
+Gets a list of all :ref:`Steering Targets <steering-qht>` in the Traffic Ops database.
+
+:Auth. Required: Yes
+:Roles Required: "Portal", "Steering", "Federation", "operations" or "admin"
+:Response Type: Array
+
+Request Structure
+-----------------
+No parameters available.
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/steering HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:deliveryService: A string that is the :ref:`ds-xmlid` of the steering :term:`Delivery Service`
+:clientSteering: Whether this is a :ref:`client steering <ds-client-steering>` delivery service.
+:targets: The delivery services that the steering delivery service targets.
+:filters: Filters of type :ref:`STEERING_REGEXP <ds-steering-regexp>` that exist on either of the targets.
Review comment:
Sub-property definitions?
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386153032
##########
File path: docs/source/api/v2/deliveryservice_request_comments.rst
##########
@@ -0,0 +1,296 @@
+..
+..
+.. 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-deliveryservice_request_comments:
+
+************************************
+``deliveryservice_request_comments``
+************************************
+
+``GET``
+=======
+Gets delivery service request comments.
+
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+
+.. table:: Request Query Parameters
+
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +==========================+==========+=====================================================================================================================================================+
+ | author | no | Filter for :ref:`Delivery Service Request <ds_requests>` comments submitted by the user identified by this username |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Filter for :ref:`Delivery Service Request <ds_requests>` comments submitted by the user identified by this integral, unique identifier |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | deliveryServiceRequestId | no | Filter for :ref:`Delivery Service Request <ds_requests>` comments submitted for the delivery service identified by this integral, unique identifier |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Filter for the :ref:`Delivery Service Request <ds_requests>` comment identified by this integral, unique identifier |
+ +--------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservice_request_comments HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 21:00:26 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: RaJZS1XFJ4oIxVKyyDjTuoQY7gPOmm5EuIL4AgHpyQpuaaNviw0XhGC4V/AKf/Ws6zXLgIUc4OyvMsTxnrilww==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 20:00:26 GMT
+ Content-Length: 207
+
+ {
+ "response": [
+ {
+ "authorId": 2,
+ "author": "admin",
+ "deliveryServiceRequestId": 2,
+ "id": 3,
+ "lastUpdated": "2020-02-24 19:59:46+00",
+ "value": "Changing to a different origin for now.",
+ "xmlId": "demo1"
+ },
+ {
+ "authorId": 2,
+ "author": "admin",
+ "deliveryServiceRequestId": 2,
+ "id": 4,
+ "lastUpdated": "2020-02-24 19:59:55+00",
+ "value": "Using HTTPS.",
+ "xmlId": "demo1"
+ }
+ ]
+ }
+
+``POST``
+========
+Allows user to create a :term:`Delivery Service Request` comment.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+
+.. code-block:: http
+ :caption: Request Example
+
+ POST /api/2.0/deliveryservice_request_comments HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 111
+
+ {
+ "deliveryServiceRequestId": 2,
+ "value": "Does anyone have time to review my delivery service request?"
+ }
+
+Response Structure
+------------------
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 21:02:20 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: LiakFP6L7PrnFO5kLXftx7WQoKn3bGpIJT5N15PvNG2sHridRMV3k23eRJM66ET0LcRfMOrQgRiydE+XgA8h0A==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 20:02:20 GMT
+ Content-Length: 223
+
+ {
+ "alerts": [
+ {
+ "text": "deliveryservice_request_comment was created.",
+ "level": "success"
+ }
+ ],
+ "response": {
+ "authorId": 2,
+ "author": null,
+ "deliveryServiceRequestId": 2,
+ "id": 6,
+ "lastUpdated": "2020-02-24 20:02:20+00",
+ "value": "Does anyone have time to review my delivery service request?",
+ "xmlId": null
+ }
+ }
+
+``PUT``
+=======
+
+Updates a delivery service request comment.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+
+Request Structure
+-----------------
+
+.. table:: Request Query Parameters
+
+ +-----------+----------+-----------------------------------------------------------------------------------+
+ | Parameter | Required | Description |
+ +===========+==========+===================================================================================+
+ | id | yes | The integral, unique identifier of the delivery service comment that you wish to |
+ | | | update. |
+ +-----------+----------+-----------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ PUT /api/2.0/deliveryservice_request_comments?id=6 HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 166
+
+ {
+ "deliveryServiceRequestId": 2,
+ "value": "Update: We no longer need this, feel free to reject.\n\nDoes anyone have time to review my delivery service request?"
+ }
+
+Response Structure
+------------------
+
Review comment:
Field definitions added in 6d4154ac02.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r409195673
##########
File path: docs/source/api/v2/asns.rst
##########
@@ -133,11 +133,11 @@ Request Structure
Response Structure
------------------
-:asn: An :abbr:`ASN (Autonomous System Number)` as specified by IANA for identifying a service provider
-:cachegroup: A string that is the :ref:`cache-group-name` of the :term:`Cache Group` that is associated with this :abbr:`ASN (Autonomous System Number)`
-:cachegroupId: An integer that is the :ref:`cache-group-id` of the :term:`Cache Group` that is associated with this :abbr:`ASN (Autonomous System Number)`
-:id: An integral, unique identifier for this association between an :abbr:`ASN (Autonomous System Number)` and a :term:`Cache Group`
-:lastUpdated: The time and date this server entry was last updated in an ISO-like format
+:asn: An :abbr:`ASN (Autonomous System Number)` as specified by IANA for identifying a service provider
+:cachegroup: A string that is the :ref:`cache-group-name` of the :term:`Cache Group` that is associated with this :abbr:`ASN (Autonomous System Number)`
+:cachegroupId: An integer that is the :ref:`cache-group-id` of the :term:`Cache Group` that is associated with this :abbr:`ASN (Autonomous System Number)`
+:id: An integral, unique identifier for this association between an :abbr:`ASN (Autonomous System Number)` and a :term:`Cache Group`
+:lastUpdated: The time and date this server entry was last updated in an ISO-like format
Review comment:
Aligned fields with spaces in c2b73f08e9.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384060749
##########
File path: docs/source/api/v2/deliveryservice_requests.rst
##########
@@ -0,0 +1,767 @@
+..
+..
+.. 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-deliveryservice-requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`.
+
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+==========================================================================================+
+ | assignee | no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this username. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | assigneeId| no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | author | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this username |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | authorId | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | changeType| no | Filter for :ref:`ds_requests` of the change type specified. |
+ | | | Can be ``create``, ``update``, or ``delete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | id | no | Filter for the :ref:`Delivery Service Request <ds_requests>` identified by this |
+ | | | integral, unique identifier. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | status | no | Filter for :ref:`ds_requests` whose status is the status |
+ | | | specified. The status can be ``draft``, ``submitted``, ``pending``, ``rejected``, or |
+ | | | ``complete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | xmlId | no | Filter for :ref:`ds_requests` that have the given |
+ | | | :ref:`ds-xmlid`. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservice_requests?status=draft HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:lastUpdated: The date and time at which the :term:`DSR <Delivery Service Request>` was last updated, in ISO format.
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 20:14:07 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: UBp3nklJr2x2cAW/TKbhXMVJH6+OduxUaEBGbX4P7IahDk3VkaTd9LsQj01zgFEnZLwHrikpwFfNlUO32RAZOA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 19:14:07 GMT
+ Content-Length: 872
+
+ {
+ "response": [
+ {
+ "authorId": 2,
+ "author": "admin",
+ "changeType": "update",
+ "createdAt": "2020-02-24 19:11:12+00",
+ "id": 1,
+ "lastEditedBy": "admin",
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-24 19:11:12+00",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "0001-01-01 00:00:00+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "draft"
+ }
+ ]
+ }
+
+.. _to-api-deliveryservice-requests-post:
+
+``POST``
+========
+
+.. note:: This route does NOT do the same thing as :ref:`POST deliveryservices/request <to-api-deliveryservices-request>`.
+
+Creates a new :term:`Delivery Service Request`.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+:changeType: The action that you want to perform on the delivery service. It can be "create", "update", or "delete".
+:status: The status of your request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+:deliveryService: The :term:`Delivery Service` that you have submitted for review as part of this request.
+
+.. code-block:: http
+ :caption: Request Example
+
+ POST /api/2.0/deliveryservice_requests HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 1979
+
+ {
+ "changeType": "update",
+ "status": "draft",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2020-02-13 16:43:54+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ }
+ }
+
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:lastUpdated: The date and time at which the :term:`DSR <Delivery Service Request>` was last updated, in ISO format.
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 20:11:12 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: aWIrFTwUGnLq56WNZPL/FgOi/NwAVUtOy4iqjFPwx4gj7RMZ6+nd++bQKIiasBl8ytAY0WmFvNnmm30Fq9mLpA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 19:11:12 GMT
+ Content-Length: 901
+
+ {
+ "alerts": [
+ {
+ "text": "deliveryservice_request was created.",
+ "level": "success"
+ }
+ ],
+ "response": {
+ "authorId": 2,
+ "author": null,
+ "changeType": "update",
+ "createdAt": null,
+ "id": 1,
+ "lastEditedBy": null,
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-24 19:11:12+00",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "0001-01-01 00:00:00+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "draft"
+ }
+ }
+
+``PUT``
+=======
+
+Updates an existing :ref:`Delivery Service Request <ds_requests>`.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+
+.. table:: Request Query Parameters
+
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+==========================================================================================+
+ | id | yes | The integral, unique identifier of the :ref:`Delivery Service Request <ds_requests>` that|
+ | | | you want to update. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ PUT /api/2.0/deliveryservice_requests?id=1 HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 2256
+
+ {
+ "authorId": 2,
+ "author": "admin",
+ "changeType": "update",
+ "createdAt": "2020-02-24 19:11:12+00",
+ "id": 1,
+ "lastEditedBy": "admin",
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-24 19:33:26+00",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "0001-01-01 00:00:00+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": "",
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "submitted"
+ }
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
Review comment:
sub-property definitions?
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386166970
##########
File path: docs/source/api/v2/servers_id_deliveryservices.rst
##########
@@ -239,3 +239,81 @@ Response Structure
.. [#tenancy] Only the :term:`Delivery Services` visible to the requesting user's :term:`Tenant` will appear, regardless of their :term:`Role` or the :term:`Delivery Services`' actual 'server assignment' status.
+
+``POST``
+========
+Assign an arbitrary number of delivery services to a single server.
+
+:Auth. Required: Yes
+:Roles Required: "admin" or "operations"
+:Response Type: Object
+
+Request Structure
+-----------------
+.. table:: Request Path Parameters
+
+ +------+----------+---------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +------+----------+---------------------------------------------------------------------------------------------+
+ | id | Yes | The integral, unique identifier of the server that you want to assign delivery services to. |
+ +------+----------+---------------------------------------------------------------------------------------------+
+
+.. table:: Request Query Parameters
+
+ +---------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=========+==========+==========================================================================================+
+ | replace | Yes | Must be a 1, true, 0, or false. Although this query parameter is required, it is unused. |
Review comment:
I was confused because the Delivery Services that the server is already assigned to are not returned in `:dsIds:` in the response, regardless of the value of `:replace:`. Corrected in 6d4154ac02.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384062520
##########
File path: docs/source/api/v2/federations_all.rst
##########
@@ -0,0 +1,88 @@
+..
+..
+.. 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-federations-all:
+
+*******************
+``federations/all``
+*******************
+
+``GET``
+=======
+Retrieves a list of :term:`Federation` mappings (also called :term:`Federation` Resolvers) for the current user.
+
+:Auth. Required: Yes
+:Roles Required: "admin"
+:Response Type: Array
+
+Request Structure
+-----------------
+No parameters available.
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/federations/all HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+
Review comment:
response field definitions?
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384058887
##########
File path: docs/source/api/v2/deliveryservice_requests_id_assign.rst
##########
@@ -0,0 +1,177 @@
+..
+..
+.. 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-deliveryservice_requests-id-assign:
+
+******************************************
+``deliveryservice_requests/{{ID}}/assign``
+******************************************
+Assign a :term:`Delivery Service Request` to a user.
+
+``PUT``
+=======
+:Auth. Required: Yes
+:Roles Required: "admin" or "operations"
+:Response Type: Object
+
+Request Structure
+-----------------
+
+.. code-block:: http
+ :caption: Request Example
+
+ PUT /api/2.0/deliveryservice_requests/1/assign HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 28
+
+ {
+ "id": 1,
+ "assigneeId": 2
+ }
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
Review comment:
sub-property definitions?
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386174357
##########
File path: docs/source/api/v2/steering.rst
##########
@@ -0,0 +1,97 @@
+..
+..
+.. 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-steering:
+
+************
+``steering``
+************
+
+``GET``
+=======
+Gets a list of all :ref:`Steering Targets <steering-qht>` in the Traffic Ops database.
+
+:Auth. Required: Yes
+:Roles Required: "Portal", "Steering", "Federation", "operations" or "admin"
+:Response Type: Array
+
+Request Structure
+-----------------
+No parameters available.
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/steering HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:deliveryService: A string that is the :ref:`ds-xmlid` of the steering :term:`Delivery Service`
+:clientSteering: Whether this is a :ref:`client steering <ds-client-steering>` delivery service.
+:targets: The delivery services that the steering delivery service targets.
Review comment:
Sub-property definitions for `:targets:` added in 702ae340f6.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386154226
##########
File path: docs/source/api/v2/servers_details.rst
##########
@@ -0,0 +1,117 @@
+..
+..
+.. 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-servers-details:
+
+*******************
+``servers/details``
+*******************
+Retrieves details of :ref:`tp-configure-servers`.
+
+
+``GET``
+=======
+:Auth. Required: Yes
+:Roles Required: "read-only"
Review comment:
Changed to None in 98a96c343c.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386121884
##########
File path: docs/source/api/v2/deliveryservice_requests.rst
##########
@@ -0,0 +1,767 @@
+..
+..
+.. 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-deliveryservice-requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`.
+
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+==========================================================================================+
+ | assignee | no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this username. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | assigneeId| no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | author | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this username |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | authorId | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | changeType| no | Filter for :ref:`ds_requests` of the change type specified. |
+ | | | Can be ``create``, ``update``, or ``delete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | id | no | Filter for the :ref:`Delivery Service Request <ds_requests>` identified by this |
+ | | | integral, unique identifier. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | status | no | Filter for :ref:`ds_requests` whose status is the status |
+ | | | specified. The status can be ``draft``, ``submitted``, ``pending``, ``rejected``, or |
+ | | | ``complete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | xmlId | no | Filter for :ref:`ds_requests` that have the given |
+ | | | :ref:`ds-xmlid`. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservice_requests?status=draft HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:lastUpdated: The date and time at which the :term:`DSR <Delivery Service Request>` was last updated, in ISO format.
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+
+.. 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-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 20:14:07 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: UBp3nklJr2x2cAW/TKbhXMVJH6+OduxUaEBGbX4P7IahDk3VkaTd9LsQj01zgFEnZLwHrikpwFfNlUO32RAZOA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 19:14:07 GMT
+ Content-Length: 872
+
+ {
+ "response": [
+ {
+ "authorId": 2,
+ "author": "admin",
+ "changeType": "update",
+ "createdAt": "2020-02-24 19:11:12+00",
+ "id": 1,
+ "lastEditedBy": "admin",
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-24 19:11:12+00",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "0001-01-01 00:00:00+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "draft"
+ }
+ ]
+ }
+
+.. _to-api-deliveryservice-requests-post:
+
+``POST``
+========
+
+.. note:: This route does NOT do the same thing as :ref:`POST deliveryservices/request <to-api-deliveryservices-request>`.
+
+Creates a new :term:`Delivery Service Request`.
+
+:Auth. Required: Yes
+:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering"
+:Response Type: Object
+
+Request Structure
+-----------------
+:changeType: The action that you want to perform on the delivery service. It can be "create", "update", or "delete".
+:status: The status of your request. Can be "draft", "submitted", "rejected", "pending", or "complete".
+:deliveryService: The :term:`Delivery Service` that you have submitted for review as part of this request.
+
+.. code-block:: http
+ :caption: Request Example
+
+ POST /api/2.0/deliveryservice_requests HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+ Content-Length: 1979
+
+ {
+ "changeType": "update",
+ "status": "draft",
+ "deliveryService": {
+ "active": false,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": "CDN-in-a-Box",
+ "checkPath": null,
+ "displayName": "Demo 1",
+ "dnsBypassCname": null,
+ "dnsBypassIp": null,
+ "dnsBypassIp6": null,
+ "dnsBypassTtl": null,
+ "dscp": 0,
+ "edgeHeaderRewrite": null,
+ "geoLimit": 0,
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": 0,
+ "globalMaxMbps": null,
+ "globalMaxTps": null,
+ "httpBypassFqdn": null,
+ "id": 1,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2020-02-13 16:43:54+00",
+ "logsEnabled": true,
+ "longDesc": "Apachecon North America 2018",
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "setNumber": 0,
+ "pattern": ".*\\.demo1\\..*"
+ }
+ ],
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 42,
+ "missLong": -88,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 2,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "video",
+ "signed": false,
+ "sslKeyVersion": 1,
+ "tenantId": 1,
+ "type": "HTTP",
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": [
+ "http://video.demo1.mycdn.ciab.test",
+ "https://video.demo1.mycdn.ciab.test"
+ ],
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": "root",
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": [
+ "abc",
+ "pdq",
+ "xxx",
+ "zyx"
+ ],
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ }
+ }
+
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
Review comment:
Fields aligned in 8d99deb8fd.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r383951421
##########
File path: docs/source/api/v2/riak_ping.rst
##########
@@ -0,0 +1,66 @@
+..
+..
+.. 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-riak-ping:
+
+*********************************************
+``riak/ping``
+*********************************************
Review comment:
Line length matched in aa00b978b0.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384067054
##########
File path: docs/source/api/v2/servers_id_deliveryservices.rst
##########
@@ -239,3 +239,81 @@ Response Structure
.. [#tenancy] Only the :term:`Delivery Services` visible to the requesting user's :term:`Tenant` will appear, regardless of their :term:`Role` or the :term:`Delivery Services`' actual 'server assignment' status.
+
+``POST``
+========
+Assign an arbitrary number of delivery services to a single server.
+
+:Auth. Required: Yes
+:Roles Required: "admin" or "operations"
+:Response Type: Object
+
+Request Structure
+-----------------
+.. table:: Request Path Parameters
+
+ +------+----------+---------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +------+----------+---------------------------------------------------------------------------------------------+
+ | id | Yes | The integral, unique identifier of the server that you want to assign delivery services to. |
+ +------+----------+---------------------------------------------------------------------------------------------+
+
+.. table:: Request Query Parameters
+
+ +---------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=========+==========+==========================================================================================+
+ | replace | Yes | Must be a 1, true, 0, or false. Although this query parameter is required, it is unused. |
+ +---------+----------+------------------------------------------------------------------------------------------+
+
+The request body is an array of IDs of delivery services that you want to assign to the server. The array can be empty, but it must be provided.
Review comment:
doesn't need to be linked again but should be "Delivery Services" not "delivery services"
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] mhoppa commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
mhoppa commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r383922880
##########
File path: docs/source/api/v2/federations_all.rst
##########
@@ -0,0 +1,88 @@
+..
+..
+.. 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-federations-all:
+
+***************************
+``federations/all``
+***************************
Review comment:
the `*` lines should match the length
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384067534
##########
File path: docs/source/api/v2/steering.rst
##########
@@ -0,0 +1,97 @@
+..
+..
+.. 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-steering:
+
+************
+``steering``
+************
+
+``GET``
+=======
+Gets a list of all :ref:`Steering Targets <steering-qht>` in the Traffic Ops database.
+
+:Auth. Required: Yes
+:Roles Required: "Portal", "Steering", "Federation", "operations" or "admin"
+:Response Type: Array
+
+Request Structure
+-----------------
+No parameters available.
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/steering HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:deliveryService: A string that is the :ref:`ds-xmlid` of the steering :term:`Delivery Service`
+:clientSteering: Whether this is a :ref:`client steering <ds-client-steering>` delivery service.
Review comment:
Doesn't need to be linked again but should be "Delivery Service" not "delivery service"
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384065529
##########
File path: docs/source/api/v2/servers_details.rst
##########
@@ -0,0 +1,117 @@
+..
+..
+.. 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-servers-details:
+
+*******************
+``servers/details``
+*******************
+Retrieves details of :ref:`tp-configure-servers`.
+
+
+``GET``
+=======
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +----------------+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +================+========================================+================================================================================================================================================================+
+ | hostName | Required if no physLocationID provided | Return only the servers with this (short) hostname. Capitalization of "hostName" is important. |
+ +----------------+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | physLocationID | Required if no hostName provided | Return only servers with this integral, unique identifier for the physical location where the server resides. Capitalization of "physLocationID" is important. |
Review comment:
How would you capitalize an id?
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386153057
##########
File path: docs/source/api/v2/federations_all.rst
##########
@@ -0,0 +1,88 @@
+..
+..
+.. 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-federations-all:
+
+*******************
+``federations/all``
+*******************
+
+``GET``
+=======
+Retrieves a list of :term:`Federation` mappings (also called :term:`Federation` Resolvers) for the current user.
+
+:Auth. Required: Yes
+:Roles Required: "admin"
+:Response Type: Array
+
+Request Structure
+-----------------
+No parameters available.
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/federations/all HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+
Review comment:
Field definitions added in 6d4154ac02.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] mhoppa commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
mhoppa commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r383903333
##########
File path: docs/source/api/v2/cdns_dnsseckeys_generate.rst
##########
@@ -13,10 +13,10 @@
.. limitations under the License.
..
-.. _to-api-deliveryservices-dnsseckeys-generate:
+.. _to-api-cdns-dnsseckeys-generate:
****************************************
-``deliveryservices/dnsseckeys/generate``
+``cdns/dnsseckeys/generate``
****************************************
Review comment:
great catch but the length of the surrounding `*` should match the line length of the title
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r409195711
##########
File path: docs/source/api/v2/servers_id_deliveryservices.rst
##########
@@ -67,78 +67,78 @@ Request Structure
Response Structure
------------------
-:active: A boolean that defines :ref:`ds-active`.
-:anonymousBlockingEnabled: A boolean that defines :ref:`ds-anonymous-blocking`
-:cacheurl: A :ref:`ds-cacheurl`
+:active: A boolean that defines :ref:`ds-active`.
+:anonymousBlockingEnabled: A boolean that defines :ref:`ds-anonymous-blocking`
+:cacheurl: A :ref:`ds-cacheurl`
.. deprecated:: ATCv3.0
This field has been deprecated in Traffic Control 3.x and is subject to removal in Traffic Control 4.x or later
-:ccrDnsTtl: The :ref:`ds-dns-ttl` - named "ccrDnsTtl" for legacy reasons
-:cdnId: The integral, unique identifier of the :ref:`ds-cdn` to which the :term:`Delivery Service` belongs
-:cdnName: Name of the :ref:`ds-cdn` to which the :term:`Delivery Service` belongs
-:checkPath: A :ref:`ds-check-path`
-:consistentHashRegex: A :ref:`ds-consistent-hashing-regex`
-:consistentHashQueryParams: An array of :ref:`ds-consistent-hashing-qparams`
-:deepCachingType: The :ref:`ds-deep-caching` setting for this :term:`Delivery Service`
-:displayName: The :ref:`ds-display-name`
-:dnsBypassCname: A :ref:`ds-dns-bypass-cname`
-:dnsBypassIp: A :ref:`ds-dns-bypass-ip`
-:dnsBypassIp6: A :ref:`ds-dns-bypass-ipv6`
-:dnsBypassTtl: The :ref:`ds-dns-bypass-ttl`
-:dscp: A :ref:`ds-dscp` to be used within the :term:`Delivery Service`
-:ecsEnabled: A boolean that defines the :ref:`ds-ecs` setting on this :term:`Delivery Service`
-:edgeHeaderRewrite: A set of :ref:`ds-edge-header-rw-rules`
-:exampleURLs: An array of :ref:`ds-example-urls`
-:fqPacingRate: The :ref:`ds-fqpr`
-:geoLimit: An integer that defines the :ref:`ds-geo-limit`
-:geoLimitCountries: A string containing a comma-separated list defining the :ref:`ds-geo-limit-countries`
-:geoLimitRedirectUrl: A :ref:`ds-geo-limit-redirect-url`
-:geoProvider: The :ref:`ds-geo-provider`
-:globalMaxMbps: The :ref:`ds-global-max-mbps`
-:globalMaxTps: The :ref:`ds-global-max-tps`
-:httpBypassFqdn: A :ref:`ds-http-bypass-fqdn`
-:id: An integral, unique identifier for this :term:`Delivery Service`
-:infoUrl: An :ref:`ds-info-url`
-:initialDispersion: The :ref:`ds-initial-dispersion`
-:ipv6RoutingEnabled: A boolean that defines the :ref:`ds-ipv6-routing` setting on this :term:`Delivery Service`
-:lastUpdated: The date and time at which this :term:`Delivery Service` was last updated, in :rfc:`3339` format
-:logsEnabled: A boolean that defines the :ref:`ds-logs-enabled` setting on this :term:`Delivery Service`
-:longDesc: The :ref:`ds-longdesc` of this :term:`Delivery Service`
-:longDesc1: The :ref:`ds-longdesc2` of this :term:`Delivery Service`
-:longDesc2: The :ref:`ds-longdesc3` of this :term:`Delivery Service`
-:matchList: The :term:`Delivery Service`'s :ref:`ds-matchlist`
-
- :pattern: A regular expression - the use of this pattern is dependent on the ``type`` field (backslashes are escaped)
- :setNumber: An integer that provides explicit ordering of :ref:`ds-matchlist` items - this is used as a priority ranking by Traffic Router, and is not guaranteed to correspond to the ordering of items in the array.
- :type: The type of match performed using ``pattern``.
-
-:maxDnsAnswers: The :ref:`ds-max-dns-answers` allowed for this :term:`Delivery Service`
-:maxOriginConnections: The :ref:`ds-max-origin-connections`
-:midHeaderRewrite: A set of :ref:`ds-mid-header-rw-rules`
-:missLat: The :ref:`ds-geo-miss-default-latitude` used by this :term:`Delivery Service`
-:missLong: The :ref:`ds-geo-miss-default-longitude` used by this :term:`Delivery Service`
-:multiSiteOrigin: A boolean that defines the use of :ref:`ds-multi-site-origin` by this :term:`Delivery Service`
-:orgServerFqdn: The :ref:`ds-origin-url`
-:originShield: A :ref:`ds-origin-shield` string
-:profileDescription: The :ref:`profile-description` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated
-:profileId: The :ref:`profile-id` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated
-:profileName: The :ref:`profile-name` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated
-:protocol: An integral, unique identifier that corresponds to the :ref:`ds-protocol` used by this :term:`Delivery Service`
-:qstringIgnore: An integral, unique identifier that corresponds to the :ref:`ds-qstring-handling` setting on this :term:`Delivery Service`
-:rangeRequestHandling: An integral, unique identifier that corresponds to the :ref:`ds-range-request-handling` setting on this :term:`Delivery Service`
-:regexRemap: A :ref:`ds-regex-remap`
-:regionalGeoBlocking: A boolean defining the :ref:`ds-regionalgeo` setting on this :term:`Delivery Service`
-:remapText: :ref:`ds-raw-remap`
-:signed: ``true`` if and only if ``signingAlgorithm`` is not ``null``, ``false`` otherwise
-:signingAlgorithm: Either a :ref:`ds-signing-algorithm` or ``null`` to indicate URL/URI signing is not implemented on this :term:`Delivery Service`
-:sslKeyVersion: This integer indicates the :ref:`ds-ssl-key-version`
-:tenantId: The integral, unique identifier of the :ref:`ds-tenant` who owns this :term:`Delivery Service`
-:trRequestHeaders: If defined, this defines the :ref:`ds-tr-req-headers` used by Traffic Router for this :term:`Delivery Service`
-:trResponseHeaders: If defined, this defines the :ref:`ds-tr-resp-headers` used by Traffic Router for this :term:`Delivery Service`
-:type: The :ref:`ds-types` of this :term:`Delivery Service`
-:typeId: The integral, unique identifier of the :ref:`ds-types` of this :term:`Delivery Service`
-:xmlId: This :term:`Delivery Service`'s :ref:`ds-xmlid`
+:ccrDnsTtl: The :ref:`ds-dns-ttl` - named "ccrDnsTtl" for legacy reasons
+:cdnId: The integral, unique identifier of the :ref:`ds-cdn` to which the :term:`Delivery Service` belongs
+:cdnName: Name of the :ref:`ds-cdn` to which the :term:`Delivery Service` belongs
+:checkPath: A :ref:`ds-check-path`
+:consistentHashRegex: A :ref:`ds-consistent-hashing-regex`
+:consistentHashQueryParams: An array of :ref:`ds-consistent-hashing-qparams`
+:deepCachingType: The :ref:`ds-deep-caching` setting for this :term:`Delivery Service`
+:displayName: The :ref:`ds-display-name`
+:dnsBypassCname: A :ref:`ds-dns-bypass-cname`
+:dnsBypassIp: A :ref:`ds-dns-bypass-ip`
+:dnsBypassIp6: A :ref:`ds-dns-bypass-ipv6`
+:dnsBypassTtl: The :ref:`ds-dns-bypass-ttl`
+:dscp: A :ref:`ds-dscp` to be used within the :term:`Delivery Service`
+:ecsEnabled: A boolean that defines the :ref:`ds-ecs` setting on this :term:`Delivery Service`
+:edgeHeaderRewrite: A set of :ref:`ds-edge-header-rw-rules`
+:exampleURLs: An array of :ref:`ds-example-urls`
+:fqPacingRate: The :ref:`ds-fqpr`
+:geoLimit: An integer that defines the :ref:`ds-geo-limit`
+:geoLimitCountries: A string containing a comma-separated list defining the :ref:`ds-geo-limit-countries`
+:geoLimitRedirectUrl: A :ref:`ds-geo-limit-redirect-url`
+:geoProvider: The :ref:`ds-geo-provider`
+:globalMaxMbps: The :ref:`ds-global-max-mbps`
+:globalMaxTps: The :ref:`ds-global-max-tps`
+:httpBypassFqdn: A :ref:`ds-http-bypass-fqdn`
+:id: An integral, unique identifier for this :term:`Delivery Service`
+:infoUrl: An :ref:`ds-info-url`
+:initialDispersion: The :ref:`ds-initial-dispersion`
+:ipv6RoutingEnabled: A boolean that defines the :ref:`ds-ipv6-routing` setting on this :term:`Delivery Service`
+:lastUpdated: The date and time at which this :term:`Delivery Service` was last updated, in :rfc:`3339` format
+:logsEnabled: A boolean that defines the :ref:`ds-logs-enabled` setting on this :term:`Delivery Service`
+:longDesc: The :ref:`ds-longdesc` of this :term:`Delivery Service`
+:longDesc1: The :ref:`ds-longdesc2` of this :term:`Delivery Service`
+:longDesc2: The :ref:`ds-longdesc3` of this :term:`Delivery Service`
+:matchList: The :term:`Delivery Service`'s :ref:`ds-matchlist`
+
+ :pattern: A regular expression - the use of this pattern is dependent on the ``type`` field (backslashes are escaped)
+ :setNumber: An integer that provides explicit ordering of :ref:`ds-matchlist` items - this is used as a priority ranking by Traffic Router, and is not guaranteed to correspond to the ordering of items in the array.
+ :type: The type of match performed using ``pattern``.
+
+:maxDnsAnswers: The :ref:`ds-max-dns-answers` allowed for this :term:`Delivery Service`
+:maxOriginConnections: The :ref:`ds-max-origin-connections`
+:midHeaderRewrite: A set of :ref:`ds-mid-header-rw-rules`
+:missLat: The :ref:`ds-geo-miss-default-latitude` used by this :term:`Delivery Service`
+:missLong: The :ref:`ds-geo-miss-default-longitude` used by this :term:`Delivery Service`
+:multiSiteOrigin: A boolean that defines the use of :ref:`ds-multi-site-origin` by this :term:`Delivery Service`
+:orgServerFqdn: The :ref:`ds-origin-url`
+:originShield: A :ref:`ds-origin-shield` string
+:profileDescription: The :ref:`profile-description` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated
+:profileId: The :ref:`profile-id` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated
+:profileName: The :ref:`profile-name` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated
+:protocol: An integral, unique identifier that corresponds to the :ref:`ds-protocol` used by this :term:`Delivery Service`
+:qstringIgnore: An integral, unique identifier that corresponds to the :ref:`ds-qstring-handling` setting on this :term:`Delivery Service`
+:rangeRequestHandling: An integral, unique identifier that corresponds to the :ref:`ds-range-request-handling` setting on this :term:`Delivery Service`
+:regexRemap: A :ref:`ds-regex-remap`
+:regionalGeoBlocking: A boolean defining the :ref:`ds-regionalgeo` setting on this :term:`Delivery Service`
+:remapText: :ref:`ds-raw-remap`
+:signed: ``true`` if and only if ``signingAlgorithm`` is not ``null``, ``false`` otherwise
+:signingAlgorithm: Either a :ref:`ds-signing-algorithm` or ``null`` to indicate URL/URI signing is not implemented on this :term:`Delivery Service`
+:sslKeyVersion: This integer indicates the :ref:`ds-ssl-key-version`
+:tenantId: The integral, unique identifier of the :ref:`ds-tenant` who owns this :term:`Delivery Service`
+:trRequestHeaders: If defined, this defines the :ref:`ds-tr-req-headers` used by Traffic Router for this :term:`Delivery Service`
+:trResponseHeaders: If defined, this defines the :ref:`ds-tr-resp-headers` used by Traffic Router for this :term:`Delivery Service`
+:type: The :ref:`ds-types` of this :term:`Delivery Service`
+:typeId: The integral, unique identifier of the :ref:`ds-types` of this :term:`Delivery Service`
+:xmlId: This :term:`Delivery Service`'s :ref:`ds-xmlid`
Review comment:
Aligned fields with spaces in c2b73f08e9.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r399477205
##########
File path: docs/source/api/v2/servers_id_deliveryservices.rst
##########
@@ -67,78 +67,78 @@ Request Structure
Response Structure
------------------
-:active: A boolean that defines :ref:`ds-active`.
-:anonymousBlockingEnabled: A boolean that defines :ref:`ds-anonymous-blocking`
-:cacheurl: A :ref:`ds-cacheurl`
+:active: A boolean that defines :ref:`ds-active`.
+:anonymousBlockingEnabled: A boolean that defines :ref:`ds-anonymous-blocking`
+:cacheurl: A :ref:`ds-cacheurl`
.. deprecated:: ATCv3.0
This field has been deprecated in Traffic Control 3.x and is subject to removal in Traffic Control 4.x or later
-:ccrDnsTtl: The :ref:`ds-dns-ttl` - named "ccrDnsTtl" for legacy reasons
-:cdnId: The integral, unique identifier of the :ref:`ds-cdn` to which the :term:`Delivery Service` belongs
-:cdnName: Name of the :ref:`ds-cdn` to which the :term:`Delivery Service` belongs
-:checkPath: A :ref:`ds-check-path`
-:consistentHashRegex: A :ref:`ds-consistent-hashing-regex`
-:consistentHashQueryParams: An array of :ref:`ds-consistent-hashing-qparams`
-:deepCachingType: The :ref:`ds-deep-caching` setting for this :term:`Delivery Service`
-:displayName: The :ref:`ds-display-name`
-:dnsBypassCname: A :ref:`ds-dns-bypass-cname`
-:dnsBypassIp: A :ref:`ds-dns-bypass-ip`
-:dnsBypassIp6: A :ref:`ds-dns-bypass-ipv6`
-:dnsBypassTtl: The :ref:`ds-dns-bypass-ttl`
-:dscp: A :ref:`ds-dscp` to be used within the :term:`Delivery Service`
-:ecsEnabled: A boolean that defines the :ref:`ds-ecs` setting on this :term:`Delivery Service`
-:edgeHeaderRewrite: A set of :ref:`ds-edge-header-rw-rules`
-:exampleURLs: An array of :ref:`ds-example-urls`
-:fqPacingRate: The :ref:`ds-fqpr`
-:geoLimit: An integer that defines the :ref:`ds-geo-limit`
-:geoLimitCountries: A string containing a comma-separated list defining the :ref:`ds-geo-limit-countries`
-:geoLimitRedirectUrl: A :ref:`ds-geo-limit-redirect-url`
-:geoProvider: The :ref:`ds-geo-provider`
-:globalMaxMbps: The :ref:`ds-global-max-mbps`
-:globalMaxTps: The :ref:`ds-global-max-tps`
-:httpBypassFqdn: A :ref:`ds-http-bypass-fqdn`
-:id: An integral, unique identifier for this :term:`Delivery Service`
-:infoUrl: An :ref:`ds-info-url`
-:initialDispersion: The :ref:`ds-initial-dispersion`
-:ipv6RoutingEnabled: A boolean that defines the :ref:`ds-ipv6-routing` setting on this :term:`Delivery Service`
-:lastUpdated: The date and time at which this :term:`Delivery Service` was last updated, in :rfc:`3339` format
-:logsEnabled: A boolean that defines the :ref:`ds-logs-enabled` setting on this :term:`Delivery Service`
-:longDesc: The :ref:`ds-longdesc` of this :term:`Delivery Service`
-:longDesc1: The :ref:`ds-longdesc2` of this :term:`Delivery Service`
-:longDesc2: The :ref:`ds-longdesc3` of this :term:`Delivery Service`
-:matchList: The :term:`Delivery Service`'s :ref:`ds-matchlist`
-
- :pattern: A regular expression - the use of this pattern is dependent on the ``type`` field (backslashes are escaped)
- :setNumber: An integer that provides explicit ordering of :ref:`ds-matchlist` items - this is used as a priority ranking by Traffic Router, and is not guaranteed to correspond to the ordering of items in the array.
- :type: The type of match performed using ``pattern``.
-
-:maxDnsAnswers: The :ref:`ds-max-dns-answers` allowed for this :term:`Delivery Service`
-:maxOriginConnections: The :ref:`ds-max-origin-connections`
-:midHeaderRewrite: A set of :ref:`ds-mid-header-rw-rules`
-:missLat: The :ref:`ds-geo-miss-default-latitude` used by this :term:`Delivery Service`
-:missLong: The :ref:`ds-geo-miss-default-longitude` used by this :term:`Delivery Service`
-:multiSiteOrigin: A boolean that defines the use of :ref:`ds-multi-site-origin` by this :term:`Delivery Service`
-:orgServerFqdn: The :ref:`ds-origin-url`
-:originShield: A :ref:`ds-origin-shield` string
-:profileDescription: The :ref:`profile-description` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated
-:profileId: The :ref:`profile-id` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated
-:profileName: The :ref:`profile-name` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated
-:protocol: An integral, unique identifier that corresponds to the :ref:`ds-protocol` used by this :term:`Delivery Service`
-:qstringIgnore: An integral, unique identifier that corresponds to the :ref:`ds-qstring-handling` setting on this :term:`Delivery Service`
-:rangeRequestHandling: An integral, unique identifier that corresponds to the :ref:`ds-range-request-handling` setting on this :term:`Delivery Service`
-:regexRemap: A :ref:`ds-regex-remap`
-:regionalGeoBlocking: A boolean defining the :ref:`ds-regionalgeo` setting on this :term:`Delivery Service`
-:remapText: :ref:`ds-raw-remap`
-:signed: ``true`` if and only if ``signingAlgorithm`` is not ``null``, ``false`` otherwise
-:signingAlgorithm: Either a :ref:`ds-signing-algorithm` or ``null`` to indicate URL/URI signing is not implemented on this :term:`Delivery Service`
-:sslKeyVersion: This integer indicates the :ref:`ds-ssl-key-version`
-:tenantId: The integral, unique identifier of the :ref:`ds-tenant` who owns this :term:`Delivery Service`
-:trRequestHeaders: If defined, this defines the :ref:`ds-tr-req-headers` used by Traffic Router for this :term:`Delivery Service`
-:trResponseHeaders: If defined, this defines the :ref:`ds-tr-resp-headers` used by Traffic Router for this :term:`Delivery Service`
-:type: The :ref:`ds-types` of this :term:`Delivery Service`
-:typeId: The integral, unique identifier of the :ref:`ds-types` of this :term:`Delivery Service`
-:xmlId: This :term:`Delivery Service`'s :ref:`ds-xmlid`
+:ccrDnsTtl: The :ref:`ds-dns-ttl` - named "ccrDnsTtl" for legacy reasons
+:cdnId: The integral, unique identifier of the :ref:`ds-cdn` to which the :term:`Delivery Service` belongs
+:cdnName: Name of the :ref:`ds-cdn` to which the :term:`Delivery Service` belongs
+:checkPath: A :ref:`ds-check-path`
+:consistentHashRegex: A :ref:`ds-consistent-hashing-regex`
+:consistentHashQueryParams: An array of :ref:`ds-consistent-hashing-qparams`
+:deepCachingType: The :ref:`ds-deep-caching` setting for this :term:`Delivery Service`
+:displayName: The :ref:`ds-display-name`
+:dnsBypassCname: A :ref:`ds-dns-bypass-cname`
+:dnsBypassIp: A :ref:`ds-dns-bypass-ip`
+:dnsBypassIp6: A :ref:`ds-dns-bypass-ipv6`
+:dnsBypassTtl: The :ref:`ds-dns-bypass-ttl`
+:dscp: A :ref:`ds-dscp` to be used within the :term:`Delivery Service`
+:ecsEnabled: A boolean that defines the :ref:`ds-ecs` setting on this :term:`Delivery Service`
+:edgeHeaderRewrite: A set of :ref:`ds-edge-header-rw-rules`
+:exampleURLs: An array of :ref:`ds-example-urls`
+:fqPacingRate: The :ref:`ds-fqpr`
+:geoLimit: An integer that defines the :ref:`ds-geo-limit`
+:geoLimitCountries: A string containing a comma-separated list defining the :ref:`ds-geo-limit-countries`
+:geoLimitRedirectUrl: A :ref:`ds-geo-limit-redirect-url`
+:geoProvider: The :ref:`ds-geo-provider`
+:globalMaxMbps: The :ref:`ds-global-max-mbps`
+:globalMaxTps: The :ref:`ds-global-max-tps`
+:httpBypassFqdn: A :ref:`ds-http-bypass-fqdn`
+:id: An integral, unique identifier for this :term:`Delivery Service`
+:infoUrl: An :ref:`ds-info-url`
+:initialDispersion: The :ref:`ds-initial-dispersion`
+:ipv6RoutingEnabled: A boolean that defines the :ref:`ds-ipv6-routing` setting on this :term:`Delivery Service`
+:lastUpdated: The date and time at which this :term:`Delivery Service` was last updated, in :rfc:`3339` format
+:logsEnabled: A boolean that defines the :ref:`ds-logs-enabled` setting on this :term:`Delivery Service`
+:longDesc: The :ref:`ds-longdesc` of this :term:`Delivery Service`
+:longDesc1: The :ref:`ds-longdesc2` of this :term:`Delivery Service`
+:longDesc2: The :ref:`ds-longdesc3` of this :term:`Delivery Service`
+:matchList: The :term:`Delivery Service`'s :ref:`ds-matchlist`
+
+ :pattern: A regular expression - the use of this pattern is dependent on the ``type`` field (backslashes are escaped)
+ :setNumber: An integer that provides explicit ordering of :ref:`ds-matchlist` items - this is used as a priority ranking by Traffic Router, and is not guaranteed to correspond to the ordering of items in the array.
+ :type: The type of match performed using ``pattern``.
+
+:maxDnsAnswers: The :ref:`ds-max-dns-answers` allowed for this :term:`Delivery Service`
+:maxOriginConnections: The :ref:`ds-max-origin-connections`
+:midHeaderRewrite: A set of :ref:`ds-mid-header-rw-rules`
+:missLat: The :ref:`ds-geo-miss-default-latitude` used by this :term:`Delivery Service`
+:missLong: The :ref:`ds-geo-miss-default-longitude` used by this :term:`Delivery Service`
+:multiSiteOrigin: A boolean that defines the use of :ref:`ds-multi-site-origin` by this :term:`Delivery Service`
+:orgServerFqdn: The :ref:`ds-origin-url`
+:originShield: A :ref:`ds-origin-shield` string
+:profileDescription: The :ref:`profile-description` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated
+:profileId: The :ref:`profile-id` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated
+:profileName: The :ref:`profile-name` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated
+:protocol: An integral, unique identifier that corresponds to the :ref:`ds-protocol` used by this :term:`Delivery Service`
+:qstringIgnore: An integral, unique identifier that corresponds to the :ref:`ds-qstring-handling` setting on this :term:`Delivery Service`
+:rangeRequestHandling: An integral, unique identifier that corresponds to the :ref:`ds-range-request-handling` setting on this :term:`Delivery Service`
+:regexRemap: A :ref:`ds-regex-remap`
+:regionalGeoBlocking: A boolean defining the :ref:`ds-regionalgeo` setting on this :term:`Delivery Service`
+:remapText: :ref:`ds-raw-remap`
+:signed: ``true`` if and only if ``signingAlgorithm`` is not ``null``, ``false`` otherwise
+:signingAlgorithm: Either a :ref:`ds-signing-algorithm` or ``null`` to indicate URL/URI signing is not implemented on this :term:`Delivery Service`
+:sslKeyVersion: This integer indicates the :ref:`ds-ssl-key-version`
+:tenantId: The integral, unique identifier of the :ref:`ds-tenant` who owns this :term:`Delivery Service`
+:trRequestHeaders: If defined, this defines the :ref:`ds-tr-req-headers` used by Traffic Router for this :term:`Delivery Service`
+:trResponseHeaders: If defined, this defines the :ref:`ds-tr-resp-headers` used by Traffic Router for this :term:`Delivery Service`
+:type: The :ref:`ds-types` of this :term:`Delivery Service`
+:typeId: The integral, unique identifier of the :ref:`ds-types` of this :term:`Delivery Service`
+:xmlId: This :term:`Delivery Service`'s :ref:`ds-xmlid`
Review comment:
Ohhhhhh, I see what's happening. You're replacing all the spaces with tabs. But that destroys alignment; tabs are for indentation, spaces are for alignment.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386121896
##########
File path: docs/source/api/v2/deliveryservice_requests.rst
##########
@@ -0,0 +1,767 @@
+..
+..
+.. 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-deliveryservice-requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`.
+
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+==========================================================================================+
+ | assignee | no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this username. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | assigneeId| no | Filter for :ref:`ds_requests` that are assigned to the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | author | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this username |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | authorId | no | Filter for :ref:`ds_requests` submitted by the user |
+ | | | identified by this integral, unique identifier |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | changeType| no | Filter for :ref:`ds_requests` of the change type specified. |
+ | | | Can be ``create``, ``update``, or ``delete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | id | no | Filter for the :ref:`Delivery Service Request <ds_requests>` identified by this |
+ | | | integral, unique identifier. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | status | no | Filter for :ref:`ds_requests` whose status is the status |
+ | | | specified. The status can be ``draft``, ``submitted``, ``pending``, ``rejected``, or |
+ | | | ``complete``. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+ | xmlId | no | Filter for :ref:`ds_requests` that have the given |
+ | | | :ref:`ds-xmlid`. |
+ +-----------+----------+------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/deliveryservice_requests?status=draft HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:author: The author of the Delivery Service Request
+:authorId: The integral, unique identifier assigned to the author
+:changeType: The change type of the :term:`DSR <Delivery Service Request>`. It can be ``create``, ``update``, or ``delete``....
+:createdAt: The date and time at which the :term:`DSR <Delivery Service Request>` was created, in ISO format.
+:deliveryService: The delivery service that the :term:`DSR <Delivery Service Request>` is requesting to update.
+:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>`
+:lastEditedBy: The username of user who last edited this :term:`DSR <Delivery Service Request>`
+:lastEditedById: The integral, unique identifier assigned to the user who last edited this :term:`DSR <Delivery Service Request>`
+:lastUpdated: The date and time at which the :term:`DSR <Delivery Service Request>` was last updated, in ISO format.
+:status: The status of the request. Can be "draft", "submitted", "rejected", "pending", or "complete".
Review comment:
Field aligned in 8d99deb8fd. This was a case of tabstop=4 showing the tabs incorrectly. Now I have tabstop=8 for ReStructuredText.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384065808
##########
File path: docs/source/api/v2/servers_details.rst
##########
@@ -0,0 +1,117 @@
+..
+..
+.. 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-servers-details:
+
+*******************
+``servers/details``
+*******************
+Retrieves details of :ref:`tp-configure-servers`.
+
+
+``GET``
+=======
+:Auth. Required: Yes
+:Roles Required: "read-only"
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +----------------+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +================+========================================+================================================================================================================================================================+
+ | hostName | Required if no physLocationID provided | Return only the servers with this (short) hostname. Capitalization of "hostName" is important. |
+ +----------------+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | physLocationID | Required if no hostName provided | Return only servers with this integral, unique identifier for the physical location where the server resides. Capitalization of "physLocationID" is important. |
+ +----------------+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/2.0/servers/details?hostName=edge HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+
Review comment:
Response field definitions? Also the non-response properties
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request
#4444: Document undocumented Traffic Ops routes
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4444: Document undocumented Traffic Ops routes
URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r386153041
##########
File path: docs/source/api/v2/deliveryservice_requests_id_assign.rst
##########
@@ -0,0 +1,177 @@
+..
+..
+.. 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-deliveryservice_requests-id-assign:
+
+******************************************
+``deliveryservice_requests/{{ID}}/assign``
+******************************************
+Assign a :term:`Delivery Service Request` to a user.
+
+``PUT``
+=======
+:Auth. Required: Yes
+:Roles Required: "admin" or "operations"
+:Response Type: Object
+
+Request Structure
+-----------------
+
Review comment:
Field definitions added in 6d4154ac02.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services