Skip to content

Commit de83c64

Browse files
Bimdata-ioBimdata-io
committed
MINOR: remove some document fields in model.document serialization
* improve storey performances * add comments
1 parent b2cbf9a commit de83c64

18 files changed

+686
-29
lines changed

‎.openapi-generator/FILES

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,8 @@ docs/MaterialOption.md
8787
docs/MaterialRequest.md
8888
docs/Model.md
8989
docs/ModelApi.md
90+
docs/ModelDocument.md
91+
docs/ModelDocumentRequest.md
9092
docs/ModelErrors.md
9193
docs/ModelErrorsRequest.md
9294
docs/ModelFiles.md
@@ -341,6 +343,8 @@ src/model/MaterialListComponentRequest.js
341343
src/model/MaterialOption.js
342344
src/model/MaterialRequest.js
343345
src/model/Model.js
346+
src/model/ModelDocument.js
347+
src/model/ModelDocumentRequest.js
344348
src/model/ModelErrors.js
345349
src/model/ModelErrorsRequest.js
346350
src/model/ModelFiles.js
@@ -589,6 +593,8 @@ test/model/MaterialListComponentRequest.spec.js
589593
test/model/MaterialOption.spec.js
590594
test/model/MaterialRequest.spec.js
591595
test/model/Model.spec.js
596+
test/model/ModelDocument.spec.js
597+
test/model/ModelDocumentRequest.spec.js
592598
test/model/ModelErrors.spec.js
593599
test/model/ModelErrorsRequest.spec.js
594600
test/model/ModelFiles.spec.js

‎README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -564,6 +564,8 @@ Class | Method | HTTP request | Description
564564
- [bimdata.MaterialOption](docs/MaterialOption.md)
565565
- [bimdata.MaterialRequest](docs/MaterialRequest.md)
566566
- [bimdata.Model](docs/Model.md)
567+
- [bimdata.ModelDocument](docs/ModelDocument.md)
568+
- [bimdata.ModelDocumentRequest](docs/ModelDocumentRequest.md)
567569
- [bimdata.ModelErrors](docs/ModelErrors.md)
568570
- [bimdata.ModelErrorsRequest](docs/ModelErrorsRequest.md)
569571
- [bimdata.ModelFiles](docs/ModelFiles.md)

‎docs/CollaborationApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -960,7 +960,7 @@ Name | Type | Description | Notes
960960
961961
Create a document
962962

963-
Create a document. If the document is one of {'OBJ', 'IFC', 'GLTF', 'DXF', 'POINT_CLOUD', 'DWG'}, a model will be created and attached to this document Required scopes: document:write
963+
Create a document. If the document is one of {'DXF', 'GLTF', 'POINT_CLOUD', 'OBJ', 'DWG', 'IFC'}, a model will be created and attached to this document Required scopes: document:write
964964

965965
### Example
966966

‎docs/Model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
1313
**createdAt** | **Date** | | [readonly]
1414
**updatedAt** | **Date** | | [readonly]
1515
**documentId** | **Number** | | [readonly]
16-
**document** | [**Document**](Document.md) | | [readonly]
16+
**document** | [**ModelDocument**](ModelDocument.md) | | [readonly]
1717
**structureFile** | **String** | | [readonly]
1818
**systemsFile** | **String** | | [readonly]
1919
**mapFile** | **String** | | [readonly]

‎docs/ModelDocument.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# bimdata.ModelDocument
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**id** | **Number** | | [readonly]
8+
**name** | **String** | Shown name of the file |
9+
**fileName** | **String** | Full name of the file | [optional]
10+
**description** | **String** | Description of the file | [optional]
11+
**file** | **String** | |
12+
**size** | **Number** | Size of the file. | [readonly]
13+
**createdAt** | **Date** | Creation date | [readonly]
14+
**updatedAt** | **Date** | Date of the last update | [readonly]
15+
**headId** | **Number** | Document id of head version | [readonly]
16+
**isHeadVersion** | **Boolean** | Document is a head of version or is owned by another document | [readonly]
17+
**historyCount** | **Number** | Number of previous versions | [readonly]
18+
**userPermission** | **Number** | Aggregate of group user permissions and folder default permission | [readonly]
19+
**officePreview** | **String** | Office files will be converted as pdf to provide a web preview. Supported extensions are .ppt, .pptx, .odp, .xls, .xlsx, .ods, .doc, .docx, .odt | [readonly]
20+
21+
22+
23+
## Enum: UserPermissionEnum
24+
25+
26+
* `1` (value: `1`)
27+
28+
* `50` (value: `50`)
29+
30+
* `100` (value: `100`)
31+
32+
33+
34+

