chore(docs): update docs according to api spec

discue · Jun 13, 2022 · bc43929 · bc43929
1 parent c3b3a44
commit bc43929
Show file tree

Hide file tree

Showing 5 changed files with 51 additions and 96 deletions.
diff --git a/docs/api-reference/api-keys/get-all-api-keys.md b/docs/api-reference/api-keys/get-all-api-keys.md
@@ -114,7 +114,6 @@ func main() {
 |Name|In|Type|Required|Description|
 |---|---|---|---|---|
 |pretty|query|boolean| ❌ |Return the response pretty printed|
-|_embed|query|boolean| ❌ |Embed full resources in response payload|
 
 ## Responses 
 
@@ -126,22 +125,14 @@ func main() {
   "api_keys": [
     {
       "id": "string",
-      "name": "string"
+      "name": "string",
+      "created_at": 1644616838173,
+      "updated_at": 1644616838173,
+      "last_used_at": 1644616838173,
+      "key": "ep1",
+      "status": "disabled"
     }
   ],
-  "_embedded": {
-    "api_keys": [
-      {
-        "id": "string",
-        "name": "string",
-        "created_at": 1644616838173,
-        "updated_at": 1644616838173,
-        "last_used_at": 1644616838173,
-        "key": "ep1",
-        "status": "disabled"
-      }
-    ]
-  },
   "_links": {
     "self": {
       "href": "https://api.discue.io/queues/180994c-b6b2-4d0e-b7ad-414716e83386/messages/8476f9ea-e457-4fed-8fbd-347a96237a96"

diff --git a/docs/api-reference/queue-listeners/get-all-listeners.md b/docs/api-reference/queue-listeners/get-all-listeners.md
@@ -115,7 +115,6 @@ func main() {
 ## Parameters 
 |Name|In|Type|Required|Description|
 |---|---|---|---|---|
-|_embed|query|boolean| ❌ |Embed full resources in response payload|
 |pretty|query|boolean| ❌ |Return the response pretty printed|
 
 ## Responses 
@@ -127,38 +126,30 @@ func main() {
 {
   "listeners": [
     {
-      "id": "0644659f-b47b-4668-86dd-a496cb7fbc76",
-      "name": "myapp.io/delete-user-listener-64fae19"
+      "id": "string",
+      "name": "string",
+      "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
+      },
+      "messages": {
+        "acknowledged_count": 312,
+        "last_success_at": 1644616838173,
+        "last_failure_at": 1644616818173,
+        "missed": [
+          "fb445832-50f7-4471-a0a9-d0def6d5951f"
+        ],
+        "missed_count": 1
+      },
+      "notify_url": "https://myapp.io/deletion/listener",
+      "liveness_url": "https://myapp.io/live"
     }
   ],
-  "_embedded": {
-    "listeners": [
-      {
-        "id": "string",
-        "name": "string",
-        "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
-        },
-        "messages": {
-          "acknowledged_count": 312,
-          "last_success_at": 1644616838173,
-          "last_failure_at": 1644616818173,
-          "missed": [
-            "fb445832-50f7-4471-a0a9-d0def6d5951f"
-          ],
-          "missed_count": 1
-        },
-        "notify_url": "https://myapp.io/deletion/listener",
-        "liveness_url": "https://myapp.io/live"
-      }
-    ]
-  },
   "_links": {
     "self": "https://api.discue.io/queues/180994c-b6b2-4d0e-b7ad-414716e83386/listeners",
     "myapp.io/delete-user-listener-64fae19": {
@@ -320,7 +311,7 @@ func main() {
 
 |Status|Meaning|Description|Schema|
 |---|---|---|---|
-|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Ok|[GetQueueListenersResponseWithEmbeddings](#getqueuelistenersresponsewithembeddings)|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Ok|[GetQueueListenersResponse](#getqueuelistenersresponse)|
 |400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|Inline|
 |401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
 |402|[Payment Required](https://tools.ietf.org/html/rfc7231#section-6.5.2)|Payment Required|Inline|

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
@@ -116,7 +116,6 @@ func main() {
 ## Parameters 
 |Name|In|Type|Required|Description|
 |---|---|---|---|---|
-|_embed|query|boolean| ❌ |Embed full resources in response payload|
 |pretty|query|boolean| ❌ |Return the response pretty printed|
 
 ## Responses 
@@ -128,38 +127,30 @@ func main() {
 {
   "listeners": [
     {
-      "id": "0644659f-b47b-4668-86dd-a496cb7fbc76",
-      "name": "myapp.io/delete-user-listener-64fae19"
+      "id": "string",
+      "name": "string",
+      "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
+      },
+      "messages": {
+        "acknowledged_count": 312,
+        "last_success_at": 1644616838173,
+        "last_failure_at": 1644616818173,
+        "missed": [
+          "fb445832-50f7-4471-a0a9-d0def6d5951f"
+        ],
+        "missed_count": 1
+      },
+      "notify_url": "https://myapp.io/deletion/listener",
+      "liveness_url": "https://myapp.io/live"
     }
   ],
-  "_embedded": {
-    "listeners": [
-      {
-        "id": "string",
-        "name": "string",
-        "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
-        },
-        "messages": {
-          "acknowledged_count": 312,
-          "last_success_at": 1644616838173,
-          "last_failure_at": 1644616818173,
-          "missed": [
-            "fb445832-50f7-4471-a0a9-d0def6d5951f"
-          ],
-          "missed_count": 1
-        },
-        "notify_url": "https://myapp.io/deletion/listener",
-        "liveness_url": "https://myapp.io/live"
-      }
-    ]
-  },
   "_links": {
     "self": "https://api.discue.io/queues/180994c-b6b2-4d0e-b7ad-414716e83386/listeners",
     "myapp.io/delete-user-listener-64fae19": {

diff --git a/docs/api-reference/queue-messages/get-all-messages.md b/docs/api-reference/queue-messages/get-all-messages.md
@@ -115,7 +115,6 @@ func main() {
 |Name|In|Type|Required|Description|
 |---|---|---|---|---|
 |queue_id|path|string(uuid)|✔|Id of the target queue|
-|_embed|query|boolean| ❌ |Embed full resources in response payload|
 |pretty|query|boolean| ❌ |Return the response pretty printed|
 
 ## Responses 
@@ -131,14 +130,6 @@ func main() {
       "name": "string"
     }
   ],
-  "_embedded": {
-    "messages": [
-      {
-        "id": "string",
-        "name": "string"
-      }
-    ]
-  },
   "_links": {
     "self": {
       "href": "https://api.discue.io/queues/180994c-b6b2-4d0e-b7ad-414716e83386/messages"

diff --git a/docs/api-reference/queue-messages/get-messages-by-queue-id.md b/docs/api-reference/queue-messages/get-messages-by-queue-id.md
@@ -117,7 +117,6 @@ func main() {
 |Name|In|Type|Required|Description|
 |---|---|---|---|---|
 |queue_id|path|string(uuid)|✔|Id of the target queue|
-|_embed|query|boolean| ❌ |Embed full resources in response payload|
 |pretty|query|boolean| ❌ |Return the response pretty printed|
 
 ## Responses 
@@ -133,14 +132,6 @@ func main() {
       "name": "string"
     }
   ],
-  "_embedded": {
-    "messages": [
-      {
-        "id": "string",
-        "name": "string"
-      }
-    ]
-  },
   "_links": {
     "self": {
       "href": "https://api.discue.io/queues/180994c-b6b2-4d0e-b7ad-414716e83386/messages"