Skip to content

Commit 4054f7c

Browse files
committed
PATCH: fix bcf excel export documentation
1 parent 32a9c7e commit 4054f7c

File tree

4 files changed

+32
-8
lines changed

4 files changed

+32
-8
lines changed

bimdata_api_client/api/bcf_api.py

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1370,7 +1370,7 @@ def __init__(self, api_client=None):
13701370
)
13711371
self.download_bcf_export_xlsx_endpoint = _Endpoint(
13721372
settings={
1373-
'response_type': (BcfProject,),
1373+
'response_type': (file_type,),
13741374
'auth': [
13751375
'ApiKey',
13761376
'BIMData_Connect',
@@ -1385,6 +1385,8 @@ def __init__(self, api_client=None):
13851385
params_map={
13861386
'all': [
13871387
'id',
1388+
'format',
1389+
'topics',
13881390
],
13891391
'required': [
13901392
'id',
@@ -1404,12 +1406,20 @@ def __init__(self, api_client=None):
14041406
'openapi_types': {
14051407
'id':
14061408
(int,),
1409+
'format':
1410+
(str,),
1411+
'topics':
1412+
(str,),
14071413
},
14081414
'attribute_map': {
14091415
'id': 'id',
1416+
'format': 'format',
1417+
'topics': 'topics',
14101418
},
14111419
'location_map': {
14121420
'id': 'path',
1421+
'format': 'query',
1422+
'topics': 'query',
14131423
},
14141424
'collection_format_map': {
14151425
}
@@ -5940,6 +5950,8 @@ def download_bcf_export_xlsx(
59405950
id (int): A unique integer value identifying this project.
59415951
59425952
Keyword Args:
5953+
format (str): topic format to export, comma separated. Default = standard. [optional]
5954+
topics (str): topic guids to export, comma separated. Default = all. [optional]
59435955
_return_http_data_only (bool): response data without head status
59445956
code and headers. Default is True.
59455957
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -5968,7 +5980,7 @@ def download_bcf_export_xlsx(
59685980
async_req (bool): execute request asynchronously
59695981
59705982
Returns:
5971-
BcfProject
5983+
file_type
59725984
If the method is called asynchronously, returns the request
59735985
thread.
59745986
"""

bimdata_api_client/api/collaboration_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8373,7 +8373,7 @@ def create_document(
83738373
):
83748374
"""Create a document # noqa: E501
83758375

8376-
Create a document. If the document is one of {'OBJ', 'DXF', 'IFC', 'GLTF', 'POINT_CLOUD', 'DWG'}, a model will be created and attached to this document Required scopes: document:write # noqa: E501
8376+
Create a document. If the document is one of {'POINT_CLOUD', 'IFC', 'GLTF', 'DWG', 'OBJ', 'DXF'}, a model will be created and attached to this document Required scopes: document:write # noqa: E501
83778377
This method makes a synchronous HTTP request by default. To make an
83788378
asynchronous HTTP request, please pass async_req=True
83798379

docs/BcfApi.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2457,7 +2457,7 @@ Name | Type | Description | Notes
24572457
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
24582458

24592459
# **download_bcf_export_xlsx**
2460-
> BcfProject download_bcf_export_xlsx(id)
2460+
> file_type download_bcf_export_xlsx(id)
24612461
24622462
Export project's topics in excel format
24632463

@@ -2474,7 +2474,6 @@ This is not a standard route. Export project's topics in excel format Required
24742474
import time
24752475
import bimdata_api_client
24762476
from bimdata_api_client.api import bcf_api
2477-
from bimdata_api_client.model.bcf_project import BcfProject
24782477
from pprint import pprint
24792478
# Defining the host is optional and defaults to http://localhost
24802479
# See configuration.py for a list of all supported configuration parameters.
@@ -2516,6 +2515,8 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
25162515
# Create an instance of the API class
25172516
api_instance = bcf_api.BcfApi(api_client)
25182517
id = 1 # int | A unique integer value identifying this project.
2518+
format = "format_example" # str | topic format to export, comma separated. Default = standard (optional)
2519+
topics = "topics_example" # str | topic guids to export, comma separated. Default = all (optional)
25192520

25202521
# example passing only required values which don't have defaults set
25212522
try:
@@ -2524,6 +2525,15 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
25242525
pprint(api_response)
25252526
except bimdata_api_client.ApiException as e:
25262527
print("Exception when calling BcfApi->download_bcf_export_xlsx: %s\n" % e)
2528+
2529+
# example passing only required values which don't have defaults set
2530+
# and optional values
2531+
try:
2532+
# Export project's topics in excel format
2533+
api_response = api_instance.download_bcf_export_xlsx(id, format=format, topics=topics)
2534+
pprint(api_response)
2535+
except bimdata_api_client.ApiException as e:
2536+
print("Exception when calling BcfApi->download_bcf_export_xlsx: %s\n" % e)
25272537
```
25282538

25292539

@@ -2532,10 +2542,12 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
25322542
Name | Type | Description | Notes
25332543
------------- | ------------- | ------------- | -------------
25342544
**id** | **int**| A unique integer value identifying this project. |
2545+
**format** | **str**| topic format to export, comma separated. Default = standard | [optional]
2546+
**topics** | **str**| topic guids to export, comma separated. Default = all | [optional]
25352547

25362548
### Return type
25372549

2538-
[**BcfProject**](BcfProject.md)
2550+
**file_type**
25392551

25402552
### Authorization
25412553

@@ -2551,7 +2563,7 @@ Name | Type | Description | Notes
25512563

25522564
| Status code | Description | Response headers |
25532565
|-------------|-------------|------------------|
2554-
**200** | | - |
2566+
**200** | bcf Excel file | - |
25552567
**401** | The authentication failed. Your token may be expired, missing or malformed | - |
25562568
**403** | You don't have the authorization to access this resource. Check if the resource is exclusive to users or app (eg: /user is exclusive to users) or if your user has the right to access this resource. | - |
25572569
**404** | The resource does not exist or you don't have the right to see if the resource exists | - |

docs/CollaborationApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1527,7 +1527,7 @@ Name | Type | Description | Notes
15271527
15281528
Create a document
15291529

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

15321532
### Example
15331533

0 commit comments

Comments
 (0)