Updated docs

linlin2018 · Jun 2, 2019 · d9a01b1 · d9a01b1
1 parent 56add90
commit d9a01b1
Show file tree

Hide file tree

Showing 3 changed files with 84 additions and 20 deletions.
diff --git a/docs/api/System/info.md b/docs/api/System/info.md
@@ -29,22 +29,47 @@ GET /api/v1beta1/system/info
 }
 
 HTTP/1.1 200 OK
-{
-  "status": "200",
-  "message": "Successful request",
-  "result" : {
-  	"apiVersion": "v1beta1",
-  	"kind": "Peer",
-  	"metadata": {
-  		"name": "Asterisk PBX",
-      "ref": "pr2c77f4"
-  	},
-  	"spec": {
-  		"credentials": {
-  			"username": "ast",
-  			"secret": "1234"
-  		}
-  	}
-  }
+{  
+   "version":"v1.0",
+   "apiVersion":"v1beta1",
+   "apiPath":"/api/v1beta1",
+   "env":[  
+      {  
+         "var":"ROUTR_JAVA_OPTS",
+         "value":null
+      },
+      {  
+         "var":"ROUTR_DS_PROVIDER",
+         "value":null
+      },
+      {  
+         "var":"ROUTR_DS_PARAMETERS",
+         "value":null
+      },
+      {  
+         "var":"ROUTR_CONFIG_PATH",
+         "value":null
+      },
+      {  
+         "var":"ROUTR_SALT",
+         "value":null
+      },
+      {  
+         "var":"ROUTR_EXTERN_ADDR",
+         "value":null
+      },
+      {  
+         "var":"ROUTR_LOCALNETS",
+         "value":null
+      },
+      {  
+         "var":"ROUTR_REGISTRAR_INTF",
+         "value":null
+      },
+      {  
+         "var":"ROUTR_JS_ENGINE",
+         "value":null
+      }
+   ]
 }
 ```
diff --git a/docs/api/System/status.md b/docs/api/System/status.md
@@ -0,0 +1,38 @@
+This method returns information about the server.
+
+**URL**
+
+`/system/status/{status}`
+
+**Method**
+
+`POST`
+
+**Parameters**
+
+| Parameter Name | Type   | Value | Description
+| ---  | :--------- |  :--------- |  :--------- |
+| status |  path | string | This accepts either `down` or `reload` parameters |
+
+Note: A `down` value causes the server to shutdown. A `reload` value causes
+the server to reload its configuration from file.
+
+**Request body**
+
+Do not supply a request body with this method.
+
+**Response**
+
+If successful this method causes the server to change its status.
+
+**Sample Call**
+
+```json
+GET /api/v1beta1/system/status/reload
+{
+
+}
+
+HTTP/1.1 200 OK
+{"status": "200", "message": "Reloaded configuration from file."}
+```
diff --git a/docs/api/overview.md b/docs/api/overview.md
@@ -7,9 +7,10 @@ The endpoint for the API is:
 ## Authentication
 
 Routr's API is authenticated with a JWT token. To obtain the token use the
-`/api/{apiversion}/credentials` endpoint with basic authentication present
-in the [User](/configuration/user) resource. You must them append the `token`
-as a query parameter.
+`/api/{apiversion}/credentials` endpoint with basic authentication. Use the information
+from the [User](/configuration/user) resource.
+
+> You must append the `token` to all requests as a query parameter.
 
 **Sample call**