Skip to content

Commit 118007d

Browse files
Ezequiel-ValenciaEzequiel-Valencia
committed
Use Summaries Container in Client
1 parent d3ac014 commit 118007d

38 files changed

Lines changed: 1621 additions & 1044 deletions

‎python-restclient/.openapi-generator/FILES‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -90,17 +90,16 @@ docs/VCImageResourceApi.md
9090
docs/VCImageSummary.md
9191
docs/VCSimulationIdentifier.md
9292
docs/VCellHTTPError.md
93-
docs/VCellInfoContainer.md
9493
docs/VCellSite.md
9594
docs/VCellSoftwareVersion.md
95+
docs/VCellSummaryContainer.md
9696
docs/VariableDomain.md
9797
docs/VariableMode.md
9898
docs/VariableSpecs.md
9999
docs/VariableType.md
100100
docs/Version.md
101101
docs/VersionFlag.md
102102
test/__init__.py
103-
test/test_v_cell_info_container.py
104103
tox.ini
105104
vcell_client/__init__.py
106105
vcell_client/api/__init__.py
@@ -195,9 +194,9 @@ vcell_client/models/user_identity_json_safe.py
195194
vcell_client/models/user_login_info_for_mapping.py
196195
vcell_client/models/user_registration_info.py
197196
vcell_client/models/v_cell_http_error.py
198-
vcell_client/models/v_cell_info_container.py
199197
vcell_client/models/v_cell_site.py
200198
vcell_client/models/v_cell_software_version.py
199+
vcell_client/models/v_cell_summary_container.py
201200
vcell_client/models/variable_domain.py
202201
vcell_client/models/variable_mode.py
203202
vcell_client/models/variable_specs.py

