update topic subscribers mgmt api docs (#135)

CPCN-355
superdesk · Oct 5, 2023 · ecc41cf · ecc41cf
1 parent 667054f
commit ecc41cf
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 2 deletions.
diff --git a/server/features/mgmt_api.feature b/server/features/mgmt_api.feature
@@ -198,3 +198,8 @@ Feature: Management API
         {"label": "topic2"}
         """
 
+        When we patch latest
+        """
+        {"subscribers": [{"user_id" :"#users._id#", "notification_type": "real-time"}]}
+        """
+        Then we get updated response
diff --git a/server/theme/swagger.yaml b/server/theme/swagger.yaml
@@ -950,9 +950,22 @@ components:
           default: false
         subscribers:
           type: array
-          description: List of User IDs that will receive email notifications for new items
+          description: Notification subscriptions.
           items:
-            $ref: '#/components/schemas/ObjectId'
+            type: object
+            properties:
+              user_id:
+                type: string
+                $ref: '#/components/schemas/ObjectId'
+              notification_type:
+                type: string
+                default: "real-time"
+                enum:
+                  - "real-time"
+                  - "scheduled"
+            required:
+              - user_id
+              - notification_type
         timezone_offset:
           type: integer
         topic_type: