docs/api/SnapshotsApi.md in ionoscloud-6.1.1 vs docs/api/SnapshotsApi.md in ionoscloud-6.1.2
- old
+ new
@@ -6,11 +6,11 @@
| ------ | ------------ | ----------- |
| [**snapshots_delete**](SnapshotsApi.md#snapshots_delete) | **DELETE** /snapshots/{snapshotId} | Delete snapshots |
| [**snapshots_find_by_id**](SnapshotsApi.md#snapshots_find_by_id) | **GET** /snapshots/{snapshotId} | Retrieve snapshots by ID |
| [**snapshots_get**](SnapshotsApi.md#snapshots_get) | **GET** /snapshots | List snapshots |
| [**snapshots_patch**](SnapshotsApi.md#snapshots_patch) | **PATCH** /snapshots/{snapshotId} | Partially modify snapshots |
-| [**snapshots_put**](SnapshotsApi.md#snapshots_put) | **PUT** /snapshots/{snapshotId} | Modify snapshots |
+| [**snapshots_put**](SnapshotsApi.md#snapshots_put) | **PUT** /snapshots/{snapshotId} | Modify a Snapshot by ID |
## snapshots_delete
> snapshots_delete(snapshot_id, opts)
@@ -321,11 +321,11 @@
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **snapshot_id** | **String** | The unique ID of the snapshot. | |
-| **snapshot** | [**SnapshotProperties**](SnapshotProperties.md) | The properties of the snapshot to be updated. | |
+| **snapshot** | [**SnapshotProperties**](../models/SnapshotProperties.md) | The properties of the snapshot to be updated. | |
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
### Return type
@@ -344,13 +344,13 @@
## snapshots_put
> <Snapshot> snapshots_put(snapshot_id, snapshot, opts)
-Modify snapshots
+Modify a Snapshot by ID
-Modify the properties of the specified snapshot.
+Modifies the properties of the specified snapshot.
### Examples
```ruby
require 'time'
@@ -375,11 +375,11 @@
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}
begin
- # Modify snapshots
+ # Modify a Snapshot by ID
result = api_instance.snapshots_put(snapshot_id, snapshot, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling SnapshotsApi->snapshots_put: #{e}"
end
@@ -391,11 +391,11 @@
> <Array(<Snapshot>, Integer, Hash)> snapshots_put_with_http_info(snapshot_id, snapshot, opts)
```ruby
begin
- # Modify snapshots
+ # Modify a Snapshot by ID
data, status_code, headers = api_instance.snapshots_put_with_http_info(snapshot_id, snapshot, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <Snapshot>
rescue Ionoscloud::ApiError => e
@@ -406,10 +406,10 @@
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **snapshot_id** | **String** | The unique ID of the snapshot. | |
-| **snapshot** | [**Snapshot**](Snapshot.md) | The modified snapshot | |
+| **snapshot** | [**Snapshot**](../models/Snapshot.md) | The modified snapshot | |
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
### Return type