docs(api/v2.3): add TLS API examples and index v2.3 API

deis · Jan 27, 2017 · cccde15 · cccde15
1 parent f578585
commit cccde15
Show file tree

Hide file tree

Showing 2 changed files with 62 additions and 0 deletions.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -90,6 +90,7 @@ pages:
     - Controller API v2.0: reference-guide/controller-api/v2.0.md
     - Controller API v2.1: reference-guide/controller-api/v2.1.md
     - Controller API v2.2: reference-guide/controller-api/v2.2.md
+    - Controller API v2.3: reference-guide/controller-api/v2.3.md
   - Changelogs:
     - v2.0.0: changelogs/v2.0.0.md
     - v2.1.0: changelogs/v2.1.0.md

diff --git a/src/reference-guide/controller-api/v2.3.md b/src/reference-guide/controller-api/v2.3.md
@@ -576,6 +576,67 @@ DEIS_API_VERSION: 2.3
 DEIS_PLATFORM_VERSION: 2.3.0
 ```
 
+### Enable or disable TLS
+
+Example Request:
+
+```
+POST /v2/apps/example-go/tls/ HTTP/1.1
+Host: deis.example.com
+Content-Type: application/json
+Authorization: token abc123
+
+{
+  "https_enforced": true
+}
+```
+
+Example Response:
+
+```
+HTTP/1.1 201 CREATED
+DEIS_API_VERSION: 2.3
+DEIS_PLATFORM_VERSION: 2.3.0
+Content-Type: application/json
+
+{
+    "created": "2014-01-01T00:00:00UTC",
+    "app": "example-go",
+    "owner": "test",
+    "https_enforced": true,
+    "updated": "2014-01-01T00:00:00UTC",
+    "uuid": "de1bf5b5-4a72-4f94-a10c-d2a3741cdf75"
+}
+```
+
+### Get TLS status
+
+Example Request:
+
+```
+GET /v2/apps/example-go/tls/ HTTP/1.1
+Host: deis.example.com
+Authorization: token abc123
+```
+
+Example Response:
+
+```
+HTTP/1.1 200 OK
+DEIS_API_VERSION: 2.3
+DEIS_PLATFORM_VERSION: 2.3.0
+Content-Type: application/json
+
+{
+    "created": "2014-01-01T00:00:00UTC",
+    "app": "example-go",
+    "owner": "test",
+    "https_enforced": false,
+    "updated": "2014-01-01T00:00:00UTC",
+    "uuid": "de1bf5b5-4a72-4f94-a10c-d2a3741cdf75"
+}
+```
+
 ## Pods
 
 ### List all Pods