1// Copyright 2020 Google LLC. All Rights Reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15// THIS FILE IS AUTOMATICALLY GENERATED.
16
17syntax = "proto3";
18
19package discovery.v1;
20
21import "google/protobuf/any.proto";
22
23// This option lets the proto compiler generate Java code inside the package
24// name (see below) instead of inside an outer class. It creates a simpler
25// developer experience by reducing one-level of name nesting and be
26// consistent with most programming languages that don't support outer classes.
27option java_multiple_files = true;
28
29// The Java outer classname should be the filename in UpperCamelCase. This
30// class is only used to hold proto descriptor, so developers don't need to
31// work with it directly.
32option java_outer_classname = "OpenAPIProto";
33
34// The Java package name must be proto package name with proper prefix.
35option java_package = "org.discovery_v1";
36
37// A reasonable prefix for the Objective-C symbols generated from the package.
38// It should at a minimum be 3 characters long, all uppercase, and convention
39// is to use an abbreviation of the package name. Something short, but
40// hopefully unique enough to not conflict with things that may come along in
41// the future. 'GPB' is reserved for the protocol buffer implementation itself.
42option objc_class_prefix = "OAS";
43
44// The Go package name.
45option go_package = "./discovery;discovery_v1";
46
47message Annotations {
48 repeated string required = 1;
49}
50
51message Any {
52 google.protobuf.Any value = 1;
53 string yaml = 2;
54}
55
56message Auth {
57 Oauth2 oauth2 = 1;
58}
59
60message Document {
61 string kind = 1;
62 string discovery_version = 2;
63 string id = 3;
64 string name = 4;
65 string version = 5;
66 string revision = 6;
67 string title = 7;
68 string description = 8;
69 Icons icons = 9;
70 string documentation_link = 10;
71 repeated string labels = 11;
72 string protocol = 12;
73 string base_url = 13;
74 string base_path = 14;
75 string root_url = 15;
76 string service_path = 16;
77 string batch_path = 17;
78 Parameters parameters = 18;
79 Auth auth = 19;
80 repeated string features = 20;
81 Schemas schemas = 21;
82 Methods methods = 22;
83 Resources resources = 23;
84 string etag = 24;
85 string owner_domain = 25;
86 string owner_name = 26;
87 bool version_module = 27;
88 string canonical_name = 28;
89 bool fully_encode_reserved_expansion = 29;
90 string package_path = 30;
91 string mtls_root_url = 31;
92}
93
94// Icons that represent the API.
95message Icons {
96 string x16 = 1;
97 string x32 = 2;
98}
99
100message MediaUpload {
101 repeated string accept = 1;
102 string max_size = 2;
103 Protocols protocols = 3;
104 bool supports_subscription = 4;
105}
106
107message Method {
108 string id = 1;
109 string path = 2;
110 string http_method = 3;
111 string description = 4;
112 Parameters parameters = 5;
113 repeated string parameter_order = 6;
114 Request request = 7;
115 Response response = 8;
116 repeated string scopes = 9;
117 bool supports_media_download = 10;
118 bool supports_media_upload = 11;
119 bool use_media_download_service = 12;
120 MediaUpload media_upload = 13;
121 bool supports_subscription = 14;
122 string flat_path = 15;
123 bool etag_required = 16;
124 string streaming_type = 17;
125}
126
127message Methods {
128 repeated NamedMethod additional_properties = 1;
129}
130
131// Automatically-generated message used to represent maps of Method as ordered (name,value) pairs.
132message NamedMethod {
133 // Map key
134 string name = 1;
135 // Mapped value
136 Method value = 2;
137}
138
139// Automatically-generated message used to represent maps of Parameter as ordered (name,value) pairs.
140message NamedParameter {
141 // Map key
142 string name = 1;
143 // Mapped value
144 Parameter value = 2;
145}
146
147// Automatically-generated message used to represent maps of Resource as ordered (name,value) pairs.
148message NamedResource {
149 // Map key
150 string name = 1;
151 // Mapped value
152 Resource value = 2;
153}
154
155// Automatically-generated message used to represent maps of Schema as ordered (name,value) pairs.
156message NamedSchema {
157 // Map key
158 string name = 1;
159 // Mapped value
160 Schema value = 2;
161}
162
163// Automatically-generated message used to represent maps of Scope as ordered (name,value) pairs.
164message NamedScope {
165 // Map key
166 string name = 1;
167 // Mapped value
168 Scope value = 2;
169}
170
171message Oauth2 {
172 Scopes scopes = 1;
173}
174
175message Parameter {
176 string id = 1;
177 string type = 2;
178 string _ref = 3;
179 string description = 4;
180 string default = 5;
181 bool required = 6;
182 string format = 7;
183 string pattern = 8;
184 string minimum = 9;
185 string maximum = 10;
186 repeated string enum = 11;
187 repeated string enum_descriptions = 12;
188 bool repeated = 13;
189 string location = 14;
190 Schemas properties = 15;
191 Schema additional_properties = 16;
192 Schema items = 17;
193 Annotations annotations = 18;
194}
195
196message Parameters {
197 repeated NamedParameter additional_properties = 1;
198}
199
200message Protocols {
201 Simple simple = 1;
202 Resumable resumable = 2;
203}
204
205message Request {
206 string _ref = 1;
207 string parameter_name = 2;
208}
209
210message Resource {
211 Methods methods = 1;
212 Resources resources = 2;
213}
214
215message Resources {
216 repeated NamedResource additional_properties = 1;
217}
218
219message Response {
220 string _ref = 1;
221}
222
223message Resumable {
224 bool multipart = 1;
225 string path = 2;
226}
227
228message Schema {
229 string id = 1;
230 string type = 2;
231 string description = 3;
232 string default = 4;
233 bool required = 5;
234 string format = 6;
235 string pattern = 7;
236 string minimum = 8;
237 string maximum = 9;
238 repeated string enum = 10;
239 repeated string enum_descriptions = 11;
240 bool repeated = 12;
241 string location = 13;
242 Schemas properties = 14;
243 Schema additional_properties = 15;
244 Schema items = 16;
245 string _ref = 17;
246 Annotations annotations = 18;
247 bool read_only = 19;
248}
249
250message Schemas {
251 repeated NamedSchema additional_properties = 1;
252}
253
254message Scope {
255 string description = 1;
256}
257
258message Scopes {
259 repeated NamedScope additional_properties = 1;
260}
261
262message Simple {
263 bool multipart = 1;
264 string path = 2;
265}
266
267message StringArray {
268 repeated string value = 1;
269}
270
View as plain text