Skip to content
This repository was archived by the owner on Nov 18, 2025. It is now read-only.

Commit 8a7a2d8

Browse files
Bimdata-ioBimdata-io
committed
PATCH: remove some useless field on dms-tree
1 parent 91a3b7a commit 8a7a2d8

34 files changed

+852
-102
lines changed

‎.openapi-generator/FILES‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
.gitignore
33
.travis.yml
44
README.md
5+
docs/Auth.md
56
docs/BcfApi.md
67
docs/BcfProject.md
78
docs/BcfProjectRequest.md
@@ -207,6 +208,7 @@ docs/RulesetRequest.md
207208
docs/SelectUserRequest.md
208209
docs/SelfBcfUser.md
209210
docs/SelfUser.md
211+
docs/ShortUser.md
210212
docs/SimpleElement.md
211213
docs/Size.md
212214
docs/Snapshot.md
@@ -236,6 +238,7 @@ docs/User.md
236238
docs/UserInvitation.md
237239
docs/UserProject.md
238240
docs/UserProjectIdRequest.md
241+
docs/Version.md
239242
docs/ViewSetupHints.md
240243
docs/ViewSetupHintsRequest.md
241244
docs/Viewpoint.md
@@ -267,6 +270,7 @@ src/api/ModelApi.js
267270
src/api/SsoApi.js
268271
src/api/WebhookApi.js
269272
src/index.js
273+
src/model/Auth.js
270274
src/model/BcfProject.js
271275
src/model/BcfProjectRequest.js
272276
src/model/Building.js
@@ -467,6 +471,7 @@ src/model/RulesetRequest.js
467471
src/model/SelectUserRequest.js
468472
src/model/SelfBcfUser.js
469473
src/model/SelfUser.js
474+
src/model/ShortUser.js
470475
src/model/SimpleElement.js
471476
src/model/Size.js
472477
src/model/Snapshot.js
@@ -495,6 +500,7 @@ src/model/User.js
495500
src/model/UserInvitation.js
496501
src/model/UserProject.js
497502
src/model/UserProjectIdRequest.js
503+
src/model/Version.js
498504
src/model/ViewSetupHints.js
499505
src/model/ViewSetupHintsRequest.js
500506
src/model/Viewpoint.js
@@ -521,6 +527,7 @@ test/api/IfcApi.spec.js
521527
test/api/ModelApi.spec.js
522528
test/api/SsoApi.spec.js
523529
test/api/WebhookApi.spec.js
530+
test/model/Auth.spec.js
524531
test/model/BcfProject.spec.js
525532
test/model/BcfProjectRequest.spec.js
526533
test/model/Building.spec.js
@@ -721,6 +728,7 @@ test/model/RulesetRequest.spec.js
721728
test/model/SelectUserRequest.spec.js
722729
test/model/SelfBcfUser.spec.js
723730
test/model/SelfUser.spec.js
731+
test/model/ShortUser.spec.js
724732
test/model/SimpleElement.spec.js
725733
test/model/Size.spec.js
726734
test/model/Snapshot.spec.js
@@ -749,6 +757,7 @@ test/model/User.spec.js
749757
test/model/UserInvitation.spec.js
750758
test/model/UserProject.spec.js
751759
test/model/UserProjectIdRequest.spec.js
760+
test/model/Version.spec.js
752761
test/model/ViewSetupHints.spec.js
753762
test/model/ViewSetupHintsRequest.spec.js
754763
test/model/Viewpoint.spec.js

