chore(docs): remove summary from all endpoint docs

discue · Jun 13, 2022 · c11e7c3 · c11e7c3
1 parent dc6bbec
commit c11e7c3
Show file tree

Hide file tree

Showing 23 changed files with 0 additions and 46 deletions.
diff --git a/docs/api-reference/api-keys/create-an-api-key.md b/docs/api-reference/api-keys/create-an-api-key.md
@@ -25,8 +25,6 @@ Creates a new API key and returns the actual key.
 <Badge type="warning" text="Note" vertical="middle"/> For security reasons, the 
 API key will only be returned once after its creation.
 
-*Create a new api key*
-
 ::: tip Authentication
 To perform this operation, you must provide a valid api key. See [Authentication](/getting-started/#prerequisites).
 :::

diff --git a/docs/api-reference/api-keys/delete-an-api-key-by-id.md b/docs/api-reference/api-keys/delete-an-api-key-by-id.md
@@ -27,8 +27,6 @@ Returns `404` if no api key was found with the given `api_key_id`.
 <strong>the target api key will be deleted.</strong> 
 There is no going back, only emptiness.
 
-*Delete api key*
-
 ::: tip Authentication
 To perform this operation, you must provide a valid api key. See [Authentication](/getting-started/#prerequisites).
 :::

diff --git a/docs/api-reference/api-keys/get-all-api-keys.md b/docs/api-reference/api-keys/get-all-api-keys.md
@@ -29,8 +29,6 @@ will, however, return meta data of each key like the time it was created and its
 The result may be inconistent as in not update-to-date as results may be cached
 for a short period of time.
 
-*Return all api keys with redacted info*
-
 ::: tip Authentication
 To perform this operation, you must provide a valid api key. See [Authentication](/getting-started/#prerequisites).
 :::

diff --git a/docs/api-reference/api-keys/get-an-api-key-by-id.md b/docs/api-reference/api-keys/get-an-api-key-by-id.md
@@ -29,8 +29,6 @@ will, however, return meta data of a key like the time it was created and its cu
 The result may be inconistent as in not update-to-date as results may be cached
 for a short period of time.
 
-*Get an api key by id*
-
 ::: tip Authentication
 To perform this operation, you must provide a valid api key. See [Authentication](/getting-started/#prerequisites).
 :::

diff --git a/docs/api-reference/api-keys/update-an-api-key-by-id.md b/docs/api-reference/api-keys/update-an-api-key-by-id.md
@@ -24,8 +24,6 @@ Updates an api key by id. Requires the id of the target api to be passed via pat
 
 Returns `404` if no api key was found with the given `api_key_id`. 
 
-*Update api key*
-
 ::: tip Authentication
 To perform this operation, you must provide a valid api key. See [Authentication](/getting-started/#prerequisites).
 :::

diff --git a/docs/api-reference/organizations/create-an-api-client.md b/docs/api-reference/organizations/create-an-api-client.md
@@ -25,8 +25,6 @@ Users who need direct acces to the resources can be assigned to an organizations
 
 <Badge type="get" text="Info" vertical="middle"/> In this context an api client and an organization can be used synonymously. 
 
-*Create an api client*
-
 ::: tip Authentication
 To perform this operation, you must provide a valid api key. See [Authentication](/getting-started/#prerequisites).
 :::

diff --git a/docs/api-reference/queue-listeners/add-a-listener-to-a-queue.md b/docs/api-reference/queue-listeners/add-a-listener-to-a-queue.md
@@ -31,8 +31,6 @@ must be passed to the following listener endpoints to update or delete the liste
 To get an overview of all registered listeners, you can always call the 
 [get all listeners endpoint](/api-reference/queue-listeners/get-all-listeners.html).
 
-*Add a listener to a queue*
-
 ::: tip Authentication
 To perform this operation, you must provide a valid api key. See [Authentication](/getting-started/#prerequisites).
 :::

diff --git a/docs/api-reference/queue-listeners/delete-a-listener-by-id.md b/docs/api-reference/queue-listeners/delete-a-listener-by-id.md
@@ -26,8 +26,6 @@ If no queue or listener with the given ids can be found, the endpoint returns st
 <Badge type="danger" text="Warning" vertical="middle"/> As a result of calling this endpoint
 <strong>the target listener will be deleted and sent to the shadow realm</strong>. This process cannot be reverted.
 
-*Delete a listener of a queue*
-
 ::: tip Authentication
 To perform this operation, you must provide a valid api key. See [Authentication](/getting-started/#prerequisites).
 :::

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
@@ -29,8 +29,6 @@ Use [this endpoint](/api-reference/queues/create-a-queue.html) to create a queue
 The result may be inconistent as in not update-to-date as results may be cached
 for a short period of time.
 
-*Returns a listener*
-
 ::: tip Authentication
 To perform this operation, you must provide a valid api key. See [Authentication](/getting-started/#prerequisites).
 :::

diff --git a/docs/api-reference/queue-listeners/get-all-listeners.md b/docs/api-reference/queue-listeners/get-all-listeners.md
@@ -30,8 +30,6 @@ of **all queues**. This can lead to potentially high response times.
 The result may be inconistent as in not update-to-date as results may be cached
 for a short period of time.
 
-*Returns all known listeners*
-
 ::: tip Authentication
 To perform this operation, you must provide a valid api key. See [Authentication](/getting-started/#prerequisites).
 :::

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
@@ -29,8 +29,6 @@ if you are only interested in the listeners of a specific queue.
 The result may be inconistent as in not update-to-date as results may be cached
 for a short period of time.
 
-*Returns all listeners of a queue*
-
 ::: tip Authentication
 To perform this operation, you must provide a valid api key. See [Authentication](/getting-started/#prerequisites).
 :::

diff --git a/docs/api-reference/queue-listeners/update-a-listener-by-id.md b/docs/api-reference/queue-listeners/update-a-listener-by-id.md
@@ -25,8 +25,6 @@ If no queue or listener with the given ids can be found, the endpoint returns st
 
 Only **mutable** properties like `name`, `notify_url`, `liveness_url` can be updated. 
 
-*Update a listener of a queue*
-
 ::: tip Authentication
 To perform this operation, you must provide a valid api key. See [Authentication](/getting-started/#prerequisites).
 :::

diff --git a/docs/api-reference/queue-messages/add-a-message-to-a-queue.md b/docs/api-reference/queue-messages/add-a-message-to-a-queue.md
@@ -33,8 +33,6 @@ Discue will keep track of all successful delivieres and will initiate redeliveri
 To get an overview of all stored messages, you can call the 
 [get all messages endpoint](/api-reference/queue-messages/get-all-messages.html).
 
-*Add a message to a queue*
-
 ::: tip Authentication
 To perform this operation, you must provide a valid api key. See [Authentication](/getting-started/#prerequisites).
 :::

diff --git a/docs/api-reference/queue-messages/delete-a-message-by-id.md b/docs/api-reference/queue-messages/delete-a-message-by-id.md
@@ -26,8 +26,6 @@ If no queue or message with the given ids can be found, the endpoint returns sta
 <Badge type="danger" text="Warning" vertical="middle"/> As a result of calling this endpoint
 <strong>the target message will be deleted forever</strong>. This process cannot be reverted.
 
-*Deletes a message of a queue*
-
 ::: tip Authentication
 To perform this operation, you must provide a valid api key. See [Authentication](/getting-started/#prerequisites).
 :::

diff --git a/docs/api-reference/queue-messages/get-a-message-by-id.md b/docs/api-reference/queue-messages/get-a-message-by-id.md
@@ -29,8 +29,6 @@ Beforehand, use [this endpoint](/api-reference/queues/create-a-queue.html) to cr
 The result may be inconistent as in not update-to-date as results may be cached
 for a short period of time.
 
-*Returns a message of a queue*
-
 ::: tip Authentication
 To perform this operation, you must provide a valid api key. See [Authentication](/getting-started/#prerequisites).
 :::

diff --git a/docs/api-reference/queue-messages/get-all-messages.md b/docs/api-reference/queue-messages/get-all-messages.md
@@ -30,8 +30,6 @@ of **all queues**. This can lead to potentially high response times.
 The result may be inconistent as in not update-to-date as results may be cached
 for a short period of time.
 
-*Returns all messages of all queues*
-
 ::: tip Authentication
 To perform this operation, you must provide a valid api key. See [Authentication](/getting-started/#prerequisites).
 :::

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
@@ -29,8 +29,6 @@ This endpoint can potentially return a large number of messages. This can lead t
 The result may be inconistent as in not update-to-date as results may be cached
 for a short period of time.
 
-*Returns a list of queue messages*
-
 ::: tip Authentication
 To perform this operation, you must provide a valid api key. See [Authentication](/getting-started/#prerequisites).
 :::

diff --git a/docs/api-reference/queue-messages/update-a-message-by-id.md b/docs/api-reference/queue-messages/update-a-message-by-id.md
@@ -20,8 +20,6 @@ api:
 <span class="font-medium">PUT</span> /queues/{queue_id}/messages/{message_id}
 </p>
 
-*Update a message of a queue*
-
 ::: tip Authentication
 To perform this operation, you must provide a valid api key. See [Authentication](/getting-started/#prerequisites).
 :::

diff --git a/docs/api-reference/queues/create-a-queue.md b/docs/api-reference/queues/create-a-queue.md
@@ -38,8 +38,6 @@ creation of a queue is a prerequisite for the following endpoints:
 - [Add a message to a queue](/api-reference/queue-messages/add-a-message-to-a-queue.html)
 - [Delete a message by id](/api-reference/queue-messages/delete-a-message-by-id.html)
 
-*Add a queue*
-
 ::: tip Authentication
 To perform this operation, you must provide a valid api key. See [Authentication](/getting-started/#prerequisites).
 :::

diff --git a/docs/api-reference/queues/delete-a-queue-by-id.md b/docs/api-reference/queues/delete-a-queue-by-id.md
@@ -27,8 +27,6 @@ If no queue with the given `queue_id` can be found, the endpoint returns status
 <strong>not only the target queue will be deleted, but also all associated listeners and messages</strong>. 
 There is no going back, only emptiness.
 
-*Delete a queue by id*
-
 ::: tip Authentication
 To perform this operation, you must provide a valid api key. See [Authentication](/getting-started/#prerequisites).
 :::

diff --git a/docs/api-reference/queues/get-a-queue-by-id.md b/docs/api-reference/queues/get-a-queue-by-id.md
@@ -28,8 +28,6 @@ can be found, the endpoint returns status `404`.
 The result may be inconistent as in not update-to-date as results may be cached
 for a short period of time.
 
-*Get a queue by id*
-
 ::: tip Authentication
 To perform this operation, you must provide a valid api key. See [Authentication](/getting-started/#prerequisites).
 :::

diff --git a/docs/api-reference/queues/get-all-queues.md b/docs/api-reference/queues/get-all-queues.md
@@ -26,8 +26,6 @@ by calling the [create queue endpoint](/api-reference/queues/create-a-queue.html
 The result may be inconistent as in not update-to-date as results may be cached
 for a short period of time.
 
-*Returns a list queues.*
-
 ::: tip Authentication
 To perform this operation, you must provide a valid api key. See [Authentication](/getting-started/#prerequisites).
 :::

diff --git a/docs/api-reference/queues/update-a-queue-by-id.md b/docs/api-reference/queues/update-a-queue-by-id.md
@@ -27,8 +27,6 @@ If no queue with the given `queue_id` can be found, the endpoint returns status
 
 Only mutable properties like `name` can be updated. 
 
-*Update a queue by id*
-
 ::: tip Authentication
 To perform this operation, you must provide a valid api key. See [Authentication](/getting-started/#prerequisites).
 :::