Definitions Update herald

alertlogic · May 25, 2023 · 371ca84 · 371ca84
1 parent 04e76df
commit 371ca84
Showing 1 changed file with 39 additions and 1 deletion.
diff --git a/alsdkdefs/apis/herald/herald.v1.yaml b/alsdkdefs/apis/herald/herald.v1.yaml
@@ -412,6 +412,8 @@ paths:
                 anyOf:
                   - $ref: '#/components/schemas/Basic-Error-Response'
                   - $ref: '#/components/schemas/Validation-Error-Response'
+        '403':
+          description: Forbidden
         '404':
           description: Not Found
         '409':
@@ -491,8 +493,13 @@ paths:
                 anyOf:
                   - $ref: '#/components/schemas/Basic-Error-Response'
                   - $ref: '#/components/schemas/Validation-Error-Response'
+                  - $ref: '#/components/schemas/Failed-Subscribers'
         '403':
           description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Failed-Subscribers'
         '404':
           description: Not Found
         '413':
@@ -636,7 +643,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/Subscription'
+                $ref: '#/components/schemas/Subscription-Extra'
         '400':
           description: Bad Request
           content:
@@ -1208,6 +1215,37 @@ components:
         subscriber_count:
           type: number
           description: Available in List subscriptions for an account by subscription id
+    Subscription-Extra:
+      allOf:
+        - $ref: '#/components/schemas/Subscription'
+        - $ref: '#/components/schemas/Failed-Subscribers'
+      x-examples:
+        Subscriber Request Extra:
+          subscriber: 82FB03F2-3FEC-411B-82A2-904F68BFCC74
+          subscriber_type: connection
+          account_id: 134047511
+          subscription_id: 2306AD6F-EC8F-40B4-AC86-7C5D4FFC1597
+    Failed-Subscribers:
+      type: object
+      properties:
+        subscribers_failed:
+          type: array
+          description: A list of subscribers which were not successfully created, along with error information
+          items:
+            allOf:
+              - $ref: '#/components/schemas/Subscriber'
+              - type: object
+                properties:
+                  error:
+                    type: string
+                  details:
+                    anyOf:
+                      - type: string
+                      - type: array
+                        items:
+                          type: string
+                required:
+                  - error
     Basic-Error-Response:
       type: object
       properties: