Merge pull request #1550 from virtualcell/vcinfo-container-resource

VCInfo Container is Retrieved from the New API

Author: Ezequiel-Valencia

python-restclient/.openapi-generator/FILES

@@ -92,6 +92,7 @@ docs/VCSimulationIdentifier.md
 docs/VCellHTTPError.md
 docs/VCellSite.md
 docs/VCellSoftwareVersion.md
+docs/VCellSummaryContainer.md
 docs/VariableDomain.md
 docs/VariableMode.md
 docs/VariableSpecs.md
@@ -195,6 +196,7 @@ vcell_client/models/user_registration_info.py
 vcell_client/models/v_cell_http_error.py
 vcell_client/models/v_cell_site.py
 vcell_client/models/v_cell_software_version.py
+vcell_client/models/v_cell_summary_container.py
 vcell_client/models/variable_domain.py
 vcell_client/models/variable_mode.py
 vcell_client/models/variable_specs.py

python-restclient/README.md

@@ -95,6 +95,7 @@ Class | Method | HTTP request | Description
 *BioModelResourceApi* | [**get_bio_model_summaries**](docs/BioModelResourceApi.md#get_bio_model_summaries) | **GET** /api/v1/bioModel/summaries | Return BioModel summaries.
 *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.
 *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.
+*BioModelResourceApi* | [**get_summaries_container**](docs/BioModelResourceApi.md#get_summaries_container) | **GET** /api/v1/bioModel/summariesContainer | 
 *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.
 *ExportResourceApi* | [**export_n5**](docs/ExportResourceApi.md#export_n5) | **POST** /api/v1/export/N5 | 
 *ExportResourceApi* | [**export_status**](docs/ExportResourceApi.md#export_status) | **GET** /api/v1/export/status | 
@@ -226,6 +227,7 @@ Class | Method | HTTP request | Description
  - [VCellHTTPError](docs/VCellHTTPError.md)
  - [VCellSite](docs/VCellSite.md)
  - [VCellSoftwareVersion](docs/VCellSoftwareVersion.md)
+ - [VCellSummaryContainer](docs/VCellSummaryContainer.md)
  - [VariableDomain](docs/VariableDomain.md)
  - [VariableMode](docs/VariableMode.md)
  - [VariableSpecs](docs/VariableSpecs.md)

python-restclient/docs/BioModelChildSummary.md

@@ -4,17 +4,13 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**sc_names** | **List[str]** |  | [optional] 
-**sc_annots** | **List[str]** |  | [optional] 
-**geo_names** | **List[str]** |  | [optional] 
-**geo_dims** | **List[int]** |  | [optional] 
 **app_types** | [**List[MathType]**](MathType.md) |  | [optional] 
-**sim_names** | **List[List[str]]** |  | [optional] 
-**sim_annots** | **List[List[str]]** |  | [optional] 
 **geometry_dimensions** | **List[int]** |  | [optional] 
 **geometry_names** | **List[str]** |  | [optional] 
 **simulation_context_annotations** | **List[str]** |  | [optional] 
 **simulation_context_names** | **List[str]** |  | [optional] 
+**all_simulation_names** | **List[List[str]]** |  | [optional] 
+**all_simulation_annots** | **List[List[str]]** |  | [optional] 
 **application_info** | [**List[ApplicationInfo]**](ApplicationInfo.md) |  | [optional] 
 
 ## Example

python-restclient/docs/BioModelResourceApi.md

@@ -9,6 +9,7 @@ Method | HTTP request | Description
 [**get_bio_model_summaries**](BioModelResourceApi.md#get_bio_model_summaries) | **GET** /api/v1/bioModel/summaries | Return BioModel summaries.
 [**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.
 [**get_bio_model_vcml**](BioModelResourceApi.md#get_bio_model_vcml) | **GET** /api/v1/bioModel/{bioModelID}/vcml_download | Get the BioModel in VCML format.
+[**get_summaries_container**](BioModelResourceApi.md#get_summaries_container) | **GET** /api/v1/bioModel/summariesContainer | 
 [**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.
 
 
@@ -345,6 +346,69 @@ No authorization required
 
 [[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)
 
+# **get_summaries_container**
+> VCellSummaryContainer get_summaries_container()
+
+
+
+All of the summary objects for this particular user.
+
+### Example
+
+```python
+import time
+import os
+import vcell_client
+from vcell_client.models.v_cell_summary_container import VCellSummaryContainer
+from vcell_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://vcell.cam.uchc.edu
+# See configuration.py for a list of all supported configuration parameters.
+configuration = vcell_client.Configuration(
+    host = "https://vcell.cam.uchc.edu"
+)
+
+
+# Enter a context with an instance of the API client
+with vcell_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = vcell_client.BioModelResourceApi(api_client)
+
+    try:
+        api_response = api_instance.get_summaries_container()
+        print("The response of BioModelResourceApi->get_summaries_container:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling BioModelResourceApi->get_summaries_container: %s\n" % e)
+```
+
+
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**VCellSummaryContainer**](VCellSummaryContainer.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK |  -  |
+**500** | Data Access Exception |  -  |
+
+[[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)
+
 # **save_bio_model**
 > str save_bio_model(body, new_name=new_name, sims_requiring_updates=sims_requiring_updates)
 

python-restclient/docs/VCellInfoContainer.md

@@ -0,0 +1,31 @@
+# VCellInfoContainer
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**image_infos** | [**List[VCImageSummary]**](VCImageSummary.md) |  | [optional] 
+**geometry_info** | [**List[GeometrySummary]**](GeometrySummary.md) |  | [optional] 
+**math_model_infos** | [**List[MathModelSummary]**](MathModelSummary.md) |  | [optional] 
+**bio_model_infos** | [**List[BioModelSummary]**](BioModelSummary.md) |  | [optional] 
+
+## Example
+
+```python
+from vcell_client.models.v_cell_info_container import VCellInfoContainer
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of VCellInfoContainer from a JSON string
+v_cell_info_container_instance = VCellInfoContainer.from_json(json)
+# print the JSON string representation of the object
+print VCellInfoContainer.to_json()
+
+# convert the object into a dict
+v_cell_info_container_dict = v_cell_info_container_instance.to_dict()
+# create an instance of VCellInfoContainer from a dict
+v_cell_info_container_form_dict = v_cell_info_container.from_dict(v_cell_info_container_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

python-restclient/docs/VCellSummaryContainer.md

@@ -0,0 +1,31 @@
+# VCellSummaryContainer
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**image_summaries** | [**List[VCImageSummary]**](VCImageSummary.md) |  | [optional] 
+**geometry_summaries** | [**List[GeometrySummary]**](GeometrySummary.md) |  | [optional] 
+**math_model_summaries** | [**List[MathModelSummary]**](MathModelSummary.md) |  | [optional] 
+**bio_model_summaries** | [**List[BioModelSummary]**](BioModelSummary.md) |  | [optional] 
+
+## Example
+
+```python
+from vcell_client.models.v_cell_summary_container import VCellSummaryContainer
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of VCellSummaryContainer from a JSON string
+v_cell_summary_container_instance = VCellSummaryContainer.from_json(json)
+# print the JSON string representation of the object
+print VCellSummaryContainer.to_json()
+
+# convert the object into a dict
+v_cell_summary_container_dict = v_cell_summary_container_instance.to_dict()
+# create an instance of VCellSummaryContainer from a dict
+v_cell_summary_container_form_dict = v_cell_summary_container.from_dict(v_cell_summary_container_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

python-restclient/docs/VersionFlag.md

@@ -4,7 +4,6 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**version_flag** | **int** |  | [optional] 
 **int_value** | **int** |  | [optional] 
 **archived** | **bool** |  | [optional] 
 **current** | **bool** |  | [optional]