‎README.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,7 @@ Class | Method | HTTP request | Description
164164
*bimdata.BcfApi* | [**fullUpdateFullTopic**](docs/BcfApi.md#fullUpdateFullTopic) | **PUT** /bcf/2.1/projects/{projects_pk}/full-topic/{guid} | Update all fields of a topic
165165
*bimdata.BcfApi* | [**fullUpdateTopic**](docs/BcfApi.md#fullUpdateTopic) | **PUT** /bcf/2.1/projects/{projects_pk}/topics/{guid} | Update all fields of a topic
166166
*bimdata.BcfApi* | [**fullUpdateViewpoint**](docs/BcfApi.md#fullUpdateViewpoint) | **PUT** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid} | Update all fields of a Viewpoint
167+
*bimdata.BcfApi* | [**getAuth**](docs/BcfApi.md#getAuth) | **GET** /bcf/2.1/auth | Retrieve Authentication Information
167168
*bimdata.BcfApi* | [**getBcfProject**](docs/BcfApi.md#getBcfProject) | **GET** /bcf/2.1/projects/{id} | Retrieve a BCF project
168169
*bimdata.BcfApi* | [**getBcfProjects**](docs/BcfApi.md#getBcfProjects) | **GET** /bcf/2.1/projects | Retrieve all BCF projects
169170
*bimdata.BcfApi* | [**getColorings**](docs/BcfApi.md#getColorings) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/coloring | Retrieve all colorings of a viewpoint
@@ -179,6 +180,7 @@ Class | Method | HTTP request | Description
179180
*bimdata.BcfApi* | [**getTopicViewpoints**](docs/BcfApi.md#getTopicViewpoints) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/topic-viewpoints | Retrieve all viewpoints attached to the topic
180181
*bimdata.BcfApi* | [**getTopics**](docs/BcfApi.md#getTopics) | **GET** /bcf/2.1/projects/{projects_pk}/topics | Retrieve all topics
181182
*bimdata.BcfApi* | [**getUser**](docs/BcfApi.md#getUser) | **GET** /bcf/2.1/current-user | Get current user info
183+
*bimdata.BcfApi* | [**getVersions**](docs/BcfApi.md#getVersions) | **GET** /bcf/versions | Retrieve all supported BCF versions by this API
182184
*bimdata.BcfApi* | [**getViewpoint**](docs/BcfApi.md#getViewpoint) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid} | Retrieve a Viewpoint
183185
*bimdata.BcfApi* | [**getViewpoints**](docs/BcfApi.md#getViewpoints) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints | Retrieve all Viewpoints of a topic
184186
*bimdata.BcfApi* | [**getVisibilities**](docs/BcfApi.md#getVisibilities) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/visibility | Retrieve all visibilities of a viewpoint
@@ -648,6 +650,7 @@ Class | Method | HTTP request | Description
648650

649651
## Documentation for Models
650652

653+
- [bimdata.Auth](docs/Auth.md)
651654
- [bimdata.BcfProject](docs/BcfProject.md)
652655
- [bimdata.BcfProjectRequest](docs/BcfProjectRequest.md)
653656
- [bimdata.Building](docs/Building.md)
@@ -848,6 +851,7 @@ Class | Method | HTTP request | Description
848851
- [bimdata.SelectUserRequest](docs/SelectUserRequest.md)
849852
- [bimdata.SelfBcfUser](docs/SelfBcfUser.md)
850853
- [bimdata.SelfUser](docs/SelfUser.md)
854+
- [bimdata.ShortUser](docs/ShortUser.md)
851855
- [bimdata.SimpleElement](docs/SimpleElement.md)
852856
- [bimdata.Size](docs/Size.md)
853857
- [bimdata.Snapshot](docs/Snapshot.md)
@@ -876,6 +880,7 @@ Class | Method | HTTP request | Description
876880
- [bimdata.UserInvitation](docs/UserInvitation.md)
877881
- [bimdata.UserProject](docs/UserProject.md)
878882
- [bimdata.UserProjectIdRequest](docs/UserProjectIdRequest.md)
883+
- [bimdata.Version](docs/Version.md)
879884
- [bimdata.ViewSetupHints](docs/ViewSetupHints.md)
880885
- [bimdata.ViewSetupHintsRequest](docs/ViewSetupHintsRequest.md)
881886
- [bimdata.Viewpoint](docs/Viewpoint.md)

‎docs/Auth.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# bimdata.Auth
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**oauth2AuthUrl** | **String** | | [readonly]
8+
**oauth2TokenUrl** | **String** | | [readonly]
9+
**httpBasicSupported** | **Boolean** | | [readonly]
10+
**supportedOauth2Flows** | **[String]** | | [readonly]
11+
12+

‎docs/BcfApi.md‎

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ Method | HTTP request | Description
2727
[**fullUpdateFullTopic**](BcfApi.md#fullUpdateFullTopic) | **PUT** /bcf/2.1/projects/{projects_pk}/full-topic/{guid} | Update all fields of a topic
2828
[**fullUpdateTopic**](BcfApi.md#fullUpdateTopic) | **PUT** /bcf/2.1/projects/{projects_pk}/topics/{guid} | Update all fields of a topic
2929
[**fullUpdateViewpoint**](BcfApi.md#fullUpdateViewpoint) | **PUT** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid} | Update all fields of a Viewpoint
30+
[**getAuth**](BcfApi.md#getAuth) | **GET** /bcf/2.1/auth | Retrieve Authentication Information
3031
[**getBcfProject**](BcfApi.md#getBcfProject) | **GET** /bcf/2.1/projects/{id} | Retrieve a BCF project
3132
[**getBcfProjects**](BcfApi.md#getBcfProjects) | **GET** /bcf/2.1/projects | Retrieve all BCF projects
3233
[**getColorings**](BcfApi.md#getColorings) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/coloring | Retrieve all colorings of a viewpoint
@@ -42,6 +43,7 @@ Method | HTTP request | Description
4243
[**getTopicViewpoints**](BcfApi.md#getTopicViewpoints) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/topic-viewpoints | Retrieve all viewpoints attached to the topic
4344
[**getTopics**](BcfApi.md#getTopics) | **GET** /bcf/2.1/projects/{projects_pk}/topics | Retrieve all topics
4445
[**getUser**](BcfApi.md#getUser) | **GET** /bcf/2.1/current-user | Get current user info
46+
[**getVersions**](BcfApi.md#getVersions) | **GET** /bcf/versions | Retrieve all supported BCF versions by this API
4547
[**getViewpoint**](BcfApi.md#getViewpoint) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid} | Retrieve a Viewpoint
4648
[**getViewpoints**](BcfApi.md#getViewpoints) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints | Retrieve all Viewpoints of a topic
4749
[**getVisibilities**](BcfApi.md#getVisibilities) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/visibility | Retrieve all visibilities of a viewpoint
@@ -1574,6 +1576,63 @@ Name | Type | Description | Notes
15741576
- **Accept**: application/json
15751577

15761578

1579+
## getAuth
1580+
1581+
> [Auth] getAuth()
1582+
1583+
Retrieve Authentication Information
1584+
1585+
oauth2_dynamic_client_reg_url is not supported, http_basic_supported is always set to false,
1586+
1587+
### Example
1588+
1589+
```javascript
1590+
import bimdata from '@bimdata/bimdata-api-client';
1591+
let defaultClient = bimdata.ApiClient.instance;
1592+
// Configure API key authorization: ApiKey
1593+
let ApiKey = defaultClient.authentications['ApiKey'];
1594+
ApiKey.apiKey = 'YOUR API KEY';
1595+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1596+
//ApiKey.apiKeyPrefix = 'Token';
1597+
// Configure OAuth2 access token for authorization: BIMData_Connect
1598+
let BIMData_Connect = defaultClient.authentications['BIMData_Connect'];
1599+
BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN';
1600+
// Configure OAuth2 access token for authorization: BIMData_Connect
1601+
let BIMData_Connect = defaultClient.authentications['BIMData_Connect'];
1602+
BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN';
1603+
// Configure API key authorization: Bearer
1604+
let Bearer = defaultClient.authentications['Bearer'];
1605+
Bearer.apiKey = 'YOUR API KEY';
1606+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
1607+
//Bearer.apiKeyPrefix = 'Token';
1608+
1609+
let apiInstance = new bimdata.BcfApi();
1610+
apiInstance.getAuth().then((data) => {
1611+
console.log('API called successfully. Returned data: ' + data);
1612+
}, (error) => {
1613+
console.error(error);
1614+
});
1615+
1616+
```
1617+
1618+
### Parameters
1619+
1620+
This endpoint does not need any parameter.
1621+
1622+
### Return type
1623+
1624+
[**[Auth]**](Auth.md)
1625+
1626+
### Authorization
1627+
1628+
[ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer)
1629+
1630+
### HTTP request headers
1631+
1632+
- **Content-Type**: Not defined
1633+
- **Accept**: application/json
1634+
1635+
15771636
## getBcfProject
15781637

15791638
> BcfProject getBcfProject(id)
@@ -2531,6 +2590,63 @@ This endpoint does not need any parameter.
25312590
- **Accept**: application/json
25322591

25332592

2593+
## getVersions
2594+
2595+
> [Version] getVersions()
2596+
2597+
Retrieve all supported BCF versions by this API
2598+
2599+
Spoiler: it's only v2.1
2600+
2601+
### Example
2602+
2603+
```javascript
2604+
import bimdata from '@bimdata/bimdata-api-client';
2605+
let defaultClient = bimdata.ApiClient.instance;
2606+
// Configure API key authorization: ApiKey
2607+
let ApiKey = defaultClient.authentications['ApiKey'];
2608+
ApiKey.apiKey = 'YOUR API KEY';
2609+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2610+
//ApiKey.apiKeyPrefix = 'Token';
2611+
// Configure OAuth2 access token for authorization: BIMData_Connect
2612+
let BIMData_Connect = defaultClient.authentications['BIMData_Connect'];
2613+
BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN';
2614+
// Configure OAuth2 access token for authorization: BIMData_Connect
2615+
let BIMData_Connect = defaultClient.authentications['BIMData_Connect'];
2616+
BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN';
2617+
// Configure API key authorization: Bearer
2618+
let Bearer = defaultClient.authentications['Bearer'];
2619+
Bearer.apiKey = 'YOUR API KEY';
2620+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2621+
//Bearer.apiKeyPrefix = 'Token';
2622+
2623+
let apiInstance = new bimdata.BcfApi();
2624+
apiInstance.getVersions().then((data) => {
2625+
console.log('API called successfully. Returned data: ' + data);
2626+
}, (error) => {
2627+
console.error(error);
2628+
});
2629+
2630+
```
2631+
2632+
### Parameters
2633+
2634+
This endpoint does not need any parameter.
2635+
2636+
### Return type
2637+
2638+
[**[Version]**](Version.md)
2639+
2640+
### Authorization
2641+
2642+
[ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer)
2643+
2644+
### HTTP request headers
2645+
2646+
- **Content-Type**: Not defined
2647+
- **Accept**: application/json
2648+
2649+
25342650
## getViewpoint
25352651

25362652
> Viewpoint getViewpoint(guid, projectsPk, topicsGuid, opts)

‎docs/CollaborationApi.md‎

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

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

963963
### Example
964964

‎docs/Folder.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
1111
**name** | **String** | Name of the folder |
1212
**createdAt** | **Date** | Creation date | [readonly]
1313
**updatedAt** | **Date** | Date of the last update | [readonly]
14-
**createdBy** | [**User**](User.md) | | [readonly]
14+
**createdBy** | [**ShortUser**](ShortUser.md) | | [readonly]
1515
**groupsPermissions** | [**[FolderGroupPermission]**](FolderGroupPermission.md) | | [readonly]
1616
**defaultPermission** | **Number** | Permission for a Folder | [optional]
1717
**userPermission** | **Number** | Aggregate of group user permissions and folder default permission | [readonly]

‎docs/FolderWithoutChildren.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
1111
**name** | **String** | Name of the folder |
1212
**createdAt** | **Date** | Creation date | [readonly]
1313
**updatedAt** | **Date** | Date of the last update | [readonly]
14-
**createdBy** | [**User**](User.md) | | [readonly]
14+
**createdBy** | [**ShortUser**](ShortUser.md) | | [readonly]
1515
**groupsPermissions** | [**[FolderGroupPermission]**](FolderGroupPermission.md) | | [readonly]
1616
**defaultPermission** | **Number** | Permission for a Folder | [optional]
1717
**userPermission** | **Number** | Aggregate of group user permissions and folder default permission | [readonly]

‎docs/IfcApi.md‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9882,8 +9882,6 @@ let opts = {
98829882
'systemsFile': "/path/to/file", // File |
98839883
'mapFile': "/path/to/file", // File |
98849884
'gltfFile': "/path/to/file", // File |
9885-
'gltfWithOpeningsFile': "/path/to/file", // File |
9886-
'bvhTreeFile': "/path/to/file", // File |
98879885
'previewFile': "/path/to/file", // File |
98889886
'xktFile': "/path/to/file" // File |
98899887
};
@@ -9907,8 +9905,6 @@ Name | Type | Description | Notes
99079905
**systemsFile** | **File**| | [optional]
99089906
**mapFile** | **File**| | [optional]
99099907
**gltfFile** | **File**| | [optional]
9910-
**gltfWithOpeningsFile** | **File**| | [optional]
9911-
**bvhTreeFile** | **File**| | [optional]
99129908
**previewFile** | **File**| | [optional]
99139909
**xktFile** | **File**| | [optional]
99149910

‎docs/Model.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ Name | Type | Description | Notes
1818
**systemsFile** | **String** | | [readonly]
1919
**mapFile** | **String** | | [readonly]
2020
**gltfFile** | **String** | | [readonly]
21-
**bvhTreeFile** | **String** | | [readonly]
2221
**previewFile** | **String** | | [readonly]
2322
**viewer360File** | **String** | DEPRECATED: Use 'preview_file' instead. | [readonly]
2423
**xktFile** | **String** | | [readonly]

‎docs/ModelApi.md‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9175,8 +9175,6 @@ let opts = {
91759175
'systemsFile': "/path/to/file", // File |
91769176
'mapFile': "/path/to/file", // File |
91779177
'gltfFile': "/path/to/file", // File |
9178-
'gltfWithOpeningsFile': "/path/to/file", // File |
9179-
'bvhTreeFile': "/path/to/file", // File |
91809178
'previewFile': "/path/to/file", // File |
91819179
'xktFile': "/path/to/file" // File |
91829180
};
@@ -9200,8 +9198,6 @@ Name | Type | Description | Notes
92009198
**systemsFile** | **File**| | [optional]
92019199
**mapFile** | **File**| | [optional]
92029200
**gltfFile** | **File**| | [optional]
9203-
**gltfWithOpeningsFile** | **File**| | [optional]
9204-
**bvhTreeFile** | **File**| | [optional]
92059201
**previewFile** | **File**| | [optional]
92069202
**xktFile** | **File**| | [optional]
92079203

0 commit comments

Comments
 (0)