summaryrefslogtreecommitdiff
path: root/static/redfish/v1/JsonSchemas/SoftwareInventory/SoftwareInventory.json
diff options
context:
space:
mode:
Diffstat (limited to 'static/redfish/v1/JsonSchemas/SoftwareInventory/SoftwareInventory.json')
-rw-r--r--static/redfish/v1/JsonSchemas/SoftwareInventory/SoftwareInventory.json102
1 files changed, 55 insertions, 47 deletions
diff --git a/static/redfish/v1/JsonSchemas/SoftwareInventory/SoftwareInventory.json b/static/redfish/v1/JsonSchemas/SoftwareInventory/SoftwareInventory.json
index 56c7936365..5504647d25 100644
--- a/static/redfish/v1/JsonSchemas/SoftwareInventory/SoftwareInventory.json
+++ b/static/redfish/v1/JsonSchemas/SoftwareInventory/SoftwareInventory.json
@@ -1,14 +1,15 @@
{
+ "$id": "http://redfish.dmtf.org/schemas/v1/SoftwareInventory.v1_2_3.json",
"$ref": "#/definitions/SoftwareInventory",
"$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",
@@ -24,18 +25,18 @@
"properties": {
"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."
}
},
"type": "object"
},
"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",
@@ -53,10 +54,10 @@
},
"SoftwareInventory": {
"additionalProperties": false,
- "description": "This schema defines an inventory of software components.",
- "longDescription": "This resource shall be used to represent a single software component managed by this Redfish Service.",
+ "description": "The SoftwareInventory schema contains an inventory of software components. This can include software components such as BIOS, BMC firmware, firmware for other devices, system drivers, or provider software.",
+ "longDescription": "This Resource contains a single software component that this Redfish Service manages.",
"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",
@@ -71,21 +72,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."
},
"Description": {
"anyOf": [
@@ -103,22 +104,24 @@
"readonly": true
},
"LowestSupportedVersion": {
- "description": "A string representing the lowest supported version of this software.",
- "longDescription": "The value of this property shall be a string representing the lowest supported version of this software. This string is formatted using the same format used for the Version property.",
+ "description": "The lowest supported version of this software.",
+ "longDescription": "This property shall represent the lowest supported version of this software. This string is formatted using the same format used for the Version property.",
"readonly": true,
"type": [
"string",
"null"
- ]
+ ],
+ "versionAdded": "v1_1_0"
},
"Manufacturer": {
- "description": "A string representing the manufacturer/producer of this software.",
- "longDescription": "The value of this property shall be a string representing the name of the manufacturer/producer of this software.",
+ "description": "The manufacturer or producer of this software.",
+ "longDescription": "This property shall represent the name of the manufacturer or producer of this software.",
"readonly": true,
"type": [
"string",
"null"
- ]
+ ],
+ "versionAdded": "v1_2_0"
},
"Name": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
@@ -126,57 +129,61 @@
},
"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."
},
"RelatedItem": {
- "description": "The ID(s) of the resources associated with this software inventory item.",
+ "description": "The IDs of the Resources associated with this software inventory item.",
"items": {
- "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/idRef"
+ "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef"
},
- "longDescription": "The value of this property shall be an array of IDs containing pointers consistent with JSON pointer syntax to the resource that is associated with this software inventory item.",
+ "longDescription": "This property shall contain an array of IDs for pointers consistent with JSON Pointer syntax to the Resource that is associated with this software inventory item.",
"readonly": true,
- "type": "array"
+ "type": "array",
+ "versionAdded": "v1_1_0"
},
"RelatedItem@odata.count": {
- "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"
+ "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
},
"ReleaseDate": {
- "description": "Release date of this software.",
+ "description": "The release date of this software.",
"format": "date-time",
- "longDescription": "The value of this property shall be the date of release or production for this software. The time of day portion of the property shall be '00:00:00Z' if the time of day is unknown.",
+ "longDescription": "This property shall contain the date of release or production for this software. If the time of day is unknown, the time of day portion of the property shall contain `00:00:00Z`.",
"readonly": true,
"type": [
"string",
"null"
- ]
+ ],
+ "versionAdded": "v1_2_0"
},
"SoftwareId": {
- "description": "A string representing the implementation-specific ID for identifying this software.",
- "longDescription": "The value of this property shall be a string representing an implementation-specific ID for identifying this software. This string is used for correlation to a component repository or database.",
+ "description": "The implementation-specific label that identifies this software.",
+ "longDescription": "This property shall represent an implementation-specific label that identifies this software. This string correlates with a component repository or database.",
"readonly": true,
- "type": "string"
+ "type": "string",
+ "versionAdded": "v1_1_0"
},
"Status": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
- "description": "This property describes the status and health of the resource and its children.",
- "longDescription": "This property shall contain any status or health properties of the resource."
+ "description": "The status and health of the Resource and its subordinate or dependent Resources.",
+ "longDescription": "This property shall contain any status or health properties of the Resource."
},
"UefiDevicePaths": {
- "description": "A list of strings representing the UEFI Device Path(s) of the component(s) associated with this software inventory item.",
+ "description": "The list of UEFI device paths of the components associated with this software inventory item.",
"items": {
"type": [
"string",
"null"
]
},
- "longDescription": "The value of this property shall be a list of strings representing the UEFI Device Path(s) of the component(s) associated with this software inventory item. The UEFI Device Path string(s) shall be formatted as defined by the UEFI Specification.",
+ "longDescription": "This property shall contain a list UEFI device paths of the components associated with this software inventory item. The UEFI device paths shall be formatted as defined by the UEFI Specification.",
"readonly": true,
- "type": "array"
+ "type": "array",
+ "versionAdded": "v1_1_0"
},
"Updateable": {
- "description": "Indicates whether this software can be updated by the update service.",
- "longDescription": "The value of this property shall be a boolean indicating whether this software can be updated by the update service. If false, this software is for reporting purpose only.",
+ "description": "An indication of whether the Update Service can update this software.",
+ "longDescription": "This property shall indicate whether the Update Service can update this software. If `true`, the Service can update this software. If `false`, the Service cannot update this software and the software is for reporting purposes only.",
"readonly": true,
"type": [
"boolean",
@@ -184,8 +191,8 @@
]
},
"Version": {
- "description": "A string representing the version of this software.",
- "longDescription": "The value of this property shall be a string representing the version of this software.",
+ "description": "The version of this software.",
+ "longDescription": "This property shall contain the version of this software.",
"readonly": true,
"type": [
"string",
@@ -203,5 +210,6 @@
}
},
"owningEntity": "DMTF",
- "title": "#SoftwareInventory.v1_2_1.SoftwareInventory"
+ "release": "2018.1",
+ "title": "#SoftwareInventory.v1_2_3.SoftwareInventory"
} \ No newline at end of file