Skip to content

Commit

Permalink
Documentation Update and Version Bump (#153)
Browse files Browse the repository at this point in the history
Supplemental changes to previous PR merged to v2 branch.
  • Loading branch information
anuragsharma-123 authored Jan 27, 2024
1 parent a215cc3 commit cf09f12
Show file tree
Hide file tree
Showing 6 changed files with 55 additions and 1 deletion.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## [2.4.0] - 2024-01-27
### Added
- Added new functions in admin client.
### Fixed
- Typos.

## [2.3.2] - 2024-01-12
### Added
- Added `caching` field in Azure Stateful Node `OsDisk` and `DataDisk` model.
Expand Down
45 changes: 45 additions & 0 deletions docs/clients/admin/admin_client.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,3 +222,48 @@ __Arguments__
__Returns__

`(Object)`: Spotinst API response

<h2 id="spotinst_sdk2.clients.admin.AdminClient.get_users">get_users</h2>

```python
AdminClient.get_users()
```

Retrieves all users from an organization.

__Returns__

`(Object)`: Spotinst API response

<h2 id="spotinst_sdk2.clients.admin.AdminClient.get_user_details">get_user_details</h2>

```python
AdminClient.get_user_details(user_id)
```

Retrieves an individual user details.

__Arguments__

- __user_id (String)__: User ID

__Returns__

`(Object)`: Spotinst API response

<h2 id="spotinst_sdk2.clients.admin.AdminClient.delete_user">delete_user</h2>

```python
AdminClient.delete_user(user_id)
```

Deletes a user from an organization.

__Arguments__

- __user_id (String)__: User ID

__Returns__

`(Object)`: Spotinst API response

1 change: 1 addition & 0 deletions docs/clients/mrscaler/mrscaler_aws_client.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,3 +169,4 @@ __Arguments__
__Returns__

`(Object)`: Elastigroup API response

1 change: 1 addition & 0 deletions docs/clients/ocean/ocean_aws_client.md
Original file line number Diff line number Diff line change
Expand Up @@ -745,3 +745,4 @@ __Arguments__
__Returns__

`(Object)`: Ocean Delete Extended Resource Definition response

1 change: 1 addition & 0 deletions docs/clients/subscription/subscription_client.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,3 +86,4 @@ __Arguments__
__Returns__

`(Object)`: subscription response

2 changes: 1 addition & 1 deletion spotinst_sdk2/version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = '2.3.2'
__version__ = '2.4.0'

0 comments on commit cf09f12

Please sign in to comment.