Skip to content

Commit

Permalink
Merge pull request #1238 from virtualcell/api-client-usability
Browse files Browse the repository at this point in the history
improve api clients login
  • Loading branch information
jcschaff committed May 2, 2024
2 parents ebd99e1 + 1d5b172 commit 59f7e1f
Show file tree
Hide file tree
Showing 53 changed files with 2,942 additions and 777 deletions.
6 changes: 4 additions & 2 deletions python-restclient/.openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,14 @@ docs/BioModelResourceApi.md
docs/BiomodelRef.md
docs/HelloWorldApi.md
docs/HelloWorldMessage.md
docs/Identity.md
docs/MathmodelRef.md
docs/Publication.md
docs/PublicationResourceApi.md
docs/Simulation.md
docs/User.md
docs/UserIdentityJSONSafe.md
docs/UserLoginInfoForMapping.md
docs/UserRegistrationInfo.md
docs/UsersResourceApi.md
pyproject.toml
test/__init__.py
Expand All @@ -33,11 +34,12 @@ vcell_client/models/acces_token_representation_record.py
vcell_client/models/bio_model.py
vcell_client/models/biomodel_ref.py
vcell_client/models/hello_world_message.py
vcell_client/models/identity.py
vcell_client/models/mathmodel_ref.py
vcell_client/models/publication.py
vcell_client/models/simulation.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/py.typed
vcell_client/rest.py
10 changes: 6 additions & 4 deletions python-restclient/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,11 +93,12 @@ Class | Method | HTTP request | Description
*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
*UsersResourceApi* | [**clear_v_cell_identity**](docs/UsersResourceApi.md#clear_v_cell_identity) | **PUT** /api/v1/users/unmapUser/{userName} | remove vcell identity mapping
*UsersResourceApi* | [**get_legacy_api_token**](docs/UsersResourceApi.md#get_legacy_api_token) | **POST** /api/v1/users/bearerToken | Get token for legacy API
*UsersResourceApi* | [**get_mapped_user**](docs/UsersResourceApi.md#get_mapped_user) | **GET** /api/v1/users/mappedUser | Get mapped VCell identity
*UsersResourceApi* | [**get_me**](docs/UsersResourceApi.md#get_me) | **GET** /api/v1/users/me | Get current user
*UsersResourceApi* | [**get_v_cell_identity**](docs/UsersResourceApi.md#get_v_cell_identity) | **GET** /api/v1/users/getIdentity | Get mapped VCell identity
*UsersResourceApi* | [**set_v_cell_identity**](docs/UsersResourceApi.md#set_v_cell_identity) | **POST** /api/v1/users/mapUser | set vcell identity mapping
*UsersResourceApi* | [**map_new_user**](docs/UsersResourceApi.md#map_new_user) | **POST** /api/v1/users/newUser | create vcell user
*UsersResourceApi* | [**map_user**](docs/UsersResourceApi.md#map_user) | **POST** /api/v1/users/mapUser | map vcell user
*UsersResourceApi* | [**unmap_user**](docs/UsersResourceApi.md#unmap_user) | **PUT** /api/v1/users/unmapUser/{userName} | remove vcell identity mapping


## Documentation For Models
Expand All @@ -106,12 +107,13 @@ Class | Method | HTTP request | Description
- [BioModel](docs/BioModel.md)
- [BiomodelRef](docs/BiomodelRef.md)
- [HelloWorldMessage](docs/HelloWorldMessage.md)
- [Identity](docs/Identity.md)
- [MathmodelRef](docs/MathmodelRef.md)
- [Publication](docs/Publication.md)
- [Simulation](docs/Simulation.md)
- [User](docs/User.md)
- [UserIdentityJSONSafe](docs/UserIdentityJSONSafe.md)
- [UserLoginInfoForMapping](docs/UserLoginInfoForMapping.md)
- [UserRegistrationInfo](docs/UserRegistrationInfo.md)


<a id="documentation-for-authorization"></a>
Expand Down
2 changes: 1 addition & 1 deletion python-restclient/docs/BioModel.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Name | Type | Description | Notes
**saved_date** | **int** | | [optional]
**annot** | **str** | | [optional]
**branch_id** | **str** | | [optional]
**model_key** | **str** | | [optional]
**phys_model_key** | **str** | | [optional]
**owner_name** | **str** | | [optional]
**owner_key** | **str** | | [optional]
**simulations** | [**List[Simulation]**](Simulation.md) | | [optional]
Expand Down
31 changes: 31 additions & 0 deletions python-restclient/docs/Identity.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Identity


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**principal_name** | **str** | | [optional]
**roles** | **List[str]** | | [optional]
**attributes** | **List[str]** | | [optional]
**credentials** | **List[str]** | | [optional]

## Example

```python
from vcell_client.models.identity import Identity

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

# convert the object into a dict
identity_dict = identity_instance.to_dict()
# create an instance of Identity from a dict
identity_form_dict = identity.from_dict(identity_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)


32 changes: 32 additions & 0 deletions python-restclient/docs/UserRegistrationInfo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# UserRegistrationInfo


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**user_id** | **str** | | [optional]
**title** | **str** | | [optional]
**organization** | **str** | | [optional]
**country** | **str** | | [optional]
**email_notification** | **bool** | | [optional]

## Example

```python
from vcell_client.models.user_registration_info import UserRegistrationInfo

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

# convert the object into a dict
user_registration_info_dict = user_registration_info_instance.to_dict()
# create an instance of UserRegistrationInfo from a dict
user_registration_info_form_dict = user_registration_info.from_dict(user_registration_info_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)


0 comments on commit 59f7e1f

Please sign in to comment.