Comment events

buildingSMART · Aug 12, 2024 · 186d506 · 186d506
1 parent ad797f7
commit 186d506
Showing 1 changed file with 36 additions and 14 deletions.
diff --git a/swagger.yaml b/swagger.yaml
@@ -1998,33 +1998,55 @@ paths:
           content:
             application/json:
               schema:
-                type: array
-                items:
-                  $ref: '#/components/schemas/comment_event_GET'
+                type: object
+                required:
+                  skip
+                  top
+                  totalCount
+                  data
+                properties:
+                  skip:
+                    type: integer
+                  top:
+                    type: integer
+                  totalCount:
+                    type: integer
+                  nextLink:
+                    type: string
+                  data:
+                    type: array
+                    items:
+                      $ref:  "#/components/schemas/comment_event_GET"
               example:
-                [{
+                {
+                  "skip": 0,
+                  "top": 1000,
+                  "totalCount": 2,
+                  "nextLink": null,
+                  "data": [{
                     "comment_guid": "C4215F4D-AC45-A43A-D615-AA456BEF832B",
                     "topic_guid": "A211FCC2-3A3B-EAA4-C321-DE22ABC8414",
                     "date": "2014-11-19T14:24:11.316Z",
                     "author": "Architect@example.com",
                     "events": [
-                        {
-                            "type": "comment_created",
-                            "value": null
-                        }
+                      {
+                        "type": "comment_created",
+                        "value": null
+                      }
                     ]
-                }, {
+                  }, {
                     "comment_guid": "C4215F4D-AC45-A43A-D615-AA456BEF832B",
                     "topic_guid": "A245F4F2-2C01-B43B-B612-5E456BEF8116",
                     "date": "2013-10-21T17:34:22.409Z",
                     "author": "Architect@example.com",
                     "events": [
-                        {
-                            "type": "comment_text_updated",
-                            "value": "This is the updated comment"
-                        }
+                      {
+                        "type": "comment_text_updated",
+                        "value": "This is the updated comment"
+                      }
                     ]
-                }]
+                  }]
+                }
 components:
   schemas:
     # error