xref: /openbmc/bmcweb/redfish-core/schema/dmtf/json-schema/VolumeCollection.json (revision 2bde4061)

{
    "$id": "http://redfish.dmtf.org/schemas/swordfish/v1/VolumeCollection.json",
    "$ref": "#/definitions/VolumeCollection",
    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
    "copyright": "Copyright 2015-2023 Storage Networking Industry Association (SNIA), USA. All rights reserved.",
    "definitions": {
        "VolumeCollection": {
            "anyOf": [
                {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef"
                },
                {
                    "additionalProperties": false,
                    "description": "A Collection of Volume resource instances.",
                    "longDescription": "This collection shall contain references to all Volume resource instances sharing the same parent resource.",
                    "patternProperties": {
                        "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                            "description": "This property shall specify a valid odata or Redfish property.",
                            "type": [
                                "array",
                                "boolean",
                                "integer",
                                "number",
                                "null",
                                "object",
                                "string"
                            ]
                        }
                    },
                    "properties": {
                        "@odata.context": {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
                        },
                        "@odata.etag": {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
                        },
                        "@odata.id": {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
                        },
                        "@odata.type": {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
                        },
                        "Description": {
                            "anyOf": [
                                {
                                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
                                },
                                {
                                    "type": "null"
                                }
                            ],
                            "readonly": true
                        },
                        "Members": {
                            "description": "The value of each member references a Volume resource.",
                            "items": {
                                "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/Volume"
                            },
                            "longDescription": "The value of each member entry shall reference a Volume resource.",
                            "readonly": true,
                            "type": "array"
                        },
                        "Members@odata.count": {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
                        },
                        "Members@odata.nextLink": {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/nextLink"
                        },
                        "Name": {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
                            "readonly": true
                        },
                        "Oem": {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
                            "description": "The OEM extension property.",
                            "longDescription": "This property shall contain the OEM extensions.  All values for properties contained in this object shall conform to the Redfish Specification-described requirements."
                        }
                    },
                    "required": [
                        "Members",
                        "Members@odata.count",
                        "@odata.id",
                        "@odata.type",
                        "Name"
                    ],
                    "type": "object"
                }
            ],
            "deletable": false,
            "insertable": true,
            "updatable": false,
            "uris": [
                "/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Volumes",
                "/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/Volumes",
                "/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Volumes",
                "/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/Volumes",
                "/redfish/v1/Storage/{StorageId}/ConsistencyGroups/{ConsistencyGroupId}/Volumes",
                "/redfish/v1/Storage/{StorageId}/FileSystems/{FileSystemId}/CapacitySources/{CapacitySourceId}/ProvidingVolumes",
                "/redfish/v1/Storage/{StorageId}/StoragePools/{StoragePoolId}/AllocatedVolumes",
                "/redfish/v1/Storage/{StorageId}/StoragePools/{StoragePoolId}/CapacitySources/{CapacitySourceId}/ProvidingVolumes",
                "/redfish/v1/Storage/{StorageId}/Volumes",
                "/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/ConsistencyGroups/{ConsistencyGroupId}/Volumes",
                "/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/FileSystems/{FileSystemId}/CapacitySources/{CapacitySourceId}/ProvidingVolumes",
                "/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/StoragePools/{StoragePoolId}/AllocatedVolumes",
                "/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/StoragePools/{StoragePoolId}/CapacitySources/{CapacitySourceId}/ProvidingVolumes",
                "/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Volumes",
                "/redfish/v1/StorageServices/{StorageServiceId}/ConsistencyGroups/{ConsistencyGroupId}/Volumes",
                "/redfish/v1/StorageServices/{StorageServiceId}/FileSystems/{FileSystemId}/CapacitySources/{CapacitySourceId}/ProvidingVolumes",
                "/redfish/v1/StorageServices/{StorageServiceId}/StoragePools/{StoragePoolId}/AllocatedVolumes",
                "/redfish/v1/StorageServices/{StorageServiceId}/StoragePools/{StoragePoolId}/CapacitySources/{CapacitySourceId}/ProvidingVolumes",
                "/redfish/v1/StorageServices/{StorageServiceId}/Volumes",
                "/redfish/v1/StorageServices/{StorageServiceId}/Volumes/{VolumeId}/CapacitySources/{CapacitySourceId}/ProvidingVolumes"
            ]
        }
    },
    "owningEntity": "SNIA",
    "title": "#VolumeCollection.VolumeCollection"
}