[DGR-2123] Remove incorrect payload attributes from collections PUT request (#102) (#103)

sandilya91 · web-flow · commit 6f1b28d54ba3 · 2025-07-07T12:59:38.000+01:00
* docs: update collections API payload structure

Fix documentation to remove incorrect payload attributes from the PUT request

- Fix parameter documentation inconsistencies

* Add response example to Collection PUT endpoint

* Update payload structure for Collection create endpoint
diff --git a/apiary.apib b/apiary.apib
@@ -2256,15 +2256,24 @@ To create one, you'll need to provide a collection name, a description, and indi
                 "collection": {
                     "name": "Collection name",
                     "description": "DESCRIPTION",
-                    "public": true,
-                    "organization_id": 1,
-                    "groups_count": 0,
-                    "groups": []
+                    "public": true
                 }
             }
 
 + Response 200 (application/json)
 
+        {
+            "collection": {
+                "id": "809fxsq0-fx89-11ef-8c4a-b7d12b7poib3",
+                "name": "Collection name",
+                "description": "DESCRIPTION",
+                "organization_id": 231,
+                "public": true,
+                "groups_count": 0,
+                "groups": []
+            }
+        }
+
 ## Collection [/v1/collections/{collection_id}]
 ### Update a Collection [PUT]
 
@@ -2290,14 +2299,28 @@ To create one, you'll need to provide a collection name, a description, and indi
                     "name": "Collection name",
                     "description": "DESCRIPTION",
                     "public": true,
-                    "organization_id": 1,
-                    "groups_count": 22,
                     "groups": [{"id": 1}, {"id": 2}, {"id": 3}]
                 }
             }
 
 + Response 200 (application/json)
 
+        {
+            "collection": {
+                "id": "809fxsq0-fx89-11ef-8c4a-b7d12b7poib3",
+                "name": "Collection name",
+                "description": "DESCRIPTION",
+                "organization_id": 231,
+                "public": true,
+                "groups_count": 3,
+                "groups": [
+                    {"id": 1},
+                    {"id": 2},
+                    {"id": 3}
+                ]
+            }
+        }
+
 ### Delete a Collection [DELETE]
 
 + Parameters
