[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #4018: Add deliveryservice server capability docs
ocket commented on a change in pull request #4018: Add deliveryservice server capability docs URL: https://github.com/apache/trafficcontrol/pull/4018#discussion_r338591745 ## File path: docs/source/api/deliveryservice_server_capabilities.rst ## @@ -0,0 +1,222 @@ +.. +.. +.. Licensed under the Apache License, Version 2.0 (the "License"); +.. you may not use this file except in compliance with the License. +.. You may obtain a copy of the License at +.. +.. http://www.apache.org/licenses/LICENSE-2.0 +.. +.. Unless required by applicable law or agreed to in writing, software +.. distributed under the License is distributed on an "AS IS" BASIS, +.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +.. See the License for the specific language governing permissions and +.. limitations under the License. +.. + +.. _to-api-deliveryservice-server-capabilities: + +*** +``deliveryservice_server_capabilities`` +*** + +.. versionadded:: 1.4 + +``GET`` +=== +Gets all associations of Server Capabilities to :term:`Delivery Services` + +:Auth. Required: Yes +:Roles Required: None +:Response Type: Array + +Request Structure +- +.. table:: Request Query Parameters + + +---+--+---+ + | Name | Required | Description | + +===+==+===+ + | deliveryServiceID | no | Filter associated Server Capabilities by :term:`Delivery Service` ID | + +---+--+---+ + | xmlID | no | Filter associated Server Capabilities by :term:`Delivery Service` :ref:`ds-xmlid` | + +---+--+---+ + | serverCapability | no | Filter associated Server Capabilities by Server Capability| + +---+--+---+ + | 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``. | + +---+--+---+ + +.. code-block:: http + :caption: Request Example + + GET /api/1.4/deliveryservice_server_capabilities HTTP/1.1 + Host: trafficops.infra.ciab.test + User-Agent: curl/7.47.0 + Accept: */* + Cookie: mojolicious=... + +Response Structure +--
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #4018: Add deliveryservice server capability docs
ocket commented on a change in pull request #4018: Add deliveryservice server capability docs URL: https://github.com/apache/trafficcontrol/pull/4018#discussion_r338580839 ## File path: docs/source/api/deliveryservice_server_capabilities.rst ## @@ -0,0 +1,222 @@ +.. +.. +.. Licensed under the Apache License, Version 2.0 (the "License"); +.. you may not use this file except in compliance with the License. +.. You may obtain a copy of the License at +.. +.. http://www.apache.org/licenses/LICENSE-2.0 +.. +.. Unless required by applicable law or agreed to in writing, software +.. distributed under the License is distributed on an "AS IS" BASIS, +.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +.. See the License for the specific language governing permissions and +.. limitations under the License. +.. + +.. _to-api-deliveryservice-server-capabilities: + +*** +``deliveryservice_server_capabilities`` +*** + +.. versionadded:: 1.4 + +``GET`` +=== +Gets all associations of Server Capabilities to :term:`Delivery Services` + +:Auth. Required: Yes +:Roles Required: None +:Response Type: Array + +Request Structure +- +.. table:: Request Query Parameters + + +---+--+---+ + | Name | Required | Description | + +===+==+===+ + | deliveryServiceID | no | Filter associated Server Capabilities by :term:`Delivery Service` ID | + +---+--+---+ + | xmlID | no | Filter associated Server Capabilities by :term:`Delivery Service` :ref:`ds-xmlid` | + +---+--+---+ + | serverCapability | no | Filter associated Server Capabilities by Server Capability| + +---+--+---+ + | 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``. | + +---+--+---+ + +.. code-block:: http + :caption: Request Example + + GET /api/1.4/deliveryservice_server_capabilities HTTP/1.1 + Host: trafficops.infra.ciab.test + User-Agent: curl/7.47.0 + Accept: */* + Cookie: mojolicious=... + +Response Structure +--
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #4018: Add deliveryservice server capability docs
ocket commented on a change in pull request #4018: Add deliveryservice server capability docs URL: https://github.com/apache/trafficcontrol/pull/4018#discussion_r338580211 ## File path: docs/source/api/deliveryservice_server_capabilities.rst ## @@ -0,0 +1,222 @@ +.. +.. +.. Licensed under the Apache License, Version 2.0 (the "License"); +.. you may not use this file except in compliance with the License. +.. You may obtain a copy of the License at +.. +.. http://www.apache.org/licenses/LICENSE-2.0 +.. +.. Unless required by applicable law or agreed to in writing, software +.. distributed under the License is distributed on an "AS IS" BASIS, +.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +.. See the License for the specific language governing permissions and +.. limitations under the License. +.. + +.. _to-api-deliveryservice-server-capabilities: + +*** +``deliveryservice_server_capabilities`` +*** + +.. versionadded:: 1.4 + +``GET`` +=== +Gets all associations of Server Capabilities to :term:`Delivery Services` + +:Auth. Required: Yes +:Roles Required: None +:Response Type: Array + +Request Structure +- +.. table:: Request Query Parameters + + +---+--+---+ + | Name | Required | Description | + +===+==+===+ + | deliveryServiceID | no | Filter associated Server Capabilities by :term:`Delivery Service` ID | + +---+--+---+ + | xmlID | no | Filter associated Server Capabilities by :term:`Delivery Service` :ref:`ds-xmlid` | + +---+--+---+ + | serverCapability | no | Filter associated Server Capabilities by Server Capability| + +---+--+---+ + | 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``. | + +---+--+---+ + +.. code-block:: http + :caption: Request Example + + GET /api/1.4/deliveryservice_server_capabilities HTTP/1.1 + Host: trafficops.infra.ciab.test + User-Agent: curl/7.47.0 + Accept: */* + Cookie: mojolicious=... + +Response Structure +--
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #4018: Add deliveryservice server capability docs
ocket commented on a change in pull request #4018: Add deliveryservice server capability docs URL: https://github.com/apache/trafficcontrol/pull/4018#discussion_r338303676 ## File path: docs/source/api/deliveryservice_server_capabilities.rst ## @@ -0,0 +1,222 @@ +.. +.. +.. Licensed under the Apache License, Version 2.0 (the "License"); +.. you may not use this file except in compliance with the License. +.. You may obtain a copy of the License at +.. +.. http://www.apache.org/licenses/LICENSE-2.0 +.. +.. Unless required by applicable law or agreed to in writing, software +.. distributed under the License is distributed on an "AS IS" BASIS, +.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +.. See the License for the specific language governing permissions and +.. limitations under the License. +.. + +.. _to-api-deliveryservice-server-capabilities: + +*** +``deliveryservice_server_capabilities`` +*** + +.. versionadded:: 1.4 + +``GET`` +=== +Gets all associations of Server Capabilities to :term:`Delivery Services` + +:Auth. Required: Yes +:Roles Required: None +:Response Type: Array + +Request Structure +- +.. table:: Request Query Parameters + + +---+--+---+ + | Name | Required | Description | + +===+==+===+ + | deliveryServiceID | no | Filter associated Server Capabilities by :term:`Delivery Service` ID | + +---+--+---+ + | xmlID | no | Filter associated Server Capabilities by :term:`Delivery Service` :ref:`ds-xmlid` | + +---+--+---+ + | serverCapability | no | Filter associated Server Capabilities by Server Capability| + +---+--+---+ + | 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``. | + +---+--+---+ + +.. code-block:: http + :caption: Request Example + + GET /api/1.4/deliveryservice_server_capabilities HTTP/1.1 + Host: trafficops.infra.ciab.test + User-Agent: curl/7.47.0 + Accept: */* + Cookie: mojolicious=... + +Response Structure +--
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #4018: Add deliveryservice server capability docs
ocket commented on a change in pull request #4018: Add deliveryservice server capability docs URL: https://github.com/apache/trafficcontrol/pull/4018#discussion_r338288856 ## File path: docs/source/api/deliveryservice_server_capabilities.rst ## @@ -0,0 +1,222 @@ +.. +.. +.. Licensed under the Apache License, Version 2.0 (the "License"); +.. you may not use this file except in compliance with the License. +.. You may obtain a copy of the License at +.. +.. http://www.apache.org/licenses/LICENSE-2.0 +.. +.. Unless required by applicable law or agreed to in writing, software +.. distributed under the License is distributed on an "AS IS" BASIS, +.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +.. See the License for the specific language governing permissions and +.. limitations under the License. +.. + +.. _to-api-deliveryservice-server-capabilities: + +*** +``deliveryservice_server_capabilities`` +*** + +.. versionadded:: 1.4 + +``GET`` +=== +Gets all associations of Server Capabilities to Delivery Services + +:Auth. Required: Yes +:Roles Required: None +:Response Type: Array + +Request Structure +- +.. table:: Request Query Parameters + + +---+--+---+ + | Name | Required | Description | + +===+==+===+ + | deliveryServiceID | no | Filter associated Server Capabilities by Delivery Service ID | + +---+--+---+ + | xmlID | no | Filter associated Server Capabilities by Delivery Service xml ID | + +---+--+---+ + | serverCapability | no | Filter associated Server Capabilities by Server Capability| + +---+--+---+ + | 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``. | + +---+--+---+ + +.. code-block:: http + :caption: Request Example + + GET /api/1.4/deliveryservice_server_capabilities HTTP/1.1 + Host: trafficops.infra.ciab.test + User-Agent: curl/7.47.0 + Accept: */* + Cookie: mojolicious=... + +Response Structure +--
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #4018: Add deliveryservice server capability docs
ocket commented on a change in pull request #4018: Add deliveryservice server capability docs URL: https://github.com/apache/trafficcontrol/pull/4018#discussion_r338288655 ## File path: .gitignore ## @@ -11,6 +11,7 @@ traffic_ops/app/public/CRConfig-Snapshots/* traffic_ops/app/public/Trafficserver-Snapshots/* docs/.todo_cache docs/_build/ +docs/source/_build/ Review comment: Well it's one thing to support specific IDEs and/or text editors - and we do have things like` .vscode/` in that `.gitignore`, but idk about supporting all the plugins people like to use for each. We already have a `docs/source/_ext` directory that's actually used, so it's possible we could want something for a similar purpose dealing with the build to be named that. But all that said, I won't block the PR on this. This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #4018: Add deliveryservice server capability docs
ocket commented on a change in pull request #4018: Add deliveryservice server capability docs URL: https://github.com/apache/trafficcontrol/pull/4018#discussion_r338230415 ## File path: .gitignore ## @@ -11,6 +11,7 @@ traffic_ops/app/public/CRConfig-Snapshots/* traffic_ops/app/public/Trafficserver-Snapshots/* docs/.todo_cache docs/_build/ +docs/source/_build/ Review comment: Well then personally I think you should take this out, because it's not a part of our build system. This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #4018: Add deliveryservice server capability docs
ocket commented on a change in pull request #4018: Add deliveryservice server capability docs URL: https://github.com/apache/trafficcontrol/pull/4018#discussion_r338208151 ## File path: .gitignore ## @@ -11,6 +11,7 @@ traffic_ops/app/public/CRConfig-Snapshots/* traffic_ops/app/public/Trafficserver-Snapshots/* docs/.todo_cache docs/_build/ +docs/source/_build/ Review comment: Why was this necessary? This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #4018: Add deliveryservice server capability docs
ocket commented on a change in pull request #4018: Add deliveryservice server capability docs URL: https://github.com/apache/trafficcontrol/pull/4018#discussion_r338209082 ## File path: docs/source/api/deliveryservice_server_capabilities.rst ## @@ -0,0 +1,222 @@ +.. +.. +.. Licensed under the Apache License, Version 2.0 (the "License"); +.. you may not use this file except in compliance with the License. +.. You may obtain a copy of the License at +.. +.. http://www.apache.org/licenses/LICENSE-2.0 +.. +.. Unless required by applicable law or agreed to in writing, software +.. distributed under the License is distributed on an "AS IS" BASIS, +.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +.. See the License for the specific language governing permissions and +.. limitations under the License. +.. + +.. _to-api-deliveryservice-server-capabilities: + +*** +``deliveryservice_server_capabilities`` +*** + +.. versionadded:: 1.4 + +``GET`` +=== +Gets all associations of Server Capabilities to Delivery Services + +:Auth. Required: Yes +:Roles Required: None +:Response Type: Array + +Request Structure +- +.. table:: Request Query Parameters + + +---+--+---+ + | Name | Required | Description | + +===+==+===+ + | deliveryServiceID | no | Filter associated Server Capabilities by Delivery Service ID | + +---+--+---+ + | xmlID | no | Filter associated Server Capabilities by Delivery Service xml ID | + +---+--+---+ + | serverCapability | no | Filter associated Server Capabilities by Server Capability| + +---+--+---+ + | 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``. | + +---+--+---+ + +.. code-block:: http + :caption: Request Example + + GET /api/1.4/deliveryservice_server_capabilities HTTP/1.1 + Host: trafficops.infra.ciab.test + User-Agent: curl/7.47.0 + Accept: */* + Cookie: mojolicious=... + +Response Structure +--
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #4018: Add deliveryservice server capability docs
ocket commented on a change in pull request #4018: Add deliveryservice server capability docs URL: https://github.com/apache/trafficcontrol/pull/4018#discussion_r338209592 ## File path: docs/source/api/deliveryservice_server_capabilities.rst ## @@ -0,0 +1,222 @@ +.. +.. +.. Licensed under the Apache License, Version 2.0 (the "License"); +.. you may not use this file except in compliance with the License. +.. You may obtain a copy of the License at +.. +.. http://www.apache.org/licenses/LICENSE-2.0 +.. +.. Unless required by applicable law or agreed to in writing, software +.. distributed under the License is distributed on an "AS IS" BASIS, +.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +.. See the License for the specific language governing permissions and +.. limitations under the License. +.. + +.. _to-api-deliveryservice-server-capabilities: + +*** +``deliveryservice_server_capabilities`` +*** + +.. versionadded:: 1.4 + +``GET`` +=== +Gets all associations of Server Capabilities to Delivery Services Review comment: "Delivery Services" is a `term`, and needs to be linked to the glossary at the very least the first time it appears within a major section ("page" in an HTML context). Though, ideally, it'd be linked everywhere. This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #4018: Add deliveryservice server capability docs
ocket commented on a change in pull request #4018: Add deliveryservice server capability docs URL: https://github.com/apache/trafficcontrol/pull/4018#discussion_r338210487 ## File path: docs/source/api/server_server_capabilities.rst ## @@ -222,4 +222,4 @@ Response Structure "level": "success" } ] - } \ No newline at end of file + } Review comment: I can't quite figure out what was changed on this line - the file does have a terminating newline doesn't it? It appears to, but otherwise idk what changed. This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #4018: Add deliveryservice server capability docs
ocket commented on a change in pull request #4018: Add deliveryservice server capability docs URL: https://github.com/apache/trafficcontrol/pull/4018#discussion_r338208580 ## File path: docs/source/api/deliveryservice_server_capabilities.rst ## @@ -0,0 +1,222 @@ +.. +.. +.. Licensed under the Apache License, Version 2.0 (the "License"); +.. you may not use this file except in compliance with the License. +.. You may obtain a copy of the License at +.. +.. http://www.apache.org/licenses/LICENSE-2.0 +.. +.. Unless required by applicable law or agreed to in writing, software +.. distributed under the License is distributed on an "AS IS" BASIS, +.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +.. See the License for the specific language governing permissions and +.. limitations under the License. +.. + +.. _to-api-deliveryservice-server-capabilities: + +*** +``deliveryservice_server_capabilities`` +*** + +.. versionadded:: 1.4 + +``GET`` +=== +Gets all associations of Server Capabilities to Delivery Services + +:Auth. Required: Yes +:Roles Required: None +:Response Type: Array + +Request Structure +- +.. table:: Request Query Parameters + + +---+--+---+ + | Name | Required | Description | + +===+==+===+ + | deliveryServiceID | no | Filter associated Server Capabilities by Delivery Service ID | + +---+--+---+ + | xmlID | no | Filter associated Server Capabilities by Delivery Service xml ID | + +---+--+---+ + | serverCapability | no | Filter associated Server Capabilities by Server Capability| + +---+--+---+ + | 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``. | + +---+--+---+ + +.. code-block:: http + :caption: Request Example + + GET /api/1.4/deliveryservice_server_capabilities HTTP/1.1 + Host: trafficops.infra.ciab.test + User-Agent: curl/7.47.0 + Accept: */* + Cookie: mojolicious=... + +Response Structure +--