Skip to content

Commit b2207a2

Browse files
Ravi Chandrasankhsin
Ravi Chandra
authored and
sankhsin
committed
TERSI-4106 Bug Fix | Added - Support for Documentation Update of BSS Direct API
1 parent 7ee7d24 commit b2207a2

File tree

6 files changed

+36
-36
lines changed

6 files changed

+36
-36
lines changed

‎website/docs/d/core_boot_volume.html.markdown‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,11 @@ The following attributes are exported:
5555
* `size_in_gbs` - The size of the boot volume in GBs.
5656
* `size_in_mbs` - The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use `size_in_gbs`.
5757
* `source_details` -
58-
* `change_block_size_in_bytes` - Block size in bytes to be considered while performing volume restore. The value must be a power of 2; ranging from 4KB (4096 bytes) to 1MB (1048576 bytes). If omitted, defaults to 4,096 bytes (4 KiB).
59-
* `first_backup_id` - The OCID of the first boot volume backup.
60-
* `id` - The OCID of the boot volume replica.
61-
* `second_backup_id` - The OCID of the second boot volume backup.
62-
* `type` - The type can be one of these values: `bootVolume`, `bootVolumeBackup`, `bootVolumeBackupDelta`, `bootVolumeReplica`
58+
* `id` - (Required when type=bootVolume | bootVolumeBackup | bootVolumeReplica) The OCID of the boot volume replica.
59+
* `type` - (Required) The type can be one of these values: `bootVolume`, `bootVolumeBackup`, `bootVolumeBackupDelta`, `bootVolumeReplica`
60+
* `change_block_size_in_bytes` - (Applicable when type=bootVolumeBackupDelta) Block size in bytes to be considered while performing volume restore. The value must be a power of 2; ranging from 4KB (4096 bytes) to 1MB (1048576 bytes). If omitted, defaults to 4,096 bytes (4 KiB).
61+
* `first_backup_id` - (Required when type=bootVolumeBackupDelta) The OCID of the first boot volume backup.
62+
* `second_backup_id` - (Required when type=bootVolumeBackupDelta) The OCID of the second boot volume backup.
6363
* `state` - The current state of a boot volume.
6464
* `system_tags` - System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`
6565
* `time_created` - The date and time the boot volume was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

‎website/docs/d/core_boot_volumes.html.markdown‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -67,11 +67,11 @@ The following attributes are exported:
6767
* `size_in_gbs` - The size of the boot volume in GBs.
6868
* `size_in_mbs` - The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use `size_in_gbs`.
6969
* `source_details` -
70-
* `change_block_size_in_bytes` - Block size in bytes to be considered while performing volume restore. The value must be a power of 2; ranging from 4KB (4096 bytes) to 1MB (1048576 bytes). If omitted, defaults to 4,096 bytes (4 KiB).
71-
* `first_backup_id` - The OCID of the first boot volume backup.
72-
* `id` - The OCID of the boot volume replica.
73-
* `second_backup_id` - The OCID of the second boot volume backup.
74-
* `type` - The type can be one of these values: `bootVolume`, `bootVolumeBackup`, `bootVolumeBackupDelta`, `bootVolumeReplica`
70+
* `id` - (Required when type=bootVolume | bootVolumeBackup | bootVolumeReplica) The OCID of the boot volume replica.
71+
* `type` - (Required) The type can be one of these values: `bootVolume`, `bootVolumeBackup`, `bootVolumeBackupDelta`, `bootVolumeReplica`
72+
* `change_block_size_in_bytes` - (Applicable when type=bootVolumeBackupDelta) Block size in bytes to be considered while performing volume restore. The value must be a power of 2; ranging from 4KB (4096 bytes) to 1MB (1048576 bytes). If omitted, defaults to 4,096 bytes (4 KiB).
73+
* `first_backup_id` - (Required when type=bootVolumeBackupDelta) The OCID of the first boot volume backup.
74+
* `second_backup_id` - (Required when type=bootVolumeBackupDelta) The OCID of the second boot volume backup.
7575
* `state` - The current state of a boot volume.
7676
* `system_tags` - System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`
7777
* `time_created` - The date and time the boot volume was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

