zrhoffman commented on a change in pull request #4444: URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r436648156
########## File path: docs/source/api/v3/deliveryservice_request_comments.rst ########## @@ -0,0 +1,325 @@ +.. +.. +.. 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: None +: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/3.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 +------------------ +:author: The username of the user who created the comment. +:authorId: The integral, unique identifier of the user who created the comment. +:deliveryServiceRequestId: The integral, unique identifier of the :term:`Delivery Service Request` that the comment was posted on. +:id: The integral, unique identifier of the :term:`DSR` comment. +:lastUpdated: The date and time at which the user was last modified, in ISO format +:value: The text of the comment that was posted. +:xmlId: This is the `:xmlId:` value that you provided in the request. + +.. 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 +----------------- +:deliveryServiceRequestId: The integral, unique identifier of the delivery service that you are commenting on. +:value: The comment text itself. +:xmlId: This can be anything except undefined. Beyond that, it is not validated or used, although it is returned in the response. + +.. code-block:: http + :caption: Request Example + + POST /api/3.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 +------------------ +:author: The username of the user who created the comment. +:authorId: The integral, unique identifier of the user who created the comment. +:deliveryServiceRequestId: The integral, unique identifier of the :term:`Delivery Service Request` that the comment was posted on. +:id: The integral, unique identifier of the :term:`DSR` comment. +:lastUpdated: The date and time at which the user was last modified, in ISO format +:value: The text of the comment that was posted. +:xmlId: This is the `:xmlId:` value that you provided in the request. + +.. 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`` +======= +:deliveryServiceRequestId: The integral, unique identifier of the delivery service that you are commenting on. +:value: The comment text itself. +:xmlId: This can be anything except undefined. Beyond that, it is not validated or used, although it is returned in the response. + +Updates a delivery service request comment. + +:Auth. Required: Yes +:Roles Required: "admin", "Federation", "operations", "Portal", or "Steering" +:Response Type: Object + + +Request Structure +----------------- +:deliveryServiceRequestId: The integral, unique identifier of the :term:`Delivery Service Request` that the comment was posted on. +:value: The comment text itself. + +.. table:: Request Query Parameters + + +-----------+----------+-----------------------------------------------------------------------------------+ + | Parameter | Required | Description | + +===========+==========+===================================================================================+ + | id | yes | The integral, unique identifier of the :term:`Delivery Service Request` comment | + | | | that you wish to update. | + +-----------+----------+-----------------------------------------------------------------------------------+ + +.. code-block:: http + :caption: Request Example + + PUT /api/3.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 +------------------ +:author: The username of the user who created the comment. +:authorId: The integral, unique identifier of the user who created the comment. +:deliveryServiceRequestId: The integral, unique identifier of the :term:`Delivery Service Request` that the comment was posted on. +:id: The integral, unique identifier of the :term:`DSR` comment. +:lastUpdated: The date and time at which the user was last modified, in ISO format +:value: The text of the comment that was posted. +:xmlId: This is the `:xmlId:` value that you provided in the request. Review comment: Changed to double-grave accents in 2556a4685c ########## File path: docs/source/api/v3/deliveryservice_request_comments.rst ########## @@ -0,0 +1,325 @@ +.. +.. +.. 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: None +: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/3.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 +------------------ +:author: The username of the user who created the comment. +:authorId: The integral, unique identifier of the user who created the comment. +:deliveryServiceRequestId: The integral, unique identifier of the :term:`Delivery Service Request` that the comment was posted on. +:id: The integral, unique identifier of the :term:`DSR` comment. +:lastUpdated: The date and time at which the user was last modified, in ISO format +:value: The text of the comment that was posted. +:xmlId: This is the `:xmlId:` value that you provided in the request. + +.. 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 +----------------- +:deliveryServiceRequestId: The integral, unique identifier of the delivery service that you are commenting on. +:value: The comment text itself. +:xmlId: This can be anything except undefined. Beyond that, it is not validated or used, although it is returned in the response. + +.. code-block:: http + :caption: Request Example + + POST /api/3.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 +------------------ +:author: The username of the user who created the comment. +:authorId: The integral, unique identifier of the user who created the comment. +:deliveryServiceRequestId: The integral, unique identifier of the :term:`Delivery Service Request` that the comment was posted on. +:id: The integral, unique identifier of the :term:`DSR` comment. +:lastUpdated: The date and time at which the user was last modified, in ISO format +:value: The text of the comment that was posted. +:xmlId: This is the `:xmlId:` value that you provided in the request. + +.. 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`` +======= +:deliveryServiceRequestId: The integral, unique identifier of the delivery service that you are commenting on. +:value: The comment text itself. +:xmlId: This can be anything except undefined. Beyond that, it is not validated or used, although it is returned in the response. Review comment: Not an accident. In the response, `xmlId` is null, but you can optionally pass a value for `xmlId` to receive that value in the response. Clarified in a0cf7efa00. ########## File path: docs/source/api/v3/deliveryservice_request_comments.rst ########## @@ -0,0 +1,325 @@ +.. +.. +.. 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: None +: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/3.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 +------------------ +:author: The username of the user who created the comment. +:authorId: The integral, unique identifier of the user who created the comment. +:deliveryServiceRequestId: The integral, unique identifier of the :term:`Delivery Service Request` that the comment was posted on. +:id: The integral, unique identifier of the :term:`DSR` comment. +:lastUpdated: The date and time at which the user was last modified, in ISO format +:value: The text of the comment that was posted. +:xmlId: This is the `:xmlId:` value that you provided in the request. + +.. 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 +----------------- +:deliveryServiceRequestId: The integral, unique identifier of the delivery service that you are commenting on. +:value: The comment text itself. +:xmlId: This can be anything except undefined. Beyond that, it is not validated or used, although it is returned in the response. + +.. code-block:: http + :caption: Request Example + + POST /api/3.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 +------------------ +:author: The username of the user who created the comment. +:authorId: The integral, unique identifier of the user who created the comment. +:deliveryServiceRequestId: The integral, unique identifier of the :term:`Delivery Service Request` that the comment was posted on. +:id: The integral, unique identifier of the :term:`DSR` comment. +:lastUpdated: The date and time at which the user was last modified, in ISO format +:value: The text of the comment that was posted. +:xmlId: This is the `:xmlId:` value that you provided in the request. Review comment: Reworded `xmlId`'s description in a0cf7efa00 ########## File path: docs/source/api/v3/deliveryservice_request_comments.rst ########## @@ -0,0 +1,325 @@ +.. +.. +.. 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: None +: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/3.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 +------------------ +:author: The username of the user who created the comment. +:authorId: The integral, unique identifier of the user who created the comment. +:deliveryServiceRequestId: The integral, unique identifier of the :term:`Delivery Service Request` that the comment was posted on. +:id: The integral, unique identifier of the :term:`DSR` comment. +:lastUpdated: The date and time at which the user was last modified, in ISO format +:value: The text of the comment that was posted. +:xmlId: This is the `:xmlId:` value that you provided in the request. + +.. 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 +----------------- +:deliveryServiceRequestId: The integral, unique identifier of the delivery service that you are commenting on. +:value: The comment text itself. +:xmlId: This can be anything except undefined. Beyond that, it is not validated or used, although it is returned in the response. Review comment: Reworded `xmlId`'s description in a0cf7efa00 ########## File path: docs/source/api/v3/deliveryservice_request_comments.rst ########## @@ -0,0 +1,325 @@ +.. +.. +.. 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: None +: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/3.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 +------------------ +:author: The username of the user who created the comment. +:authorId: The integral, unique identifier of the user who created the comment. +:deliveryServiceRequestId: The integral, unique identifier of the :term:`Delivery Service Request` that the comment was posted on. +:id: The integral, unique identifier of the :term:`DSR` comment. +:lastUpdated: The date and time at which the user was last modified, in ISO format +:value: The text of the comment that was posted. +:xmlId: This is the `:xmlId:` value that you provided in the request. Review comment: Changed to double-grave accents in 2556a4685c ########## File path: docs/source/api/v3/deliveryservice_request_comments.rst ########## @@ -0,0 +1,325 @@ +.. +.. +.. 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: None +: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/3.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 +------------------ +:author: The username of the user who created the comment. +:authorId: The integral, unique identifier of the user who created the comment. +:deliveryServiceRequestId: The integral, unique identifier of the :term:`Delivery Service Request` that the comment was posted on. +:id: The integral, unique identifier of the :term:`DSR` comment. +:lastUpdated: The date and time at which the user was last modified, in ISO format +:value: The text of the comment that was posted. +:xmlId: This is the `:xmlId:` value that you provided in the request. + +.. 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 +----------------- +:deliveryServiceRequestId: The integral, unique identifier of the delivery service that you are commenting on. +:value: The comment text itself. +:xmlId: This can be anything except undefined. Beyond that, it is not validated or used, although it is returned in the response. + +.. code-block:: http + :caption: Request Example + + POST /api/3.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 +------------------ +:author: The username of the user who created the comment. +:authorId: The integral, unique identifier of the user who created the comment. +:deliveryServiceRequestId: The integral, unique identifier of the :term:`Delivery Service Request` that the comment was posted on. +:id: The integral, unique identifier of the :term:`DSR` comment. +:lastUpdated: The date and time at which the user was last modified, in ISO format +:value: The text of the comment that was posted. +:xmlId: This is the `:xmlId:` value that you provided in the request. + +.. 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`` +======= +:deliveryServiceRequestId: The integral, unique identifier of the delivery service that you are commenting on. +:value: The comment text itself. +:xmlId: This can be anything except undefined. Beyond that, it is not validated or used, although it is returned in the response. Review comment: Removed duplicate request fields lists in c49d7415b. ########## File path: docs/source/api/v3/steering.rst ########## @@ -0,0 +1,104 @@ +.. +.. +.. 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: Review comment: Label renamed in fe141ebc8 ########## File path: docs/source/api/v3/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: Review comment: Label renamed in fe141ebc8 ########## File path: docs/source/api/v3/federations_all.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-federations-all: Review comment: Label renamed in fe141ebc8 ########## File path: docs/source/api/v3/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: Review comment: Label renamed in fe141ebc8 ########## File path: docs/source/api/v3/deliveryservice_requests_id_status.rst ########## @@ -0,0 +1,273 @@ +.. +.. +.. 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: Review comment: Label renamed in fe141ebc8 ########## File path: docs/source/api/v3/deliveryservice_requests_id_status.rst ########## @@ -0,0 +1,273 @@ +.. +.. +.. 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}}/status`` +****************************************** +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 +----------------- +:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>` +:status: The status of the `DSR <Delivery Service Request>`. Can be "draft", "submitted", "rejected", "pending", or "complete". + +.. code-block:: http + :caption: Request Example + + PUT /api/3.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 +------------------ +:assignee: The username of the user to whom the :term:`Delivery Service Request` is assigned. +:assigneeId: The integral, unique identifier of the user to whom the :term:`Delivery Service Request` is assigned. +:author: The author of the :term:`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>` Review comment: Missed a conflict section when resolving rebase conflicts. Removed in 1916f9acd ########## File path: docs/source/api/v3/deliveryservice_requests_id_assign.rst ########## @@ -0,0 +1,259 @@ +.. +.. +.. 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: Review comment: Label renamed in fe141ebc8 ########## File path: docs/source/api/v3/deliveryservice_requests.rst ########## @@ -0,0 +1,1148 @@ +.. +.. +.. 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: None +: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/3.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 username of the user who created 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. + + :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` + :consistentHashQueryParams: An array of :ref:`ds-consistent-hashing-qparams` + :consistentHashRegex: A :ref:`ds-consistent-hashing-regex` + :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`\ [#geolimit]_ + :geoLimitRedirectUrl: A :ref:`ds-geo-limit-redirect-url`\ [#geolimit]_ + :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: An optional field containing the :ref:`ds-longdesc2` of this :term:`Delivery Service` + :longDesc2: An optional field containing 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: An optional :ref:`profile-id` of a :ref:`ds-profile` with which this :term:`Delivery Service` shall be 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` + :routingName: The :ref:`ds-routing-name` of this :term:`Delivery Service` + :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` + :tenant: The name of the :term:`Tenant` who owns this :term:`origin` + :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` + +: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: Review comment: Label renamed in fe141ebc8 ########## File path: docs/source/api/v3/deliveryservice_requests.rst ########## @@ -0,0 +1,1148 @@ +.. +.. +.. 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: Review comment: Label renamed in fe141ebc8 ########## File path: docs/source/api/v3/deliveryservice_request_comments.rst ########## @@ -0,0 +1,321 @@ +.. +.. +.. 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: Review comment: Label renamed in fe141ebc8 ########## File path: docs/source/api/v3/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-v2-deliveryservices-dnsseckeys-generate: Review comment: Label renamed in fe141ebc8 ########## File path: docs/source/api/v3/about.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-about: Review comment: Label renamed in fe141ebc8 ########## File path: docs/source/api/v2/deliveryservice_requests_id_status.rst ########## @@ -0,0 +1,273 @@ +.. +.. +.. 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}}/status`` +****************************************** +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 +----------------- +:id: The integral, unique identifier assigned to the :term:`DSR <Delivery Service Request>` +:status: The status of the `DSR <Delivery Service Request>`. Can be "draft", "submitted", "rejected", "pending", or "complete". + +.. 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 +------------------ +:assignee: The username of the user to whom the :term:`Delivery Service Request` is assigned. +:assigneeId: The integral, unique identifier of the user to whom the :term:`Delivery Service Request` is assigned. +:author: The author of the :term:`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>` Review comment: Missed a conflict section when resolving rebase conflicts. Removed in 1916f9acd ---------------------------------------------------------------- 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: us...@infra.apache.org
