blob: 84cab6d37ab2d10f2377ec29f3d80bd0b0889a26 [file] [log] [blame]
{
"$id": "http://redfish.dmtf.org/schemas/v1/redfish-payload-annotations.v1_0_1.json",
"$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
"copyright": "Copyright 2014-2019 Distributed Management Task Force, Inc. (DMTF). For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
"properties": {
"@Redfish.ActionInfo": {
"description": "The term can be applied to an action to specify a URI to an ActionInfo Resource that describes the parameters supported by this instance of the action.",
"type": "string",
"format": "uri-reference",
"readonly": true
},
"@Redfish.Settings": {
"description": "The link to the Settings Resource that represents the settings to apply to this Resource.",
"$ref": "http://redfish.dmtf.org/schemas/v1/Settings.json#/definitions/Settings"
},
"@Redfish.SettingsApplyTime": {
"description": "The configuration settings for when the values in the settings object are applied to a Resource.",
"$ref": "http://redfish.dmtf.org/schemas/v1/Settings.json#/definitions/PreferredApplyTime"
},
"@Redfish.OperationApplyTime": {
"description": "The requested apply time from a client when performing a create, delete, or action operation.",
"$ref": "http://redfish.dmtf.org/schemas/v1/Settings.json#/definitions/OperationApplyTime"
},
"@Redfish.OperationApplyTimeSupport": {
"description": "An indication of whether a client can request an apply time for a create, delete, or action operation of a Resource through the OperationApplyTime term.",
"$ref": "http://redfish.dmtf.org/schemas/v1/Settings.json#/definitions/OperationApplyTimeSupport"
},
"@Redfish.MaintenanceWindow": {
"description": "The maintenance window configuration for a Resource for when to apply settings or operations.",
"$ref": "http://redfish.dmtf.org/schemas/v1/Settings.json#/definitions/MaintenanceWindow"
},
"@Redfish.CollectionCapabilities": {
"description": "The link to the Resource that represents the POST capabilities of a collection.",
"$ref": "http://redfish.dmtf.org/schemas/v1/CollectionCapabilities.json#/definitions/CollectionCapabilities"
},
"@odata.context": {
"type": "string",
"format": "uri-reference",
"readonly": true,
"description": "The OData description of a payload.",
"longDescription": "The value of this property shall be the context URL that describes the resource according to OData-Protocol and shall be of the form defined in the Redfish specification."
},
"@odata.id": {
"type": "string",
"format": "uri-reference",
"readonly": true,
"description": "The unique identifier for a resource.",
"longDescription": "The value of this property shall be the unique identifier for the resource and it shall be of the form defined in the Redfish specification."
},
"@odata.type": {
"type": "string",
"readonly": true,
"description": "The type of a resource.",
"longDescription": "The value of this property shall be a URI fragment that specifies the type of the resource and it shall be of the form defined in the Redfish specification."
},
"@odata.etag": {
"type": "string",
"readonly": true,
"description": "The current ETag of the resource.",
"longDescription": "The value of this property shall be a string that is defined by the ETag HTTP header definition in RFC7232."
}
},
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@Redfish.AllowableValues$": {
"description": "The set of allowable values for a parameter.",
"type": "array",
"items": {
"type": "string"
},
"readonly": true
},
"^([a-zA-Z_][a-zA-Z0-9_]*)?@Redfish.RequiredOnCreate$": {
"description": "The term specifies that a property is required to be specified in the body of a POST request to create the Resource.",
"type": "boolean",
"readonly": true
},
"^([a-zA-Z_][a-zA-Z0-9_]*)?@Redfish.SetOnlyOnCreate$": {
"description": "The term specifies that a property can only be set when a client creates an instance of a Resource through POST.",
"type": "boolean",
"readonly": true
},
"^([a-zA-Z_][a-zA-Z0-9_]*)?@Redfish.OptionalOnCreate$": {
"description": "The term specifies that a property may be set when a client creates an instance of a Resource through POST.",
"type": "boolean",
"readonly": true
},
"^([a-zA-Z_][a-zA-Z0-9_]*)?@Redfish.UpdatableAfterCreate$": {
"description": "The term specifies that a property may be set by a client that uses PATCH after it creates an instance of a Resource through POST.",
"type": "boolean",
"readonly": true
},
"^([a-zA-Z_][a-zA-Z0-9_]*)?@Message.ExtendedInfo$": {
"description": "The ExtendedInfo annotation can be applied to any object or property to provide additional information about the item.",
"type": "array",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Message.json#/definitions/Message"
}
},
"^([a-zA-Z_][a-zA-Z0-9_]*)?@odata.count$": {
"type": "integer",
"readonly": true,
"description": "The number of items in a collection.",
"longDescription": "The value of this property shall be an integer representing the number of items in a collection."
},
"^([a-zA-Z_][a-zA-Z0-9_]*)?@odata.nextLink$": {
"type": "string",
"format": "uri-reference",
"readonly": true,
"description": "The URI to the resource containing the next set of partial members.",
"longDescription": "The value of this property shall be a URI to a resource, with the same @odata.type, containing the next set of partial members."
}
}
}