diff options
Diffstat (limited to 'static/redfish/v1/JsonSchemas/ActionInfo/ActionInfo.json')
| -rw-r--r-- | static/redfish/v1/JsonSchemas/ActionInfo/ActionInfo.json | 68 |
1 files changed, 36 insertions, 32 deletions
diff --git a/static/redfish/v1/JsonSchemas/ActionInfo/ActionInfo.json b/static/redfish/v1/JsonSchemas/ActionInfo/ActionInfo.json index 76ebef944d..73ffca2856 100644 --- a/static/redfish/v1/JsonSchemas/ActionInfo/ActionInfo.json +++ b/static/redfish/v1/JsonSchemas/ActionInfo/ActionInfo.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/ActionInfo.v1_1_2.json", "$ref": "#/definitions/ActionInfo", "$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": { "ActionInfo": { "additionalProperties": false, - "description": "The ActionInfo schema describes the parameters and other information necessary to perform a Redfish Action on a particular Action target. Parameter support can differ between vendors and even between instances of a resource. This data can be used to ensure Action requests from applications contain supported parameters.", - "longDescription": "This resource shall be used to represent information about the supported parameters for an Action within a Redfish implementation.", + "description": "The ActionInfo schema defines the supported parameters and other information for a Redfish action. Supported parameters can differ among vendors and even among Resource instances. This data can ensure that action requests from applications contain supported parameters.", + "longDescription": "This Resource shall represent the supported parameters and other information for a Redfish action on a target within a Redfish implementation. Supported parameters can differ among vendors and even among Resource instances. This data can ensure that action requests from applications contain supported 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", @@ -23,16 +24,16 @@ }, "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" }, "Description": { "anyOf": [ @@ -55,15 +56,15 @@ }, "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." }, "Parameters": { - "description": "The parameters associated with the specified Redfish Action.", + "description": "The list of parameters included in the specified Redfish action.", "items": { "$ref": "#/definitions/Parameters" }, - "longDescription": "This property shall contain a list of parameters associated with a Redfish Action associated with this resource.", + "longDescription": "This property shall list the parameters included in the specified Redfish action for this Resource.", "type": "array" } }, @@ -86,7 +87,7 @@ "ObjectArray" ], "enumDescriptions": { - "Boolean": "A boolean (true or false).", + "Boolean": "A boolean.", "Number": "A number.", "NumberArray": "An array of numbers.", "Object": "An embedded JSON object.", @@ -98,10 +99,10 @@ }, "Parameters": { "additionalProperties": false, - "description": "A parameter associated with the specified Redfish Action.", - "longDescription": "This property shall contain information about a specific parameter associated with a Redfish Action associated with this resource.", + "description": "The information about a parameter included in a Redfish action for this Resource.", + "longDescription": "This property shall contain information about a parameter included in a Redfish Action 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", @@ -116,14 +117,14 @@ }, "properties": { "AllowableValues": { - "description": "A list of values for this parameter supported by this Action target.", + "description": "The allowable values for this parameter as applied to this action target.", "items": { "type": [ "string", "null" ] }, - "longDescription": "This property shall indicate the allowable values for this parameter as applied to this Action target.", + "longDescription": "This property shall indicate the allowable values for this parameter as applied to this action target.", "readonly": true, "type": "array" }, @@ -136,37 +137,39 @@ "type": "null" } ], - "description": "The JSON property type used for this parameter.", - "longDescription": "This property shall indicate the JSON property type of the parameter.", + "description": "The JSON property type for this parameter.", + "longDescription": "This property shall contain the JSON property type for this parameter.", "readonly": true }, "MaximumValue": { - "description": "The maximum supported value of this parameter.", - "longDescription": "This property shall indicate the maximum value of an integer or number type parameter supported by this service. This property shall not be present for parameters that are of types other than integer or number.", + "description": "The maximum supported value for this parameter.", + "longDescription": "This integer or number property shall contain the maximum value that this service supports. This property shall not be present for non-integer or number parameters.", "readonly": true, "type": [ "number", "null" - ] + ], + "versionAdded": "v1_1_0" }, "MinimumValue": { "description": "The minimum supported value for this parameter.", - "longDescription": "This property shall indicate the minimum value of an integer or number type parameter supported by this service. This property shall not be present for parameters that are of types other than integer or number.", + "longDescription": "This integer or number property shall contain the minimum value that this service supports. This property shall not be present for parameters that are of types other than integer or number.", "readonly": true, "type": [ "number", "null" - ] + ], + "versionAdded": "v1_1_0" }, "Name": { - "description": "The name of the parameter for this Action.", - "longDescription": "This property shall contain the name of the parameter used by the associated Redfish Action.", + "description": "The name of the parameter for this action.", + "longDescription": "This property shall contain the name of the parameter included in a Redfish action.", "readonly": true, "type": "string" }, "ObjectDataType": { - "description": "The OData Type of an object-based parameter.", - "longDescription": "This property shall describe the entity type definition (in @odata.type format) for the parameter. This property shall be required for parameters with a DataType of Object or ObjectArray, and shall not be present for parameters with other DataType(s).", + "description": "The data type of an object-based parameter.", + "longDescription": "This property shall describe the entity type definition in `@odata.type` format for the parameter. This property shall be required for parameters with a data type of `Object` or `ObjectArray`, and shall not be present for parameters with other data types.", "readonly": true, "type": [ "string", @@ -174,8 +177,8 @@ ] }, "Required": { - "description": "Indicates whether the parameter is required to perform this Action.", - "longDescription": "This property shall return true if the parameter is required to be present to perform the associated Action, and shall be false if the parameter is not required (optional) to perform the associated Action.", + "description": "An indication of whether the parameter is required to complete this action.", + "longDescription": "This property shall indicate whether the parameter is required to complete this action.", "readonly": true, "type": "boolean" } @@ -187,5 +190,6 @@ } }, "owningEntity": "DMTF", - "title": "#ActionInfo.v1_1_0.ActionInfo" + "release": "2018.2", + "title": "#ActionInfo.v1_1_2.ActionInfo" }
\ No newline at end of file |