tests/data/zoo.json

{
 "kind": "discovery#describeItem",
 "name": "zoo",
 "version": "v1",
 "description": "Zoo API used for Apiary testing",
 "basePath": "/zoo/",
 "rpcPath": "/rpc",
 "parameters": {
  "alt": {
   "type": "string",
   "description": "Data format for the response.",
   "default": "json",
   "enum": [
    "json"
   ],
   "enumDescriptions": [
    "Responses with Content-Type of application/json"
   ],
   "location": "query"
  },
  "fields": {
   "type": "string",
   "description": "Selector specifying which fields to include in a partial response.",
   "location": "query"
  },
  "key": {
   "type": "string",
   "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.",
   "location": "query"
  },
  "oauth_token": {
   "type": "string",
   "description": "OAuth 2.0 token for the current user.",
   "location": "query"
  },
  "prettyPrint": {
   "type": "boolean",
   "description": "Returns response with indentations and line breaks.",
   "default": "true",
   "location": "query"
  },
  "quotaUser": {
   "type": "string",
   "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.",
   "location": "query"
  },
  "userIp": {
   "type": "string",
   "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
   "location": "query"
  }
 },
 "features": [
  "dataWrapper"
 ],
 "schemas": {
  "Animal": {
   "id": "Animal",
   "type": "object",
   "properties": {
    "etag": {
     "type": "string"
    },
    "kind": {
     "type": "string",
     "default": "zoo#animal"
    },
    "name": {
     "type": "string"
    },
    "photo": {
     "type": "object",
     "properties": {
      "filename": {
       "type": "string"
      },
      "hash": {
       "type": "string"
      },
      "hashAlgorithm": {
       "type": "string"
      },
      "size": {
       "type": "integer"
      },
      "type": {
       "type": "string"
      }
     }
    }
   }
  },
  "Animal2": {
   "id": "Animal2",
   "type": "object",
   "properties": {
    "kind": {
     "type": "string",
     "default": "zoo#animal"
    },
    "name": {
     "type": "string"
    }
   }
  },
  "AnimalFeed": {
   "id": "AnimalFeed",
   "type": "object",
   "properties": {
    "etag": {
     "type": "string"
    },
    "items": {
     "type": "array",
     "items": {
      "$ref": "Animal"
     }
    },
    "kind": {
     "type": "string",
     "default": "zoo#animalFeed"
    }
   }
  },
  "LoadFeed": {
   "id": "LoadFeed",
   "type": "object",
   "properties": {
    "items": {
     "type": "array",
     "items": {
      "type": "object",
      "properties": {
       "doubleVal": {
        "type": "number"
       },
       "nullVal": {
        "type": "null"
       },
       "booleanVal": {
        "type": "boolean",
        "description": "True or False."
       },
       "anyVal": {
        "type": "any",
        "description": "Anything will do."
       },
       "enumVal": {
        "type": "string"
       },
       "kind": {
        "type": "string",
        "default": "zoo#loadValue"
       },
       "longVal": {
        "type": "integer"
       },
       "stringVal": {
        "type": "string"
       }
      }
     }
    },
    "kind": {
     "type": "string",
     "default": "zoo#loadFeed"
    }
   }
  }
 },
 "methods": {
  "query": {
   "path": "query",
   "id": "bigquery.query",
   "httpMethod": "GET",
   "parameters": {
    "q": {
     "type": "string",
     "location": "query",
     "required": false,
     "repeated": false
    },
    "i": {
     "type": "integer",
     "location": "query",
     "required": false,
     "repeated": false,
     "minimum": "0",
     "maximum": "4294967295",
     "default": "20"
    },
    "n": {
     "type": "number",
     "location": "query",
     "required": false,
     "repeated": false
    },
    "b": {
     "type": "boolean",
     "location": "query",
     "required": false,
     "repeated": false
    },
    "a": {
     "type": "any",
     "location": "query",
     "required": false,
     "repeated": false
    },
    "o": {
     "type": "object",
     "location": "query",
     "required": false,
     "repeated": false
    },
    "e": {
     "type": "string",
     "location": "query",
     "required": false,
     "repeated": false,
     "enum": [
       "foo",
       "bar"
     ]
    },
    "er": {
      "type": "string",
      "location": "query",
      "required": false,
      "repeated": true,
      "enum": [
        "one",
        "two",
        "three"
      ]
    },
    "rr": {
     "type": "string",
     "location": "query",
     "required": false,
     "repeated": true,
     "pattern": "[a-z]+"
    }
   }
  }
 },
 "resources": {
  "my": {
   "resources": {
    "favorites": {
     "methods": {
      "list": {
       "path": "favorites/@me/mine",
       "id": "zoo.animals.mine",
       "httpMethod": "GET",
       "parameters": {
        "max-results": {
          "location": "query",
          "required": false
        }
       }
      }
     }
    }
   }
  },
  "global": {
   "resources": {
    "print": {
     "methods": {
      "assert": {
       "path": "global/print/assert",
       "id": "zoo.animals.mine",
       "httpMethod": "GET",
       "parameters": {
        "max-results": {
          "location": "query",
          "required": false
        }
       }
      }
     }
    }
   }
  },
  "animals": {
   "methods": {
    "crossbreed": {
     "path": "animals/crossbreed",
     "id": "zoo.animals.crossbreed",
     "httpMethod": "POST",
     "description": "Cross-breed animals",
     "response": {
      "$ref": "Animal2"
     },
     "mediaUpload": {
      "accept": [
       "image/png"
      ],
      "protocols": {
       "simple": {
        "multipart": true,
        "path": "upload/activities/{userId}/@self"
       },
       "resumable": {
        "multipart": true,
        "path": "upload/activities/{userId}/@self"
       }
      }
     }
    },
    "delete": {
     "path": "animals/{name}",
     "id": "zoo.animals.delete",
     "httpMethod": "DELETE",
     "description": "Delete animals",
     "parameters": {
      "name": {
       "location": "path",
       "required": true,
       "description": "Name of the animal to delete",
       "type": "string"
      }
     },
     "parameterOrder": [
      "name"
     ]
    },
    "get": {
     "path": "animals/{name}",
     "id": "zoo.animals.get",
     "httpMethod": "GET",
     "description": "Get animals",
     "parameters": {
      "name": {
       "location": "path",
       "required": true,
       "description": "Name of the animal to load",
       "type": "string"
      },
      "projection": {
       "location": "query",
       "type": "string",
       "enum": [
        "full"
       ],
       "enumDescriptions": [
        "Include everything"
       ]
      }
     },
     "parameterOrder": [
      "name"
     ],
     "response": {
      "$ref": "Animal"
     }
    },
    "getmedia": {
     "path": "animals/{name}",
     "id": "zoo.animals.get",
     "httpMethod": "GET",
     "description": "Get animals",
     "parameters": {
      "name": {
       "location": "path",
       "required": true,
       "description": "Name of the animal to load",
       "type": "string"
      },
      "projection": {
       "location": "query",
       "type": "string",
       "enum": [
        "full"
       ],
       "enumDescriptions": [
        "Include everything"
       ]
      }
     },
     "parameterOrder": [
      "name"
     ]
    },
    "insert": {
     "path": "animals",
     "id": "zoo.animals.insert",
     "httpMethod": "POST",
     "description": "Insert animals",
     "request": {
      "$ref": "Animal"
     },
     "response": {
      "$ref": "Animal"
     },
     "mediaUpload": {
      "accept": [
       "image/png"
      ],
      "maxSize": "1KB",
      "protocols": {
       "simple": {
        "multipart": true,
        "path": "upload/activities/{userId}/@self"
       },
       "resumable": {
        "multipart": true,
        "path": "upload/activities/{userId}/@self"
       }
      }
     }
    },
    "list": {
     "path": "animals",
     "id": "zoo.animals.list",
     "httpMethod": "GET",
     "description": "List animals",
     "parameters": {
      "max-results": {
       "location": "query",
       "description": "Maximum number of results to return",
       "type": "integer",
       "minimum": "0"
      },
      "name": {
       "location": "query",
       "description": "Restrict result to animals with this name",
       "type": "string"
      },
      "projection": {
       "location": "query",
       "type": "string",
       "enum": [
        "full"
       ],
       "enumDescriptions": [
        "Include absolutely everything"
       ]
      },
      "start-token": {
       "location": "query",
       "description": "Pagination token",
       "type": "string"
      }
     },
     "response": {
      "$ref": "AnimalFeed"
     }
    },
    "patch": {
     "path": "animals/{name}",
     "id": "zoo.animals.patch",
     "httpMethod": "PATCH",
     "description": "Update animals",
     "parameters": {
      "name": {
       "location": "path",
       "required": true,
       "description": "Name of the animal to update",
       "type": "string"
      }
     },
     "parameterOrder": [
      "name"
     ],
     "request": {
      "$ref": "Animal"
     },
     "response": {
      "$ref": "Animal"
     }
    },
    "update": {
     "path": "animals/{name}",
     "id": "zoo.animals.update",
     "httpMethod": "PUT",
     "description": "Update animals",
     "parameters": {
      "name": {
       "location": "path",
       "description": "Name of the animal to update",
       "type": "string"
      }
     },
     "parameterOrder": [
      "name"
     ],
     "request": {
      "$ref": "Animal"
     },
     "response": {
      "$ref": "Animal"
     }
    }
   }
  },
  "load": {
   "methods": {
    "list": {
     "path": "load",
     "id": "zoo.load.list",
     "httpMethod": "GET",
     "response": {
      "$ref": "LoadFeed"
     }
    }
   }
  },
  "loadNoTemplate": {
   "methods": {
    "list": {
     "path": "loadNoTemplate",
     "id": "zoo.loadNoTemplate.list",
     "httpMethod": "GET"
    }
   }
  },
  "scopedAnimals": {
   "methods": {
    "list": {
     "path": "scopedanimals",
     "id": "zoo.scopedAnimals.list",
     "httpMethod": "GET",
     "description": "List animals (scoped)",
     "parameters": {
      "max-results": {
       "location": "query",
       "description": "Maximum number of results to return",
       "type": "integer",
       "minimum": "0"
      },
      "name": {
       "location": "query",
       "description": "Restrict result to animals with this name",
       "type": "string"
      },
      "projection": {
       "location": "query",
       "type": "string",
       "enum": [
        "full"
       ],
       "enumDescriptions": [
        "Include absolutely everything"
       ]
      },
      "start-token": {
       "location": "query",
       "description": "Pagination token",
       "type": "string"
      }
     },
     "response": {
      "$ref": "AnimalFeed"
     }
    }
   }
  }
 }
}