Document references

buildingSMART · Aug 12, 2024 · 56177ea · 56177ea
1 parent ec4eaf5
commit 56177ea
Showing 1 changed file with 28 additions and 6 deletions.
diff --git a/swagger.yaml b/swagger.yaml
@@ -1471,19 +1471,41 @@ paths:
           content:
             application/json:
               schema:
-                type: array
-                items:
-                  $ref: '#/components/schemas/document_reference_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/document_reference_GET"
               example:
-                [{
+                {
+                  "skip": 0,
+                  "top": 1000,
+                  "totalCount": 2,
+                  "nextLink": null,
+                  "data": [{
                     "guid": "212ab37a-6122-448e-86fc-86503183b520",
                     "url": "http://example.com/files/LegalRequirements.pdf",
                     "description": "The legal requirements for buildings."
-                }, {
+                  }, {
                     "guid": "6cbfe31d-95c3-4f4d-92a6-420c23698721",
                     "document_guid": "472ab37a-6122-448e-86fc-86503183b520",
                     "description": "The building owners global design parameters for buildings."
-                }]
+                  }]
+                }
     post:
       summary: Create Document Reference
       description:  |