scorpio 0.0.4 → 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/README.md +37 -14
- data/bin/documents_to_yml.rb +26 -0
- data/documents/swagger.io/v2/schema.json +1607 -0
- data/documents/swagger.io/v2/schema.yml +1079 -0
- data/documents/www.googleapis.com/discovery/v1/apis/discovery/v1/rest +684 -0
- data/{getRest.yml → documents/www.googleapis.com/discovery/v1/apis/discovery/v1/rest.yml} +34 -72
- data/lib/scorpio.rb +30 -1
- data/lib/scorpio/google_api_document.rb +232 -0
- data/lib/scorpio/json-schema-fragments.rb +191 -0
- data/lib/scorpio/json.rb +5 -0
- data/lib/scorpio/json/node.rb +214 -0
- data/lib/scorpio/model.rb +178 -91
- data/lib/scorpio/openapi.rb +81 -0
- data/lib/scorpio/schema.rb +133 -0
- data/lib/scorpio/schema_object_base.rb +227 -0
- data/lib/scorpio/typelike_modules.rb +52 -0
- data/lib/scorpio/version.rb +1 -1
- data/scorpio.gemspec +2 -1
- metadata +20 -8
|
@@ -0,0 +1,684 @@
|
|
|
1
|
+
{
|
|
2
|
+
"kind": "discovery#restDescription",
|
|
3
|
+
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/K3nEDF6hixE8Pks2-9Ysn9j9prQ\"",
|
|
4
|
+
"discoveryVersion": "v1",
|
|
5
|
+
"id": "discovery:v1",
|
|
6
|
+
"name": "discovery",
|
|
7
|
+
"version": "v1",
|
|
8
|
+
"title": "APIs Discovery Service",
|
|
9
|
+
"description": "Provides information about other Google APIs, such as what APIs are available, the resource, and method details for each API.",
|
|
10
|
+
"ownerDomain": "google.com",
|
|
11
|
+
"ownerName": "Google",
|
|
12
|
+
"icons": {
|
|
13
|
+
"x16": "http://www.google.com/images/icons/feature/filing_cabinet_search-g16.png",
|
|
14
|
+
"x32": "http://www.google.com/images/icons/feature/filing_cabinet_search-g32.png"
|
|
15
|
+
},
|
|
16
|
+
"documentationLink": "https://developers.google.com/discovery/",
|
|
17
|
+
"protocol": "rest",
|
|
18
|
+
"baseUrl": "https://www.googleapis.com/discovery/v1/",
|
|
19
|
+
"basePath": "/discovery/v1/",
|
|
20
|
+
"rootUrl": "https://www.googleapis.com/",
|
|
21
|
+
"servicePath": "discovery/v1/",
|
|
22
|
+
"batchPath": "batch/discovery/v1",
|
|
23
|
+
"parameters": {
|
|
24
|
+
"alt": {
|
|
25
|
+
"type": "string",
|
|
26
|
+
"description": "Data format for the response.",
|
|
27
|
+
"default": "json",
|
|
28
|
+
"enum": [
|
|
29
|
+
"json"
|
|
30
|
+
],
|
|
31
|
+
"enumDescriptions": [
|
|
32
|
+
"Responses with Content-Type of application/json"
|
|
33
|
+
],
|
|
34
|
+
"location": "query"
|
|
35
|
+
},
|
|
36
|
+
"fields": {
|
|
37
|
+
"type": "string",
|
|
38
|
+
"description": "Selector specifying which fields to include in a partial response.",
|
|
39
|
+
"location": "query"
|
|
40
|
+
},
|
|
41
|
+
"key": {
|
|
42
|
+
"type": "string",
|
|
43
|
+
"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.",
|
|
44
|
+
"location": "query"
|
|
45
|
+
},
|
|
46
|
+
"oauth_token": {
|
|
47
|
+
"type": "string",
|
|
48
|
+
"description": "OAuth 2.0 token for the current user.",
|
|
49
|
+
"location": "query"
|
|
50
|
+
},
|
|
51
|
+
"prettyPrint": {
|
|
52
|
+
"type": "boolean",
|
|
53
|
+
"description": "Returns response with indentations and line breaks.",
|
|
54
|
+
"default": "true",
|
|
55
|
+
"location": "query"
|
|
56
|
+
},
|
|
57
|
+
"quotaUser": {
|
|
58
|
+
"type": "string",
|
|
59
|
+
"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.",
|
|
60
|
+
"location": "query"
|
|
61
|
+
},
|
|
62
|
+
"userIp": {
|
|
63
|
+
"type": "string",
|
|
64
|
+
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
|
|
65
|
+
"location": "query"
|
|
66
|
+
}
|
|
67
|
+
},
|
|
68
|
+
"schemas": {
|
|
69
|
+
"DirectoryList": {
|
|
70
|
+
"id": "DirectoryList",
|
|
71
|
+
"type": "object",
|
|
72
|
+
"properties": {
|
|
73
|
+
"discoveryVersion": {
|
|
74
|
+
"type": "string",
|
|
75
|
+
"description": "Indicate the version of the Discovery API used to generate this doc.",
|
|
76
|
+
"default": "v1"
|
|
77
|
+
},
|
|
78
|
+
"items": {
|
|
79
|
+
"type": "array",
|
|
80
|
+
"description": "The individual directory entries. One entry per api/version pair.",
|
|
81
|
+
"items": {
|
|
82
|
+
"type": "object",
|
|
83
|
+
"properties": {
|
|
84
|
+
"description": {
|
|
85
|
+
"type": "string",
|
|
86
|
+
"description": "The description of this API."
|
|
87
|
+
},
|
|
88
|
+
"discoveryLink": {
|
|
89
|
+
"type": "string",
|
|
90
|
+
"description": "A link to the discovery document."
|
|
91
|
+
},
|
|
92
|
+
"discoveryRestUrl": {
|
|
93
|
+
"type": "string",
|
|
94
|
+
"description": "The URL for the discovery REST document."
|
|
95
|
+
},
|
|
96
|
+
"documentationLink": {
|
|
97
|
+
"type": "string",
|
|
98
|
+
"description": "A link to human readable documentation for the API."
|
|
99
|
+
},
|
|
100
|
+
"icons": {
|
|
101
|
+
"type": "object",
|
|
102
|
+
"description": "Links to 16x16 and 32x32 icons representing the API.",
|
|
103
|
+
"properties": {
|
|
104
|
+
"x16": {
|
|
105
|
+
"type": "string",
|
|
106
|
+
"description": "The URL of the 16x16 icon."
|
|
107
|
+
},
|
|
108
|
+
"x32": {
|
|
109
|
+
"type": "string",
|
|
110
|
+
"description": "The URL of the 32x32 icon."
|
|
111
|
+
}
|
|
112
|
+
}
|
|
113
|
+
},
|
|
114
|
+
"id": {
|
|
115
|
+
"type": "string",
|
|
116
|
+
"description": "The id of this API."
|
|
117
|
+
},
|
|
118
|
+
"kind": {
|
|
119
|
+
"type": "string",
|
|
120
|
+
"description": "The kind for this response.",
|
|
121
|
+
"default": "discovery#directoryItem"
|
|
122
|
+
},
|
|
123
|
+
"labels": {
|
|
124
|
+
"type": "array",
|
|
125
|
+
"description": "Labels for the status of this API, such as labs or deprecated.",
|
|
126
|
+
"items": {
|
|
127
|
+
"type": "string"
|
|
128
|
+
}
|
|
129
|
+
},
|
|
130
|
+
"name": {
|
|
131
|
+
"type": "string",
|
|
132
|
+
"description": "The name of the API."
|
|
133
|
+
},
|
|
134
|
+
"preferred": {
|
|
135
|
+
"type": "boolean",
|
|
136
|
+
"description": "True if this version is the preferred version to use."
|
|
137
|
+
},
|
|
138
|
+
"title": {
|
|
139
|
+
"type": "string",
|
|
140
|
+
"description": "The title of this API."
|
|
141
|
+
},
|
|
142
|
+
"version": {
|
|
143
|
+
"type": "string",
|
|
144
|
+
"description": "The version of the API."
|
|
145
|
+
}
|
|
146
|
+
}
|
|
147
|
+
}
|
|
148
|
+
},
|
|
149
|
+
"kind": {
|
|
150
|
+
"type": "string",
|
|
151
|
+
"description": "The kind for this response.",
|
|
152
|
+
"default": "discovery#directoryList"
|
|
153
|
+
}
|
|
154
|
+
}
|
|
155
|
+
},
|
|
156
|
+
"JsonSchema": {
|
|
157
|
+
"id": "JsonSchema",
|
|
158
|
+
"type": "object",
|
|
159
|
+
"properties": {
|
|
160
|
+
"$ref": {
|
|
161
|
+
"type": "string",
|
|
162
|
+
"description": "A reference to another schema. The value of this property is the \"id\" of another schema."
|
|
163
|
+
},
|
|
164
|
+
"additionalProperties": {
|
|
165
|
+
"$ref": "JsonSchema",
|
|
166
|
+
"description": "If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object."
|
|
167
|
+
},
|
|
168
|
+
"annotations": {
|
|
169
|
+
"type": "object",
|
|
170
|
+
"description": "Additional information about this property.",
|
|
171
|
+
"properties": {
|
|
172
|
+
"required": {
|
|
173
|
+
"type": "array",
|
|
174
|
+
"description": "A list of methods for which this property is required on requests.",
|
|
175
|
+
"items": {
|
|
176
|
+
"type": "string"
|
|
177
|
+
}
|
|
178
|
+
}
|
|
179
|
+
}
|
|
180
|
+
},
|
|
181
|
+
"default": {
|
|
182
|
+
"type": "string",
|
|
183
|
+
"description": "The default value of this property (if one exists)."
|
|
184
|
+
},
|
|
185
|
+
"description": {
|
|
186
|
+
"type": "string",
|
|
187
|
+
"description": "A description of this object."
|
|
188
|
+
},
|
|
189
|
+
"enum": {
|
|
190
|
+
"type": "array",
|
|
191
|
+
"description": "Values this parameter may take (if it is an enum).",
|
|
192
|
+
"items": {
|
|
193
|
+
"type": "string"
|
|
194
|
+
}
|
|
195
|
+
},
|
|
196
|
+
"enumDescriptions": {
|
|
197
|
+
"type": "array",
|
|
198
|
+
"description": "The descriptions for the enums. Each position maps to the corresponding value in the \"enum\" array.",
|
|
199
|
+
"items": {
|
|
200
|
+
"type": "string"
|
|
201
|
+
}
|
|
202
|
+
},
|
|
203
|
+
"format": {
|
|
204
|
+
"type": "string",
|
|
205
|
+
"description": "An additional regular expression or key that helps constrain the value. For more details see: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23"
|
|
206
|
+
},
|
|
207
|
+
"id": {
|
|
208
|
+
"type": "string",
|
|
209
|
+
"description": "Unique identifier for this schema."
|
|
210
|
+
},
|
|
211
|
+
"items": {
|
|
212
|
+
"$ref": "JsonSchema",
|
|
213
|
+
"description": "If this is a schema for an array, this property is the schema for each element in the array."
|
|
214
|
+
},
|
|
215
|
+
"location": {
|
|
216
|
+
"type": "string",
|
|
217
|
+
"description": "Whether this parameter goes in the query or the path for REST requests."
|
|
218
|
+
},
|
|
219
|
+
"maximum": {
|
|
220
|
+
"type": "string",
|
|
221
|
+
"description": "The maximum value of this parameter."
|
|
222
|
+
},
|
|
223
|
+
"minimum": {
|
|
224
|
+
"type": "string",
|
|
225
|
+
"description": "The minimum value of this parameter."
|
|
226
|
+
},
|
|
227
|
+
"pattern": {
|
|
228
|
+
"type": "string",
|
|
229
|
+
"description": "The regular expression this parameter must conform to. Uses Java 6 regex format: http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html"
|
|
230
|
+
},
|
|
231
|
+
"properties": {
|
|
232
|
+
"type": "object",
|
|
233
|
+
"description": "If this is a schema for an object, list the schema for each property of this object.",
|
|
234
|
+
"additionalProperties": {
|
|
235
|
+
"$ref": "JsonSchema",
|
|
236
|
+
"description": "A single property of this object. The value is itself a JSON Schema object describing this property."
|
|
237
|
+
}
|
|
238
|
+
},
|
|
239
|
+
"readOnly": {
|
|
240
|
+
"type": "boolean",
|
|
241
|
+
"description": "The value is read-only, generated by the service. The value cannot be modified by the client. If the value is included in a POST, PUT, or PATCH request, it is ignored by the service."
|
|
242
|
+
},
|
|
243
|
+
"repeated": {
|
|
244
|
+
"type": "boolean",
|
|
245
|
+
"description": "Whether this parameter may appear multiple times."
|
|
246
|
+
},
|
|
247
|
+
"required": {
|
|
248
|
+
"type": "boolean",
|
|
249
|
+
"description": "Whether the parameter is required."
|
|
250
|
+
},
|
|
251
|
+
"type": {
|
|
252
|
+
"type": "string",
|
|
253
|
+
"description": "The value type for this schema. A list of values can be found here: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1"
|
|
254
|
+
},
|
|
255
|
+
"variant": {
|
|
256
|
+
"type": "object",
|
|
257
|
+
"description": "In a variant data type, the value of one property is used to determine how to interpret the entire entity. Its value must exist in a map of descriminant values to schema names.",
|
|
258
|
+
"properties": {
|
|
259
|
+
"discriminant": {
|
|
260
|
+
"type": "string",
|
|
261
|
+
"description": "The name of the type discriminant property."
|
|
262
|
+
},
|
|
263
|
+
"map": {
|
|
264
|
+
"type": "array",
|
|
265
|
+
"description": "The map of discriminant value to schema to use for parsing..",
|
|
266
|
+
"items": {
|
|
267
|
+
"type": "object",
|
|
268
|
+
"properties": {
|
|
269
|
+
"$ref": {
|
|
270
|
+
"type": "string"
|
|
271
|
+
},
|
|
272
|
+
"type_value": {
|
|
273
|
+
"type": "string"
|
|
274
|
+
}
|
|
275
|
+
}
|
|
276
|
+
}
|
|
277
|
+
}
|
|
278
|
+
}
|
|
279
|
+
}
|
|
280
|
+
}
|
|
281
|
+
},
|
|
282
|
+
"RestDescription": {
|
|
283
|
+
"id": "RestDescription",
|
|
284
|
+
"type": "object",
|
|
285
|
+
"properties": {
|
|
286
|
+
"auth": {
|
|
287
|
+
"type": "object",
|
|
288
|
+
"description": "Authentication information.",
|
|
289
|
+
"properties": {
|
|
290
|
+
"oauth2": {
|
|
291
|
+
"type": "object",
|
|
292
|
+
"description": "OAuth 2.0 authentication information.",
|
|
293
|
+
"properties": {
|
|
294
|
+
"scopes": {
|
|
295
|
+
"type": "object",
|
|
296
|
+
"description": "Available OAuth 2.0 scopes.",
|
|
297
|
+
"additionalProperties": {
|
|
298
|
+
"type": "object",
|
|
299
|
+
"description": "The scope value.",
|
|
300
|
+
"properties": {
|
|
301
|
+
"description": {
|
|
302
|
+
"type": "string",
|
|
303
|
+
"description": "Description of scope."
|
|
304
|
+
}
|
|
305
|
+
}
|
|
306
|
+
}
|
|
307
|
+
}
|
|
308
|
+
}
|
|
309
|
+
}
|
|
310
|
+
}
|
|
311
|
+
},
|
|
312
|
+
"basePath": {
|
|
313
|
+
"type": "string",
|
|
314
|
+
"description": "[DEPRECATED] The base path for REST requests."
|
|
315
|
+
},
|
|
316
|
+
"baseUrl": {
|
|
317
|
+
"type": "string",
|
|
318
|
+
"description": "[DEPRECATED] The base URL for REST requests."
|
|
319
|
+
},
|
|
320
|
+
"batchPath": {
|
|
321
|
+
"type": "string",
|
|
322
|
+
"description": "The path for REST batch requests."
|
|
323
|
+
},
|
|
324
|
+
"canonicalName": {
|
|
325
|
+
"type": "string",
|
|
326
|
+
"description": "Indicates how the API name should be capitalized and split into various parts. Useful for generating pretty class names."
|
|
327
|
+
},
|
|
328
|
+
"description": {
|
|
329
|
+
"type": "string",
|
|
330
|
+
"description": "The description of this API."
|
|
331
|
+
},
|
|
332
|
+
"discoveryVersion": {
|
|
333
|
+
"type": "string",
|
|
334
|
+
"description": "Indicate the version of the Discovery API used to generate this doc.",
|
|
335
|
+
"default": "v1"
|
|
336
|
+
},
|
|
337
|
+
"documentationLink": {
|
|
338
|
+
"type": "string",
|
|
339
|
+
"description": "A link to human readable documentation for the API."
|
|
340
|
+
},
|
|
341
|
+
"etag": {
|
|
342
|
+
"type": "string",
|
|
343
|
+
"description": "The ETag for this response.",
|
|
344
|
+
"readOnly": true
|
|
345
|
+
},
|
|
346
|
+
"exponentialBackoffDefault": {
|
|
347
|
+
"type": "boolean",
|
|
348
|
+
"description": "Enable exponential backoff for suitable methods in the generated clients."
|
|
349
|
+
},
|
|
350
|
+
"features": {
|
|
351
|
+
"type": "array",
|
|
352
|
+
"description": "A list of supported features for this API.",
|
|
353
|
+
"items": {
|
|
354
|
+
"type": "string"
|
|
355
|
+
}
|
|
356
|
+
},
|
|
357
|
+
"icons": {
|
|
358
|
+
"type": "object",
|
|
359
|
+
"description": "Links to 16x16 and 32x32 icons representing the API.",
|
|
360
|
+
"properties": {
|
|
361
|
+
"x16": {
|
|
362
|
+
"type": "string",
|
|
363
|
+
"description": "The URL of the 16x16 icon."
|
|
364
|
+
},
|
|
365
|
+
"x32": {
|
|
366
|
+
"type": "string",
|
|
367
|
+
"description": "The URL of the 32x32 icon."
|
|
368
|
+
}
|
|
369
|
+
}
|
|
370
|
+
},
|
|
371
|
+
"id": {
|
|
372
|
+
"type": "string",
|
|
373
|
+
"description": "The ID of this API."
|
|
374
|
+
},
|
|
375
|
+
"kind": {
|
|
376
|
+
"type": "string",
|
|
377
|
+
"description": "The kind for this response.",
|
|
378
|
+
"default": "discovery#restDescription"
|
|
379
|
+
},
|
|
380
|
+
"labels": {
|
|
381
|
+
"type": "array",
|
|
382
|
+
"description": "Labels for the status of this API, such as labs or deprecated.",
|
|
383
|
+
"items": {
|
|
384
|
+
"type": "string"
|
|
385
|
+
}
|
|
386
|
+
},
|
|
387
|
+
"methods": {
|
|
388
|
+
"type": "object",
|
|
389
|
+
"description": "API-level methods for this API.",
|
|
390
|
+
"additionalProperties": {
|
|
391
|
+
"$ref": "RestMethod",
|
|
392
|
+
"description": "An individual method description."
|
|
393
|
+
}
|
|
394
|
+
},
|
|
395
|
+
"name": {
|
|
396
|
+
"type": "string",
|
|
397
|
+
"description": "The name of this API."
|
|
398
|
+
},
|
|
399
|
+
"ownerDomain": {
|
|
400
|
+
"type": "string",
|
|
401
|
+
"description": "The domain of the owner of this API. Together with the ownerName and a packagePath values, this can be used to generate a library for this API which would have a unique fully qualified name."
|
|
402
|
+
},
|
|
403
|
+
"ownerName": {
|
|
404
|
+
"type": "string",
|
|
405
|
+
"description": "The name of the owner of this API. See ownerDomain."
|
|
406
|
+
},
|
|
407
|
+
"packagePath": {
|
|
408
|
+
"type": "string",
|
|
409
|
+
"description": "The package of the owner of this API. See ownerDomain."
|
|
410
|
+
},
|
|
411
|
+
"parameters": {
|
|
412
|
+
"type": "object",
|
|
413
|
+
"description": "Common parameters that apply across all apis.",
|
|
414
|
+
"additionalProperties": {
|
|
415
|
+
"$ref": "JsonSchema",
|
|
416
|
+
"description": "Description of a single parameter."
|
|
417
|
+
}
|
|
418
|
+
},
|
|
419
|
+
"protocol": {
|
|
420
|
+
"type": "string",
|
|
421
|
+
"description": "The protocol described by this document.",
|
|
422
|
+
"default": "rest"
|
|
423
|
+
},
|
|
424
|
+
"resources": {
|
|
425
|
+
"type": "object",
|
|
426
|
+
"description": "The resources in this API.",
|
|
427
|
+
"additionalProperties": {
|
|
428
|
+
"$ref": "RestResource",
|
|
429
|
+
"description": "An individual resource description. Contains methods and sub-resources related to this resource."
|
|
430
|
+
}
|
|
431
|
+
},
|
|
432
|
+
"revision": {
|
|
433
|
+
"type": "string",
|
|
434
|
+
"description": "The version of this API."
|
|
435
|
+
},
|
|
436
|
+
"rootUrl": {
|
|
437
|
+
"type": "string",
|
|
438
|
+
"description": "The root URL under which all API services live."
|
|
439
|
+
},
|
|
440
|
+
"schemas": {
|
|
441
|
+
"type": "object",
|
|
442
|
+
"description": "The schemas for this API.",
|
|
443
|
+
"additionalProperties": {
|
|
444
|
+
"$ref": "JsonSchema",
|
|
445
|
+
"description": "An individual schema description."
|
|
446
|
+
}
|
|
447
|
+
},
|
|
448
|
+
"servicePath": {
|
|
449
|
+
"type": "string",
|
|
450
|
+
"description": "The base path for all REST requests."
|
|
451
|
+
},
|
|
452
|
+
"title": {
|
|
453
|
+
"type": "string",
|
|
454
|
+
"description": "The title of this API."
|
|
455
|
+
},
|
|
456
|
+
"version": {
|
|
457
|
+
"type": "string",
|
|
458
|
+
"description": "The version of this API."
|
|
459
|
+
},
|
|
460
|
+
"version_module": {
|
|
461
|
+
"type": "boolean"
|
|
462
|
+
}
|
|
463
|
+
}
|
|
464
|
+
},
|
|
465
|
+
"RestMethod": {
|
|
466
|
+
"id": "RestMethod",
|
|
467
|
+
"type": "object",
|
|
468
|
+
"properties": {
|
|
469
|
+
"description": {
|
|
470
|
+
"type": "string",
|
|
471
|
+
"description": "Description of this method."
|
|
472
|
+
},
|
|
473
|
+
"etagRequired": {
|
|
474
|
+
"type": "boolean",
|
|
475
|
+
"description": "Whether this method requires an ETag to be specified. The ETag is sent as an HTTP If-Match or If-None-Match header."
|
|
476
|
+
},
|
|
477
|
+
"httpMethod": {
|
|
478
|
+
"type": "string",
|
|
479
|
+
"description": "HTTP method used by this method."
|
|
480
|
+
},
|
|
481
|
+
"id": {
|
|
482
|
+
"type": "string",
|
|
483
|
+
"description": "A unique ID for this method. This property can be used to match methods between different versions of Discovery."
|
|
484
|
+
},
|
|
485
|
+
"mediaUpload": {
|
|
486
|
+
"type": "object",
|
|
487
|
+
"description": "Media upload parameters.",
|
|
488
|
+
"properties": {
|
|
489
|
+
"accept": {
|
|
490
|
+
"type": "array",
|
|
491
|
+
"description": "MIME Media Ranges for acceptable media uploads to this method.",
|
|
492
|
+
"items": {
|
|
493
|
+
"type": "string"
|
|
494
|
+
}
|
|
495
|
+
},
|
|
496
|
+
"maxSize": {
|
|
497
|
+
"type": "string",
|
|
498
|
+
"description": "Maximum size of a media upload, such as \"1MB\", \"2GB\" or \"3TB\"."
|
|
499
|
+
},
|
|
500
|
+
"protocols": {
|
|
501
|
+
"type": "object",
|
|
502
|
+
"description": "Supported upload protocols.",
|
|
503
|
+
"properties": {
|
|
504
|
+
"resumable": {
|
|
505
|
+
"type": "object",
|
|
506
|
+
"description": "Supports the Resumable Media Upload protocol.",
|
|
507
|
+
"properties": {
|
|
508
|
+
"multipart": {
|
|
509
|
+
"type": "boolean",
|
|
510
|
+
"description": "True if this endpoint supports uploading multipart media.",
|
|
511
|
+
"default": "true"
|
|
512
|
+
},
|
|
513
|
+
"path": {
|
|
514
|
+
"type": "string",
|
|
515
|
+
"description": "The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level."
|
|
516
|
+
}
|
|
517
|
+
}
|
|
518
|
+
},
|
|
519
|
+
"simple": {
|
|
520
|
+
"type": "object",
|
|
521
|
+
"description": "Supports uploading as a single HTTP request.",
|
|
522
|
+
"properties": {
|
|
523
|
+
"multipart": {
|
|
524
|
+
"type": "boolean",
|
|
525
|
+
"description": "True if this endpoint supports upload multipart media.",
|
|
526
|
+
"default": "true"
|
|
527
|
+
},
|
|
528
|
+
"path": {
|
|
529
|
+
"type": "string",
|
|
530
|
+
"description": "The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level."
|
|
531
|
+
}
|
|
532
|
+
}
|
|
533
|
+
}
|
|
534
|
+
}
|
|
535
|
+
}
|
|
536
|
+
}
|
|
537
|
+
},
|
|
538
|
+
"parameterOrder": {
|
|
539
|
+
"type": "array",
|
|
540
|
+
"description": "Ordered list of required parameters, serves as a hint to clients on how to structure their method signatures. The array is ordered such that the \"most-significant\" parameter appears first.",
|
|
541
|
+
"items": {
|
|
542
|
+
"type": "string"
|
|
543
|
+
}
|
|
544
|
+
},
|
|
545
|
+
"parameters": {
|
|
546
|
+
"type": "object",
|
|
547
|
+
"description": "Details for all parameters in this method.",
|
|
548
|
+
"additionalProperties": {
|
|
549
|
+
"$ref": "JsonSchema",
|
|
550
|
+
"description": "Details for a single parameter in this method."
|
|
551
|
+
}
|
|
552
|
+
},
|
|
553
|
+
"path": {
|
|
554
|
+
"type": "string",
|
|
555
|
+
"description": "The URI path of this REST method. Should be used in conjunction with the basePath property at the api-level."
|
|
556
|
+
},
|
|
557
|
+
"request": {
|
|
558
|
+
"type": "object",
|
|
559
|
+
"description": "The schema for the request.",
|
|
560
|
+
"properties": {
|
|
561
|
+
"$ref": {
|
|
562
|
+
"type": "string",
|
|
563
|
+
"description": "Schema ID for the request schema."
|
|
564
|
+
},
|
|
565
|
+
"parameterName": {
|
|
566
|
+
"type": "string",
|
|
567
|
+
"description": "parameter name."
|
|
568
|
+
}
|
|
569
|
+
}
|
|
570
|
+
},
|
|
571
|
+
"response": {
|
|
572
|
+
"type": "object",
|
|
573
|
+
"description": "The schema for the response.",
|
|
574
|
+
"properties": {
|
|
575
|
+
"$ref": {
|
|
576
|
+
"type": "string",
|
|
577
|
+
"description": "Schema ID for the response schema."
|
|
578
|
+
}
|
|
579
|
+
}
|
|
580
|
+
},
|
|
581
|
+
"scopes": {
|
|
582
|
+
"type": "array",
|
|
583
|
+
"description": "OAuth 2.0 scopes applicable to this method.",
|
|
584
|
+
"items": {
|
|
585
|
+
"type": "string"
|
|
586
|
+
}
|
|
587
|
+
},
|
|
588
|
+
"supportsMediaDownload": {
|
|
589
|
+
"type": "boolean",
|
|
590
|
+
"description": "Whether this method supports media downloads."
|
|
591
|
+
},
|
|
592
|
+
"supportsMediaUpload": {
|
|
593
|
+
"type": "boolean",
|
|
594
|
+
"description": "Whether this method supports media uploads."
|
|
595
|
+
},
|
|
596
|
+
"supportsSubscription": {
|
|
597
|
+
"type": "boolean",
|
|
598
|
+
"description": "Whether this method supports subscriptions."
|
|
599
|
+
},
|
|
600
|
+
"useMediaDownloadService": {
|
|
601
|
+
"type": "boolean",
|
|
602
|
+
"description": "Indicates that downloads from this method should use the download service URL (i.e. \"/download\"). Only applies if the method supports media download."
|
|
603
|
+
}
|
|
604
|
+
}
|
|
605
|
+
},
|
|
606
|
+
"RestResource": {
|
|
607
|
+
"id": "RestResource",
|
|
608
|
+
"type": "object",
|
|
609
|
+
"properties": {
|
|
610
|
+
"methods": {
|
|
611
|
+
"type": "object",
|
|
612
|
+
"description": "Methods on this resource.",
|
|
613
|
+
"additionalProperties": {
|
|
614
|
+
"$ref": "RestMethod",
|
|
615
|
+
"description": "Description for any methods on this resource."
|
|
616
|
+
}
|
|
617
|
+
},
|
|
618
|
+
"resources": {
|
|
619
|
+
"type": "object",
|
|
620
|
+
"description": "Sub-resources on this resource.",
|
|
621
|
+
"additionalProperties": {
|
|
622
|
+
"$ref": "RestResource",
|
|
623
|
+
"description": "Description for any sub-resources on this resource."
|
|
624
|
+
}
|
|
625
|
+
}
|
|
626
|
+
}
|
|
627
|
+
}
|
|
628
|
+
},
|
|
629
|
+
"resources": {
|
|
630
|
+
"apis": {
|
|
631
|
+
"methods": {
|
|
632
|
+
"getRest": {
|
|
633
|
+
"id": "discovery.apis.getRest",
|
|
634
|
+
"path": "apis/{api}/{version}/rest",
|
|
635
|
+
"httpMethod": "GET",
|
|
636
|
+
"description": "Retrieve the description of a particular version of an api.",
|
|
637
|
+
"parameters": {
|
|
638
|
+
"api": {
|
|
639
|
+
"type": "string",
|
|
640
|
+
"description": "The name of the API.",
|
|
641
|
+
"required": true,
|
|
642
|
+
"location": "path"
|
|
643
|
+
},
|
|
644
|
+
"version": {
|
|
645
|
+
"type": "string",
|
|
646
|
+
"description": "The version of the API.",
|
|
647
|
+
"required": true,
|
|
648
|
+
"location": "path"
|
|
649
|
+
}
|
|
650
|
+
},
|
|
651
|
+
"parameterOrder": [
|
|
652
|
+
"api",
|
|
653
|
+
"version"
|
|
654
|
+
],
|
|
655
|
+
"response": {
|
|
656
|
+
"$ref": "RestDescription"
|
|
657
|
+
}
|
|
658
|
+
},
|
|
659
|
+
"list": {
|
|
660
|
+
"id": "discovery.apis.list",
|
|
661
|
+
"path": "apis",
|
|
662
|
+
"httpMethod": "GET",
|
|
663
|
+
"description": "Retrieve the list of APIs supported at this endpoint.",
|
|
664
|
+
"parameters": {
|
|
665
|
+
"name": {
|
|
666
|
+
"type": "string",
|
|
667
|
+
"description": "Only include APIs with the given name.",
|
|
668
|
+
"location": "query"
|
|
669
|
+
},
|
|
670
|
+
"preferred": {
|
|
671
|
+
"type": "boolean",
|
|
672
|
+
"description": "Return only the preferred version of an API.",
|
|
673
|
+
"default": "false",
|
|
674
|
+
"location": "query"
|
|
675
|
+
}
|
|
676
|
+
},
|
|
677
|
+
"response": {
|
|
678
|
+
"$ref": "DirectoryList"
|
|
679
|
+
}
|
|
680
|
+
}
|
|
681
|
+
}
|
|
682
|
+
}
|
|
683
|
+
}
|
|
684
|
+
}
|