xref: /openbmc/bmcweb/redfish-core/schema/dmtf/json-schema/VolumeCollection.json (revision 28cfceb2980baa76d7f0599dd4a331ceaec52e1f) 
12bde4061SEd Tanous{
22bde4061SEd Tanous    "$id": "http://redfish.dmtf.org/schemas/swordfish/v1/VolumeCollection.json",
32bde4061SEd Tanous    "$ref": "#/definitions/VolumeCollection",
42bde4061SEd Tanous    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
5*28cfceb2SGunnar Mills    "copyright": "Copyright 2015-2024 Storage Networking Industry Association (SNIA), USA. All rights reserved.",
62bde4061SEd Tanous    "definitions": {
72bde4061SEd Tanous        "VolumeCollection": {
82bde4061SEd Tanous            "anyOf": [
92bde4061SEd Tanous                {
102bde4061SEd Tanous                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef"
112bde4061SEd Tanous                },
122bde4061SEd Tanous                {
132bde4061SEd Tanous                    "additionalProperties": false,
142bde4061SEd Tanous                    "description": "A Collection of Volume resource instances.",
152bde4061SEd Tanous                    "longDescription": "This collection shall contain references to all Volume resource instances sharing the same parent resource.",
162bde4061SEd Tanous                    "patternProperties": {
172bde4061SEd Tanous                        "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
182bde4061SEd Tanous                            "description": "This property shall specify a valid odata or Redfish property.",
192bde4061SEd Tanous                            "type": [
202bde4061SEd Tanous                                "array",
212bde4061SEd Tanous                                "boolean",
222bde4061SEd Tanous                                "integer",
232bde4061SEd Tanous                                "number",
242bde4061SEd Tanous                                "null",
252bde4061SEd Tanous                                "object",
262bde4061SEd Tanous                                "string"
272bde4061SEd Tanous                            ]
282bde4061SEd Tanous                        }
292bde4061SEd Tanous                    },
302bde4061SEd Tanous                    "properties": {
312bde4061SEd Tanous                        "@odata.context": {
322bde4061SEd Tanous                            "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
332bde4061SEd Tanous                        },
342bde4061SEd Tanous                        "@odata.etag": {
352bde4061SEd Tanous                            "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
362bde4061SEd Tanous                        },
372bde4061SEd Tanous                        "@odata.id": {
382bde4061SEd Tanous                            "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
392bde4061SEd Tanous                        },
402bde4061SEd Tanous                        "@odata.type": {
412bde4061SEd Tanous                            "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
422bde4061SEd Tanous                        },
432bde4061SEd Tanous                        "Description": {
442bde4061SEd Tanous                            "anyOf": [
452bde4061SEd Tanous                                {
462bde4061SEd Tanous                                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
472bde4061SEd Tanous                                },
482bde4061SEd Tanous                                {
492bde4061SEd Tanous                                    "type": "null"
502bde4061SEd Tanous                                }
512bde4061SEd Tanous                            ],
522bde4061SEd Tanous                            "readonly": true
532bde4061SEd Tanous                        },
542bde4061SEd Tanous                        "Members": {
552bde4061SEd Tanous                            "description": "The value of each member references a Volume resource.",
562bde4061SEd Tanous                            "items": {
572bde4061SEd Tanous                                "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Volume.json#/definitions/Volume"
582bde4061SEd Tanous                            },
592bde4061SEd Tanous                            "longDescription": "The value of each member entry shall reference a Volume resource.",
602bde4061SEd Tanous                            "readonly": true,
612bde4061SEd Tanous                            "type": "array"
622bde4061SEd Tanous                        },
632bde4061SEd Tanous                        "Members@odata.count": {
642bde4061SEd Tanous                            "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
652bde4061SEd Tanous                        },
662bde4061SEd Tanous                        "Members@odata.nextLink": {
672bde4061SEd Tanous                            "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/nextLink"
682bde4061SEd Tanous                        },
692bde4061SEd Tanous                        "Name": {
702bde4061SEd Tanous                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
712bde4061SEd Tanous                            "readonly": true
722bde4061SEd Tanous                        },
732bde4061SEd Tanous                        "Oem": {
742bde4061SEd Tanous                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
752bde4061SEd Tanous                            "description": "The OEM extension property.",
762bde4061SEd Tanous                            "longDescription": "This property shall contain the OEM extensions.  All values for properties contained in this object shall conform to the Redfish Specification-described requirements."
772bde4061SEd Tanous                        }
782bde4061SEd Tanous                    },
792bde4061SEd Tanous                    "required": [
802bde4061SEd Tanous                        "Members",
812bde4061SEd Tanous                        "Members@odata.count",
822bde4061SEd Tanous                        "@odata.id",
832bde4061SEd Tanous                        "@odata.type",
842bde4061SEd Tanous                        "Name"
852bde4061SEd Tanous                    ],
862bde4061SEd Tanous                    "type": "object"
872bde4061SEd Tanous                }
882bde4061SEd Tanous            ],
892bde4061SEd Tanous            "deletable": false,
902bde4061SEd Tanous            "insertable": true,
912bde4061SEd Tanous            "updatable": false,
922bde4061SEd Tanous            "uris": [
932bde4061SEd Tanous                "/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Volumes",
942bde4061SEd Tanous                "/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/Volumes",
952bde4061SEd Tanous                "/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Volumes",
962bde4061SEd Tanous                "/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/Volumes",
972bde4061SEd Tanous                "/redfish/v1/Storage/{StorageId}/ConsistencyGroups/{ConsistencyGroupId}/Volumes",
982bde4061SEd Tanous                "/redfish/v1/Storage/{StorageId}/FileSystems/{FileSystemId}/CapacitySources/{CapacitySourceId}/ProvidingVolumes",
992bde4061SEd Tanous                "/redfish/v1/Storage/{StorageId}/StoragePools/{StoragePoolId}/AllocatedVolumes",
1002bde4061SEd Tanous                "/redfish/v1/Storage/{StorageId}/StoragePools/{StoragePoolId}/CapacitySources/{CapacitySourceId}/ProvidingVolumes",
1012bde4061SEd Tanous                "/redfish/v1/Storage/{StorageId}/Volumes",
1022bde4061SEd Tanous                "/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/ConsistencyGroups/{ConsistencyGroupId}/Volumes",
1032bde4061SEd Tanous                "/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/FileSystems/{FileSystemId}/CapacitySources/{CapacitySourceId}/ProvidingVolumes",
1042bde4061SEd Tanous                "/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/StoragePools/{StoragePoolId}/AllocatedVolumes",
1052bde4061SEd Tanous                "/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/StoragePools/{StoragePoolId}/CapacitySources/{CapacitySourceId}/ProvidingVolumes",
1062bde4061SEd Tanous                "/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Volumes",
1072bde4061SEd Tanous                "/redfish/v1/StorageServices/{StorageServiceId}/ConsistencyGroups/{ConsistencyGroupId}/Volumes",
1082bde4061SEd Tanous                "/redfish/v1/StorageServices/{StorageServiceId}/FileSystems/{FileSystemId}/CapacitySources/{CapacitySourceId}/ProvidingVolumes",
1092bde4061SEd Tanous                "/redfish/v1/StorageServices/{StorageServiceId}/StoragePools/{StoragePoolId}/AllocatedVolumes",
1102bde4061SEd Tanous                "/redfish/v1/StorageServices/{StorageServiceId}/StoragePools/{StoragePoolId}/CapacitySources/{CapacitySourceId}/ProvidingVolumes",
1112bde4061SEd Tanous                "/redfish/v1/StorageServices/{StorageServiceId}/Volumes",
1122bde4061SEd Tanous                "/redfish/v1/StorageServices/{StorageServiceId}/Volumes/{VolumeId}/CapacitySources/{CapacitySourceId}/ProvidingVolumes"
1132bde4061SEd Tanous            ]
1142bde4061SEd Tanous        }
1152bde4061SEd Tanous    },
1162bde4061SEd Tanous    "owningEntity": "SNIA",
1172bde4061SEd Tanous    "title": "#VolumeCollection.VolumeCollection"
1182bde4061SEd Tanous}