PATCH: Bcf group permissions (#911)

Bimdata-io · Bimdata-io · commit 8ee529fd752f · 2025-10-28T15:48:07.000Z
* Add model, filter list views

* wip: permissions

* remove useless config

* Comment permission implementation

* bcf permissions

* more tests, more view filters

* add more tests

* add comment about permissions
diff --git a/docs/CollaborationApi.md b/docs/CollaborationApi.md
@@ -961,7 +961,7 @@ Name | Type | Description  | Notes
 
 Create a document
 
-Create a document. If the document is one of {&#39;DXF&#39;, &#39;OBJ&#39;, &#39;POINT_CLOUD&#39;, &#39;DWG&#39;, &#39;GLTF&#39;, &#39;IFC&#39;}, a model will be created and attached to this document  Required scopes: document:write
+Create a document. If the document is one of {&#39;POINT_CLOUD&#39;, &#39;GLTF&#39;, &#39;IFC&#39;, &#39;DXF&#39;, &#39;OBJ&#39;, &#39;DWG&#39;}, a model will be created and attached to this document  Required scopes: document:write
 
 ### Example
 
diff --git a/docs/DocumentText.md b/docs/DocumentText.md
@@ -6,19 +6,19 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Number** |  | [readonly] 
 **text** | **String** | The full text representation of a document if the feature is enabled and the file format supported | [optional] 
-**language** | **String** | * &#x60;german&#x60; - german * &#x60;french&#x60; - french * &#x60;spanish&#x60; - spanish * &#x60;italian&#x60; - italian * &#x60;english&#x60; - english | [optional] 
+**language** | **String** | * &#x60;french&#x60; - french * &#x60;spanish&#x60; - spanish * &#x60;german&#x60; - german * &#x60;italian&#x60; - italian * &#x60;english&#x60; - english | [optional] 
 
 
 
 ## Enum: LanguageEnum
 
 
-* `german` (value: `"german"`)
-
 * `french` (value: `"french"`)
 
 * `spanish` (value: `"spanish"`)
 
+* `german` (value: `"german"`)
+
 * `italian` (value: `"italian"`)
 
 * `english` (value: `"english"`)
diff --git a/docs/FullTopic.md b/docs/FullTopic.md
@@ -26,5 +26,6 @@ Name | Type | Description | Notes
 **comments** | [**[Comment]**](Comment.md) |  | [optional] 
 **viewpoints** | [**[Viewpoint]**](Viewpoint.md) |  | [optional] 
 **bimdataViewerLayout** | **Object** | Non standard field. JSON describing bimdataViewerLayout. | [optional] 
+**groups** | **[Number]** |  | [optional] 
 
 
diff --git a/docs/FullTopicRequest.md b/docs/FullTopicRequest.md
@@ -25,5 +25,6 @@ Name | Type | Description | Notes
 **comments** | [**[CommentRequest]**](CommentRequest.md) |  | [optional] 
 **viewpoints** | [**[ViewpointRequest]**](ViewpointRequest.md) |  | [optional] 
 **bimdataViewerLayout** | **Object** | Non standard field. JSON describing bimdataViewerLayout. | [optional] 
+**groups** | **[Number]** |  | [optional] 
 
 
diff --git a/docs/PatchedDocumentTextRequest.md b/docs/PatchedDocumentTextRequest.md
@@ -5,19 +5,19 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **text** | **String** | The full text representation of a document if the feature is enabled and the file format supported | [optional] 
-**language** | **String** | * &#x60;german&#x60; - german * &#x60;french&#x60; - french * &#x60;spanish&#x60; - spanish * &#x60;italian&#x60; - italian * &#x60;english&#x60; - english | [optional] 
+**language** | **String** | * &#x60;french&#x60; - french * &#x60;spanish&#x60; - spanish * &#x60;german&#x60; - german * &#x60;italian&#x60; - italian * &#x60;english&#x60; - english | [optional] 
 
 
 
 ## Enum: LanguageEnum
 
 
-* `german` (value: `"german"`)
-
 * `french` (value: `"french"`)
 
 * `spanish` (value: `"spanish"`)
 
+* `german` (value: `"german"`)
+
 * `italian` (value: `"italian"`)
 
 * `english` (value: `"english"`)
diff --git a/docs/PatchedFullTopicRequest.md b/docs/PatchedFullTopicRequest.md
@@ -25,5 +25,6 @@ Name | Type | Description | Notes
 **comments** | [**[CommentRequest]**](CommentRequest.md) |  | [optional] 
 **viewpoints** | [**[ViewpointRequest]**](ViewpointRequest.md) |  | [optional] 
 **bimdataViewerLayout** | **Object** | Non standard field. JSON describing bimdataViewerLayout. | [optional] 
+**groups** | **[Number]** |  | [optional] 
 
 
diff --git a/docs/PatchedTopicRequest.md b/docs/PatchedTopicRequest.md
@@ -23,5 +23,6 @@ Name | Type | Description | Notes
 **format** | **String** |          The BCF data structure may be used for other purposes than BCF Topics. (Storing coordinates, a viewpoint, a list of objecs, etc)         The default value is \&quot;standard\&quot;.         If you want to use the BCF routes to store custom data not related to a BCF Topic, you must set this value to something else.         You must add a query string filter if you want to fetch topics with a non \&quot;standard\&quot; format.          | [optional] 
 **index** | **Number** |  | [optional] 
 **bimdataViewerLayout** | **Object** | Non standard field. JSON describing bimdataViewerLayout. | [optional] 
+**groups** | **[Number]** |  | [optional] 
 
 
diff --git a/docs/Topic.md b/docs/Topic.md
@@ -24,5 +24,6 @@ Name | Type | Description | Notes
 **format** | **String** |          The BCF data structure may be used for other purposes than BCF Topics. (Storing coordinates, a viewpoint, a list of objecs, etc)         The default value is \&quot;standard\&quot;.         If you want to use the BCF routes to store custom data not related to a BCF Topic, you must set this value to something else.         You must add a query string filter if you want to fetch topics with a non \&quot;standard\&quot; format.          | [optional] 
 **index** | **Number** |  | [optional] 
 **bimdataViewerLayout** | **Object** | Non standard field. JSON describing bimdataViewerLayout. | [optional] 
+**groups** | **[Number]** |  | [optional] 
 
 
diff --git a/docs/TopicRequest.md b/docs/TopicRequest.md
@@ -23,5 +23,6 @@ Name | Type | Description | Notes
 **format** | **String** |          The BCF data structure may be used for other purposes than BCF Topics. (Storing coordinates, a viewpoint, a list of objecs, etc)         The default value is \&quot;standard\&quot;.         If you want to use the BCF routes to store custom data not related to a BCF Topic, you must set this value to something else.         You must add a query string filter if you want to fetch topics with a non \&quot;standard\&quot; format.          | [optional] 
 **index** | **Number** |  | [optional] 
 **bimdataViewerLayout** | **Object** | Non standard field. JSON describing bimdataViewerLayout. | [optional] 
+**groups** | **[Number]** |  | [optional] 
 
 
diff --git a/docs/WriteFolder.md b/docs/WriteFolder.md
@@ -4,22 +4,22 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**groupsPermissions** | [**[GroupFolderRead]**](GroupFolderRead.md) | List of group permissions | [readonly] 
-**createdAt** | **Date** | Creation date | [readonly] 
+**nature** | **String** | Value is \&quot;Folder\&quot;. It is usefull to parse the tree and discriminate folders and files | [readonly] 
 **name** | **String** | Name of the folder | 
+**defaultPermission** | **Number** | Permission for a Folder  * &#x60;1&#x60; - denied * &#x60;50&#x60; - read_only * &#x60;100&#x60; - read_write | [optional] 
 **updatedAt** | **Date** | Date of the last update | [readonly] 
-**nature** | **String** | Value is \&quot;Folder\&quot;. It is usefull to parse the tree and discriminate folders and files | [readonly] 
-**createdBy** | [**ShortUser**](ShortUser.md) |  | [readonly] 
 **parentId** | **Number** |  | [optional] 
 **id** | **Number** |  | [readonly] 
+**createdBy** | [**ShortUser**](ShortUser.md) |  | [readonly] 
+**createdAt** | **Date** | Creation date | [readonly] 
+**groupsPermissions** | [**[GroupFolderRead]**](GroupFolderRead.md) | List of group permissions | [readonly] 
 **userPermission** | **Number** | Aggregate of group user permissions and folder default permission | [readonly] 
 **type** | **String** | DEPRECATED: Use &#39;nature&#39; instead. Value is \&quot;Folder\&quot;. It is usefull to parse the tree and discriminate folders and files | [readonly] 
-**defaultPermission** | **Number** | Permission for a Folder  * &#x60;1&#x60; - denied * &#x60;50&#x60; - read_only * &#x60;100&#x60; - read_write | [optional] 
 **children** | [**[WriteFolder]**](WriteFolder.md) |  | [optional] 
 
 
 
-## Enum: UserPermissionEnum
+## Enum: DefaultPermissionEnum
 
 
 * `1` (value: `1`)
@@ -32,7 +32,7 @@ Name | Type | Description | Notes
 
 
 
-## Enum: DefaultPermissionEnum
+## Enum: UserPermissionEnum
 
 
 * `1` (value: `1`)
diff --git a/docs/WriteFolderRequest.md b/docs/WriteFolderRequest.md
@@ -5,8 +5,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | Name of the folder | 
-**parentId** | **Number** |  | [optional] 
 **defaultPermission** | **Number** | Permission for a Folder  * &#x60;1&#x60; - denied * &#x60;50&#x60; - read_only * &#x60;100&#x60; - read_write | [optional] 
+**parentId** | **Number** |  | [optional] 
 **children** | [**[WriteFolder]**](WriteFolder.md) |  | [optional] 
 
 
diff --git a/src/api/CollaborationApi.js b/src/api/CollaborationApi.js
@@ -868,7 +868,7 @@ export default class CollaborationApi {
 
     /**
      * Create a document
-     * Create a document. If the document is one of {'DXF', 'OBJ', 'POINT_CLOUD', 'DWG', 'GLTF', 'IFC'}, a model will be created and attached to this document  Required scopes: document:write
+     * Create a document. If the document is one of {'POINT_CLOUD', 'GLTF', 'IFC', 'DXF', 'OBJ', 'DWG'}, a model will be created and attached to this document  Required scopes: document:write
      * @param {Number} cloudPk A unique integer value identifying this cloud.
      * @param {Number} projectPk A unique integer value identifying this project.
      * @param {String} name Shown name of the file
@@ -936,7 +936,7 @@ export default class CollaborationApi {
 
     /**
      * Create a document
-     * Create a document. If the document is one of {'DXF', 'OBJ', 'POINT_CLOUD', 'DWG', 'GLTF', 'IFC'}, a model will be created and attached to this document  Required scopes: document:write
+     * Create a document. If the document is one of {'POINT_CLOUD', 'GLTF', 'IFC', 'DXF', 'OBJ', 'DWG'}, a model will be created and attached to this document  Required scopes: document:write
      * @param {Number} cloudPk A unique integer value identifying this cloud.
      * @param {Number} projectPk A unique integer value identifying this project.
      * @param {String} name Shown name of the file
diff --git a/src/model/DocumentText.js b/src/model/DocumentText.js
@@ -77,7 +77,7 @@ DocumentText.prototype['id'] = undefined;
 DocumentText.prototype['text'] = undefined;
 
 /**
- * * `german` - german * `french` - french * `spanish` - spanish * `italian` - italian * `english` - english
+ * * `french` - french * `spanish` - spanish * `german` - german * `italian` - italian * `english` - english
  * @member {module:model/DocumentText.LanguageEnum} language
  */
 DocumentText.prototype['language'] = undefined;
@@ -93,12 +93,6 @@ DocumentText.prototype['language'] = undefined;
  */
 DocumentText['LanguageEnum'] = {
 
-    /**
-     * value: "german"
-     * @const
-     */
-    "german": "german",
-
     /**
      * value: "french"
      * @const
@@ -111,6 +105,12 @@ DocumentText['LanguageEnum'] = {
      */
     "spanish": "spanish",
 
+    /**
+     * value: "german"
+     * @const
+     */
+    "german": "german",
+
     /**
      * value: "italian"
      * @const
diff --git a/src/model/FullTopic.js b/src/model/FullTopic.js
@@ -119,6 +119,9 @@ class FullTopic {
             if (data.hasOwnProperty('bimdata_viewer_layout')) {
                 obj['bimdata_viewer_layout'] = ApiClient.convertToType(data['bimdata_viewer_layout'], Object);
             }
+            if (data.hasOwnProperty('groups')) {
+                obj['groups'] = ApiClient.convertToType(data['groups'], ['Number']);
+            }
         }
         return obj;
     }
@@ -239,6 +242,11 @@ FullTopic.prototype['viewpoints'] = undefined;
  */
 FullTopic.prototype['bimdata_viewer_layout'] = undefined;
 
+/**
+ * @member {Array.<Number>} groups
+ */
+FullTopic.prototype['groups'] = undefined;
+
 
 
 
diff --git a/src/model/FullTopicRequest.js b/src/model/FullTopicRequest.js
@@ -114,6 +114,9 @@ class FullTopicRequest {
             if (data.hasOwnProperty('bimdata_viewer_layout')) {
                 obj['bimdata_viewer_layout'] = ApiClient.convertToType(data['bimdata_viewer_layout'], Object);
             }
+            if (data.hasOwnProperty('groups')) {
+                obj['groups'] = ApiClient.convertToType(data['groups'], ['Number']);
+            }
         }
         return obj;
     }
@@ -229,6 +232,11 @@ FullTopicRequest.prototype['viewpoints'] = undefined;
  */
 FullTopicRequest.prototype['bimdata_viewer_layout'] = undefined;
 
+/**
+ * @member {Array.<Number>} groups
+ */
+FullTopicRequest.prototype['groups'] = undefined;
+
 
 
 
diff --git a/src/model/PatchedDocumentTextRequest.js b/src/model/PatchedDocumentTextRequest.js
@@ -67,7 +67,7 @@ class PatchedDocumentTextRequest {
 PatchedDocumentTextRequest.prototype['text'] = undefined;
 
 /**
- * * `german` - german * `french` - french * `spanish` - spanish * `italian` - italian * `english` - english
+ * * `french` - french * `spanish` - spanish * `german` - german * `italian` - italian * `english` - english
  * @member {module:model/PatchedDocumentTextRequest.LanguageEnum} language
  */
 PatchedDocumentTextRequest.prototype['language'] = undefined;
@@ -83,12 +83,6 @@ PatchedDocumentTextRequest.prototype['language'] = undefined;
  */
 PatchedDocumentTextRequest['LanguageEnum'] = {
 
-    /**
-     * value: "german"
-     * @const
-     */
-    "german": "german",
-
     /**
      * value: "french"
      * @const
@@ -101,6 +95,12 @@ PatchedDocumentTextRequest['LanguageEnum'] = {
      */
     "spanish": "spanish",
 
+    /**
+     * value: "german"
+     * @const
+     */
+    "german": "german",
+
     /**
      * value: "italian"
      * @const
diff --git a/src/model/PatchedFullTopicRequest.js b/src/model/PatchedFullTopicRequest.js
@@ -112,6 +112,9 @@ class PatchedFullTopicRequest {
             if (data.hasOwnProperty('bimdata_viewer_layout')) {
                 obj['bimdata_viewer_layout'] = ApiClient.convertToType(data['bimdata_viewer_layout'], Object);
             }
+            if (data.hasOwnProperty('groups')) {
+                obj['groups'] = ApiClient.convertToType(data['groups'], ['Number']);
+            }
         }
         return obj;
     }
@@ -227,6 +230,11 @@ PatchedFullTopicRequest.prototype['viewpoints'] = undefined;
  */
 PatchedFullTopicRequest.prototype['bimdata_viewer_layout'] = undefined;
 
+/**
+ * @member {Array.<Number>} groups
+ */
+PatchedFullTopicRequest.prototype['groups'] = undefined;
+
 
 
 
diff --git a/src/model/PatchedTopicRequest.js b/src/model/PatchedTopicRequest.js
@@ -104,6 +104,9 @@ class PatchedTopicRequest {
             if (data.hasOwnProperty('bimdata_viewer_layout')) {
                 obj['bimdata_viewer_layout'] = ApiClient.convertToType(data['bimdata_viewer_layout'], Object);
             }
+            if (data.hasOwnProperty('groups')) {
+                obj['groups'] = ApiClient.convertToType(data['groups'], ['Number']);
+            }
         }
         return obj;
     }
@@ -209,6 +212,11 @@ PatchedTopicRequest.prototype['index'] = undefined;
  */
 PatchedTopicRequest.prototype['bimdata_viewer_layout'] = undefined;
 
+/**
+ * @member {Array.<Number>} groups
+ */
+PatchedTopicRequest.prototype['groups'] = undefined;
+
 
 
 
diff --git a/src/model/Topic.js b/src/model/Topic.js
@@ -111,6 +111,9 @@ class Topic {
             if (data.hasOwnProperty('bimdata_viewer_layout')) {
                 obj['bimdata_viewer_layout'] = ApiClient.convertToType(data['bimdata_viewer_layout'], Object);
             }
+            if (data.hasOwnProperty('groups')) {
+                obj['groups'] = ApiClient.convertToType(data['groups'], ['Number']);
+            }
         }
         return obj;
     }
@@ -221,6 +224,11 @@ Topic.prototype['index'] = undefined;
  */
 Topic.prototype['bimdata_viewer_layout'] = undefined;
 
+/**
+ * @member {Array.<Number>} groups
+ */
+Topic.prototype['groups'] = undefined;
+
 
 
 
diff --git a/src/model/TopicRequest.js b/src/model/TopicRequest.js
@@ -106,6 +106,9 @@ class TopicRequest {
             if (data.hasOwnProperty('bimdata_viewer_layout')) {
                 obj['bimdata_viewer_layout'] = ApiClient.convertToType(data['bimdata_viewer_layout'], Object);
             }
+            if (data.hasOwnProperty('groups')) {
+                obj['groups'] = ApiClient.convertToType(data['groups'], ['Number']);
+            }
         }
         return obj;
     }
@@ -211,6 +214,11 @@ TopicRequest.prototype['index'] = undefined;
  */
 TopicRequest.prototype['bimdata_viewer_layout'] = undefined;
 
+/**
+ * @member {Array.<Number>} groups
+ */
+TopicRequest.prototype['groups'] = undefined;
+
 
 
 
diff --git a/src/model/WriteFolder.js b/src/model/WriteFolder.js
diff --git a/src/model/WriteFolderRequest.js b/src/model/WriteFolderRequest.js
diff --git a/test/model/FullTopic.spec.js b/test/model/FullTopic.spec.js
diff --git a/test/model/FullTopicRequest.spec.js b/test/model/FullTopicRequest.spec.js
diff --git a/test/model/PatchedFullTopicRequest.spec.js b/test/model/PatchedFullTopicRequest.spec.js
diff --git a/test/model/PatchedTopicRequest.spec.js b/test/model/PatchedTopicRequest.spec.js
diff --git a/test/model/Topic.spec.js b/test/model/Topic.spec.js
diff --git a/test/model/TopicRequest.spec.js b/test/model/TopicRequest.spec.js
diff --git a/test/model/WriteFolder.spec.js b/test/model/WriteFolder.spec.js
diff --git a/test/model/WriteFolderRequest.spec.js b/test/model/WriteFolderRequest.spec.js
