Skip to content
This repository was archived by the owner on Nov 24, 2025. It is now read-only.

Add service category feature to TO and TP #4518

Merged
mattjackson220 merged 44 commits into from
Aug 11, 2020
Merged

Add service category feature to TO and TP #4518

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
6571548
add service category to TP and TO
jehunte Mar 10, 2020
b0619de
add service category documentation
jehunte Mar 11, 2020
99626d4
add creation of x-cdn-svc remap rule to ats config
jehunte Mar 13, 2020
f6f73fd
add service category to TP and TO
jehunte Mar 10, 2020
bca63c9
add service category documentation
jehunte Mar 11, 2020
2888b68
add creation of x-cdn-svc remap rule to ats config
jehunte Mar 13, 2020
61bafcf
add service category to TP and TO
jehunte Mar 10, 2020
639018b
add service category documentation
jehunte Mar 11, 2020
e39a4c6
fix indentation
jehunte Mar 18, 2020
830982e
add tenant scope
jehunte Mar 20, 2020
6b8c66a
add tenant scope
jehunte Mar 20, 2020
2d745c7
address michaels pr comments
jehunte Mar 27, 2020
318f94b
add service category role capabilities to new api routes
jehunte Mar 31, 2020
b3f0b27
rebase with master and resolve merge conflicts
jehunte Apr 16, 2020
654b1f4
update service category to api v3
jehunte Apr 30, 2020
fc666aa
change TP service category route to latest
jehunte May 5, 2020
35f0840
revert latest path to root and fix v1 ort test
jehunte May 18, 2020
1065bce
update db migration filename and ats service category header
jehunte May 19, 2020
579667d
address pr comments from ocket8888 and mitchell852
jehunte May 26, 2020
22d0d75
fix indentation issue from rst plugin
jehunte May 26, 2020
5515cae
rebase with master to resolve ats conflict
jehunte May 27, 2020
786163d
update service category path and move under services tab
jehunte Jun 19, 2020
091e709
adds topology column
mitchell852 Jul 21, 2020
861d342
fixes c/p error
mitchell852 Jul 21, 2020
6838820
update read method and fix merge conflicts
jehunte Jul 29, 2020
4453477
updates to service categories tenancy and tests
mattjackson220 Jul 30, 2020
5a53930
update documentation and fix formatting issues
jehunte Aug 4, 2020
5116059
Remove extraneous ID property of Service Categories
ocket8888 Aug 4, 2020
2446377
Fix compilation errors
ocket8888 Aug 4, 2020
a51c4f4
Fixed bad SQL
ocket8888 Aug 4, 2020
5dc4844
Fixed TP routing to account for name-based identification
ocket8888 Aug 4, 2020
ef7ae2e
Fix 'Generic CRUDer' not allowing non-int keys
ocket8888 Aug 4, 2020
5f4de83
Fix servicecategories not returning its name on update
ocket8888 Aug 4, 2020
c97fbd3
Fix being able to change readonly field
ocket8888 Aug 4, 2020
094c8d5
Fix some bad URL construction
ocket8888 Aug 4, 2020
40452f4
Fixed incorrect json tag in DS struct
ocket8888 Aug 4, 2020
4a39e9f
Fix missing ds table rows
ocket8888 Aug 4, 2020
10fbffd
fix missing struct tag
ocket8888 Aug 5, 2020
0355b05
Fix api test compilation and db cleaning errors
ocket8888 Aug 5, 2020
28ea5de
update sc html in delivery service and revert route ids for 2.0 deliv…
jehunte Aug 5, 2020
c074002
rename db migration file
jehunte Aug 10, 2020
fdbab8e
Fix generic cruder not properly setting IDs after creation
ocket8888 Aug 7, 2020
adef5dd
Fix servicecategories_test trying to mutate immutable properties
ocket8888 Aug 7, 2020
c1a43bb
make service category unselectable
jehunte Aug 10, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 41 additions & 33 deletions docs/source/api/v3/deliveryservices.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,39 +31,41 @@ Request Structure
-----------------
.. table:: Request Query Parameters

