libstorage.json

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "definitions": {
        "volume": {
            "properties": {
                "id": {
                    "type": "string",
                    "description": "The volume ID."
                },
                "name": {
                    "type": "string",
                    "description": "The volume name."
                },
                "type": {
                    "type": "string",
                    "description": "The volume type."
                },
                "attachments": {
                    "type": "array",
                    "description": "The volume's attachments.",
                    "items": { "$ref": "#/definitions/volumeAttachment" }
                },
                "availabilityZone": {
                    "type": "string",
                    "description": "The zone for which the volume is available."
                },
                "iops": {
                    "type": "number",
                    "description": "The volume IOPs."
                },
                "networkName": {
                    "type": "string",
                    "description": "The name of the network on which the volume resides."
                },
                "size": {
                    "type": "number",
                    "description": "The volume size (GB)."
                },
                "status": {
                    "type": "string",
                    "description": "The volume status."
                },
                "fields": { "$ref": "#/definitions/fields" }
            },
            "required": [ "id", "name", "size" ],
            "additionalProperties": false
        },
        "volumeAttachment": {
            "properties": {
                "instanceID": { "$ref": "#/definitions/instanceID" },
                "deviceName": {
                    "type": "string",
                    "description": "The name of the device on which the volume to which the object is attached is mounted."
                },
                "status": {
                    "type": "string",
                    "description": "The status of the attachment."
                },
                "volumeID": {
                    "type": "string",
                    "description": "The ID of the volume to which the attachment belongs."
                },
                "fields": { "$ref": "#/definitions/fields" }
            },
            "required": [ "instanceID", "deviceName", "volumeID" ],
            "additionalProperties": false
        },
        "instanceID": {
            "properties": {
                "id": {
                    "type": "string",
                    "description": "The instance ID."
                },
                "data": {
                    "type": "object",
                    "description": "Extra information about the instance ID."
                }
            },
            "required": [ "id" ],
            "additionalProperties": false
        },
        "fields": {
            "additionalProperties": true,
            "description": "Fields are additional properties that can be defined for this type."
        }
    }
}