[GitHub] mitchell852 closed pull request #3032: Add Docs, changelog for 1.4 dnssec refresh

[GitBox <gi...@apache.org>]

mitchell852 closed pull request #3032: Add Docs, changelog for 1.4 dnssec refresh
URL: https://github.com/apache/trafficcontrol/pull/3032
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 12bfcbe82..70c9348d4 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -5,14 +5,16 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 
 ## [Unreleased]
 ### Added
-- Traffic Ops Golang Proxy Endpoints
+- Traffic Ops Golang Endpoints
   - /api/1.4/users `(GET,POST,PUT)`
   - /api/1.1/deliveryservices/xmlId/:xmlid/sslkeys `GET`
   - /api/1.1/deliveryservices/hostname/:hostname/sslkeys `GET`
   - /api/1.1/deliveryservices/sslkeys/add `POST`
   - /api/1.1/deliveryservices/xmlId/:xmlid/sslkeys/delete `GET`
+  - /api/1.4/cdns/dnsseckeys/refresh `GET`
 - To support reusing a single riak cluster connection, an optional parameter is added to riak.conf: "HealthCheckInterval". This options takes a 'Duration' value (ie: 10s, 5m) which affects how often the riak cluster is health checked.  Default is currently set to: "HealthCheckInterval": "5s".
-  
+- Added an API 1.4 endpoint, /api/1.4/cdns/dnsseckeys/refresh, to perform necessary behavior previously served outside the API under `/internal`.
+
 ### Changed
 - Issue 2821: Fixed "Traffic Router may choose wrong certificate when SNI names overlap"
 - traffic_ops/app/bin/checks/ToDnssecRefresh.pl now requires "user" and "pass" parameters of an operations-level user! Update your scripts accordingly! This was necessary to move to an API endpoint with proper authentication, which may be safely exposed.
diff --git a/docs/source/api/v14/cdn.rst b/docs/source/api/v14/cdn.rst
index b83a7f31e..7884420be 100644
--- a/docs/source/api/v14/cdn.rst
+++ b/docs/source/api/v14/cdn.rst
@@ -64,3 +64,31 @@ CDN
 
 |
 
+**GET /api/1.4/cdns/dnsseckeys/refresh**
+
+  Refresh the DNSSEC keys for all CDNs. This call initiates a background process to refresh outdated keys, and immediately returns a response that the process has started.
+
+  Authentication Required: Yes
+
+  Role(s) Required: Admin
+
+  **Request Route Parameters**
+
+  None.
+
+  **Response Properties**
+
+  +--------------+--------+------------------+
+  |  Parameter   |  Type  |   Description    |
+  +==============+========+==================+
+  | ``response`` | string | success response |
+  +--------------+--------+------------------+
+
+  **Response Example**
+  ::
+
+    {
+      "response": "Checking DNSSEC keys for refresh in the background"
+    }
+
+|


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on 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