Skip to content

Commit 7b81461

Browse files
Merge pull request #1523 from virtualcell/key-value-searlizes-to-string
KeyValue Serialization, Fix BioModel Save Bug, and Update BioModel Save Input
2 parents 1d0b07c + dd14172 commit 7b81461

87 files changed

Lines changed: 637 additions & 998 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

python-restclient/.openapi-generator/FILES

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,13 @@ docs/HelloWorldMessage.md
2929
docs/HtcJobID.md
3030
docs/ISize.md
3131
docs/Identity.md
32-
docs/KeyValue.md
3332
docs/MathType.md
3433
docs/MathmodelRef.md
3534
docs/ModelType.md
3635
docs/Origin.md
3736
docs/Publication.md
3837
docs/PublicationInfo.md
3938
docs/PublicationResourceApi.md
40-
docs/SaveBioModel.md
4139
docs/SchedulerStatus.md
4240
docs/SimulationExecutionStatusRecord.md
4341
docs/SimulationJobStatusRecord.md
@@ -105,14 +103,12 @@ vcell_client/models/hello_world_message.py
105103
vcell_client/models/htc_job_id.py
106104
vcell_client/models/i_size.py
107105
vcell_client/models/identity.py
108-
vcell_client/models/key_value.py
109106
vcell_client/models/math_type.py
110107
vcell_client/models/mathmodel_ref.py
111108
vcell_client/models/model_type.py
112109
vcell_client/models/origin.py
113110
vcell_client/models/publication.py
114111
vcell_client/models/publication_info.py
115-
vcell_client/models/save_bio_model.py
116112
vcell_client/models/scheduler_status.py
117113
vcell_client/models/simulation_execution_status_record.py
118114
vcell_client/models/simulation_job_status_record.py

python-restclient/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,14 +154,12 @@ Class | Method | HTTP request | Description
154154
- [HtcJobID](docs/HtcJobID.md)
155155
- [ISize](docs/ISize.md)
156156
- [Identity](docs/Identity.md)
157-
- [KeyValue](docs/KeyValue.md)
158157
- [MathType](docs/MathType.md)
159158
- [MathmodelRef](docs/MathmodelRef.md)
160159
- [ModelType](docs/ModelType.md)
161160
- [Origin](docs/Origin.md)
162161
- [Publication](docs/Publication.md)
163162
- [PublicationInfo](docs/PublicationInfo.md)
164-
- [SaveBioModel](docs/SaveBioModel.md)
165163
- [SchedulerStatus](docs/SchedulerStatus.md)
166164
- [SimulationExecutionStatusRecord](docs/SimulationExecutionStatusRecord.md)
167165
- [SimulationJobStatusRecord](docs/SimulationJobStatusRecord.md)

python-restclient/docs/BioModel.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
1414
**phys_model_key** | **str** | | [optional]
1515
**owner_name** | **str** | | [optional]
1616
**owner_key** | **str** | | [optional]
17-
**simulation_key_list** | [**List[KeyValue]**](KeyValue.md) | | [optional]
17+
**simulation_key_list** | **List[str]** | | [optional]
1818
**applications** | **List[object]** | | [optional]
1919

2020
## Example

