blob: 85a7276a74456edf1f12728ca949c9520d5e8403 [file] [log] [blame]
Ed Tanous118b1c72018-09-13 13:45:51 -07001{
Ed Tanous118b1c72018-09-13 13:45:51 -07002 "$ref": "#/definitions/Session",
Ed Tanous530520e2019-01-02 13:41:37 -08003 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
4 "copyright": "Copyright 2014-2018 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
Ed Tanous118b1c72018-09-13 13:45:51 -07005 "definitions": {
Ed Tanous530520e2019-01-02 13:41:37 -08006 "Actions": {
7 "additionalProperties": false,
8 "description": "The available actions for this resource.",
9 "longDescription": "This type shall contain the available actions for this resource.",
Ed Tanous118b1c72018-09-13 13:45:51 -070010 "patternProperties": {
Ed Tanous530520e2019-01-02 13:41:37 -080011 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
12 "description": "This property shall specify a valid odata or Redfish property.",
Ed Tanous118b1c72018-09-13 13:45:51 -070013 "type": [
14 "array",
15 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -080016 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -070017 "number",
18 "null",
19 "object",
20 "string"
Ed Tanous530520e2019-01-02 13:41:37 -080021 ]
Ed Tanous118b1c72018-09-13 13:45:51 -070022 }
23 },
Ed Tanous530520e2019-01-02 13:41:37 -080024 "properties": {
25 "Oem": {
26 "$ref": "#/definitions/OemActions",
27 "description": "This property contains the available OEM specific actions for this resource.",
28 "longDescription": "This property shall contain any additional OEM actions for this resource."
29 }
30 },
31 "type": "object"
32 },
33 "OemActions": {
34 "additionalProperties": true,
35 "description": "The available OEM specific actions for this resource.",
36 "longDescription": "This type shall contain any additional OEM actions for this resource.",
37 "patternProperties": {
38 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
39 "description": "This property shall specify a valid odata or Redfish property.",
40 "type": [
41 "array",
42 "boolean",
43 "integer",
44 "number",
45 "null",
46 "object",
47 "string"
48 ]
49 }
50 },
51 "properties": {},
52 "type": "object"
53 },
54 "Session": {
Ed Tanous118b1c72018-09-13 13:45:51 -070055 "additionalProperties": false,
Ed Tanous530520e2019-01-02 13:41:37 -080056 "description": "The Session resource describes a single connection (session) between a client and a Redfish service instance.",
57 "longDescription": "This resource shall be used to represent a session for a Redfish implementation.",
58 "patternProperties": {
59 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
60 "description": "This property shall specify a valid odata or Redfish property.",
61 "type": [
62 "array",
63 "boolean",
64 "integer",
65 "number",
66 "null",
67 "object",
68 "string"
69 ]
70 }
71 },
Ed Tanous118b1c72018-09-13 13:45:51 -070072 "properties": {
73 "@odata.context": {
Ed Tanous530520e2019-01-02 13:41:37 -080074 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context"
75 },
76 "@odata.etag": {
77 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag"
Ed Tanous118b1c72018-09-13 13:45:51 -070078 },
79 "@odata.id": {
Ed Tanous530520e2019-01-02 13:41:37 -080080 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id"
Ed Tanous118b1c72018-09-13 13:45:51 -070081 },
82 "@odata.type": {
Ed Tanous530520e2019-01-02 13:41:37 -080083 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/type"
Ed Tanous118b1c72018-09-13 13:45:51 -070084 },
Ed Tanous530520e2019-01-02 13:41:37 -080085 "Actions": {
86 "$ref": "#/definitions/Actions",
87 "description": "The available actions for this resource.",
88 "longDescription": "The Actions property shall contain the available actions for this resource."
Ed Tanous118b1c72018-09-13 13:45:51 -070089 },
90 "Description": {
91 "anyOf": [
Ed Tanous530520e2019-01-02 13:41:37 -080092 {
93 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
94 },
95 {
96 "type": "null"
97 }
Ed Tanous118b1c72018-09-13 13:45:51 -070098 ],
99 "readonly": true
100 },
Ed Tanous530520e2019-01-02 13:41:37 -0800101 "Id": {
102 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
103 "readonly": true
104 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700105 "Name": {
106 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
107 "readonly": true
108 },
Ed Tanous530520e2019-01-02 13:41:37 -0800109 "Oem": {
110 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
111 "description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.",
112 "longDescription": "The value of this string shall be of the format for the reserved word *Oem*."
Ed Tanous118b1c72018-09-13 13:45:51 -0700113 },
114 "Password": {
Ed Tanous530520e2019-01-02 13:41:37 -0800115 "description": "This property is used in a POST to specify a password when creating a new session. This property is null on a GET.",
116 "longDescription": "The value of this property shall be the password for this session. The value shall be null for GET requests.",
117 "readonly": true,
Ed Tanous118b1c72018-09-13 13:45:51 -0700118 "type": [
119 "string",
120 "null"
Ed Tanous530520e2019-01-02 13:41:37 -0800121 ]
Ed Tanous118b1c72018-09-13 13:45:51 -0700122 },
Ed Tanous530520e2019-01-02 13:41:37 -0800123 "UserName": {
124 "description": "The UserName for the account for this session.",
125 "longDescription": "The value of this property shall be the UserName that matches a registered account identified by a ManagerAccount resource registered with the Account Service.",
126 "readonly": true,
127 "type": [
128 "string",
129 "null"
130 ]
Ed Tanous118b1c72018-09-13 13:45:51 -0700131 }
132 },
133 "required": [
Ed Tanous530520e2019-01-02 13:41:37 -0800134 "@odata.id",
135 "@odata.type",
Ed Tanous118b1c72018-09-13 13:45:51 -0700136 "Id",
137 "Name"
138 ],
139 "requiredOnCreate": [
140 "UserName",
141 "Password"
142 ],
Ed Tanous530520e2019-01-02 13:41:37 -0800143 "type": "object"
Ed Tanous118b1c72018-09-13 13:45:51 -0700144 }
145 },
Ed Tanous530520e2019-01-02 13:41:37 -0800146 "owningEntity": "DMTF",
147 "title": "#Session.v1_1_1.Session"
148}