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/04/10 17:31:37 UTC
[GitHub] [trafficcontrol] ZugNZwang opened a new pull request #4629: API
Documentation for deliveryservice_requests
ZugNZwang opened a new pull request #4629: API Documentation for deliveryservice_requests
URL: https://github.com/apache/trafficcontrol/pull/4629
<!--
************ 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 #3572
- [x] This PR fixes #4165
^ 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.
-->
- [x] This PR fixes #3572
- [x] This PR fixes #4165
<!-- You can check for an issue here: https://github.com/apache/trafficcontrol/issues -->
## 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
## 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. -->
Verify the docs build correctly
Validate the documentation for the `deliveryservice_request` endpoint is correct for api v1 and v2.
## 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 '1df853c8'), in v4.0.0,
and in the current 4.0.1 Release candidate (e.g. RC1), then this list would
look like:
- master (1df853c8)
- 4.0.0
- 4.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).
-->
## 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] This PR includes tests OR I have explained why tests are unnecessary
- [X] This PR includes documentation OR I have explained why documentation is unnecessary
- [X] This PR includes an update to CHANGELOG.md OR such an update 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] ocket8888 commented on a change in pull request
#4629: API Documentation for deliveryservice_requests
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4629: API Documentation for deliveryservice_requests
URL: https://github.com/apache/trafficcontrol/pull/4629#discussion_r406869788
##########
File path: docs/source/api/v1/deliveryservice_requests.rst
##########
@@ -0,0 +1,972 @@
+..
+..
+.. 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-v1-deliveryservice_requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`
+
+:Auth. Required: Yes
+:Roles Required: None\ [#tenancy]_
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+======================================================================================================================================+
+ | assignee | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this text-based, unique identifier |
Review comment:
Same as above
----------------------------------------------------------------
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] ZugNZwang commented on a change in pull request
#4629: API Documentation for deliveryservice_requests
Posted by GitBox <gi...@apache.org>.
ZugNZwang commented on a change in pull request #4629: API Documentation for deliveryservice_requests
URL: https://github.com/apache/trafficcontrol/pull/4629#discussion_r406886610
##########
File path: docs/source/api/v1/deliveryservice_requests.rst
##########
@@ -0,0 +1,972 @@
+..
+..
+.. 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-v1-deliveryservice_requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`
+
+:Auth. Required: Yes
+:Roles Required: None\ [#tenancy]_
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+======================================================================================================================================+
+ | assignee | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | assigneeId | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | author | no | Show only the :ref:`ds_requests` created by this author identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Show only the :ref:`ds_requests` created by this author identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | changeType | no | Return only the :ref:`ds_requests` that have this changeType identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Show only the :ref:`ds_requests` that has this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | status | no | Return only :ref:`ds_requests` that have this status identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | xmlId | no | Return only :ref:`ds_requests` that have this xmlId identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | orderby | no | Choose the ordering of the results - must be the name of one of the fields of the objects in the ``response`` |
+ | | | array |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either ascending (default or "asc") or descending ("desc") |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to return |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before beginning to return results. Must use in conjunction with limit |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | page | no | Return the n\ :sup:`th` page of results, where "n" is the value of this parameter, pages are ``limit`` long and the first page is 1. |
+ | | | If ``offset`` was defined, this query parameter has no effect. ``limit`` must be defined to make use of ``page``. |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+Response Structure
+------------------
+:assigneeId: The integral, unique identifier of the assignee of this :ref:`ds_requests`
+:assignee: Name of the assignee to which the :ref:`ds_requests` is assigned to
+:authorId: The integral, unique identifier of the author of this :ref:`ds_requests`
+:author: Name of the author who created this :ref:`ds_requests`
+:changeType: The type of change made to the delivery service as described in this :ref:`ds_requests`
+:createdAt: The date and time at which this :ref:`ds_requests` was created, in :rfc:`3339` format
Review comment:
The delivery service documentation is also wrong in this case
----------------------------------------------------------------
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
#4629: API Documentation for deliveryservice_requests
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4629: API Documentation for deliveryservice_requests
URL: https://github.com/apache/trafficcontrol/pull/4629#discussion_r406871007
##########
File path: docs/source/api/v1/deliveryservice_requests.rst
##########
@@ -0,0 +1,972 @@
+..
+..
+.. 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-v1-deliveryservice_requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`
+
+:Auth. Required: Yes
+:Roles Required: None\ [#tenancy]_
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+======================================================================================================================================+
+ | assignee | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | assigneeId | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | author | no | Show only the :ref:`ds_requests` created by this author identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Show only the :ref:`ds_requests` created by this author identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | changeType | no | Return only the :ref:`ds_requests` that have this changeType identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Show only the :ref:`ds_requests` that has this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | status | no | Return only :ref:`ds_requests` that have this status identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | xmlId | no | Return only :ref:`ds_requests` that have this xmlId identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | orderby | no | Choose the ordering of the results - must be the name of one of the fields of the objects in the ``response`` |
+ | | | array |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either ascending (default or "asc") or descending ("desc") |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to return |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before beginning to return results. Must use in conjunction with limit |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | page | no | Return the n\ :sup:`th` page of results, where "n" is the value of this parameter, pages are ``limit`` long and the first page is 1. |
+ | | | If ``offset`` was defined, this query parameter has no effect. ``limit`` must be defined to make use of ``page``. |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+Response Structure
+------------------
+:assigneeId: The integral, unique identifier of the assignee of this :ref:`ds_requests`
+:assignee: Name of the assignee to which the :ref:`ds_requests` is assigned to
+:authorId: The integral, unique identifier of the author of this :ref:`ds_requests`
+:author: Name of the author who created this :ref:`ds_requests`
+:changeType: The type of change made to the delivery service as described in this :ref:`ds_requests`
Review comment:
"Delivery Service" is a `:term:` and should be so linked at least the first time it appears in a major section ("page" in an html context).
----------------------------------------------------------------
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
#4629: API Documentation for deliveryservice_requests
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4629: API Documentation for deliveryservice_requests
URL: https://github.com/apache/trafficcontrol/pull/4629#discussion_r406897445
##########
File path: docs/source/api/v1/deliveryservice_requests.rst
##########
@@ -0,0 +1,972 @@
+..
+..
+.. 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-v1-deliveryservice_requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`
+
+:Auth. Required: Yes
+:Roles Required: None\ [#tenancy]_
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+======================================================================================================================================+
+ | assignee | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | assigneeId | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | author | no | Show only the :ref:`ds_requests` created by this author identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Show only the :ref:`ds_requests` created by this author identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | changeType | no | Return only the :ref:`ds_requests` that have this changeType identified by this text-based, unique identifier |
Review comment:
Could you list what they are somewhere?
----------------------------------------------------------------
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
#4629: API Documentation for deliveryservice_requests
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4629: API Documentation for deliveryservice_requests
URL: https://github.com/apache/trafficcontrol/pull/4629#discussion_r406873286
##########
File path: docs/source/api/v1/deliveryservice_requests.rst
##########
@@ -0,0 +1,972 @@
+..
+..
+.. 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-v1-deliveryservice_requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`
+
+:Auth. Required: Yes
+:Roles Required: None\ [#tenancy]_
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+======================================================================================================================================+
+ | assignee | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | assigneeId | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | author | no | Show only the :ref:`ds_requests` created by this author identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Show only the :ref:`ds_requests` created by this author identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | changeType | no | Return only the :ref:`ds_requests` that have this changeType identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Show only the :ref:`ds_requests` that has this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | status | no | Return only :ref:`ds_requests` that have this status identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | xmlId | no | Return only :ref:`ds_requests` that have this xmlId identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | orderby | no | Choose the ordering of the results - must be the name of one of the fields of the objects in the ``response`` |
+ | | | array |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either ascending (default or "asc") or descending ("desc") |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to return |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before beginning to return results. Must use in conjunction with limit |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | page | no | Return the n\ :sup:`th` page of results, where "n" is the value of this parameter, pages are ``limit`` long and the first page is 1. |
+ | | | If ``offset`` was defined, this query parameter has no effect. ``limit`` must be defined to make use of ``page``. |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+Response Structure
+------------------
+:assigneeId: The integral, unique identifier of the assignee of this :ref:`ds_requests`
+:assignee: Name of the assignee to which the :ref:`ds_requests` is assigned to
+:authorId: The integral, unique identifier of the author of this :ref:`ds_requests`
+:author: Name of the author who created this :ref:`ds_requests`
+:changeType: The type of change made to the delivery service as described in this :ref:`ds_requests`
+:createdAt: The date and time at which this :ref:`ds_requests` was created, in :rfc:`3339` format
+:id: An integral, unique identifier for this :ref:`ds_requests`
+:lastEditedBy: Name of the previous user to edit this :ref:`ds_requests`
+:lastEditedById: The integral, unique identifier of the previous user to edit this :ref:`ds_requests`
+:lastUpdated: The date and time at which this :ref:`ds_requests` was last updated, in :rfc:`3339` format
+:status: The status of this :ref:`ds_requests`
+
+:deliveryService: An object describing the actual parameters for the Delivery Service request
+ :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`
+
+ .. versionadded:: 1.4
+
+ :consistentHashQueryParams: An array of :ref:`ds-consistent-hashing-qparams`
+
+ .. versionadded:: 1.4
+
+ :deepCachingType: The :ref:`ds-deep-caching` setting for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.5
+
+ :edgeHeaderRewrite: A set of :ref:`ds-edge-header-rw-rules`
+ :exampleURLs: An array of :ref:`ds-example-urls`
+ :fqPacingRate: The :ref:`ds-fqpr`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.4
+
+ :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`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.3
+
+ :trRequestHeaders: If defined, this defines the :ref:`ds-tr-req-headers` used by Traffic Router for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :trResponseHeaders: If defined, this defines the :ref:`ds-tr-resp-headers` used by Traffic Router for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+.. 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-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Wed, 12 Feb 2020 00:21:40 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: ME1ZLCtgXYrWlIXhS6qn4YqOzx2yk7aoe0hV7AxRsZfH0/TiCPOnLLkOHxS6YfuuIQK9UQNPxuOxDlAK78rkxA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Tue, 11 Feb 2020 23:21:40 GMT
+ Transfer-Encoding: chunked
+
+ { "response": [{
+ "assigneeId": 2,
+ "assignee": "admin",
+ "authorId": 2,
+ "author": "admin",
+ "changeType": "create",
+ "createdAt": "2020-02-11 20:05:48+00",
+ "id": 1,
+ "lastEditedBy": "admin",
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-11 20:05:48+00",
+ "deliveryService": {
+ "active": true,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": null,
+ "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": "2019-05-15 14:32:05+00",
+ "logsEnabled": true,
+ "longDesc": "Demo Delivery Service Request",
+ "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": null,
+ "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": "complete"
+ }]}
+
+
+``POST``
+========
+Allows users to create :ref:`ds_requests`.
+
+:Auth. Required: Yes
+:Roles Required: Portal\ [#tenancy]_
+:Response Type: Array
+
+Request Structure
+-----------------
+:changeType: The type of change made to the delivery service as described in this :ref:`ds_requests`
Review comment:
Is this the Name of a Type? Or an ID of a Type? Or something else altogether?
----------------------------------------------------------------
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
#4629: API Documentation for deliveryservice_requests
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4629: API Documentation for deliveryservice_requests
URL: https://github.com/apache/trafficcontrol/pull/4629#discussion_r406872561
##########
File path: docs/source/api/v1/deliveryservice_requests.rst
##########
@@ -0,0 +1,972 @@
+..
+..
+.. 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-v1-deliveryservice_requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`
+
+:Auth. Required: Yes
+:Roles Required: None\ [#tenancy]_
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+======================================================================================================================================+
+ | assignee | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | assigneeId | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | author | no | Show only the :ref:`ds_requests` created by this author identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Show only the :ref:`ds_requests` created by this author identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | changeType | no | Return only the :ref:`ds_requests` that have this changeType identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Show only the :ref:`ds_requests` that has this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | status | no | Return only :ref:`ds_requests` that have this status identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | xmlId | no | Return only :ref:`ds_requests` that have this xmlId identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | orderby | no | Choose the ordering of the results - must be the name of one of the fields of the objects in the ``response`` |
+ | | | array |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either ascending (default or "asc") or descending ("desc") |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to return |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before beginning to return results. Must use in conjunction with limit |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | page | no | Return the n\ :sup:`th` page of results, where "n" is the value of this parameter, pages are ``limit`` long and the first page is 1. |
+ | | | If ``offset`` was defined, this query parameter has no effect. ``limit`` must be defined to make use of ``page``. |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+Response Structure
+------------------
+:assigneeId: The integral, unique identifier of the assignee of this :ref:`ds_requests`
+:assignee: Name of the assignee to which the :ref:`ds_requests` is assigned to
+:authorId: The integral, unique identifier of the author of this :ref:`ds_requests`
+:author: Name of the author who created this :ref:`ds_requests`
+:changeType: The type of change made to the delivery service as described in this :ref:`ds_requests`
+:createdAt: The date and time at which this :ref:`ds_requests` was created, in :rfc:`3339` format
+:id: An integral, unique identifier for this :ref:`ds_requests`
+:lastEditedBy: Name of the previous user to edit this :ref:`ds_requests`
+:lastEditedById: The integral, unique identifier of the previous user to edit this :ref:`ds_requests`
+:lastUpdated: The date and time at which this :ref:`ds_requests` was last updated, in :rfc:`3339` format
+:status: The status of this :ref:`ds_requests`
Review comment:
Is this the Name of a Status? Or is it restricted to a certain set of values?
----------------------------------------------------------------
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
#4629: API Documentation for deliveryservice_requests
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4629: API Documentation for deliveryservice_requests
URL: https://github.com/apache/trafficcontrol/pull/4629#discussion_r406873694
##########
File path: docs/source/api/v1/deliveryservice_requests.rst
##########
@@ -0,0 +1,972 @@
+..
+..
+.. 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-v1-deliveryservice_requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`
+
+:Auth. Required: Yes
+:Roles Required: None\ [#tenancy]_
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+======================================================================================================================================+
+ | assignee | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | assigneeId | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | author | no | Show only the :ref:`ds_requests` created by this author identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Show only the :ref:`ds_requests` created by this author identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | changeType | no | Return only the :ref:`ds_requests` that have this changeType identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Show only the :ref:`ds_requests` that has this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | status | no | Return only :ref:`ds_requests` that have this status identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | xmlId | no | Return only :ref:`ds_requests` that have this xmlId identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | orderby | no | Choose the ordering of the results - must be the name of one of the fields of the objects in the ``response`` |
+ | | | array |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either ascending (default or "asc") or descending ("desc") |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to return |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before beginning to return results. Must use in conjunction with limit |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | page | no | Return the n\ :sup:`th` page of results, where "n" is the value of this parameter, pages are ``limit`` long and the first page is 1. |
+ | | | If ``offset`` was defined, this query parameter has no effect. ``limit`` must be defined to make use of ``page``. |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+Response Structure
+------------------
+:assigneeId: The integral, unique identifier of the assignee of this :ref:`ds_requests`
+:assignee: Name of the assignee to which the :ref:`ds_requests` is assigned to
+:authorId: The integral, unique identifier of the author of this :ref:`ds_requests`
+:author: Name of the author who created this :ref:`ds_requests`
+:changeType: The type of change made to the delivery service as described in this :ref:`ds_requests`
+:createdAt: The date and time at which this :ref:`ds_requests` was created, in :rfc:`3339` format
+:id: An integral, unique identifier for this :ref:`ds_requests`
+:lastEditedBy: Name of the previous user to edit this :ref:`ds_requests`
+:lastEditedById: The integral, unique identifier of the previous user to edit this :ref:`ds_requests`
+:lastUpdated: The date and time at which this :ref:`ds_requests` was last updated, in :rfc:`3339` format
+:status: The status of this :ref:`ds_requests`
+
+:deliveryService: An object describing the actual parameters for the Delivery Service request
+ :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`
+
+ .. versionadded:: 1.4
+
+ :consistentHashQueryParams: An array of :ref:`ds-consistent-hashing-qparams`
+
+ .. versionadded:: 1.4
+
+ :deepCachingType: The :ref:`ds-deep-caching` setting for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.5
+
+ :edgeHeaderRewrite: A set of :ref:`ds-edge-header-rw-rules`
+ :exampleURLs: An array of :ref:`ds-example-urls`
+ :fqPacingRate: The :ref:`ds-fqpr`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.4
+
+ :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`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.3
+
+ :trRequestHeaders: If defined, this defines the :ref:`ds-tr-req-headers` used by Traffic Router for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :trResponseHeaders: If defined, this defines the :ref:`ds-tr-resp-headers` used by Traffic Router for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+.. 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-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Wed, 12 Feb 2020 00:21:40 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: ME1ZLCtgXYrWlIXhS6qn4YqOzx2yk7aoe0hV7AxRsZfH0/TiCPOnLLkOHxS6YfuuIQK9UQNPxuOxDlAK78rkxA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Tue, 11 Feb 2020 23:21:40 GMT
+ Transfer-Encoding: chunked
+
+ { "response": [{
+ "assigneeId": 2,
+ "assignee": "admin",
+ "authorId": 2,
+ "author": "admin",
+ "changeType": "create",
+ "createdAt": "2020-02-11 20:05:48+00",
+ "id": 1,
+ "lastEditedBy": "admin",
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-11 20:05:48+00",
+ "deliveryService": {
+ "active": true,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": null,
+ "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": "2019-05-15 14:32:05+00",
+ "logsEnabled": true,
+ "longDesc": "Demo Delivery Service Request",
+ "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": null,
+ "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": "complete"
+ }]}
+
+
+``POST``
+========
+Allows users to create :ref:`ds_requests`.
+
+:Auth. Required: Yes
+:Roles Required: Portal\ [#tenancy]_
+:Response Type: Array
+
+Request Structure
+-----------------
+:changeType: The type of change made to the delivery service as described in this :ref:`ds_requests`
+:status: The status of this :ref:`ds_requests`
+
+:deliveryService: An object describing the actual parameters for the Delivery Service request
+ :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
+ :checkPath: A :ref:`ds-check-path`
+ :consistentHashRegex: A :ref:`ds-consistent-hashing-regex`
+
+ .. versionadded:: 1.4
+
+ :consistentHashQueryParams: An array of :ref:`ds-consistent-hashing-qparams`
+
+ .. versionadded:: 1.4
+
+ :deepCachingType: The :ref:`ds-deep-caching` setting for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.4
+
+ :edgeHeaderRewrite: A set of :ref:`ds-edge-header-rw-rules`
+ :fqPacingRate: The :ref:`ds-fqpr`
+
+ .. versionadded:: 1.3
+
+ :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`
+ :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`
+ :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`
+ :maxDnsAnswers: The :ref:`ds-max-dns-answers` allowed for this :term:`Delivery Service`
+ :maxOriginConnections: The :ref:`ds-max-origin-connections`
+
+ .. versionadded:: 1.4
+
+ :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
+ :profileId: An optional :ref:`profile-id` of a :ref:`ds-profile` with which this :term:`Delivery Service` shall be 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`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.3
+
+ :trRequestHeaders: If defined, this defines the :ref:`ds-tr-req-headers` used by Traffic Router for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :trResponseHeaders: If defined, this defines the :ref:`ds-tr-resp-headers` used by Traffic Router for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+.. code-block:: http
+ :caption: Request Example
+
+ POST /api/1.3/deliveryservice_requests HTTP/1.1
+ Host: trafficops.infra.ciab.test
+ User-Agent: curl/7.47.0
+ Accept: */*
+ Cookie: mojolicious=...
+ Content-Length: 777
+ Content-Type: application/json
+
+ {
+ "changeType": "create",
+ "deliveryService": {
+ "active": true,
+ "cdnId": 2,
+ "displayName": "test",
+ "dscp": 0,
+ "geoLimit": 0,
+ "geoProvider": 0,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "logsEnabled": false,
+ "missLat": 0,
+ "missLong": 0,
+ "multiSiteOrigin": false,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "protocol": 0,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regionalGeoBlocking": false,
+ "tenantId": 1,
+ "typeId": 1,
+ "xmlId": "demo1"
+ },
+ "status": "submitted"
+ }
+
+
+Response Structure
+------------------
+:assigneeId: The integral, unique identifier of the assignee of this :ref:`ds_requests`
+:assignee: Name of the assignee to which the :ref:`ds_requests` is assigned to
+:authorId: The integral, unique identifier of the author of this :ref:`ds_requests`
+:author: Name of the author who created this :ref:`ds_requests`
+:changeType: The type of change made to the delivery service as described in this :ref:`ds_requests`
+:createdAt: The date and time at which this :ref:`ds_requests` was created, in :rfc:`3339` format
+:id: An integral, unique identifier for this :ref:`ds_requests`
+:lastEditedBy: Name of the previous user to edit this :ref:`ds_requests`
+:lastEditedById: The integral, unique identifier of the previous user to edit this :ref:`ds_requests`
+:lastUpdated: The date and time at which this :ref:`ds_requests` was last updated, in :rfc:`3339` format
+:status: The status of this :ref:`ds_requests`
Review comment:
Same as my above comments on this section for the `GET` method response
----------------------------------------------------------------
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
#4629: API Documentation for deliveryservice_requests
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4629: API Documentation for deliveryservice_requests
URL: https://github.com/apache/trafficcontrol/pull/4629#discussion_r406874316
##########
File path: docs/source/api/v1/deliveryservice_requests.rst
##########
@@ -0,0 +1,972 @@
+..
+..
+.. 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-v1-deliveryservice_requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`
+
+:Auth. Required: Yes
+:Roles Required: None\ [#tenancy]_
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+======================================================================================================================================+
+ | assignee | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | assigneeId | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | author | no | Show only the :ref:`ds_requests` created by this author identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Show only the :ref:`ds_requests` created by this author identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | changeType | no | Return only the :ref:`ds_requests` that have this changeType identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Show only the :ref:`ds_requests` that has this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | status | no | Return only :ref:`ds_requests` that have this status identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | xmlId | no | Return only :ref:`ds_requests` that have this xmlId identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | orderby | no | Choose the ordering of the results - must be the name of one of the fields of the objects in the ``response`` |
+ | | | array |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either ascending (default or "asc") or descending ("desc") |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to return |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before beginning to return results. Must use in conjunction with limit |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | page | no | Return the n\ :sup:`th` page of results, where "n" is the value of this parameter, pages are ``limit`` long and the first page is 1. |
+ | | | If ``offset`` was defined, this query parameter has no effect. ``limit`` must be defined to make use of ``page``. |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+Response Structure
+------------------
+:assigneeId: The integral, unique identifier of the assignee of this :ref:`ds_requests`
+:assignee: Name of the assignee to which the :ref:`ds_requests` is assigned to
+:authorId: The integral, unique identifier of the author of this :ref:`ds_requests`
+:author: Name of the author who created this :ref:`ds_requests`
+:changeType: The type of change made to the delivery service as described in this :ref:`ds_requests`
+:createdAt: The date and time at which this :ref:`ds_requests` was created, in :rfc:`3339` format
+:id: An integral, unique identifier for this :ref:`ds_requests`
+:lastEditedBy: Name of the previous user to edit this :ref:`ds_requests`
+:lastEditedById: The integral, unique identifier of the previous user to edit this :ref:`ds_requests`
+:lastUpdated: The date and time at which this :ref:`ds_requests` was last updated, in :rfc:`3339` format
+:status: The status of this :ref:`ds_requests`
+
+:deliveryService: An object describing the actual parameters for the Delivery Service request
+ :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`
+
+ .. versionadded:: 1.4
+
+ :consistentHashQueryParams: An array of :ref:`ds-consistent-hashing-qparams`
+
+ .. versionadded:: 1.4
+
+ :deepCachingType: The :ref:`ds-deep-caching` setting for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.5
+
+ :edgeHeaderRewrite: A set of :ref:`ds-edge-header-rw-rules`
+ :exampleURLs: An array of :ref:`ds-example-urls`
+ :fqPacingRate: The :ref:`ds-fqpr`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.4
+
+ :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`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.3
+
+ :trRequestHeaders: If defined, this defines the :ref:`ds-tr-req-headers` used by Traffic Router for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :trResponseHeaders: If defined, this defines the :ref:`ds-tr-resp-headers` used by Traffic Router for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+.. 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-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Wed, 12 Feb 2020 00:21:40 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: ME1ZLCtgXYrWlIXhS6qn4YqOzx2yk7aoe0hV7AxRsZfH0/TiCPOnLLkOHxS6YfuuIQK9UQNPxuOxDlAK78rkxA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Tue, 11 Feb 2020 23:21:40 GMT
+ Transfer-Encoding: chunked
+
+ { "response": [{
+ "assigneeId": 2,
+ "assignee": "admin",
+ "authorId": 2,
+ "author": "admin",
+ "changeType": "create",
+ "createdAt": "2020-02-11 20:05:48+00",
+ "id": 1,
+ "lastEditedBy": "admin",
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-11 20:05:48+00",
+ "deliveryService": {
+ "active": true,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": null,
+ "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": "2019-05-15 14:32:05+00",
+ "logsEnabled": true,
+ "longDesc": "Demo Delivery Service Request",
+ "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": null,
+ "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": "complete"
+ }]}
+
+
+``POST``
+========
+Allows users to create :ref:`ds_requests`.
+
+:Auth. Required: Yes
+:Roles Required: Portal\ [#tenancy]_
+:Response Type: Array
+
+Request Structure
+-----------------
+:changeType: The type of change made to the delivery service as described in this :ref:`ds_requests`
+:status: The status of this :ref:`ds_requests`
+
+:deliveryService: An object describing the actual parameters for the Delivery Service request
+ :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
+ :checkPath: A :ref:`ds-check-path`
+ :consistentHashRegex: A :ref:`ds-consistent-hashing-regex`
+
+ .. versionadded:: 1.4
+
+ :consistentHashQueryParams: An array of :ref:`ds-consistent-hashing-qparams`
+
+ .. versionadded:: 1.4
+
+ :deepCachingType: The :ref:`ds-deep-caching` setting for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.4
+
+ :edgeHeaderRewrite: A set of :ref:`ds-edge-header-rw-rules`
+ :fqPacingRate: The :ref:`ds-fqpr`
+
+ .. versionadded:: 1.3
+
+ :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`
+ :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`
+ :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`
+ :maxDnsAnswers: The :ref:`ds-max-dns-answers` allowed for this :term:`Delivery Service`
+ :maxOriginConnections: The :ref:`ds-max-origin-connections`
+
+ .. versionadded:: 1.4
+
+ :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
+ :profileId: An optional :ref:`profile-id` of a :ref:`ds-profile` with which this :term:`Delivery Service` shall be 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`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.3
+
+ :trRequestHeaders: If defined, this defines the :ref:`ds-tr-req-headers` used by Traffic Router for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :trResponseHeaders: If defined, this defines the :ref:`ds-tr-resp-headers` used by Traffic Router for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+.. code-block:: http
+ :caption: Request Example
+
+ POST /api/1.3/deliveryservice_requests HTTP/1.1
+ Host: trafficops.infra.ciab.test
+ User-Agent: curl/7.47.0
+ Accept: */*
+ Cookie: mojolicious=...
+ Content-Length: 777
+ Content-Type: application/json
+
+ {
+ "changeType": "create",
+ "deliveryService": {
+ "active": true,
+ "cdnId": 2,
+ "displayName": "test",
+ "dscp": 0,
+ "geoLimit": 0,
+ "geoProvider": 0,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "logsEnabled": false,
+ "missLat": 0,
+ "missLong": 0,
+ "multiSiteOrigin": false,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "protocol": 0,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regionalGeoBlocking": false,
+ "tenantId": 1,
+ "typeId": 1,
+ "xmlId": "demo1"
+ },
+ "status": "submitted"
+ }
+
+
+Response Structure
+------------------
+:assigneeId: The integral, unique identifier of the assignee of this :ref:`ds_requests`
+:assignee: Name of the assignee to which the :ref:`ds_requests` is assigned to
+:authorId: The integral, unique identifier of the author of this :ref:`ds_requests`
+:author: Name of the author who created this :ref:`ds_requests`
+:changeType: The type of change made to the delivery service as described in this :ref:`ds_requests`
+:createdAt: The date and time at which this :ref:`ds_requests` was created, in :rfc:`3339` format
+:id: An integral, unique identifier for this :ref:`ds_requests`
+:lastEditedBy: Name of the previous user to edit this :ref:`ds_requests`
+:lastEditedById: The integral, unique identifier of the previous user to edit this :ref:`ds_requests`
+:lastUpdated: The date and time at which this :ref:`ds_requests` was last updated, in :rfc:`3339` format
+:status: The status of this :ref:`ds_requests`
+
+:deliveryService: An object describing the actual parameters for the Delivery Service request
+ :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`
+
+ .. versionadded:: 1.4
+
+ :consistentHashQueryParams: An array of :ref:`ds-consistent-hashing-qparams`
+
+ .. versionadded:: 1.4
+
+ :deepCachingType: The :ref:`ds-deep-caching` setting for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.4
+
+ :edgeHeaderRewrite: A set of :ref:`ds-edge-header-rw-rules`
+ :exampleURLs: An array of :ref:`ds-example-urls`
+ :fqPacingRate: The :ref:`ds-fqpr`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.4
+
+ :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`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.3
+
+ :trRequestHeaders: If defined, this defines the :ref:`ds-tr-req-headers` used by Traffic Router for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :trResponseHeaders: If defined, this defines the :ref:`ds-tr-resp-headers` used by Traffic Router for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+.. 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-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: SVveQ5hGwfPv8N5APUskwLOzwrTUVA+z8wuFLsSLCr1/vVnFJJ0VQOGMUctg1NbqhAuQ795MJmuuAaAwR8dSOQ==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 19 Nov 2018 19:45:49 GMT
+ Content-Length: 792
+
+ { "alerts": [
+ {
+ "text": "deliveryservice_request was created.",
+ "level": "success"
+ }
+ ],
+ "response": {
+ "authorId": 2,
+ "author": null,
+ "changeType": "create",
+ "createdAt": null,
+ "id": 1,
+ "lastEditedBy": null,
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-12 18:18:33+00",
+ "deliveryService": {
+ "active": true,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": null,
+ "checkPath": null,
+ "displayName": "test",
+ "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": null,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": null,
+ "logsEnabled": false,
+ "longDesc": null,
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": null,
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 0,
+ "missLong": 0,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 0,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "cdn",
+ "signed": false,
+ "sslKeyVersion": null,
+ "tenantId": 1,
+ "type": null,
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": null,
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": null,
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": null,
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "submitted"
+ }}
+
+
+
+``PUT``
+=======
+Allows users to edit an existing :ref:`ds_requests`.
+
+:Auth. Required: Yes
+:Roles Required: Portal\ [#tenancy]_
+:Response Type:
+
+Request Structure
+-----------------
+
+.. table:: Request Path Parameters
+
+ +------+-------------------------------------------------------------------------------+
+ | Name | Description |
+ +======+===============================================================================+
+ | ID | The integral, unique identifier of the :ref:`ds_requests` to be updated |
+ +------+-------------------------------------------------------------------------------+
+
+:changeType: The type of change of this :ref:`ds_requests`
+:status: The status of this :ref:`ds_requests`
+
+:deliveryService: An object describing the actual parameters for the Delivery Service request
+ :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
+ :checkPath: A :ref:`ds-check-path`
+ :consistentHashRegex: A :ref:`ds-consistent-hashing-regex`
+
+ .. versionadded:: 1.4
+
+ :consistentHashQueryParams: An array of :ref:`ds-consistent-hashing-qparams`
+
+ .. versionadded:: 1.4
+
+ :deepCachingType: The :ref:`ds-deep-caching` setting for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.4
+
+ :edgeHeaderRewrite: A set of :ref:`ds-edge-header-rw-rules`
+ :fqPacingRate: The :ref:`ds-fqpr`
+
+ .. versionadded:: 1.3
+
+ :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`
+ :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`
+ :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`
+ :maxDnsAnswers: The :ref:`ds-max-dns-answers` allowed for this :term:`Delivery Service`
+ :maxOriginConnections: The :ref:`ds-max-origin-connections`
+
+ .. versionadded:: 1.4
+
+ :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
+ :profileId: An optional :ref:`profile-id` of the :ref:`ds-profile` with which this :term:`Delivery Service` will be 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`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.3
+
+ :trRequestHeaders: If defined, this defines the :ref:`ds-tr-req-headers` used by Traffic Router for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :trResponseHeaders: If defined, this defines the :ref:`ds-tr-resp-headers` used by Traffic Router for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :typeId: The integral, unique identifier of the :ref:`ds-types` of this :term:`Delivery Service`
+ :xmlId: This :term:`Delivery Service`'s :ref:`ds-xmlid`
+
+ .. note:: While this field **must** be present, it is **not** allowed to change; this must be the same as the ``xml_id`` the :term:`Delivery Service` already has. This should almost never be different from the :term:`Delivery Service`'s ``displayName``.
+
+
+.. code-block:: http
+ :caption: Request Example
+
+ PUT /api/1.3/deliveryservice_reques?id=1 HTTP/1.1
+ Host: trafficops.infra.ciab.test
+ User-Agent: curl/7.47.0
+ Accept: */*
+ Cookie: mojolicious=...
+ Content-Length: 756
+ Content-Type: application/json
+
+ {
+ "changeType": "create",
+ "deliveryService": {
+ "active": true,
+ "cdnId": 2,
+ "displayName": "test",
+ "dscp": 0,
+ "geoLimit": 0,
+ "geoProvider": 0,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "logsEnabled": false,
+ "missLat": 0,
+ "missLong": 0,
+ "multiSiteOrigin": false,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "protocol": 0,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regionalGeoBlocking": false,
+ "tenantId": 1,
+ "typeId": 1,
+ "xmlId": "demo1"
+ },
+ "status": "draft"
+ }
+
+
+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: *
+ Set-Cookie: mojolicious=...; Path=/; Expires=Wed, 12 Feb 2020 21:08:53 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: CrvtsPOSStvRNophKIvKc7m2vyT1yLqDqORi8rkcQ7jJ8XSaw5mX5zqWb2BNavpgO3/k69Pcj4gB/RfYFv71eA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Wed, 12 Feb 2020 20:08:53 GMT
+ Content-Length: 756
+ Content-Type: text/plain; charset=utf-8
+
+ { "alerts": [
+ {
+ "text": "deliveryservice_request was updated.",
+ "level": "success"
+ }
+ ],
+ "response": {
+ "authorId": 2,
+ "author": null,
+ "changeType": "create",
+ "createdAt": null,
+ "id": 1,
+ "lastEditedBy": null,
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-12 20:12:20+00",
+ "deliveryService": {
+ "active": true,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": null,
+ "checkPath": null,
+ "displayName": "test",
+ "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": null,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": null,
+ "logsEnabled": false,
+ "longDesc": null,
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": null,
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 0,
+ "missLong": 0,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 0,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "cdn",
+ "signed": false,
+ "sslKeyVersion": null,
+ "tenantId": 1,
+ "type": null,
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": null,
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": null,
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": null,
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "draft"
+ }}
+
+
+``DELETE``
+==========
+Deletes the target :term:`Delivery Service`
Review comment:
I don't think that's true
----------------------------------------------------------------
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
#4629: API Documentation for deliveryservice_requests
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4629: API Documentation for deliveryservice_requests
URL: https://github.com/apache/trafficcontrol/pull/4629#discussion_r406869681
##########
File path: docs/source/api/v1/deliveryservice_requests.rst
##########
@@ -0,0 +1,972 @@
+..
+..
+.. 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-v1-deliveryservice_requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`
+
+:Auth. Required: Yes
+:Roles Required: None\ [#tenancy]_
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+======================================================================================================================================+
+ | assignee | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | assigneeId | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | author | no | Show only the :ref:`ds_requests` created by this author identified by this text-based, unique identifier |
Review comment:
What text-based identifier? Email? Username?
----------------------------------------------------------------
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
#4629: API Documentation for deliveryservice_requests
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4629: API Documentation for deliveryservice_requests
URL: https://github.com/apache/trafficcontrol/pull/4629#discussion_r406898430
##########
File path: docs/source/api/v1/deliveryservice_requests.rst
##########
@@ -0,0 +1,972 @@
+..
+..
+.. 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-v1-deliveryservice_requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`
+
+:Auth. Required: Yes
+:Roles Required: None\ [#tenancy]_
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+======================================================================================================================================+
+ | assignee | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | assigneeId | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | author | no | Show only the :ref:`ds_requests` created by this author identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Show only the :ref:`ds_requests` created by this author identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | changeType | no | Return only the :ref:`ds_requests` that have this changeType identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Show only the :ref:`ds_requests` that has this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | status | no | Return only :ref:`ds_requests` that have this status identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | xmlId | no | Return only :ref:`ds_requests` that have this xmlId identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | orderby | no | Choose the ordering of the results - must be the name of one of the fields of the objects in the ``response`` |
+ | | | array |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either ascending (default or "asc") or descending ("desc") |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to return |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before beginning to return results. Must use in conjunction with limit |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | page | no | Return the n\ :sup:`th` page of results, where "n" is the value of this parameter, pages are ``limit`` long and the first page is 1. |
+ | | | If ``offset`` was defined, this query parameter has no effect. ``limit`` must be defined to make use of ``page``. |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+Response Structure
+------------------
+:assigneeId: The integral, unique identifier of the assignee of this :ref:`ds_requests`
+:assignee: Name of the assignee to which the :ref:`ds_requests` is assigned to
+:authorId: The integral, unique identifier of the author of this :ref:`ds_requests`
+:author: Name of the author who created this :ref:`ds_requests`
+:changeType: The type of change made to the delivery service as described in this :ref:`ds_requests`
+:createdAt: The date and time at which this :ref:`ds_requests` was created, in :rfc:`3339` format
Review comment:
Yeah, that's more accurate.
----------------------------------------------------------------
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
#4629: API Documentation for deliveryservice_requests
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4629: API Documentation for deliveryservice_requests
URL: https://github.com/apache/trafficcontrol/pull/4629#discussion_r406873411
##########
File path: docs/source/api/v1/deliveryservice_requests.rst
##########
@@ -0,0 +1,972 @@
+..
+..
+.. 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-v1-deliveryservice_requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`
+
+:Auth. Required: Yes
+:Roles Required: None\ [#tenancy]_
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+======================================================================================================================================+
+ | assignee | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | assigneeId | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | author | no | Show only the :ref:`ds_requests` created by this author identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Show only the :ref:`ds_requests` created by this author identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | changeType | no | Return only the :ref:`ds_requests` that have this changeType identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Show only the :ref:`ds_requests` that has this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | status | no | Return only :ref:`ds_requests` that have this status identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | xmlId | no | Return only :ref:`ds_requests` that have this xmlId identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | orderby | no | Choose the ordering of the results - must be the name of one of the fields of the objects in the ``response`` |
+ | | | array |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either ascending (default or "asc") or descending ("desc") |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to return |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before beginning to return results. Must use in conjunction with limit |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | page | no | Return the n\ :sup:`th` page of results, where "n" is the value of this parameter, pages are ``limit`` long and the first page is 1. |
+ | | | If ``offset`` was defined, this query parameter has no effect. ``limit`` must be defined to make use of ``page``. |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+Response Structure
+------------------
+:assigneeId: The integral, unique identifier of the assignee of this :ref:`ds_requests`
+:assignee: Name of the assignee to which the :ref:`ds_requests` is assigned to
+:authorId: The integral, unique identifier of the author of this :ref:`ds_requests`
+:author: Name of the author who created this :ref:`ds_requests`
+:changeType: The type of change made to the delivery service as described in this :ref:`ds_requests`
+:createdAt: The date and time at which this :ref:`ds_requests` was created, in :rfc:`3339` format
+:id: An integral, unique identifier for this :ref:`ds_requests`
+:lastEditedBy: Name of the previous user to edit this :ref:`ds_requests`
+:lastEditedById: The integral, unique identifier of the previous user to edit this :ref:`ds_requests`
+:lastUpdated: The date and time at which this :ref:`ds_requests` was last updated, in :rfc:`3339` format
+:status: The status of this :ref:`ds_requests`
+
+:deliveryService: An object describing the actual parameters for the Delivery Service request
+ :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`
+
+ .. versionadded:: 1.4
+
+ :consistentHashQueryParams: An array of :ref:`ds-consistent-hashing-qparams`
+
+ .. versionadded:: 1.4
+
+ :deepCachingType: The :ref:`ds-deep-caching` setting for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.5
+
+ :edgeHeaderRewrite: A set of :ref:`ds-edge-header-rw-rules`
+ :exampleURLs: An array of :ref:`ds-example-urls`
+ :fqPacingRate: The :ref:`ds-fqpr`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.4
+
+ :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`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.3
+
+ :trRequestHeaders: If defined, this defines the :ref:`ds-tr-req-headers` used by Traffic Router for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :trResponseHeaders: If defined, this defines the :ref:`ds-tr-resp-headers` used by Traffic Router for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+.. 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-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Wed, 12 Feb 2020 00:21:40 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: ME1ZLCtgXYrWlIXhS6qn4YqOzx2yk7aoe0hV7AxRsZfH0/TiCPOnLLkOHxS6YfuuIQK9UQNPxuOxDlAK78rkxA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Tue, 11 Feb 2020 23:21:40 GMT
+ Transfer-Encoding: chunked
+
+ { "response": [{
+ "assigneeId": 2,
+ "assignee": "admin",
+ "authorId": 2,
+ "author": "admin",
+ "changeType": "create",
+ "createdAt": "2020-02-11 20:05:48+00",
+ "id": 1,
+ "lastEditedBy": "admin",
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-11 20:05:48+00",
+ "deliveryService": {
+ "active": true,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": null,
+ "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": "2019-05-15 14:32:05+00",
+ "logsEnabled": true,
+ "longDesc": "Demo Delivery Service Request",
+ "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": null,
+ "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": "complete"
+ }]}
+
+
+``POST``
+========
+Allows users to create :ref:`ds_requests`.
+
+:Auth. Required: Yes
+:Roles Required: Portal\ [#tenancy]_
+:Response Type: Array
+
+Request Structure
+-----------------
+:changeType: The type of change made to the delivery service as described in this :ref:`ds_requests`
+:status: The status of this :ref:`ds_requests`
Review comment:
Is this the Name of a Status? Or an ID of a Status? Or something else altogether?
----------------------------------------------------------------
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
#4629: API Documentation for deliveryservice_requests
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4629: API Documentation for deliveryservice_requests
URL: https://github.com/apache/trafficcontrol/pull/4629#discussion_r406874191
##########
File path: docs/source/api/v1/deliveryservice_requests.rst
##########
@@ -0,0 +1,972 @@
+..
+..
+.. 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-v1-deliveryservice_requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`
+
+:Auth. Required: Yes
+:Roles Required: None\ [#tenancy]_
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+======================================================================================================================================+
+ | assignee | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | assigneeId | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | author | no | Show only the :ref:`ds_requests` created by this author identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Show only the :ref:`ds_requests` created by this author identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | changeType | no | Return only the :ref:`ds_requests` that have this changeType identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Show only the :ref:`ds_requests` that has this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | status | no | Return only :ref:`ds_requests` that have this status identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | xmlId | no | Return only :ref:`ds_requests` that have this xmlId identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | orderby | no | Choose the ordering of the results - must be the name of one of the fields of the objects in the ``response`` |
+ | | | array |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either ascending (default or "asc") or descending ("desc") |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to return |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before beginning to return results. Must use in conjunction with limit |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | page | no | Return the n\ :sup:`th` page of results, where "n" is the value of this parameter, pages are ``limit`` long and the first page is 1. |
+ | | | If ``offset`` was defined, this query parameter has no effect. ``limit`` must be defined to make use of ``page``. |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+Response Structure
+------------------
+:assigneeId: The integral, unique identifier of the assignee of this :ref:`ds_requests`
+:assignee: Name of the assignee to which the :ref:`ds_requests` is assigned to
+:authorId: The integral, unique identifier of the author of this :ref:`ds_requests`
+:author: Name of the author who created this :ref:`ds_requests`
+:changeType: The type of change made to the delivery service as described in this :ref:`ds_requests`
+:createdAt: The date and time at which this :ref:`ds_requests` was created, in :rfc:`3339` format
+:id: An integral, unique identifier for this :ref:`ds_requests`
+:lastEditedBy: Name of the previous user to edit this :ref:`ds_requests`
+:lastEditedById: The integral, unique identifier of the previous user to edit this :ref:`ds_requests`
+:lastUpdated: The date and time at which this :ref:`ds_requests` was last updated, in :rfc:`3339` format
+:status: The status of this :ref:`ds_requests`
+
+:deliveryService: An object describing the actual parameters for the Delivery Service request
+ :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`
+
+ .. versionadded:: 1.4
+
+ :consistentHashQueryParams: An array of :ref:`ds-consistent-hashing-qparams`
+
+ .. versionadded:: 1.4
+
+ :deepCachingType: The :ref:`ds-deep-caching` setting for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.5
+
+ :edgeHeaderRewrite: A set of :ref:`ds-edge-header-rw-rules`
+ :exampleURLs: An array of :ref:`ds-example-urls`
+ :fqPacingRate: The :ref:`ds-fqpr`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.4
+
+ :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`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.3
+
+ :trRequestHeaders: If defined, this defines the :ref:`ds-tr-req-headers` used by Traffic Router for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :trResponseHeaders: If defined, this defines the :ref:`ds-tr-resp-headers` used by Traffic Router for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+.. 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-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Wed, 12 Feb 2020 00:21:40 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: ME1ZLCtgXYrWlIXhS6qn4YqOzx2yk7aoe0hV7AxRsZfH0/TiCPOnLLkOHxS6YfuuIQK9UQNPxuOxDlAK78rkxA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Tue, 11 Feb 2020 23:21:40 GMT
+ Transfer-Encoding: chunked
+
+ { "response": [{
+ "assigneeId": 2,
+ "assignee": "admin",
+ "authorId": 2,
+ "author": "admin",
+ "changeType": "create",
+ "createdAt": "2020-02-11 20:05:48+00",
+ "id": 1,
+ "lastEditedBy": "admin",
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-11 20:05:48+00",
+ "deliveryService": {
+ "active": true,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": null,
+ "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": "2019-05-15 14:32:05+00",
+ "logsEnabled": true,
+ "longDesc": "Demo Delivery Service Request",
+ "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": null,
+ "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": "complete"
+ }]}
+
+
+``POST``
+========
+Allows users to create :ref:`ds_requests`.
+
+:Auth. Required: Yes
+:Roles Required: Portal\ [#tenancy]_
+:Response Type: Array
+
+Request Structure
+-----------------
+:changeType: The type of change made to the delivery service as described in this :ref:`ds_requests`
+:status: The status of this :ref:`ds_requests`
+
+:deliveryService: An object describing the actual parameters for the Delivery Service request
+ :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
+ :checkPath: A :ref:`ds-check-path`
+ :consistentHashRegex: A :ref:`ds-consistent-hashing-regex`
+
+ .. versionadded:: 1.4
+
+ :consistentHashQueryParams: An array of :ref:`ds-consistent-hashing-qparams`
+
+ .. versionadded:: 1.4
+
+ :deepCachingType: The :ref:`ds-deep-caching` setting for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.4
+
+ :edgeHeaderRewrite: A set of :ref:`ds-edge-header-rw-rules`
+ :fqPacingRate: The :ref:`ds-fqpr`
+
+ .. versionadded:: 1.3
+
+ :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`
+ :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`
+ :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`
+ :maxDnsAnswers: The :ref:`ds-max-dns-answers` allowed for this :term:`Delivery Service`
+ :maxOriginConnections: The :ref:`ds-max-origin-connections`
+
+ .. versionadded:: 1.4
+
+ :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
+ :profileId: An optional :ref:`profile-id` of a :ref:`ds-profile` with which this :term:`Delivery Service` shall be 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`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.3
+
+ :trRequestHeaders: If defined, this defines the :ref:`ds-tr-req-headers` used by Traffic Router for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :trResponseHeaders: If defined, this defines the :ref:`ds-tr-resp-headers` used by Traffic Router for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+.. code-block:: http
+ :caption: Request Example
+
+ POST /api/1.3/deliveryservice_requests HTTP/1.1
+ Host: trafficops.infra.ciab.test
+ User-Agent: curl/7.47.0
+ Accept: */*
+ Cookie: mojolicious=...
+ Content-Length: 777
+ Content-Type: application/json
+
+ {
+ "changeType": "create",
+ "deliveryService": {
+ "active": true,
+ "cdnId": 2,
+ "displayName": "test",
+ "dscp": 0,
+ "geoLimit": 0,
+ "geoProvider": 0,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "logsEnabled": false,
+ "missLat": 0,
+ "missLong": 0,
+ "multiSiteOrigin": false,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "protocol": 0,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regionalGeoBlocking": false,
+ "tenantId": 1,
+ "typeId": 1,
+ "xmlId": "demo1"
+ },
+ "status": "submitted"
+ }
+
+
+Response Structure
+------------------
+:assigneeId: The integral, unique identifier of the assignee of this :ref:`ds_requests`
+:assignee: Name of the assignee to which the :ref:`ds_requests` is assigned to
+:authorId: The integral, unique identifier of the author of this :ref:`ds_requests`
+:author: Name of the author who created this :ref:`ds_requests`
+:changeType: The type of change made to the delivery service as described in this :ref:`ds_requests`
+:createdAt: The date and time at which this :ref:`ds_requests` was created, in :rfc:`3339` format
+:id: An integral, unique identifier for this :ref:`ds_requests`
+:lastEditedBy: Name of the previous user to edit this :ref:`ds_requests`
+:lastEditedById: The integral, unique identifier of the previous user to edit this :ref:`ds_requests`
+:lastUpdated: The date and time at which this :ref:`ds_requests` was last updated, in :rfc:`3339` format
+:status: The status of this :ref:`ds_requests`
+
+:deliveryService: An object describing the actual parameters for the Delivery Service request
+ :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`
+
+ .. versionadded:: 1.4
+
+ :consistentHashQueryParams: An array of :ref:`ds-consistent-hashing-qparams`
+
+ .. versionadded:: 1.4
+
+ :deepCachingType: The :ref:`ds-deep-caching` setting for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.4
+
+ :edgeHeaderRewrite: A set of :ref:`ds-edge-header-rw-rules`
+ :exampleURLs: An array of :ref:`ds-example-urls`
+ :fqPacingRate: The :ref:`ds-fqpr`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.4
+
+ :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`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.3
+
+ :trRequestHeaders: If defined, this defines the :ref:`ds-tr-req-headers` used by Traffic Router for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :trResponseHeaders: If defined, this defines the :ref:`ds-tr-resp-headers` used by Traffic Router for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+.. 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-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: SVveQ5hGwfPv8N5APUskwLOzwrTUVA+z8wuFLsSLCr1/vVnFJJ0VQOGMUctg1NbqhAuQ795MJmuuAaAwR8dSOQ==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 19 Nov 2018 19:45:49 GMT
+ Content-Length: 792
+
+ { "alerts": [
+ {
+ "text": "deliveryservice_request was created.",
+ "level": "success"
+ }
+ ],
+ "response": {
+ "authorId": 2,
+ "author": null,
+ "changeType": "create",
+ "createdAt": null,
+ "id": 1,
+ "lastEditedBy": null,
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-12 18:18:33+00",
+ "deliveryService": {
+ "active": true,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": null,
+ "checkPath": null,
+ "displayName": "test",
+ "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": null,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": null,
+ "logsEnabled": false,
+ "longDesc": null,
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": null,
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 0,
+ "missLong": 0,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 0,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "cdn",
+ "signed": false,
+ "sslKeyVersion": null,
+ "tenantId": 1,
+ "type": null,
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": null,
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": null,
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": null,
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "submitted"
+ }}
+
+
+
+``PUT``
+=======
+Allows users to edit an existing :ref:`ds_requests`.
+
+:Auth. Required: Yes
+:Roles Required: Portal\ [#tenancy]_
+:Response Type:
+
+Request Structure
+-----------------
+
+.. table:: Request Path Parameters
+
+ +------+-------------------------------------------------------------------------------+
+ | Name | Description |
+ +======+===============================================================================+
+ | ID | The integral, unique identifier of the :ref:`ds_requests` to be updated |
+ +------+-------------------------------------------------------------------------------+
+
+:changeType: The type of change of this :ref:`ds_requests`
+:status: The status of this :ref:`ds_requests`
+
+:deliveryService: An object describing the actual parameters for the Delivery Service request
+ :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
+ :checkPath: A :ref:`ds-check-path`
+ :consistentHashRegex: A :ref:`ds-consistent-hashing-regex`
+
+ .. versionadded:: 1.4
+
+ :consistentHashQueryParams: An array of :ref:`ds-consistent-hashing-qparams`
+
+ .. versionadded:: 1.4
+
+ :deepCachingType: The :ref:`ds-deep-caching` setting for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.4
+
+ :edgeHeaderRewrite: A set of :ref:`ds-edge-header-rw-rules`
+ :fqPacingRate: The :ref:`ds-fqpr`
+
+ .. versionadded:: 1.3
+
+ :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`
+ :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`
+ :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`
+ :maxDnsAnswers: The :ref:`ds-max-dns-answers` allowed for this :term:`Delivery Service`
+ :maxOriginConnections: The :ref:`ds-max-origin-connections`
+
+ .. versionadded:: 1.4
+
+ :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
+ :profileId: An optional :ref:`profile-id` of the :ref:`ds-profile` with which this :term:`Delivery Service` will be 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`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.3
+
+ :trRequestHeaders: If defined, this defines the :ref:`ds-tr-req-headers` used by Traffic Router for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :trResponseHeaders: If defined, this defines the :ref:`ds-tr-resp-headers` used by Traffic Router for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :typeId: The integral, unique identifier of the :ref:`ds-types` of this :term:`Delivery Service`
+ :xmlId: This :term:`Delivery Service`'s :ref:`ds-xmlid`
+
+ .. note:: While this field **must** be present, it is **not** allowed to change; this must be the same as the ``xml_id`` the :term:`Delivery Service` already has. This should almost never be different from the :term:`Delivery Service`'s ``displayName``.
+
+
+.. code-block:: http
+ :caption: Request Example
+
+ PUT /api/1.3/deliveryservice_reques?id=1 HTTP/1.1
+ Host: trafficops.infra.ciab.test
+ User-Agent: curl/7.47.0
+ Accept: */*
+ Cookie: mojolicious=...
+ Content-Length: 756
+ Content-Type: application/json
+
+ {
+ "changeType": "create",
+ "deliveryService": {
+ "active": true,
+ "cdnId": 2,
+ "displayName": "test",
+ "dscp": 0,
+ "geoLimit": 0,
+ "geoProvider": 0,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "logsEnabled": false,
+ "missLat": 0,
+ "missLong": 0,
+ "multiSiteOrigin": false,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "protocol": 0,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regionalGeoBlocking": false,
+ "tenantId": 1,
+ "typeId": 1,
+ "xmlId": "demo1"
+ },
+ "status": "draft"
+ }
+
+
+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] ZugNZwang commented on a change in pull request
#4629: API Documentation for deliveryservice_requests
Posted by GitBox <gi...@apache.org>.
ZugNZwang commented on a change in pull request #4629: API Documentation for deliveryservice_requests
URL: https://github.com/apache/trafficcontrol/pull/4629#discussion_r406892103
##########
File path: docs/source/api/v1/deliveryservice_requests.rst
##########
@@ -0,0 +1,972 @@
+..
+..
+.. 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-v1-deliveryservice_requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`
+
+:Auth. Required: Yes
+:Roles Required: None\ [#tenancy]_
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+======================================================================================================================================+
+ | assignee | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | assigneeId | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | author | no | Show only the :ref:`ds_requests` created by this author identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Show only the :ref:`ds_requests` created by this author identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | changeType | no | Return only the :ref:`ds_requests` that have this changeType identified by this text-based, unique identifier |
Review comment:
It seems to be restricted to a set of values
----------------------------------------------------------------
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
#4629: API Documentation for deliveryservice_requests
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4629: API Documentation for deliveryservice_requests
URL: https://github.com/apache/trafficcontrol/pull/4629#discussion_r406868829
##########
File path: docs/source/api/v1/deliveryservice_requests.rst
##########
@@ -0,0 +1,972 @@
+..
+..
+.. 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-v1-deliveryservice_requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`
+
+:Auth. Required: Yes
+:Roles Required: None\ [#tenancy]_
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+======================================================================================================================================+
+ | assignee | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | assigneeId | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | author | no | Show only the :ref:`ds_requests` created by this author identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Show only the :ref:`ds_requests` created by this author identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | changeType | no | Return only the :ref:`ds_requests` that have this changeType identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Show only the :ref:`ds_requests` that has this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | status | no | Return only :ref:`ds_requests` that have this status identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | xmlId | no | Return only :ref:`ds_requests` that have this xmlId identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | orderby | no | Choose the ordering of the results - must be the name of one of the fields of the objects in the ``response`` |
+ | | | array |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either ascending (default or "asc") or descending ("desc") |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to return |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before beginning to return results. Must use in conjunction with limit |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | page | no | Return the n\ :sup:`th` page of results, where "n" is the value of this parameter, pages are ``limit`` long and the first page is 1. |
+ | | | If ``offset`` was defined, this query parameter has no effect. ``limit`` must be defined to make use of ``page``. |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+Response Structure
+------------------
+:assigneeId: The integral, unique identifier of the assignee of this :ref:`ds_requests`
+:assignee: Name of the assignee to which the :ref:`ds_requests` is assigned to
+:authorId: The integral, unique identifier of the author of this :ref:`ds_requests`
+:author: Name of the author who created this :ref:`ds_requests`
Review comment:
Same as above
----------------------------------------------------------------
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
#4629: API Documentation for deliveryservice_requests
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4629: API Documentation for deliveryservice_requests
URL: https://github.com/apache/trafficcontrol/pull/4629#discussion_r406871901
##########
File path: docs/source/api/v1/deliveryservice_requests.rst
##########
@@ -0,0 +1,972 @@
+..
+..
+.. 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-v1-deliveryservice_requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`
+
+:Auth. Required: Yes
+:Roles Required: None\ [#tenancy]_
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+======================================================================================================================================+
+ | assignee | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | assigneeId | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | author | no | Show only the :ref:`ds_requests` created by this author identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Show only the :ref:`ds_requests` created by this author identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | changeType | no | Return only the :ref:`ds_requests` that have this changeType identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Show only the :ref:`ds_requests` that has this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | status | no | Return only :ref:`ds_requests` that have this status identified by this text-based, unique identifier |
Review comment:
Is this the Name of a Status? Or is it restricted to a set of values?
----------------------------------------------------------------
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
#4629: API Documentation for deliveryservice_requests
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4629: API Documentation for deliveryservice_requests
URL: https://github.com/apache/trafficcontrol/pull/4629#discussion_r406897675
##########
File path: docs/source/api/v1/deliveryservice_requests.rst
##########
@@ -0,0 +1,972 @@
+..
+..
+.. 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-v1-deliveryservice_requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`
+
+:Auth. Required: Yes
+:Roles Required: None\ [#tenancy]_
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+======================================================================================================================================+
+ | assignee | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | assigneeId | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | author | no | Show only the :ref:`ds_requests` created by this author identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Show only the :ref:`ds_requests` created by this author identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | changeType | no | Return only the :ref:`ds_requests` that have this changeType identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Show only the :ref:`ds_requests` that has this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | status | no | Return only :ref:`ds_requests` that have this status identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | xmlId | no | Return only :ref:`ds_requests` that have this xmlId identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | orderby | no | Choose the ordering of the results - must be the name of one of the fields of the objects in the ``response`` |
+ | | | array |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either ascending (default or "asc") or descending ("desc") |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to return |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before beginning to return results. Must use in conjunction with limit |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | page | no | Return the n\ :sup:`th` page of results, where "n" is the value of this parameter, pages are ``limit`` long and the first page is 1. |
+ | | | If ``offset`` was defined, this query parameter has no effect. ``limit`` must be defined to make use of ``page``. |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+Response Structure
+------------------
+:assigneeId: The integral, unique identifier of the assignee of this :ref:`ds_requests`
+:assignee: Name of the assignee to which the :ref:`ds_requests` is assigned to
Review comment:
Would you mind changing it to say that, so that it's clear?
----------------------------------------------------------------
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
#4629: API Documentation for deliveryservice_requests
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4629: API Documentation for deliveryservice_requests
URL: https://github.com/apache/trafficcontrol/pull/4629#discussion_r406872248
##########
File path: docs/source/api/v1/deliveryservice_requests.rst
##########
@@ -0,0 +1,972 @@
+..
+..
+.. 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-v1-deliveryservice_requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`
+
+:Auth. Required: Yes
+:Roles Required: None\ [#tenancy]_
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+======================================================================================================================================+
+ | assignee | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | assigneeId | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | author | no | Show only the :ref:`ds_requests` created by this author identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Show only the :ref:`ds_requests` created by this author identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | changeType | no | Return only the :ref:`ds_requests` that have this changeType identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Show only the :ref:`ds_requests` that has this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | status | no | Return only :ref:`ds_requests` that have this status identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | xmlId | no | Return only :ref:`ds_requests` that have this xmlId identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | orderby | no | Choose the ordering of the results - must be the name of one of the fields of the objects in the ``response`` |
+ | | | array |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either ascending (default or "asc") or descending ("desc") |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to return |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before beginning to return results. Must use in conjunction with limit |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | page | no | Return the n\ :sup:`th` page of results, where "n" is the value of this parameter, pages are ``limit`` long and the first page is 1. |
+ | | | If ``offset`` was defined, this query parameter has no effect. ``limit`` must be defined to make use of ``page``. |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+Response Structure
+------------------
+:assigneeId: The integral, unique identifier of the assignee of this :ref:`ds_requests`
+:assignee: Name of the assignee to which the :ref:`ds_requests` is assigned to
+:authorId: The integral, unique identifier of the author of this :ref:`ds_requests`
+:author: Name of the author who created this :ref:`ds_requests`
+:changeType: The type of change made to the delivery service as described in this :ref:`ds_requests`
+:createdAt: The date and time at which this :ref:`ds_requests` was created, in :rfc:`3339` format
+:id: An integral, unique identifier for this :ref:`ds_requests`
+:lastEditedBy: Name of the previous user to edit this :ref:`ds_requests`
+:lastEditedById: The integral, unique identifier of the previous user to edit this :ref:`ds_requests`
+:lastUpdated: The date and time at which this :ref:`ds_requests` was last updated, in :rfc:`3339` format
Review comment:
Based on the example this isn't true; the returned timestamps aren't in RFC3339 format
----------------------------------------------------------------
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
#4629: API Documentation for deliveryservice_requests
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4629: API Documentation for deliveryservice_requests
URL: https://github.com/apache/trafficcontrol/pull/4629#discussion_r406872020
##########
File path: docs/source/api/v1/deliveryservice_requests.rst
##########
@@ -0,0 +1,972 @@
+..
+..
+.. 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-v1-deliveryservice_requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`
+
+:Auth. Required: Yes
+:Roles Required: None\ [#tenancy]_
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+======================================================================================================================================+
+ | assignee | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | assigneeId | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | author | no | Show only the :ref:`ds_requests` created by this author identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Show only the :ref:`ds_requests` created by this author identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | changeType | no | Return only the :ref:`ds_requests` that have this changeType identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Show only the :ref:`ds_requests` that has this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | status | no | Return only :ref:`ds_requests` that have this status identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | xmlId | no | Return only :ref:`ds_requests` that have this xmlId identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | orderby | no | Choose the ordering of the results - must be the name of one of the fields of the objects in the ``response`` |
+ | | | array |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either ascending (default or "asc") or descending ("desc") |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to return |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before beginning to return results. Must use in conjunction with limit |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | page | no | Return the n\ :sup:`th` page of results, where "n" is the value of this parameter, pages are ``limit`` long and the first page is 1. |
+ | | | If ``offset`` was defined, this query parameter has no effect. ``limit`` must be defined to make use of ``page``. |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+Response Structure
+------------------
+:assigneeId: The integral, unique identifier of the assignee of this :ref:`ds_requests`
+:assignee: Name of the assignee to which the :ref:`ds_requests` is assigned to
+:authorId: The integral, unique identifier of the author of this :ref:`ds_requests`
+:author: Name of the author who created this :ref:`ds_requests`
+:changeType: The type of change made to the delivery service as described in this :ref:`ds_requests`
+:createdAt: The date and time at which this :ref:`ds_requests` was created, in :rfc:`3339` format
+:id: An integral, unique identifier for this :ref:`ds_requests`
+:lastEditedBy: Name of the previous user to edit this :ref:`ds_requests`
Review comment:
Username or full name?
----------------------------------------------------------------
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] ZugNZwang commented on a change in pull request
#4629: API Documentation for deliveryservice_requests
Posted by GitBox <gi...@apache.org>.
ZugNZwang commented on a change in pull request #4629: API Documentation for deliveryservice_requests
URL: https://github.com/apache/trafficcontrol/pull/4629#discussion_r406897816
##########
File path: docs/source/api/v1/deliveryservice_requests.rst
##########
@@ -0,0 +1,972 @@
+..
+..
+.. 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-v1-deliveryservice_requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`
+
+:Auth. Required: Yes
+:Roles Required: None\ [#tenancy]_
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+======================================================================================================================================+
+ | assignee | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | assigneeId | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | author | no | Show only the :ref:`ds_requests` created by this author identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Show only the :ref:`ds_requests` created by this author identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | changeType | no | Return only the :ref:`ds_requests` that have this changeType identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Show only the :ref:`ds_requests` that has this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | status | no | Return only :ref:`ds_requests` that have this status identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | xmlId | no | Return only :ref:`ds_requests` that have this xmlId identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | orderby | no | Choose the ordering of the results - must be the name of one of the fields of the objects in the ``response`` |
+ | | | array |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either ascending (default or "asc") or descending ("desc") |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to return |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before beginning to return results. Must use in conjunction with limit |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | page | no | Return the n\ :sup:`th` page of results, where "n" is the value of this parameter, pages are ``limit`` long and the first page is 1. |
+ | | | If ``offset`` was defined, this query parameter has no effect. ``limit`` must be defined to make use of ``page``. |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+Response Structure
+------------------
+:assigneeId: The integral, unique identifier of the assignee of this :ref:`ds_requests`
+:assignee: Name of the assignee to which the :ref:`ds_requests` is assigned to
+:authorId: The integral, unique identifier of the author of this :ref:`ds_requests`
+:author: Name of the author who created this :ref:`ds_requests`
+:changeType: The type of change made to the delivery service as described in this :ref:`ds_requests`
+:createdAt: The date and time at which this :ref:`ds_requests` was created, in :rfc:`3339` format
Review comment:
Other documented endpoints use: `in ISO-like format`
----------------------------------------------------------------
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
#4629: API Documentation for deliveryservice_requests
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4629: API Documentation for deliveryservice_requests
URL: https://github.com/apache/trafficcontrol/pull/4629#discussion_r406874057
##########
File path: docs/source/api/v1/deliveryservice_requests.rst
##########
@@ -0,0 +1,972 @@
+..
+..
+.. 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-v1-deliveryservice_requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`
+
+:Auth. Required: Yes
+:Roles Required: None\ [#tenancy]_
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+======================================================================================================================================+
+ | assignee | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | assigneeId | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | author | no | Show only the :ref:`ds_requests` created by this author identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Show only the :ref:`ds_requests` created by this author identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | changeType | no | Return only the :ref:`ds_requests` that have this changeType identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Show only the :ref:`ds_requests` that has this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | status | no | Return only :ref:`ds_requests` that have this status identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | xmlId | no | Return only :ref:`ds_requests` that have this xmlId identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | orderby | no | Choose the ordering of the results - must be the name of one of the fields of the objects in the ``response`` |
+ | | | array |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either ascending (default or "asc") or descending ("desc") |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to return |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before beginning to return results. Must use in conjunction with limit |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | page | no | Return the n\ :sup:`th` page of results, where "n" is the value of this parameter, pages are ``limit`` long and the first page is 1. |
+ | | | If ``offset`` was defined, this query parameter has no effect. ``limit`` must be defined to make use of ``page``. |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+Response Structure
+------------------
+:assigneeId: The integral, unique identifier of the assignee of this :ref:`ds_requests`
+:assignee: Name of the assignee to which the :ref:`ds_requests` is assigned to
+:authorId: The integral, unique identifier of the author of this :ref:`ds_requests`
+:author: Name of the author who created this :ref:`ds_requests`
+:changeType: The type of change made to the delivery service as described in this :ref:`ds_requests`
+:createdAt: The date and time at which this :ref:`ds_requests` was created, in :rfc:`3339` format
+:id: An integral, unique identifier for this :ref:`ds_requests`
+:lastEditedBy: Name of the previous user to edit this :ref:`ds_requests`
+:lastEditedById: The integral, unique identifier of the previous user to edit this :ref:`ds_requests`
+:lastUpdated: The date and time at which this :ref:`ds_requests` was last updated, in :rfc:`3339` format
+:status: The status of this :ref:`ds_requests`
+
+:deliveryService: An object describing the actual parameters for the Delivery Service request
+ :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`
+
+ .. versionadded:: 1.4
+
+ :consistentHashQueryParams: An array of :ref:`ds-consistent-hashing-qparams`
+
+ .. versionadded:: 1.4
+
+ :deepCachingType: The :ref:`ds-deep-caching` setting for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.5
+
+ :edgeHeaderRewrite: A set of :ref:`ds-edge-header-rw-rules`
+ :exampleURLs: An array of :ref:`ds-example-urls`
+ :fqPacingRate: The :ref:`ds-fqpr`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.4
+
+ :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`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.3
+
+ :trRequestHeaders: If defined, this defines the :ref:`ds-tr-req-headers` used by Traffic Router for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :trResponseHeaders: If defined, this defines the :ref:`ds-tr-resp-headers` used by Traffic Router for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+.. 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-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Wed, 12 Feb 2020 00:21:40 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: ME1ZLCtgXYrWlIXhS6qn4YqOzx2yk7aoe0hV7AxRsZfH0/TiCPOnLLkOHxS6YfuuIQK9UQNPxuOxDlAK78rkxA==
+ X-Server-Name: traffic_ops_golang/
+ Date: Tue, 11 Feb 2020 23:21:40 GMT
+ Transfer-Encoding: chunked
+
+ { "response": [{
+ "assigneeId": 2,
+ "assignee": "admin",
+ "authorId": 2,
+ "author": "admin",
+ "changeType": "create",
+ "createdAt": "2020-02-11 20:05:48+00",
+ "id": 1,
+ "lastEditedBy": "admin",
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-11 20:05:48+00",
+ "deliveryService": {
+ "active": true,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": null,
+ "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": "2019-05-15 14:32:05+00",
+ "logsEnabled": true,
+ "longDesc": "Demo Delivery Service Request",
+ "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": null,
+ "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": "complete"
+ }]}
+
+
+``POST``
+========
+Allows users to create :ref:`ds_requests`.
+
+:Auth. Required: Yes
+:Roles Required: Portal\ [#tenancy]_
+:Response Type: Array
+
+Request Structure
+-----------------
+:changeType: The type of change made to the delivery service as described in this :ref:`ds_requests`
+:status: The status of this :ref:`ds_requests`
+
+:deliveryService: An object describing the actual parameters for the Delivery Service request
+ :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
+ :checkPath: A :ref:`ds-check-path`
+ :consistentHashRegex: A :ref:`ds-consistent-hashing-regex`
+
+ .. versionadded:: 1.4
+
+ :consistentHashQueryParams: An array of :ref:`ds-consistent-hashing-qparams`
+
+ .. versionadded:: 1.4
+
+ :deepCachingType: The :ref:`ds-deep-caching` setting for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.4
+
+ :edgeHeaderRewrite: A set of :ref:`ds-edge-header-rw-rules`
+ :fqPacingRate: The :ref:`ds-fqpr`
+
+ .. versionadded:: 1.3
+
+ :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`
+ :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`
+ :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`
+ :maxDnsAnswers: The :ref:`ds-max-dns-answers` allowed for this :term:`Delivery Service`
+ :maxOriginConnections: The :ref:`ds-max-origin-connections`
+
+ .. versionadded:: 1.4
+
+ :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
+ :profileId: An optional :ref:`profile-id` of a :ref:`ds-profile` with which this :term:`Delivery Service` shall be 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`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.3
+
+ :trRequestHeaders: If defined, this defines the :ref:`ds-tr-req-headers` used by Traffic Router for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :trResponseHeaders: If defined, this defines the :ref:`ds-tr-resp-headers` used by Traffic Router for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+.. code-block:: http
+ :caption: Request Example
+
+ POST /api/1.3/deliveryservice_requests HTTP/1.1
+ Host: trafficops.infra.ciab.test
+ User-Agent: curl/7.47.0
+ Accept: */*
+ Cookie: mojolicious=...
+ Content-Length: 777
+ Content-Type: application/json
+
+ {
+ "changeType": "create",
+ "deliveryService": {
+ "active": true,
+ "cdnId": 2,
+ "displayName": "test",
+ "dscp": 0,
+ "geoLimit": 0,
+ "geoProvider": 0,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "logsEnabled": false,
+ "missLat": 0,
+ "missLong": 0,
+ "multiSiteOrigin": false,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "protocol": 0,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regionalGeoBlocking": false,
+ "tenantId": 1,
+ "typeId": 1,
+ "xmlId": "demo1"
+ },
+ "status": "submitted"
+ }
+
+
+Response Structure
+------------------
+:assigneeId: The integral, unique identifier of the assignee of this :ref:`ds_requests`
+:assignee: Name of the assignee to which the :ref:`ds_requests` is assigned to
+:authorId: The integral, unique identifier of the author of this :ref:`ds_requests`
+:author: Name of the author who created this :ref:`ds_requests`
+:changeType: The type of change made to the delivery service as described in this :ref:`ds_requests`
+:createdAt: The date and time at which this :ref:`ds_requests` was created, in :rfc:`3339` format
+:id: An integral, unique identifier for this :ref:`ds_requests`
+:lastEditedBy: Name of the previous user to edit this :ref:`ds_requests`
+:lastEditedById: The integral, unique identifier of the previous user to edit this :ref:`ds_requests`
+:lastUpdated: The date and time at which this :ref:`ds_requests` was last updated, in :rfc:`3339` format
+:status: The status of this :ref:`ds_requests`
+
+:deliveryService: An object describing the actual parameters for the Delivery Service request
+ :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`
+
+ .. versionadded:: 1.4
+
+ :consistentHashQueryParams: An array of :ref:`ds-consistent-hashing-qparams`
+
+ .. versionadded:: 1.4
+
+ :deepCachingType: The :ref:`ds-deep-caching` setting for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.4
+
+ :edgeHeaderRewrite: A set of :ref:`ds-edge-header-rw-rules`
+ :exampleURLs: An array of :ref:`ds-example-urls`
+ :fqPacingRate: The :ref:`ds-fqpr`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.4
+
+ :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`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+ .. versionadded:: 1.3
+
+ :trRequestHeaders: If defined, this defines the :ref:`ds-tr-req-headers` used by Traffic Router for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :trResponseHeaders: If defined, this defines the :ref:`ds-tr-resp-headers` used by Traffic Router for this :term:`Delivery Service`
+
+ .. versionadded:: 1.3
+
+ :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`
+
+.. 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-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: SVveQ5hGwfPv8N5APUskwLOzwrTUVA+z8wuFLsSLCr1/vVnFJJ0VQOGMUctg1NbqhAuQ795MJmuuAaAwR8dSOQ==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 19 Nov 2018 19:45:49 GMT
+ Content-Length: 792
+
+ { "alerts": [
+ {
+ "text": "deliveryservice_request was created.",
+ "level": "success"
+ }
+ ],
+ "response": {
+ "authorId": 2,
+ "author": null,
+ "changeType": "create",
+ "createdAt": null,
+ "id": 1,
+ "lastEditedBy": null,
+ "lastEditedById": 2,
+ "lastUpdated": "2020-02-12 18:18:33+00",
+ "deliveryService": {
+ "active": true,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": null,
+ "cdnId": 2,
+ "cdnName": null,
+ "checkPath": null,
+ "displayName": "test",
+ "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": null,
+ "infoUrl": null,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": null,
+ "logsEnabled": false,
+ "longDesc": null,
+ "longDesc1": null,
+ "longDesc2": null,
+ "matchList": null,
+ "maxDnsAnswers": null,
+ "midHeaderRewrite": null,
+ "missLat": 0,
+ "missLong": 0,
+ "multiSiteOrigin": false,
+ "originShield": null,
+ "orgServerFqdn": "http://origin.infra.ciab.test",
+ "profileDescription": null,
+ "profileId": null,
+ "profileName": null,
+ "protocol": 0,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "cdn",
+ "signed": false,
+ "sslKeyVersion": null,
+ "tenantId": 1,
+ "type": null,
+ "typeId": 1,
+ "xmlId": "demo1",
+ "exampleURLs": null,
+ "deepCachingType": "NEVER",
+ "fqPacingRate": null,
+ "signingAlgorithm": null,
+ "tenant": null,
+ "trResponseHeaders": null,
+ "trRequestHeaders": null,
+ "consistentHashRegex": null,
+ "consistentHashQueryParams": null,
+ "maxOriginConnections": 0,
+ "ecsEnabled": false
+ },
+ "status": "submitted"
+ }}
+
+
+
+``PUT``
+=======
+Allows users to edit an existing :ref:`ds_requests`.
+
+:Auth. Required: Yes
+:Roles Required: Portal\ [#tenancy]_
+:Response Type:
+
+Request Structure
+-----------------
+
+.. table:: Request Path Parameters
+
+ +------+-------------------------------------------------------------------------------+
+ | Name | Description |
+ +======+===============================================================================+
+ | ID | The integral, unique identifier of the :ref:`ds_requests` to be updated |
+ +------+-------------------------------------------------------------------------------+
+
+:changeType: The type of change of this :ref:`ds_requests`
+:status: The status of this :ref:`ds_requests`
Review comment:
Same as my above comments on this section for `POST` request payloads.
----------------------------------------------------------------
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] ZugNZwang commented on a change in pull request
#4629: API Documentation for deliveryservice_requests
Posted by GitBox <gi...@apache.org>.
ZugNZwang commented on a change in pull request #4629: API Documentation for deliveryservice_requests
URL: https://github.com/apache/trafficcontrol/pull/4629#discussion_r406893317
##########
File path: docs/source/api/v1/deliveryservice_requests.rst
##########
@@ -0,0 +1,972 @@
+..
+..
+.. 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-v1-deliveryservice_requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`
+
+:Auth. Required: Yes
+:Roles Required: None\ [#tenancy]_
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+======================================================================================================================================+
+ | assignee | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | assigneeId | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | author | no | Show only the :ref:`ds_requests` created by this author identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Show only the :ref:`ds_requests` created by this author identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | changeType | no | Return only the :ref:`ds_requests` that have this changeType identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Show only the :ref:`ds_requests` that has this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | status | no | Return only :ref:`ds_requests` that have this status identified by this text-based, unique identifier |
Review comment:
They're restricted to this set:
https://github.com/apache/trafficcontrol/blob/70544337088e0eec669961be4d1028a37a8838f7/lib/go-tc/deliveryservice_requests.go#L452-L459
----------------------------------------------------------------
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
#4629: API Documentation for deliveryservice_requests
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4629: API Documentation for deliveryservice_requests
URL: https://github.com/apache/trafficcontrol/pull/4629#discussion_r406870453
##########
File path: docs/source/api/v1/deliveryservice_requests.rst
##########
@@ -0,0 +1,972 @@
+..
+..
+.. 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-v1-deliveryservice_requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`
+
+:Auth. Required: Yes
+:Roles Required: None\ [#tenancy]_
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+======================================================================================================================================+
+ | assignee | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | assigneeId | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | author | no | Show only the :ref:`ds_requests` created by this author identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Show only the :ref:`ds_requests` created by this author identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | changeType | no | Return only the :ref:`ds_requests` that have this changeType identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Show only the :ref:`ds_requests` that has this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | status | no | Return only :ref:`ds_requests` that have this status identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | xmlId | no | Return only :ref:`ds_requests` that have this xmlId identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | orderby | no | Choose the ordering of the results - must be the name of one of the fields of the objects in the ``response`` |
+ | | | array |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either ascending (default or "asc") or descending ("desc") |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to return |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before beginning to return results. Must use in conjunction with limit |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | page | no | Return the n\ :sup:`th` page of results, where "n" is the value of this parameter, pages are ``limit`` long and the first page is 1. |
+ | | | If ``offset`` was defined, this query parameter has no effect. ``limit`` must be defined to make use of ``page``. |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+Response Structure
+------------------
+:assigneeId: The integral, unique identifier of the assignee of this :ref:`ds_requests`
+:assignee: Name of the assignee to which the :ref:`ds_requests` is assigned to
+:authorId: The integral, unique identifier of the author of this :ref:`ds_requests`
+:author: Name of the author who created this :ref:`ds_requests`
+:changeType: The type of change made to the delivery service as described in this :ref:`ds_requests`
+:createdAt: The date and time at which this :ref:`ds_requests` was created, in :rfc:`3339` format
Review comment:
Based on the example, this isn't true; the returned timestamps aren't in RFC3339 format.
----------------------------------------------------------------
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
#4629: API Documentation for deliveryservice_requests
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4629: API Documentation for deliveryservice_requests
URL: https://github.com/apache/trafficcontrol/pull/4629#discussion_r406871769
##########
File path: docs/source/api/v1/deliveryservice_requests.rst
##########
@@ -0,0 +1,972 @@
+..
+..
+.. 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-v1-deliveryservice_requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`
+
+:Auth. Required: Yes
+:Roles Required: None\ [#tenancy]_
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+======================================================================================================================================+
+ | assignee | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | assigneeId | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | author | no | Show only the :ref:`ds_requests` created by this author identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Show only the :ref:`ds_requests` created by this author identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | changeType | no | Return only the :ref:`ds_requests` that have this changeType identified by this text-based, unique identifier |
Review comment:
Is this the Name of a Type? Or is it restricted to a set of values?
----------------------------------------------------------------
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] ZugNZwang commented on a change in pull request
#4629: API Documentation for deliveryservice_requests
Posted by GitBox <gi...@apache.org>.
ZugNZwang commented on a change in pull request #4629: API Documentation for deliveryservice_requests
URL: https://github.com/apache/trafficcontrol/pull/4629#discussion_r406877140
##########
File path: docs/source/api/v1/deliveryservice_requests.rst
##########
@@ -0,0 +1,972 @@
+..
+..
+.. 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-v1-deliveryservice_requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`
+
+:Auth. Required: Yes
+:Roles Required: None\ [#tenancy]_
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+======================================================================================================================================+
+ | assignee | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | assigneeId | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | author | no | Show only the :ref:`ds_requests` created by this author identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Show only the :ref:`ds_requests` created by this author identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | changeType | no | Return only the :ref:`ds_requests` that have this changeType identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Show only the :ref:`ds_requests` that has this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | status | no | Return only :ref:`ds_requests` that have this status identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | xmlId | no | Return only :ref:`ds_requests` that have this xmlId identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | orderby | no | Choose the ordering of the results - must be the name of one of the fields of the objects in the ``response`` |
+ | | | array |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either ascending (default or "asc") or descending ("desc") |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to return |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before beginning to return results. Must use in conjunction with limit |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | page | no | Return the n\ :sup:`th` page of results, where "n" is the value of this parameter, pages are ``limit`` long and the first page is 1. |
+ | | | If ``offset`` was defined, this query parameter has no effect. ``limit`` must be defined to make use of ``page``. |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+Response Structure
+------------------
+:assigneeId: The integral, unique identifier of the assignee of this :ref:`ds_requests`
+:assignee: Name of the assignee to which the :ref:`ds_requests` is assigned to
Review comment:
Username of the user
----------------------------------------------------------------
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
#4629: API Documentation for deliveryservice_requests
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4629: API Documentation for deliveryservice_requests
URL: https://github.com/apache/trafficcontrol/pull/4629#discussion_r406868756
##########
File path: docs/source/api/v1/deliveryservice_requests.rst
##########
@@ -0,0 +1,972 @@
+..
+..
+.. 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-v1-deliveryservice_requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`
+
+:Auth. Required: Yes
+:Roles Required: None\ [#tenancy]_
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+======================================================================================================================================+
+ | assignee | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | assigneeId | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | author | no | Show only the :ref:`ds_requests` created by this author identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Show only the :ref:`ds_requests` created by this author identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | changeType | no | Return only the :ref:`ds_requests` that have this changeType identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Show only the :ref:`ds_requests` that has this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | status | no | Return only :ref:`ds_requests` that have this status identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | xmlId | no | Return only :ref:`ds_requests` that have this xmlId identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | orderby | no | Choose the ordering of the results - must be the name of one of the fields of the objects in the ``response`` |
+ | | | array |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either ascending (default or "asc") or descending ("desc") |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to return |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before beginning to return results. Must use in conjunction with limit |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | page | no | Return the n\ :sup:`th` page of results, where "n" is the value of this parameter, pages are ``limit`` long and the first page is 1. |
+ | | | If ``offset`` was defined, this query parameter has no effect. ``limit`` must be defined to make use of ``page``. |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+Response Structure
+------------------
+:assigneeId: The integral, unique identifier of the assignee of this :ref:`ds_requests`
+:assignee: Name of the assignee to which the :ref:`ds_requests` is assigned to
Review comment:
Is this just an arbitrary name? Or is it the full name or username of a user?
----------------------------------------------------------------
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
#4629: API Documentation for deliveryservice_requests
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4629: API Documentation for deliveryservice_requests
URL: https://github.com/apache/trafficcontrol/pull/4629#discussion_r406869405
##########
File path: docs/source/api/v1/deliveryservice_requests.rst
##########
@@ -0,0 +1,972 @@
+..
+..
+.. 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-v1-deliveryservice_requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`
+
+:Auth. Required: Yes
+:Roles Required: None\ [#tenancy]_
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+======================================================================================================================================+
+ | assignee | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | assigneeId | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | author | no | Show only the :ref:`ds_requests` created by this author identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Show only the :ref:`ds_requests` created by this author identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | changeType | no | Return only the :ref:`ds_requests` that have this changeType identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Show only the :ref:`ds_requests` that has this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | status | no | Return only :ref:`ds_requests` that have this status identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | xmlId | no | Return only :ref:`ds_requests` that have this xmlId identified by this text-based, unique identifier |
Review comment:
DS Requests don't have XMLIDs though, do they? This is the XMLID of the *Delivery Service* to which the request pertains, 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] ZugNZwang commented on a change in pull request
#4629: API Documentation for deliveryservice_requests
Posted by GitBox <gi...@apache.org>.
ZugNZwang commented on a change in pull request #4629: API Documentation for deliveryservice_requests
URL: https://github.com/apache/trafficcontrol/pull/4629#discussion_r406877247
##########
File path: docs/source/api/v1/deliveryservice_requests.rst
##########
@@ -0,0 +1,972 @@
+..
+..
+.. 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-v1-deliveryservice_requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`
+
+:Auth. Required: Yes
+:Roles Required: None\ [#tenancy]_
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+======================================================================================================================================+
+ | assignee | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | assigneeId | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | author | no | Show only the :ref:`ds_requests` created by this author identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Show only the :ref:`ds_requests` created by this author identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | changeType | no | Return only the :ref:`ds_requests` that have this changeType identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Show only the :ref:`ds_requests` that has this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | status | no | Return only :ref:`ds_requests` that have this status identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | xmlId | no | Return only :ref:`ds_requests` that have this xmlId identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | orderby | no | Choose the ordering of the results - must be the name of one of the fields of the objects in the ``response`` |
+ | | | array |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either ascending (default or "asc") or descending ("desc") |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to return |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before beginning to return results. Must use in conjunction with limit |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | page | no | Return the n\ :sup:`th` page of results, where "n" is the value of this parameter, pages are ``limit`` long and the first page is 1. |
+ | | | If ``offset`` was defined, this query parameter has no effect. ``limit`` must be defined to make use of ``page``. |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+Response Structure
+------------------
+:assigneeId: The integral, unique identifier of the assignee of this :ref:`ds_requests`
+:assignee: Name of the assignee to which the :ref:`ds_requests` is assigned to
+:authorId: The integral, unique identifier of the author of this :ref:`ds_requests`
+:author: Name of the author who created this :ref:`ds_requests`
Review comment:
Also the username of the user
----------------------------------------------------------------
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
#4629: API Documentation for deliveryservice_requests
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4629: API Documentation for deliveryservice_requests
URL: https://github.com/apache/trafficcontrol/pull/4629#discussion_r406897330
##########
File path: docs/source/api/v1/deliveryservice_requests.rst
##########
@@ -0,0 +1,972 @@
+..
+..
+.. 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-v1-deliveryservice_requests:
+
+****************************
+``deliveryservice_requests``
+****************************
+
+``GET``
+=======
+Retrieves :ref:`ds_requests`
+
+:Auth. Required: Yes
+:Roles Required: None\ [#tenancy]_
+:Response Type: Array
+
+Request Structure
+-----------------
+.. table:: Request Query Parameters
+
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+======================================================================================================================================+
+ | assignee | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | assigneeId | no | Show only the :ref:`ds_requests` assigned to this assignee identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | author | no | Show only the :ref:`ds_requests` created by this author identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | authorId | no | Show only the :ref:`ds_requests` created by this author identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | changeType | no | Return only the :ref:`ds_requests` that have this changeType identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Show only the :ref:`ds_requests` that has this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | status | no | Return only :ref:`ds_requests` that have this status identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | xmlId | no | Return only :ref:`ds_requests` that have this xmlId identified by this text-based, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | orderby | no | Choose the ordering of the results - must be the name of one of the fields of the objects in the ``response`` |
+ | | | array |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | sortOrder | no | Changes the order of sorting. Either ascending (default or "asc") or descending ("desc") |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | limit | no | Choose the maximum number of results to return |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | offset | no | The number of results to skip before beginning to return results. Must use in conjunction with limit |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | page | no | Return the n\ :sup:`th` page of results, where "n" is the value of this parameter, pages are ``limit`` long and the first page is 1. |
+ | | | If ``offset`` was defined, this query parameter has no effect. ``limit`` must be defined to make use of ``page``. |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+Response Structure
+------------------
+:assigneeId: The integral, unique identifier of the assignee of this :ref:`ds_requests`
+:assignee: Name of the assignee to which the :ref:`ds_requests` is assigned to
+:authorId: The integral, unique identifier of the author of this :ref:`ds_requests`
+:author: Name of the author who created this :ref:`ds_requests`
+:changeType: The type of change made to the delivery service as described in this :ref:`ds_requests`
+:createdAt: The date and time at which this :ref:`ds_requests` was created, in :rfc:`3339` format
Review comment:
interesting
----------------------------------------------------------------
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