[jira] [Created] (TC-408) Documentation for creating ssl keys is missing a field.

["Joseph Pappano (JIRA)" <ji...@apache.org>]

Joseph Pappano created TC-408:
---------------------------------

             Summary: Documentation for creating ssl keys is missing a field.
                 Key: TC-408
                 URL: https://issues.apache.org/jira/browse/TC-408
             Project: Traffic Control
          Issue Type: Bug
          Components: Documentation
            Reporter: Joseph Pappano
            Priority: Minor


The documentation to generate ssl keys is missing the delivery service field. generating keys with that field being null will cause issues on Riak.

{code}
POST /api/1.2/deliveryservices/sslkeys/generate

Generates SSL crt, csr, and private key for a delivery service

Authentication Required: Yes

Role(s) Required: Admin

Request Properties

Parameter	Type	Description
key	string	xml_id of the delivery service
version	string	version of the keys being generated
hostname	string	the pristine hostname of the delivery service
country	string	 
state	string	 
city	string	 
org	string	 
unit	boolean	 
Request Example

{
  "key": "ds-01",
  "businessUnit": "CDN Engineering",
  "version": "3",
  "hostname": "tr.ds-01.ott.kabletown.com",
  "certificate": {
    "key": "some_key",
    "csr": "some_csr",
    "crt": "some_crt"
  },
  "country": "US",
  "organization": "Kabletown",
  "city": "Denver",
  "state": "Colorado"
}{code}


These are the fields required. Notice the delivery service is null. 
{code}
{
    "cdn": null,
    "certificate": {
        "crt": 
        "csr":         "key":     },
    "city": "Denver",
    "country": "US",
    "deliveryservice": null,
    "hostname": "*.linear-chi-pil-red.xcr.comcast.net",
    "key": "linear-chi-pil-red",
    "org": null,
    "state": "Colorado",
    "unit": "IPCDN",
    "version": "1"
}{code}



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)