add docs for redeliver_event api (fix #4176) (#4177)

CHANGELOG.md

@@ -91,3 +91,4 @@
 - server: preserve cookie headers from sync action webhook (close #4021)
 - server: add 'ID' to default scalars in custom types (fix #4061)
 - console: add design system base components (#3866)
+- docs: add docs for redeliver_event API

docs/graphql/manual/api-reference/schema-metadata-api/event-triggers.rst

@@ -143,12 +143,53 @@ Args syntax
      - TriggerName_
      - Name of the event trigger
 
+
+.. _redeliver_event:
+
+redeliver_event
+---------------
+
+``redeliver_event`` is used to redeliver an existing event. For example, if an event is marked as error (
+say it did not succeed after retries), you can redeliver it using this API. Note that this will reset the count of retries so far.
+If the event fails to deliver, it will be retried automatically according to its ``retry_conf``.
+
+.. code-block:: http
+
+   POST /v1/query HTTP/1.1
+   Content-Type: application/json
+   X-Hasura-Role: admin
+
+   {
+       "type" : "redeliver_event",
+       "args" : {
+           "event_id": "ad4f698f-a14e-4a6d-a01b-38cd252dd8bf"
+       }
+   }
+
+.. _redeliver_event_syntax:
+
+Args syntax
+^^^^^^^^^^^
+
+.. list-table::
+   :header-rows: 1
+
+   * - Key
+     - Required
+     - Schema
+     - Description
+   * - event_id
+     - true
+     - String
+     - UUID of the event
+
+
 .. _invoke_event_trigger:
 
 invoke_event_trigger
 --------------------
 
-``invoke_event_trigger`` is used to invoke an event trigger manually.
+``invoke_event_trigger`` is used to invoke an event trigger with custom payload.
 
 .. code-block:: http
 

docs/graphql/manual/api-reference/schema-metadata-api/index.rst

@@ -211,16 +211,21 @@ The various types of queries are listed in the following table:
      - 1
      - Create or replace an event trigger
 
-   * - :ref:`invoke_event_trigger`
-     - :ref:`invoke_event_trigger_args <invoke_event_trigger_syntax>`
-     - 1
-     - Invoke a trigger manually
-
    * - :ref:`delete_event_trigger`
      - :ref:`delete_event_trigger_args <delete_event_trigger_syntax>`
      - 1
      - Delete an existing event trigger
 
+   * - :ref:`redeliver_event`
+     - :ref:`redeliver_event_args <redeliver_event_syntax>`
+     - 1
+     - Redeliver an existing event
+
+   * - :ref:`invoke_event_trigger`
+     - :ref:`invoke_event_trigger_args <invoke_event_trigger_syntax>`
+     - 1
+     - Invoke a trigger with custom payload
+
    * - :ref:`add_remote_schema`
      - :ref:`add_remote_schema_args <add_remote_schema_syntax>`
      - 1