Skip to content

Commit e04c180

Browse files
committed
PATCH: rename operation_id
1 parent 3413682 commit e04c180

4 files changed

Lines changed: 15 additions & 15 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ Class | Method | HTTP request | Description
258258
*CollaborationApi* | [**create_validation**](docs/CollaborationApi.md#create_validation) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validation | Add a validation to a visa
259259
*CollaborationApi* | [**create_visa**](docs/CollaborationApi.md#create_visa) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa | Create a visa
260260
*CollaborationApi* | [**create_visa_comment**](docs/CollaborationApi.md#create_visa_comment) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/comment | Add a comment
261-
*CollaborationApi* | [**delete_all_history**](docs/CollaborationApi.md#delete_all_history) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/history/delete | Delete all document history
261+
*CollaborationApi* | [**delete_all_document_history**](docs/CollaborationApi.md#delete_all_document_history) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/history/delete | Delete all document history
262262
*CollaborationApi* | [**delete_classification**](docs/CollaborationApi.md#delete_classification) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/classification/{id} | Delete a classification
263263
*CollaborationApi* | [**delete_cloud**](docs/CollaborationApi.md#delete_cloud) | **DELETE** /cloud/{id} | Delete a cloud
264264
*CollaborationApi* | [**delete_cloud_user**](docs/CollaborationApi.md#delete_cloud_user) | **DELETE** /cloud/{cloud_pk}/user/{id} | Remove a user from a cloud

bimdata_api_client/api/collaboration_api.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1524,7 +1524,7 @@ def __init__(self, api_client=None):
15241524
},
15251525
api_client=api_client
15261526
)
1527-
self.delete_all_history_endpoint = _Endpoint(
1527+
self.delete_all_document_history_endpoint = _Endpoint(
15281528
settings={
15291529
'response_type': None,
15301530
'auth': [
@@ -1534,7 +1534,7 @@ def __init__(self, api_client=None):
15341534
'Bearer'
15351535
],
15361536
'endpoint_path': '/cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/history/delete',
1537-
'operation_id': 'delete_all_history',
1537+
'operation_id': 'delete_all_document_history',
15381538
'http_method': 'DELETE',
15391539
'servers': None,
15401540
},
@@ -8613,7 +8613,7 @@ def create_visa_comment(
86138613
visa_pk
86148614
return self.create_visa_comment_endpoint.call_with_http_info(**kwargs)
86158615

8616-
def delete_all_history(
8616+
def delete_all_document_history(
86178617
self,
86188618
cloud_pk,
86198619
document_pk,
@@ -8622,11 +8622,11 @@ def delete_all_history(
86228622
):
86238623
"""Delete all document history # noqa: E501
86248624

8625-
Delete all document history Required scopes: document:write # noqa: E501
8625+
Delete the document from the head version and all its history Required scopes: document:write # noqa: E501
86268626
This method makes a synchronous HTTP request by default. To make an
86278627
asynchronous HTTP request, please pass async_req=True
86288628

8629-
>>> thread = api.delete_all_history(cloud_pk, document_pk, project_pk, async_req=True)
8629+
>>> thread = api.delete_all_document_history(cloud_pk, document_pk, project_pk, async_req=True)
86308630
>>> result = thread.get()
86318631

86328632
Args:
@@ -8697,7 +8697,7 @@ def delete_all_history(
86978697
document_pk
86988698
kwargs['project_pk'] = \
86998699
project_pk
8700-
return self.delete_all_history_endpoint.call_with_http_info(**kwargs)
8700+
return self.delete_all_document_history_endpoint.call_with_http_info(**kwargs)
87018701

87028702
def delete_classification(
87038703
self,

docs/CollaborationApi.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Method | HTTP request | Description
2424
[**create_validation**](CollaborationApi.md#create_validation) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/validation | Add a validation to a visa
2525
[**create_visa**](CollaborationApi.md#create_visa) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa | Create a visa
2626
[**create_visa_comment**](CollaborationApi.md#create_visa_comment) | **POST** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/visa/{visa_pk}/comment | Add a comment
27-
[**delete_all_history**](CollaborationApi.md#delete_all_history) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/history/delete | Delete all document history
27+
[**delete_all_document_history**](CollaborationApi.md#delete_all_document_history) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/document/{document_pk}/history/delete | Delete all document history
2828
[**delete_classification**](CollaborationApi.md#delete_classification) | **DELETE** /cloud/{cloud_pk}/project/{project_pk}/classification/{id} | Delete a classification
2929
[**delete_cloud**](CollaborationApi.md#delete_cloud) | **DELETE** /cloud/{id} | Delete a cloud
3030
[**delete_cloud_user**](CollaborationApi.md#delete_cloud_user) | **DELETE** /cloud/{cloud_pk}/user/{id} | Remove a user from a cloud
@@ -2362,12 +2362,12 @@ Name | Type | Description | Notes
23622362

23632363
[[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)
23642364

2365-
# **delete_all_history**
2366-
> delete_all_history(cloud_pk, document_pk, project_pk)
2365+
# **delete_all_document_history**
2366+
> delete_all_document_history(cloud_pk, document_pk, project_pk)
23672367
23682368
Delete all document history
23692369

2370-
Delete all document history Required scopes: document:write
2370+
Delete the document from the head version and all its history Required scopes: document:write
23712371

23722372
### Example
23732373

@@ -2427,9 +2427,9 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
24272427
# example passing only required values which don't have defaults set
24282428
try:
24292429
# Delete all document history
2430-
api_instance.delete_all_history(cloud_pk, document_pk, project_pk)
2430+
api_instance.delete_all_document_history(cloud_pk, document_pk, project_pk)
24312431
except bimdata_api_client.ApiException as e:
2432-
print("Exception when calling CollaborationApi->delete_all_history: %s\n" % e)
2432+
print("Exception when calling CollaborationApi->delete_all_document_history: %s\n" % e)
24332433
```
24342434

24352435

test/test_collaboration_api.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -164,8 +164,8 @@ def test_create_visa_comment(self):
164164
"""
165165
pass
166166

167-
def test_delete_all_history(self):
168-
"""Test case for delete_all_history
167+
def test_delete_all_document_history(self):
168+
"""Test case for delete_all_document_history
169169
170170
Delete all document history # noqa: E501
171171
"""

0 commit comments

Comments
 (0)