-
Notifications
You must be signed in to change notification settings - Fork 6.3k
/
bookstore.proto
126 lines (109 loc) · 3.51 KB
/
bookstore.proto
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
// Copyright 2016 Google Inc. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
////////////////////////////////////////////////////////////////////////////////
syntax = "proto3";
package endpoints.examples.bookstore;
option java_multiple_files = true;
option java_outer_classname = "BookstoreProto";
option java_package = "com.google.endpoints.examples.bookstore";
import "google/protobuf/empty.proto";
// A simple Bookstore API.
//
// The API manages shelves and books resources. Shelves contain books.
service Bookstore {
// Returns a list of all shelves in the bookstore.
rpc ListShelves(google.protobuf.Empty) returns (ListShelvesResponse) {}
// Creates a new shelf in the bookstore.
rpc CreateShelf(CreateShelfRequest) returns (Shelf) {}
// Returns a specific bookstore shelf.
rpc GetShelf(GetShelfRequest) returns (Shelf) {}
// Deletes a shelf, including all books that are stored on the shelf.
rpc DeleteShelf(DeleteShelfRequest) returns (google.protobuf.Empty) {}
// Returns a list of books on a shelf.
rpc ListBooks(ListBooksRequest) returns (ListBooksResponse) {}
// Creates a new book.
rpc CreateBook(CreateBookRequest) returns (Book) {}
// Returns a specific book.
rpc GetBook(GetBookRequest) returns (Book) {}
// Deletes a book from a shelf.
rpc DeleteBook(DeleteBookRequest) returns (google.protobuf.Empty) {}
}
// A shelf resource.
message Shelf {
// A unique shelf id.
int64 id = 1;
// A theme of the shelf (fiction, poetry, etc).
string theme = 2;
}
// A book resource.
message Book {
// A unique book id.
int64 id = 1;
// An author of the book.
string author = 2;
// A book title.
string title = 3;
}
// Response to ListShelves call.
message ListShelvesResponse {
// Shelves in the bookstore.
repeated Shelf shelves = 1;
}
// Request message for CreateShelf method.
message CreateShelfRequest {
// The shelf resource to create.
Shelf shelf = 1;
}
// Request message for GetShelf method.
message GetShelfRequest {
// The ID of the shelf resource to retrieve.
int64 shelf = 1;
}
// Request message for DeleteShelf method.
message DeleteShelfRequest {
// The ID of the shelf to delete.
int64 shelf = 1;
}
// Request message for ListBooks method.
message ListBooksRequest {
// ID of the shelf which books to list.
int64 shelf = 1;
}
// Response message to ListBooks method.
message ListBooksResponse {
// The books on the shelf.
repeated Book books = 1;
}
// Request message for CreateBook method.
message CreateBookRequest {
// The ID of the shelf on which to create a book.
int64 shelf = 1;
// A book resource to create on the shelf.
Book book = 2;
}
// Request message for GetBook method.
message GetBookRequest {
// The ID of the shelf from which to retrieve a book.
int64 shelf = 1;
// The ID of the book to retrieve.
int64 book = 2;
}
// Request message for DeleteBook method.
message DeleteBookRequest {
// The ID of the shelf from which to delete a book.
int64 shelf = 1;
// The ID of the book to delete.
int64 book = 2;
}