Updated docs

linlin2018 · Jun 1, 2019 · 88d1882 · 88d1882
1 parent d463102
commit 88d1882
Show file tree

Hide file tree

Showing 6 changed files with 119 additions and 40 deletions.
diff --git a/docs/api/credentials.md b/docs/api/credentials.md
@@ -0,0 +1,47 @@
+# Credentials
+
+Gets a token for subsequent API calls
+
+**URL**
+
+  `/credentials`
+
+**Method**
+
+  `GET`
+
+**URL Params**
+
+  None
+
+**Data Params**
+
+  None
+
+**Success Response**
+
+| Code | Content|
+| ---  |:------ |
+| 200 OK  | JWT Token |
+
+**Error Response**
+
+| Code | Content   |
+| ---  | :--------- |
+| 401 UNAUTHORIZED | `{ status: "401", message : "You are unauthorized to make this request." }`|
+
+**Sample Call**
+
+```json
+GET /api/{apiversion}/credentials
+{
+
+}
+
+HTTP/1.1 200 OK
+"eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhZG1pbiJ9.O7hC-ta225epRQlJZO44WC-l2cWohKnJ8lkmlOQpw8Z_xYiwJ6-qDUhHeJEZH9DmwIwz_jD77sj1kQUkXHsbOg"
+```
+
+**Notes**
+
+You must send a basic authentication header with this request
diff --git a/docs/api/location.md b/docs/api/location.md
@@ -0,0 +1,37 @@
+# Location
+
+Gets a list of registered devices
+
+**URL**
+
+  `/location`
+
+**Method**
+
+  `GET`
+
+**URL Params**
+
+  None
+
+**Data Params**
+
+  None
+
+**Success Response**
+
+| Code | Content   |
+| ---  |:------    |
+| 200  |  |
+
+**Sample Call**
+
+```json
+GET /api/{apiversion}/location
+{
+
+}
+
+HTTP/1.1 200 OK
+"eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhZG1pbiJ9.O7hC-ta225epRQlJZO44WC-l2cWohKnJ8lkmlOQpw8Z_xYiwJ6-qDUhHeJEZH9DmwIwz_jD77sj1kQUkXHsbOg"
+```
diff --git a/docs/api/overview.md b/docs/api/overview.md
@@ -0,0 +1,3 @@
+Routr API version is currently `v1beta1`. We continue to improve the API, resource definition, and other artifacts until we reach a final version. We can then establish an update policy to ensure backward compatibility. Until then keep an eye on this document. The endpoint for the API is as follows:
+
+`/api/{apiversion}`
diff --git a/docs/api/reference.md b/docs/api/reference.md
diff --git a/docs/theme/partials/header.html b/docs/theme/partials/header.html
@@ -2,6 +2,24 @@
 <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
 
 <style>
+  table {
+      width:100%;
+      box-shadow: none;
+      border-collapse: collapse;
+  }
+  .md-typeset__table {
+    width:100%;
+  }
+
+  .md-typeset table:not([class]) {
+    box-shadow: none;
+    border-radius: 0;
+  }
+
+  thead {
+    background-color: rgba(50, 94, 142, 0.54);
+  }
+
   .topnav {
     background-color: #33383d;
     overflow: hidden;

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -35,7 +35,20 @@ nav:
       - Cheatsheet: administration/cli/cheatsheet.md
       - Remote Access to a Routr Server: administration/cli/remote-access.md
     - Web Console: administration/webconsole.md
-  - API Reference: api/reference.md
+  - Rest API:
+    - Overview: api/overview.md
+    - API Permissions: api/api-permissions.md
+    - Admin APIs:
+        - Credentials: api/credentials.md
+        - Location: api/location.md
+        - Registry: api/registry.md
+        - Agents: api/agents.md
+        - Peers: api/peers.md
+        - Domains: api/domains.md
+        - Gateways: api/gateways.md
+        - DIDs: api/dids.md
+        - System.status: api/system-status.md
+        - System.info: api/system-info.md
   - Guides:
     - Basic Setup: guides/basic-setup.md
     - Routr as Asterisk frontend: guides/routr-as-asterisk-frontend.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		Routr API version is currently `v1beta1`. We continue to improve the API, resource definition, and other artifacts until we reach a final version. We can then establish an update policy to ensure backward compatibility. Until then keep an eye on this document. The endpoint for the API is as follows:

		`/api/{apiversion}`