diff options
Diffstat (limited to 'static/redfish/v1/JsonSchemas/VirtualMedia/VirtualMedia.json')
| -rw-r--r-- | static/redfish/v1/JsonSchemas/VirtualMedia/VirtualMedia.json | 142 |
1 files changed, 71 insertions, 71 deletions
diff --git a/static/redfish/v1/JsonSchemas/VirtualMedia/VirtualMedia.json b/static/redfish/v1/JsonSchemas/VirtualMedia/VirtualMedia.json index 8053690943..dcdeee9924 100644 --- a/static/redfish/v1/JsonSchemas/VirtualMedia/VirtualMedia.json +++ b/static/redfish/v1/JsonSchemas/VirtualMedia/VirtualMedia.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/VirtualMedia.v1_3_0.json", + "$id": "http://redfish.dmtf.org/schemas/v1/VirtualMedia.v1_3_2.json", "$ref": "#/definitions/VirtualMedia", "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", - "copyright": "Copyright 2014-2018 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", + "copyright": "Copyright 2014-2019 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", "definitions": { "Actions": { "additionalProperties": false, - "description": "The available actions for this resource.", - "longDescription": "This type shall contain the available actions for this resource.", + "description": "The available actions for this Resource.", + "longDescription": "This type shall contain the available actions for this Resource.", "patternProperties": { - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "^([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", @@ -31,8 +31,8 @@ }, "Oem": { "$ref": "#/definitions/OemActions", - "description": "This property contains the available OEM specific actions for this resource.", - "longDescription": "This property shall contain any additional OEM actions for this resource.", + "description": "The available OEM-specific actions for this Resource.", + "longDescription": "This property shall contain the available OEM-specific actions for this Resource.", "versionAdded": "v1_1_0" } }, @@ -48,18 +48,18 @@ "enumDescriptions": { "Applet": "Connected to a client application.", "NotConnected": "No current connection.", - "Oem": "Connected via an OEM-defined method.", + "Oem": "Connected through an OEM-defined method.", "URI": "Connected to a URI location." }, "type": "string" }, "EjectMedia": { "additionalProperties": false, - "description": "This action is used to detach remote media from virtual media.", - "longDescription": "This action shall detach the remote media from the virtual media. At the completion of the operation, inserted shall be set to false and the image name shall be cleared.", + "description": "This action detaches remote media from virtual media.", + "longDescription": "This action shall detach the remote media from the virtual media. At the completion of the operation, inserted shall be set to `false` and the image name shall be cleared.", "parameters": {}, "patternProperties": { - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "^([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", @@ -75,7 +75,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -88,52 +88,52 @@ }, "InsertMedia": { "additionalProperties": false, - "description": "This action is used to attach remote media to virtual media.", + "description": "This action attaches remote media to virtual media.", "longDescription": "This action shall attach remote media to virtual media.", "parameters": { "Image": { "description": "The URI of the remote media to attach to the virtual media.", - "longDescription": "This value shall specify the URI of the remote media to be attached to the virtual media.", + "longDescription": "This parameter shall specify the URI of the remote media to be attached to the virtual media.", "requiredParameter": true, "type": "string" }, "Inserted": { - "description": "Indicates if the image is to be treated as inserted upon completion of the action.", - "longDescription": "This value shall specify if the image is to be treated as inserted upon completion of the action. If this parameter is not provided by the client, the service shall default this value to be true.", + "description": "An indication of whether the image is treated as inserted upon completion of the action. The default is `true`.", + "longDescription": "This parameter shall indicate whether the image is treated as inserted upon completion of the action. If the client does not provide this parameter, the service shall default this value to `true`.", "type": "boolean" }, "Password": { - "description": "The password to be used when accessing the URI specified by the Image parameter.", - "longDescription": "This parameter shall contain a string representing the password to be used when accessing the URI specified by the Image parameter.", + "description": "The password to access the Image parameter-specified URI.", + "longDescription": "This parameter shall represent the password to access the Image parameter-specified URI.", "type": "string", "versionAdded": "v1_3_0" }, "TransferMethod": { "$ref": "#/definitions/TransferMethod", - "description": "Transfer method to use with the given Image.", - "longDescription": "This parameter shall contain a value describing how the image transfer is done.", + "description": "The transfer method to use with the Image.", + "longDescription": "This parameter shall describe how the image transfer occurs.", "versionAdded": "v1_3_0" }, "TransferProtocolType": { "$ref": "#/definitions/TransferProtocolType", - "description": "Network protocol to use with the image.", - "longDescription": "This parameter shall contain a value representing the network protocol to use with the specified image URI.", + "description": "The network protocol to use with the image.", + "longDescription": "This parameter shall represent the network protocol to use with the specified image URI.", "versionAdded": "v1_3_0" }, "UserName": { - "description": "The username to be used when accessing the URI specified by the Image parameter.", - "longDescription": "This parameter shall contain a string representing the username to be used when accessing the URI specified by the Image parameter.", + "description": "The user name to access the Image parameter-specified URI.", + "longDescription": "This parameter shall contain the user name to access the Image parameter-specified URI.", "type": "string", "versionAdded": "v1_3_0" }, "WriteProtected": { - "description": "Indicates if the remote media is supposed to be treated as write protected.", - "longDescription": "This value shall specify if the remote media is supposed to be treated as write protected. If this parameter is not provided by the client, the service shall default this value to be true.", + "description": "An indication of whether the remote media is treated as write-protected. The default is `true`.", + "longDescription": "This parameter shall indicate whether the remote media is treated as write-protected. If the client does not provide this parameter, the service shall default this value to `true`.", "type": "boolean" } }, "patternProperties": { - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "^([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", @@ -149,7 +149,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -177,10 +177,10 @@ }, "OemActions": { "additionalProperties": true, - "description": "The available OEM specific actions for this resource.", - "longDescription": "This type shall contain any additional OEM actions for this resource.", + "description": "The available OEM-specific actions for this Resource.", + "longDescription": "This type shall contain the available OEM-specific actions for this Resource.", "patternProperties": { - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "^([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", @@ -220,24 +220,24 @@ "OEM" ], "enumDescriptions": { - "CIFS": "Common Internet File System protocol.", - "FTP": "File Transfer Protocol.", - "HTTP": "Hypertext Transfer Protocol.", - "HTTPS": "HTTP Secure protocol.", - "NFS": "Network File System protocol.", - "OEM": "A protocol defined by the manufacturer.", - "SCP": "Secure File Copy protocol.", - "SFTP": "Secure File Transfer Protocol.", - "TFTP": "Trivial File Transfer Protocol." + "CIFS": "Common Internet File System (CIFS).", + "FTP": "File Transfer Protocol (FTP).", + "HTTP": "Hypertext Transfer Protocol (HTTP).", + "HTTPS": "Hypertext Transfer Protocol Secure (HTTPS).", + "NFS": "Network File System (NFS).", + "OEM": "A manufacturer-defined protocol.", + "SCP": "Secure Copy Protocol (SCP).", + "SFTP": "Secure File Transfer Protocol (SFTP).", + "TFTP": "Trivial File Transfer Protocol (TFTP)." }, "type": "string" }, "VirtualMedia": { "additionalProperties": false, - "description": "The VirtualMedia schema contains properties related to monitoring and control of an instance of virtual media such as a remote CD, DVD, or USB device. Virtual media functionality is provided by a Manager for a system or device.", - "longDescription": "This resource shall be used to represent a virtual media service for a Redfish implementation.", + "description": "The VirtualMedia schema contains properties related to the monitor and control of an instance of virtual media, such as a remote CD, DVD, or USB device. A manager for a system or device provides virtual media functionality.", + "longDescription": "This Resource shall represent a virtual media service for a Redfish implementation.", "patternProperties": { - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "^([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", @@ -252,21 +252,21 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" }, "@odata.type": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/type" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type" }, "Actions": { "$ref": "#/definitions/Actions", - "description": "The available actions for this resource.", - "longDescription": "The Actions property shall contain the available actions for this resource.", + "description": "The available actions for this Resource.", + "longDescription": "This property shall contain the available actions for this Resource.", "versionAdded": "v1_1_0" }, "ConnectedVia": { @@ -278,8 +278,8 @@ "type": "null" } ], - "description": "Current virtual media connection methods.", - "longDescription": "The value of this property shall indicate the current connection method from a client to the virtual media represented by this resource. A value of NotConnected shall indicate no connection is present. A value of URI shall indicate that a remote connection via a URI reference type is being used.", + "description": "The current virtual media connection method.", + "longDescription": "This property shall contain the current connection method from a client to the virtual media that this Resource represents.", "readonly": true }, "Description": { @@ -298,9 +298,9 @@ "readonly": true }, "Image": { - "description": "A URI providing the location of the selected image.", - "format": "uri", - "longDescription": "The value of this string shall be an URI. A null value indicated no image connection.", + "description": "The URI of the location of the selected image.", + "format": "uri-reference", + "longDescription": "This property shall contain an URI. A null value indicated no image connection.", "readonly": false, "type": [ "string", @@ -309,7 +309,7 @@ }, "ImageName": { "description": "The current image name.", - "longDescription": "The value of this property shall be the name of the image.", + "longDescription": "This property shall contain the name of the image.", "readonly": true, "type": [ "string", @@ -317,8 +317,8 @@ ] }, "Inserted": { - "description": "Indicates if virtual media is inserted in the virtual device.", - "longDescription": "The value of this property shall be used to indicate if media is present in the virtual media device. This is usually only applicable to remoting of devices and not for image virtual media usage.", + "description": "An indication of whether virtual media is inserted into the virtual device.", + "longDescription": "This property shall indicate whether media is present in the virtual media device.", "readonly": false, "type": [ "boolean", @@ -326,7 +326,7 @@ ] }, "MediaTypes": { - "description": "This is the media types supported as virtual media.", + "description": "The media types supported as virtual media.", "items": { "$ref": "#/definitions/MediaType" }, @@ -340,12 +340,12 @@ }, "Oem": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", - "description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.", - "longDescription": "The value of this string shall be of the format for the reserved word *Oem*." + "description": "The OEM extension property.", + "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements." }, "Password": { - "description": "The password to be used when accessing the URI specified by the Image parameter. This property is null on a GET.", - "longDescription": "This parameter shall contain a string representing the password to be used when accessing the URI specified by the Image parameter. The value shall be null for GET requests.", + "description": "The password to access the Image parameter-specified URI. This property is null in responses.", + "longDescription": "This parameter shall represent the password to access the Image parameter-specified URI. The value shall be null in responses.", "readonly": false, "type": [ "string", @@ -362,8 +362,8 @@ "type": "null" } ], - "description": "Transfer method to use with the given Image.", - "longDescription": "This parameter shall contain a value describing how the image transfer is done.", + "description": "The transfer method to use with the Image.", + "longDescription": "This parameter shall describe how the image transfer occurs.", "readonly": false, "versionAdded": "v1_3_0" }, @@ -376,14 +376,14 @@ "type": "null" } ], - "description": "Network protocol to use with the image.", - "longDescription": "This parameter shall contain a value representing the network protocol to use with the specified image URI.", + "description": "The network protocol to use with the image.", + "longDescription": "This parameter shall represent the network protocol to use with the specified image URI.", "readonly": false, "versionAdded": "v1_3_0" }, "UserName": { - "description": "The username to be used when accessing the URI specified by the Image parameter.", - "longDescription": "This parameter shall contain a string representing the username to be used when accessing the URI specified by the Image parameter.", + "description": "The user name to access the Image parameter-specified URI.", + "longDescription": "This parameter shall represent the user name to access the Image parameter-specified URI.", "readonly": false, "type": [ "string", @@ -392,8 +392,8 @@ "versionAdded": "v1_3_0" }, "WriteProtected": { - "description": "Indicates the media is write protected.", - "longDescription": "The value of this property shall be used to indicate if the remote device media prevents writing to that media.", + "description": "An indication of whether the media is write-protected.", + "longDescription": "This property shall indicate whether the remote device media prevents writing to that media.", "readonly": false, "type": [ "boolean", @@ -412,5 +412,5 @@ }, "owningEntity": "DMTF", "release": "2018.3", - "title": "#VirtualMedia.v1_3_0.VirtualMedia" + "title": "#VirtualMedia.v1_3_2.VirtualMedia" }
\ No newline at end of file |