This repository was archived by the owner on Mar 8, 2022. It is now read-only.
forked from KartikTalwar/DocumentationGenerator
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathschema.json
More file actions
182 lines (182 loc) · 5.8 KB
/
Copy pathschema.json
File metadata and controls
182 lines (182 loc) · 5.8 KB
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
{
"method_id":1153,
"method_url":"/v2/foodservices/{year}/{week}/menu.{format}",
"method_name":"Weekly Food Menu",
"service_id":227,
"service_name":"foodservices",
"request_protocol":"GET",
"is_authenticated":true,
"is_enabled" : true,
"update_frequency":"Every request (live)",
"cache_time_s":0,
"data_type":"Direct DB Connection",
"data_source":[
"http://foodservices.uwaterloo.ca"
],
"method_description":"This method returns the given week and year's food menu.",
"additional_notes":[
"Usage won't increase if there is not data returned",
"We cannot modify the data from this method"
],
"information_steward":"UW FoodServices",
"request_examples":[
"http://api.uwaterloo.ca/v2/foodservices/2013/12/menu.json",
"http://api.uwaterloo.ca/v2/foodservices/2013/22/menu.xml",
"http://api.uwaterloo.ca/v2/foodservices/2013/15/menu.json?callback=myResponse"
],
"response_formats":[
"json",
"xml"
],
"method_parameters":[
{
"parameter":"year",
"description":"The year of menu to be requested",
"is_required":true,
"type":"input"
},
{
"parameter":"week",
"description":"The week number of the menu to be requested",
"is_required":true,
"type":"input"
},
{
"parameter":"format",
"description":"The format of the output",
"is_required":true,
"type":"input"
},
{
"parameter":"key",
"description":"Your API key",
"is_required":true,
"type":"filter"
},
{
"parameter":"callback",
"description":"JSONP callback format",
"is_required":false,
"type":"filter"
}
],
"response_fields":[
{
"field":"date",
"description":"Menu date object",
"type":"object",
"children":[
{
"field":"week",
"description":"Requested week",
"type":"integer"
},
{
"field":"year",
"description":"Requested year",
"type":"integer"
},
{
"field":"start",
"description":"Starting day of the menu (Y-m-d)",
"type":"string"
},
{
"field":"end",
"description":"Ending day of the menu (Y-m-d)",
"type":"string"
}
]
},
{
"field":"outlets",
"description":"Available outlets",
"type":"list",
"children":[
{
"field":"outlet_name",
"description":"Name of the outlet",
"type":"string"
},
{
"field":"outlet_id",
"description":"Foodservices ID for the outlet",
"type":"integer"
},
{
"field":"menu",
"description":"The outlet menu list",
"type":"list",
"children":[
{
"field":"date",
"description":"Date of the menu (Y-m-d)",
"type":"string"
},
{
"field":"day",
"description":"Day of the week",
"type":"string"
},
{
"field":"meals",
"description":"All the meals for the day",
"type":"object",
"children":[
{
"field":"lunch",
"description":"Lunch menu items",
"type":"list",
"children":[
{
"field":"product_name",
"description":"Food item name",
"type":"string"
},
{
"field":"diet_type",
"description":"Type of diet",
"type":"string"
},
{
"field":"product_id",
"description":"Food item ID",
"type":"integer"
}
]
},
{
"field":"dinner",
"description":"Dinner menu",
"type":"list",
"children":[
{
"field":"product_name",
"description":"Food item name",
"type":"string"
},
{
"field":"diet_type",
"description":"Type of Diet",
"type":"string"
},
{
"field":"product_id",
"description":"Food item ID",
"type":"integer"
}
]
},
{
"field":"notes",
"description":"Additional announcements for the day",
"type":"string"
}
]
}
]
}
]
}
]
}