Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(126)

Side by Side Diff: discovery/googleapis/firebaserules__v1.json

Issue 2734843002: Api-roll 46: 2017-03-06 (Closed)
Patch Set: Created 3 years, 9 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
1 { 1 {
2 "auth": { 2 "auth": {
3 "oauth2": { 3 "oauth2": {
4 "scopes": { 4 "scopes": {
5 "https://www.googleapis.com/auth/cloud-platform": { 5 "https://www.googleapis.com/auth/cloud-platform": {
6 "description": "View and manage your data across Google Clou d Platform services" 6 "description": "View and manage your data across Google Clou d Platform services"
7 }, 7 },
8 "https://www.googleapis.com/auth/firebase": { 8 "https://www.googleapis.com/auth/firebase": {
9 "description": "View and administer all your Firebase data a nd settings" 9 "description": "View and administer all your Firebase data a nd settings"
10 }, 10 },
(...skipping 13 matching lines...) Expand all
24 "icons": { 24 "icons": {
25 "x16": "http://www.google.com/images/icons/product/search-16.gif", 25 "x16": "http://www.google.com/images/icons/product/search-16.gif",
26 "x32": "http://www.google.com/images/icons/product/search-32.gif" 26 "x32": "http://www.google.com/images/icons/product/search-32.gif"
27 }, 27 },
28 "id": "firebaserules:v1", 28 "id": "firebaserules:v1",
29 "kind": "discovery#restDescription", 29 "kind": "discovery#restDescription",
30 "name": "firebaserules", 30 "name": "firebaserules",
31 "ownerDomain": "google.com", 31 "ownerDomain": "google.com",
32 "ownerName": "Google", 32 "ownerName": "Google",
33 "parameters": { 33 "parameters": {
34 "quotaUser": {
35 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.",
36 "location": "query",
37 "type": "string"
38 },
39 "pp": {
40 "default": "true",
41 "description": "Pretty-print response.",
42 "location": "query",
43 "type": "boolean"
44 },
45 "bearer_token": {
46 "description": "OAuth bearer token.",
47 "location": "query",
48 "type": "string"
49 },
50 "oauth_token": {
51 "description": "OAuth 2.0 token for the current user.",
52 "location": "query",
53 "type": "string"
54 },
55 "upload_protocol": { 34 "upload_protocol": {
56 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").", 35 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
57 "location": "query", 36 "location": "query",
58 "type": "string" 37 "type": "string"
59 }, 38 },
60 "prettyPrint": { 39 "prettyPrint": {
61 "default": "true", 40 "default": "true",
62 "description": "Returns response with indentations and line breaks." , 41 "description": "Returns response with indentations and line breaks." ,
63 "location": "query", 42 "location": "query",
64 "type": "boolean" 43 "type": "boolean"
(...skipping 44 matching lines...) Expand 10 before | Expand all | Expand 10 after
109 }, 88 },
110 "access_token": { 89 "access_token": {
111 "description": "OAuth access token.", 90 "description": "OAuth access token.",
112 "location": "query", 91 "location": "query",
113 "type": "string" 92 "type": "string"
114 }, 93 },
115 "key": { 94 "key": {
116 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.", 95 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.",
117 "location": "query", 96 "location": "query",
118 "type": "string" 97 "type": "string"
98 },
99 "quotaUser": {
100 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.",
101 "location": "query",
102 "type": "string"
103 },
104 "pp": {
105 "default": "true",
106 "description": "Pretty-print response.",
107 "location": "query",
108 "type": "boolean"
109 },
110 "bearer_token": {
111 "description": "OAuth bearer token.",
112 "location": "query",
113 "type": "string"
114 },
115 "oauth_token": {
116 "description": "OAuth 2.0 token for the current user.",
117 "location": "query",
118 "type": "string"
119 } 119 }
120 }, 120 },
121 "protocol": "rest", 121 "protocol": "rest",
122 "resources": { 122 "resources": {
123 "projects": { 123 "projects": {
124 "methods": { 124 "methods": {
125 "test": { 125 "test": {
126 "description": "Test `Source` for syntactic and semantic cor rectness. Issues present in the\nrules, if any, will be returned to the caller w ith a description, severity,\nand source location.\n\nThe test method will typic ally be executed with a developer provided\n`Source`, but if regression testing is desired, this method may be\nexecuted against a `Ruleset` resource name and t he `Source` will be\nretrieved from the persisted `Ruleset`.\n\nThe following is an example of `Source` that permits users to upload images\nto a bucket bearing their user id and matching the correct metadata:\n\n_*Example*_\n\n // Users are allowed to subscribe and unsubscribe to the blog.\n service firebase.sto rage {\n match /users/{userId}/images/{imageName} {\n allow write: if userId == request.userId\n && (imageName.endsWith('.png') || im ageName.endsWith('.jpg'))\n && resource.mimeType.startsWith('image/ ')\n }\n }", 126 "description": "Test `Source` for syntactic and semantic cor rectness. Issues present in the\nrules, if any, will be returned to the caller w ith a description, severity,\nand source location.\n\nThe test method will typic ally be executed with a developer provided\n`Source`, but if regression testing is desired, this method may be\nexecuted against a `Ruleset` resource name and t he `Source` will be\nretrieved from the persisted `Ruleset`.\n\nThe following is an example of `Source` that permits users to upload images\nto a bucket bearing their user id and matching the correct metadata:\n\n_*Example*_\n\n // Users are allowed to subscribe and unsubscribe to the blog.\n service firebase.sto rage {\n match /users/{userId}/images/{imageName} {\n allow write: if userId == request.userId\n && (imageName.endsWith('.png') || im ageName.endsWith('.jpg'))\n && resource.mimeType.startsWith('image/ ')\n }\n }",
127 "httpMethod": "POST", 127 "httpMethod": "POST",
128 "id": "firebaserules.projects.test", 128 "id": "firebaserules.projects.test",
(...skipping 19 matching lines...) Expand all
148 "scopes": [ 148 "scopes": [
149 "https://www.googleapis.com/auth/cloud-platform", 149 "https://www.googleapis.com/auth/cloud-platform",
150 "https://www.googleapis.com/auth/firebase", 150 "https://www.googleapis.com/auth/firebase",
151 "https://www.googleapis.com/auth/firebase.readonly" 151 "https://www.googleapis.com/auth/firebase.readonly"
152 ] 152 ]
153 } 153 }
154 }, 154 },
155 "resources": { 155 "resources": {
156 "rulesets": { 156 "rulesets": {
157 "methods": { 157 "methods": {
158 "create": {
159 "description": "Create a `Ruleset` from `Source`.\n\ nThe `Ruleset` is given a unique generated name which is returned to the\ncaller . `Source` containing syntactic or semantics errors will result in an\nerror res ponse indicating the first error encountered. For a detailed view\nof `Source` i ssues, use TestRuleset.",
160 "httpMethod": "POST",
161 "id": "firebaserules.projects.rulesets.create",
162 "parameterOrder": [
163 "name"
164 ],
165 "parameters": {
166 "name": {
167 "description": "Resource name for Project wh ich owns this `Ruleset`.\n\nFormat: `projects/{project_id}`",
168 "location": "path",
169 "pattern": "^projects/[^/]+$",
170 "required": true,
171 "type": "string"
172 }
173 },
174 "path": "v1/{+name}/rulesets",
175 "request": {
176 "$ref": "Ruleset"
177 },
178 "response": {
179 "$ref": "Ruleset"
180 },
181 "scopes": [
182 "https://www.googleapis.com/auth/cloud-platform" ,
183 "https://www.googleapis.com/auth/firebase"
184 ]
185 },
158 "delete": { 186 "delete": {
159 "description": "Delete a `Ruleset` by resource name. \n\nIf the `Ruleset` is referenced by a `Release` the operation will fail.", 187 "description": "Delete a `Ruleset` by resource name. \n\nIf the `Ruleset` is referenced by a `Release` the operation will fail.",
160 "httpMethod": "DELETE", 188 "httpMethod": "DELETE",
161 "id": "firebaserules.projects.rulesets.delete", 189 "id": "firebaserules.projects.rulesets.delete",
162 "parameterOrder": [ 190 "parameterOrder": [
163 "name" 191 "name"
164 ], 192 ],
165 "parameters": { 193 "parameters": {
166 "name": { 194 "name": {
167 "description": "Resource name for the rulese t to delete.\n\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`", 195 "description": "Resource name for the rulese t to delete.\n\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`",
(...skipping 67 matching lines...) Expand 10 before | Expand all | Expand 10 after
235 }, 263 },
236 "path": "v1/{+name}/rulesets", 264 "path": "v1/{+name}/rulesets",
237 "response": { 265 "response": {
238 "$ref": "ListRulesetsResponse" 266 "$ref": "ListRulesetsResponse"
239 }, 267 },
240 "scopes": [ 268 "scopes": [
241 "https://www.googleapis.com/auth/cloud-platform" , 269 "https://www.googleapis.com/auth/cloud-platform" ,
242 "https://www.googleapis.com/auth/firebase", 270 "https://www.googleapis.com/auth/firebase",
243 "https://www.googleapis.com/auth/firebase.readon ly" 271 "https://www.googleapis.com/auth/firebase.readon ly"
244 ] 272 ]
245 },
246 "create": {
247 "description": "Create a `Ruleset` from `Source`.\n\ nThe `Ruleset` is given a unique generated name which is returned to the\ncaller . `Source` containing syntactic or semantics errors will result in an\nerror res ponse indicating the first error encountered. For a detailed view\nof `Source` i ssues, use TestRuleset.",
248 "httpMethod": "POST",
249 "id": "firebaserules.projects.rulesets.create",
250 "parameterOrder": [
251 "name"
252 ],
253 "parameters": {
254 "name": {
255 "description": "Resource name for Project wh ich owns this `Ruleset`.\n\nFormat: `projects/{project_id}`",
256 "location": "path",
257 "pattern": "^projects/[^/]+$",
258 "required": true,
259 "type": "string"
260 }
261 },
262 "path": "v1/{+name}/rulesets",
263 "request": {
264 "$ref": "Ruleset"
265 },
266 "response": {
267 "$ref": "Ruleset"
268 },
269 "scopes": [
270 "https://www.googleapis.com/auth/cloud-platform" ,
271 "https://www.googleapis.com/auth/firebase"
272 ]
273 } 273 }
274 } 274 }
275 }, 275 },
276 "releases": { 276 "releases": {
277 "methods": { 277 "methods": {
278 "get": { 278 "update": {
279 "description": "Get a `Release` by name.", 279 "description": "Update a `Release`.\n\nOnly updates to the `ruleset_name` field will be honored. `Release` rename\nis not supported. To create a `Release` use the CreateRelease method\ninstead.",
280 "httpMethod": "GET", 280 "httpMethod": "PUT",
281 "id": "firebaserules.projects.releases.get", 281 "id": "firebaserules.projects.releases.update",
282 "parameterOrder": [ 282 "parameterOrder": [
283 "name" 283 "name"
284 ], 284 ],
285 "parameters": { 285 "parameters": {
286 "name": { 286 "name": {
287 "description": "Resource name of the `Releas e`.\n\n\nFormat: `projects/{project_id}/releases/{release_id}`", 287 "description": "Resource name for the `Relea se`.\n\n`Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`\ nwhich affords developers a great deal of flexibility in mapping the name\nto th e style that best fits their existing development practices. For\nexample, a nam e could refer to an environment, an app, a version, or some\ncombination of thre e.\n\nIn the table below, for the project name `projects/foo`, the following\nre lative release paths show how flat and structured names might be chosen\nto matc h a desired development / deployment strategy.\n\nUse Case | Flat Name | Structured Name\n-------------|---------------------|----------------\nEn vironments | releases/qa | releases/qa\nApps | releases/app1_qa | releases/app1/qa\nVersions | releases/app1_v2_qa | releases/app1/v2/qa\ n\nThe delimiter between the release name path elements can be almost anything\n and it should work equally well with the release name list filter, but in\nmany ways the structured paths provide a clearer picture of the\nrelationship between `Release` instances.\n\nFormat: `projects/{project_id}/releases/{release_id}`",
288 "location": "path", 288 "location": "path",
289 "pattern": "^projects/[^/]+/releases/.+$", 289 "pattern": "^projects/[^/]+/releases/.+$",
290 "required": true, 290 "required": true,
291 "type": "string" 291 "type": "string"
292 } 292 }
293 }, 293 },
294 "path": "v1/{+name}", 294 "path": "v1/{+name}",
295 "request": {
296 "$ref": "Release"
297 },
295 "response": { 298 "response": {
296 "$ref": "Release" 299 "$ref": "Release"
297 }, 300 },
298 "scopes": [ 301 "scopes": [
299 "https://www.googleapis.com/auth/cloud-platform" , 302 "https://www.googleapis.com/auth/cloud-platform" ,
300 "https://www.googleapis.com/auth/firebase", 303 "https://www.googleapis.com/auth/firebase"
301 "https://www.googleapis.com/auth/firebase.readon ly"
302 ] 304 ]
303 }, 305 },
304 "list": { 306 "create": {
305 "description": "List the `Release` values for a proj ect. This list may optionally be\nfiltered by `Release` name or `Ruleset` id or both.", 307 "description": "Create a `Release`.\n\nRelease names should reflect the developer's deployment practices. For\nexample, the release name may include the environment name, application\nname, application version, o r any other name meaningful to the developer.\nOnce a `Release` refers to a `Rul eset`, the rules can be enforced by\nFirebase Rules-enabled services.\n\nMore th an one `Release` may be 'live' concurrently. Consider the following\nthree `Rele ase` names for `projects/foo` and the `Ruleset` to which they\nrefer.\n\nRelease Name | Ruleset Name\n--------------------------------|------ -------\nprojects/foo/releases/prod | projects/foo/rulesets/uuid123\nprojec ts/foo/releases/prod/beta | projects/foo/rulesets/uuid123\nprojects/foo/releases /prod/v23 | projects/foo/rulesets/uuid456\n\nThe table reflects the `Ruleset` r ollout in progress. The `prod` and\n`prod/beta` releases refer to the same `Rule set`. However, `prod/v23`\nrefers to a new `Ruleset`. The `Ruleset` reference fo r a `Release` may be\nupdated using the UpdateRelease method, and the custom `Re lease` name\nmay be referenced by specifying the `X-Firebase-Rules-Release-Name` header.",
306 "httpMethod": "GET", 308 "httpMethod": "POST",
307 "id": "firebaserules.projects.releases.list", 309 "id": "firebaserules.projects.releases.create",
308 "parameterOrder": [ 310 "parameterOrder": [
309 "name" 311 "name"
310 ], 312 ],
311 "parameters": { 313 "parameters": {
312 "name": { 314 "name": {
313 "description": "Resource name for the projec t.\n\nFormat: `projects/{project_id}`", 315 "description": "Resource name for the projec t which owns this `Release`.\n\nFormat: `projects/{project_id}`",
314 "location": "path", 316 "location": "path",
315 "pattern": "^projects/[^/]+$", 317 "pattern": "^projects/[^/]+$",
316 "required": true, 318 "required": true,
317 "type": "string" 319 "type": "string"
318 },
319 "pageToken": {
320 "description": "Next page token for the next batch of `Release` instances.",
321 "location": "query",
322 "type": "string"
323 },
324 "pageSize": {
325 "description": "Page size to load. Maximum o f 100. Defaults to 10.\nNote: `page_size` is just a hint and the service may cho ose to load less\nthan `page_size` due to the size of the output. To traverse al l of the\nreleases, caller should iterate until the `page_token` is empty.",
326 "format": "int32",
327 "location": "query",
328 "type": "integer"
329 },
330 "filter": {
331 "description": "`Release` filter. The list m ethod supports filters with restrictions on the\n`Release` `name` and also on th e `Ruleset` `ruleset_name`.\n\nExample 1) A filter of 'name=prod*' might return `Release`s with names\nwithin 'projects/foo' prefixed with 'prod':\n\nName | Ruleset Name\n------------------------------|------------- \nprojects/foo/releases/prod | projects/foo/rulesets/uuid1234\nprojects/foo/r eleases/prod/v1 | projects/foo/rulesets/uuid1234\nprojects/foo/releases/prod/v2 | projects/foo/rulesets/uuid8888\n\nExample 2) A filter of `name=prod* ruleset_n ame=uuid1234` would return only\n`Release` instances for 'projects/foo' with nam es prefixed with 'prod'\nreferring to the same `Ruleset` name of 'uuid1234':\n\n Name | Ruleset Name\n------------------------------|--- ----------\nprojects/foo/releases/prod | projects/foo/rulesets/1234\nprojects /foo/releases/prod/v1 | projects/foo/rulesets/1234\n\nIn the examples, the filte r parameters refer to the search filters for\nrelease and ruleset names are rela tive to the project releases and rulesets\ncollections. Fully qualified prefixed may also be used. e.g.\n`name=projects/foo/releases/prod* ruleset_name=projects /foo/rulesets/uuid1`",
332 "location": "query",
333 "type": "string"
334 } 320 }
335 }, 321 },
336 "path": "v1/{+name}/releases", 322 "path": "v1/{+name}/releases",
323 "request": {
324 "$ref": "Release"
325 },
337 "response": { 326 "response": {
338 "$ref": "ListReleasesResponse" 327 "$ref": "Release"
339 }, 328 },
340 "scopes": [ 329 "scopes": [
341 "https://www.googleapis.com/auth/cloud-platform" , 330 "https://www.googleapis.com/auth/cloud-platform" ,
342 "https://www.googleapis.com/auth/firebase", 331 "https://www.googleapis.com/auth/firebase"
343 "https://www.googleapis.com/auth/firebase.readon ly"
344 ] 332 ]
345 }, 333 },
346 "update": { 334 "delete": {
347 "description": "Update a `Release`.\n\nOnly updates to the `ruleset_name` field will be honored. `Release` rename\nis not supported. To create a `Release` use the CreateRelease method\ninstead.", 335 "description": "Delete a `Release` by resource name. ",
348 "httpMethod": "PUT", 336 "httpMethod": "DELETE",
349 "id": "firebaserules.projects.releases.update", 337 "id": "firebaserules.projects.releases.delete",
350 "parameterOrder": [ 338 "parameterOrder": [
351 "name" 339 "name"
352 ], 340 ],
353 "parameters": { 341 "parameters": {
354 "name": { 342 "name": {
355 "description": "Resource name for the `Relea se`.\n\n`Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`\ nwhich affords developers a great deal of flexibility in mapping the name\nto th e style that best fits their existing development practices. For\nexample, a nam e could refer to an environment, an app, a version, or some\ncombination of thre e.\n\nIn the table below, for the project name `projects/foo`, the following\nre lative release paths show how flat and structured names might be chosen\nto matc h a desired development / deployment strategy.\n\nUse Case | Flat Name | Structured Name\n-------------|---------------------|----------------\nEn vironments | releases/qa | releases/qa\nApps | releases/app1_qa | releases/app1/qa\nVersions | releases/app1_v2_qa | releases/app1/v2/qa\ n\nThe delimiter between the release name path elements can be almost anything\n and it should work equally well with the release name list filter, but in\nmany ways the structured paths provide a clearer picture of the\nrelationship between `Release` instances.\n\nFormat: `projects/{project_id}/releases/{release_id}`", 343 "description": "Resource name for the `Relea se` to delete.\n\nFormat: `projects/{project_id}/releases/{release_id}`",
356 "location": "path", 344 "location": "path",
357 "pattern": "^projects/[^/]+/releases/.+$", 345 "pattern": "^projects/[^/]+/releases/.+$",
358 "required": true, 346 "required": true,
359 "type": "string" 347 "type": "string"
360 } 348 }
361 }, 349 },
362 "path": "v1/{+name}", 350 "path": "v1/{+name}",
363 "request": {
364 "$ref": "Release"
365 },
366 "response": {
367 "$ref": "Release"
368 },
369 "scopes": [
370 "https://www.googleapis.com/auth/cloud-platform" ,
371 "https://www.googleapis.com/auth/firebase"
372 ]
373 },
374 "create": {
375 "description": "Create a `Release`.\n\nRelease names should reflect the developer's deployment practices. For\nexample, the release name may include the environment name, application\nname, application version, o r any other name meaningful to the developer.\nOnce a `Release` refers to a `Rul eset`, the rules can be enforced by\nFirebase Rules-enabled services.\n\nMore th an one `Release` may be 'live' concurrently. Consider the following\nthree `Rele ase` names for `projects/foo` and the `Ruleset` to which they\nrefer.\n\nRelease Name | Ruleset Name\n--------------------------------|------ -------\nprojects/foo/releases/prod | projects/foo/rulesets/uuid123\nprojec ts/foo/releases/prod/beta | projects/foo/rulesets/uuid123\nprojects/foo/releases /prod/v23 | projects/foo/rulesets/uuid456\n\nThe table reflects the `Ruleset` r ollout in progress. The `prod` and\n`prod/beta` releases refer to the same `Rule set`. However, `prod/v23`\nrefers to a new `Ruleset`. The `Ruleset` reference fo r a `Release` may be\nupdated using the UpdateRelease method, and the custom `Re lease` name\nmay be referenced by specifying the `X-Firebase-Rules-Release-Name` header.",
376 "httpMethod": "POST",
377 "id": "firebaserules.projects.releases.create",
378 "parameterOrder": [
379 "name"
380 ],
381 "parameters": {
382 "name": {
383 "description": "Resource name for the projec t which owns this `Release`.\n\nFormat: `projects/{project_id}`",
384 "location": "path",
385 "pattern": "^projects/[^/]+$",
386 "required": true,
387 "type": "string"
388 }
389 },
390 "path": "v1/{+name}/releases",
391 "request": {
392 "$ref": "Release"
393 },
394 "response": {
395 "$ref": "Release"
396 },
397 "scopes": [
398 "https://www.googleapis.com/auth/cloud-platform" ,
399 "https://www.googleapis.com/auth/firebase"
400 ]
401 },
402 "delete": {
403 "description": "Delete a `Release` by resource name. ",
404 "httpMethod": "DELETE",
405 "id": "firebaserules.projects.releases.delete",
406 "parameterOrder": [
407 "name"
408 ],
409 "parameters": {
410 "name": {
411 "description": "Resource name for the `Relea se` to delete.\n\nFormat: `projects/{project_id}/releases/{release_id}`",
412 "location": "path",
413 "pattern": "^projects/[^/]+/releases/.+$",
414 "required": true,
415 "type": "string"
416 }
417 },
418 "path": "v1/{+name}",
419 "response": { 351 "response": {
420 "$ref": "Empty" 352 "$ref": "Empty"
421 }, 353 },
422 "scopes": [ 354 "scopes": [
423 "https://www.googleapis.com/auth/cloud-platform" , 355 "https://www.googleapis.com/auth/cloud-platform" ,
424 "https://www.googleapis.com/auth/firebase" 356 "https://www.googleapis.com/auth/firebase"
425 ] 357 ]
358 },
359 "get": {
360 "description": "Get a `Release` by name.",
361 "httpMethod": "GET",
362 "id": "firebaserules.projects.releases.get",
363 "parameterOrder": [
364 "name"
365 ],
366 "parameters": {
367 "name": {
368 "description": "Resource name of the `Releas e`.\n\n\nFormat: `projects/{project_id}/releases/{release_id}`",
369 "location": "path",
370 "pattern": "^projects/[^/]+/releases/.+$",
371 "required": true,
372 "type": "string"
373 }
374 },
375 "path": "v1/{+name}",
376 "response": {
377 "$ref": "Release"
378 },
379 "scopes": [
380 "https://www.googleapis.com/auth/cloud-platform" ,
381 "https://www.googleapis.com/auth/firebase",
382 "https://www.googleapis.com/auth/firebase.readon ly"
383 ]
384 },
385 "list": {
386 "description": "List the `Release` values for a proj ect. This list may optionally be\nfiltered by `Release` name or `Ruleset` id or both.",
387 "httpMethod": "GET",
388 "id": "firebaserules.projects.releases.list",
389 "parameterOrder": [
390 "name"
391 ],
392 "parameters": {
393 "filter": {
394 "description": "`Release` filter. The list m ethod supports filters with restrictions on the\n`Release` `name` and also on th e `Ruleset` `ruleset_name`.\n\nExample 1) A filter of 'name=prod*' might return `Release`s with names\nwithin 'projects/foo' prefixed with 'prod':\n\nName | Ruleset Name\n------------------------------|------------- \nprojects/foo/releases/prod | projects/foo/rulesets/uuid1234\nprojects/foo/r eleases/prod/v1 | projects/foo/rulesets/uuid1234\nprojects/foo/releases/prod/v2 | projects/foo/rulesets/uuid8888\n\nExample 2) A filter of `name=prod* ruleset_n ame=uuid1234` would return only\n`Release` instances for 'projects/foo' with nam es prefixed with 'prod'\nreferring to the same `Ruleset` name of 'uuid1234':\n\n Name | Ruleset Name\n------------------------------|--- ----------\nprojects/foo/releases/prod | projects/foo/rulesets/1234\nprojects /foo/releases/prod/v1 | projects/foo/rulesets/1234\n\nIn the examples, the filte r parameters refer to the search filters for\nrelease and ruleset names are rela tive to the project releases and rulesets\ncollections. Fully qualified prefixed may also be used. e.g.\n`name=projects/foo/releases/prod* ruleset_name=projects /foo/rulesets/uuid1`",
395 "location": "query",
396 "type": "string"
397 },
398 "name": {
399 "description": "Resource name for the projec t.\n\nFormat: `projects/{project_id}`",
400 "location": "path",
401 "pattern": "^projects/[^/]+$",
402 "required": true,
403 "type": "string"
404 },
405 "pageToken": {
406 "description": "Next page token for the next batch of `Release` instances.",
407 "location": "query",
408 "type": "string"
409 },
410 "pageSize": {
411 "description": "Page size to load. Maximum o f 100. Defaults to 10.\nNote: `page_size` is just a hint and the service may cho ose to load less\nthan `page_size` due to the size of the output. To traverse al l of the\nreleases, caller should iterate until the `page_token` is empty.",
412 "format": "int32",
413 "location": "query",
414 "type": "integer"
415 }
416 },
417 "path": "v1/{+name}/releases",
418 "response": {
419 "$ref": "ListReleasesResponse"
420 },
421 "scopes": [
422 "https://www.googleapis.com/auth/cloud-platform" ,
423 "https://www.googleapis.com/auth/firebase",
424 "https://www.googleapis.com/auth/firebase.readon ly"
425 ]
426 } 426 }
427 } 427 }
428 } 428 }
429 } 429 }
430 } 430 }
431 }, 431 },
432 "revision": "20170127", 432 "revision": "20170210",
433 "rootUrl": "https://firebaserules.googleapis.com/", 433 "rootUrl": "https://firebaserules.googleapis.com/",
434 "schemas": { 434 "schemas": {
435 "TestRulesetResponse": {
436 "description": "The response for FirebaseRulesService.TestRuleset.",
437 "id": "TestRulesetResponse",
438 "properties": {
439 "issues": {
440 "description": "Syntactic and semantic `Source` issues of va rying severity. Issues of\n`ERROR` severity will prevent tests from executing.",
441 "items": {
442 "$ref": "Issue"
443 },
444 "type": "array"
445 }
446 },
447 "type": "object"
448 },
435 "ListRulesetsResponse": { 449 "ListRulesetsResponse": {
436 "description": "The response for FirebaseRulesService.ListRulesets", 450 "description": "The response for FirebaseRulesService.ListRulesets",
437 "id": "ListRulesetsResponse", 451 "id": "ListRulesetsResponse",
438 "properties": { 452 "properties": {
439 "rulesets": { 453 "rulesets": {
440 "description": "List of `Ruleset` instances.", 454 "description": "List of `Ruleset` instances.",
441 "items": { 455 "items": {
442 "$ref": "Ruleset" 456 "$ref": "Ruleset"
443 }, 457 },
444 "type": "array" 458 "type": "array"
(...skipping 37 matching lines...) Expand 10 before | Expand all | Expand 10 after
482 "format": "int32", 496 "format": "int32",
483 "type": "integer" 497 "type": "integer"
484 } 498 }
485 }, 499 },
486 "type": "object" 500 "type": "object"
487 }, 501 },
488 "Issue": { 502 "Issue": {
489 "description": "Issues include warnings, errors, and deprecation not ices.", 503 "description": "Issues include warnings, errors, and deprecation not ices.",
490 "id": "Issue", 504 "id": "Issue",
491 "properties": { 505 "properties": {
492 "description": {
493 "description": "Short error description.",
494 "type": "string"
495 },
496 "sourcePosition": { 506 "sourcePosition": {
497 "$ref": "SourcePosition", 507 "$ref": "SourcePosition",
498 "description": "Position of the issue in the `Source`." 508 "description": "Position of the issue in the `Source`."
499 }, 509 },
500 "severity": { 510 "severity": {
501 "description": "The severity of the issue.", 511 "description": "The severity of the issue.",
502 "enum": [ 512 "enum": [
503 "SEVERITY_UNSPECIFIED", 513 "SEVERITY_UNSPECIFIED",
504 "DEPRECATION", 514 "DEPRECATION",
505 "WARNING", 515 "WARNING",
506 "ERROR" 516 "ERROR"
507 ], 517 ],
508 "enumDescriptions": [ 518 "enumDescriptions": [
509 "An unspecified severity.", 519 "An unspecified severity.",
510 "Deprecation issue for statements and method that may no longer be\nsupported or maintained.", 520 "Deprecation issue for statements and method that may no longer be\nsupported or maintained.",
511 "Warnings such as: unused variables.", 521 "Warnings such as: unused variables.",
512 "Errors such as: unmatched curly braces or variable rede finition." 522 "Errors such as: unmatched curly braces or variable rede finition."
513 ], 523 ],
514 "type": "string" 524 "type": "string"
525 },
526 "description": {
527 "description": "Short error description.",
528 "type": "string"
515 } 529 }
516 }, 530 },
517 "type": "object" 531 "type": "object"
518 }, 532 },
519 "TestRulesetRequest": { 533 "TestRulesetRequest": {
520 "description": "The request for FirebaseRulesService.TestRuleset.", 534 "description": "The request for FirebaseRulesService.TestRuleset.",
521 "id": "TestRulesetRequest", 535 "id": "TestRulesetRequest",
522 "properties": { 536 "properties": {
523 "source": { 537 "source": {
524 "$ref": "Source", 538 "$ref": "Source",
525 "description": "`Source` to be checked for correctness." 539 "description": "`Source` to be checked for correctness."
526 } 540 }
527 }, 541 },
528 "type": "object" 542 "type": "object"
529 }, 543 },
530 "Ruleset": { 544 "Ruleset": {
531 "description": "`Ruleset` is an immutable copy of `Source` with a gl obally unique identifier\nand a creation time.", 545 "description": "`Ruleset` is an immutable copy of `Source` with a gl obally unique identifier\nand a creation time.",
532 "id": "Ruleset", 546 "id": "Ruleset",
533 "properties": { 547 "properties": {
534 "createTime": {
535 "description": "Time the `Ruleset` was created.\n@OutputOnly ",
536 "format": "google-datetime",
537 "type": "string"
538 },
539 "name": { 548 "name": {
540 "description": "Name of the `Ruleset`. The ruleset_id is aut o generated by the service.\nFormat: `projects/{project_id}/rulesets/{ruleset_id }`\n@OutputOnly", 549 "description": "Name of the `Ruleset`. The ruleset_id is aut o generated by the service.\nFormat: `projects/{project_id}/rulesets/{ruleset_id }`\n@OutputOnly",
541 "type": "string" 550 "type": "string"
542 }, 551 },
543 "source": { 552 "source": {
544 "$ref": "Source", 553 "$ref": "Source",
545 "description": "`Source` for the `Ruleset`." 554 "description": "`Source` for the `Ruleset`."
555 },
556 "createTime": {
557 "description": "Time the `Ruleset` was created.\n@OutputOnly ",
558 "format": "google-datetime",
559 "type": "string"
546 } 560 }
547 }, 561 },
548 "type": "object" 562 "type": "object"
549 }, 563 },
550 "Empty": { 564 "Empty": {
551 "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use i t as the request\nor the response type of an API method. For instance:\n\n se rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty );\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", 565 "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use i t as the request\nor the response type of an API method. For instance:\n\n se rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty );\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
552 "id": "Empty", 566 "id": "Empty",
553 "properties": {}, 567 "properties": {},
554 "type": "object" 568 "type": "object"
555 }, 569 },
556 "File": {
557 "description": "`File` containing source content.",
558 "id": "File",
559 "properties": {
560 "name": {
561 "description": "File name.",
562 "type": "string"
563 },
564 "content": {
565 "description": "Textual Content.",
566 "type": "string"
567 },
568 "fingerprint": {
569 "description": "Fingerprint (e.g. github sha) associated wit h the `File`.",
570 "format": "byte",
571 "type": "string"
572 }
573 },
574 "type": "object"
575 },
576 "ListReleasesResponse": { 570 "ListReleasesResponse": {
577 "description": "The response for FirebaseRulesService.ListReleases." , 571 "description": "The response for FirebaseRulesService.ListReleases." ,
578 "id": "ListReleasesResponse", 572 "id": "ListReleasesResponse",
579 "properties": { 573 "properties": {
580 "releases": { 574 "releases": {
581 "description": "List of `Release` instances.", 575 "description": "List of `Release` instances.",
582 "items": { 576 "items": {
583 "$ref": "Release" 577 "$ref": "Release"
584 }, 578 },
585 "type": "array" 579 "type": "array"
586 }, 580 },
587 "nextPageToken": { 581 "nextPageToken": {
588 "description": "The pagination token to retrieve the next pa ge of results. If the value is\nempty, no further results remain.", 582 "description": "The pagination token to retrieve the next pa ge of results. If the value is\nempty, no further results remain.",
589 "type": "string" 583 "type": "string"
590 } 584 }
591 }, 585 },
592 "type": "object" 586 "type": "object"
593 }, 587 },
588 "File": {
589 "description": "`File` containing source content.",
590 "id": "File",
591 "properties": {
592 "fingerprint": {
593 "description": "Fingerprint (e.g. github sha) associated wit h the `File`.",
594 "format": "byte",
595 "type": "string"
596 },
597 "name": {
598 "description": "File name.",
599 "type": "string"
600 },
601 "content": {
602 "description": "Textual Content.",
603 "type": "string"
604 }
605 },
606 "type": "object"
607 },
594 "Release": { 608 "Release": {
595 "description": "`Release` is a named reference to a `Ruleset`. Once a `Release` refers to a\n`Ruleset`, rules-enabled services will be able to enfor ce the `Ruleset`.", 609 "description": "`Release` is a named reference to a `Ruleset`. Once a `Release` refers to a\n`Ruleset`, rules-enabled services will be able to enfor ce the `Ruleset`.",
596 "id": "Release", 610 "id": "Release",
597 "properties": { 611 "properties": {
598 "createTime": { 612 "createTime": {
599 "description": "Time the release was created.\n@OutputOnly", 613 "description": "Time the release was created.\n@OutputOnly",
600 "format": "google-datetime", 614 "format": "google-datetime",
601 "type": "string" 615 "type": "string"
602 }, 616 },
603 "updateTime": { 617 "updateTime": {
604 "description": "Time the release was updated.\n@OutputOnly", 618 "description": "Time the release was updated.\n@OutputOnly",
605 "format": "google-datetime", 619 "format": "google-datetime",
606 "type": "string" 620 "type": "string"
607 }, 621 },
608 "name": { 622 "name": {
609 "description": "Resource name for the `Release`.\n\n`Release ` names may be structured `app1/prod/v2` or flat `app1_prod_v2`\nwhich affords d evelopers a great deal of flexibility in mapping the name\nto the style that bes t fits their existing development practices. For\nexample, a name could refer to an environment, an app, a version, or some\ncombination of three.\n\nIn the tab le below, for the project name `projects/foo`, the following\nrelative release p aths show how flat and structured names might be chosen\nto match a desired deve lopment / deployment strategy.\n\nUse Case | Flat Name | Structure d Name\n-------------|---------------------|----------------\nEnvironments | rel eases/qa | releases/qa\nApps | releases/app1_qa | releases/ap p1/qa\nVersions | releases/app1_v2_qa | releases/app1/v2/qa\n\nThe delimiter between the release name path elements can be almost anything\nand it should wo rk equally well with the release name list filter, but in\nmany ways the structu red paths provide a clearer picture of the\nrelationship between `Release` insta nces.\n\nFormat: `projects/{project_id}/releases/{release_id}`", 623 "description": "Resource name for the `Release`.\n\n`Release ` names may be structured `app1/prod/v2` or flat `app1_prod_v2`\nwhich affords d evelopers a great deal of flexibility in mapping the name\nto the style that bes t fits their existing development practices. For\nexample, a name could refer to an environment, an app, a version, or some\ncombination of three.\n\nIn the tab le below, for the project name `projects/foo`, the following\nrelative release p aths show how flat and structured names might be chosen\nto match a desired deve lopment / deployment strategy.\n\nUse Case | Flat Name | Structure d Name\n-------------|---------------------|----------------\nEnvironments | rel eases/qa | releases/qa\nApps | releases/app1_qa | releases/ap p1/qa\nVersions | releases/app1_v2_qa | releases/app1/v2/qa\n\nThe delimiter between the release name path elements can be almost anything\nand it should wo rk equally well with the release name list filter, but in\nmany ways the structu red paths provide a clearer picture of the\nrelationship between `Release` insta nces.\n\nFormat: `projects/{project_id}/releases/{release_id}`",
610 "type": "string" 624 "type": "string"
611 }, 625 },
612 "rulesetName": { 626 "rulesetName": {
613 "description": "Name of the `Ruleset` referred to by this `R elease`. The `Ruleset` must\nexist the `Release` to be created.", 627 "description": "Name of the `Ruleset` referred to by this `R elease`. The `Ruleset` must\nexist the `Release` to be created.",
614 "type": "string" 628 "type": "string"
615 } 629 }
616 }, 630 },
617 "type": "object" 631 "type": "object"
618 },
619 "TestRulesetResponse": {
620 "description": "The response for FirebaseRulesService.TestRuleset.",
621 "id": "TestRulesetResponse",
622 "properties": {
623 "issues": {
624 "description": "Syntactic and semantic `Source` issues of va rying severity. Issues of\n`ERROR` severity will prevent tests from executing.",
625 "items": {
626 "$ref": "Issue"
627 },
628 "type": "array"
629 }
630 },
631 "type": "object"
632 } 632 }
633 }, 633 },
634 "servicePath": "", 634 "servicePath": "",
635 "title": "Firebase Rules API", 635 "title": "Firebase Rules API",
636 "version": "v1" 636 "version": "v1"
637 } 637 }
OLDNEW
« no previous file with comments | « discovery/googleapis/firebasedynamiclinks__v1.json ('k') | discovery/googleapis/gamesConfiguration__v1configuration.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698