ionoscloud-dbaas-mongo 1.1.0 → 1.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +2 -2
- data/docs/CHANGELOG.md +38 -0
- data/docs/api/ClustersApi.md +11 -7
- data/docs/api/LogsApi.md +1 -1
- data/docs/api/MetadataApi.md +2 -2
- data/docs/api/RestoresApi.md +1 -1
- data/docs/api/SnapshotsApi.md +11 -5
- data/docs/api/TemplatesApi.md +13 -6
- data/docs/api/UsersApi.md +37 -37
- data/docs/models/ClusterList.md +6 -6
- data/docs/models/ClusterResponse.md +1 -1
- data/docs/models/Health.md +15 -0
- data/docs/models/Metadata.md +3 -1
- data/docs/models/Pagination.md +6 -6
- data/docs/models/SnapshotList.md +6 -6
- data/docs/models/SnapshotResponse.md +1 -1
- data/docs/models/TemplateList.md +6 -6
- data/docs/models/User.md +1 -1
- data/docs/models/UserMetadata.md +1 -3
- data/ionoscloud-dbaas-mongo.gemspec +3 -3
- data/lib/ionoscloud-dbaas-mongo/api/clusters_api.rb +16 -2
- data/lib/ionoscloud-dbaas-mongo/api/logs_api.rb +2 -2
- data/lib/ionoscloud-dbaas-mongo/api/metadata_api.rb +2 -2
- data/lib/ionoscloud-dbaas-mongo/api/restores_api.rb +2 -2
- data/lib/ionoscloud-dbaas-mongo/api/snapshots_api.rb +16 -2
- data/lib/ionoscloud-dbaas-mongo/api/templates_api.rb +16 -2
- data/lib/ionoscloud-dbaas-mongo/api/users_api.rb +32 -36
- data/lib/ionoscloud-dbaas-mongo/api_client.rb +3 -3
- data/lib/ionoscloud-dbaas-mongo/api_error.rb +2 -2
- data/lib/ionoscloud-dbaas-mongo/configuration.rb +2 -2
- data/lib/ionoscloud-dbaas-mongo/models/api_version.rb +2 -2
- data/lib/ionoscloud-dbaas-mongo/models/cluster_list.rb +24 -11
- data/lib/ionoscloud-dbaas-mongo/models/cluster_list_all_of.rb +2 -2
- data/lib/ionoscloud-dbaas-mongo/models/cluster_logs.rb +2 -2
- data/lib/ionoscloud-dbaas-mongo/models/cluster_logs_instances.rb +2 -2
- data/lib/ionoscloud-dbaas-mongo/models/cluster_logs_messages.rb +2 -2
- data/lib/ionoscloud-dbaas-mongo/models/cluster_properties.rb +2 -2
- data/lib/ionoscloud-dbaas-mongo/models/cluster_response.rb +2 -2
- data/lib/ionoscloud-dbaas-mongo/models/connection.rb +2 -2
- data/lib/ionoscloud-dbaas-mongo/models/create_cluster_properties.rb +2 -2
- data/lib/ionoscloud-dbaas-mongo/models/create_cluster_request.rb +2 -2
- data/lib/ionoscloud-dbaas-mongo/models/create_restore_request.rb +2 -2
- data/lib/ionoscloud-dbaas-mongo/models/day_of_the_week.rb +2 -2
- data/lib/ionoscloud-dbaas-mongo/models/error_message.rb +2 -2
- data/lib/ionoscloud-dbaas-mongo/models/error_response.rb +2 -2
- data/lib/ionoscloud-dbaas-mongo/models/health.rb +39 -0
- data/lib/ionoscloud-dbaas-mongo/models/maintenance_window.rb +2 -2
- data/lib/ionoscloud-dbaas-mongo/models/metadata.rb +23 -6
- data/lib/ionoscloud-dbaas-mongo/models/pagination.rb +24 -11
- data/lib/ionoscloud-dbaas-mongo/models/pagination_links.rb +3 -3
- data/lib/ionoscloud-dbaas-mongo/models/patch_cluster_properties.rb +2 -2
- data/lib/ionoscloud-dbaas-mongo/models/patch_cluster_request.rb +2 -2
- data/lib/ionoscloud-dbaas-mongo/models/patch_user_properties.rb +2 -2
- data/lib/ionoscloud-dbaas-mongo/models/patch_user_request.rb +2 -2
- data/lib/ionoscloud-dbaas-mongo/models/resource_type.rb +2 -2
- data/lib/ionoscloud-dbaas-mongo/models/snapshot_list.rb +24 -11
- data/lib/ionoscloud-dbaas-mongo/models/snapshot_list_all_of.rb +2 -2
- data/lib/ionoscloud-dbaas-mongo/models/snapshot_properties.rb +2 -2
- data/lib/ionoscloud-dbaas-mongo/models/snapshot_response.rb +3 -3
- data/lib/ionoscloud-dbaas-mongo/models/state.rb +2 -2
- data/lib/ionoscloud-dbaas-mongo/models/template_list.rb +24 -11
- data/lib/ionoscloud-dbaas-mongo/models/template_list_all_of.rb +2 -2
- data/lib/ionoscloud-dbaas-mongo/models/template_response.rb +2 -2
- data/lib/ionoscloud-dbaas-mongo/models/user.rb +2 -2
- data/lib/ionoscloud-dbaas-mongo/models/user_metadata.rb +6 -58
- data/lib/ionoscloud-dbaas-mongo/models/user_properties.rb +2 -2
- data/lib/ionoscloud-dbaas-mongo/models/user_roles.rb +4 -4
- data/lib/ionoscloud-dbaas-mongo/models/users_list.rb +2 -2
- data/lib/ionoscloud-dbaas-mongo/version.rb +3 -3
- data/lib/ionoscloud-dbaas-mongo.rb +3 -2
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +2 -2
- data/spec/spec_helper.rb +2 -2
- metadata +9 -6
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: e3871043094af505bb616a1f6db7948aab0fe7f3c56903ec3145c0be606c2065
|
|
4
|
+
data.tar.gz: 94138a14a2b150fbc6ec933766682c74effdbc4bc75c4c42ba1f567d52b4464f
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: e8968325fc1694be369d26ed3d646430914de39cf824854052574863548dd7e21a0f8c8c45a09a24bd1e13071580d2e51f3c74a259e0b1bf9db1a5ae482f7155
|
|
7
|
+
data.tar.gz: b07e919e58fe0505b218851b22d070b72183ea6d7b72b5d6142fde73b750b4c36fefab20bc8112f6de82e5100c9c3eb70fbd1deb250234b2efdaa8598258aa6e
|
data/Gemfile.lock
CHANGED
data/docs/CHANGELOG.md
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# SDK Ruby DBaaS Mongo
|
|
2
|
+
|
|
3
|
+
## v1.2.1
|
|
4
|
+
|
|
5
|
+
### Added
|
|
6
|
+
- Added PaginationLimit, PaginationOffset query params
|
|
7
|
+
|
|
8
|
+
### Removed
|
|
9
|
+
- Removed User state enum
|
|
10
|
+
|
|
11
|
+
## v1.2.0
|
|
12
|
+
|
|
13
|
+
### Added
|
|
14
|
+
- Added `Health` model that indicates the current health status reported by the cluster
|
|
15
|
+
|
|
16
|
+
### Removed
|
|
17
|
+
|
|
18
|
+
- Removed `database` field for `clusters_users_delete`, `clusters_users_find_by_id`, `clusters_users_patch` method in `UsersApi`
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
## v1.1.0
|
|
22
|
+
|
|
23
|
+
### Added
|
|
24
|
+
|
|
25
|
+
- Added `ClustersPatch` and its underlying data types, requests and execution functions
|
|
26
|
+
- Added `ClustersUsersPatch` and its underlying data types, requests and execution functions
|
|
27
|
+
- Added `Name`, `Edition` for templates
|
|
28
|
+
- Added `Id` for TemplateList
|
|
29
|
+
- Added `Snapshot` as a ResourceType
|
|
30
|
+
- Added `Pagination`: Offset, Limit, Links
|
|
31
|
+
|
|
32
|
+
### Removed
|
|
33
|
+
|
|
34
|
+
- Removed `database` field for `UserProperties`
|
|
35
|
+
|
|
36
|
+
## v1.0.0
|
|
37
|
+
### Overview
|
|
38
|
+
This is the first release of the SDK Ruby DBaaS Mongo. With IONOS Cloud Database as a service, you can quickly setup and manage MongoDB database clusters
|
data/docs/api/ClustersApi.md
CHANGED
|
@@ -74,7 +74,7 @@ end
|
|
|
74
74
|
|
|
75
75
|
### Return type
|
|
76
76
|
|
|
77
|
-
[**ClusterResponse**](ClusterResponse.md)
|
|
77
|
+
[**ClusterResponse**](../models/ClusterResponse.md)
|
|
78
78
|
|
|
79
79
|
### Authorization
|
|
80
80
|
|
|
@@ -149,7 +149,7 @@ end
|
|
|
149
149
|
|
|
150
150
|
### Return type
|
|
151
151
|
|
|
152
|
-
[**ClusterResponse**](ClusterResponse.md)
|
|
152
|
+
[**ClusterResponse**](../models/ClusterResponse.md)
|
|
153
153
|
|
|
154
154
|
### Authorization
|
|
155
155
|
|
|
@@ -188,6 +188,8 @@ end
|
|
|
188
188
|
|
|
189
189
|
api_instance = IonoscloudDbaasMongo::ClustersApi.new
|
|
190
190
|
opts = {
|
|
191
|
+
limit: 100, # Integer | The maximum number of elements to return. Use together with 'offset' for pagination.
|
|
192
|
+
offset: 200, # Integer | The first element to return. Use together with 'limit' for pagination.
|
|
191
193
|
filter_name: 'filter_name_example' # String | Response filter to list only the MongoDB clusters that contain the specified name. The value is case insensitive and matched on the 'displayName' field.
|
|
192
194
|
}
|
|
193
195
|
|
|
@@ -222,11 +224,13 @@ end
|
|
|
222
224
|
|
|
223
225
|
| Name | Type | Description | Notes |
|
|
224
226
|
| ---- | ---- | ----------- | ----- |
|
|
227
|
+
| **limit** | **Integer** | The maximum number of elements to return. Use together with 'offset' for pagination. | [optional][default to 100] |
|
|
228
|
+
| **offset** | **Integer** | The first element to return. Use together with 'limit' for pagination. | [optional][default to 0] |
|
|
225
229
|
| **filter_name** | **String** | Response filter to list only the MongoDB clusters that contain the specified name. The value is case insensitive and matched on the 'displayName' field. | [optional] |
|
|
226
230
|
|
|
227
231
|
### Return type
|
|
228
232
|
|
|
229
|
-
[**ClusterList**](ClusterList.md)
|
|
233
|
+
[**ClusterList**](../models/ClusterList.md)
|
|
230
234
|
|
|
231
235
|
### Authorization
|
|
232
236
|
|
|
@@ -299,11 +303,11 @@ end
|
|
|
299
303
|
| Name | Type | Description | Notes |
|
|
300
304
|
| ---- | ---- | ----------- | ----- |
|
|
301
305
|
| **cluster_id** | **String** | The unique ID of the cluster. | |
|
|
302
|
-
| **patch_cluster_request** | [**PatchClusterRequest**](PatchClusterRequest.md) | Part of the cluster which should be modified. | |
|
|
306
|
+
| **patch_cluster_request** | [**PatchClusterRequest**](../models/PatchClusterRequest.md) | Part of the cluster which should be modified. | |
|
|
303
307
|
|
|
304
308
|
### Return type
|
|
305
309
|
|
|
306
|
-
[**ClusterResponse**](ClusterResponse.md)
|
|
310
|
+
[**ClusterResponse**](../models/ClusterResponse.md)
|
|
307
311
|
|
|
308
312
|
### Authorization
|
|
309
313
|
|
|
@@ -374,11 +378,11 @@ end
|
|
|
374
378
|
|
|
375
379
|
| Name | Type | Description | Notes |
|
|
376
380
|
| ---- | ---- | ----------- | ----- |
|
|
377
|
-
| **create_cluster_request** | [**CreateClusterRequest**](CreateClusterRequest.md) | The cluster to be created. | |
|
|
381
|
+
| **create_cluster_request** | [**CreateClusterRequest**](../models/CreateClusterRequest.md) | The cluster to be created. | |
|
|
378
382
|
|
|
379
383
|
### Return type
|
|
380
384
|
|
|
381
|
-
[**ClusterResponse**](ClusterResponse.md)
|
|
385
|
+
[**ClusterResponse**](../models/ClusterResponse.md)
|
|
382
386
|
|
|
383
387
|
### Authorization
|
|
384
388
|
|
data/docs/api/LogsApi.md
CHANGED
data/docs/api/MetadataApi.md
CHANGED
|
@@ -68,7 +68,7 @@ This endpoint does not need any parameter.
|
|
|
68
68
|
|
|
69
69
|
### Return type
|
|
70
70
|
|
|
71
|
-
[**APIVersion**](APIVersion.md)
|
|
71
|
+
[**APIVersion**](../models/APIVersion.md)
|
|
72
72
|
|
|
73
73
|
### Authorization
|
|
74
74
|
|
|
@@ -140,7 +140,7 @@ This endpoint does not need any parameter.
|
|
|
140
140
|
|
|
141
141
|
### Return type
|
|
142
142
|
|
|
143
|
-
[**Array<APIVersion>**](APIVersion.md)
|
|
143
|
+
[**Array<APIVersion>**](../models/APIVersion.md)
|
|
144
144
|
|
|
145
145
|
### Authorization
|
|
146
146
|
|
data/docs/api/RestoresApi.md
CHANGED
|
@@ -67,7 +67,7 @@ end
|
|
|
67
67
|
| Name | Type | Description | Notes |
|
|
68
68
|
| ---- | ---- | ----------- | ----- |
|
|
69
69
|
| **cluster_id** | **String** | The unique ID of the cluster. | |
|
|
70
|
-
| **create_restore_request** | [**CreateRestoreRequest**](CreateRestoreRequest.md) | The restore request to create. | |
|
|
70
|
+
| **create_restore_request** | [**CreateRestoreRequest**](../models/CreateRestoreRequest.md) | The restore request to create. | |
|
|
71
71
|
|
|
72
72
|
### Return type
|
|
73
73
|
|
data/docs/api/SnapshotsApi.md
CHANGED
|
@@ -9,7 +9,7 @@ All URIs are relative to *https://api.ionos.com/databases/mongodb*
|
|
|
9
9
|
|
|
10
10
|
## clusters_snapshots_get
|
|
11
11
|
|
|
12
|
-
> <SnapshotList> clusters_snapshots_get(cluster_id)
|
|
12
|
+
> <SnapshotList> clusters_snapshots_get(cluster_id, opts)
|
|
13
13
|
|
|
14
14
|
Get the snapshots of your cluster
|
|
15
15
|
|
|
@@ -34,10 +34,14 @@ end
|
|
|
34
34
|
|
|
35
35
|
api_instance = IonoscloudDbaasMongo::SnapshotsApi.new
|
|
36
36
|
cluster_id = 'cluster_id_example' # String | The unique ID of the cluster.
|
|
37
|
+
opts = {
|
|
38
|
+
limit: 100, # Integer | The maximum number of elements to return. Use together with 'offset' for pagination.
|
|
39
|
+
offset: 200 # Integer | The first element to return. Use together with 'limit' for pagination.
|
|
40
|
+
}
|
|
37
41
|
|
|
38
42
|
begin
|
|
39
43
|
# Get the snapshots of your cluster
|
|
40
|
-
result = api_instance.clusters_snapshots_get(cluster_id)
|
|
44
|
+
result = api_instance.clusters_snapshots_get(cluster_id, opts)
|
|
41
45
|
p result
|
|
42
46
|
rescue IonoscloudDbaasMongo::ApiError => e
|
|
43
47
|
puts "Error when calling SnapshotsApi->clusters_snapshots_get: #{e}"
|
|
@@ -48,12 +52,12 @@ end
|
|
|
48
52
|
|
|
49
53
|
This returns an Array which contains the response data, status code and headers.
|
|
50
54
|
|
|
51
|
-
> <Array(<SnapshotList>, Integer, Hash)> clusters_snapshots_get_with_http_info(cluster_id)
|
|
55
|
+
> <Array(<SnapshotList>, Integer, Hash)> clusters_snapshots_get_with_http_info(cluster_id, opts)
|
|
52
56
|
|
|
53
57
|
```ruby
|
|
54
58
|
begin
|
|
55
59
|
# Get the snapshots of your cluster
|
|
56
|
-
data, status_code, headers = api_instance.clusters_snapshots_get_with_http_info(cluster_id)
|
|
60
|
+
data, status_code, headers = api_instance.clusters_snapshots_get_with_http_info(cluster_id, opts)
|
|
57
61
|
p status_code # => 2xx
|
|
58
62
|
p headers # => { ... }
|
|
59
63
|
p data # => <SnapshotList>
|
|
@@ -67,10 +71,12 @@ end
|
|
|
67
71
|
| Name | Type | Description | Notes |
|
|
68
72
|
| ---- | ---- | ----------- | ----- |
|
|
69
73
|
| **cluster_id** | **String** | The unique ID of the cluster. | |
|
|
74
|
+
| **limit** | **Integer** | The maximum number of elements to return. Use together with 'offset' for pagination. | [optional][default to 100] |
|
|
75
|
+
| **offset** | **Integer** | The first element to return. Use together with 'limit' for pagination. | [optional][default to 0] |
|
|
70
76
|
|
|
71
77
|
### Return type
|
|
72
78
|
|
|
73
|
-
[**SnapshotList**](SnapshotList.md)
|
|
79
|
+
[**SnapshotList**](../models/SnapshotList.md)
|
|
74
80
|
|
|
75
81
|
### Authorization
|
|
76
82
|
|
data/docs/api/TemplatesApi.md
CHANGED
|
@@ -9,7 +9,7 @@ All URIs are relative to *https://api.ionos.com/databases/mongodb*
|
|
|
9
9
|
|
|
10
10
|
## templates_get
|
|
11
11
|
|
|
12
|
-
> <TemplateList> templates_get
|
|
12
|
+
> <TemplateList> templates_get(opts)
|
|
13
13
|
|
|
14
14
|
Get Templates
|
|
15
15
|
|
|
@@ -33,10 +33,14 @@ IonoscloudDbaasMongo.configure do |config|
|
|
|
33
33
|
end
|
|
34
34
|
|
|
35
35
|
api_instance = IonoscloudDbaasMongo::TemplatesApi.new
|
|
36
|
+
opts = {
|
|
37
|
+
limit: 100, # Integer | The maximum number of elements to return. Use together with 'offset' for pagination.
|
|
38
|
+
offset: 200 # Integer | The first element to return. Use together with 'limit' for pagination.
|
|
39
|
+
}
|
|
36
40
|
|
|
37
41
|
begin
|
|
38
42
|
# Get Templates
|
|
39
|
-
result = api_instance.templates_get
|
|
43
|
+
result = api_instance.templates_get(opts)
|
|
40
44
|
p result
|
|
41
45
|
rescue IonoscloudDbaasMongo::ApiError => e
|
|
42
46
|
puts "Error when calling TemplatesApi->templates_get: #{e}"
|
|
@@ -47,12 +51,12 @@ end
|
|
|
47
51
|
|
|
48
52
|
This returns an Array which contains the response data, status code and headers.
|
|
49
53
|
|
|
50
|
-
> <Array(<TemplateList>, Integer, Hash)> templates_get_with_http_info
|
|
54
|
+
> <Array(<TemplateList>, Integer, Hash)> templates_get_with_http_info(opts)
|
|
51
55
|
|
|
52
56
|
```ruby
|
|
53
57
|
begin
|
|
54
58
|
# Get Templates
|
|
55
|
-
data, status_code, headers = api_instance.templates_get_with_http_info
|
|
59
|
+
data, status_code, headers = api_instance.templates_get_with_http_info(opts)
|
|
56
60
|
p status_code # => 2xx
|
|
57
61
|
p headers # => { ... }
|
|
58
62
|
p data # => <TemplateList>
|
|
@@ -63,11 +67,14 @@ end
|
|
|
63
67
|
|
|
64
68
|
### Parameters
|
|
65
69
|
|
|
66
|
-
|
|
70
|
+
| Name | Type | Description | Notes |
|
|
71
|
+
| ---- | ---- | ----------- | ----- |
|
|
72
|
+
| **limit** | **Integer** | The maximum number of elements to return. Use together with 'offset' for pagination. | [optional][default to 100] |
|
|
73
|
+
| **offset** | **Integer** | The first element to return. Use together with 'limit' for pagination. | [optional][default to 0] |
|
|
67
74
|
|
|
68
75
|
### Return type
|
|
69
76
|
|
|
70
|
-
[**TemplateList**](TemplateList.md)
|
|
77
|
+
[**TemplateList**](../models/TemplateList.md)
|
|
71
78
|
|
|
72
79
|
### Authorization
|
|
73
80
|
|
data/docs/api/UsersApi.md
CHANGED
|
@@ -4,16 +4,16 @@ All URIs are relative to *https://api.ionos.com/databases/mongodb*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**clusters_users_delete**](UsersApi.md#clusters_users_delete) | **DELETE** /clusters/{clusterId}/users/{
|
|
8
|
-
| [**clusters_users_find_by_id**](UsersApi.md#clusters_users_find_by_id) | **GET** /clusters/{clusterId}/users/{
|
|
9
|
-
| [**clusters_users_get**](UsersApi.md#clusters_users_get) | **GET** /clusters/{clusterId}/users | Get
|
|
10
|
-
| [**clusters_users_patch**](UsersApi.md#clusters_users_patch) | **PATCH** /clusters/{clusterId}/users/{
|
|
7
|
+
| [**clusters_users_delete**](UsersApi.md#clusters_users_delete) | **DELETE** /clusters/{clusterId}/users/{username} | Delete a MongoDB User by ID |
|
|
8
|
+
| [**clusters_users_find_by_id**](UsersApi.md#clusters_users_find_by_id) | **GET** /clusters/{clusterId}/users/{username} | Get a MongoDB User by ID |
|
|
9
|
+
| [**clusters_users_get**](UsersApi.md#clusters_users_get) | **GET** /clusters/{clusterId}/users | Get all Cluster Users |
|
|
10
|
+
| [**clusters_users_patch**](UsersApi.md#clusters_users_patch) | **PATCH** /clusters/{clusterId}/users/{username} | Patch a MongoDB User by ID |
|
|
11
11
|
| [**clusters_users_post**](UsersApi.md#clusters_users_post) | **POST** /clusters/{clusterId}/users | Create MongoDB User |
|
|
12
12
|
|
|
13
13
|
|
|
14
14
|
## clusters_users_delete
|
|
15
15
|
|
|
16
|
-
> <User> clusters_users_delete(cluster_id,
|
|
16
|
+
> <User> clusters_users_delete(cluster_id, username)
|
|
17
17
|
|
|
18
18
|
Delete a MongoDB User by ID
|
|
19
19
|
|
|
@@ -38,12 +38,11 @@ end
|
|
|
38
38
|
|
|
39
39
|
api_instance = IonoscloudDbaasMongo::UsersApi.new
|
|
40
40
|
cluster_id = 'cluster_id_example' # String | The unique ID of the cluster.
|
|
41
|
-
database = 'database_example' # String | The authentication database.
|
|
42
41
|
username = 'username_example' # String | The authentication username.
|
|
43
42
|
|
|
44
43
|
begin
|
|
45
44
|
# Delete a MongoDB User by ID
|
|
46
|
-
result = api_instance.clusters_users_delete(cluster_id,
|
|
45
|
+
result = api_instance.clusters_users_delete(cluster_id, username)
|
|
47
46
|
p result
|
|
48
47
|
rescue IonoscloudDbaasMongo::ApiError => e
|
|
49
48
|
puts "Error when calling UsersApi->clusters_users_delete: #{e}"
|
|
@@ -54,12 +53,12 @@ end
|
|
|
54
53
|
|
|
55
54
|
This returns an Array which contains the response data, status code and headers.
|
|
56
55
|
|
|
57
|
-
> <Array(<User>, Integer, Hash)> clusters_users_delete_with_http_info(cluster_id,
|
|
56
|
+
> <Array(<User>, Integer, Hash)> clusters_users_delete_with_http_info(cluster_id, username)
|
|
58
57
|
|
|
59
58
|
```ruby
|
|
60
59
|
begin
|
|
61
60
|
# Delete a MongoDB User by ID
|
|
62
|
-
data, status_code, headers = api_instance.clusters_users_delete_with_http_info(cluster_id,
|
|
61
|
+
data, status_code, headers = api_instance.clusters_users_delete_with_http_info(cluster_id, username)
|
|
63
62
|
p status_code # => 2xx
|
|
64
63
|
p headers # => { ... }
|
|
65
64
|
p data # => <User>
|
|
@@ -73,12 +72,11 @@ end
|
|
|
73
72
|
| Name | Type | Description | Notes |
|
|
74
73
|
| ---- | ---- | ----------- | ----- |
|
|
75
74
|
| **cluster_id** | **String** | The unique ID of the cluster. | |
|
|
76
|
-
| **database** | **String** | The authentication database. | |
|
|
77
75
|
| **username** | **String** | The authentication username. | |
|
|
78
76
|
|
|
79
77
|
### Return type
|
|
80
78
|
|
|
81
|
-
[**User**](User.md)
|
|
79
|
+
[**User**](../models/User.md)
|
|
82
80
|
|
|
83
81
|
### Authorization
|
|
84
82
|
|
|
@@ -92,11 +90,11 @@ basicAuth, tokenAuth
|
|
|
92
90
|
|
|
93
91
|
## clusters_users_find_by_id
|
|
94
92
|
|
|
95
|
-
> <User> clusters_users_find_by_id(cluster_id,
|
|
93
|
+
> <User> clusters_users_find_by_id(cluster_id, username)
|
|
96
94
|
|
|
97
95
|
Get a MongoDB User by ID
|
|
98
96
|
|
|
99
|
-
Retrieves the MongoDB user identified by the username
|
|
97
|
+
Retrieves the MongoDB user identified by the username.
|
|
100
98
|
|
|
101
99
|
### Examples
|
|
102
100
|
|
|
@@ -117,12 +115,11 @@ end
|
|
|
117
115
|
|
|
118
116
|
api_instance = IonoscloudDbaasMongo::UsersApi.new
|
|
119
117
|
cluster_id = 'cluster_id_example' # String | The unique ID of the cluster.
|
|
120
|
-
database = 'database_example' # String | The authentication database.
|
|
121
118
|
username = 'username_example' # String | The authentication username.
|
|
122
119
|
|
|
123
120
|
begin
|
|
124
121
|
# Get a MongoDB User by ID
|
|
125
|
-
result = api_instance.clusters_users_find_by_id(cluster_id,
|
|
122
|
+
result = api_instance.clusters_users_find_by_id(cluster_id, username)
|
|
126
123
|
p result
|
|
127
124
|
rescue IonoscloudDbaasMongo::ApiError => e
|
|
128
125
|
puts "Error when calling UsersApi->clusters_users_find_by_id: #{e}"
|
|
@@ -133,12 +130,12 @@ end
|
|
|
133
130
|
|
|
134
131
|
This returns an Array which contains the response data, status code and headers.
|
|
135
132
|
|
|
136
|
-
> <Array(<User>, Integer, Hash)> clusters_users_find_by_id_with_http_info(cluster_id,
|
|
133
|
+
> <Array(<User>, Integer, Hash)> clusters_users_find_by_id_with_http_info(cluster_id, username)
|
|
137
134
|
|
|
138
135
|
```ruby
|
|
139
136
|
begin
|
|
140
137
|
# Get a MongoDB User by ID
|
|
141
|
-
data, status_code, headers = api_instance.clusters_users_find_by_id_with_http_info(cluster_id,
|
|
138
|
+
data, status_code, headers = api_instance.clusters_users_find_by_id_with_http_info(cluster_id, username)
|
|
142
139
|
p status_code # => 2xx
|
|
143
140
|
p headers # => { ... }
|
|
144
141
|
p data # => <User>
|
|
@@ -152,12 +149,11 @@ end
|
|
|
152
149
|
| Name | Type | Description | Notes |
|
|
153
150
|
| ---- | ---- | ----------- | ----- |
|
|
154
151
|
| **cluster_id** | **String** | The unique ID of the cluster. | |
|
|
155
|
-
| **database** | **String** | The authentication database. | |
|
|
156
152
|
| **username** | **String** | The authentication username. | |
|
|
157
153
|
|
|
158
154
|
### Return type
|
|
159
155
|
|
|
160
|
-
[**User**](User.md)
|
|
156
|
+
[**User**](../models/User.md)
|
|
161
157
|
|
|
162
158
|
### Authorization
|
|
163
159
|
|
|
@@ -171,9 +167,9 @@ basicAuth, tokenAuth
|
|
|
171
167
|
|
|
172
168
|
## clusters_users_get
|
|
173
169
|
|
|
174
|
-
> <UsersList> clusters_users_get(cluster_id)
|
|
170
|
+
> <UsersList> clusters_users_get(cluster_id, opts)
|
|
175
171
|
|
|
176
|
-
Get
|
|
172
|
+
Get all Cluster Users
|
|
177
173
|
|
|
178
174
|
Retrieves a list of MongoDB users.
|
|
179
175
|
|
|
@@ -196,10 +192,14 @@ end
|
|
|
196
192
|
|
|
197
193
|
api_instance = IonoscloudDbaasMongo::UsersApi.new
|
|
198
194
|
cluster_id = 'cluster_id_example' # String | The unique ID of the cluster.
|
|
195
|
+
opts = {
|
|
196
|
+
limit: 100, # Integer | The maximum number of elements to return. Use together with 'offset' for pagination.
|
|
197
|
+
offset: 200 # Integer | The first element to return. Use together with 'limit' for pagination.
|
|
198
|
+
}
|
|
199
199
|
|
|
200
200
|
begin
|
|
201
|
-
# Get
|
|
202
|
-
result = api_instance.clusters_users_get(cluster_id)
|
|
201
|
+
# Get all Cluster Users
|
|
202
|
+
result = api_instance.clusters_users_get(cluster_id, opts)
|
|
203
203
|
p result
|
|
204
204
|
rescue IonoscloudDbaasMongo::ApiError => e
|
|
205
205
|
puts "Error when calling UsersApi->clusters_users_get: #{e}"
|
|
@@ -210,12 +210,12 @@ end
|
|
|
210
210
|
|
|
211
211
|
This returns an Array which contains the response data, status code and headers.
|
|
212
212
|
|
|
213
|
-
> <Array(<UsersList>, Integer, Hash)> clusters_users_get_with_http_info(cluster_id)
|
|
213
|
+
> <Array(<UsersList>, Integer, Hash)> clusters_users_get_with_http_info(cluster_id, opts)
|
|
214
214
|
|
|
215
215
|
```ruby
|
|
216
216
|
begin
|
|
217
|
-
# Get
|
|
218
|
-
data, status_code, headers = api_instance.clusters_users_get_with_http_info(cluster_id)
|
|
217
|
+
# Get all Cluster Users
|
|
218
|
+
data, status_code, headers = api_instance.clusters_users_get_with_http_info(cluster_id, opts)
|
|
219
219
|
p status_code # => 2xx
|
|
220
220
|
p headers # => { ... }
|
|
221
221
|
p data # => <UsersList>
|
|
@@ -229,10 +229,12 @@ end
|
|
|
229
229
|
| Name | Type | Description | Notes |
|
|
230
230
|
| ---- | ---- | ----------- | ----- |
|
|
231
231
|
| **cluster_id** | **String** | The unique ID of the cluster. | |
|
|
232
|
+
| **limit** | **Integer** | The maximum number of elements to return. Use together with 'offset' for pagination. | [optional][default to 100] |
|
|
233
|
+
| **offset** | **Integer** | The first element to return. Use together with 'limit' for pagination. | [optional][default to 0] |
|
|
232
234
|
|
|
233
235
|
### Return type
|
|
234
236
|
|
|
235
|
-
[**UsersList**](UsersList.md)
|
|
237
|
+
[**UsersList**](../models/UsersList.md)
|
|
236
238
|
|
|
237
239
|
### Authorization
|
|
238
240
|
|
|
@@ -246,7 +248,7 @@ basicAuth, tokenAuth
|
|
|
246
248
|
|
|
247
249
|
## clusters_users_patch
|
|
248
250
|
|
|
249
|
-
> <User> clusters_users_patch(cluster_id,
|
|
251
|
+
> <User> clusters_users_patch(cluster_id, username, patch_user_request)
|
|
250
252
|
|
|
251
253
|
Patch a MongoDB User by ID
|
|
252
254
|
|
|
@@ -271,13 +273,12 @@ end
|
|
|
271
273
|
|
|
272
274
|
api_instance = IonoscloudDbaasMongo::UsersApi.new
|
|
273
275
|
cluster_id = 'cluster_id_example' # String | The unique ID of the cluster.
|
|
274
|
-
database = 'database_example' # String | The authentication database.
|
|
275
276
|
username = 'username_example' # String | The authentication username.
|
|
276
277
|
patch_user_request = IonoscloudDbaasMongo::PatchUserRequest.new # PatchUserRequest | Part of the MongoDB user which should be modified.
|
|
277
278
|
|
|
278
279
|
begin
|
|
279
280
|
# Patch a MongoDB User by ID
|
|
280
|
-
result = api_instance.clusters_users_patch(cluster_id,
|
|
281
|
+
result = api_instance.clusters_users_patch(cluster_id, username, patch_user_request)
|
|
281
282
|
p result
|
|
282
283
|
rescue IonoscloudDbaasMongo::ApiError => e
|
|
283
284
|
puts "Error when calling UsersApi->clusters_users_patch: #{e}"
|
|
@@ -288,12 +289,12 @@ end
|
|
|
288
289
|
|
|
289
290
|
This returns an Array which contains the response data, status code and headers.
|
|
290
291
|
|
|
291
|
-
> <Array(<User>, Integer, Hash)> clusters_users_patch_with_http_info(cluster_id,
|
|
292
|
+
> <Array(<User>, Integer, Hash)> clusters_users_patch_with_http_info(cluster_id, username, patch_user_request)
|
|
292
293
|
|
|
293
294
|
```ruby
|
|
294
295
|
begin
|
|
295
296
|
# Patch a MongoDB User by ID
|
|
296
|
-
data, status_code, headers = api_instance.clusters_users_patch_with_http_info(cluster_id,
|
|
297
|
+
data, status_code, headers = api_instance.clusters_users_patch_with_http_info(cluster_id, username, patch_user_request)
|
|
297
298
|
p status_code # => 2xx
|
|
298
299
|
p headers # => { ... }
|
|
299
300
|
p data # => <User>
|
|
@@ -307,13 +308,12 @@ end
|
|
|
307
308
|
| Name | Type | Description | Notes |
|
|
308
309
|
| ---- | ---- | ----------- | ----- |
|
|
309
310
|
| **cluster_id** | **String** | The unique ID of the cluster. | |
|
|
310
|
-
| **database** | **String** | The authentication database. | |
|
|
311
311
|
| **username** | **String** | The authentication username. | |
|
|
312
|
-
| **patch_user_request** | [**PatchUserRequest**](PatchUserRequest.md) | Part of the MongoDB user which should be modified. | |
|
|
312
|
+
| **patch_user_request** | [**PatchUserRequest**](../models/PatchUserRequest.md) | Part of the MongoDB user which should be modified. | |
|
|
313
313
|
|
|
314
314
|
### Return type
|
|
315
315
|
|
|
316
|
-
[**User**](User.md)
|
|
316
|
+
[**User**](../models/User.md)
|
|
317
317
|
|
|
318
318
|
### Authorization
|
|
319
319
|
|
|
@@ -386,11 +386,11 @@ end
|
|
|
386
386
|
| Name | Type | Description | Notes |
|
|
387
387
|
| ---- | ---- | ----------- | ----- |
|
|
388
388
|
| **cluster_id** | **String** | The unique ID of the cluster. | |
|
|
389
|
-
| **user** | [**User**](User.md) | The user to be created. | |
|
|
389
|
+
| **user** | [**User**](../models/User.md) | The user to be created. | |
|
|
390
390
|
|
|
391
391
|
### Return type
|
|
392
392
|
|
|
393
|
-
[**User**](User.md)
|
|
393
|
+
[**User**](../models/User.md)
|
|
394
394
|
|
|
395
395
|
### Authorization
|
|
396
396
|
|
data/docs/models/ClusterList.md
CHANGED
|
@@ -7,9 +7,9 @@
|
|
|
7
7
|
| **type** | [**ResourceType**](ResourceType.md) | | [optional] |
|
|
8
8
|
| **id** | **String** | The unique ID of the resource. | [optional] |
|
|
9
9
|
| **items** | [**Array<ClusterResponse>**](ClusterResponse.md) | | [optional] |
|
|
10
|
-
| **offset** | **Integer** | The offset specified in the request (if none was specified, the default offset is 0)
|
|
11
|
-
| **limit** | **Integer** | The limit specified in the request (if none was specified,
|
|
12
|
-
| **
|
|
10
|
+
| **offset** | **Integer** | The offset specified in the request (if none was specified, the default offset is 0). | [optional][default to 0] |
|
|
11
|
+
| **limit** | **Integer** | The limit specified in the request (if none was specified, the default limit is 100). | [optional][default to 100] |
|
|
12
|
+
| **links** | [**PaginationLinks**](PaginationLinks.md) | | [optional] |
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -20,9 +20,9 @@ instance = IonoscloudDbaasMongo::ClusterList.new(
|
|
|
20
20
|
type: null,
|
|
21
21
|
id: 498ae72f-411f-11eb-9d07-046c59cc737e,
|
|
22
22
|
items: null,
|
|
23
|
-
offset:
|
|
24
|
-
limit:
|
|
25
|
-
|
|
23
|
+
offset: 200,
|
|
24
|
+
limit: 100,
|
|
25
|
+
links: null
|
|
26
26
|
)
|
|
27
27
|
```
|
|
28
28
|
|
data/docs/models/Metadata.md
CHANGED
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
| **last_modified_by** | **String** | The last user who modified the resource. | [optional] |
|
|
12
12
|
| **last_modified_by_user_id** | **String** | The ID of the user who last modified the resource. | [optional] |
|
|
13
13
|
| **state** | [**State**](State.md) | | [optional] |
|
|
14
|
+
| **health** | [**Health**](Health.md) | | [optional] |
|
|
14
15
|
|
|
15
16
|
## Example
|
|
16
17
|
|
|
@@ -24,7 +25,8 @@ instance = IonoscloudDbaasMongo::Metadata.new(
|
|
|
24
25
|
last_modified_date: 2020-12-11T13:37:50+01:00,
|
|
25
26
|
last_modified_by: jane.doe@example.com,
|
|
26
27
|
last_modified_by_user_id: 87f9a82e-b28d-49ed-9d04-fba2c0459cd3,
|
|
27
|
-
state: null
|
|
28
|
+
state: null,
|
|
29
|
+
health: null
|
|
28
30
|
)
|
|
29
31
|
```
|
|
30
32
|
|
data/docs/models/Pagination.md
CHANGED
|
@@ -4,9 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **offset** | **Integer** | The offset specified in the request (if none was specified, the default offset is 0)
|
|
8
|
-
| **limit** | **Integer** | The limit specified in the request (if none was specified,
|
|
9
|
-
| **
|
|
7
|
+
| **offset** | **Integer** | The offset specified in the request (if none was specified, the default offset is 0). | [optional][default to 0] |
|
|
8
|
+
| **limit** | **Integer** | The limit specified in the request (if none was specified, the default limit is 100). | [optional][default to 100] |
|
|
9
|
+
| **links** | [**PaginationLinks**](PaginationLinks.md) | | [optional] |
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
@@ -14,9 +14,9 @@
|
|
|
14
14
|
require 'ionoscloud-dbaas-mongo'
|
|
15
15
|
|
|
16
16
|
instance = IonoscloudDbaasMongo::Pagination.new(
|
|
17
|
-
offset:
|
|
18
|
-
limit:
|
|
19
|
-
|
|
17
|
+
offset: 200,
|
|
18
|
+
limit: 100,
|
|
19
|
+
links: null
|
|
20
20
|
)
|
|
21
21
|
```
|
|
22
22
|
|
data/docs/models/SnapshotList.md
CHANGED
|
@@ -7,9 +7,9 @@
|
|
|
7
7
|
| **type** | [**ResourceType**](ResourceType.md) | | [optional] |
|
|
8
8
|
| **id** | **String** | The unique ID of the resource. | [optional] |
|
|
9
9
|
| **items** | [**Array<SnapshotResponse>**](SnapshotResponse.md) | | [optional] |
|
|
10
|
-
| **offset** | **Integer** | The offset specified in the request (if none was specified, the default offset is 0)
|
|
11
|
-
| **limit** | **Integer** | The limit specified in the request (if none was specified,
|
|
12
|
-
| **
|
|
10
|
+
| **offset** | **Integer** | The offset specified in the request (if none was specified, the default offset is 0). | [optional][default to 0] |
|
|
11
|
+
| **limit** | **Integer** | The limit specified in the request (if none was specified, the default limit is 100). | [optional][default to 100] |
|
|
12
|
+
| **links** | [**PaginationLinks**](PaginationLinks.md) | | [optional] |
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -20,9 +20,9 @@ instance = IonoscloudDbaasMongo::SnapshotList.new(
|
|
|
20
20
|
type: null,
|
|
21
21
|
id: 498ae72f-411f-11eb-9d07-046c59cc737e,
|
|
22
22
|
items: null,
|
|
23
|
-
offset:
|
|
24
|
-
limit:
|
|
25
|
-
|
|
23
|
+
offset: 200,
|
|
24
|
+
limit: 100,
|
|
25
|
+
links: null
|
|
26
26
|
)
|
|
27
27
|
```
|
|
28
28
|
|