Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 1 | { |
Ed Tanous | a8d8f9d | 2023-01-26 13:57:00 -0800 | [diff] [blame] | 2 | "$id": "http://redfish.dmtf.org/schemas/v1/Resource.v1_15_0.json", |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 3 | "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", |
Ed Tanous | ed76121 | 2022-09-23 15:03:29 -0700 | [diff] [blame] | 4 | "copyright": "Copyright 2014-2022 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 5 | "definitions": { |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 6 | "ContactInfo": { |
| 7 | "additionalProperties": false, |
Gunnar Mills | a778c02 | 2020-05-12 12:20:36 -0500 | [diff] [blame] | 8 | "description": "Contact information for this resource.", |
| 9 | "longDescription": "This object shall contain contact information for an individual or organization responsible for this resource.", |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 10 | "patternProperties": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 11 | "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 12 | "description": "This property shall specify a valid odata or Redfish property.", |
| 13 | "type": [ |
| 14 | "array", |
| 15 | "boolean", |
| 16 | "integer", |
| 17 | "number", |
| 18 | "null", |
| 19 | "object", |
| 20 | "string" |
| 21 | ] |
| 22 | } |
| 23 | }, |
| 24 | "properties": { |
| 25 | "ContactName": { |
| 26 | "description": "Name of this contact.", |
Gunnar Mills | a778c02 | 2020-05-12 12:20:36 -0500 | [diff] [blame] | 27 | "longDescription": "This property shall contain the name of a person or organization to contact for information about this resource.", |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 28 | "readonly": false, |
| 29 | "type": [ |
| 30 | "string", |
| 31 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 32 | ], |
| 33 | "versionAdded": "v1_7_0" |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 34 | }, |
| 35 | "EmailAddress": { |
| 36 | "description": "Email address for this contact.", |
Gunnar Mills | a778c02 | 2020-05-12 12:20:36 -0500 | [diff] [blame] | 37 | "longDescription": "This property shall contain the email address for a person or organization to contact for information about this resource.", |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 38 | "readonly": false, |
| 39 | "type": [ |
| 40 | "string", |
| 41 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 42 | ], |
| 43 | "versionAdded": "v1_7_0" |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 44 | }, |
| 45 | "PhoneNumber": { |
| 46 | "description": "Phone number for this contact.", |
Gunnar Mills | a778c02 | 2020-05-12 12:20:36 -0500 | [diff] [blame] | 47 | "longDescription": "This property shall contain the phone number for a person or organization to contact for information about this resource.", |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 48 | "readonly": false, |
| 49 | "type": [ |
| 50 | "string", |
| 51 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 52 | ], |
| 53 | "versionAdded": "v1_7_0" |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 54 | } |
| 55 | }, |
| 56 | "type": "object" |
| 57 | }, |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 58 | "DurableNameFormat": { |
| 59 | "enum": [ |
| 60 | "NAA", |
| 61 | "iQN", |
| 62 | "FC_WWN", |
| 63 | "UUID", |
| 64 | "EUI", |
| 65 | "NQN", |
Asmitha Karunanithi | c8ccb77 | 2020-09-22 10:56:46 -0500 | [diff] [blame] | 66 | "NSID", |
Sui Chen | 141d943 | 2022-02-03 22:01:27 -0800 | [diff] [blame] | 67 | "NGUID", |
Ed Tanous | a8d8f9d | 2023-01-26 13:57:00 -0800 | [diff] [blame] | 68 | "MACAddress", |
| 69 | "GCXLID" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 70 | ], |
Gunnar Mills | 10f270b | 2021-05-19 15:34:06 -0500 | [diff] [blame] | 71 | "enumDeprecated": { |
| 72 | "NSID": "This value has been deprecated due to its non-uniqueness and `NGUID` should be used." |
| 73 | }, |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 74 | "enumDescriptions": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 75 | "EUI": "The IEEE-defined 64-bit Extended Unique Identifier (EUI).", |
| 76 | "FC_WWN": "The Fibre Channel (FC) World Wide Name (WWN).", |
Ed Tanous | a8d8f9d | 2023-01-26 13:57:00 -0800 | [diff] [blame] | 77 | "GCXLID": "The globally unique CXL logical device identifier (GCXLID).", |
Sui Chen | 141d943 | 2022-02-03 22:01:27 -0800 | [diff] [blame] | 78 | "MACAddress": "The media access control address (MAC address).", |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 79 | "NAA": "The Name Address Authority (NAA) format.", |
Asmitha Karunanithi | c8ccb77 | 2020-09-22 10:56:46 -0500 | [diff] [blame] | 80 | "NGUID": "The Namespace Globally Unique Identifier (NGUID).", |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 81 | "NQN": "The NVMe Qualified Name (NQN).", |
| 82 | "NSID": "The NVM Namespace Identifier (NSID).", |
| 83 | "UUID": "The Universally Unique Identifier (UUID).", |
| 84 | "iQN": "The iSCSI Qualified Name (iQN)." |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 85 | }, |
| 86 | "enumLongDescriptions": { |
Ed Tanous | ed76121 | 2022-09-23 15:03:29 -0700 | [diff] [blame] | 87 | "EUI": "This durable name shall contain the hexadecimal representation of the IEEE-defined 64-bit Extended Unique Identifier (EUI), as defined in the IEEE's Guidelines for 64-bit Global Identifier (EUI-64) Specification. The DurableName property shall follow the regular expression pattern '^([0-9A-Fa-f]{2}[:-]){7}([0-9A-Fa-f]{2})$', where the most significant octet is first.", |
| 88 | "FC_WWN": "This durable name shall contain a hexadecimal representation of the World-Wide Name (WWN) format, as defined in the T11 Fibre Channel Physical and Signaling Interface Specification. The DurableName property shall follow the regular expression pattern '^([0-9A-Fa-f]{2}[:-]){7}([0-9A-Fa-f]{2})$', where the most significant octet is first.", |
Ed Tanous | a8d8f9d | 2023-01-26 13:57:00 -0800 | [diff] [blame] | 89 | "GCXLID": "This durable name shall be in the globally unique CXL logical device identifier (GCXLID). The DurableName property shall follow the regular expression pattern '^([0-9A-Fa-f]{2}-){7}[0-9A-Fa-f]{2}:([0-9A-Fa-f]{4})$', where the first eight hyphen-delimited octets contain the PCIe serial number, where the most significant octet is first, and the remaining 16-bit field contains the CXL Logical Device Identifier, where the most significant byte first.", |
Ed Tanous | ed76121 | 2022-09-23 15:03:29 -0700 | [diff] [blame] | 90 | "MACAddress": "This durable name shall be a media access control address (MAC address), which is a unique identifier assigned to a network interface controller (NIC) for use as a network address. This value should not be used if a more specific type of identifier is available. The DurableName property shall follow the regular expression pattern '^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$', where the most significant octet is first.", |
| 91 | "NAA": "This durable name shall contain a hexadecimal representation of the Name Address Authority structure, as defined in the T11 Fibre Channel - Framing and Signaling - 3 (FC-FS-3) specification. The DurableName property shall follow the regular expression pattern '^(([0-9A-Fa-f]{2}){8}){1,2}$', where the most significant octet is first.", |
| 92 | "NGUID": "This durable name shall be in the Namespace Globally Unique Identifier (NGUID), as defined in the NVN Express Specification. The DurableName property shall follow the regular expression pattern '^([0-9A-Fa-f]{2}){16}$', where the most significant octet is first.", |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 93 | "NQN": "This durable name shall be in the NVMe Qualified Name (NQN) format, as defined in the NVN Express over Fabric Specification.", |
| 94 | "NSID": "This durable name shall be in the NVM Namespace Identifier (NSID) format, as defined in the NVN Express Specification.", |
Ed Tanous | ed76121 | 2022-09-23 15:03:29 -0700 | [diff] [blame] | 95 | "UUID": "This durable name shall contain the hexadecimal representation of the UUID, as defined by RFC4122. The DurableName property shall follow the regular expression pattern '([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})'.", |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 96 | "iQN": "This durable name shall be in the iSCSI Qualified Name (iQN) format, as defined in RFC3720 and RFC3721." |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 97 | }, |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 98 | "enumVersionAdded": { |
Ed Tanous | a8d8f9d | 2023-01-26 13:57:00 -0800 | [diff] [blame] | 99 | "GCXLID": "v1_15_0", |
Sui Chen | 141d943 | 2022-02-03 22:01:27 -0800 | [diff] [blame] | 100 | "MACAddress": "v1_14_0", |
Asmitha Karunanithi | c8ccb77 | 2020-09-22 10:56:46 -0500 | [diff] [blame] | 101 | "NGUID": "v1_10_0", |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 102 | "NQN": "v1_6_0", |
| 103 | "NSID": "v1_6_0" |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 104 | }, |
Gunnar Mills | 10f270b | 2021-05-19 15:34:06 -0500 | [diff] [blame] | 105 | "enumVersionDeprecated": { |
| 106 | "NSID": "v1_12_0" |
| 107 | }, |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 108 | "type": "string" |
| 109 | }, |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 110 | "Identifier": { |
| 111 | "additionalProperties": false, |
Gunnar Mills | a778c02 | 2020-05-12 12:20:36 -0500 | [diff] [blame] | 112 | "description": "Any additional identifiers for a resource.", |
| 113 | "longDescription": "This type shall contain any additional identifiers for a resource.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 114 | "patternProperties": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 115 | "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 116 | "description": "This property shall specify a valid odata or Redfish property.", |
| 117 | "type": [ |
| 118 | "array", |
| 119 | "boolean", |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 120 | "integer", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 121 | "number", |
| 122 | "null", |
| 123 | "object", |
| 124 | "string" |
| 125 | ] |
| 126 | } |
| 127 | }, |
| 128 | "properties": { |
| 129 | "DurableName": { |
Gunnar Mills | a778c02 | 2020-05-12 12:20:36 -0500 | [diff] [blame] | 130 | "description": "The world-wide, persistent name of the resource.", |
| 131 | "longDescription": "This property shall contain the world-wide unique identifier for the resource. The string shall be in the Identifier.DurableNameFormat property value format.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 132 | "readonly": true, |
| 133 | "type": [ |
| 134 | "string", |
| 135 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 136 | ], |
| 137 | "versionAdded": "v1_1_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 138 | }, |
| 139 | "DurableNameFormat": { |
| 140 | "anyOf": [ |
| 141 | { |
| 142 | "$ref": "#/definitions/DurableNameFormat" |
| 143 | }, |
| 144 | { |
| 145 | "type": "null" |
| 146 | } |
| 147 | ], |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 148 | "description": "The format of the durable name property.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 149 | "longDescription": "This property shall represent the format of the DurableName property.", |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 150 | "readonly": true, |
| 151 | "versionAdded": "v1_1_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 152 | } |
| 153 | }, |
| 154 | "type": "object" |
| 155 | }, |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 156 | "Location": { |
| 157 | "additionalProperties": false, |
Gunnar Mills | a778c02 | 2020-05-12 12:20:36 -0500 | [diff] [blame] | 158 | "description": "The location of a resource.", |
| 159 | "longDescription": "This type shall describe the location of a resource.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 160 | "patternProperties": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 161 | "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 162 | "description": "This property shall specify a valid odata or Redfish property.", |
| 163 | "type": [ |
| 164 | "array", |
| 165 | "boolean", |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 166 | "integer", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 167 | "number", |
| 168 | "null", |
| 169 | "object", |
| 170 | "string" |
| 171 | ] |
| 172 | } |
| 173 | }, |
| 174 | "properties": { |
| 175 | "AltitudeMeters": { |
Gunnar Mills | a778c02 | 2020-05-12 12:20:36 -0500 | [diff] [blame] | 176 | "description": "The altitude of the resource in meters.", |
Sui Chen | 141d943 | 2022-02-03 22:01:27 -0800 | [diff] [blame] | 177 | "longDescription": "This property shall contain the altitude of the resource, in meters units, defined as the elevation above sea level.", |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 178 | "readonly": false, |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 179 | "type": [ |
| 180 | "number", |
| 181 | "null" |
| 182 | ], |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 183 | "units": "m", |
| 184 | "versionAdded": "v1_6_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 185 | }, |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 186 | "Contacts": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 187 | "description": "An array of contact information.", |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 188 | "items": { |
| 189 | "anyOf": [ |
| 190 | { |
| 191 | "$ref": "#/definitions/ContactInfo" |
| 192 | }, |
| 193 | { |
| 194 | "type": "null" |
| 195 | } |
| 196 | ] |
| 197 | }, |
Gunnar Mills | a778c02 | 2020-05-12 12:20:36 -0500 | [diff] [blame] | 198 | "longDescription": "This property shall contain an array of contact information for an individual or organization responsible for this resource.", |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 199 | "type": "array", |
| 200 | "versionAdded": "v1_7_0" |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 201 | }, |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 202 | "Info": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 203 | "deprecated": "This property has been deprecated in favor of the PostalAddress, Placement, and PartLocation properties.", |
Gunnar Mills | a778c02 | 2020-05-12 12:20:36 -0500 | [diff] [blame] | 204 | "description": "The location of the resource.", |
| 205 | "longDescription": "This property shall represent the location of the resource.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 206 | "readonly": true, |
| 207 | "type": [ |
| 208 | "string", |
| 209 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 210 | ], |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 211 | "versionAdded": "v1_1_0", |
| 212 | "versionDeprecated": "v1_5_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 213 | }, |
| 214 | "InfoFormat": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 215 | "deprecated": "This property has been deprecated in favor of the PostalAddress, Placement, and PartLocation properties.", |
| 216 | "description": "The format of the Info property.", |
| 217 | "longDescription": "This property shall represent the Info property format.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 218 | "readonly": true, |
| 219 | "type": [ |
| 220 | "string", |
| 221 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 222 | ], |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 223 | "versionAdded": "v1_1_0", |
| 224 | "versionDeprecated": "v1_5_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 225 | }, |
| 226 | "Latitude": { |
Gunnar Mills | a778c02 | 2020-05-12 12:20:36 -0500 | [diff] [blame] | 227 | "description": "The latitude of the resource.", |
| 228 | "longDescription": "This property shall contain the latitude of the resource specified in degrees using a decimal format and not minutes or seconds.", |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 229 | "readonly": false, |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 230 | "type": [ |
| 231 | "number", |
| 232 | "null" |
| 233 | ], |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 234 | "units": "deg", |
| 235 | "versionAdded": "v1_6_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 236 | }, |
| 237 | "Longitude": { |
Gunnar Mills | a778c02 | 2020-05-12 12:20:36 -0500 | [diff] [blame] | 238 | "description": "The longitude of the resource in degrees.", |
| 239 | "longDescription": "This property shall contain the longitude of the resource specified in degrees using a decimal format and not minutes or seconds.", |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 240 | "readonly": false, |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 241 | "type": [ |
| 242 | "number", |
| 243 | "null" |
| 244 | ], |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 245 | "units": "deg", |
| 246 | "versionAdded": "v1_6_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 247 | }, |
| 248 | "Oem": { |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 249 | "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 250 | "description": "The OEM extension property.", |
| 251 | "longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements.", |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 252 | "versionAdded": "v1_1_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 253 | }, |
| 254 | "PartLocation": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 255 | "$ref": "#/definitions/PartLocation", |
Gunnar Mills | 10f270b | 2021-05-19 15:34:06 -0500 | [diff] [blame] | 256 | "description": "The part location for a resource within an enclosure.", |
| 257 | "longDescription": "This property shall contain the part location for a resource within an enclosure. This representation shall indicate the location of a part within a location specified by the Placement property.", |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 258 | "versionAdded": "v1_5_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 259 | }, |
| 260 | "Placement": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 261 | "$ref": "#/definitions/Placement", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 262 | "description": "A place within the addressed location.", |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 263 | "longDescription": "This property shall contain a place within the addressed location.", |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 264 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 265 | }, |
| 266 | "PostalAddress": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 267 | "$ref": "#/definitions/PostalAddress", |
Gunnar Mills | a778c02 | 2020-05-12 12:20:36 -0500 | [diff] [blame] | 268 | "description": "The postal address of the addressed resource.", |
| 269 | "longDescription": "This property shall contain a postal address of the resource.", |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 270 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 271 | } |
| 272 | }, |
| 273 | "type": "object" |
| 274 | }, |
| 275 | "LocationType": { |
Gunnar Mills | 10f270b | 2021-05-19 15:34:06 -0500 | [diff] [blame] | 276 | "description": "The types of locations for a part within an enclosure.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 277 | "enum": [ |
| 278 | "Slot", |
| 279 | "Bay", |
| 280 | "Connector", |
Gunnar Mills | 10f270b | 2021-05-19 15:34:06 -0500 | [diff] [blame] | 281 | "Socket", |
Gunnar Mills | 9d42466 | 2021-09-22 21:56:16 -0500 | [diff] [blame] | 282 | "Backplane", |
| 283 | "Embedded" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 284 | ], |
| 285 | "enumDescriptions": { |
Gunnar Mills | 10f270b | 2021-05-19 15:34:06 -0500 | [diff] [blame] | 286 | "Backplane": "A backplane.", |
| 287 | "Bay": "A bay.", |
| 288 | "Connector": "A connector or port.", |
Gunnar Mills | 9d42466 | 2021-09-22 21:56:16 -0500 | [diff] [blame] | 289 | "Embedded": "Embedded within a part.", |
Gunnar Mills | 10f270b | 2021-05-19 15:34:06 -0500 | [diff] [blame] | 290 | "Slot": "A slot.", |
| 291 | "Socket": "A socket." |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 292 | }, |
| 293 | "enumLongDescriptions": { |
Gunnar Mills | 10f270b | 2021-05-19 15:34:06 -0500 | [diff] [blame] | 294 | "Backplane": "This value shall indicate the part is a backplane in an enclosure.", |
| 295 | "Bay": "This value shall indicate the part is located in a bay.", |
| 296 | "Connector": "This value shall indicate the part is located in a connector or port.", |
Gunnar Mills | 9d42466 | 2021-09-22 21:56:16 -0500 | [diff] [blame] | 297 | "Embedded": "This value shall indicate the part is embedded or otherwise permanently incorporated into a larger part or device. This value shall not be used for parts that can be removed by a user or are considered field-replaceable.", |
Gunnar Mills | 10f270b | 2021-05-19 15:34:06 -0500 | [diff] [blame] | 298 | "Slot": "This value shall indicate the part is located in a slot.", |
| 299 | "Socket": "This value shall indicate the part is located in a socket." |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 300 | }, |
Gunnar Mills | 10f270b | 2021-05-19 15:34:06 -0500 | [diff] [blame] | 301 | "enumVersionAdded": { |
Gunnar Mills | 9d42466 | 2021-09-22 21:56:16 -0500 | [diff] [blame] | 302 | "Backplane": "v1_12_0", |
| 303 | "Embedded": "v1_13_0" |
Gunnar Mills | 10f270b | 2021-05-19 15:34:06 -0500 | [diff] [blame] | 304 | }, |
| 305 | "longDescription": "This enumeration shall list the types of locations for a part within an enclosure.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 306 | "type": "string" |
| 307 | }, |
| 308 | "Orientation": { |
Gunnar Mills | 10f270b | 2021-05-19 15:34:06 -0500 | [diff] [blame] | 309 | "description": "The orientations for the ordering of the part location ordinal value.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 310 | "enum": [ |
| 311 | "FrontToBack", |
| 312 | "BackToFront", |
| 313 | "TopToBottom", |
| 314 | "BottomToTop", |
| 315 | "LeftToRight", |
| 316 | "RightToLeft" |
| 317 | ], |
| 318 | "enumDescriptions": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 319 | "BackToFront": "The ordering for the LocationOrdinalValue is back to front.", |
| 320 | "BottomToTop": "The ordering for LocationOrdinalValue is bottom to top.", |
| 321 | "FrontToBack": "The ordering for LocationOrdinalValue is front to back.", |
| 322 | "LeftToRight": "The ordering for the LocationOrdinalValue is left to right.", |
| 323 | "RightToLeft": "The ordering for the LocationOrdinalValue is right to left.", |
| 324 | "TopToBottom": "The ordering for the LocationOrdinalValue is top to bottom." |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 325 | }, |
| 326 | "enumLongDescriptions": { |
Gunnar Mills | 10f270b | 2021-05-19 15:34:06 -0500 | [diff] [blame] | 327 | "BackToFront": "This value shall indicate the ordering for LocationOrdinalValue is back to front.", |
| 328 | "BottomToTop": "This value shall indicate the ordering for LocationOrdinalValue is bottom to top.", |
| 329 | "FrontToBack": "This value shall indicate the ordering for LocationOrdinalValue is front to back.", |
| 330 | "LeftToRight": "This value shall indicate the ordering for LocationOrdinalValue is left to right.", |
| 331 | "RightToLeft": "This value shall indicate the ordering for LocationOrdinalValue is right to left.", |
| 332 | "TopToBottom": "This value shall indicate the ordering for LocationOrdinalValue is top to bottom." |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 333 | }, |
Gunnar Mills | 10f270b | 2021-05-19 15:34:06 -0500 | [diff] [blame] | 334 | "longDescription": "This enumeration shall list the orientations for the ordering of the LocationOrdinalValue property.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 335 | "type": "string" |
| 336 | }, |
| 337 | "PartLocation": { |
| 338 | "additionalProperties": false, |
Gunnar Mills | 10f270b | 2021-05-19 15:34:06 -0500 | [diff] [blame] | 339 | "description": "The part location for a resource within an enclosure.", |
| 340 | "longDescription": "This type shall describe a location for a resource within an enclosure.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 341 | "patternProperties": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 342 | "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 343 | "description": "This property shall specify a valid odata or Redfish property.", |
| 344 | "type": [ |
| 345 | "array", |
| 346 | "boolean", |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 347 | "integer", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 348 | "number", |
| 349 | "null", |
| 350 | "object", |
| 351 | "string" |
| 352 | ] |
| 353 | } |
| 354 | }, |
| 355 | "properties": { |
| 356 | "LocationOrdinalValue": { |
Gunnar Mills | 10f270b | 2021-05-19 15:34:06 -0500 | [diff] [blame] | 357 | "description": "The number that represents the location of the part. For example, if LocationType is `Slot` and this unit is in slot 2, the LocationOrdinalValue is `2`.", |
| 358 | "longDescription": "This property shall contain the number that represents the location of the part based on the LocationType. LocationOrdinalValue shall be measured based on the Orientation value starting with `0`.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 359 | "readonly": true, |
| 360 | "type": [ |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 361 | "integer", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 362 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 363 | ], |
| 364 | "versionAdded": "v1_5_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 365 | }, |
| 366 | "LocationType": { |
| 367 | "anyOf": [ |
| 368 | { |
| 369 | "$ref": "#/definitions/LocationType" |
| 370 | }, |
| 371 | { |
| 372 | "type": "null" |
| 373 | } |
| 374 | ], |
Gunnar Mills | 9d42466 | 2021-09-22 21:56:16 -0500 | [diff] [blame] | 375 | "description": "The type of location of the part.", |
| 376 | "longDescription": "This property shall contain the type of location of the part.", |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 377 | "readonly": true, |
| 378 | "versionAdded": "v1_5_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 379 | }, |
| 380 | "Orientation": { |
| 381 | "anyOf": [ |
| 382 | { |
| 383 | "$ref": "#/definitions/Orientation" |
| 384 | }, |
| 385 | { |
| 386 | "type": "null" |
| 387 | } |
| 388 | ], |
| 389 | "description": "The orientation for the ordering of the slot enumeration used by the LocationOrdinalValue property.", |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 390 | "longDescription": "This property shall contain the orientation for the ordering used by the LocationOrdinalValue property.", |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 391 | "readonly": true, |
| 392 | "versionAdded": "v1_5_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 393 | }, |
| 394 | "Reference": { |
| 395 | "anyOf": [ |
| 396 | { |
| 397 | "$ref": "#/definitions/Reference" |
| 398 | }, |
| 399 | { |
| 400 | "type": "null" |
| 401 | } |
| 402 | ], |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 403 | "description": "The reference point for the part location. Provides guidance about the general location of the part.", |
| 404 | "longDescription": "This property shall contain the general location within the unit of the part.", |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 405 | "readonly": true, |
| 406 | "versionAdded": "v1_5_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 407 | }, |
| 408 | "ServiceLabel": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 409 | "description": "The label of the part location, such as a silk-screened name or a printed label.", |
| 410 | "longDescription": "This property shall contain the label assigned for service at the part location.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 411 | "readonly": true, |
| 412 | "type": [ |
| 413 | "string", |
| 414 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 415 | ], |
| 416 | "versionAdded": "v1_5_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 417 | } |
| 418 | }, |
| 419 | "type": "object" |
| 420 | }, |
| 421 | "Placement": { |
| 422 | "additionalProperties": false, |
| 423 | "description": "The placement within the addressed location.", |
Gunnar Mills | a778c02 | 2020-05-12 12:20:36 -0500 | [diff] [blame] | 424 | "longDescription": "The value shall describe a location within a resource. Examples include a shelf in a rack.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 425 | "patternProperties": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 426 | "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 427 | "description": "This property shall specify a valid odata or Redfish property.", |
| 428 | "type": [ |
| 429 | "array", |
| 430 | "boolean", |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 431 | "integer", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 432 | "number", |
| 433 | "null", |
| 434 | "object", |
| 435 | "string" |
| 436 | ] |
| 437 | } |
| 438 | }, |
| 439 | "properties": { |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 440 | "AdditionalInfo": { |
| 441 | "description": "Area designation or other additional info.", |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 442 | "longDescription": "This property shall contain additional information, such as Tile, Column (Post), Wall, or other designation that describes a location that cannot be conveyed with other properties defined for the Placement object.", |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 443 | "readonly": false, |
| 444 | "type": [ |
| 445 | "string", |
| 446 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 447 | ], |
| 448 | "versionAdded": "v1_7_0" |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 449 | }, |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 450 | "Rack": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 451 | "description": "The name of a rack location within a row.", |
| 452 | "longDescription": "This property shall contain the name of the rack within a row.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 453 | "readonly": false, |
| 454 | "type": [ |
| 455 | "string", |
| 456 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 457 | ], |
| 458 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 459 | }, |
| 460 | "RackOffset": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 461 | "description": "The vertical location of the item, in terms of RackOffsetUnits.", |
| 462 | "longDescription": "The vertical location of the item in the rack. Rack offset units shall be measured from bottom to top, starting with 0.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 463 | "readonly": false, |
| 464 | "type": [ |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 465 | "integer", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 466 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 467 | ], |
| 468 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 469 | }, |
| 470 | "RackOffsetUnits": { |
| 471 | "anyOf": [ |
| 472 | { |
| 473 | "$ref": "#/definitions/RackUnits" |
| 474 | }, |
| 475 | { |
| 476 | "type": "null" |
| 477 | } |
| 478 | ], |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 479 | "description": "The type of rack units in use.", |
| 480 | "longDescription": "This property shall contain a RackUnit enumeration literal that indicates the type of rack units in use.", |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 481 | "readonly": false, |
| 482 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 483 | }, |
| 484 | "Row": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 485 | "description": "The name of the row.", |
| 486 | "longDescription": "This property shall contain the name of the row.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 487 | "readonly": false, |
| 488 | "type": [ |
| 489 | "string", |
| 490 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 491 | ], |
| 492 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 493 | } |
| 494 | }, |
| 495 | "type": "object" |
| 496 | }, |
| 497 | "PostalAddress": { |
| 498 | "additionalProperties": false, |
Gunnar Mills | a778c02 | 2020-05-12 12:20:36 -0500 | [diff] [blame] | 499 | "description": "The postal address for a resource.", |
Gunnar Mills | 844b415 | 2020-06-22 12:44:09 -0500 | [diff] [blame] | 500 | "longDescription": "Instances shall describe a postal address for a resource. For more information, see RFC5139. Depending on use, the instance can represent a past, current, or future location.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 501 | "patternProperties": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 502 | "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 503 | "description": "This property shall specify a valid odata or Redfish property.", |
| 504 | "type": [ |
| 505 | "array", |
| 506 | "boolean", |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 507 | "integer", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 508 | "number", |
| 509 | "null", |
| 510 | "object", |
| 511 | "string" |
| 512 | ] |
| 513 | } |
| 514 | }, |
| 515 | "properties": { |
| 516 | "AdditionalCode": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 517 | "description": "The additional code.", |
| 518 | "longDescription": "The value shall conform to the RFC5139-defined requirements of the ADDCODE field.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 519 | "readonly": false, |
| 520 | "type": [ |
| 521 | "string", |
| 522 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 523 | ], |
| 524 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 525 | }, |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 526 | "AdditionalInfo": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 527 | "description": "The room designation or other additional information.", |
| 528 | "longDescription": "The value shall conform to the requirements of the LOC field as defined in RFC5139. Provides additional information.", |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 529 | "readonly": false, |
| 530 | "type": [ |
| 531 | "string", |
| 532 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 533 | ], |
| 534 | "versionAdded": "v1_7_0" |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 535 | }, |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 536 | "Building": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 537 | "description": "The name of the building.", |
| 538 | "longDescription": "The value shall conform to the RFC5139-defined requirements of the BLD field. Names the building.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 539 | "readonly": false, |
| 540 | "type": [ |
| 541 | "string", |
| 542 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 543 | ], |
| 544 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 545 | }, |
| 546 | "City": { |
| 547 | "description": "City, township, or shi (JP).", |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 548 | "longDescription": "The value shall conform to the RFC5139-defined requirements of the A3 field. Names a city, township, or shi (JP).", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 549 | "readonly": false, |
| 550 | "type": [ |
| 551 | "string", |
| 552 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 553 | ], |
| 554 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 555 | }, |
| 556 | "Community": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 557 | "description": "The postal community name.", |
| 558 | "longDescription": "The value shall conform to the RFC5139-defined requirements of the PCN field. A postal community name.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 559 | "readonly": false, |
| 560 | "type": [ |
| 561 | "string", |
| 562 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 563 | ], |
| 564 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 565 | }, |
| 566 | "Country": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 567 | "description": "The country.", |
| 568 | "longDescription": "The value shall conform to the RFC5139-defined requirements of the Country field.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 569 | "readonly": false, |
| 570 | "type": [ |
| 571 | "string", |
| 572 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 573 | ], |
| 574 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 575 | }, |
| 576 | "District": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 577 | "description": "A county, parish, gun (JP), or district (IN).", |
| 578 | "longDescription": "The value shall conform to the RFC5139-defined requirements of the A2 field. Names a county, parish, gun (JP), or district (IN).", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 579 | "readonly": false, |
| 580 | "type": [ |
| 581 | "string", |
| 582 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 583 | ], |
| 584 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 585 | }, |
| 586 | "Division": { |
Gunnar Mills | a778c02 | 2020-05-12 12:20:36 -0500 | [diff] [blame] | 587 | "description": "City division, borough, city district, ward, or chou (JP).", |
| 588 | "longDescription": "The value shall conform to the RFC5139-defined requirements of the A4 field. Names a city division, borough, city district, ward, or chou (JP).", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 589 | "readonly": false, |
| 590 | "type": [ |
| 591 | "string", |
| 592 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 593 | ], |
| 594 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 595 | }, |
| 596 | "Floor": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 597 | "description": "The floor.", |
| 598 | "longDescription": "The value shall conform to the RFC5139-defined requirements of the FLR field. Provides a floor designation.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 599 | "readonly": false, |
| 600 | "type": [ |
| 601 | "string", |
| 602 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 603 | ], |
| 604 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 605 | }, |
| 606 | "GPSCoords": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 607 | "deprecated": "This property has been deprecated in favor of the Longitude and Latitude properties.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 608 | "description": "The GPS coordinates of the part.", |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 609 | "longDescription": "The value shall conform to the RFC5139-defined requirements of the ADDCODE field. Shall contain the GPS coordinates of the location. If furnished, expressed in the '[-][nn]n.nnnnnn, [-][nn]n.nnnnn' format. For example, two comma-separated positive or negative numbers with six decimal places of precision.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 610 | "readonly": false, |
| 611 | "type": [ |
| 612 | "string", |
| 613 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 614 | ], |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 615 | "versionAdded": "v1_3_0", |
| 616 | "versionDeprecated": "v1_6_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 617 | }, |
| 618 | "HouseNumber": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 619 | "description": "The numeric portion of house number.", |
| 620 | "longDescription": "The value shall conform to the RFC5139-defined requirements of the HNO field. The numeric portion of the house number.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 621 | "readonly": false, |
| 622 | "type": [ |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 623 | "integer", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 624 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 625 | ], |
| 626 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 627 | }, |
| 628 | "HouseNumberSuffix": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 629 | "description": "The house number suffix.", |
| 630 | "longDescription": "The value shall conform to the RFC5139-defined requirements of the HNS field. Provides a suffix to a house number, (F, B, or 1/2).", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 631 | "readonly": false, |
| 632 | "type": [ |
| 633 | "string", |
| 634 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 635 | ], |
| 636 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 637 | }, |
| 638 | "Landmark": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 639 | "description": "The landmark.", |
| 640 | "longDescription": "The value shall conform to the RFC5139-defined requirements of the LMK field. Identifies a landmark or vanity address.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 641 | "readonly": false, |
| 642 | "type": [ |
| 643 | "string", |
| 644 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 645 | ], |
| 646 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 647 | }, |
| 648 | "LeadingStreetDirection": { |
| 649 | "description": "A leading street direction.", |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 650 | "longDescription": "The value shall conform to the requirements of the PRD field as defined in RFC5139. Names a leading street direction, (N, W, or SE).", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 651 | "readonly": false, |
| 652 | "type": [ |
| 653 | "string", |
| 654 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 655 | ], |
| 656 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 657 | }, |
| 658 | "Location": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 659 | "deprecated": "This property has been deprecated in favor of the AdditionalInfo property.", |
| 660 | "description": "The room designation or other additional information.", |
| 661 | "longDescription": "The value shall conform to the RFC5139-defined requirements of the LOC field. Provides additional information.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 662 | "readonly": false, |
| 663 | "type": [ |
| 664 | "string", |
| 665 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 666 | ], |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 667 | "versionAdded": "v1_3_0", |
| 668 | "versionDeprecated": "v1_7_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 669 | }, |
| 670 | "Name": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 671 | "description": "The name.", |
| 672 | "longDescription": "The value shall conform to the RFC5139-defined requirements of the NAM field. Names the occupant.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 673 | "readonly": false, |
| 674 | "type": [ |
| 675 | "string", |
| 676 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 677 | ], |
| 678 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 679 | }, |
| 680 | "Neighborhood": { |
| 681 | "description": "Neighborhood or block.", |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 682 | "longDescription": "The value shall conform to the RFC5139-defined requirements of the A5 field. Names a neighborhood or block.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 683 | "readonly": false, |
| 684 | "type": [ |
| 685 | "string", |
| 686 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 687 | ], |
| 688 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 689 | }, |
| 690 | "POBox": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 691 | "description": "The post office box (PO box).", |
| 692 | "longDescription": "The value shall conform to the RFC5139-defined requirements of the POBOX field. A post office box (PO box).", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 693 | "readonly": false, |
| 694 | "type": [ |
| 695 | "string", |
| 696 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 697 | ], |
| 698 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 699 | }, |
| 700 | "PlaceType": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 701 | "description": "The description of the type of place that is addressed.", |
| 702 | "longDescription": "The value shall conform to the RFC5139-defined requirements of the PLC field. Examples include office and residence.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 703 | "readonly": false, |
| 704 | "type": [ |
| 705 | "string", |
| 706 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 707 | ], |
| 708 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 709 | }, |
| 710 | "PostalCode": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 711 | "description": "The postal code or zip code.", |
| 712 | "longDescription": "The value shall conform to the RFC5139-defined requirements of the PC field. A postal code (or zip code).", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 713 | "readonly": false, |
| 714 | "type": [ |
| 715 | "string", |
| 716 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 717 | ], |
| 718 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 719 | }, |
| 720 | "Road": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 721 | "description": "The primary road or street.", |
| 722 | "longDescription": "The value shall conform to the RFC5139-defined requirements of the RD field. Designates a primary road or street.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 723 | "readonly": false, |
| 724 | "type": [ |
| 725 | "string", |
| 726 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 727 | ], |
| 728 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 729 | }, |
| 730 | "RoadBranch": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 731 | "description": "The road branch.", |
| 732 | "longDescription": "The value shall conform to the RFC5139-defined requirements of the RDBR field. Shall contain a post office box (PO box) road branch.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 733 | "readonly": false, |
| 734 | "type": [ |
| 735 | "string", |
| 736 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 737 | ], |
| 738 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 739 | }, |
| 740 | "RoadPostModifier": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 741 | "description": "The road post-modifier.", |
| 742 | "longDescription": "The value shall conform to the RFC5139-defined requirements of the POM field. For example, Extended.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 743 | "readonly": false, |
| 744 | "type": [ |
| 745 | "string", |
| 746 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 747 | ], |
| 748 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 749 | }, |
| 750 | "RoadPreModifier": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 751 | "description": "The road pre-modifier.", |
| 752 | "longDescription": "The value shall conform to the RFC5139-defined requirements of the PRM field. For example, Old or New.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 753 | "readonly": false, |
| 754 | "type": [ |
| 755 | "string", |
| 756 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 757 | ], |
| 758 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 759 | }, |
| 760 | "RoadSection": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 761 | "description": "The road section.", |
| 762 | "longDescription": "The value shall conform to the RFC5139-defined requirements of the RDSEC field. A road section.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 763 | "readonly": false, |
| 764 | "type": [ |
| 765 | "string", |
| 766 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 767 | ], |
| 768 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 769 | }, |
| 770 | "RoadSubBranch": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 771 | "description": "The road sub branch.", |
| 772 | "longDescription": "The value shall conform to the RFC5139-defined requirements of the RDSUBBR field.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 773 | "readonly": false, |
| 774 | "type": [ |
| 775 | "string", |
| 776 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 777 | ], |
| 778 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 779 | }, |
| 780 | "Room": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 781 | "description": "The name or number of the room.", |
Gunnar Mills | a778c02 | 2020-05-12 12:20:36 -0500 | [diff] [blame] | 782 | "longDescription": "The value shall conform to the RFC5139-defined requirements of the ROOM field. A name or number of a room to locate the resource within the unit.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 783 | "readonly": false, |
| 784 | "type": [ |
| 785 | "string", |
| 786 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 787 | ], |
| 788 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 789 | }, |
| 790 | "Seat": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 791 | "description": "The seat, such as the desk, cubicle, or workstation.", |
| 792 | "longDescription": "The value shall conform to the RFC5139-defined requirements of the SEAT field. A name or number of a seat, such as the desk, cubicle, or workstation.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 793 | "readonly": false, |
| 794 | "type": [ |
| 795 | "string", |
| 796 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 797 | ], |
| 798 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 799 | }, |
| 800 | "Street": { |
| 801 | "description": "Street name.", |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 802 | "longDescription": "The value shall conform to the RFC5139-defined requirements of the A6 field. Names a street.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 803 | "readonly": false, |
| 804 | "type": [ |
| 805 | "string", |
| 806 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 807 | ], |
| 808 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 809 | }, |
| 810 | "StreetSuffix": { |
| 811 | "description": "Avenue, Platz, Street, Circle.", |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 812 | "longDescription": "The value shall conform to the RFC5139-defined requirements of the STS field. Names a street suffix.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 813 | "readonly": false, |
| 814 | "type": [ |
| 815 | "string", |
| 816 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 817 | ], |
| 818 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 819 | }, |
| 820 | "Territory": { |
| 821 | "description": "A top-level subdivision within a country.", |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 822 | "longDescription": "The value shall conform to the RFC5139-defined requirements of the A1 field when it names a territory, state, region, province, or prefecture within a country.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 823 | "readonly": false, |
| 824 | "type": [ |
| 825 | "string", |
| 826 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 827 | ], |
| 828 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 829 | }, |
| 830 | "TrailingStreetSuffix": { |
| 831 | "description": "A trailing street suffix.", |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 832 | "longDescription": "The value shall conform to the RFC5139-defined requirements of the POD field. Names a trailing street suffix.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 833 | "readonly": false, |
| 834 | "type": [ |
| 835 | "string", |
| 836 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 837 | ], |
| 838 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 839 | }, |
| 840 | "Unit": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 841 | "description": "The name or number of the apartment unit or suite.", |
Gunnar Mills | a778c02 | 2020-05-12 12:20:36 -0500 | [diff] [blame] | 842 | "longDescription": "The value shall conform to the RFC5139-defined requirements of the UNIT field. The name or number of a unit, such as the apartment or suite, to locate the resource.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 843 | "readonly": false, |
| 844 | "type": [ |
| 845 | "string", |
| 846 | "null" |
Marri Devender Rao | d45d2d0 | 2019-01-21 10:11:34 -0600 | [diff] [blame] | 847 | ], |
| 848 | "versionAdded": "v1_3_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 849 | } |
| 850 | }, |
| 851 | "type": "object" |
| 852 | }, |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 853 | "RackUnits": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 854 | "description": "The type of rack unit in use.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 855 | "enum": [ |
| 856 | "OpenU", |
| 857 | "EIA_310" |
| 858 | ], |
| 859 | "enumDescriptions": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 860 | "EIA_310": "A rack unit that is equal to 1.75 in (44.45 mm).", |
| 861 | "OpenU": "A rack unit that is equal to 48 mm (1.89 in)." |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 862 | }, |
| 863 | "enumLongDescriptions": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 864 | "EIA_310": "Rack units shall conform to the EIA-310 standard.", |
Gunnar Mills | a778c02 | 2020-05-12 12:20:36 -0500 | [diff] [blame] | 865 | "OpenU": "Rack units shall be specified in terms of the Open Compute Open Rack Specification." |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 866 | }, |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 867 | "longDescription": "Enumeration literals shall name the type of rack unit in use.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 868 | "type": "string" |
| 869 | }, |
| 870 | "Reference": { |
Gunnar Mills | 10f270b | 2021-05-19 15:34:06 -0500 | [diff] [blame] | 871 | "description": "The reference areas for the location of the part within an enclosure.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 872 | "enum": [ |
| 873 | "Top", |
| 874 | "Bottom", |
| 875 | "Front", |
| 876 | "Rear", |
| 877 | "Left", |
| 878 | "Right", |
| 879 | "Middle" |
| 880 | ], |
| 881 | "enumDescriptions": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 882 | "Bottom": "The part is in the bottom of the unit.", |
| 883 | "Front": "The part is in the front of the unit.", |
| 884 | "Left": "The part is on the left side of of the unit.", |
| 885 | "Middle": "The part is in the middle of the unit.", |
| 886 | "Rear": "The part is in the rear of the unit.", |
| 887 | "Right": "The part is on the right side of the unit.", |
| 888 | "Top": "The part is in the top of the unit." |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 889 | }, |
| 890 | "enumLongDescriptions": { |
Gunnar Mills | 10f270b | 2021-05-19 15:34:06 -0500 | [diff] [blame] | 891 | "Bottom": "This value shall indicate the part is in the bottom of the unit.", |
| 892 | "Front": "This value shall indicate the part is in the front of the unit.", |
| 893 | "Left": "This value shall indicate the part is on the left side of of the unit.", |
| 894 | "Middle": "This value shall indicate the part is in the middle of the unit.", |
| 895 | "Rear": "This value shall indicate the part is in the rear of the unit.", |
| 896 | "Right": "This value shall indicate the part is on the right side of the unit.", |
| 897 | "Top": "This value shall indicate the part is in the top of the unit." |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 898 | }, |
Gunnar Mills | 10f270b | 2021-05-19 15:34:06 -0500 | [diff] [blame] | 899 | "longDescription": "This enumeration shall list the reference areas for the location of the part within an enclosure.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 900 | "type": "string" |
| 901 | }, |
| 902 | "ReferenceableMember": { |
| 903 | "additionalProperties": false, |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 904 | "description": "The base type for addressable members of an array.", |
Gunnar Mills | 844b415 | 2020-06-22 12:44:09 -0500 | [diff] [blame] | 905 | "longDescription": "References array members by using the value returned in the @odata.id property, which can be a dereferenceable URL. The @odata.id of this entity shall contain the location of this element within an item.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 906 | "patternProperties": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 907 | "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 908 | "description": "This property shall specify a valid odata or Redfish property.", |
| 909 | "type": [ |
| 910 | "array", |
| 911 | "boolean", |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 912 | "integer", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 913 | "number", |
| 914 | "null", |
| 915 | "object", |
| 916 | "string" |
| 917 | ] |
| 918 | } |
| 919 | }, |
| 920 | "properties": { |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 921 | "@odata.id": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 922 | "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 923 | }, |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 924 | "MemberId": { |
Gunnar Mills | 9d42466 | 2021-09-22 21:56:16 -0500 | [diff] [blame] | 925 | "description": "The unique identifier for the member within an array.", |
| 926 | "longDescription": "This property shall contain the unique identifier for this member within an array. For services supporting Redfish v1.6 or higher, this value shall contain the zero-based array index.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 927 | "readonly": true, |
| 928 | "type": "string" |
| 929 | }, |
| 930 | "Oem": { |
| 931 | "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 932 | "description": "The OEM extension property.", |
| 933 | "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements." |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 934 | } |
| 935 | }, |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 936 | "required": [ |
| 937 | "MemberId", |
| 938 | "@odata.id" |
| 939 | ], |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 940 | "type": "object" |
| 941 | }, |
| 942 | "Resource": { |
| 943 | "additionalProperties": false, |
Gunnar Mills | a778c02 | 2020-05-12 12:20:36 -0500 | [diff] [blame] | 944 | "description": "The base type for resources and members that can be linked to.", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 945 | "patternProperties": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 946 | "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 947 | "description": "This property shall specify a valid odata or Redfish property.", |
| 948 | "type": [ |
| 949 | "array", |
| 950 | "boolean", |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 951 | "integer", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 952 | "number", |
| 953 | "null", |
| 954 | "object", |
| 955 | "string" |
| 956 | ] |
| 957 | } |
| 958 | }, |
| 959 | "properties": { |
| 960 | "@odata.context": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 961 | "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 962 | }, |
| 963 | "@odata.etag": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 964 | "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 965 | }, |
| 966 | "@odata.id": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 967 | "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 968 | }, |
| 969 | "@odata.type": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 970 | "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 971 | }, |
| 972 | "Description": { |
| 973 | "anyOf": [ |
| 974 | { |
| 975 | "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description" |
| 976 | }, |
| 977 | { |
| 978 | "type": "null" |
| 979 | } |
| 980 | ], |
| 981 | "readonly": true |
| 982 | }, |
| 983 | "Id": { |
| 984 | "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", |
| 985 | "readonly": true |
| 986 | }, |
| 987 | "Name": { |
| 988 | "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", |
| 989 | "readonly": true |
| 990 | }, |
| 991 | "Oem": { |
| 992 | "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 993 | "description": "The OEM extension property.", |
| 994 | "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements." |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 995 | } |
| 996 | }, |
| 997 | "required": [ |
| 998 | "Id", |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 999 | "Name", |
| 1000 | "@odata.id", |
| 1001 | "@odata.type" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 1002 | ], |
| 1003 | "type": "object" |
| 1004 | }, |
| 1005 | "ResourceCollection": { |
| 1006 | "additionalProperties": false, |
| 1007 | "patternProperties": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 1008 | "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 1009 | "description": "This property shall specify a valid odata or Redfish property.", |
| 1010 | "type": [ |
| 1011 | "array", |
| 1012 | "boolean", |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 1013 | "integer", |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 1014 | "number", |
| 1015 | "null", |
| 1016 | "object", |
| 1017 | "string" |
| 1018 | ] |
| 1019 | } |
| 1020 | }, |
| 1021 | "properties": { |
| 1022 | "@odata.context": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 1023 | "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 1024 | }, |
| 1025 | "@odata.etag": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 1026 | "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 1027 | }, |
| 1028 | "@odata.id": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 1029 | "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 1030 | }, |
| 1031 | "@odata.type": { |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 1032 | "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 1033 | }, |
| 1034 | "Description": { |
| 1035 | "anyOf": [ |
| 1036 | { |
| 1037 | "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description" |
| 1038 | }, |
| 1039 | { |
| 1040 | "type": "null" |
| 1041 | } |
| 1042 | ], |
| 1043 | "readonly": true |
| 1044 | }, |
| 1045 | "Name": { |
| 1046 | "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", |
| 1047 | "readonly": true |
| 1048 | }, |
| 1049 | "Oem": { |
| 1050 | "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", |
Ed Tanous | cb10313 | 2019-10-08 11:34:22 -0700 | [diff] [blame] | 1051 | "description": "The OEM extension property.", |
| 1052 | "longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements." |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 1053 | } |
| 1054 | }, |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 1055 | "required": [ |
| 1056 | "Name", |
| 1057 | "@odata.id", |
| 1058 | "@odata.type" |
| 1059 | ], |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 1060 | "type": "object" |
| 1061 | } |
| 1062 | }, |
Ed Tanous | 530520e | 2019-01-02 13:41:37 -0800 | [diff] [blame] | 1063 | "owningEntity": "DMTF", |
Ed Tanous | a8d8f9d | 2023-01-26 13:57:00 -0800 | [diff] [blame] | 1064 | "release": "2022.3", |
| 1065 | "title": "#Resource.v1_15_0" |
Ed Tanous | 118b1c7 | 2018-09-13 13:45:51 -0700 | [diff] [blame] | 1066 | } |