‎docs/ModelDocumentRequest.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# bimdata.ModelDocumentRequest
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**name** | **String** | Shown name of the file |
8+
**fileName** | **String** | Full name of the file | [optional]
9+
**description** | **String** | Description of the file | [optional]
10+
**file** | **File** | |
11+
**processHint** | **String** | Provide a info about the document in order to customize the way it is processed. * `PHOTOSPHERE` - PHOTOSPHERE | [optional]
12+
13+
14+
15+
## Enum: ProcessHintEnum
16+
17+
18+
* `PHOTOSPHERE` (value: `"PHOTOSPHERE"`)
19+
20+
21+
22+

‎docs/ModelSerializerWithoutChildren.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
1313
**createdAt** | **Date** | | [readonly]
1414
**updatedAt** | **Date** | | [readonly]
1515
**documentId** | **Number** | | [readonly]
16-
**document** | [**Document**](Document.md) | | [readonly]
16+
**document** | [**ModelDocument**](ModelDocument.md) | | [readonly]
1717
**structureFile** | **String** | | [readonly]
1818
**systemsFile** | **String** | | [readonly]
1919
**mapFile** | **String** | | [readonly]

‎docs/WriteFolderRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**name** | **String** | Name of the folder |
87
**defaultPermission** | **Number** | Permission for a Folder * `1` - denied * `50` - read_only * `100` - read_write | [optional]
98
**parentId** | **Number** | | [optional]
9+
**name** | **String** | Name of the folder |
1010
**children** | [**[WriteFolderRequest]**](WriteFolderRequest.md) | | [optional]
1111

1212

‎src/api/CollaborationApi.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -866,7 +866,7 @@ export default class CollaborationApi {
866866

867867
/**
868868
* Create a document
869-
* Create a document. If the document is one of {'OBJ', 'IFC', 'GLTF', 'DXF', 'POINT_CLOUD', 'DWG'}, a model will be created and attached to this document Required scopes: document:write
869+
* Create a document. If the document is one of {'DXF', 'GLTF', 'POINT_CLOUD', 'OBJ', 'DWG', 'IFC'}, a model will be created and attached to this document Required scopes: document:write
870870
* @param {Number} cloudPk A unique integer value identifying this cloud.
871871
* @param {Number} projectPk A unique integer value identifying this project.
872872
* @param {String} name Shown name of the file
@@ -934,7 +934,7 @@ export default class CollaborationApi {
934934

935935
/**
936936
* Create a document
937-
* Create a document. If the document is one of {'OBJ', 'IFC', 'GLTF', 'DXF', 'POINT_CLOUD', 'DWG'}, a model will be created and attached to this document Required scopes: document:write
937+
* Create a document. If the document is one of {'DXF', 'GLTF', 'POINT_CLOUD', 'OBJ', 'DWG', 'IFC'}, a model will be created and attached to this document Required scopes: document:write
938938
* @param {Number} cloudPk A unique integer value identifying this cloud.
939939
* @param {Number} projectPk A unique integer value identifying this project.
940940
* @param {String} name Shown name of the file

‎src/index.js

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,8 @@ import MaterialListComponentRequest from './model/MaterialListComponentRequest';
9595
import MaterialOption from './model/MaterialOption';
9696
import MaterialRequest from './model/MaterialRequest';
9797
import Model from './model/Model';
98+
import ModelDocument from './model/ModelDocument';
99+
import ModelDocumentRequest from './model/ModelDocumentRequest';
98100
import ModelErrors from './model/ModelErrors';
99101
import ModelErrorsRequest from './model/ModelErrorsRequest';
100102
import ModelFiles from './model/ModelFiles';
@@ -793,6 +795,18 @@ export {
793795
*/
794796
Model,
795797

798+
/**
799+
* The ModelDocument model constructor.
800+
* @property {module:model/ModelDocument}
801+
*/
802+
ModelDocument,
803+
804+
/**
805+
* The ModelDocumentRequest model constructor.
806+
* @property {module:model/ModelDocumentRequest}
807+
*/
808+
ModelDocumentRequest,
809+
796810
/**
797811
* The ModelErrors model constructor.
798812
* @property {module:model/ModelErrors}

0 commit comments

Comments
 (0)