Merge pull request #156 from Nike-Inc/documentation-cleanup

Clean Up Documentation

.gitignore

@@ -196,10 +196,8 @@ npm-debug.log
 package-lock.json
 /dashboard/reports
 /dashboard/logs
-/dashboard/vault
 /dashboard/*.tar.gz
 
 # embedded mysql stuff
 /target/
 /.proxy-dash.pid.lock
-/.vault-sql.pid.lock

API.md

@@ -750,7 +750,7 @@ Calling GET on a virtual path without the list=true parameter will return 404.
               "errors": [
                 {
                   "code": 99105,
-                  "message": "X-Vault-Token or X-Cerberus-Token header is malformed or invalid."
+                  "message": "X-Cerberus-Token header is malformed or invalid."
                 }
               ]
             }
@@ -809,7 +809,7 @@ Gets a specific version of a secret from the change history stored in Cerberus
               "errors": [
                 {
                   "code": 99105,
-                  "message": "X-Vault-Token or X-Cerberus-Token header is malformed or invalid."
+                  "message": "X-Cerberus-Token header is malformed or invalid."
                 }
               ]
             }
@@ -860,7 +860,7 @@ Gets a specific version of a secret from the change history stored in Cerberus
               "errors": [
                 {
                   "code": 99105,
-                  "message": "X-Vault-Token or X-Cerberus-Token header is malformed or invalid."
+                  "message": "X-Cerberus-Token header is malformed or invalid."
                 }
               ]
             }
@@ -906,7 +906,7 @@ Gets a specific version of a secret from the change history stored in Cerberus
               "errors": [
                 {
                   "code": 99105,
-                  "message": "X-Vault-Token or X-Cerberus-Token header is malformed or invalid."
+                  "message": "X-Cerberus-Token header is malformed or invalid."
                 }
               ]
             }
@@ -989,7 +989,46 @@ Gets a specific version of a secret from the change history stored in Cerberus
               "errors": [
                 {
                   "code": 99105,
-                  "message": "X-Vault-Token or X-Cerberus-Token header is malformed or invalid."
+                  "message": "X-Cerberus-Token header is malformed or invalid."
+                }
+              ]
+            }
+
++ Response 404 (application/json)
+
+    + Body
+
+            {
+              "error_id": "6b13cdaa-ce64-473d-9228-5cf9bf0e51a9",
+              "errors": [
+                {
+                  "code": 99996,
+                  "message": "Not found"
+                }
+              ]
+            }
+
+### Delete secure file at a path [DELETE]
+
++ Request
+
+    + Headers
+
+            X-Cerberus-Token: AaAAAaaaAAAabCdEF0JkLMNZ01iGabcdefGHIJKLtClQabcCVabEYab1aDaZZz12a
+            X-Cerberus-Client: MyClientName/1.0.0
+
++ Response 204
+
++ Response 401 (application/json)
+
+    + Body
+
+            {
+              "error_id": "9c4dc9de-2ce2-4b55-9bda-dbd8e2397879",
+              "errors": [
+                {
+                  "code": 99105,
+                  "message": "X-Cerberus-Token header is malformed or invalid."
                 }
               ]
             }

README.md

@@ -5,15 +5,15 @@
 [![][license img]][license]
 
 The Cerberus Management Service (CMS) is a core component of the Cerberus [REST API](http://engineering.nike.com/cerberus/docs/architecture/rest-api)
-that facilities user and AWS IAM role authentication and the management of Safe Deposit Boxes (SDBs), an abstraction on top of Hashicorp's Vault.
+that facilities user and AWS IAM role authentication and the management of Safe Deposit Boxes (SDBs), containers for secrets.
 
 To learn more about Cerberus, please visit the [Cerberus website](http://engineering.nike.com/cerberus/).
 
 ## Getting Started
 
 ### Running with persistent data,
 
-If you wish to persist data permanently you can install Vault and MySQL locally
+If you wish to persist data permanently you can install MySQL locally
 
 **MySQL** is required to run the application locally.
 
@@ -265,14 +265,6 @@ Using local instance of MySQL server:
 
 Above should work on Windows, Mac, and Linux.
 
-### From the CLI
-
-With Vault and MySQL running
-
-    ./gradlew clean build
-
-    ./debugShadowJar.sh -Dvault.addr=http://localhost:8200 -Dvault.token=<token>
-
 
 ## Setting up your IDE