‎website/docs/d/core_volume.html.markdown‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,11 @@ The following attributes are exported:
5454
* `size_in_gbs` - The size of the volume in GBs.
5555
* `size_in_mbs` - The size of the volume in MBs. This field is deprecated. Use sizeInGBs instead.
5656
* `source_details` - Specifies the volume source details for a new Block volume. The volume source is either another Block volume in the same Availability Domain or a Block volume backup. This is an optional field. If not specified or set to null, the new Block volume will be empty. When specified, the new Block volume will contain data from the source volume or backup.
57-
* `change_block_size_in_bytes` - Block size in bytes to be considered while performing volume restore. The value must be a power of 2; ranging from 4KB (4096 bytes) to 1MB (1048576 bytes). If omitted, defaults to 4,096 bytes (4 KiB).
58-
* `first_backup_id` - The OCID of the first volume backup.
59-
* `id` - The OCID of the block volume replica.
60-
* `second_backup_id` - The OCID of the second volume backup.
61-
* `type` - The type can be one of these values: `blockVolumeReplica`, `volume`, `volumeBackup`, `volumeBackupDelta`
57+
* `id` - (Required when type=blockVolumeReplica | volume | volumeBackup) The OCID of the block volume replica.
58+
* `type` - (Required) The type can be one of these values: `blockVolumeReplica`, `volume`, `volumeBackup`, `volumeBackupDelta`
59+
* `change_block_size_in_bytes` - (Applicable when type=volumeBackupDelta) Block size in bytes to be considered while performing volume restore. The value must be a power of 2; ranging from 4KB (4096 bytes) to 1MB (1048576 bytes). If omitted, defaults to 4,096 bytes (4 KiB).
60+
* `first_backup_id` - (Required when type=volumeBackupDelta) The OCID of the first volume backup.
61+
* `second_backup_id` - (Required when type=volumeBackupDelta) The OCID of the second volume backup.
6262
* `state` - The current state of a volume.
6363
* `system_tags` - System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`
6464
* `time_created` - The date and time the volume was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

‎website/docs/d/core_volumes.html.markdown‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -72,11 +72,11 @@ The following attributes are exported:
7272
* `size_in_gbs` - The size of the volume in GBs.
7373
* `size_in_mbs` - The size of the volume in MBs. This field is deprecated. Use sizeInGBs instead.
7474
* `source_details` - Specifies the volume source details for a new Block volume. The volume source is either another Block volume in the same Availability Domain or a Block volume backup. This is an optional field. If not specified or set to null, the new Block volume will be empty. When specified, the new Block volume will contain data from the source volume or backup.
75-
* `change_block_size_in_bytes` - Block size in bytes to be considered while performing volume restore. The value must be a power of 2; ranging from 4KB (4096 bytes) to 1MB (1048576 bytes). If omitted, defaults to 4,096 bytes (4 KiB).
76-
* `first_backup_id` - The OCID of the first volume backup.
77-
* `id` - The OCID of the block volume replica.
78-
* `second_backup_id` - The OCID of the second volume backup.
79-
* `type` - The type can be one of these values: `blockVolumeReplica`, `volume`, `volumeBackup`, `volumeBackupDelta`
75+
* `id` - (Required when type=blockVolumeReplica | volume | volumeBackup) The OCID of the block volume replica.
76+
* `type` - (Required) The type can be one of these values: `blockVolumeReplica`, `volume`, `volumeBackup`, `volumeBackupDelta`
77+
* `change_block_size_in_bytes` - (Applicable when type=volumeBackupDelta) Block size in bytes to be considered while performing volume restore. The value must be a power of 2; ranging from 4KB (4096 bytes) to 1MB (1048576 bytes). If omitted, defaults to 4,096 bytes (4 KiB).
78+
* `first_backup_id` - (Required when type=volumeBackupDelta) The OCID of the first volume backup.
79+
* `second_backup_id` - (Required when type=volumeBackupDelta) The OCID of the second volume backup.
8080
* `state` - The current state of a volume.
8181
* `system_tags` - System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`
8282
* `time_created` - The date and time the volume was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

