Merge pull request #1859 from HubSpot/0_21_release_docs

0.21.0 release docs

Author: ssalinas

Docs/about/requests-and-deploys.md

@@ -11,7 +11,7 @@ To illustrate the differences between and usages of these two concepts, we will
 ## The `TestService` Example
 
 ### Creating a `Request`
-You have a new web service called `TestService` that you want to run via Singularity. The first thing you need to do is create a `Request` for `TestService`. To create this request, you would `POST` json over http to the Singularity API ([`/api/requests`](../reference/apidocs/api-requests.md#post-apirequests)) or create a request via the new request page in the Singularity UI. Example json:
+You have a new web service called `TestService` that you want to run via Singularity. The first thing you need to do is create a `Request` for `TestService`. To create this request, you would `POST` json over http to the Singularity API ([`/api/requests`](../reference/api.html)) or create a request via the new request page in the Singularity UI. Example json:
 
 ```json
 {
@@ -26,7 +26,7 @@ This `Request` now holds high level information about your web service. Singular
 
 ### Creating a `Deploy`
 
-Now you want `TestService` to actually run. To do this, you need to create a `Deploy` for the `TestService` `Request`. This deploy will let Singularity know all of the information necessary to actually build and launch a task. This information includes things like the command to run, environment variables to set, the location of any artifacts to download, or the resources that should be allocated to a task. You would create this deploy by `POST`ing json to the Singularity API's deploy endpoint ([`/api/deploys`](../reference/apidocs/api-deploys.md#post-apideploys)), or creating a new deploy in the Singularity UI. Example json:
+Now you want `TestService` to actually run. To do this, you need to create a `Deploy` for the `TestService` `Request`. This deploy will let Singularity know all of the information necessary to actually build and launch a task. This information includes things like the command to run, environment variables to set, the location of any artifacts to download, or the resources that should be allocated to a task. You would create this deploy by `POST`ing json to the Singularity API's deploy endpoint ([`/api/deploys`](../reference/api.html)), or creating a new deploy in the Singularity UI. Example json:
 
 ```json
 {
@@ -55,13 +55,13 @@ Posting this to Singularity creates a `PendingDeploy`. Singularity will then try
 
 ### A New `Deploy`
 
-Let's say some changes were made to the `TestService` code and you want to run the new version in Singularity, maybe with a bit more memory as well. You would create a new `Deploy` json with information about the new code to run, and updated memory value and `POST` that to the Singularity API ([`/api/deploys`](../reference/apidocs/api-deploys.md#post-apideploys)), or create a new deploy in the Singularity UI.
+Let's say some changes were made to the `TestService` code and you want to run the new version in Singularity, maybe with a bit more memory as well. You would create a new `Deploy` json with information about the new code to run, and updated memory value and `POST` that to the Singularity API ([`/api/deploys`](../reference/api.html)), or create a new deploy in the Singularity UI.
 
 Singularity sees a new `Deploy` has been started and makes that the `PendingDeploy` for the `TestService` `Request`. Singularity will then try to build and launch `1` new task with the configuration specified in the new `PendingDeploy` (note that the task from the previous `Deploy` is still running and it's settings are unchanged). Once the task is launched and determined to be healthy, that new `Deploy` now becomes the `ActiveDeploy` and the task from the old deploy is shut down.
 
 ### Updating the Request
 
-Now, for example, you notice `TestService` is getting more traffic than expected and you want to run `3` instances instead of just `1`. You can `PUT` a new number of instances over http to the Singularity API ([`/api/requests/request/{requestId}/scale`](../reference/apidocs/api-requests.md#put-apirequestsrequestrequestidscale)), or click `Scale` on the Singularity UI request page and enter a new number of instances to update our number of instances. Example json:
+Now, for example, you notice `TestService` is getting more traffic than expected and you want to run `3` instances instead of just `1`. You can `PUT` a new number of instances over http to the Singularity API ([`/api/requests/request/{requestId}/scale`](../reference/api.html)), or click `Scale` on the Singularity UI request page and enter a new number of instances to update our number of instances. Example json:
 
 ```json
 {

Docs/reference/api.html

@@ -0,0 +1,35 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+    <meta charset="UTF-8">
+    <title>ServiceDesk Service Swagger</title>
+    <link rel="stylesheet" type="text/css" href="https://unpkg.com/swagger-ui-dist@3.19.0/swagger-ui.css">
+</head>
+<body>
+
+<div id="swagger-ui"></div>
+
+<script src="https://unpkg.com/swagger-ui-dist@3.19.0/swagger-ui-standalone-preset.js"></script>
+<script src="https://unpkg.com/swagger-ui-dist@3.19.0/swagger-ui-bundle.js"></script>
+
+<script>
+    window.onload = function() {
+        // Build a system
+        const ui = SwaggerUIBundle({
+            url: "http://getsingularity.com/Docs/reference/openapi.json",
+            dom_id: '#swagger-ui',
+            deepLinking: true,
+            presets: [
+                SwaggerUIBundle.presets.apis,
+                SwaggerUIStandalonePreset
+            ],
+            plugins: [
+                SwaggerUIBundle.plugins.DownloadUrl
+            ],
+            layout: "StandaloneLayout",
+        })
+        window.ui = ui
+    }
+</script>
+</body>
+</html>