‎python-restclient/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ Class | Method | HTTP request | Description
9595
*BioModelResourceApi* | [**get_bio_model_summaries**](docs/BioModelResourceApi.md#get_bio_model_summaries) | **GET** /api/v1/bioModel/summaries | Return BioModel summaries.
9696
*BioModelResourceApi* | [**get_bio_model_summary**](docs/BioModelResourceApi.md#get_bio_model_summary) | **GET** /api/v1/bioModel/{bioModelID}/summary | All of the text based information about a BioModel (summary, version, publication status, etc...), but not the actual BioModel itself.
9797
*BioModelResourceApi* | [**get_bio_model_vcml**](docs/BioModelResourceApi.md#get_bio_model_vcml) | **GET** /api/v1/bioModel/{bioModelID}/vcml_download | Get the BioModel in VCML format.
98-
*BioModelResourceApi* | [**get_info_containers**](docs/BioModelResourceApi.md#get_info_containers) | **GET** /api/v1/bioModel/infoContainers |
98+
*BioModelResourceApi* | [**get_summaries_container**](docs/BioModelResourceApi.md#get_summaries_container) | **GET** /api/v1/bioModel/summariesContainer |
9999
*BioModelResourceApi* | [**save_bio_model**](docs/BioModelResourceApi.md#save_bio_model) | **POST** /api/v1/bioModel | Save's the given BioModel. Optional parameters of name and simulations to update due to math changes. Returns saved BioModel as VCML.
100100
*ExportResourceApi* | [**export_n5**](docs/ExportResourceApi.md#export_n5) | **POST** /api/v1/export/N5 |
101101
*ExportResourceApi* | [**export_status**](docs/ExportResourceApi.md#export_status) | **GET** /api/v1/export/status |
@@ -225,9 +225,9 @@ Class | Method | HTTP request | Description
225225
- [VCImageSummary](docs/VCImageSummary.md)
226226
- [VCSimulationIdentifier](docs/VCSimulationIdentifier.md)
227227
- [VCellHTTPError](docs/VCellHTTPError.md)
228-
- [VCellInfoContainer](docs/VCellInfoContainer.md)
229228
- [VCellSite](docs/VCellSite.md)
230229
- [VCellSoftwareVersion](docs/VCellSoftwareVersion.md)
230+
- [VCellSummaryContainer](docs/VCellSummaryContainer.md)
231231
- [VariableDomain](docs/VariableDomain.md)
232232
- [VariableMode](docs/VariableMode.md)
233233
- [VariableSpecs](docs/VariableSpecs.md)

‎python-restclient/docs/BioModelChildSummary.md‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,13 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**sc_names** | **List[str]** | | [optional]
8-
**sc_annots** | **List[str]** | | [optional]
9-
**geo_names** | **List[str]** | | [optional]
10-
**geo_dims** | **List[int]** | | [optional]
117
**app_types** | [**List[MathType]**](MathType.md) | | [optional]
12-
**sim_names** | **List[List[str]]** | | [optional]
13-
**sim_annots** | **List[List[str]]** | | [optional]
148
**geometry_dimensions** | **List[int]** | | [optional]
159
**geometry_names** | **List[str]** | | [optional]
1610
**simulation_context_annotations** | **List[str]** | | [optional]
1711
**simulation_context_names** | **List[str]** | | [optional]
12+
**all_simulation_names** | **List[List[str]]** | | [optional]
13+
**all_simulation_annots** | **List[List[str]]** | | [optional]
1814
**application_info** | [**List[ApplicationInfo]**](ApplicationInfo.md) | | [optional]
1915

2016
## Example

‎python-restclient/docs/BioModelResourceApi.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Method | HTTP request | Description
99
[**get_bio_model_summaries**](BioModelResourceApi.md#get_bio_model_summaries) | **GET** /api/v1/bioModel/summaries | Return BioModel summaries.
1010
[**get_bio_model_summary**](BioModelResourceApi.md#get_bio_model_summary) | **GET** /api/v1/bioModel/{bioModelID}/summary | All of the text based information about a BioModel (summary, version, publication status, etc...), but not the actual BioModel itself.
1111
[**get_bio_model_vcml**](BioModelResourceApi.md#get_bio_model_vcml) | **GET** /api/v1/bioModel/{bioModelID}/vcml_download | Get the BioModel in VCML format.
12-
[**get_info_containers**](BioModelResourceApi.md#get_info_containers) | **GET** /api/v1/bioModel/infoContainers |
12+
[**get_summaries_container**](BioModelResourceApi.md#get_summaries_container) | **GET** /api/v1/bioModel/summariesContainer |
1313
[**save_bio_model**](BioModelResourceApi.md#save_bio_model) | **POST** /api/v1/bioModel | Save's the given BioModel. Optional parameters of name and simulations to update due to math changes. Returns saved BioModel as VCML.
1414

1515

@@ -346,8 +346,8 @@ No authorization required
346346

347347
[[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)
348348

349-
# **get_info_containers**
350-
> VCellInfoContainer get_info_containers()
349+
# **get_summaries_container**
350+
> VCellSummaryContainer get_summaries_container()
351351
352352

353353

@@ -359,7 +359,7 @@ All of the summary objects for this particular user.
359359
import time
360360
import os
361361
import vcell_client
362-
from vcell_client.models.v_cell_info_container import VCellInfoContainer
362+
from vcell_client.models.v_cell_summary_container import VCellSummaryContainer
363363
from vcell_client.rest import ApiException
364364
from pprint import pprint
365365

@@ -376,11 +376,11 @@ with vcell_client.ApiClient(configuration) as api_client:
376376
api_instance = vcell_client.BioModelResourceApi(api_client)
377377

378378
try:
379-
api_response = api_instance.get_info_containers()
380-
print("The response of BioModelResourceApi->get_info_containers:\n")
379+
api_response = api_instance.get_summaries_container()
380+
print("The response of BioModelResourceApi->get_summaries_container:\n")
381381
pprint(api_response)
382382
except Exception as e:
383-
print("Exception when calling BioModelResourceApi->get_info_containers: %s\n" % e)
383+
print("Exception when calling BioModelResourceApi->get_summaries_container: %s\n" % e)
384384
```
385385

386386

@@ -390,7 +390,7 @@ This endpoint does not need any parameter.
390390

391391
### Return type
392392

393-
[**VCellInfoContainer**](VCellInfoContainer.md)
393+
[**VCellSummaryContainer**](VCellSummaryContainer.md)
394394

395395
### Authorization
396396

‎python-restclient/docs/VCellSummaryContainer.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# VCellSummaryContainer
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**image_summaries** | [**List[VCImageSummary]**](VCImageSummary.md) | | [optional]
8+
**geometry_summaries** | [**List[GeometrySummary]**](GeometrySummary.md) | | [optional]
9+
**math_model_summaries** | [**List[MathModelSummary]**](MathModelSummary.md) | | [optional]
10+
**bio_model_summaries** | [**List[BioModelSummary]**](BioModelSummary.md) | | [optional]
11+
12+
## Example
13+
14+
```python
15+
from vcell_client.models.v_cell_summary_container import VCellSummaryContainer
16+
17+
# TODO update the JSON string below
18+
json = "{}"
19+
# create an instance of VCellSummaryContainer from a JSON string
20+
v_cell_summary_container_instance = VCellSummaryContainer.from_json(json)
21+
# print the JSON string representation of the object
22+
print VCellSummaryContainer.to_json()
23+
24+
# convert the object into a dict
25+
v_cell_summary_container_dict = v_cell_summary_container_instance.to_dict()
26+
# create an instance of VCellSummaryContainer from a dict
27+
v_cell_summary_container_form_dict = v_cell_summary_container.from_dict(v_cell_summary_container_dict)
28+
```
29+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
30+
31+

‎python-restclient/docs/VersionFlag.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**version_flag** | **int** | | [optional]
87
**int_value** | **int** | | [optional]
98
**archived** | **bool** | | [optional]
109
**current** | **bool** | | [optional]

0 commit comments

Comments
 (0)