-
Notifications
You must be signed in to change notification settings - Fork 1
/
swagger.json
194 lines (194 loc) · 5.81 KB
/
swagger.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
{
"swagger": "2.0",
"info": {
"title": "MSA-WORLD-FACTBOOK",
"description": "Semi structured API for the CIA World Factbook, a reference of information for 267 countries.",
"version": "1.0.0"
},
"produces": [
"application/json"
],
"paths": {
"/ms/version": {
"get": {
"tags": [
"msa-standard"
],
"summary": "Return the microservice version number",
"responses": {
"200": {
"description": "the version number"
}
}
}
},
"/ms/name": {
"get": {
"tags": [
"msa-standard"
],
"summary": "Return the microservice name",
"responses": {
"200": {
"description": "the name"
}
}
}
},
"/ms/readme.md": {
"get": {
"tags": [
"msa-standard"
],
"summary": "Return the microservice readme in markdown",
"responses": {
"200": {
"description": "the readme in markdown"
}
}
}
},
"/ms/readme.html": {
"get": {
"tags": [
"msa-standard"
],
"summary": "Return the microservice readme in html",
"responses": {
"200": {
"description": "the readme in html"
}
}
}
},
"/swagger/swagger.json": {
"get": {
"tags": [
"msa-standard"
],
"summary": "Return the microservice Swagger JSON file",
"responses": {
"200": {
"description": "the Swagger JSON file"
}
}
}
},
"/swagger/#": {
"get": {
"tags": [
"msa-standard"
],
"summary": "Return the Swagger-UI page",
"responses": {
"200": {
"description": "the Swagger-UI page"
}
}
}
},
"/nginx/stats.json": {
"get": {
"tags": [
"msa-standard"
],
"summary": "Return stats about Nginx in JSON",
"responses": {
"200": {
"description": "the stats about Nginx in JSON"
}
}
}
},
"/nginx/stats.html": {
"get": {
"tags": [
"msa-standard"
],
"summary": "Return a dashboard displaying the stats from Nginx",
"responses": {
"200": {
"description": "the Nginx stats dashboard"
}
}
}
},
"/factbook/codes": {
"get": {
"tags": [
"msa-world-factbook"
],
"summary": "Returns the list of country codes",
"responses": {
"200": {
"description": "the list of valid country codes"
}
}
}
},
"/factbook/attributes": {
"get": {
"tags": [
"msa-world-factbook"
],
"summary": "Returns the list of country attributes",
"responses": {
"200": {
"description": "the list of valid country attributes"
}
}
}
},
"/factbook/{code}": {
"get": {
"tags": [
"msa-world-factbook"
],
"summary": "Returns a summary of all the data for a given country",
"parameters": [
{
"name": "code",
"in": "path",
"description": "a country code",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "the data"
}
}
}
},
"/factbook/{code}/{attribute}": {
"get": {
"tags": [
"msa-world-factbook"
],
"summary": "Returns the data for the specified attribute for a given country, as a string + an array of extracted numbers",
"parameters": [
{
"name": "code",
"in": "path",
"description": "a country code",
"required": true,
"type": "string"
},
{
"name": "attribute",
"in": "path",
"description": "a country attribute",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "the data"
}
}
}
}
}
}