MINOR: Add color validator where it's possible. (#874)

Bimdata-io · Bimdata-io · commit 1d9589d700f8 · 2025-07-04T10:56:36.000Z
diff --git a/docs/CollaborationApi.md b/docs/CollaborationApi.md
@@ -882,7 +882,7 @@ Name | Type | Description  | Notes
 
 Create a document
 
-Create a document. If the document is one of {&#39;POINT_CLOUD&#39;, &#39;OBJ&#39;, &#39;DXF&#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;OBJ&#39;, &#39;DWG&#39;, &#39;IFC&#39;, &#39;GLTF&#39;, &#39;POINT_CLOUD&#39;, &#39;DXF&#39;}, a model will be created and attached to this document  Required scopes: document:write
 
 ### Example
 
diff --git a/docs/PatchedPinRequest.md b/docs/PatchedPinRequest.md
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **guid** | **String** |  | [optional] 
 **name** | **String** |  | [optional] 
-**color** | **String** |  | [optional] 
+**color** | **String** |              Color of the pin in hexadecimal string without the &#39;#&#39; prefix.             Example: &#39;fff&#39;, &#39;fff0&#39;, &#39;0f0f0f&#39;, &#39;0f0f0f00&#39;.          | [optional] 
 **point** | [**GeometryPointRequest**](GeometryPointRequest.md) |  | [optional] 
 **index** | **Number** |  | [optional] 
 
diff --git a/docs/PatchedPriorityRequest.md b/docs/PatchedPriorityRequest.md
@@ -5,6 +5,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **priority** | **String** |  | [optional] 
-**color** | **String** |  | [optional] 
+**color** | **String** |              Color of the priority in hexadecimal string without the &#39;#&#39; prefix.             Example: &#39;fff&#39;, &#39;fff0&#39;, &#39;0f0f0f&#39;, &#39;0f0f0f00&#39;.          | [optional] 
 
 
diff --git a/docs/PatchedTagRequest.md b/docs/PatchedTagRequest.md
@@ -5,6 +5,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | Full name of the tags | [optional] 
-**color** | **String** |  | [optional] 
+**color** | **String** |              Color of the Tag status in hexadecimal string without the &#39;#&#39; prefix.             Example: &#39;fff&#39;, &#39;fff0&#39;, &#39;0f0f0f&#39;, &#39;0f0f0f00&#39;.          | [optional] 
 
 
diff --git a/docs/PatchedTopicStatusRequest.md b/docs/PatchedTopicStatusRequest.md
@@ -5,6 +5,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **topicStatus** | **String** |  | [optional] 
-**color** | **String** |  | [optional] 
+**color** | **String** |              Color of the topic status in hexadecimal string without the &#39;#&#39; prefix.             Example: &#39;fff&#39;, &#39;fff0&#39;, &#39;0f0f0f&#39;, &#39;0f0f0f00&#39;.          | [optional] 
 
 
diff --git a/docs/Pin.md b/docs/Pin.md
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **guid** | **String** |  | [optional] 
 **name** | **String** |  | [optional] 
-**color** | **String** |  | [optional] 
+**color** | **String** |              Color of the pin in hexadecimal string without the &#39;#&#39; prefix.             Example: &#39;fff&#39;, &#39;fff0&#39;, &#39;0f0f0f&#39;, &#39;0f0f0f00&#39;.          | [optional] 
 **point** | [**GeometryPoint**](GeometryPoint.md) |  | 
 **index** | **Number** |  | [optional] 
 
diff --git a/docs/PinRequest.md b/docs/PinRequest.md
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **guid** | **String** |  | [optional] 
 **name** | **String** |  | [optional] 
-**color** | **String** |  | [optional] 
+**color** | **String** |              Color of the pin in hexadecimal string without the &#39;#&#39; prefix.             Example: &#39;fff&#39;, &#39;fff0&#39;, &#39;0f0f0f&#39;, &#39;0f0f0f00&#39;.          | [optional] 
 **point** | [**GeometryPointRequest**](GeometryPointRequest.md) |  | 
 **index** | **Number** |  | [optional] 
 
diff --git a/docs/PinWithModels.md b/docs/PinWithModels.md
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **guid** | **String** |  | [readonly] 
 **name** | **String** |  | [readonly] 
-**color** | **String** |  | [readonly] 
+**color** | **String** |              Color of the pin in hexadecimal string without the &#39;#&#39; prefix.             Example: &#39;fff&#39;, &#39;fff0&#39;, &#39;0f0f0f&#39;, &#39;0f0f0f00&#39;.          | [readonly] 
 **point** | [**GeometryPoint**](GeometryPoint.md) |  | 
 **index** | **Number** |  | [readonly] 
 **modelIds** | **[Number]** |  | [readonly] 
diff --git a/docs/Priority.md b/docs/Priority.md
@@ -6,6 +6,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Number** |  | [readonly] 
 **priority** | **String** |  | 
-**color** | **String** |  | [optional] 
+**color** | **String** |              Color of the priority in hexadecimal string without the &#39;#&#39; prefix.             Example: &#39;fff&#39;, &#39;fff0&#39;, &#39;0f0f0f&#39;, &#39;0f0f0f00&#39;.          | [optional] 
 
 
diff --git a/docs/PriorityRequest.md b/docs/PriorityRequest.md
@@ -5,6 +5,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **priority** | **String** |  | 
-**color** | **String** |  | [optional] 
+**color** | **String** |              Color of the priority in hexadecimal string without the &#39;#&#39; prefix.             Example: &#39;fff&#39;, &#39;fff0&#39;, &#39;0f0f0f&#39;, &#39;0f0f0f00&#39;.          | [optional] 
 
 
diff --git a/docs/Tag.md b/docs/Tag.md
@@ -6,6 +6,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Number** |  | [readonly] 
 **name** | **String** | Full name of the tags | 
-**color** | **String** |  | [optional] 
+**color** | **String** |              Color of the Tag status in hexadecimal string without the &#39;#&#39; prefix.             Example: &#39;fff&#39;, &#39;fff0&#39;, &#39;0f0f0f&#39;, &#39;0f0f0f00&#39;.          | [optional] 
 
 
diff --git a/docs/TagRequest.md b/docs/TagRequest.md
@@ -5,6 +5,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | Full name of the tags | 
-**color** | **String** |  | [optional] 
+**color** | **String** |              Color of the Tag status in hexadecimal string without the &#39;#&#39; prefix.             Example: &#39;fff&#39;, &#39;fff0&#39;, &#39;0f0f0f&#39;, &#39;0f0f0f00&#39;.          | [optional] 
 
 
diff --git a/docs/TopicStatus.md b/docs/TopicStatus.md
@@ -6,6 +6,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Number** |  | [readonly] 
 **topicStatus** | **String** |  | 
-**color** | **String** |  | [optional] 
+**color** | **String** |              Color of the topic status in hexadecimal string without the &#39;#&#39; prefix.             Example: &#39;fff&#39;, &#39;fff0&#39;, &#39;0f0f0f&#39;, &#39;0f0f0f00&#39;.          | [optional] 
 
 
diff --git a/docs/TopicStatusRequest.md b/docs/TopicStatusRequest.md
@@ -5,6 +5,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **topicStatus** | **String** |  | 
-**color** | **String** |  | [optional] 
+**color** | **String** |              Color of the topic status in hexadecimal string without the &#39;#&#39; prefix.             Example: &#39;fff&#39;, &#39;fff0&#39;, &#39;0f0f0f&#39;, &#39;0f0f0f00&#39;.          | [optional] 
 
 
diff --git a/docs/WriteFolder.md b/docs/WriteFolder.md
@@ -4,17 +4,17 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**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] 
+**updatedAt** | **Date** | Date of the last update | [readonly] 
 **defaultPermission** | **Number** | Permission for a Folder  * &#x60;1&#x60; - denied * &#x60;50&#x60; - read_only * &#x60;100&#x60; - read_write | [optional] 
