Skip to content

Commit fde526d

Browse files
TakayukiHoshi1984TakayukiHoshi1984
authored
Merge pull request #4 from TakayukiHoshi1984/bugfix_missing_properties
API定義ファイルに不足していた情報を追加
2 parents 9d3b745 + f2333c9 commit fde526d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+1379
-248
lines changed

‎api/airConditioner.json

+22-8
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
"paths": {
1414
"/": {
1515
"get": {
16+
"operationId": "airConditionerGet",
1617
"x-type": "one-shot",
1718
"summary": "スマートデバイスの電源状態を取得する。",
1819
"description": "",
@@ -43,6 +44,7 @@
4344
}
4445
},
4546
"put": {
47+
"operationId": "airConditionerPut",
4648
"x-type": "one-shot",
4749
"summary": "スマートデバイスの電源を点ける。",
4850
"description": "",
@@ -72,6 +74,7 @@
7274
}
7375
},
7476
"delete": {
77+
"operationId": "airConditionerDelete",
7578
"x-type": "one-shot",
7679
"summary": "スマートデバイスの電源を消す。",
7780
"description": "",
@@ -103,6 +106,7 @@
103106
},
104107
"/powerSaving": {
105108
"get": {
109+
"operationId": "airConditionerPowerSavingGet",
106110
"x-type": "one-shot",
107111
"summary": "スマートデバイスの節電動作設定を取得する。",
108112
"description": "",
@@ -133,6 +137,7 @@
133137
}
134138
},
135139
"put": {
140+
"operationId": "airConditionerPowerSavingPut",
136141
"x-type": "one-shot",
137142
"summary": "スマートデバイスの節電動作設定を設定する。",
138143
"description": "",
@@ -172,6 +177,7 @@
172177
},
173178
"/modeSetting": {
174179
"get": {
180+
"operationId": "airConditionerModeSettingGet",
175181
"x-type": "one-shot",
176182
"summary": "スマートデバイスの運転モード設定を取得する。",
177183
"description": "",
@@ -202,6 +208,7 @@
202208
}
203209
},
204210
"put": {
211+
"operationId": "airConditionerModeSettingPut",
205212
"x-type": "one-shot",
206213
"summary": "スマートデバイスの運転モード設定を設定する。",
207214
"description": "",
@@ -241,6 +248,7 @@
241248
},
242249
"/roomTemperature": {
243250
"get": {
251+
"operationId": "airConditionerRoomTemperatureGet",
244252
"x-type": "one-shot",
245253
"summary": "スマートデバイスの室温計測値を取得する。",
246254
"description": "",
@@ -273,6 +281,7 @@
273281
},
274282
"/temperature": {
275283
"get": {
284+
"operationId": "airConditionerTemperatureGet",
276285
"x-type": "one-shot",
277286
"summary": "スマートデバイスの温度設定値を取得する。",
278287
"description": "",
@@ -303,6 +312,7 @@
303312
}
304313
},
305314
"put": {
315+
"operationId": "airConditionerTemperaturePut",
306316
"x-type": "one-shot",
307317
"summary": "スマートデバイスの温度設定値を設定する。",
308318
"description": "",
@@ -343,6 +353,7 @@
343353
},
344354
"/airFlow": {
345355
"get": {
356+
"operationId": "airConditionerAirFlowGet",
346357
"x-type": "one-shot",
347358
"summary": "スマートデバイスの風量設定値を取得する。",
348359
"description": "",
@@ -374,6 +385,7 @@
374385
}
375386
},
376387
"put": {
388+
"operationId": "airConditionerAirFlowPut",
377389
"x-type": "one-shot",
378390
"summary": "スマートデバイスの風量設定値を設定する。",
379391
"description": "",
@@ -421,6 +433,7 @@
421433
},
422434
"/enlProperty": {
423435
"get": {
436+
"operationId": "airConditionerEnlPropertyGet",
424437
"x-type": "one-shot",
425438
"summary": "スマートデバイスがサポートしているECHONET Lite 機器オブジェクトプロパティの設定内容を取得する（必須プロパティのみ）。",
426439
"description": "※enlproperty:ECHONET Lite Propertyのこと。",
@@ -470,6 +483,7 @@
470483
}
471484
},
472485
"put": {
486+
"operationId": "airConditionerEnlPropertyPut",
473487
"x-type": "one-shot",
474488
"summary": "スマートデバイスがサポートしているECHONET Lite 機器オブジェクトプロパティに設定を行う（必須プロパティのみ）。",
475489
"description": "※enlproperty:ECHONET Lite Propertyのこと。",
@@ -731,12 +745,12 @@
731745
"properties": {
732746
"epc": {
733747
"type": "string",
734-
"title": "ECHONET Property Code",
748+
"title": "EPC",
735749
"description": "ECHONET Property Code"
736750
},
737751
"value": {
738752
"type": "string",
739-
"title": "ECHONET Property Codeの設定値。",
753+
"title": "設定値",
740754
"description": "ECHONET Property Codeの設定値。"
741755
}
742756
}
@@ -769,18 +783,18 @@
769783
},
770784
"product": {
771785
"type": "string",
772-
"title": "DeviceConnectシステムの名前",
773-
"description": ""
786+
"title": "システム名",
787+
"description": "DeviceConnectシステムの名前。"
774788
},
775789
"version": {
776790
"type": "string",
777-
"title": "DeviceConnectシステムのバージョン名",
778-
"description": ""
791+
"title": "システムバージョン",
792+
"description": "DeviceConnectシステムのバージョン名。"
779793
},
780794
"hmac": {
781795
"type": "string",
782-
"title": "レスポンスに対する署名",
783-
"description": "アプリケーション側から事前にHMACキーを共有されていた場合は必須。"
796+
"title": "署名",
797+
"description": "レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。"
784798
}
785799
}
786800
}

