Updated docs

config/config.yml

@@ -5,3 +5,7 @@ spec:
       port: 5060
     - protocol: tcp
       port: 5060
+  data_source:
+    provider: redis_data_provider
+    host: 192.168.1.127
+    secret: changeit

docs/api/agents/create.md

@@ -0,0 +1,39 @@
+Creates a new Agent resource. The Domain must exist before creating the Agent. Otherwise, this method responds with a `UNFULFILLED_DEPENDENCY_RESPONSE`.
+
+**URL**
+
+`/agents`
+
+**Method**
+
+`POST`
+
+**Parameters**
+
+This method does not receive any parameters.
+
+**Request body**
+
+A file containing an [Agent](/configuration/agents) resource in `json` or `yaml` format.
+
+**Response**
+
+If successful this method creates an Agent resource.
+
+**Sample Call**
+
+```json
+POST /api/{apiversion}/agents
+- apiVersion: v1beta1
+  kind: Agent
+  metadata:
+    name: John Doe
+  spec:
+    credentials:
+      username: '1001'
+      secret: '1234'
+    domains: [sip.local]
+
+HTTP/1.1 201 Created
+{"status": "201", "Successful request"}
+```

docs/api/agents/delete.md

@@ -0,0 +1,35 @@
+Removes an Agent resource from a persistent database.
+
+**URL**
+
+`/agents/{ref}`
+
+**Method**
+
+`DELETE`
+
+**Parameters**
+
+| Parameter Name | Type   | Value | Description
+| ---  | :--------- |  :--------- |  :--------- |
+| ref |  path | string | Resource reference|
+
+**Request body**
+
+Do not supply a request body with this method.
+
+**Response**
+
+If successful this method removes an Agent resource.
+
+**Sample Call**
+
+```json
+DELETE /api/{apiversion}/agents/{ref}
+{
+
+}
+
+HTTP/1.1 200 OK
+{"status": "200", "Successful request"}
+```

docs/api/agents/get.md

@@ -0,0 +1,35 @@
+This method returns an Agent resource.
+
+**URL**
+
+`/agents/{ref}`
+
+**Method**
+
+`GET`
+
+**Parameters**
+
+| Parameter Name | Type   | Value | Description
+| ---  | :--------- |  :--------- |  :--------- |
+| ref |  path | string | Resource reference|
+
+**Request body**
+
+Do not supply a request body with this method.
+
+**Response**
+
+If successful this method returns an Agent resource.
+
+**Sample Call**
+
+```json
+GET /api/{apiversion}/agents/{ref}
+{
+
+}
+
+HTTP/1.1 200 OK
+{"status": "200", "Successful request"}
+```

docs/api/agents/list.md

@@ -0,0 +1,35 @@
+This method returns a list of Agent resources.
+
+**URL**
+
+`/agents`
+
+**Method**
+
+`GET`
+
+**Parameters**
+
+| Parameter Name | Type   | Value | Description
+| ---  | :--------- |  :--------- |  :--------- |
+| filter |  query | string | Use filter to narrow the elements shown. |
+
+**Request body**
+
+Do not supply a request body with this method.
+
+**Response**
+
+If successful this method returns a list of Agent resources.
+
+**Sample Call**
+
+```json
+GET /api/{apiversion}/agents
+{
+
+}
+
+HTTP/1.1 200 OK
+{"status": "200", "Successful request"}
+```

docs/api/agents/update.md

@@ -0,0 +1,40 @@
+Updates am existing Agent resource.
+
+**URL**
+
+`/agents/{ref}`
+
+**Method**
+
+`PUT`
+
+**Parameters**
+
+This method does not receive any parameters.
+
+**Request body**
+
+A file containing an [Agent](/configuration/agents) resource in `json` or `yaml` format.
+
+**Response**
+
+If successful this method updates an Agent resource.
+
+**Sample Call**
+
+```json
+PUT /api/{apiversion}/agents/{ref}
+- apiVersion: v1beta1
+  kind: Agent
+  metadata:
+    name: John Doe
+    ref: {ref}
+  spec:
+    credentials:
+      username: '1001'
+      secret: '1234'
+    domains: [sip.local]
+
+HTTP/1.1 200 OK
+{"status": "200", "Successful request"}
+```