Joe Gregorio | 2379ecc | 2010-10-26 10:51:28 -0400 | [diff] [blame] | 1 | { |
Joe Gregorio | f415342 | 2011-03-18 22:45:18 -0400 | [diff] [blame] | 2 | "kind": "discovery#describeItem", |
Joe Gregorio | 2379ecc | 2010-10-26 10:51:28 -0400 | [diff] [blame] | 3 | "name": "zoo", |
| 4 | "version": "v1", |
Joe Gregorio | bb8677e | 2012-08-21 14:26:02 -0400 | [diff] [blame] | 5 | "description": "Zoo API used for testing", |
Joe Gregorio | 6a63a76 | 2011-05-02 22:36:05 -0400 | [diff] [blame] | 6 | "basePath": "/zoo/", |
Pepper Lebeck-Jobe | 860836f | 2015-06-12 20:42:23 -0400 | [diff] [blame] | 7 | "batchPath": "batchZoo", |
Joe Gregorio | a283815 | 2012-07-16 11:52:17 -0400 | [diff] [blame] | 8 | "rootUrl": "https://www.googleapis.com/", |
arithmetic1728 | 981eadf | 2020-06-02 10:20:10 -0700 | [diff] [blame] | 9 | "mtlsRootUrl": "https://www.mtls.googleapis.com/", |
Joe Gregorio | a283815 | 2012-07-16 11:52:17 -0400 | [diff] [blame] | 10 | "servicePath": "zoo/v1/", |
Joe Gregorio | 2379ecc | 2010-10-26 10:51:28 -0400 | [diff] [blame] | 11 | "rpcPath": "/rpc", |
Joe Gregorio | c8e421c | 2012-06-06 14:03:13 -0400 | [diff] [blame] | 12 | "parameters": { |
| 13 | "alt": { |
| 14 | "type": "string", |
| 15 | "description": "Data format for the response.", |
| 16 | "default": "json", |
| 17 | "enum": [ |
| 18 | "json" |
| 19 | ], |
| 20 | "enumDescriptions": [ |
| 21 | "Responses with Content-Type of application/json" |
| 22 | ], |
| 23 | "location": "query" |
| 24 | }, |
| 25 | "fields": { |
| 26 | "type": "string", |
| 27 | "description": "Selector specifying which fields to include in a partial response.", |
| 28 | "location": "query" |
| 29 | }, |
| 30 | "key": { |
| 31 | "type": "string", |
| 32 | "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", |
| 33 | "location": "query" |
| 34 | }, |
| 35 | "oauth_token": { |
| 36 | "type": "string", |
| 37 | "description": "OAuth 2.0 token for the current user.", |
| 38 | "location": "query" |
| 39 | }, |
| 40 | "prettyPrint": { |
| 41 | "type": "boolean", |
| 42 | "description": "Returns response with indentations and line breaks.", |
| 43 | "default": "true", |
| 44 | "location": "query" |
| 45 | }, |
| 46 | "quotaUser": { |
| 47 | "type": "string", |
| 48 | "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.", |
| 49 | "location": "query" |
| 50 | }, |
| 51 | "userIp": { |
| 52 | "type": "string", |
| 53 | "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.", |
| 54 | "location": "query" |
| 55 | } |
| 56 | }, |
Joe Gregorio | f415342 | 2011-03-18 22:45:18 -0400 | [diff] [blame] | 57 | "features": [ |
| 58 | "dataWrapper" |
| 59 | ], |
| 60 | "schemas": { |
| 61 | "Animal": { |
| 62 | "id": "Animal", |
| 63 | "type": "object", |
| 64 | "properties": { |
| 65 | "etag": { |
| 66 | "type": "string" |
| 67 | }, |
| 68 | "kind": { |
| 69 | "type": "string", |
| 70 | "default": "zoo#animal" |
| 71 | }, |
| 72 | "name": { |
| 73 | "type": "string" |
| 74 | }, |
| 75 | "photo": { |
| 76 | "type": "object", |
| 77 | "properties": { |
| 78 | "filename": { |
| 79 | "type": "string" |
| 80 | }, |
| 81 | "hash": { |
| 82 | "type": "string" |
| 83 | }, |
| 84 | "hashAlgorithm": { |
| 85 | "type": "string" |
| 86 | }, |
| 87 | "size": { |
| 88 | "type": "integer" |
| 89 | }, |
| 90 | "type": { |
| 91 | "type": "string" |
| 92 | } |
| 93 | } |
| 94 | } |
| 95 | } |
| 96 | }, |
| 97 | "Animal2": { |
| 98 | "id": "Animal2", |
| 99 | "type": "object", |
| 100 | "properties": { |
| 101 | "kind": { |
| 102 | "type": "string", |
| 103 | "default": "zoo#animal" |
| 104 | }, |
| 105 | "name": { |
| 106 | "type": "string" |
| 107 | } |
| 108 | } |
| 109 | }, |
| 110 | "AnimalFeed": { |
| 111 | "id": "AnimalFeed", |
| 112 | "type": "object", |
| 113 | "properties": { |
| 114 | "etag": { |
| 115 | "type": "string" |
| 116 | }, |
| 117 | "items": { |
| 118 | "type": "array", |
| 119 | "items": { |
| 120 | "$ref": "Animal" |
| 121 | } |
| 122 | }, |
| 123 | "kind": { |
| 124 | "type": "string", |
| 125 | "default": "zoo#animalFeed" |
| 126 | } |
| 127 | } |
| 128 | }, |
Joe Gregorio | 7f371e1 | 2012-07-12 16:04:33 -0400 | [diff] [blame] | 129 | "AnimalMap": { |
| 130 | "id": "AnimalMap", |
| 131 | "type": "object", |
| 132 | "properties": { |
| 133 | "etag": { |
| 134 | "type": "string" |
| 135 | }, |
| 136 | "animals": { |
| 137 | "type": "object", |
| 138 | "description": "Map of animal id to animal data", |
| 139 | "additionalProperties": { |
| 140 | "$ref": "Animal" |
| 141 | } |
| 142 | }, |
| 143 | "kind": { |
| 144 | "type": "string", |
| 145 | "default": "zoo#animalMap" |
| 146 | } |
| 147 | } |
| 148 | }, |
Joe Gregorio | f415342 | 2011-03-18 22:45:18 -0400 | [diff] [blame] | 149 | "LoadFeed": { |
| 150 | "id": "LoadFeed", |
| 151 | "type": "object", |
| 152 | "properties": { |
| 153 | "items": { |
| 154 | "type": "array", |
| 155 | "items": { |
| 156 | "type": "object", |
| 157 | "properties": { |
| 158 | "doubleVal": { |
| 159 | "type": "number" |
| 160 | }, |
Joe Gregorio | 2b78128 | 2011-12-08 12:00:25 -0500 | [diff] [blame] | 161 | "nullVal": { |
| 162 | "type": "null" |
| 163 | }, |
| 164 | "booleanVal": { |
| 165 | "type": "boolean", |
| 166 | "description": "True or False." |
| 167 | }, |
| 168 | "anyVal": { |
| 169 | "type": "any", |
| 170 | "description": "Anything will do." |
| 171 | }, |
Joe Gregorio | f415342 | 2011-03-18 22:45:18 -0400 | [diff] [blame] | 172 | "enumVal": { |
| 173 | "type": "string" |
| 174 | }, |
| 175 | "kind": { |
| 176 | "type": "string", |
| 177 | "default": "zoo#loadValue" |
| 178 | }, |
| 179 | "longVal": { |
| 180 | "type": "integer" |
| 181 | }, |
| 182 | "stringVal": { |
| 183 | "type": "string" |
| 184 | } |
| 185 | } |
| 186 | } |
| 187 | }, |
| 188 | "kind": { |
| 189 | "type": "string", |
| 190 | "default": "zoo#loadFeed" |
| 191 | } |
| 192 | } |
| 193 | } |
| 194 | }, |
Joe Gregorio | 7a6df3a | 2011-01-31 21:55:21 -0500 | [diff] [blame] | 195 | "methods": { |
| 196 | "query": { |
Joe Gregorio | 6a63a76 | 2011-05-02 22:36:05 -0400 | [diff] [blame] | 197 | "path": "query", |
| 198 | "id": "bigquery.query", |
Joe Gregorio | 7a6df3a | 2011-01-31 21:55:21 -0500 | [diff] [blame] | 199 | "httpMethod": "GET", |
| 200 | "parameters": { |
| 201 | "q": { |
Joe Gregorio | bee8683 | 2011-02-22 10:00:19 -0500 | [diff] [blame] | 202 | "type": "string", |
Joe Gregorio | 6a63a76 | 2011-05-02 22:36:05 -0400 | [diff] [blame] | 203 | "location": "query", |
Joe Gregorio | 7a6df3a | 2011-01-31 21:55:21 -0500 | [diff] [blame] | 204 | "required": false, |
| 205 | "repeated": false |
Joe Gregorio | bee8683 | 2011-02-22 10:00:19 -0500 | [diff] [blame] | 206 | }, |
| 207 | "i": { |
| 208 | "type": "integer", |
Joe Gregorio | 6a63a76 | 2011-05-02 22:36:05 -0400 | [diff] [blame] | 209 | "location": "query", |
Joe Gregorio | bee8683 | 2011-02-22 10:00:19 -0500 | [diff] [blame] | 210 | "required": false, |
| 211 | "repeated": false, |
| 212 | "minimum": "0", |
| 213 | "maximum": "4294967295", |
| 214 | "default": "20" |
| 215 | }, |
| 216 | "n": { |
| 217 | "type": "number", |
Joe Gregorio | 6a63a76 | 2011-05-02 22:36:05 -0400 | [diff] [blame] | 218 | "location": "query", |
Joe Gregorio | bee8683 | 2011-02-22 10:00:19 -0500 | [diff] [blame] | 219 | "required": false, |
| 220 | "repeated": false |
| 221 | }, |
| 222 | "b": { |
| 223 | "type": "boolean", |
Joe Gregorio | 6a63a76 | 2011-05-02 22:36:05 -0400 | [diff] [blame] | 224 | "location": "query", |
Joe Gregorio | bee8683 | 2011-02-22 10:00:19 -0500 | [diff] [blame] | 225 | "required": false, |
| 226 | "repeated": false |
| 227 | }, |
| 228 | "a": { |
| 229 | "type": "any", |
Joe Gregorio | 6a63a76 | 2011-05-02 22:36:05 -0400 | [diff] [blame] | 230 | "location": "query", |
Joe Gregorio | bee8683 | 2011-02-22 10:00:19 -0500 | [diff] [blame] | 231 | "required": false, |
| 232 | "repeated": false |
| 233 | }, |
| 234 | "o": { |
| 235 | "type": "object", |
Joe Gregorio | 6a63a76 | 2011-05-02 22:36:05 -0400 | [diff] [blame] | 236 | "location": "query", |
Joe Gregorio | bee8683 | 2011-02-22 10:00:19 -0500 | [diff] [blame] | 237 | "required": false, |
| 238 | "repeated": false |
| 239 | }, |
| 240 | "e": { |
| 241 | "type": "string", |
Joe Gregorio | 6a63a76 | 2011-05-02 22:36:05 -0400 | [diff] [blame] | 242 | "location": "query", |
Joe Gregorio | bee8683 | 2011-02-22 10:00:19 -0500 | [diff] [blame] | 243 | "required": false, |
| 244 | "repeated": false, |
| 245 | "enum": [ |
| 246 | "foo", |
| 247 | "bar" |
| 248 | ] |
Joe Gregorio | 6804c7a | 2011-11-18 14:30:32 -0500 | [diff] [blame] | 249 | }, |
Craig Citro | 1e74282 | 2012-03-01 12:59:22 -0800 | [diff] [blame] | 250 | "er": { |
| 251 | "type": "string", |
| 252 | "location": "query", |
| 253 | "required": false, |
| 254 | "repeated": true, |
| 255 | "enum": [ |
| 256 | "one", |
| 257 | "two", |
| 258 | "three" |
| 259 | ] |
| 260 | }, |
Joe Gregorio | 6804c7a | 2011-11-18 14:30:32 -0500 | [diff] [blame] | 261 | "rr": { |
| 262 | "type": "string", |
| 263 | "location": "query", |
| 264 | "required": false, |
| 265 | "repeated": true, |
| 266 | "pattern": "[a-z]+" |
Joe Gregorio | 7a6df3a | 2011-01-31 21:55:21 -0500 | [diff] [blame] | 267 | } |
| 268 | } |
| 269 | } |
| 270 | }, |
Joe Gregorio | 2379ecc | 2010-10-26 10:51:28 -0400 | [diff] [blame] | 271 | "resources": { |
Joe Gregorio | 3fada33 | 2011-01-07 17:07:45 -0500 | [diff] [blame] | 272 | "my": { |
| 273 | "resources": { |
| 274 | "favorites": { |
| 275 | "methods": { |
| 276 | "list": { |
Joe Gregorio | 6a63a76 | 2011-05-02 22:36:05 -0400 | [diff] [blame] | 277 | "path": "favorites/@me/mine", |
| 278 | "id": "zoo.animals.mine", |
Joe Gregorio | 3fada33 | 2011-01-07 17:07:45 -0500 | [diff] [blame] | 279 | "httpMethod": "GET", |
| 280 | "parameters": { |
| 281 | "max-results": { |
Joe Gregorio | 6a63a76 | 2011-05-02 22:36:05 -0400 | [diff] [blame] | 282 | "location": "query", |
Joe Gregorio | 3fada33 | 2011-01-07 17:07:45 -0500 | [diff] [blame] | 283 | "required": false |
| 284 | } |
| 285 | } |
| 286 | } |
| 287 | } |
| 288 | } |
| 289 | } |
| 290 | }, |
Joe Gregorio | d92897c | 2011-07-07 11:44:56 -0400 | [diff] [blame] | 291 | "global": { |
| 292 | "resources": { |
| 293 | "print": { |
| 294 | "methods": { |
| 295 | "assert": { |
| 296 | "path": "global/print/assert", |
| 297 | "id": "zoo.animals.mine", |
| 298 | "httpMethod": "GET", |
| 299 | "parameters": { |
| 300 | "max-results": { |
| 301 | "location": "query", |
| 302 | "required": false |
| 303 | } |
| 304 | } |
| 305 | } |
| 306 | } |
| 307 | } |
| 308 | } |
| 309 | }, |
Joe Gregorio | 2379ecc | 2010-10-26 10:51:28 -0400 | [diff] [blame] | 310 | "animals": { |
| 311 | "methods": { |
| 312 | "crossbreed": { |
Joe Gregorio | 6a63a76 | 2011-05-02 22:36:05 -0400 | [diff] [blame] | 313 | "path": "animals/crossbreed", |
| 314 | "id": "zoo.animals.crossbreed", |
Joe Gregorio | f415342 | 2011-03-18 22:45:18 -0400 | [diff] [blame] | 315 | "httpMethod": "POST", |
| 316 | "description": "Cross-breed animals", |
| 317 | "response": { |
| 318 | "$ref": "Animal2" |
Joe Gregorio | 84d3c1f | 2011-07-25 10:39:45 -0400 | [diff] [blame] | 319 | }, |
| 320 | "mediaUpload": { |
| 321 | "accept": [ |
| 322 | "image/png" |
| 323 | ], |
| 324 | "protocols": { |
| 325 | "simple": { |
| 326 | "multipart": true, |
| 327 | "path": "upload/activities/{userId}/@self" |
| 328 | }, |
| 329 | "resumable": { |
| 330 | "multipart": true, |
| 331 | "path": "upload/activities/{userId}/@self" |
| 332 | } |
| 333 | } |
Joe Gregorio | 2379ecc | 2010-10-26 10:51:28 -0400 | [diff] [blame] | 334 | } |
| 335 | }, |
| 336 | "delete": { |
Joe Gregorio | 6a63a76 | 2011-05-02 22:36:05 -0400 | [diff] [blame] | 337 | "path": "animals/{name}", |
| 338 | "id": "zoo.animals.delete", |
Joe Gregorio | 2379ecc | 2010-10-26 10:51:28 -0400 | [diff] [blame] | 339 | "httpMethod": "DELETE", |
Joe Gregorio | f415342 | 2011-03-18 22:45:18 -0400 | [diff] [blame] | 340 | "description": "Delete animals", |
Joe Gregorio | 2379ecc | 2010-10-26 10:51:28 -0400 | [diff] [blame] | 341 | "parameters": { |
| 342 | "name": { |
Joe Gregorio | 6a63a76 | 2011-05-02 22:36:05 -0400 | [diff] [blame] | 343 | "location": "path", |
Joe Gregorio | f415342 | 2011-03-18 22:45:18 -0400 | [diff] [blame] | 344 | "required": true, |
| 345 | "description": "Name of the animal to delete", |
| 346 | "type": "string" |
Joe Gregorio | 2379ecc | 2010-10-26 10:51:28 -0400 | [diff] [blame] | 347 | } |
Joe Gregorio | f415342 | 2011-03-18 22:45:18 -0400 | [diff] [blame] | 348 | }, |
| 349 | "parameterOrder": [ |
| 350 | "name" |
| 351 | ] |
Joe Gregorio | 2379ecc | 2010-10-26 10:51:28 -0400 | [diff] [blame] | 352 | }, |
| 353 | "get": { |
Joe Gregorio | 6a63a76 | 2011-05-02 22:36:05 -0400 | [diff] [blame] | 354 | "path": "animals/{name}", |
| 355 | "id": "zoo.animals.get", |
Joe Gregorio | 2379ecc | 2010-10-26 10:51:28 -0400 | [diff] [blame] | 356 | "httpMethod": "GET", |
Joe Gregorio | f415342 | 2011-03-18 22:45:18 -0400 | [diff] [blame] | 357 | "description": "Get animals", |
Joe Gregorio | 708388c | 2012-06-15 13:43:04 -0400 | [diff] [blame] | 358 | "supportsMediaDownload": true, |
Joe Gregorio | 2379ecc | 2010-10-26 10:51:28 -0400 | [diff] [blame] | 359 | "parameters": { |
| 360 | "name": { |
Joe Gregorio | 6a63a76 | 2011-05-02 22:36:05 -0400 | [diff] [blame] | 361 | "location": "path", |
Joe Gregorio | f415342 | 2011-03-18 22:45:18 -0400 | [diff] [blame] | 362 | "required": true, |
| 363 | "description": "Name of the animal to load", |
| 364 | "type": "string" |
Joe Gregorio | 2379ecc | 2010-10-26 10:51:28 -0400 | [diff] [blame] | 365 | }, |
| 366 | "projection": { |
Joe Gregorio | 6a63a76 | 2011-05-02 22:36:05 -0400 | [diff] [blame] | 367 | "location": "query", |
Joe Gregorio | f415342 | 2011-03-18 22:45:18 -0400 | [diff] [blame] | 368 | "type": "string", |
| 369 | "enum": [ |
| 370 | "full" |
| 371 | ], |
| 372 | "enumDescriptions": [ |
| 373 | "Include everything" |
| 374 | ] |
Joe Gregorio | 2379ecc | 2010-10-26 10:51:28 -0400 | [diff] [blame] | 375 | } |
Joe Gregorio | f415342 | 2011-03-18 22:45:18 -0400 | [diff] [blame] | 376 | }, |
| 377 | "parameterOrder": [ |
| 378 | "name" |
| 379 | ], |
| 380 | "response": { |
| 381 | "$ref": "Animal" |
Joe Gregorio | 2379ecc | 2010-10-26 10:51:28 -0400 | [diff] [blame] | 382 | } |
| 383 | }, |
Joe Gregorio | e08a166 | 2011-12-07 09:48:22 -0500 | [diff] [blame] | 384 | "getmedia": { |
| 385 | "path": "animals/{name}", |
| 386 | "id": "zoo.animals.get", |
| 387 | "httpMethod": "GET", |
| 388 | "description": "Get animals", |
| 389 | "parameters": { |
| 390 | "name": { |
| 391 | "location": "path", |
| 392 | "required": true, |
| 393 | "description": "Name of the animal to load", |
| 394 | "type": "string" |
| 395 | }, |
| 396 | "projection": { |
| 397 | "location": "query", |
| 398 | "type": "string", |
| 399 | "enum": [ |
| 400 | "full" |
| 401 | ], |
| 402 | "enumDescriptions": [ |
| 403 | "Include everything" |
| 404 | ] |
| 405 | } |
| 406 | }, |
| 407 | "parameterOrder": [ |
| 408 | "name" |
| 409 | ] |
| 410 | }, |
Joe Gregorio | 2379ecc | 2010-10-26 10:51:28 -0400 | [diff] [blame] | 411 | "insert": { |
Joe Gregorio | 6a63a76 | 2011-05-02 22:36:05 -0400 | [diff] [blame] | 412 | "path": "animals", |
| 413 | "id": "zoo.animals.insert", |
Joe Gregorio | 2379ecc | 2010-10-26 10:51:28 -0400 | [diff] [blame] | 414 | "httpMethod": "POST", |
Joe Gregorio | f415342 | 2011-03-18 22:45:18 -0400 | [diff] [blame] | 415 | "description": "Insert animals", |
| 416 | "request": { |
| 417 | "$ref": "Animal" |
| 418 | }, |
| 419 | "response": { |
| 420 | "$ref": "Animal" |
Joe Gregorio | fdf7c80 | 2011-06-30 12:33:38 -0400 | [diff] [blame] | 421 | }, |
| 422 | "mediaUpload": { |
| 423 | "accept": [ |
| 424 | "image/png" |
| 425 | ], |
| 426 | "maxSize": "1KB", |
| 427 | "protocols": { |
| 428 | "simple": { |
| 429 | "multipart": true, |
| 430 | "path": "upload/activities/{userId}/@self" |
| 431 | }, |
| 432 | "resumable": { |
| 433 | "multipart": true, |
| 434 | "path": "upload/activities/{userId}/@self" |
| 435 | } |
| 436 | } |
Joe Gregorio | 2379ecc | 2010-10-26 10:51:28 -0400 | [diff] [blame] | 437 | } |
| 438 | }, |
| 439 | "list": { |
Joe Gregorio | 6a63a76 | 2011-05-02 22:36:05 -0400 | [diff] [blame] | 440 | "path": "animals", |
| 441 | "id": "zoo.animals.list", |
Joe Gregorio | 2379ecc | 2010-10-26 10:51:28 -0400 | [diff] [blame] | 442 | "httpMethod": "GET", |
Joe Gregorio | f415342 | 2011-03-18 22:45:18 -0400 | [diff] [blame] | 443 | "description": "List animals", |
Joe Gregorio | 2379ecc | 2010-10-26 10:51:28 -0400 | [diff] [blame] | 444 | "parameters": { |
| 445 | "max-results": { |
Joe Gregorio | 6a63a76 | 2011-05-02 22:36:05 -0400 | [diff] [blame] | 446 | "location": "query", |
Joe Gregorio | f415342 | 2011-03-18 22:45:18 -0400 | [diff] [blame] | 447 | "description": "Maximum number of results to return", |
| 448 | "type": "integer", |
| 449 | "minimum": "0" |
Joe Gregorio | 2379ecc | 2010-10-26 10:51:28 -0400 | [diff] [blame] | 450 | }, |
| 451 | "name": { |
Joe Gregorio | 6a63a76 | 2011-05-02 22:36:05 -0400 | [diff] [blame] | 452 | "location": "query", |
Joe Gregorio | f415342 | 2011-03-18 22:45:18 -0400 | [diff] [blame] | 453 | "description": "Restrict result to animals with this name", |
| 454 | "type": "string" |
Joe Gregorio | 2379ecc | 2010-10-26 10:51:28 -0400 | [diff] [blame] | 455 | }, |
| 456 | "projection": { |
Joe Gregorio | 6a63a76 | 2011-05-02 22:36:05 -0400 | [diff] [blame] | 457 | "location": "query", |
Joe Gregorio | f415342 | 2011-03-18 22:45:18 -0400 | [diff] [blame] | 458 | "type": "string", |
| 459 | "enum": [ |
| 460 | "full" |
| 461 | ], |
| 462 | "enumDescriptions": [ |
| 463 | "Include absolutely everything" |
| 464 | ] |
Joe Gregorio | 2379ecc | 2010-10-26 10:51:28 -0400 | [diff] [blame] | 465 | }, |
| 466 | "start-token": { |
Joe Gregorio | 6a63a76 | 2011-05-02 22:36:05 -0400 | [diff] [blame] | 467 | "location": "query", |
Joe Gregorio | f415342 | 2011-03-18 22:45:18 -0400 | [diff] [blame] | 468 | "description": "Pagination token", |
| 469 | "type": "string" |
Joe Gregorio | 2379ecc | 2010-10-26 10:51:28 -0400 | [diff] [blame] | 470 | } |
Joe Gregorio | f415342 | 2011-03-18 22:45:18 -0400 | [diff] [blame] | 471 | }, |
| 472 | "response": { |
| 473 | "$ref": "AnimalFeed" |
| 474 | } |
| 475 | }, |
| 476 | "patch": { |
Joe Gregorio | 6a63a76 | 2011-05-02 22:36:05 -0400 | [diff] [blame] | 477 | "path": "animals/{name}", |
| 478 | "id": "zoo.animals.patch", |
Joe Gregorio | f415342 | 2011-03-18 22:45:18 -0400 | [diff] [blame] | 479 | "httpMethod": "PATCH", |
| 480 | "description": "Update animals", |
| 481 | "parameters": { |
| 482 | "name": { |
Joe Gregorio | 6a63a76 | 2011-05-02 22:36:05 -0400 | [diff] [blame] | 483 | "location": "path", |
Joe Gregorio | f415342 | 2011-03-18 22:45:18 -0400 | [diff] [blame] | 484 | "required": true, |
| 485 | "description": "Name of the animal to update", |
| 486 | "type": "string" |
| 487 | } |
| 488 | }, |
| 489 | "parameterOrder": [ |
| 490 | "name" |
| 491 | ], |
| 492 | "request": { |
| 493 | "$ref": "Animal" |
| 494 | }, |
| 495 | "response": { |
| 496 | "$ref": "Animal" |
Joe Gregorio | 2379ecc | 2010-10-26 10:51:28 -0400 | [diff] [blame] | 497 | } |
| 498 | }, |
| 499 | "update": { |
Joe Gregorio | 6a63a76 | 2011-05-02 22:36:05 -0400 | [diff] [blame] | 500 | "path": "animals/{name}", |
| 501 | "id": "zoo.animals.update", |
Joe Gregorio | f415342 | 2011-03-18 22:45:18 -0400 | [diff] [blame] | 502 | "httpMethod": "PUT", |
| 503 | "description": "Update animals", |
| 504 | "parameters": { |
| 505 | "name": { |
Joe Gregorio | 6a63a76 | 2011-05-02 22:36:05 -0400 | [diff] [blame] | 506 | "location": "path", |
Joe Gregorio | f415342 | 2011-03-18 22:45:18 -0400 | [diff] [blame] | 507 | "description": "Name of the animal to update", |
| 508 | "type": "string" |
| 509 | } |
| 510 | }, |
| 511 | "parameterOrder": [ |
| 512 | "name" |
| 513 | ], |
| 514 | "request": { |
| 515 | "$ref": "Animal" |
| 516 | }, |
| 517 | "response": { |
| 518 | "$ref": "Animal" |
| 519 | } |
Joe Gregorio | 2379ecc | 2010-10-26 10:51:28 -0400 | [diff] [blame] | 520 | } |
| 521 | } |
| 522 | }, |
| 523 | "load": { |
| 524 | "methods": { |
| 525 | "list": { |
Joe Gregorio | 6a63a76 | 2011-05-02 22:36:05 -0400 | [diff] [blame] | 526 | "path": "load", |
| 527 | "id": "zoo.load.list", |
Joe Gregorio | f415342 | 2011-03-18 22:45:18 -0400 | [diff] [blame] | 528 | "httpMethod": "GET", |
| 529 | "response": { |
| 530 | "$ref": "LoadFeed" |
| 531 | } |
Joe Gregorio | 2379ecc | 2010-10-26 10:51:28 -0400 | [diff] [blame] | 532 | } |
| 533 | } |
| 534 | }, |
| 535 | "loadNoTemplate": { |
| 536 | "methods": { |
| 537 | "list": { |
Joe Gregorio | 6a63a76 | 2011-05-02 22:36:05 -0400 | [diff] [blame] | 538 | "path": "loadNoTemplate", |
| 539 | "id": "zoo.loadNoTemplate.list", |
Joe Gregorio | 2379ecc | 2010-10-26 10:51:28 -0400 | [diff] [blame] | 540 | "httpMethod": "GET" |
| 541 | } |
| 542 | } |
Joe Gregorio | f415342 | 2011-03-18 22:45:18 -0400 | [diff] [blame] | 543 | }, |
| 544 | "scopedAnimals": { |
| 545 | "methods": { |
| 546 | "list": { |
Joe Gregorio | 6a63a76 | 2011-05-02 22:36:05 -0400 | [diff] [blame] | 547 | "path": "scopedanimals", |
| 548 | "id": "zoo.scopedAnimals.list", |
Joe Gregorio | f415342 | 2011-03-18 22:45:18 -0400 | [diff] [blame] | 549 | "httpMethod": "GET", |
| 550 | "description": "List animals (scoped)", |
| 551 | "parameters": { |
| 552 | "max-results": { |
Joe Gregorio | 6a63a76 | 2011-05-02 22:36:05 -0400 | [diff] [blame] | 553 | "location": "query", |
Joe Gregorio | f415342 | 2011-03-18 22:45:18 -0400 | [diff] [blame] | 554 | "description": "Maximum number of results to return", |
| 555 | "type": "integer", |
| 556 | "minimum": "0" |
| 557 | }, |
| 558 | "name": { |
Joe Gregorio | 6a63a76 | 2011-05-02 22:36:05 -0400 | [diff] [blame] | 559 | "location": "query", |
Joe Gregorio | f415342 | 2011-03-18 22:45:18 -0400 | [diff] [blame] | 560 | "description": "Restrict result to animals with this name", |
| 561 | "type": "string" |
| 562 | }, |
| 563 | "projection": { |
Joe Gregorio | 6a63a76 | 2011-05-02 22:36:05 -0400 | [diff] [blame] | 564 | "location": "query", |
Joe Gregorio | f415342 | 2011-03-18 22:45:18 -0400 | [diff] [blame] | 565 | "type": "string", |
| 566 | "enum": [ |
| 567 | "full" |
| 568 | ], |
| 569 | "enumDescriptions": [ |
| 570 | "Include absolutely everything" |
| 571 | ] |
| 572 | }, |
| 573 | "start-token": { |
Joe Gregorio | 6a63a76 | 2011-05-02 22:36:05 -0400 | [diff] [blame] | 574 | "location": "query", |
Joe Gregorio | f415342 | 2011-03-18 22:45:18 -0400 | [diff] [blame] | 575 | "description": "Pagination token", |
| 576 | "type": "string" |
| 577 | } |
| 578 | }, |
| 579 | "response": { |
| 580 | "$ref": "AnimalFeed" |
| 581 | } |
| 582 | } |
| 583 | } |
Joe Gregorio | 2379ecc | 2010-10-26 10:51:28 -0400 | [diff] [blame] | 584 | } |
| 585 | } |
| 586 | } |