‎api/atmosphericPressure.json

+7-6
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
"paths": {
1414
"/": {
1515
"get": {
16+
"operationId": "atmosphericPressureGet",
1617
"x-type": "one-shot",
1718
"summary": "スマートデバイスの気圧情報を取得する。",
1819
"description": "",
@@ -96,18 +97,18 @@
9697
},
9798
"product": {
9899
"type": "string",
99-
"title": "DeviceConnectシステムの名前",
100-
"description": ""
100+
"title": "システム名",
101+
"description": "DeviceConnectシステムの名前。"
101102
},
102103
"version": {
103104
"type": "string",
104-
"title": "DeviceConnectシステムのバージョン名",
105-
"description": ""
105+
"title": "システムバージョン",
106+
"description": "DeviceConnectシステムのバージョン名。"
106107
},
107108
"hmac": {
108109
"type": "string",
109-
"title": "レスポンスに対する署名",
110-
"description": "アプリケーション側から事前にHMACキーを共有されていた場合は必須。"
110+
"title": "署名",
111+
"description": "レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。"
111112
}
112113
}
113114
}

‎api/authorization.json

+8-6
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
"paths": {
1111
"/grant": {
1212
"get": {
13+
"operationId": "authorizationGrantGet",
1314
"x-type": "one-shot",
1415
"summary": "Device Connect ManagerにLocal OAuthを行うためのクライアントの作成要求を行う。",
1516
"description": "同じオリジンから送信された場合には、以前のクライアントを削除して新たにクライアントを作成する。<br>それに伴い、クライアントに紐づいていたアクセストークンもすべて破棄される。",
@@ -34,6 +35,7 @@
3435
},
3536
"/accessToken": {
3637
"get": {
38+
"operationId": "authorizationAccessTokenGet",
3739
"x-type": "one-shot",
3840
"summary": "DeviceConnectManagerにLocal OAuthを行うためのアクセストークンの作成要求を行う。",
3941
"description": "各プロファイルにアクセスするためには、このAPIで作成したアクセストークンが必要になる。<br>また、アクセストークンには有効期限が存在するので、有効期限が切れた場合には再度アクセストークンを作成し直す必要がある。",
@@ -182,18 +184,18 @@
182184
},
183185
"product": {
184186
"type": "string",
185-
"title": "DeviceConnectシステムの名前",
186-
"description": ""
187+
"title": "システム名",
188+
"description": "DeviceConnectシステムの名前。"
187189
},
188190
"version": {
189191
"type": "string",
190-
"title": "DeviceConnectシステムのバージョン名",
191-
"description": ""
192+
"title": "システムバージョン",
193+
"description": "DeviceConnectシステムのバージョン名。"
192194
},
193195
"hmac": {
194196
"type": "string",
195-
"title": "レスポンスに対する署名",
196-
"description": "アプリケーション側から事前にHMACキーを共有されていた場合は必須。"
197+
"title": "署名",
198+
"description": "レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。"
197199
}
198200
}
199201
}

‎api/availability.json

+7-6
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
"paths": {
1111
"/": {
1212
"get": {
13+
"operationId": "availabilityGet",
1314
"x-type": "one-shot",
1415
"summary": "Device Connect Managerが起動しているかどうかを確認する。",
1516
"description": "",
@@ -69,18 +70,18 @@
6970
},
7071
"product": {
7172
"type": "string",
72-
"title": "DeviceConnectシステムの名前",
73-
"description": ""
73+
"title": "システム名",
74+
"description": "DeviceConnectシステムの名前。"
7475
},
7576
"version": {
7677
"type": "string",
77-
"title": "DeviceConnectシステムのバージョン名",
78-
"description": ""
78+
"title": "システムバージョン",
79+
"description": "DeviceConnectシステムのバージョン名。"
7980
},
8081
"hmac": {
8182
"type": "string",
82-
"title": "レスポンスに対する署名",
83-
"description": "アプリケーション側から事前にHMACキーを共有されていた場合は必須。"
83+
"title": "署名",
84+
"description": "レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。"
8485
}
8586
}
8687
}

0 commit comments

Comments
 (0)