Skip to content

Commit f5b0048

Browse files
TakayukiHoshi1984TakayukiHoshi1984
committed
JSONにdescriptionを追加。
1 parent 4b7d060 commit f5b0048

48 files changed

Lines changed: 25060 additions & 24555 deletions

Some content is hidden

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

‎api/airConditioner.json‎

Lines changed: 789 additions & 770 deletions
Large diffs are not rendered by default.

‎api/atmosphericPressure.json‎

Lines changed: 108 additions & 108 deletions
Original file line numberDiff line numberDiff line change
@@ -1,115 +1,115 @@
11
{
2-
"swagger": "2.0",
3-
"basePath": "/gotapi/atmosphericPressure",
4-
"info": {
5-
"title": "Atmospheric Pressure 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-
"operationId": "atmosphericPressureGet",
17-
"x-type": "one-shot",
18-
"summary": "スマートデバイスの気圧情報を取得する。",
19-
"description": "",
20-
"parameters": [
21-
{
22-
"name": "serviceId",
23-
"description": "サービスID。取得対象スマートデバイス",
24-
"in": "query",
25-
"required": true,
26-
"type": "string"
27-
}
28-
],
29-
"responses": {
30-
"200": {
31-
"description": "",
32-
"schema": {
33-
"$ref": "#/definitions/GetAtmosphericPressureResponse"
34-
},
35-
"examples": {
36-
"application/json": {
37-
"result": 0,
38-
"product": "Example System",
39-
"version": "1.0.0",
40-
"atmosphericPressure": 1016.12,
41-
"timeStamp": 1431856940275,
42-
"timeStampString": "2015-05-17T10:02:20+09:00"
43-
}
44-
}
45-
}
46-
}
2+
"swagger": "2.0",
3+
"basePath": "/gotapi/atmosphericPressure",
4+
"info": {
5+
"title": "Atmospheric Pressure 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+
"operationId": "atmosphericPressureGet",
17+
"x-type": "one-shot",
18+
"summary": "スマートデバイスの気圧情報を取得する。",
19+
"description": "スマートデバイスで測定した気圧を返す。失敗した場合はエラーを返す。",
20+
"parameters": [
21+
{
22+
"name": "serviceId",
23+
"description": "サービスID。取得対象スマートデバイス",
24+
"in": "query",
25+
"required": true,
26+
"type": "string"
27+
}
28+
],
29+
"responses": {
30+
"200": {
31+
"description": "スマートデバイスで測定した気圧を返す。失敗した場合はエラーを返す。",
32+
"schema": {
33+
"$ref": "#/definitions/GetAtmosphericPressureResponse"
34+
},
35+
"examples": {
36+
"application/json": {
37+
"result": 0,
38+
"product": "Example System",
39+
"version": "1.0.0",
40+
"atmosphericPressure": 1016.12,
41+
"timeStamp": 1431856940275,
42+
"timeStampString": "2015-05-17T10:02:20+09:00"
43+
}
4744
}
45+
}
4846
}
49-
},
50-
"definitions": {
51-
"GetAtmosphericPressureResponse": {
52-
"type": "object",
53-
"allOf": [
54-
{
55-
"$ref": "#/definitions/CommonResponse"
56-
},
57-
{
58-
"type": "object",
59-
"required": [
60-
"atmosphericPressure"
61-
],
62-
"properties": {
63-
"atmosphericPressure": {
64-
"type": "number",
65-
"title": "気圧",
66-
"description": "気圧<br>単位: ヘクトパスカル(hPa)"
67-
},
68-
"timeStamp": {
69-
"type": "integer",
70-
"format": "int64",
71-
"title": "気圧のタイムスタンプ",
72-
"description": "測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。"
73-
},
74-
"timeStampString": {
75-
"type": "string",
76-
"format": "date-time",
77-
"title": "気圧のタイムスタンプ文字列",
78-
"description": "タイムスタンプと同じタイムスタンプをRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。"
79-
}
80-
}
81-
}
82-
]
47+
}
48+
}
49+
},
50+
"definitions": {
51+
"GetAtmosphericPressureResponse": {
52+
"type": "object",
53+
"allOf": [
54+
{
55+
"$ref": "#/definitions/CommonResponse"
8356
},
84-
"CommonResponse": {
85-
"type": "object",
86-
"required": [
87-
"result",
88-
"product",
89-
"version"
90-
],
91-
"properties": {
92-
"result": {
93-
"type": "integer",
94-
"title": "処理結果",
95-
"description": "0: 正常応答<br>0以外: 異常応答"
96-
},
97-
"product": {
98-
"type": "string",
99-
"title": "システム名",
100-
"description": "DeviceConnectシステムの名前。"
101-
},
102-
"version": {
103-
"type": "string",
104-
"title": "システムバージョン",
105-
"description": "DeviceConnectシステムのバージョン名。"
106-
},
107-
"hmac": {
108-
"type": "string",
109-
"title": "署名",
110-
"description": "レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。"
111-
}
57+
{
58+
"type": "object",
59+
"required": [
60+
"atmosphericPressure"
61+
],
62+
"properties": {
63+
"atmosphericPressure": {
64+
"type": "number",
65+
"title": "気圧",
66+
"description": "気圧<br> 単位: ヘクトパスカル(hPa)"
67+
},
68+
"timeStamp": {
69+
"type": "integer",
70+
"format": "int64",
71+
"title": "気圧のタイムスタンプ",
72+
"description": "測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。"
73+
},
74+
"timeStampString": {
75+
"type": "string",
76+
"format": "date-time",
77+
"title": "気圧のタイムスタンプ文字列",
78+
"description": "タイムスタンプと同じタイムスタンプを RFC3339「yyyy-MM-dd''T''HH:mm:ssZZZZZ」の形式で返す。"
11279
}
80+
}
81+
}
82+
]
83+
},
84+
"CommonResponse": {
85+
"type": "object",
86+
"required": [
87+
"result",
88+
"product",
89+
"version"
90+
],
91+
"properties": {
92+
"result": {
93+
"type": "integer",
94+
"title": "処理結果",
95+
"description": "0: 正常応答<br> 0以外: 異常応答"
96+
},
97+
"product": {
98+
"type": "string",
99+
"title": "システム名",
100+
"description": "DeviceConnectシステムの名前。"
101+
},
102+
"version": {
103+
"type": "string",
104+
"title": "システムバージョン",
105+
"description": "DeviceConnectシステムのバージョン名。"
106+
},
107+
"hmac": {
108+
"type": "string",
109+
"title": "署名",
110+
"description": "レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。"
113111
}
112+
}
114113
}
115-
}
114+
}
115+
}

0 commit comments

Comments
 (0)