‎website/docs/r/core_boot_volume.html.markdown‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -87,11 +87,11 @@ The following arguments are supported:
8787
* `kms_key_id` - (Optional) (Updatable) The OCID of the Vault service key to assign as the master encryption key for the boot volume.
8888
* `size_in_gbs` - (Optional) (Updatable) The size of the volume in GBs.
8989
* `source_details` - (Required)
90-
* `change_block_size_in_bytes` - (Applicable when type=bootVolumeBackupDelta) Block size in bytes to be considered while performing volume restore. The value must be a power of 2; ranging from 4KB (4096 bytes) to 1MB (1048576 bytes). If omitted, defaults to 4,096 bytes (4 KiB).
91-
* `first_backup_id` - (Required when type=bootVolumeBackupDelta) The OCID of the first boot volume backup.
9290
* `id` - (Required when type=bootVolume | bootVolumeBackup | bootVolumeReplica) The OCID of the boot volume replica.
93-
* `second_backup_id` - (Required when type=bootVolumeBackupDelta) The OCID of the second boot volume backup.
9491
* `type` - (Required) The type can be one of these values: `bootVolume`, `bootVolumeBackup`, `bootVolumeBackupDelta`, `bootVolumeReplica`
92+
* `change_block_size_in_bytes` - (Applicable when type=bootVolumeBackupDelta) Block size in bytes to be considered while performing volume restore. The value must be a power of 2; ranging from 4KB (4096 bytes) to 1MB (1048576 bytes). If omitted, defaults to 4,096 bytes (4 KiB).
93+
* `first_backup_id` - (Required when type=bootVolumeBackupDelta) The OCID of the first boot volume backup.
94+
* `second_backup_id` - (Required when type=bootVolumeBackupDelta) The OCID of the second boot volume backup.
9595
* `vpus_per_gb` - (Optional) (Updatable) The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See [Block Volume Performance Levels](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.
9696

9797
Allowed values:
@@ -133,11 +133,11 @@ The following attributes are exported:
133133
* `size_in_gbs` - The size of the boot volume in GBs.
134134
* `size_in_mbs` - The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use `size_in_gbs`.
135135
* `source_details` -
136-
* `change_block_size_in_bytes` - Block size in bytes to be considered while performing volume restore. The value must be a power of 2; ranging from 4KB (4096 bytes) to 1MB (1048576 bytes). If omitted, defaults to 4,096 bytes (4 KiB).
137-
* `first_backup_id` - The OCID of the first boot volume backup.
138-
* `id` - The OCID of the boot volume replica.
139-
* `second_backup_id` - The OCID of the second boot volume backup.
140-
* `type` - The type can be one of these values: `bootVolume`, `bootVolumeBackup`, `bootVolumeBackupDelta`, `bootVolumeReplica`
136+
* `id` - (Required when type=bootVolume | bootVolumeBackup | bootVolumeReplica) The OCID of the boot volume replica.
137+
* `type` - (Required) The type can be one of these values: `bootVolume`, `bootVolumeBackup`, `bootVolumeBackupDelta`, `bootVolumeReplica`
138+
* `change_block_size_in_bytes` - (Applicable when type=bootVolumeBackupDelta) Block size in bytes to be considered while performing volume restore. The value must be a power of 2; ranging from 4KB (4096 bytes) to 1MB (1048576 bytes). If omitted, defaults to 4,096 bytes (4 KiB).
139+
* `first_backup_id` - (Required when type=bootVolumeBackupDelta) The OCID of the first boot volume backup.
140+
* `second_backup_id` - (Required when type=bootVolumeBackupDelta) The OCID of the second boot volume backup.
141141
* `state` - The current state of a boot volume.
142142
* `system_tags` - System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`
143143
* `time_created` - The date and time the boot volume was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

‎website/docs/r/core_volume.html.markdown‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -99,11 +99,11 @@ The following arguments are supported:
9999
* `size_in_gbs` - (Optional) (Updatable) The size of the volume in GBs.
100100
* `size_in_mbs` - (Optional) The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Use sizeInGBs instead.
101101
* `source_details` - (Optional) Specifies the volume source details for a new Block volume. The volume source is either another Block volume in the same Availability Domain or a Block volume backup. This is an optional field. If not specified or set to null, the new Block volume will be empty. When specified, the new Block volume will contain data from the source volume or backup.
102-
* `change_block_size_in_bytes` - (Applicable when type=volumeBackupDelta) Block size in bytes to be considered while performing volume restore. The value must be a power of 2; ranging from 4KB (4096 bytes) to 1MB (1048576 bytes). If omitted, defaults to 4,096 bytes (4 KiB).
103-
* `first_backup_id` - (Required when type=volumeBackupDelta) The OCID of the first volume backup.
104102
* `id` - (Required when type=blockVolumeReplica | volume | volumeBackup) The OCID of the block volume replica.
105-
* `second_backup_id` - (Required when type=volumeBackupDelta) The OCID of the second volume backup.
106103
* `type` - (Required) The type can be one of these values: `blockVolumeReplica`, `volume`, `volumeBackup`, `volumeBackupDelta`
104+
* `change_block_size_in_bytes` - (Applicable when type=volumeBackupDelta) Block size in bytes to be considered while performing volume restore. The value must be a power of 2; ranging from 4KB (4096 bytes) to 1MB (1048576 bytes). If omitted, defaults to 4,096 bytes (4 KiB).
105+
* `first_backup_id` - (Required when type=volumeBackupDelta) The OCID of the first volume backup.
106+
* `second_backup_id` - (Required when type=volumeBackupDelta) The OCID of the second volume backup.
107107
* `volume_backup_id` - (Optional) The OCID of the volume backup from which the data should be restored on the newly created volume. This field is deprecated. Use the sourceDetails field instead to specify the backup for the volume.
108108
* `vpus_per_gb` - (Optional) (Updatable) The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See [Block Volume Performance Levels](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.
109109

@@ -146,11 +146,11 @@ The following attributes are exported:
146146
* `size_in_gbs` - The size of the volume in GBs.
147147
* `size_in_mbs` - The size of the volume in MBs. This field is deprecated. Use sizeInGBs instead.
148148
* `source_details` -
149-
* `change_block_size_in_bytes` - Block size in bytes to be considered while performing volume restore. The value must be a power of 2; ranging from 4KB (4096 bytes) to 1MB (1048576 bytes). If omitted, defaults to 4,096 bytes (4 KiB).
150-
* `first_backup_id` - The OCID of the first volume backup.
151-
* `id` - The OCID of the block volume replica or volume backup.
152-
* `second_backup_id` - The OCID of the second volume backup.
153-
* `type` - The type can be one of these values: `blockVolumeReplica`, `volume`, `volumeBackup`, `volumeBackupDelta`
149+
* `id` - (Required when type=blockVolumeReplica | volume | volumeBackup) The OCID of the block volume replica.
150+
* `type` - (Required) The type can be one of these values: `blockVolumeReplica`, `volume`, `volumeBackup`, `volumeBackupDelta`
151+
* `change_block_size_in_bytes` - (Applicable when type=volumeBackupDelta) Block size in bytes to be considered while performing volume restore. The value must be a power of 2; ranging from 4KB (4096 bytes) to 1MB (1048576 bytes). If omitted, defaults to 4,096 bytes (4 KiB).
152+
* `first_backup_id` - (Required when type=volumeBackupDelta) The OCID of the first volume backup.
153+
* `second_backup_id` - (Required when type=volumeBackupDelta) The OCID of the second volume backup.
154154
* `state` - The current state of a volume.
155155
* `system_tags` - System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`
156156
* `time_created` - The date and time the volume was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

0 commit comments

Comments
 (0)