Skip to content

Commit 2e2726c

Browse files
committed
PATCH: fix openAPI definition of getProjectFolderTree
1 parent b79730b commit 2e2726c

File tree

4 files changed

+7
-128
lines changed

4 files changed

+7
-128
lines changed

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,6 @@ Class | Method | HTTP request | Description
268268
*bimdata.CollaborationApi* | [**getProjectCreatorVisas**](docs/CollaborationApi.md#getProjectCreatorVisas) | **GET** /cloud/{cloud_pk}/project/{project_pk}/me/visa/creator | List visas created by user
269269
*bimdata.CollaborationApi* | [**getProjectDMSTree**](docs/CollaborationApi.md#getProjectDMSTree) | **GET** /cloud/{cloud_pk}/project/{id}/dms-tree | Retrieve the complete DMS tree
270270
*bimdata.CollaborationApi* | [**getProjectFolderTree**](docs/CollaborationApi.md#getProjectFolderTree) | **GET** /cloud/{cloud_pk}/project/{id}/folder-tree | Retrieve folder tree of the project
271-
*bimdata.CollaborationApi* | [**getProjectFolderTreeSerializers**](docs/CollaborationApi.md#getProjectFolderTreeSerializers) | **GET** /cloud/{cloud_pk}/project/folder-trees | Retrieve folder tree for all projects
272271
*bimdata.CollaborationApi* | [**getProjectInvitations**](docs/CollaborationApi.md#getProjectInvitations) | **GET** /cloud/{cloud_pk}/project/{project_pk}/invitation | Retrieve all pending invitations in the project
273272
*bimdata.CollaborationApi* | [**getProjectSize**](docs/CollaborationApi.md#getProjectSize) | **GET** /cloud/{cloud_pk}/project/{id}/size | Get size of all model files in the project
274273
*bimdata.CollaborationApi* | [**getProjectSubTree**](docs/CollaborationApi.md#getProjectSubTree) | **GET** /cloud/{cloud_pk}/project/subtree | Retrieve the complete projects tree of the cloud

docs/CollaborationApi.md

Lines changed: 2 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,6 @@ Method | HTTP request | Description
6969
[**getProjectCreatorVisas**](CollaborationApi.md#getProjectCreatorVisas) | **GET** /cloud/{cloud_pk}/project/{project_pk}/me/visa/creator | List visas created by user
7070
[**getProjectDMSTree**](CollaborationApi.md#getProjectDMSTree) | **GET** /cloud/{cloud_pk}/project/{id}/dms-tree | Retrieve the complete DMS tree
7171
[**getProjectFolderTree**](CollaborationApi.md#getProjectFolderTree) | **GET** /cloud/{cloud_pk}/project/{id}/folder-tree | Retrieve folder tree of the project
72-
[**getProjectFolderTreeSerializers**](CollaborationApi.md#getProjectFolderTreeSerializers) | **GET** /cloud/{cloud_pk}/project/folder-trees | Retrieve folder tree for all projects
7372
[**getProjectInvitations**](CollaborationApi.md#getProjectInvitations) | **GET** /cloud/{cloud_pk}/project/{project_pk}/invitation | Retrieve all pending invitations in the project
7473
[**getProjectSize**](CollaborationApi.md#getProjectSize) | **GET** /cloud/{cloud_pk}/project/{id}/size | Get size of all model files in the project
7574
[**getProjectSubTree**](CollaborationApi.md#getProjectSubTree) | **GET** /cloud/{cloud_pk}/project/subtree | Retrieve the complete projects tree of the cloud
@@ -961,7 +960,7 @@ Name | Type | Description | Notes
961960
962961
Create a document
963962

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

966965
### Example
967966

@@ -4376,7 +4375,7 @@ Name | Type | Description | Notes
43764375

43774376
## getProjectFolderTree
43784377

4379-
> ProjectFolderTree getProjectFolderTree(cloudPk, id)
4378+
> [ProjectFolderTree] getProjectFolderTree(cloudPk, id)
43804379
43814380
Retrieve folder tree of the project
43824381

@@ -4425,67 +4424,6 @@ Name | Type | Description | Notes
44254424

44264425
### Return type
44274426

4428-
[**ProjectFolderTree**](ProjectFolderTree.md)
4429-
4430-
### Authorization
4431-
4432-
[ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer)
4433-
4434-
### HTTP request headers
4435-
4436-
- **Content-Type**: Not defined
4437-
- **Accept**: application/json
4438-
4439-
4440-
## getProjectFolderTreeSerializers
4441-
4442-
> [ProjectFolderTree] getProjectFolderTreeSerializers(cloudPk)
4443-
4444-
Retrieve folder tree for all projects
4445-
4446-
Retrieve folder tree for all projects
4447-
4448-
### Example
4449-
4450-
```javascript
4451-
import bimdata from '@bimdata/bimdata-api-client';
4452-
let defaultClient = bimdata.ApiClient.instance;
4453-
// Configure API key authorization: ApiKey
4454-
let ApiKey = defaultClient.authentications['ApiKey'];
4455-
ApiKey.apiKey = 'YOUR API KEY';
4456-
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
4457-
//ApiKey.apiKeyPrefix = 'Token';
4458-
// Configure OAuth2 access token for authorization: BIMData_Connect
4459-
let BIMData_Connect = defaultClient.authentications['BIMData_Connect'];
4460-
BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN';
4461-
// Configure OAuth2 access token for authorization: BIMData_Connect
4462-
let BIMData_Connect = defaultClient.authentications['BIMData_Connect'];
4463-
BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN';
4464-
// Configure API key authorization: Bearer
4465-
let Bearer = defaultClient.authentications['Bearer'];
4466-
Bearer.apiKey = 'YOUR API KEY';
4467-
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
4468-
//Bearer.apiKeyPrefix = 'Token';
4469-
4470-
let apiInstance = new bimdata.CollaborationApi();
4471-
let cloudPk = 56; // Number |
4472-
apiInstance.getProjectFolderTreeSerializers(cloudPk).then((data) => {
4473-
console.log('API called successfully. Returned data: ' + data);
4474-
}, (error) => {
4475-
console.error(error);
4476-
});
4477-
4478-
```
4479-
4480-
### Parameters
4481-
4482-
4483-
Name | Type | Description | Notes
4484-
------------- | ------------- | ------------- | -------------
4485-
**cloudPk** | **Number**| |
4486-
4487-
### Return type
4488-
44894427
[**[ProjectFolderTree]**](ProjectFolderTree.md)
44904428

44914429
### Authorization

src/api/CollaborationApi.js

Lines changed: 5 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -865,7 +865,7 @@ export default class CollaborationApi {
865865

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

932932
/**
933933
* Create a document
934-
* Create a document. If the document is one of {'DWG', 'POINT_CLOUD', 'OBJ', 'GLTF', 'DXF', 'IFC'}, a model will be created and attached to this document Required scopes: document:write
934+
* Create a document. If the document is one of {'OBJ', 'POINT_CLOUD', 'IFC', 'GLTF', 'DWG', 'DXF'}, a model will be created and attached to this document Required scopes: document:write
935935
* @param {Number} cloudPk A unique integer value identifying this cloud.
936936
* @param {Number} projectPk A unique integer value identifying this project.
937937
* @param {String} name Shown name of the file
@@ -4121,7 +4121,7 @@ export default class CollaborationApi {
41214121
* Retrieve folder tree of the project
41224122
* @param {Number} cloudPk
41234123
* @param {Number} id A unique integer value identifying this project.
4124-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ProjectFolderTree} and HTTP response
4124+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.<module:model/ProjectFolderTree>} and HTTP response
41254125
*/
41264126
getProjectFolderTreeWithHttpInfo(cloudPk, id) {
41274127
let postBody = null;
@@ -4148,7 +4148,7 @@ export default class CollaborationApi {
41484148
let authNames = ['ApiKey', 'BIMData_Connect', 'BIMData_Connect', 'Bearer'];
41494149
let contentTypes = [];
41504150
let accepts = ['application/json'];
4151-
let returnType = ProjectFolderTree;
4151+
let returnType = [ProjectFolderTree];
41524152
return this.apiClient.callApi(
41534153
'/cloud/{cloud_pk}/project/{id}/folder-tree', 'GET',
41544154
pathParams, queryParams, headerParams, formParams, postBody,
@@ -4161,7 +4161,7 @@ export default class CollaborationApi {
41614161
* Retrieve folder tree of the project
41624162
* @param {Number} cloudPk
41634163
* @param {Number} id A unique integer value identifying this project.
4164-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ProjectFolderTree}
4164+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<module:model/ProjectFolderTree>}
41654165
*/
41664166
getProjectFolderTree(cloudPk, id) {
41674167
return this.getProjectFolderTreeWithHttpInfo(cloudPk, id)
@@ -4171,54 +4171,6 @@ export default class CollaborationApi {
41714171
}
41724172

41734173

4174-
/**
4175-
* Retrieve folder tree for all projects
4176-
* Retrieve folder tree for all projects
4177-
* @param {Number} cloudPk
4178-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.<module:model/ProjectFolderTree>} and HTTP response
4179-
*/
4180-
getProjectFolderTreeSerializersWithHttpInfo(cloudPk) {
4181-
let postBody = null;
4182-
// verify the required parameter 'cloudPk' is set
4183-
if (cloudPk === undefined || cloudPk === null) {
4184-
throw new Error("Missing the required parameter 'cloudPk' when calling getProjectFolderTreeSerializers");
4185-
}
4186-
4187-
let pathParams = {
4188-
'cloud_pk': cloudPk
4189-
};
4190-
let queryParams = {
4191-
};
4192-
let headerParams = {
4193-
};
4194-
let formParams = {
4195-
};
4196-
4197-
let authNames = ['ApiKey', 'BIMData_Connect', 'BIMData_Connect', 'Bearer'];
4198-
let contentTypes = [];
4199-
let accepts = ['application/json'];
4200-
let returnType = [ProjectFolderTree];
4201-
return this.apiClient.callApi(
4202-
'/cloud/{cloud_pk}/project/folder-trees', 'GET',
4203-
pathParams, queryParams, headerParams, formParams, postBody,
4204-
authNames, contentTypes, accepts, returnType, null
4205-
);
4206-
}
4207-
4208-
/**
4209-
* Retrieve folder tree for all projects
4210-
* Retrieve folder tree for all projects
4211-
* @param {Number} cloudPk
4212-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<module:model/ProjectFolderTree>}
4213-
*/
4214-
getProjectFolderTreeSerializers(cloudPk) {
4215-
return this.getProjectFolderTreeSerializersWithHttpInfo(cloudPk)
4216-
.then(function(response_and_data) {
4217-
return response_and_data.data;
4218-
});
4219-
}
4220-
4221-
42224174
/**
42234175
* Retrieve all pending invitations in the project
42244176
* Returns app's invitations only Required scopes: org:manage

test/api/CollaborationApi.spec.js

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -698,16 +698,6 @@
698698
done();
699699
});
700700
});
701-
describe('getProjectFolderTreeSerializers', function() {
702-
it('should call getProjectFolderTreeSerializers successfully', function(done) {
703-
//uncomment below and update the code to test getProjectFolderTreeSerializers
704-
//instance.getProjectFolderTreeSerializers(function(error) {
705-
// if (error) throw error;
706-
//expect().to.be();
707-
//});
708-
done();
709-
});
710-
});
711701
describe('getProjectInvitations', function() {
712702
it('should call getProjectInvitations successfully', function(done) {
713703
//uncomment below and update the code to test getProjectInvitations

0 commit comments

Comments
 (0)