python-restclient/docs/BioModelResourceApi.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,7 @@ No authorization required
346346
[[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)
347347

348348
# **save_bio_model**
349-
> str save_bio_model(save_bio_model=save_bio_model)
349+
> str save_bio_model(body, new_name=new_name, sims_requiring_updates=sims_requiring_updates)
350350
351351
Save's the given BioModel. Optional parameters of name and simulations to update due to math changes. Returns saved BioModel as VCML.
352352

@@ -356,7 +356,6 @@ Save's the given BioModel. Optional parameters of name and simulations to update
356356
import time
357357
import os
358358
import vcell_client
359-
from vcell_client.models.save_bio_model import SaveBioModel
360359
from vcell_client.rest import ApiException
361360
from pprint import pprint
362361

@@ -375,11 +374,13 @@ configuration = vcell_client.Configuration(
375374
with vcell_client.ApiClient(configuration) as api_client:
376375
# Create an instance of the API class
377376
api_instance = vcell_client.BioModelResourceApi(api_client)
378-
save_bio_model = vcell_client.SaveBioModel() # SaveBioModel | (optional)
377+
body = 'body_example' # str | BioModelVCML which will be saved.
378+
new_name = 'new_name_example' # str | Name to save new BioModel under. Leave blank if re-saving existing BioModel. (optional)
379+
sims_requiring_updates = ['sims_requiring_updates_example'] # List[str] | The name of simulations that will be prepared for future execution. (optional)
379380

380381
try:
381382
# Save's the given BioModel. Optional parameters of name and simulations to update due to math changes. Returns saved BioModel as VCML.
382-
api_response = api_instance.save_bio_model(save_bio_model=save_bio_model)
383+
api_response = api_instance.save_bio_model(body, new_name=new_name, sims_requiring_updates=sims_requiring_updates)
383384
print("The response of BioModelResourceApi->save_bio_model:\n")
384385
pprint(api_response)
385386
except Exception as e:
@@ -392,7 +393,9 @@ with vcell_client.ApiClient(configuration) as api_client:
392393

393394
Name | Type | Description | Notes
394395
------------- | ------------- | ------------- | -------------
395-
**save_bio_model** | [**SaveBioModel**](SaveBioModel.md)| | [optional]
396+
**body** | **str**| BioModelVCML which will be saved. |
397+
**new_name** | **str**| Name to save new BioModel under. Leave blank if re-saving existing BioModel. | [optional]
398+
**sims_requiring_updates** | [**List[str]**](str.md)| The name of simulations that will be prepared for future execution. | [optional]
396399

397400
### Return type
398401

@@ -404,7 +407,7 @@ Name | Type | Description | Notes
404407

405408
### HTTP request headers
406409

407-
- **Content-Type**: application/json
410+
- **Content-Type**: application/xml
408411
- **Accept**: application/xml, application/json
409412

410413
### HTTP response details

python-restclient/docs/ExternalDataIdentifier.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**key** | [**KeyValue**](KeyValue.md) | | [optional]
7+
**key** | **str** | | [optional]
88
**owner** | [**User**](User.md) | | [optional]
99
**name** | **str** | | [optional]
1010
**job_index** | **int** | | [optional]
11-
**simulation_key** | [**KeyValue**](KeyValue.md) | | [optional]
11+
**simulation_key** | **str** | | [optional]
1212
**parameter_scan_type** | **bool** | | [optional]
13-
**data_key** | [**KeyValue**](KeyValue.md) | | [optional]
13+
**data_key** | **str** | | [optional]
1414

1515
## Example
1616

python-restclient/docs/FieldDataReference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**field_data_id** | [**ExternalDataIdentifier**](ExternalDataIdentifier.md) | | [optional]
88
**annotation** | **str** | | [optional]
9-
**simulations_referencing_this_id** | [**List[KeyValue]**](KeyValue.md) | | [optional]
9+
**simulations_referencing_this_id** | **List[str]** | | [optional]
1010

1111
## Example
1212

python-restclient/docs/PublicationInfo.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**publication_key** | [**KeyValue**](KeyValue.md) | | [optional]
8-
**version_key** | [**KeyValue**](KeyValue.md) | | [optional]
7+
**publication_key** | **str** | | [optional]
8+
**version_key** | **str** | | [optional]
99
**title** | **str** | | [optional]
1010
**authors** | **List[str]** | | [optional]
1111
**citation** | **str** | | [optional]

python-restclient/docs/User.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**user_name** | **str** | | [optional]
8-
**key** | [**KeyValue**](KeyValue.md) | | [optional]
8+
**key** | **str** | | [optional]
99

1010
## Example
1111

python-restclient/docs/VCSimulationIdentifier.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**simulation_key** | [**KeyValue**](KeyValue.md) | | [optional]
7+
**simulation_key** | **str** | | [optional]
88
**owner** | [**User**](User.md) | | [optional]
99
**id** | **str** | | [optional]
1010

python-restclient/docs/Version.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**version_key** | [**KeyValue**](KeyValue.md) | | [optional]
7+
**version_key** | **str** | | [optional]
88
**annot** | **str** | | [optional]
99
**branch_id** | **float** | | [optional]
10-
**branch_point_ref_key** | [**KeyValue**](KeyValue.md) | | [optional]
10+
**branch_point_ref_key** | **str** | | [optional]
1111
**var_date** | **datetime** | | [optional]
1212
**flag** | [**VersionFlag**](VersionFlag.md) | | [optional]
1313
**group_access** | [**GroupAccess**](GroupAccess.md) | | [optional]

0 commit comments

Comments
 (0)