xref: /openbmc/bmcweb/redfish-core/schema/dmtf/json-schema/OutletCollection.json (revision f2a8e57ede74a8252100b2281e3f4d170aa69391) 
1 {
2     "$id": "http://redfish.dmtf.org/schemas/v1/OutletCollection.json",
3     "$ref": "#/definitions/OutletCollection",
4     "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
5     "copyright": "Copyright 2014-2024 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
6     "definitions": {
7         "OutletCollection": {
8             "anyOf": [
9                 {
10                     "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef"
11                 },
12                 {
13                     "additionalProperties": false,
14                     "description": "The collection of `Outlet` resource instances.",
15                     "longDescription": "This resource shall represent a resource collection of `Outlet` instances for a Redfish implementation.",
16                     "patternProperties": {
17                         "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
18                             "description": "This property shall specify a valid odata or Redfish property.",
19                             "type": [
20                                 "array",
21                                 "boolean",
22                                 "integer",
23                                 "number",
24                                 "null",
25                                 "object",
26                                 "string"
27                             ]
28                         }
29                     },
30                     "properties": {
31                         "@odata.context": {
32                             "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
33                         },
34                         "@odata.etag": {
35                             "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
36                         },
37                         "@odata.id": {
38                             "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
39                         },
40                         "@odata.type": {
41                             "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
42                         },
43                         "Description": {
44                             "anyOf": [
45                                 {
46                                     "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
47                                 },
48                                 {
49                                     "type": "null"
50                                 }
51                             ],
52                             "readonly": true
53                         },
54                         "Members": {
55                             "description": "The members of this collection.",
56                             "items": {
57                                 "$ref": "http://redfish.dmtf.org/schemas/v1/Outlet.json#/definitions/Outlet"
58                             },
59                             "longDescription": "This property shall contain an array of links to the members of this collection.",
60                             "readonly": true,
61                             "type": "array"
62                         },
63                         "Members@odata.count": {
64                             "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
65                         },
66                         "Members@odata.nextLink": {
67                             "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/nextLink"
68                         },
69                         "Name": {
70                             "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
71                             "readonly": true
72                         },
73                         "Oem": {
74                             "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
75                             "description": "The OEM extension property.",
76                             "longDescription": "This property shall contain the OEM extensions.  All values for properties contained in this object shall conform to the Redfish Specification-described requirements."
77                         }
78                     },
79                     "required": [
80                         "Members",
81                         "Members@odata.count",
82                         "@odata.id",
83                         "@odata.type",
84                         "Name"
85                     ],
86                     "type": "object"
87                 }
88             ],
89             "deletable": false,
90             "insertable": false,
91             "updatable": false,
92             "uris": [
93                 "/redfish/v1/PowerEquipment/RackPDUs/{PowerDistributionId}/Outlets",
94                 "/redfish/v1/PowerEquipment/TransferSwitches/{PowerDistributionId}/Outlets",
95                 "/redfish/v1/PowerEquipment/PowerShelves/{PowerDistributionId}/Outlets",
96                 "/redfish/v1/PowerEquipment/ElectricalBuses/{PowerDistributionId}/Outlets"
97             ]
98         }
99     },
100     "language": "en",
101     "owningEntity": "DMTF",
102     "title": "#OutletCollection.OutletCollection"
103 }