Skip to content

Commit 60955d2

Browse files
TakayukiHoshi1984TakayukiHoshi1984
committed
独自Profileの追加(remoteController, tv)
1 parent 72cbefe commit 60955d2

2 files changed

Lines changed: 695 additions & 0 deletions

File tree

‎api/remoteController.json‎

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
{
2+
"swagger": "2.0",
3+
"basePath": "/gotapi/remoteController",
4+
"info": {
5+
"title": "Remote Controller Profile",
6+
"version": "2.0.0",
7+
"description": "スマートデバイスが保持する赤外線などの信号の送受信機能を提供するAPI。"
8+
},
9+
"consumes": [
10+
"application/x-www-form-urlencoded",
11+
"multipart/form-data"
12+
],
13+
"paths": {
14+
"/": {
15+
"get": {
16+
"x-type": "one-shot",
17+
"summary": "スマートデバイスが保持する赤外線などの信号を取得する。",
18+
"description": "",
19+
"parameters": [
20+
{
21+
"name": "serviceId",
22+
"description": "サービスID。取得対象スマートデバイス",
23+
"in": "query",
24+
"required": true,
25+
"type": "string"
26+
}
27+
],
28+
"responses": {
29+
"200": {
30+
"description": "",
31+
"schema": {
32+
"$ref": "#/definitions/ReceiveRemoteControllerResponse"
33+
},
34+
"examples": {
35+
"application/json": {
36+
"result": 0,
37+
"product": "Example System",
38+
"version": "1.0.0",
39+
"message": "{data[18031,8755,1190,1190,1190,3341,1190,3341,1190,3341,1190,1190,1190,3341,1190,3341,1190,334 1,1190,3341,1190,3341,1190,3341,1190,1190,1190,1190,1190,1190,1190,1190,1190,3341,1190,3341,1190,1190,1190,3 341,1190,1190,1190,1190,1190,1190,1190,1190,1190,1190,1190,1190,1190,1190,1190,1190,1190,3341,1190,3341,1190 ,3341,1190,3341,1190,3341,1190,65535,0,9379,18031,4400,1190]}"
40+
}
41+
}
42+
}
43+
}
44+
},
45+
"post": {
46+
"x-type": "one-shot",
47+
"summary": "スマートデバイスに対して赤外線などの信号送信依頼を送る。",
48+
"description": "",
49+
"parameters": [
50+
{
51+
"name": "serviceId",
52+
"description": "サービスID。取得対象スマートデバイス",
53+
"in": "formData",
54+
"required": true,
55+
"type": "string"
56+
},
57+
{
58+
"name": "message",
59+
"description": "メッセージ(赤外線など)。赤外線などの信号。",
60+
"in": "formData",
61+
"required": true,
62+
"type": "string"
63+
}
64+
],
65+
"responses": {
66+
"200": {
67+
"description": "",
68+
"schema": {
69+
"$ref": "#/definitions/SendRemoteControllerResponse"
70+
},
71+
"examples": {
72+
"application/json": {
73+
"result": 0,
74+
"product": "Example System",
75+
"version": "1.0.0"
76+
}
77+
}
78+
}
79+
}
80+
}
81+
}
82+
},
83+
84+
"definitions": {
85+
"ReceiveRemoteControllerResponse": {
86+
"type": "object",
87+
"allOf": [
88+
{
89+
"$ref": "#/definitions/CommonResponse"
90+
},
91+
{
92+
"type": "object",
93+
"required": [
94+
"message"
95+
],
96+
"properties": {
97+
"message": {
98+
"type": "string",
99+
"title": "メッセージ(赤外線など）",
100+
"description": "赤外線などの信号。"
101+
}
102+
}
103+
}
104+
]
105+
},
106+
"SendRemoteControllerResponse": {
107+
"type": "object",
108+
"allOf": [
109+
{
110+
"$ref": "#/definitions/CommonResponse"
111+
}
112+
]
113+
},
114+
115+
"CommonResponse": {
116+
"type": "object",
117+
"required": [
118+
"result",
119+
"product",
120+
"version"
121+
],
122+
"properties": {
123+
"result": {
124+
"type": "integer",
125+
"description": "0:正常応答<br>0以外:異常応答"
126+
},
127+
"product": {
128+
"type": "string",
129+
"description": "DeviceConnectシステムの名前。"
130+
},
131+
"version": {
132+
"type": "string",
133+
"description": "DeviceConnectシステムのバージョン名。"
134+
},
135+
"hmac": {
136+
"type": "string",
137+
"description": "レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。"
138+
}
139+
}
140+
}
141+
}
142+
}

0 commit comments

Comments
 (0)