+--------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------+
| Name | Required | Description |
+==============+==========+=========================================================================================================================================+
| cdn | no | Show only the :term:`Delivery Services` belonging to the :ref:`ds-cdn` identified by this integral, unique identifier |
+--------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------+
| id | no | Show only the :term:`Delivery Service` that has this integral, unique identifier |
+--------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------+
| logsEnabled | no | Show only the :term:`Delivery Services` that have :ref:`ds-logs-enabled` set or not based on this boolean |
+--------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------+
| profile | no | Return only :term:`Delivery Services` using the :term:`Profile` that has this :ref:`profile-id` |
+--------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------+
| tenant | no | Show only the :term:`Delivery Services` belonging to the :term:`Tenant` identified by this integral, unique identifier |
+--------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------+
| topology | no | Show only the :term:`Delivery Services` assigned to the :term:`Topology` identified by this unique name |
+--------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------+
| type | no | Return only :term:`Delivery Services` of the :term:`Delivery Service` :ref:`ds-types` identified by this integral, unique identifier |
+--------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------+
| accessibleTo | no | Return the :term:`Delivery Services` accessible from a :term:`Tenant` *or it's children* identified by this integral, unique identifier |
+--------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------+
| xmlId | no | Show only the :term:`Delivery Service` that has 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``. |
+--------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------+
+-------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------+
| Name | Required | Description |
+===================+==========+=========================================================================================================================================+
| cdn | no | Show only the :term:`Delivery Services` belonging to the :ref:`ds-cdn` identified by this integral, unique identifier |
+-------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------+
| id | no | Show only the :term:`Delivery Service` that has this integral, unique identifier |
+-------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------+
| logsEnabled | no | Show only the :term:`Delivery Services` that have :ref:`ds-logs-enabled` set or not based on this boolean |
+-------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------+
| profile | no | Return only :term:`Delivery Services` using the :term:`Profile` that has this :ref:`profile-id` |
+-------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------+
| tenant | no | Show only the :term:`Delivery Services` belonging to the :term:`Tenant` identified by this integral, unique identifier |
+-------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------+
| topology | no | Show only the :term:`Delivery Services` assigned to the :term:`Topology` identified by this unique name |
+-------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------+
| type | no | Return only :term:`Delivery Services` of the :term:`Delivery Service` :ref:`ds-types` identified by this integral, unique identifier |
+-------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------+
| accessibleTo | no | Return the :term:`Delivery Services` accessible from a :term:`Tenant` *or it's children* identified by this integral, unique identifier |
+-------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------+
| serviceCategory | no | Show only the :term:`Delivery Services` belonging to the :term:`Service Category` that has this name |
+-------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------+
| xmlId | no | Show only the :term:`Delivery Service` that has 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
------------------
Expand Down Expand Up @@ -133,6 +135,7 @@ Response Structure
: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`
:serviceCategory: The name of the :ref:`ds-service-category` with which the :term:`Delivery Service` is associated
: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`
:rangeSliceBlockSize: An integer that defines the byte block size for the ATS Slice Plugin. It can only and must be set if ``rangeRequestHandling`` is set to 3.
Expand Down Expand Up @@ -245,6 +248,7 @@ Response Structure
"ecsEnabled": false,
"rangeSliceBlockSize": null,
"topology": null
"serviceCategory": null
}]}


Expand Down Expand Up @@ -312,6 +316,7 @@ Request Structure
: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`
:serviceCategory: The name of the :ref:`ds-service-category` with which the :term:`Delivery Service` is associated - or ``null`` if there is to be no such category
: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`
:rangeSliceBlockSize: An integer that defines the byte block size for the ATS Slice Plugin. It can only and must be set if ``rangeRequestHandling`` is set to 3. It can only be between (inclusive) 262144 (256KB) - 33554432 (32MB).
Expand Down Expand Up @@ -359,6 +364,7 @@ Request Structure
"rangeRequestHandling": 0,
"regionalGeoBlocking": false,
"routingName": "test",
"serviceCategory": null,
"signed": false,
"tenant": "root",
"tenantId": 1,
Expand Down Expand Up @@ -435,6 +441,7 @@ Response Structure
: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`
:serviceCategory: The name of the :ref:`ds-service-category` with which the :term:`Delivery Service` is associated
: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`
:rangeSliceBlockSize: An integer that defines the byte block size for the ATS Slice Plugin. It can only and must be set if ``rangeRequestHandling`` is set to 3.
Expand Down Expand Up @@ -528,6 +535,7 @@ Response Structure
"regionalGeoBlocking": false,
"remapText": null,
"routingName": "test",
"serviceCategory": null,
"signed": false,
"sslKeyVersion": null,
"tenantId": 1,
Expand Down
Loading