Skip to content

Commit

Permalink
Auto Generated Rest Clients
Browse files Browse the repository at this point in the history
  • Loading branch information
AvocadoMoon committed Jan 2, 2025
1 parent f9751ef commit 9504791
Show file tree
Hide file tree
Showing 54 changed files with 1,953 additions and 3,244 deletions.
31 changes: 5 additions & 26 deletions python-restclient/.openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,15 @@ docs/BatchSystemType.md
docs/BioModel.md
docs/BioModelResourceApi.md
docs/BiomodelRef.md
docs/CartesianMesh.md
docs/Coordinate.md
docs/DataIdentifier.md
docs/DetailedState.md
docs/Domain.md
docs/Extent.md
docs/ExternalDataIdentifier.md
docs/FieldDataDBOperationSpec.md
docs/FieldDataFileOperationSpec.md
docs/FieldDataInfo.md
docs/FieldDataNoCopyConflict.md
docs/FieldDataReferences.md
docs/FieldDataReference.md
docs/FieldDataResourceApi.md
docs/FieldDataSaveResults.md
docs/GroupAccess.md
docs/FieldDataShape.md
docs/HelloWorldApi.md
docs/HelloWorldMessage.md
docs/HtcJobID.md
Expand All @@ -43,7 +37,6 @@ docs/SimulationResourceApi.md
docs/SimulationStatusPersistentRecord.md
docs/Status.md
docs/StatusMessage.md
docs/UCDInfo.md
docs/User.md
docs/UserIdentityJSONSafe.md
docs/UserLoginInfoForMapping.md
Expand All @@ -52,12 +45,9 @@ docs/UsersResourceApi.md
docs/VCSimulationIdentifier.md
docs/VariableDomain.md
docs/VariableType.md
docs/Version.md
docs/VersionFlag.md
docs/VersionableType.md
docs/VersionableTypeVersion.md
pyproject.toml
test/__init__.py
test/test_field_data_shape.py
tox.ini
vcell_client/__init__.py
vcell_client/api/__init__.py
Expand All @@ -78,20 +68,14 @@ vcell_client/models/analyzed_results_from_field_data.py
vcell_client/models/batch_system_type.py
vcell_client/models/bio_model.py
vcell_client/models/biomodel_ref.py
vcell_client/models/cartesian_mesh.py
vcell_client/models/coordinate.py
vcell_client/models/data_identifier.py
vcell_client/models/detailed_state.py
vcell_client/models/domain.py
vcell_client/models/extent.py
vcell_client/models/external_data_identifier.py
vcell_client/models/field_data_db_operation_spec.py
vcell_client/models/field_data_file_operation_spec.py
vcell_client/models/field_data_info.py
vcell_client/models/field_data_no_copy_conflict.py
vcell_client/models/field_data_references.py
vcell_client/models/field_data_reference.py
vcell_client/models/field_data_save_results.py
vcell_client/models/group_access.py
vcell_client/models/field_data_shape.py
vcell_client/models/hello_world_message.py
vcell_client/models/htc_job_id.py
vcell_client/models/i_size.py
Expand All @@ -109,17 +93,12 @@ vcell_client/models/simulation_queue_id.py
vcell_client/models/simulation_status_persistent_record.py
vcell_client/models/status.py
vcell_client/models/status_message.py
vcell_client/models/ucd_info.py
vcell_client/models/user.py
vcell_client/models/user_identity_json_safe.py
vcell_client/models/user_login_info_for_mapping.py
vcell_client/models/user_registration_info.py
vcell_client/models/variable_domain.py
vcell_client/models/variable_type.py
vcell_client/models/vc_simulation_identifier.py
vcell_client/models/version.py
vcell_client/models/version_flag.py
vcell_client/models/versionable_type.py
vcell_client/models/versionable_type_version.py
vcell_client/py.typed
vcell_client/rest.py
25 changes: 6 additions & 19 deletions python-restclient/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,13 +89,11 @@ Class | Method | HTTP request | Description
*BioModelResourceApi* | [**delete_bio_model**](docs/BioModelResourceApi.md#delete_bio_model) | **DELETE** /api/v1/bioModel/{bioModelID} | Delete the BioModel from VCell's database.
*BioModelResourceApi* | [**get_biomodel_by_id**](docs/BioModelResourceApi.md#get_biomodel_by_id) | **GET** /api/v1/bioModel/{bioModelID} | Get BioModel information in JSON format by ID.
*BioModelResourceApi* | [**upload_bio_model**](docs/BioModelResourceApi.md#upload_bio_model) | **POST** /api/v1/bioModel/upload_bioModel | Upload the BioModel to VCell database. Returns BioModel ID.
*FieldDataResourceApi* | [**copy_field_data**](docs/FieldDataResourceApi.md#copy_field_data) | **POST** /api/v1/fieldData/copy | Copy an existing field data entry.
*FieldDataResourceApi* | [**create_new_field_data_from_file_already_analyzed**](docs/FieldDataResourceApi.md#create_new_field_data_from_file_already_analyzed) | **POST** /api/v1/fieldData/createFieldDataFromFileAlreadyAnalyzed |
*FieldDataResourceApi* | [**create_new_field_data_from_simulation**](docs/FieldDataResourceApi.md#create_new_field_data_from_simulation) | **POST** /api/v1/fieldData/createFieldDataFromSimulation | Create new field data from a simulation.
*FieldDataResourceApi* | [**delete_field_data**](docs/FieldDataResourceApi.md#delete_field_data) | **DELETE** /api/v1/fieldData | Delete the selected field data.
*FieldDataResourceApi* | [**generate_field_data_estimate**](docs/FieldDataResourceApi.md#generate_field_data_estimate) | **POST** /api/v1/fieldData/analyzeFieldDataFromFile |
*FieldDataResourceApi* | [**analyze_field_data_file**](docs/FieldDataResourceApi.md#analyze_field_data_file) | **POST** /api/v1/fieldData/analyzeFieldDataFile | Analyze the field data from the uploaded file. Filenames must be lowercase alphanumeric, and can contain underscores.
*FieldDataResourceApi* | [**create_field_data_from_analyzed_file**](docs/FieldDataResourceApi.md#create_field_data_from_analyzed_file) | **POST** /api/v1/fieldData/createFieldDataFromAnalyzedFile | Take the analyzed results of the field data, modify it to your liking, then save it on the server.
*FieldDataResourceApi* | [**delete_field_data**](docs/FieldDataResourceApi.md#delete_field_data) | **DELETE** /api/v1/fieldData/delete/{fieldDataID} | Delete the selected field data.
*FieldDataResourceApi* | [**get_all_field_data_ids**](docs/FieldDataResourceApi.md#get_all_field_data_ids) | **GET** /api/v1/fieldData/IDs | Get all of the ids used to identify, and retrieve field data.
*FieldDataResourceApi* | [**get_field_data_from_id**](docs/FieldDataResourceApi.md#get_field_data_from_id) | **GET** /api/v1/fieldData | Get the field data from the selected field data ID.
*FieldDataResourceApi* | [**get_field_data_shape_from_id**](docs/FieldDataResourceApi.md#get_field_data_shape_from_id) | **GET** /api/v1/fieldData/fieldDataShape/{fieldDataID} | Get the shape of the field data. That is it's size, origin, extent, and data identifiers.
*HelloWorldApi* | [**get_hello_world**](docs/HelloWorldApi.md#get_hello_world) | **GET** /api/v1/helloworld | Get hello world message.
*PublicationResourceApi* | [**create_publication**](docs/PublicationResourceApi.md#create_publication) | **POST** /api/v1/publications | Create publication
*PublicationResourceApi* | [**delete_publication**](docs/PublicationResourceApi.md#delete_publication) | **DELETE** /api/v1/publications/{id} | Delete publication
Expand Down Expand Up @@ -124,20 +122,14 @@ Class | Method | HTTP request | Description
- [BatchSystemType](docs/BatchSystemType.md)
- [BioModel](docs/BioModel.md)
- [BiomodelRef](docs/BiomodelRef.md)
- [CartesianMesh](docs/CartesianMesh.md)
- [Coordinate](docs/Coordinate.md)
- [DataIdentifier](docs/DataIdentifier.md)
- [DetailedState](docs/DetailedState.md)
- [Domain](docs/Domain.md)
- [Extent](docs/Extent.md)
- [ExternalDataIdentifier](docs/ExternalDataIdentifier.md)
- [FieldDataDBOperationSpec](docs/FieldDataDBOperationSpec.md)
- [FieldDataFileOperationSpec](docs/FieldDataFileOperationSpec.md)
- [FieldDataInfo](docs/FieldDataInfo.md)
- [FieldDataNoCopyConflict](docs/FieldDataNoCopyConflict.md)
- [FieldDataReferences](docs/FieldDataReferences.md)
- [FieldDataReference](docs/FieldDataReference.md)
- [FieldDataSaveResults](docs/FieldDataSaveResults.md)
- [GroupAccess](docs/GroupAccess.md)
- [FieldDataShape](docs/FieldDataShape.md)
- [HelloWorldMessage](docs/HelloWorldMessage.md)
- [HtcJobID](docs/HtcJobID.md)
- [ISize](docs/ISize.md)
Expand All @@ -155,18 +147,13 @@ Class | Method | HTTP request | Description
- [SimulationStatusPersistentRecord](docs/SimulationStatusPersistentRecord.md)
- [Status](docs/Status.md)
- [StatusMessage](docs/StatusMessage.md)
- [UCDInfo](docs/UCDInfo.md)
- [User](docs/User.md)
- [UserIdentityJSONSafe](docs/UserIdentityJSONSafe.md)
- [UserLoginInfoForMapping](docs/UserLoginInfoForMapping.md)
- [UserRegistrationInfo](docs/UserRegistrationInfo.md)
- [VCSimulationIdentifier](docs/VCSimulationIdentifier.md)
- [VariableDomain](docs/VariableDomain.md)
- [VariableType](docs/VariableType.md)
- [Version](docs/Version.md)
- [VersionFlag](docs/VersionFlag.md)
- [VersionableType](docs/VersionableType.md)
- [VersionableTypeVersion](docs/VersionableTypeVersion.md)


<a id="documentation-for-authorization"></a>
Expand Down
2 changes: 1 addition & 1 deletion python-restclient/docs/BioModelResourceApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,8 +202,8 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK | - |
**403** | Not Allowed | - |
**401** | Not Authorized | - |
**403** | Not Allowed | - |

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

1 change: 0 additions & 1 deletion python-restclient/docs/ExternalDataIdentifier.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ Name | Type | Description | Notes
**key** | [**KeyValue**](KeyValue.md) | | [optional]
**owner** | [**User**](User.md) | | [optional]
**name** | **str** | | [optional]
**i_d** | **str** | | [optional]
**job_index** | **int** | | [optional]
**simulation_key** | [**KeyValue**](KeyValue.md) | | [optional]
**parameter_scan_type** | **bool** | | [optional]
Expand Down
30 changes: 30 additions & 0 deletions python-restclient/docs/FieldDataReference.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# FieldDataReference


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**external_data_identifier** | [**ExternalDataIdentifier**](ExternalDataIdentifier.md) | | [optional]
**external_data_annotation** | **str** | | [optional]
**external_data_id_sim_ref** | [**List[KeyValue]**](KeyValue.md) | | [optional]

## Example

```python
from vcell_client.models.field_data_reference import FieldDataReference

# TODO update the JSON string below
json = "{}"
# create an instance of FieldDataReference from a JSON string
field_data_reference_instance = FieldDataReference.from_json(json)
# print the JSON string representation of the object
print FieldDataReference.to_json()

# convert the object into a dict
field_data_reference_dict = field_data_reference_instance.to_dict()
# create an instance of FieldDataReference from a dict
field_data_reference_form_dict = field_data_reference.from_dict(field_data_reference_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)


Loading

0 comments on commit 9504791

Please sign in to comment.