You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by el...@apache.org on 2018/10/29 15:36:58 UTC
[trafficcontrol] 02/02: Add docs for cdns/dnsseckeys/ksk/generate
This is an automated email from the ASF dual-hosted git repository.
elsloo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficcontrol.git
commit 2025541bf3a132fc069b9691f66fbfaef2b58559
Author: Robert Butts <ro...@apache.org>
AuthorDate: Thu Oct 4 10:32:25 2018 -0600
Add docs for cdns/dnsseckeys/ksk/generate
---
docs/source/api/index.rst | 1 +
docs/source/api/v14/cdn.rst | 66 +++++++++++++++++++++++++++++++++++++
docs/source/api/{ => v14}/index.rst | 26 +++++++--------
3 files changed, 78 insertions(+), 15 deletions(-)
diff --git a/docs/source/api/index.rst b/docs/source/api/index.rst
index 6cdf32e..9f02e95 100644
--- a/docs/source/api/index.rst
+++ b/docs/source/api/index.rst
@@ -25,4 +25,5 @@ A guide to external RESTful APIs for Traffic Ops
v11/index
v12/index
v13/index
+ v14/index
diff --git a/docs/source/api/v14/cdn.rst b/docs/source/api/v14/cdn.rst
new file mode 100644
index 0000000..ce5491e
--- /dev/null
+++ b/docs/source/api/v14/cdn.rst
@@ -0,0 +1,66 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v14-cdns:
+
+CDN
+==========
+
+.. _to-api-v14-cdns-route:
+
+/api/1.4/cdns
+++++++++++++++++++++
+
+**GET api/1.4/cdns/:name/dnsseckeys/ksk/generate**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +--------------------+----------+----------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +====================+==========+====================================================================================================+
+ | ``expirationDays`` | yes | The number of days until the new generated ksk expires. |
+ +--------------------+----------+----------------------------------------------------------------------------------------------------+
+ | ``effectiveDate`` | no | The time the new generated ksk becomes effective, in RFC3339 format. Defaults to the current time. |
+ +--------------------+----------+----------------------------------------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "expirationDays": 100,
+ "effectiveDate": "2021-01-01T00:00:00.0000000-04:00"
+ }
+
+|
+
+ **Response Properties**
+
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================================+========+==========================================================================+
+ | ``response`` | string | response string |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": Successfully generated ksk dnssec keys for my-cdn-name"
+ }
+
+|
+
diff --git a/docs/source/api/index.rst b/docs/source/api/v14/index.rst
similarity index 77%
copy from docs/source/api/index.rst
copy to docs/source/api/v14/index.rst
index 6cdf32e..a7af22f 100644
--- a/docs/source/api/index.rst
+++ b/docs/source/api/v14/index.rst
@@ -1,28 +1,24 @@
-..
-..
+..
+..
.. 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.
-..
+..
-APIs
-****
-A guide to external RESTful APIs for Traffic Ops
+
+API 1.4 Reference
+*****************
+Traffic Ops API V1.4
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
- traffic_ops_api
- routes
- v11/index
- v12/index
- v13/index
-
+ cdn