Skip to content

Commit

Permalink
Added new attributes StoragePoolName and DataCenterName in volume's p…
Browse files Browse the repository at this point in the history
…roject API response. (#134)

* Added new attributes StoragePoolName and DataCenterName in volume's project API response.

* [auto generated] Checking in generated offline HTML doc

* Update v1/api/swagger/components/schemas/Volume.yaml

Co-authored-by: anurag-shrivastav <91617830+anurag-shrivastav@users.noreply.github.com>

* Update v1/api/swagger/components/schemas/Volume.yaml

Co-authored-by: anurag-shrivastav <91617830+anurag-shrivastav@users.noreply.github.com>

* Fixed review comments.

* [auto generated] Checking in generated offline HTML doc

---------

Co-authored-by: chitranm <chitranm@users.noreply.github.com>
Co-authored-by: anurag-shrivastav <91617830+anurag-shrivastav@users.noreply.github.com>
  • Loading branch information
3 people authored Oct 29, 2024
1 parent 8911f6e commit 406649e
Show file tree
Hide file tree
Showing 7 changed files with 36 additions and 5 deletions.
10 changes: 10 additions & 0 deletions v1/api/swagger/components/schemas/Volume.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,12 @@ allOf:
- Description
- FlavorID
- StoragePoolID
- StoragePoolName
- Capacity
- CapacityUsed
- Shareable
- LocationID
- DataCenterName
- State
- SubState
- Status
Expand Down Expand Up @@ -36,6 +38,10 @@ allOf:
description: >-
The storage pool ID matching an entry in the StoragePools array
returned as part of the get /available-resources call
StoragePoolName:
type: string
description: >-
Name of the storage pool from where the volume is allocated.
Capacity:
type: integer
format: int64
Expand All @@ -59,6 +65,10 @@ allOf:
of those listed by the LocationInfo array returned as part of the get
/available-resources call. Any volumes must be in the same location as
their attached Host.
DataCenterName:
type: string
description: >-
Name of the data center where the volume is created on the storage array.
VolumeCollectionID:
type: string
format: uuid
Expand Down
10 changes: 5 additions & 5 deletions v1/html/index.html

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions v1/pkg/client/api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7105,6 +7105,9 @@ components:
returned as part of the get /available-resources call
format: uuid
type: string
StoragePoolName:
description: Name of the storage pool from where the volume is allocated.
type: string
Capacity:
description: The size of the volume in KiB
example: 10485760
Expand All @@ -7128,6 +7131,10 @@ components:
as their attached Host.
format: uuid
type: string
DataCenterName:
description: Name of the data center where the volume is created on the
storage array.
type: string
VolumeCollectionID:
description: The optional volume collection ID matching an entry in the
VolumeCollections array returned as part of the get /available-resources
Expand Down Expand Up @@ -7177,6 +7184,7 @@ components:
- Capacity
- CapacityUsed
- CreatedSite
- DataCenterName
- Description
- ExportCount
- FlavorID
Expand All @@ -7187,6 +7195,7 @@ components:
- State
- Status
- StoragePoolID
- StoragePoolName
- SubState
- UnmanagedVolume
- WWN
Expand Down
2 changes: 2 additions & 0 deletions v1/pkg/client/docs/Volume.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,12 @@ Name | Type | Description | Notes
**Description** | **string** | |
**FlavorID** | **string** | The VolumeFlavorID matching an entry in the VolumeFlavors array returned as part of the get /available-resources call |
**StoragePoolID** | **string** | The storage pool ID matching an entry in the StoragePools array returned as part of the get /available-resources call |
**StoragePoolName** | **string** | Name of the storage pool from where the volume is allocated. |
**Capacity** | **int64** | The size of the volume in KiB |
**CapacityUsed** | **int64** | The amount of the volume currently used as reported by the array in KiB |
**Shareable** | **bool** | Indicates if the volume can be attached to multiple hosts |
**LocationID** | **string** | The location of the volume (and the storage array) LocationID is one of those listed by the LocationInfo array returned as part of the get /available-resources call. Any volumes must be in the same location as their attached Host. |
**DataCenterName** | **string** | Name of the data center where the volume is created on the storage array. |
**VolumeCollectionID** | **string** | The optional volume collection ID matching an entry in the VolumeCollections array returned as part of the get /available-resources call | [optional]
**State** | [**VolumeState**](VolumeState.md) | |
**SubState** | [**VolumeSubState**](VolumeSubState.md) | |
Expand Down
2 changes: 2 additions & 0 deletions v1/pkg/client/docs/VolumeAllOf.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,12 @@ Name | Type | Description | Notes
**Description** | **string** | |
**FlavorID** | **string** | The VolumeFlavorID matching an entry in the VolumeFlavors array returned as part of the get /available-resources call |
**StoragePoolID** | **string** | The storage pool ID matching an entry in the StoragePools array returned as part of the get /available-resources call |
**StoragePoolName** | **string** | Name of the storage pool from where the volume is allocated. |
**Capacity** | **int64** | The size of the volume in KiB |
**CapacityUsed** | **int64** | The amount of the volume currently used as reported by the array in KiB |
**Shareable** | **bool** | Indicates if the volume can be attached to multiple hosts |
**LocationID** | **string** | The location of the volume (and the storage array) LocationID is one of those listed by the LocationInfo array returned as part of the get /available-resources call. Any volumes must be in the same location as their attached Host. |
**DataCenterName** | **string** | Name of the data center where the volume is created on the storage array. |
**VolumeCollectionID** | **string** | The optional volume collection ID matching an entry in the VolumeCollections array returned as part of the get /available-resources call | [optional]
**State** | [**VolumeState**](VolumeState.md) | |
**SubState** | [**VolumeSubState**](VolumeSubState.md) | |
Expand Down
4 changes: 4 additions & 0 deletions v1/pkg/client/model_volume.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ type Volume struct {
FlavorID string `json:"FlavorID"`
// The storage pool ID matching an entry in the StoragePools array returned as part of the get /available-resources call
StoragePoolID string `json:"StoragePoolID"`
// Name of the storage pool from where the volume is allocated.
StoragePoolName string `json:"StoragePoolName"`
// The size of the volume in KiB
Capacity int64 `json:"Capacity"`
// The amount of the volume currently used as reported by the array in KiB
Expand All @@ -38,6 +40,8 @@ type Volume struct {
Shareable bool `json:"Shareable"`
// The location of the volume (and the storage array) LocationID is one of those listed by the LocationInfo array returned as part of the get /available-resources call. Any volumes must be in the same location as their attached Host.
LocationID string `json:"LocationID"`
// Name of the data center where the volume is created on the storage array.
DataCenterName string `json:"DataCenterName"`
// The optional volume collection ID matching an entry in the VolumeCollections array returned as part of the get /available-resources call
VolumeCollectionID string `json:"VolumeCollectionID,omitempty"`
State VolumeState `json:"State"`
Expand Down
4 changes: 4 additions & 0 deletions v1/pkg/client/model_volume_all_of.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ type VolumeAllOf struct {
FlavorID string `json:"FlavorID"`
// The storage pool ID matching an entry in the StoragePools array returned as part of the get /available-resources call
StoragePoolID string `json:"StoragePoolID"`
// Name of the storage pool from where the volume is allocated.
StoragePoolName string `json:"StoragePoolName"`
// The size of the volume in KiB
Capacity int64 `json:"Capacity"`
// The amount of the volume currently used as reported by the array in KiB
Expand All @@ -25,6 +27,8 @@ type VolumeAllOf struct {
Shareable bool `json:"Shareable"`
// The location of the volume (and the storage array) LocationID is one of those listed by the LocationInfo array returned as part of the get /available-resources call. Any volumes must be in the same location as their attached Host.
LocationID string `json:"LocationID"`
// Name of the data center where the volume is created on the storage array.
DataCenterName string `json:"DataCenterName"`
// The optional volume collection ID matching an entry in the VolumeCollections array returned as part of the get /available-resources call
VolumeCollectionID string `json:"VolumeCollectionID,omitempty"`
State VolumeState `json:"State"`
Expand Down

0 comments on commit 406649e

Please sign in to comment.