chore(docs): update api documentation

discue · Mar 11, 2023 · 50d7e1a · 50d7e1a
1 parent 37b4547
commit 50d7e1a
Show file tree

Hide file tree

Showing 6 changed files with 328 additions and 49 deletions.
diff --git a/docs/api-reference/organizations/create-an-api-client.md b/docs/api-reference/organizations/create-an-api-client.md
@@ -41,33 +41,22 @@ See also: [Authentication](/getting-started/#prerequisites).
 
 ```shell
 curl -X POST http://api.discue.io/v1/api_clients \
-  -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \
-  -H 'X-API-KEY: API_KEY' \
-  -d '{
-  "id": "5bc2be68-7498-4853-aa64-4be0ca62934e",
-  "name": "example.com/dev"
-}' 
+  -H 'X-API-KEY: API_KEY'
 ```
 
 </CodeGroupItem>
 
 <CodeGroupItem title="javascript">
 
 ```javascript
-const body = {
-  "id": "5bc2be68-7498-4853-aa64-4be0ca62934e",
-  "name": "example.com/dev"
-}
-
 const headers = {
-  'Content-Type':'application/json',
   'Accept':'application/json',
   'X-API-KEY':'API_KEY'
 }
 
 const response = await fetch('http://api.discue.io/v1/api_clients', {
-  method: 'POST',  body,  headers
+  method: 'POST',  headers
 })
 
 const body = await response.json()
@@ -80,7 +69,6 @@ const body = await response.json()
 ```python
 import requests
 headers = {
-  'Content-Type': 'application/json',
   'Accept': 'application/json',
   'X-API-KEY': 'API_KEY'
 }
@@ -103,7 +91,6 @@ import (
 func main() {
 
   headers := map[string][]string{
-      "Content-Type": []string{"application/json"},
       "Accept": []string{"application/json"},
       "X-API-KEY": []string{"API_KEY"},
   }
@@ -121,22 +108,10 @@ func main() {
 
 </CodeGroup>
 
-## Body
-
-```json
-{
-  "id": "5bc2be68-7498-4853-aa64-4be0ca62934e",
-  "name": "example.com/dev"
-}
-```
-
 ## Parameters 
 |Name|In|Type|Required|Description|
 |---|---|---|---|---|
 |pretty|query|boolean| ❌ |Return the response pretty printed|
-|body|body|[ApiClient](#schemaapiclient)| ❌ |none|
-|» name|body|string| ❌ |none|
-|» id|body|[ResourceId](#resourceid)| ❌ |none|
 
 ## Responses 
 

diff --git a/docs/api-reference/organizations/update-an-api-client.md b/docs/api-reference/organizations/update-an-api-client.md
@@ -132,7 +132,7 @@ func main() {
 |---|---|---|---|---|
 |api_client_id|path|string(uuid)|✔|none|
 |pretty|query|boolean| ❌ |Return the response pretty printed|
-|body|body|[ApiClient](#schemaapiclient)| ❌ |none|
+|body|body|[ApiClientRef](#schemaapiclientref)| ❌ |none|
 |» name|body|string| ❌ |none|
 |» id|body|[ResourceId](#resourceid)| ❌ |none|
 

diff --git a/docs/api-reference/queue-listeners/get-a-listener-by-id.md b/docs/api-reference/queue-listeners/get-a-listener-by-id.md
@@ -131,16 +131,10 @@ func main() {
     "liveness": {
       "state": "stable",
       "success_count": 1,
-      "last_success_at": 1644262937466,
-      "failure_count": 1,
-      "last_failure_status": 500,
-      "last_failure_at": 1644262937466,
-      "last_failure_msg": 1644262937466
+      "failure_count": 1
     },
     "messages": {
       "acknowledged_count": 312,
-      "last_success_at": 1644616838173,
-      "last_failure_at": 1644616818173,
       "missed": [
         "fb445832-50f7-4471-a0a9-d0def6d5951f"
       ],

diff --git a/docs/api-reference/queue-listeners/get-all-listeners.md b/docs/api-reference/queue-listeners/get-all-listeners.md
@@ -131,16 +131,10 @@ func main() {
       "liveness": {
         "state": "stable",
         "success_count": 1,
-        "last_success_at": 1644262937466,
-        "failure_count": 1,
-        "last_failure_status": 500,
-        "last_failure_at": 1644262937466,
-        "last_failure_msg": 1644262937466
+        "failure_count": 1
       },
       "messages": {
         "acknowledged_count": 312,
-        "last_success_at": 1644616838173,
-        "last_failure_at": 1644616818173,
         "missed": [
           "fb445832-50f7-4471-a0a9-d0def6d5951f"
         ],

diff --git a/docs/api-reference/queue-listeners/get-all-queue-listeners-by-id.md b/docs/api-reference/queue-listeners/get-all-queue-listeners-by-id.md
@@ -132,16 +132,10 @@ func main() {
       "liveness": {
         "state": "stable",
         "success_count": 1,
-        "last_success_at": 1644262937466,
-        "failure_count": 1,
-        "last_failure_status": 500,
-        "last_failure_at": 1644262937466,
-        "last_failure_msg": 1644262937466
+        "failure_count": 1
       },
       "messages": {
         "acknowledged_count": 312,
-        "last_success_at": 1644616838173,
-        "last_failure_at": 1644616818173,
         "missed": [
           "fb445832-50f7-4471-a0a9-d0def6d5951f"
         ],