-**name** | **String** | Name of the folder | 
-**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] 
-**id** | **Number** |  | [readonly] 
 **parentId** | **Number** |  | [optional] 
-**updatedAt** | **Date** | Date of the last update | [readonly] 
 **groupsPermissions** | [**[GroupFolderRead]**](GroupFolderRead.md) | List of group permissions | [readonly] 
-**createdBy** | [**ShortUser**](ShortUser.md) |  | [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 | 
+**id** | **Number** |  | [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] 
 **userPermission** | **Number** | Aggregate of group user permissions and folder default permission | [readonly] 
+**createdAt** | **Date** | Creation date | [readonly] 
+**createdBy** | [**ShortUser**](ShortUser.md) |  | [readonly] 
 **children** | [**[WriteFolder]**](WriteFolder.md) |  | [optional] 
 
 
diff --git a/docs/WriteFolderRequest.md b/docs/WriteFolderRequest.md
@@ -5,8 +5,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **defaultPermission** | **Number** | Permission for a Folder  * &#x60;1&#x60; - denied * &#x60;50&#x60; - read_only * &#x60;100&#x60; - read_write | [optional] 
-**name** | **String** | Name of the folder | 
 **parentId** | **Number** |  | [optional] 
+**name** | **String** | Name of the folder | 
 **children** | [**[WriteFolder]**](WriteFolder.md) |  | [optional] 
 
 
diff --git a/src/api/CollaborationApi.js b/src/api/CollaborationApi.js
@@ -866,7 +866,7 @@ export default class CollaborationApi {
 
     /**
      * Create a document
-     * Create a document. If the document is one of {'POINT_CLOUD', 'OBJ', 'DXF', '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 {'OBJ', 'DWG', 'IFC', 'GLTF', 'POINT_CLOUD', 'DXF'}, 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
@@ -934,7 +934,7 @@ export default class CollaborationApi {
 
     /**
      * Create a document
-     * Create a document. If the document is one of {'POINT_CLOUD', 'OBJ', 'DXF', '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 {'OBJ', 'DWG', 'IFC', 'GLTF', 'POINT_CLOUD', 'DXF'}, 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/PatchedPinRequest.js b/src/model/PatchedPinRequest.js
@@ -81,6 +81,7 @@ PatchedPinRequest.prototype['guid'] = undefined;
 PatchedPinRequest.prototype['name'] = undefined;
 
 /**
+ *              Color of the pin in hexadecimal string without the '#' prefix.             Example: 'fff', 'fff0', '0f0f0f', '0f0f0f00'.         
  * @member {String} color
  */
 PatchedPinRequest.prototype['color'] = undefined;
diff --git a/src/model/PatchedPriorityRequest.js b/src/model/PatchedPriorityRequest.js
@@ -66,6 +66,7 @@ class PatchedPriorityRequest {
 PatchedPriorityRequest.prototype['priority'] = undefined;
 
 /**
+ *              Color of the priority in hexadecimal string without the '#' prefix.             Example: 'fff', 'fff0', '0f0f0f', '0f0f0f00'.         
  * @member {String} color
  */
 PatchedPriorityRequest.prototype['color'] = undefined;
diff --git a/src/model/PatchedTagRequest.js b/src/model/PatchedTagRequest.js
@@ -67,6 +67,7 @@ class PatchedTagRequest {
 PatchedTagRequest.prototype['name'] = undefined;
 
 /**
+ *              Color of the Tag status in hexadecimal string without the '#' prefix.             Example: 'fff', 'fff0', '0f0f0f', '0f0f0f00'.         
  * @member {String} color
  */
 PatchedTagRequest.prototype['color'] = undefined;
diff --git a/src/model/PatchedTopicStatusRequest.js b/src/model/PatchedTopicStatusRequest.js
@@ -66,6 +66,7 @@ class PatchedTopicStatusRequest {
 PatchedTopicStatusRequest.prototype['topic_status'] = undefined;
 
 /**
+ *              Color of the topic status in hexadecimal string without the '#' prefix.             Example: 'fff', 'fff0', '0f0f0f', '0f0f0f00'.         
  * @member {String} color
  */
 PatchedTopicStatusRequest.prototype['color'] = undefined;
diff --git a/src/model/Pin.js b/src/model/Pin.js
@@ -83,6 +83,7 @@ Pin.prototype['guid'] = undefined;
 Pin.prototype['name'] = undefined;
 
 /**
+ *              Color of the pin in hexadecimal string without the '#' prefix.             Example: 'fff', 'fff0', '0f0f0f', '0f0f0f00'.         
  * @member {String} color
  */
 Pin.prototype['color'] = undefined;
diff --git a/src/model/PinRequest.js b/src/model/PinRequest.js
@@ -83,6 +83,7 @@ PinRequest.prototype['guid'] = undefined;
 PinRequest.prototype['name'] = undefined;
 
 /**
+ *              Color of the pin in hexadecimal string without the '#' prefix.             Example: 'fff', 'fff0', '0f0f0f', '0f0f0f00'.         
  * @member {String} color
  */
 PinRequest.prototype['color'] = undefined;
diff --git a/src/model/PinWithModels.js b/src/model/PinWithModels.js
@@ -25,7 +25,7 @@ class PinWithModels {
      * @alias module:model/PinWithModels
      * @param guid {String} 
      * @param name {String} 
-     * @param color {String} 
+     * @param color {String}              Color of the pin in hexadecimal string without the '#' prefix.             Example: 'fff', 'fff0', '0f0f0f', '0f0f0f00'.         
      * @param point {module:model/GeometryPoint} 
      * @param index {Number} 
      * @param modelIds {Array.<Number>} 
@@ -96,6 +96,7 @@ PinWithModels.prototype['guid'] = undefined;
 PinWithModels.prototype['name'] = undefined;
 
 /**
+ *              Color of the pin in hexadecimal string without the '#' prefix.             Example: 'fff', 'fff0', '0f0f0f', '0f0f0f00'.         
  * @member {String} color
  */
 PinWithModels.prototype['color'] = undefined;
diff --git a/src/model/Priority.js b/src/model/Priority.js
@@ -78,6 +78,7 @@ Priority.prototype['id'] = undefined;
 Priority.prototype['priority'] = undefined;
 
 /**
+ *              Color of the priority in hexadecimal string without the '#' prefix.             Example: 'fff', 'fff0', '0f0f0f', '0f0f0f00'.         
  * @member {String} color
  */
 Priority.prototype['color'] = undefined;
diff --git a/src/model/PriorityRequest.js b/src/model/PriorityRequest.js
@@ -68,6 +68,7 @@ class PriorityRequest {
 PriorityRequest.prototype['priority'] = undefined;
 
 /**
+ *              Color of the priority in hexadecimal string without the '#' prefix.             Example: 'fff', 'fff0', '0f0f0f', '0f0f0f00'.         
  * @member {String} color
  */
 PriorityRequest.prototype['color'] = undefined;
diff --git a/src/model/Tag.js b/src/model/Tag.js
@@ -79,6 +79,7 @@ Tag.prototype['id'] = undefined;
 Tag.prototype['name'] = undefined;
 
 /**
+ *              Color of the Tag status in hexadecimal string without the '#' prefix.             Example: 'fff', 'fff0', '0f0f0f', '0f0f0f00'.         
  * @member {String} color
  */
 Tag.prototype['color'] = undefined;
diff --git a/src/model/TagRequest.js b/src/model/TagRequest.js
@@ -69,6 +69,7 @@ class TagRequest {
 TagRequest.prototype['name'] = undefined;
 
 /**
+ *              Color of the Tag status in hexadecimal string without the '#' prefix.             Example: 'fff', 'fff0', '0f0f0f', '0f0f0f00'.         
  * @member {String} color
  */
 TagRequest.prototype['color'] = undefined;
diff --git a/src/model/TopicStatus.js b/src/model/TopicStatus.js
@@ -78,6 +78,7 @@ TopicStatus.prototype['id'] = undefined;
 TopicStatus.prototype['topic_status'] = undefined;
 
 /**
+ *              Color of the topic status in hexadecimal string without the '#' prefix.             Example: 'fff', 'fff0', '0f0f0f', '0f0f0f00'.         
  * @member {String} color
  */
 TopicStatus.prototype['color'] = undefined;
diff --git a/src/model/TopicStatusRequest.js b/src/model/TopicStatusRequest.js
@@ -68,6 +68,7 @@ class TopicStatusRequest {
 TopicStatusRequest.prototype['topic_status'] = undefined;
 
 /**
+ *              Color of the topic status in hexadecimal string without the '#' prefix.             Example: 'fff', 'fff0', '0f0f0f', '0f0f0f00'.         
  * @member {String} color
  */
 TopicStatusRequest.prototype['color'] = 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/WriteFolder.spec.js b/test/model/WriteFolder.spec.js
diff --git a/test/model/WriteFolderRequest.spec.js b/test/model/WriteFolderRequest.spec.js
