{ "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "View and manage your data across Google Cloud Platform services" } } } }, "basePath": "", "baseUrl": "https://libraryagent.googleapis.com/", "batchPath": "batch", "canonicalName": "Libraryagent", "description": "A simple Google Example Library API.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/docs/quota", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "id": "libraryagent:v1", "kind": "discovery#restDescription", "name": "libraryagent", "ownerDomain": "google.com", "ownerName": "Google", "parameters": { "$.xgafv": { "description": "V1 error format.", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query", "type": "string" }, "access_token": { "description": "OAuth access token.", "location": "query", "type": "string" }, "alt": { "default": "json", "description": "Data format for response.", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query", "type": "string" }, "callback": { "description": "JSONP", "location": "query", "type": "string" }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "location": "query", "type": "string" }, "key": { "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", "type": "string" }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "location": "query", "type": "string" }, "prettyPrint": { "default": "true", "description": "Returns response with indentations and line breaks.", "location": "query", "type": "boolean" }, "quotaUser": { "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.", "location": "query", "type": "string" }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query", "type": "string" }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query", "type": "string" } }, "protocol": "rest", "resources": { "shelves": { "methods": { "get": { "description": "Gets a shelf. Returns NOT_FOUND if the shelf does not exist.", "flatPath": "v1/shelves/{shelvesId}", "httpMethod": "GET", "id": "libraryagent.shelves.get", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name of the shelf to retrieve.", "location": "path", "pattern": "^shelves/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { "$ref": "GoogleExampleLibraryagentV1Shelf" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "description": "Lists shelves. The order is unspecified but deterministic. Newly created\nshelves will not necessarily be added to the end of this list.", "flatPath": "v1/shelves", "httpMethod": "GET", "id": "libraryagent.shelves.list", "parameterOrder": [], "parameters": { "pageSize": { "description": "Requested page size. Server may return fewer shelves than requested.\nIf unspecified, server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListShelvesResponse.next_page_token\nreturned from the previous call to `ListShelves` method.", "location": "query", "type": "string" } }, "path": "v1/shelves", "response": { "$ref": "GoogleExampleLibraryagentV1ListShelvesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } }, "resources": { "books": { "methods": { "borrow": { "description": "Borrow a book from the library. Returns the book if it is borrowed\nsuccessfully. Returns NOT_FOUND if the book does not exist in the library.\nReturns quota exceeded error if the amount of books borrowed exceeds\nallocation quota in any dimensions.", "flatPath": "v1/shelves/{shelvesId}/books/{booksId}:borrow", "httpMethod": "POST", "id": "libraryagent.shelves.books.borrow", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name of the book to borrow.", "location": "path", "pattern": "^shelves/[^/]+/books/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}:borrow", "response": { "$ref": "GoogleExampleLibraryagentV1Book" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "description": "Gets a book. Returns NOT_FOUND if the book does not exist.", "flatPath": "v1/shelves/{shelvesId}/books/{booksId}", "httpMethod": "GET", "id": "libraryagent.shelves.books.get", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name of the book to retrieve.", "location": "path", "pattern": "^shelves/[^/]+/books/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { "$ref": "GoogleExampleLibraryagentV1Book" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "description": "Lists books in a shelf. The order is unspecified but deterministic. Newly\ncreated books will not necessarily be added to the end of this list.\nReturns NOT_FOUND if the shelf does not exist.", "flatPath": "v1/shelves/{shelvesId}/books", "httpMethod": "GET", "id": "libraryagent.shelves.books.list", "parameterOrder": [ "parent" ], "parameters": { "pageSize": { "description": "Requested page size. Server may return fewer books than requested.\nIf unspecified, server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBooksResponse.next_page_token.\nreturned from the previous call to `ListBooks` method.", "location": "query", "type": "string" }, "parent": { "description": "The name of the shelf whose books we'd like to list.", "location": "path", "pattern": "^shelves/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+parent}/books", "response": { "$ref": "GoogleExampleLibraryagentV1ListBooksResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "return": { "description": "Return a book to the library. Returns the book if it is returned to the\nlibrary successfully.\nReturns error if the book does not belong to the library\nor the users didn't borrow before.", "flatPath": "v1/shelves/{shelvesId}/books/{booksId}:return", "httpMethod": "POST", "id": "libraryagent.shelves.books.return", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name of the book to return.", "location": "path", "pattern": "^shelves/[^/]+/books/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}:return", "response": { "$ref": "GoogleExampleLibraryagentV1Book" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } } }, "revision": "20190107", "rootUrl": "https://libraryagent.googleapis.com/", "schemas": { "GoogleExampleLibraryagentV1Book": { "description": "A single book in the library.", "id": "GoogleExampleLibraryagentV1Book", "properties": { "author": { "description": "The name of the book author.", "type": "string" }, "name": { "description": "The resource name of the book.\nBook names have the form `shelves/{shelf_id}/books/{book_id}`.\nThe name is ignored when creating a book.", "type": "string" }, "read": { "description": "Value indicating whether the book has been read.", "type": "boolean" }, "title": { "description": "The title of the book.", "type": "string" } }, "type": "object" }, "GoogleExampleLibraryagentV1ListBooksResponse": { "description": "Response message for LibraryAgent.ListBooks.", "id": "GoogleExampleLibraryagentV1ListBooksResponse", "properties": { "books": { "description": "The list of books.", "items": { "$ref": "GoogleExampleLibraryagentV1Book" }, "type": "array" }, "nextPageToken": { "description": "A token to retrieve next page of results.\nPass this value in the\nListBooksRequest.page_token\nfield in the subsequent call to `ListBooks` method to retrieve the next\npage of results.", "type": "string" } }, "type": "object" }, "GoogleExampleLibraryagentV1ListShelvesResponse": { "description": "Response message for LibraryAgent.ListShelves.", "id": "GoogleExampleLibraryagentV1ListShelvesResponse", "properties": { "nextPageToken": { "description": "A token to retrieve next page of results.\nPass this value in the\nListShelvesRequest.page_token\nfield in the subsequent call to `ListShelves` method to retrieve the next\npage of results.", "type": "string" }, "shelves": { "description": "The list of shelves.", "items": { "$ref": "GoogleExampleLibraryagentV1Shelf" }, "type": "array" } }, "type": "object" }, "GoogleExampleLibraryagentV1Shelf": { "description": "A Shelf contains a collection of books with a theme.", "id": "GoogleExampleLibraryagentV1Shelf", "properties": { "name": { "description": "Output only. The resource name of the shelf.\nShelf names have the form `shelves/{shelf_id}`.\nThe name is ignored when creating a shelf.", "type": "string" }, "theme": { "description": "The theme of the shelf", "type": "string" } }, "type": "object" } }, "servicePath": "", "title": "Library Agent API", "version": "v1", "version_module": true }