Skip to content

Commit

Permalink
Clarify Endpoint Function Name
Browse files Browse the repository at this point in the history
Instead of create, its update.
  • Loading branch information
AvocadoMoon committed Jan 14, 2025
1 parent a342c95 commit 51b85e6
Show file tree
Hide file tree
Showing 19 changed files with 137 additions and 137 deletions.
2 changes: 1 addition & 1 deletion python-restclient/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ Class | Method | HTTP request | Description
*PublicationResourceApi* | [**delete_publication**](docs/PublicationResourceApi.md#delete_publication) | **DELETE** /api/v1/publications/{id} | Delete publication
*PublicationResourceApi* | [**get_publication_by_id**](docs/PublicationResourceApi.md#get_publication_by_id) | **GET** /api/v1/publications/{id} | Get publication by ID
*PublicationResourceApi* | [**get_publications**](docs/PublicationResourceApi.md#get_publications) | **GET** /api/v1/publications | Get all publications
*PublicationResourceApi* | [**update_publication**](docs/PublicationResourceApi.md#update_publication) | **PUT** /api/v1/publications | Create publication
*PublicationResourceApi* | [**update_publication**](docs/PublicationResourceApi.md#update_publication) | **PUT** /api/v1/publications | Update publication
*SimulationResourceApi* | [**get_simulation_status**](docs/SimulationResourceApi.md#get_simulation_status) | **GET** /api/v1/Simulation/{simID}/simulationStatus | Get the status of simulation running
*SimulationResourceApi* | [**start_simulation**](docs/SimulationResourceApi.md#start_simulation) | **POST** /api/v1/Simulation/{simID}/startSimulation | Start a simulation.
*SimulationResourceApi* | [**stop_simulation**](docs/SimulationResourceApi.md#stop_simulation) | **POST** /api/v1/Simulation/{simID}/stopSimulation | Stop a simulation.
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 | - |
**401** | Not Authorized | - |
**403** | Not Allowed | - |
**401** | Not Authorized | - |

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

6 changes: 3 additions & 3 deletions python-restclient/docs/PublicationResourceApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Method | HTTP request | Description
[**delete_publication**](PublicationResourceApi.md#delete_publication) | **DELETE** /api/v1/publications/{id} | Delete publication
[**get_publication_by_id**](PublicationResourceApi.md#get_publication_by_id) | **GET** /api/v1/publications/{id} | Get publication by ID
[**get_publications**](PublicationResourceApi.md#get_publications) | **GET** /api/v1/publications | Get all publications
[**update_publication**](PublicationResourceApi.md#update_publication) | **PUT** /api/v1/publications | Create publication
[**update_publication**](PublicationResourceApi.md#update_publication) | **PUT** /api/v1/publications | Update publication


# **create_publication**
Expand Down Expand Up @@ -267,7 +267,7 @@ No authorization required
# **update_publication**
> Publication update_publication(publication=publication)
Create publication
Update publication

### Example

Expand All @@ -293,7 +293,7 @@ with vcell_client.ApiClient(configuration) as api_client:
publication = vcell_client.Publication() # Publication | (optional)

try:
# Create publication
# Update publication
api_response = api_instance.update_publication(publication=publication)
print("The response of PublicationResourceApi->update_publication:\n")
pprint(api_response)
Expand Down
6 changes: 3 additions & 3 deletions python-restclient/docs/SimulationResourceApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,8 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK | - |
**401** | Not Authorized | - |
**403** | Not Allowed | - |
**401** | Not Authorized | - |

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

Expand Down Expand Up @@ -150,8 +150,8 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK | - |
**401** | Not Authorized | - |
**403** | Not Allowed | - |
**401** | Not Authorized | - |

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

Expand Down Expand Up @@ -221,8 +221,8 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK | - |
**401** | Not Authorized | - |
**403** | Not Allowed | - |
**401** | Not Authorized | - |

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

12 changes: 6 additions & 6 deletions python-restclient/docs/UsersResourceApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,8 +208,8 @@ This endpoint does not need any parameter.
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK | - |
**401** | Not Authorized | - |
**403** | Not Allowed | - |
**401** | Not Authorized | - |

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

Expand Down Expand Up @@ -275,8 +275,8 @@ This endpoint does not need any parameter.
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful, returning the identity | - |
**401** | Not Authorized | - |
**403** | Not Allowed | - |
**401** | Not Authorized | - |

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

Expand Down Expand Up @@ -406,8 +406,8 @@ void (empty response body)
|-------------|-------------|------------------|
**200** | Successful, returning the identity | - |
**409** | VCell Identity not mapped, userid already exists | - |
**401** | Not Authorized | - |
**403** | Not Allowed | - |
**401** | Not Authorized | - |

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

Expand Down Expand Up @@ -477,8 +477,8 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK | - |
**401** | Not Authorized | - |
**403** | Not Allowed | - |
**401** | Not Authorized | - |

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

Expand Down Expand Up @@ -611,8 +611,8 @@ void (empty response body)
|-------------|-------------|------------------|
**200** | magic link sent in email if appropriate | - |
**400** | unable to process request | - |
**401** | Not Authorized | - |
**403** | Not Allowed | - |
**401** | Not Authorized | - |

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

Expand Down Expand Up @@ -681,8 +681,8 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK | - |
**401** | Not Authorized | - |
**403** | Not Allowed | - |
**401** | Not Authorized | - |

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

12 changes: 6 additions & 6 deletions python-restclient/vcell_client/api/bio_model_resource_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -612,8 +612,8 @@ def upload_bio_model(

_response_types_map: Dict[str, Optional[str]] = {
'200': "str",
'401': None,
'403': None
'403': None,
'401': None

}
response_data = self.api_client.call_api(
Expand Down Expand Up @@ -681,8 +681,8 @@ def upload_bio_model_with_http_info(

_response_types_map: Dict[str, Optional[str]] = {
'200': "str",
'401': None,
'403': None
'403': None,
'401': None

}
response_data = self.api_client.call_api(
Expand Down Expand Up @@ -750,8 +750,8 @@ def upload_bio_model_without_preload_content(

_response_types_map: Dict[str, Optional[str]] = {
'200': "str",
'401': None,
'403': None
'403': None,
'401': None

}
response_data = self.api_client.call_api(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1086,7 +1086,7 @@ def update_publication(
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> Publication:
"""Create publication
"""Update publication
:param publication:
Expand Down Expand Up @@ -1153,7 +1153,7 @@ def update_publication_with_http_info(
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[Publication]:
"""Create publication
"""Update publication
:param publication:
Expand Down Expand Up @@ -1220,7 +1220,7 @@ def update_publication_without_preload_content(
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
"""Create publication
"""Update publication
:param publication:
Expand Down
36 changes: 18 additions & 18 deletions python-restclient/vcell_client/api/simulation_resource_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,8 @@ def get_simulation_status(

_response_types_map: Dict[str, Optional[str]] = {
'200': "SimulationStatusPersistentRecord",
'401': None,
'403': None
'403': None,
'401': None

}
response_data = self.api_client.call_api(
Expand Down Expand Up @@ -188,8 +188,8 @@ def get_simulation_status_with_http_info(

_response_types_map: Dict[str, Optional[str]] = {
'200': "SimulationStatusPersistentRecord",
'401': None,
'403': None
'403': None,
'401': None

}
response_data = self.api_client.call_api(
Expand Down Expand Up @@ -265,8 +265,8 @@ def get_simulation_status_without_preload_content(

_response_types_map: Dict[str, Optional[str]] = {
'200': "SimulationStatusPersistentRecord",
'401': None,
'403': None
'403': None,
'401': None

}
response_data = self.api_client.call_api(
Expand Down Expand Up @@ -402,8 +402,8 @@ def start_simulation(

_response_types_map: Dict[str, Optional[str]] = {
'200': "List[StatusMessage]",
'401': None,
'403': None
'403': None,
'401': None

}
response_data = self.api_client.call_api(
Expand Down Expand Up @@ -471,8 +471,8 @@ def start_simulation_with_http_info(

_response_types_map: Dict[str, Optional[str]] = {
'200': "List[StatusMessage]",
'401': None,
'403': None
'403': None,
'401': None

}
response_data = self.api_client.call_api(
Expand Down Expand Up @@ -540,8 +540,8 @@ def start_simulation_without_preload_content(

_response_types_map: Dict[str, Optional[str]] = {
'200': "List[StatusMessage]",
'401': None,
'403': None
'403': None,
'401': None

}
response_data = self.api_client.call_api(
Expand Down Expand Up @@ -667,8 +667,8 @@ def stop_simulation(

_response_types_map: Dict[str, Optional[str]] = {
'200': "List[StatusMessage]",
'401': None,
'403': None
'403': None,
'401': None

}
response_data = self.api_client.call_api(
Expand Down Expand Up @@ -736,8 +736,8 @@ def stop_simulation_with_http_info(

_response_types_map: Dict[str, Optional[str]] = {
'200': "List[StatusMessage]",
'401': None,
'403': None
'403': None,
'401': None

}
response_data = self.api_client.call_api(
Expand Down Expand Up @@ -805,8 +805,8 @@ def stop_simulation_without_preload_content(

_response_types_map: Dict[str, Optional[str]] = {
'200': "List[StatusMessage]",
'401': None,
'403': None
'403': None,
'401': None

}
response_data = self.api_client.call_api(
Expand Down
Loading

0 comments on commit 51b85e6

Please sign in to comment.