docs(webhooks): create webhooks API spec

Author: syncush

docs/openapi3.yaml

@@ -37,6 +37,9 @@ tags:
   - name: Configuration
     description: |
       This resource allows you to configure Predator programmatically.
+  - name: Webhooks
+    description: |
+      This resource allows you to configure webhooks.
 x-tagGroups:
   - name: Reference
     tags:
@@ -46,6 +49,7 @@ x-tagGroups:
       - Jobs
       - Reports
       - Configuration
+      - Webhooks
 
 paths:
   #DSL Definitions
@@ -1383,6 +1387,142 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/error_response'
+  # Webhooks
+  /v1/webhooks:
+    get:
+      operationId: retrieve-webhooks
+      tags:
+        - Webhooks
+      summary: Retrieve webhooks
+      description: Retrieve all webhooks.
+      responses:
+        '200':
+          description: Success
+          content:
+            application/json:
+               schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/webhook'
+        '400':
+          description: Bad request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/error_response'
+        '404':
+          description: Not found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/error_response'
+        '500':
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/error_response'
+    post:
+      operationId: create-a-webhook
+      tags:
+        - Webhooks
+      summary: Create a Webhook
+      description: Create a new Webhook.
+      responses:
+        '201':
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/webhook'
+        '400':
+          description: Bad request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/error_response'
+        '422':
+          description: Unprocessable entity
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/error_response'
+        '500':
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/error_response'
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/webhook'
+        description: The webhook to add
+        required: true
+  /v1/webhooks/{webhook_id}:
+    get:
+      operationId: retrieve-a-webhook
+      tags:
+        - Webhooks
+      summary: Retrieve a webhook by id
+      description: Retrieve a webhook by id.
+      responses:
+        '200':
+          description: Success
+          content:
+            application/json:
+               schema:
+                  $ref: '#/components/schemas/webhook'
+        '404':
+          description: Not found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/error_response'
+        '500':
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/error_response'
+    put:
+      operationId: update-a-webhook
+      tags:
+        - Webhooks
+      summary: Update a webhook
+      description: Update a webhook.
+      responses:
+        '200':
+          description: Success
+          content:
+            application/json:
+               schema:
+                  $ref: '#/components/schemas/webhook'
+        '400':
+          description: Bad request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/error_response'
+        '422':
+          description: Unprocessable entity
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/error_response'
+        '404':
+          description: Not found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/error_response'
+        '500':
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/error_response'
 
 components:
   parameters:
@@ -1856,7 +1996,8 @@ components:
             The event body will include detailed information about the test, such as the number of scenarios that were executed and the number of requests that were invoked.
           items:
             type: string
-            description: The url of where to send the webhook with the report information
+            format: uuid
+            description: The id of the webhook
         arrival_rate:
           type: number
           minimum: 1
@@ -2277,3 +2418,38 @@ components:
         percentage:
             type: number
             description: benchmark percentage weight
+    webhook:
+      type: object
+      required:
+        - name
+        - webhook_url
+        - events
+      properties:
+        id:
+          description: Unique webhook identifier
+          type: string
+          format: uuid
+          readOnly: true
+        name:
+          type: string
+          description: Webhook name
+        webhook_url:
+          type: string
+          description: Webhook url to post events
+        events:
+          description: list of events which will trigger the webhook
+          type: array
+          items:
+            $ref: '#/components/schemas/webhooks_types'
+
+    webhooks_types:
+      type: string
+      enum:
+        - started
+        - api_failure
+        - aborted
+        - failed
+        - finished
+        - bencmark_passed
+        - benchmark_failed
+