1720c9898SEd Tanous{ 2*28cfceb2SGunnar Mills "$id": "http://redfish.dmtf.org/schemas/v1/redfish-payload-annotations.v1_2_3.json", 3720c9898SEd Tanous "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", 4*28cfceb2SGunnar Mills "copyright": "Copyright 2014-2024 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", 5720c9898SEd Tanous "properties": { 6720c9898SEd Tanous "@Redfish.ActionInfo": { 7720c9898SEd Tanous "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.", 8720c9898SEd Tanous "type": "string", 9720c9898SEd Tanous "format": "uri-reference", 10720c9898SEd Tanous "readonly": true 11720c9898SEd Tanous }, 12720c9898SEd Tanous "@Redfish.Settings": { 13720c9898SEd Tanous "description": "The link to the settings resource that represents the settings to apply to this resource.", 14720c9898SEd Tanous "$ref": "http://redfish.dmtf.org/schemas/v1/Settings.json#/definitions/Settings" 15720c9898SEd Tanous }, 16720c9898SEd Tanous "@Redfish.SettingsApplyTime": { 17720c9898SEd Tanous "description": "The configuration settings for when the values in the settings object are applied to a resource.", 18720c9898SEd Tanous "$ref": "http://redfish.dmtf.org/schemas/v1/Settings.json#/definitions/PreferredApplyTime" 19720c9898SEd Tanous }, 20720c9898SEd Tanous "@Redfish.OperationApplyTime": { 21720c9898SEd Tanous "description": "The requested apply time from a client when performing a create, delete, or action operation.", 22720c9898SEd Tanous "$ref": "http://redfish.dmtf.org/schemas/v1/Settings.json#/definitions/OperationApplyTime" 23720c9898SEd Tanous }, 24720c9898SEd Tanous "@Redfish.OperationApplyTimeSupport": { 25720c9898SEd Tanous "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.", 26720c9898SEd Tanous "$ref": "http://redfish.dmtf.org/schemas/v1/Settings.json#/definitions/OperationApplyTimeSupport" 27720c9898SEd Tanous }, 28720c9898SEd Tanous "@Redfish.MaintenanceWindow": { 29720c9898SEd Tanous "description": "The maintenance window configuration for a resource for when to apply settings or operations.", 30720c9898SEd Tanous "$ref": "http://redfish.dmtf.org/schemas/v1/Settings.json#/definitions/MaintenanceWindow" 31720c9898SEd Tanous }, 32720c9898SEd Tanous "@Redfish.CollectionCapabilities": { 33720c9898SEd Tanous "description": "The link to the resource that represents the POST capabilities of a collection.", 34720c9898SEd Tanous "$ref": "http://redfish.dmtf.org/schemas/v1/CollectionCapabilities.json#/definitions/CollectionCapabilities" 35720c9898SEd Tanous }, 36720c9898SEd Tanous "@Redfish.RequestedCount": { 37720c9898SEd Tanous "type": "integer", 38720c9898SEd Tanous "description": "The term is used by a client to specify a request for a quantity of items." 39720c9898SEd Tanous }, 40720c9898SEd Tanous "@Redfish.RequestedCountRequired": { 41720c9898SEd Tanous "type": "boolean", 42720c9898SEd Tanous "readonly": true, 43720c9898SEd Tanous "description": "The term specifies that a client is required to provide the @Redfish.RequestedCount term as part of the payload to specify a quantity of items." 44720c9898SEd Tanous }, 45720c9898SEd Tanous "@Redfish.AllowOverprovisioning": { 46720c9898SEd Tanous "type": "boolean", 47720c9898SEd Tanous "description": "The term specifies that a client allows the service to provide more resources than requested, which includes, but is not limited to, a larger quantity of items, larger capacity, and faster devices.", 48720c9898SEd Tanous "longDescription": "The term shall specify that a client allows the service to provide more resources than requested, which includes, but is not limited to, a larger quantity of items, larger capacity, and faster devices. If not specified by the client, the service shall treat this as `false`." 49720c9898SEd Tanous }, 50720c9898SEd Tanous "@Redfish.ZoneAffinity": { 51720c9898SEd Tanous "type": "string", 52720c9898SEd Tanous "description": "The term specifies that a client requests that the service fulfills a request with resources available within a specific zone resource. The term value is the Id property of the zone resource.", 53720c9898SEd Tanous "longDescription": "The term shall specify that a client requests that the service fulfills a request with resources available in a specific zone resource. The term value shall contain the Id property of the zone resource. This term shall only be at the root level of the request payload." 54720c9898SEd Tanous }, 55720c9898SEd Tanous "@Redfish.ResourceBlockLimits": { 56720c9898SEd Tanous "description": "The term specifies the allowable quantities of types of resource blocks for a composition request.", 57720c9898SEd Tanous "$ref": "http://redfish.dmtf.org/schemas/v1/ResourceBlock.json#/definitions/ResourceBlockLimits" 58720c9898SEd Tanous }, 59720c9898SEd Tanous "@Redfish.SupportedCertificates": { 60720c9898SEd Tanous "description": "The term specifies the supported certificate formats for a given certificate collection.", 61720c9898SEd Tanous "type": "array", 62720c9898SEd Tanous "items": { 63720c9898SEd Tanous "$ref": "http://redfish.dmtf.org/schemas/v1/Certificate.json#/definitions/CertificateType" 64720c9898SEd Tanous }, 65720c9898SEd Tanous "readonly": true 66720c9898SEd Tanous }, 67720c9898SEd Tanous "@Redfish.WriteableProperties": { 68720c9898SEd Tanous "description": "The term specifies the properties supported as read-write. The values contained are the names of the writable properties as defined in the Redfish schema that are available as read-write given the implementation, current configuration, and state of the resource. This term might appear at the root level of a resource, or within an object. For arrays of objects, the term might only appear in the first element of the array to indicate identical capabilities for every element in the array.", 69720c9898SEd Tanous "type": "array", 70720c9898SEd Tanous "items": { 71720c9898SEd Tanous "type": "string" 72720c9898SEd Tanous }, 73720c9898SEd Tanous "readonly": true 74720c9898SEd Tanous }, 75720c9898SEd Tanous "@odata.context": { 76720c9898SEd Tanous "type": "string", 77720c9898SEd Tanous "format": "uri-reference", 78720c9898SEd Tanous "readonly": true, 79720c9898SEd Tanous "description": "The OData description of a payload.", 80720c9898SEd Tanous "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." 81720c9898SEd Tanous }, 82720c9898SEd Tanous "@odata.id": { 83720c9898SEd Tanous "type": "string", 84720c9898SEd Tanous "format": "uri-reference", 85720c9898SEd Tanous "readonly": true, 86720c9898SEd Tanous "description": "The unique identifier for a resource.", 87720c9898SEd Tanous "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." 88720c9898SEd Tanous }, 89720c9898SEd Tanous "@odata.type": { 90720c9898SEd Tanous "type": "string", 91720c9898SEd Tanous "readonly": true, 92720c9898SEd Tanous "description": "The type of a resource.", 93720c9898SEd Tanous "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." 94720c9898SEd Tanous }, 95720c9898SEd Tanous "@odata.etag": { 96720c9898SEd Tanous "type": "string", 97720c9898SEd Tanous "readonly": true, 98720c9898SEd Tanous "description": "The current ETag of the resource.", 99720c9898SEd Tanous "longDescription": "The value of this property shall be a string that is defined by the ETag HTTP header definition in RFC7232." 100720c9898SEd Tanous } 101720c9898SEd Tanous }, 102720c9898SEd Tanous "patternProperties": { 103720c9898SEd Tanous "^([a-zA-Z_][a-zA-Z0-9_]*)?@Redfish.AllowableValues$": { 104720c9898SEd Tanous "description": "The set of allowable values for an action parameter or read-write property.", 105720c9898SEd Tanous "type": "array", 106720c9898SEd Tanous "items": { 107720c9898SEd Tanous "type": "string" 108720c9898SEd Tanous }, 109720c9898SEd Tanous "readonly": true 110720c9898SEd Tanous }, 111720c9898SEd Tanous "^([a-zA-Z_][a-zA-Z0-9_]*)?@Redfish.RequiredOnCreate$": { 112720c9898SEd Tanous "description": "The term specifies that a property is required to be specified in the body of a POST request to create the resource.", 113720c9898SEd Tanous "type": "boolean", 114720c9898SEd Tanous "readonly": true 115720c9898SEd Tanous }, 116720c9898SEd Tanous "^([a-zA-Z_][a-zA-Z0-9_]*)?@Redfish.SetOnlyOnCreate$": { 117720c9898SEd Tanous "description": "The term specifies that a property can only be set when a client creates an instance of a resource through POST.", 118720c9898SEd Tanous "type": "boolean", 119720c9898SEd Tanous "readonly": true 120720c9898SEd Tanous }, 121720c9898SEd Tanous "^([a-zA-Z_][a-zA-Z0-9_]*)?@Redfish.OptionalOnCreate$": { 122720c9898SEd Tanous "description": "The term specifies that a property can be set when a client creates an instance of a resource through POST.", 123720c9898SEd Tanous "type": "boolean", 124720c9898SEd Tanous "readonly": true 125720c9898SEd Tanous }, 126720c9898SEd Tanous "^([a-zA-Z_][a-zA-Z0-9_]*)?@Redfish.UpdatableAfterCreate$": { 127720c9898SEd Tanous "description": "The term specifies that a property can be set by a client that uses PATCH after it creates an instance of a resource through POST.", 128720c9898SEd Tanous "type": "boolean", 129720c9898SEd Tanous "readonly": true 130720c9898SEd Tanous }, 131720c9898SEd Tanous "^([a-zA-Z_][a-zA-Z0-9_]*)?@Redfish.Deprecated$": { 132720c9898SEd Tanous "description": "The term shall be applied to a property or value to specify that the property or value is deprecated. The string value should explain the deprecation, including new property or properties or value to use. The property or value can be supported in new and existing implementations, but usage in new implementations is discouraged. Deprecated properties and values are likely to be removed in a future major version of the schema.", 133720c9898SEd Tanous "type": "string", 134720c9898SEd Tanous "readonly": true 135720c9898SEd Tanous }, 136720c9898SEd Tanous "^([a-zA-Z_][a-zA-Z0-9_]*)?@Redfish.AllowableNumbers$": { 137*28cfceb2SGunnar Mills "description": "The term specifies the numeric values or duration values, inclusive ranges of values, and incremental step values for an action parameter or a read-write property that are supported by the service, as defined in the 'Allowable values for numbers and durations' clause of the Redfish Specification.", 138720c9898SEd Tanous "type": "array", 139720c9898SEd Tanous "items": { 140720c9898SEd Tanous "type": "string" 141720c9898SEd Tanous }, 142720c9898SEd Tanous "readonly": true 143720c9898SEd Tanous }, 144720c9898SEd Tanous "^([a-zA-Z_][a-zA-Z0-9_]*)?@Redfish.AllowablePattern$": { 145*28cfceb2SGunnar Mills "description": "The term specifies a regular expression that describes the allowable values for an action parameter or a read-write property as supported by the service.", 146720c9898SEd Tanous "type": "string", 147720c9898SEd Tanous "readonly": true 148720c9898SEd Tanous }, 149720c9898SEd Tanous "^([a-zA-Z_][a-zA-Z0-9_]*)?@Message.ExtendedInfo$": { 150720c9898SEd Tanous "description": "The ExtendedInfo annotation can be applied to any object or property to provide additional information about the item.", 151720c9898SEd Tanous "type": "array", 152720c9898SEd Tanous "items": { 153720c9898SEd Tanous "$ref": "http://redfish.dmtf.org/schemas/v1/Message.json#/definitions/Message" 154720c9898SEd Tanous } 155720c9898SEd Tanous }, 156720c9898SEd Tanous "^([a-zA-Z_][a-zA-Z0-9_]*)?@odata.count$": { 157720c9898SEd Tanous "type": "integer", 158720c9898SEd Tanous "readonly": true, 159720c9898SEd Tanous "description": "The number of items in a collection.", 160720c9898SEd Tanous "longDescription": "The value of this property shall be an integer representing the number of items in a collection." 161720c9898SEd Tanous }, 162720c9898SEd Tanous "^([a-zA-Z_][a-zA-Z0-9_]*)?@odata.nextLink$": { 163720c9898SEd Tanous "type": "string", 164720c9898SEd Tanous "format": "uri-reference", 165720c9898SEd Tanous "readonly": true, 166720c9898SEd Tanous "description": "The URI to the resource containing the next set of partial members.", 167720c9898SEd Tanous "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." 168720c9898SEd Tanous } 169720c9898SEd Tanous } 170720c9898SEd Tanous} 171