diff options
Diffstat (limited to 'static/redfish/v1/JsonSchemas/PrivilegeRegistry/PrivilegeRegistry.json')
| -rw-r--r-- | static/redfish/v1/JsonSchemas/PrivilegeRegistry/PrivilegeRegistry.json | 174 |
1 files changed, 70 insertions, 104 deletions
diff --git a/static/redfish/v1/JsonSchemas/PrivilegeRegistry/PrivilegeRegistry.json b/static/redfish/v1/JsonSchemas/PrivilegeRegistry/PrivilegeRegistry.json index 596100fc18..b50a7997be 100644 --- a/static/redfish/v1/JsonSchemas/PrivilegeRegistry/PrivilegeRegistry.json +++ b/static/redfish/v1/JsonSchemas/PrivilegeRegistry/PrivilegeRegistry.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/PrivilegeRegistry.v1_1_4.json", "$ref": "#/definitions/PrivilegeRegistry", "$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,19 @@ "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.", + "versionAdded": "v1_1_0" } }, "type": "object" }, "Mapping": { "additionalProperties": false, - "description": "This type describes a mapping between an entity and the relevant privileges used to access it.", - "longDescription": "This type shall describe a mapping between an entity and the relevant privileges used to access it.", + "description": "The mapping between a Resource type and the relevant privileges that accesses the Resource.", + "longDescription": "This type shall describe a mapping between a Resource type and the relevant privileges that accesses the 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", @@ -50,59 +52,38 @@ }, "properties": { "Entity": { - "description": "Indicates entity name. e.g., Manager.", - "longDescription": "Indicates entity name. e.g., Manager.", + "description": "The Resource name, such as `Manager`.", + "longDescription": "This property shall contain the Resource name, such as `Manager`.", "readonly": true, "type": "string" }, "OperationMap": { "$ref": "#/definitions/OperationMap", - "description": "List mapping between HTTP method and privilege required for entity.", - "longDescription": "List mapping between HTTP method and privilege required for entity." + "description": "List mapping between HTTP methods and privilege required for the Resource.", + "longDescription": "This property shall list the mapping between HTTP methods and the privilege required for the Resource." }, "PropertyOverrides": { - "description": "Indicates privilege overrides of property or element within a entity.", + "description": "The privilege overrides of properties within a Resource.", "items": { - "anyOf": [ - { - "$ref": "#/definitions/Target_PrivilegeMap" - }, - { - "type": "null" - } - ] + "$ref": "#/definitions/Target_PrivilegeMap" }, - "longDescription": "Indicates privilege overrides of property or element. e.g., password property.", + "longDescription": "This property shall contain the privilege overrides of properties, such as the `Password` property in the `ManagerAccount` Resource.", "type": "array" }, "ResourceURIOverrides": { - "description": "Indicates privilege overrides of Resource URI.", + "description": "The privilege overrides of Resource URIs.", "items": { - "anyOf": [ - { - "$ref": "#/definitions/Target_PrivilegeMap" - }, - { - "type": "null" - } - ] + "$ref": "#/definitions/Target_PrivilegeMap" }, - "longDescription": "Indicates privilege overrides of Resource URI. Target lists Resource URI.", + "longDescription": "This property shall contain the privilege overrides of Resource URIs. The target lists the Resource URI and the new privileges.", "type": "array" }, "SubordinateOverrides": { - "description": "Indicates privilege overrides of subordinate resource.", + "description": "The privilege overrides of the subordinate Resource.", "items": { - "anyOf": [ - { - "$ref": "#/definitions/Target_PrivilegeMap" - }, - { - "type": "null" - } - ] + "$ref": "#/definitions/Target_PrivilegeMap" }, - "longDescription": "Indicates privilege overrides of subordinate resource. Target lists referenced by Entity.", + "longDescription": "This property shall contain the privilege overrides of the subordinate Resource. The target lists are identified by Resource type.", "type": "array" } }, @@ -110,10 +91,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", @@ -131,10 +112,10 @@ }, "OperationMap": { "additionalProperties": false, - "description": "Used for describing the specific privileges for a set of HTTP operations.", - "longDescription": "This type shall describe the specific privileges required for a set of HTTP operations.", + "description": "The specific privileges required to complete a set of HTTP operations.", + "longDescription": "This type shall describe the specific privileges required to complete a set of HTTP operations.", "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,51 +130,51 @@ }, "properties": { "DELETE": { - "description": "Indicates privilege required for HTTP DELETE operation.", + "description": "The privilege required to complete an HTTP DELETE operation.", "items": { "$ref": "#/definitions/OperationPrivilege" }, - "longDescription": "Indicates privilege required for HTTP DELETE operation.", + "longDescription": "This property shall contain the privilege required to complete an HTTP DELETE operation.", "type": "array" }, "GET": { - "description": "Indicates privilege required for HTTP GET operation.", + "description": "The privilege required to complete an HTTP GET operation.", "items": { "$ref": "#/definitions/OperationPrivilege" }, - "longDescription": "Indicates privilege required for HTTP GET operation.", + "longDescription": "This property shall contain the privilege required to complete an HTTP GET operation.", "type": "array" }, "HEAD": { - "description": "Indicates privilege required for HTTP HEAD operation.", + "description": "The privilege required to complete an HTTP HEAD operation.", "items": { "$ref": "#/definitions/OperationPrivilege" }, - "longDescription": "Indicates privilege required for HTTP HEAD operation.", + "longDescription": "This property shall contain the privilege required to complete an HTTP HEAD operation.", "type": "array" }, "PATCH": { - "description": "Indicates privilege required for HTTP PATCH operation.", + "description": "The privilege required to complete an HTTP PATCH operation.", "items": { "$ref": "#/definitions/OperationPrivilege" }, - "longDescription": "Indicates privilege required for HTTP PATCH operation.", + "longDescription": "This property shall contain the privilege required to complete an HTTP PATCH operation.", "type": "array" }, "POST": { - "description": "Indicates privilege required for HTTP POST operation.", + "description": "The privilege required to complete an HTTP POST operation.", "items": { "$ref": "#/definitions/OperationPrivilege" }, - "longDescription": "Indicates privilege required for HTTP POST operation.", + "longDescription": "This property shall contain the privilege required to complete an HTTP POST operation.", "type": "array" }, "PUT": { - "description": "Indicates privilege required for HTTP PUT operation.", + "description": "The privilege required to complete an HTTP PUT operation.", "items": { "$ref": "#/definitions/OperationPrivilege" }, - "longDescription": "Indicates privilege required for HTTP PUT operation.", + "longDescription": "This property shall contain the privilege required to complete an HTTP PUT operation.", "type": "array" } }, @@ -201,10 +182,10 @@ }, "OperationPrivilege": { "additionalProperties": false, - "description": "Used for describing the specific privileges for a given type of HTTP operation.", - "longDescription": "This type shall describe the specific privileges required for a given type of HTTP operation.", + "description": "The privileges for a specific HTTP operation.", + "longDescription": "This type shall describe the privileges required to complete a specific HTTP operation.", "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", @@ -219,11 +200,11 @@ }, "properties": { "Privilege": { - "description": "Lists the privileges that are allowed to perform the given type of HTTP operation on the entity type.", + "description": "An array of privileges that are required to complete a specific HTTP operation on a Resource.", "items": { "type": "string" }, - "longDescription": "This array shall contain a set of strings that match 0 or more of the strings found in the PrivilegesUsed and OEMPrivilegesUsed properties.", + "longDescription": "This array shall contain an array of privileges that are required to complete a specific HTTP operation on a Resource. This set of strings match zero or more strings in the PrivilegesUsed and OEMPrivilegesUsed properties.", "readonly": true, "type": "array" } @@ -232,10 +213,10 @@ }, "PrivilegeRegistry": { "additionalProperties": false, - "description": "This is the schema definition for Operation to Privilege mapping.", - "longDescription": "This resource shall be used to represent operation to privilege mappings.", + "description": "The PrivilegeRegistry schema describes the operation-to-privilege mappings.", + "longDescription": "This Resource contains operation-to-privilege mappings.", "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", @@ -249,22 +230,14 @@ } }, "properties": { - "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" - }, - "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" - }, - "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.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" }, "Description": { "anyOf": [ @@ -282,11 +255,11 @@ "readonly": true }, "Mappings": { - "description": "This property describes the mappings between entities and the relevant privileges used to access them.", + "description": "The mappings between entities and the relevant privileges that access those entities.", "items": { "$ref": "#/definitions/Mapping" }, - "longDescription": "This property shall describe the mappings between entities and the relevant privileges used to access them.", + "longDescription": "This property shall describe the mappings between entities and the relevant privileges that access those entities.", "type": "array" }, "Name": { @@ -294,31 +267,30 @@ "readonly": true }, "OEMPrivilegesUsed": { - "description": "Lists the set of OEM Priviliges used in building this mapping.", + "description": "The set of OEM privileges used in this mapping.", "items": { "type": "string" }, - "longDescription": "This property shall be an array that contains the set of OEM Priviliges used in building this mapping.", + "longDescription": "This property shall contain an array of OEM privileges used in this mapping.", "readonly": true, "type": "array" }, "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." }, "PrivilegesUsed": { - "description": "Lists the set of Redfish standard priviliges used in building this mapping.", + "description": "The set of Redfish standard privileges used in this mapping.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Privileges.json#/definitions/PrivilegeType" }, - "longDescription": "This property shall be an array that contains the set of Redfish standard priviliges used in building this mapping.", + "longDescription": "This property shall contain an array of Redfish standard privileges used in this mapping.", "readonly": true, "type": "array" } }, "required": [ - "@odata.id", "@odata.type", "Id", "Name" @@ -330,7 +302,7 @@ "description": "This type describes a mapping between one or more targets and the HTTP operations associated with them.", "longDescription": "This type shall describe a mapping between one or more targets and the HTTP operations associated with them.", "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", @@ -345,26 +317,19 @@ }, "properties": { "OperationMap": { - "anyOf": [ - { - "$ref": "#/definitions/OperationMap" - }, - { - "type": "null" - } - ], - "description": "List mapping between HTTP operation and privilege needed to perform operation.", - "longDescription": "List mapping between HTTP operation and privilege needed to perform operation." + "$ref": "#/definitions/OperationMap", + "description": "The mapping between the HTTP operation and the privilege required to complete the operation.", + "longDescription": "This property shall contain the mapping between the HTTP operation and the privilege required to complete the operation." }, "Targets": { - "description": "Indicates the URI or Entity.", + "description": "The set of URIs, Resource types, or properties.", "items": { "type": [ "string", "null" ] }, - "longDescription": "Indicates the set of URI(s) or Entity(s) or property(s). e.g./redfish/v1/Systems/1, Manager, Password. When targets property is not mentioned, then there is no override.", + "longDescription": "This property shall contain the array of URIs, Resource types, or properties. For example, `/redfish/v1/Systems/1`, `Manager`, or `Password`. When the Targets property is not present, no override is specified.", "readonly": true, "type": "array" } @@ -373,5 +338,6 @@ } }, "owningEntity": "DMTF", - "title": "#PrivilegeRegistry.v1_1_2.PrivilegeRegistry" + "release": "2017.1", + "title": "#PrivilegeRegistry.v1_1_4.PrivilegeRegistry" }
\ No newline at end of file |