Skip to content

Commit e52ebe0

Browse files
Bimdata-ioBimdata-io
committed
PATCH: add name to naming constraint rules (#1059)
* add name to naming constraint rules * better doc
1 parent 9cb069f commit e52ebe0

34 files changed

Lines changed: 550 additions & 189 deletions

‎.openapi-generator/FILES‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,7 @@ bimdata_api_client/model/naming_constraint.py
134134
bimdata_api_client/model/naming_constraint_request.py
135135
bimdata_api_client/model/naming_parts_template.py
136136
bimdata_api_client/model/naming_parts_template_request.py
137+
bimdata_api_client/model/naming_rule_configuration.py
137138
bimdata_api_client/model/organization.py
138139
bimdata_api_client/model/organization_request.py
139140
bimdata_api_client/model/orthogonal_camera.py
@@ -437,6 +438,7 @@ docs/NamingConstraint.md
437438
docs/NamingConstraintRequest.md
438439
docs/NamingPartsTemplate.md
439440
docs/NamingPartsTemplateRequest.md
441+
docs/NamingRuleConfiguration.md
440442
docs/Organization.md
441443
docs/OrganizationRequest.md
442444
docs/OrthogonalCamera.md
@@ -743,6 +745,7 @@ test/test_naming_constraint.py
743745
test/test_naming_constraint_request.py
744746
test/test_naming_parts_template.py
745747
test/test_naming_parts_template_request.py
748+
test/test_naming_rule_configuration.py
746749
test/test_organization.py
747750
test/test_organization_request.py
748751
test/test_orthogonal_camera.py

‎README.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -144,13 +144,13 @@ with bimdata_api_client.ApiClient(configuration) as api_client:
144144
projects_pk = 1 # int | A unique integer value identifying this project.
145145
topics_guid = "topics_guid_example" # str |
146146
comment_request = CommentRequest(
147-
comment="comment_example",
147+
modified_author="modified_author_example",
148148
viewpoint_guid="viewpoint_guid_example",
149-
viewpoint_temp_id=1,
150-
author="author_example",
149+
comment="comment_example",
151150
reply_to_comment_guid="reply_to_comment_guid_example",
152151
date=dateutil_parser('1970-01-01T00:00:00.00Z'),
153-
modified_author="modified_author_example",
152+
author="author_example",
153+
viewpoint_temp_id=1,
154154
guid="guid_example",
155155
) # CommentRequest | (optional)
156156

@@ -687,6 +687,7 @@ Class | Method | HTTP request | Description
687687
- [NamingConstraintRequest](docs/NamingConstraintRequest.md)
688688
- [NamingPartsTemplate](docs/NamingPartsTemplate.md)
689689
- [NamingPartsTemplateRequest](docs/NamingPartsTemplateRequest.md)
690+
- [NamingRuleConfiguration](docs/NamingRuleConfiguration.md)
690691
- [Organization](docs/Organization.md)
691692
- [OrganizationRequest](docs/OrganizationRequest.md)
692693
- [OrthogonalCamera](docs/OrthogonalCamera.md)

‎bimdata_api_client/api/collaboration_api.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10239,7 +10239,7 @@ def create_document(
1023910239
):
1024010240
"""Create a document # noqa: E501
1024110241

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

@@ -10590,7 +10590,7 @@ def create_naming_parts_template(
1059010590
):
1059110591
"""Create a naming rule list # noqa: E501
1059210592

10593-
Create a naming rule list Required scopes: document:write # noqa: E501
10593+
Create a naming rule list. These are just templates being copied, effective rules using these lists will copy the content. Required scopes: document:write # noqa: E501
1059410594
This method makes a synchronous HTTP request by default. To make an
1059510595
asynchronous HTTP request, please pass async_req=True
1059610596

@@ -18828,7 +18828,7 @@ def update_naming_parts_template(
1882818828
):
1882918829
"""Update some fields of a naming rule list # noqa: E501
1883018830

18831-
Update some fields of a naming rule list Required scopes: document:write # noqa: E501
18831+
Update some fields of a naming rule list. These are just templates. Changing the template won't change the effective rules using these lists, they will keep the content they had when they were created. Required scopes: document:write # noqa: E501
1883218832
This method makes a synchronous HTTP request by default. To make an
1883318833
asynchronous HTTP request, please pass async_req=True
1883418834

‎bimdata_api_client/model/comment.py‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -59,10 +59,10 @@ class Comment(ModelNormal):
5959
}
6060

6161
validations = {
62-
('author',): {
62+
('modified_author',): {
6363
'max_length': 254,
6464
},
65-
('modified_author',): {
65+
('author',): {
6666
'max_length': 254,
6767
},
6868
}
@@ -88,14 +88,14 @@ def openapi_types():
8888
and the value is attribute type.
8989
"""
9090
return {
91-
'modified_date': (datetime,), # noqa: E501
9291
'topic_guid': (str,), # noqa: E501
93-
'comment': (str,), # noqa: E501
92+
'modified_date': (datetime,), # noqa: E501
93+
'modified_author': (str, none_type,), # noqa: E501
9494
'viewpoint_guid': (str, none_type,), # noqa: E501
95-
'author': (str, none_type,), # noqa: E501
95+
'comment': (str,), # noqa: E501
9696
'reply_to_comment_guid': (str, none_type,), # noqa: E501
9797
'date': (datetime,), # noqa: E501
98-
'modified_author': (str, none_type,), # noqa: E501
98+
'author': (str, none_type,), # noqa: E501
9999
'guid': (str,), # noqa: E501
100100
}
101101

@@ -105,32 +105,32 @@ def discriminator():
105105

106106

107107
attribute_map = {
108-
'modified_date': 'modified_date', # noqa: E501
109108
'topic_guid': 'topic_guid', # noqa: E501
110-
'comment': 'comment', # noqa: E501
109+
'modified_date': 'modified_date', # noqa: E501
110+
'modified_author': 'modified_author', # noqa: E501
111111
'viewpoint_guid': 'viewpoint_guid', # noqa: E501
112-
'author': 'author', # noqa: E501
112+
'comment': 'comment', # noqa: E501
113113
'reply_to_comment_guid': 'reply_to_comment_guid', # noqa: E501
114114
'date': 'date', # noqa: E501
115-
'modified_author': 'modified_author', # noqa: E501
115+
'author': 'author', # noqa: E501
116116
'guid': 'guid', # noqa: E501
117117
}
118118

119119
read_only_vars = {
120-
'modified_date', # noqa: E501
121120
'topic_guid', # noqa: E501
121+
'modified_date', # noqa: E501
122122
}
123123

124124
_composed_schemas = {}
125125

126126
@classmethod
127127
@convert_js_args_to_python_args
128-
def _from_openapi_data(cls, modified_date, topic_guid, *args, **kwargs): # noqa: E501
128+
def _from_openapi_data(cls, topic_guid, modified_date, *args, **kwargs): # noqa: E501
129129
"""Comment - a model defined in OpenAPI
130130
131131
Args:
132-
modified_date (datetime):
133132
topic_guid (str):
133+
modified_date (datetime):
134134
135135
Keyword Args:
136136
_check_type (bool): if True, values for parameters in openapi_types
@@ -163,12 +163,12 @@ def _from_openapi_data(cls, modified_date, topic_guid, *args, **kwargs): # noqa
163163
Animal class but this time we won't travel
164164
through its discriminator because we passed in
165165
_visited_composed_classes = (Animal,)
166-
comment (str): [optional] # noqa: E501
166+
modified_author (str, none_type): [optional] # noqa: E501
167167
viewpoint_guid (str, none_type): [optional] # noqa: E501
168-
author (str, none_type): [optional] # noqa: E501
168+
comment (str): [optional] # noqa: E501
169169
reply_to_comment_guid (str, none_type): [optional] # noqa: E501
170170
date (datetime): [optional] # noqa: E501
171-
modified_author (str, none_type): [optional] # noqa: E501
171+
author (str, none_type): [optional] # noqa: E501
172172
guid (str): [optional] # noqa: E501
173173
"""
174174

@@ -197,8 +197,8 @@ def _from_openapi_data(cls, modified_date, topic_guid, *args, **kwargs): # noqa
197197
self._configuration = _configuration
198198
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
199199

200-
self.modified_date = modified_date
201200
self.topic_guid = topic_guid
201+
self.modified_date = modified_date
202202
for var_name, var_value in kwargs.items():
203203
if var_name not in self.attribute_map and \
204204
self._configuration is not None and \
@@ -253,12 +253,12 @@ def __init__(self, *args, **kwargs): # noqa: E501
253253
Animal class but this time we won't travel
254254
through its discriminator because we passed in
255255
_visited_composed_classes = (Animal,)
256-
comment (str): [optional] # noqa: E501
256+
modified_author (str, none_type): [optional] # noqa: E501
257257
viewpoint_guid (str, none_type): [optional] # noqa: E501
258-
author (str, none_type): [optional] # noqa: E501
258+
comment (str): [optional] # noqa: E501
259259
reply_to_comment_guid (str, none_type): [optional] # noqa: E501
260260
date (datetime): [optional] # noqa: E501
261-
modified_author (str, none_type): [optional] # noqa: E501
261+
author (str, none_type): [optional] # noqa: E501
262262
guid (str): [optional] # noqa: E501
263263
"""
264264

‎bimdata_api_client/model/comment_request.py‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -59,10 +59,10 @@ class CommentRequest(ModelNormal):
5959
}
6060

6161
validations = {
62-
('author',): {
62+
('modified_author',): {
6363
'max_length': 254,
6464
},
65-
('modified_author',): {
65+
('author',): {
6666
'max_length': 254,
6767
},
6868
}
@@ -88,13 +88,13 @@ def openapi_types():
8888
and the value is attribute type.
8989
"""
9090
return {
91-
'comment': (str,), # noqa: E501
91+
'modified_author': (str, none_type,), # noqa: E501
9292
'viewpoint_guid': (str, none_type,), # noqa: E501
93-
'viewpoint_temp_id': (int,), # noqa: E501
94-
'author': (str, none_type,), # noqa: E501
93+
'comment': (str,), # noqa: E501
9594
'reply_to_comment_guid': (str, none_type,), # noqa: E501
9695
'date': (datetime,), # noqa: E501
97-
'modified_author': (str, none_type,), # noqa: E501
96+
'author': (str, none_type,), # noqa: E501
97+
'viewpoint_temp_id': (int,), # noqa: E501
9898
'guid': (str,), # noqa: E501
9999
}
100100

@@ -104,13 +104,13 @@ def discriminator():
104104

105105

106106
attribute_map = {
107-
'comment': 'comment', # noqa: E501
107+
'modified_author': 'modified_author', # noqa: E501
108108
'viewpoint_guid': 'viewpoint_guid', # noqa: E501
109-
'viewpoint_temp_id': 'viewpoint_temp_id', # noqa: E501
110-
'author': 'author', # noqa: E501
109+
'comment': 'comment', # noqa: E501
111110
'reply_to_comment_guid': 'reply_to_comment_guid', # noqa: E501
112111
'date': 'date', # noqa: E501
113-
'modified_author': 'modified_author', # noqa: E501
112+
'author': 'author', # noqa: E501
113+
'viewpoint_temp_id': 'viewpoint_temp_id', # noqa: E501
114114
'guid': 'guid', # noqa: E501
115115
}
116116

@@ -155,13 +155,13 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
155155
Animal class but this time we won't travel
156156
through its discriminator because we passed in
157157
_visited_composed_classes = (Animal,)
158-
comment (str): [optional] # noqa: E501
158+
modified_author (str, none_type): [optional] # noqa: E501
159159
viewpoint_guid (str, none_type): [optional] # noqa: E501
160-
viewpoint_temp_id (int): Only used when using POST on the full-topic route to bind viewpoint with comment. [optional] # noqa: E501
161-
author (str, none_type): [optional] # noqa: E501
160+
comment (str): [optional] # noqa: E501
162161
reply_to_comment_guid (str, none_type): [optional] # noqa: E501
163162
date (datetime): [optional] # noqa: E501
164-
modified_author (str, none_type): [optional] # noqa: E501
163+
author (str, none_type): [optional] # noqa: E501
164+
viewpoint_temp_id (int): Only used when using POST on the full-topic route to bind viewpoint with comment. [optional] # noqa: E501
165165
guid (str): [optional] # noqa: E501
166166
"""
167167

@@ -244,13 +244,13 @@ def __init__(self, *args, **kwargs): # noqa: E501
244244
Animal class but this time we won't travel
245245
through its discriminator because we passed in
246246
_visited_composed_classes = (Animal,)
247-
comment (str): [optional] # noqa: E501
247+
modified_author (str, none_type): [optional] # noqa: E501
248248
viewpoint_guid (str, none_type): [optional] # noqa: E501
249-
viewpoint_temp_id (int): Only used when using POST on the full-topic route to bind viewpoint with comment. [optional] # noqa: E501
250-
author (str, none_type): [optional] # noqa: E501
249+
comment (str): [optional] # noqa: E501
251250
reply_to_comment_guid (str, none_type): [optional] # noqa: E501
252251
date (datetime): [optional] # noqa: E501
253-
modified_author (str, none_type): [optional] # noqa: E501
252+
author (str, none_type): [optional] # noqa: E501
253+
viewpoint_temp_id (int): Only used when using POST on the full-topic route to bind viewpoint with comment. [optional] # noqa: E501
254254
guid (str): [optional] # noqa: E501
255255
"""
256256

‎bimdata_api_client/model/document_text.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,11 @@ class DocumentText(ModelNormal):
5858
allowed_values = {
5959
('language',): {
6060
'None': None,
61+
'FRENCH': "french",
6162
'ENGLISH': "english",
62-
'ITALIAN': "italian",
6363
'GERMAN': "german",
64-
'FRENCH': "french",
6564
'SPANISH': "spanish",
65+
'ITALIAN': "italian",
6666
'NULL': "null",
6767
},
6868
}
@@ -153,7 +153,7 @@ def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501
153153
through its discriminator because we passed in
154154
_visited_composed_classes = (Animal,)
155155
text (str, none_type): The full text representation of a document if the feature is enabled and the file format supported. [optional] # noqa: E501
156-
language (str, none_type): * `english` - english * `italian` - italian * `german` - german * `french` - french * `spanish` - spanish. [optional] # noqa: E501
156+
language (str, none_type): * `french` - french * `english` - english * `german` - german * `spanish` - spanish * `italian` - italian. [optional] # noqa: E501
157157
"""
158158

159159
_check_type = kwargs.pop('_check_type', True)
@@ -237,7 +237,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
237237
through its discriminator because we passed in
238238
_visited_composed_classes = (Animal,)
239239
text (str, none_type): The full text representation of a document if the feature is enabled and the file format supported. [optional] # noqa: E501
240-
language (str, none_type): * `english` - english * `italian` - italian * `german` - german * `french` - french * `spanish` - spanish. [optional] # noqa: E501
240+
language (str, none_type): * `french` - french * `english` - english * `german` - german * `spanish` - spanish * `italian` - italian. [optional] # noqa: E501
241241
"""
242242

243243
_check_type = kwargs.pop('_check_type', True)

0 commit comments

Comments
 (0)