Index: discovery/googleapis/firebaserules__v1.json |
diff --git a/discovery/googleapis/firebaserules__v1.json b/discovery/googleapis/firebaserules__v1.json |
index 38028c2538f44cedc011c04dbf15bd4ea0087743..1a54f33c2dd3c7f74202f35b6be8aee7324d9bb1 100644 |
--- a/discovery/googleapis/firebaserules__v1.json |
+++ b/discovery/googleapis/firebaserules__v1.json |
@@ -31,30 +31,35 @@ |
"ownerDomain": "google.com", |
"ownerName": "Google", |
"parameters": { |
- "access_token": { |
- "description": "OAuth access token.", |
+ "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" |
}, |
- "prettyPrint": { |
+ "pp": { |
"default": "true", |
- "description": "Returns response with indentations and line breaks.", |
+ "description": "Pretty-print response.", |
"location": "query", |
"type": "boolean" |
}, |
- "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.", |
+ "bearer_token": { |
+ "description": "OAuth bearer token.", |
"location": "query", |
"type": "string" |
}, |
- "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.", |
+ "oauth_token": { |
+ "description": "OAuth 2.0 token for the current user.", |
"location": "query", |
"type": "string" |
}, |
- "pp": { |
+ "upload_protocol": { |
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "prettyPrint": { |
"default": "true", |
- "description": "Pretty-print response.", |
+ "description": "Returns response with indentations and line breaks.", |
"location": "query", |
"type": "boolean" |
}, |
@@ -63,19 +68,13 @@ |
"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" |
- ], |
+ "uploadType": { |
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "callback": { |
+ "description": "JSONP", |
"location": "query", |
"type": "string" |
}, |
@@ -92,28 +91,29 @@ |
"location": "query", |
"type": "string" |
}, |
- "callback": { |
- "description": "JSONP", |
- "location": "query", |
- "type": "string" |
- }, |
- "oauth_token": { |
- "description": "OAuth 2.0 token for the current user.", |
- "location": "query", |
- "type": "string" |
- }, |
- "uploadType": { |
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", |
+ "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" |
}, |
- "bearer_token": { |
- "description": "OAuth bearer token.", |
+ "access_token": { |
+ "description": "OAuth access token.", |
"location": "query", |
"type": "string" |
}, |
- "upload_protocol": { |
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", |
+ "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" |
} |
@@ -155,28 +155,25 @@ |
"resources": { |
"rulesets": { |
"methods": { |
- "create": { |
- "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 response indicating the first error encountered. For a detailed view\nof `Source` issues, use TestRuleset.", |
- "httpMethod": "POST", |
- "id": "firebaserules.projects.rulesets.create", |
+ "delete": { |
+ "description": "Delete a `Ruleset` by resource name.\n\nIf the `Ruleset` is referenced by a `Release` the operation will fail.", |
+ "httpMethod": "DELETE", |
+ "id": "firebaserules.projects.rulesets.delete", |
"parameterOrder": [ |
"name" |
], |
"parameters": { |
"name": { |
- "description": "Resource name for Project which owns this `Ruleset`.\n\nFormat: `projects/{project_id}`", |
+ "description": "Resource name for the ruleset to delete.\n\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`", |
"location": "path", |
- "pattern": "^projects/[^/]+$", |
+ "pattern": "^projects/[^/]+/rulesets/[^/]+$", |
"required": true, |
"type": "string" |
} |
}, |
- "path": "v1/{+name}/rulesets", |
- "request": { |
- "$ref": "Ruleset" |
- }, |
+ "path": "v1/{+name}", |
"response": { |
- "$ref": "Ruleset" |
+ "$ref": "Empty" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
@@ -217,12 +214,6 @@ |
"name" |
], |
"parameters": { |
- "pageSize": { |
- "description": "Page size to load. Maximum of 100. Defaults to 10.\nNote: `page_size` is just a hint and the service may choose to load less\nthan `page_size` due to the size of the output. To traverse all of the\nreleases, caller should iterate until the `page_token` is empty.", |
- "format": "int32", |
- "location": "query", |
- "type": "integer" |
- }, |
"name": { |
"description": "Resource name for the project.\n\nFormat: `projects/{project_id}`", |
"location": "path", |
@@ -234,6 +225,12 @@ |
"description": "Next page token for loading the next batch of `Ruleset` instances.", |
"location": "query", |
"type": "string" |
+ }, |
+ "pageSize": { |
+ "description": "Page size to load. Maximum of 100. Defaults to 10.\nNote: `page_size` is just a hint and the service may choose to load less\nthan `page_size` due to the size of the output. To traverse all of the\nreleases, caller should iterate until the `page_token` is empty.", |
+ "format": "int32", |
+ "location": "query", |
+ "type": "integer" |
} |
}, |
"path": "v1/{+name}/rulesets", |
@@ -246,25 +243,28 @@ |
"https://www.googleapis.com/auth/firebase.readonly" |
] |
}, |
- "delete": { |
- "description": "Delete a `Ruleset` by resource name.\n\nIf the `Ruleset` is referenced by a `Release` the operation will fail.", |
- "httpMethod": "DELETE", |
- "id": "firebaserules.projects.rulesets.delete", |
+ "create": { |
+ "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 response indicating the first error encountered. For a detailed view\nof `Source` issues, use TestRuleset.", |
+ "httpMethod": "POST", |
+ "id": "firebaserules.projects.rulesets.create", |
"parameterOrder": [ |
"name" |
], |
"parameters": { |
"name": { |
- "description": "Resource name for the ruleset to delete.\n\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`", |
+ "description": "Resource name for Project which owns this `Ruleset`.\n\nFormat: `projects/{project_id}`", |
"location": "path", |
- "pattern": "^projects/[^/]+/rulesets/[^/]+$", |
+ "pattern": "^projects/[^/]+$", |
"required": true, |
"type": "string" |
} |
}, |
- "path": "v1/{+name}", |
+ "path": "v1/{+name}/rulesets", |
+ "request": { |
+ "$ref": "Ruleset" |
+ }, |
"response": { |
- "$ref": "Empty" |
+ "$ref": "Ruleset" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
@@ -275,16 +275,16 @@ |
}, |
"releases": { |
"methods": { |
- "update": { |
- "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.", |
- "httpMethod": "PUT", |
- "id": "firebaserules.projects.releases.update", |
+ "get": { |
+ "description": "Get a `Release` by name.", |
+ "httpMethod": "GET", |
+ "id": "firebaserules.projects.releases.get", |
"parameterOrder": [ |
"name" |
], |
"parameters": { |
"name": { |
- "description": "Resource name for the `Release`.\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 the style that best 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 table below, for the project name `projects/foo`, the following\nrelative release paths show how flat and structured names might be chosen\nto match a desired development / deployment strategy.\n\nUse Case | Flat Name | Structured Name\n-------------|---------------------|----------------\nEnvironments | 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\nand 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}`", |
+ "description": "Resource name of the `Release`.\n\n\nFormat: `projects/{project_id}/releases/{release_id}`", |
"location": "path", |
"pattern": "^projects/[^/]+/releases/.+$", |
"required": true, |
@@ -292,55 +292,67 @@ |
} |
}, |
"path": "v1/{+name}", |
- "request": { |
- "$ref": "Release" |
- }, |
"response": { |
"$ref": "Release" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
- "https://www.googleapis.com/auth/firebase" |
+ "https://www.googleapis.com/auth/firebase", |
+ "https://www.googleapis.com/auth/firebase.readonly" |
] |
}, |
- "create": { |
- "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, or any other name meaningful to the developer.\nOnce a `Release` refers to a `Ruleset`, the rules can be enforced by\nFirebase Rules-enabled services.\n\nMore than one `Release` may be 'live' concurrently. Consider the following\nthree `Release` 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\nprojects/foo/releases/prod/beta | projects/foo/rulesets/uuid123\nprojects/foo/releases/prod/v23 | projects/foo/rulesets/uuid456\n\nThe table reflects the `Ruleset` rollout in progress. The `prod` and\n`prod/beta` releases refer to the same `Ruleset`. However, `prod/v23`\nrefers to a new `Ruleset`. The `Ruleset` reference for a `Release` may be\nupdated using the UpdateRelease method, and the custom `Release` name\nmay be referenced by specifying the `X-Firebase-Rules-Release-Name` header.", |
- "httpMethod": "POST", |
- "id": "firebaserules.projects.releases.create", |
+ "list": { |
+ "description": "List the `Release` values for a project. This list may optionally be\nfiltered by `Release` name or `Ruleset` id or both.", |
+ "httpMethod": "GET", |
+ "id": "firebaserules.projects.releases.list", |
"parameterOrder": [ |
"name" |
], |
"parameters": { |
"name": { |
- "description": "Resource name for the project which owns this `Release`.\n\nFormat: `projects/{project_id}`", |
+ "description": "Resource name for the project.\n\nFormat: `projects/{project_id}`", |
"location": "path", |
"pattern": "^projects/[^/]+$", |
"required": true, |
"type": "string" |
+ }, |
+ "pageToken": { |
+ "description": "Next page token for the next batch of `Release` instances.", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "pageSize": { |
+ "description": "Page size to load. Maximum of 100. Defaults to 10.\nNote: `page_size` is just a hint and the service may choose to load less\nthan `page_size` due to the size of the output. To traverse all of the\nreleases, caller should iterate until the `page_token` is empty.", |
+ "format": "int32", |
+ "location": "query", |
+ "type": "integer" |
+ }, |
+ "filter": { |
+ "description": "`Release` filter. The list method supports filters with restrictions on the\n`Release` `name` and also on the `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/releases/prod/v1 | projects/foo/rulesets/uuid1234\nprojects/foo/releases/prod/v2 | projects/foo/rulesets/uuid8888\n\nExample 2) A filter of `name=prod* ruleset_name=uuid1234` would return only\n`Release` instances for 'projects/foo' with names prefixed with 'prod'\nreferring to the same `Ruleset` name of 'uuid1234':\n\nName | 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 filter parameters refer to the search filters for\nrelease and ruleset names are relative 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`", |
+ "location": "query", |
+ "type": "string" |
} |
}, |
"path": "v1/{+name}/releases", |
- "request": { |
- "$ref": "Release" |
- }, |
"response": { |
- "$ref": "Release" |
+ "$ref": "ListReleasesResponse" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
- "https://www.googleapis.com/auth/firebase" |
+ "https://www.googleapis.com/auth/firebase", |
+ "https://www.googleapis.com/auth/firebase.readonly" |
] |
}, |
- "get": { |
- "description": "Get a `Release` by name.", |
- "httpMethod": "GET", |
- "id": "firebaserules.projects.releases.get", |
+ "update": { |
+ "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.", |
+ "httpMethod": "PUT", |
+ "id": "firebaserules.projects.releases.update", |
"parameterOrder": [ |
"name" |
], |
"parameters": { |
"name": { |
- "description": "Resource name of the `Release`.\n\n\nFormat: `projects/{project_id}/releases/{release_id}`", |
+ "description": "Resource name for the `Release`.\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 the style that best 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 table below, for the project name `projects/foo`, the following\nrelative release paths show how flat and structured names might be chosen\nto match a desired development / deployment strategy.\n\nUse Case | Flat Name | Structured Name\n-------------|---------------------|----------------\nEnvironments | 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\nand 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}`", |
"location": "path", |
"pattern": "^projects/[^/]+/releases/.+$", |
"required": true, |
@@ -348,55 +360,43 @@ |
} |
}, |
"path": "v1/{+name}", |
+ "request": { |
+ "$ref": "Release" |
+ }, |
"response": { |
"$ref": "Release" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
- "https://www.googleapis.com/auth/firebase", |
- "https://www.googleapis.com/auth/firebase.readonly" |
+ "https://www.googleapis.com/auth/firebase" |
] |
}, |
- "list": { |
- "description": "List the `Release` values for a project. This list may optionally be\nfiltered by `Release` name or `Ruleset` id or both.", |
- "httpMethod": "GET", |
- "id": "firebaserules.projects.releases.list", |
+ "create": { |
+ "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, or any other name meaningful to the developer.\nOnce a `Release` refers to a `Ruleset`, the rules can be enforced by\nFirebase Rules-enabled services.\n\nMore than one `Release` may be 'live' concurrently. Consider the following\nthree `Release` 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\nprojects/foo/releases/prod/beta | projects/foo/rulesets/uuid123\nprojects/foo/releases/prod/v23 | projects/foo/rulesets/uuid456\n\nThe table reflects the `Ruleset` rollout in progress. The `prod` and\n`prod/beta` releases refer to the same `Ruleset`. However, `prod/v23`\nrefers to a new `Ruleset`. The `Ruleset` reference for a `Release` may be\nupdated using the UpdateRelease method, and the custom `Release` name\nmay be referenced by specifying the `X-Firebase-Rules-Release-Name` header.", |
+ "httpMethod": "POST", |
+ "id": "firebaserules.projects.releases.create", |
"parameterOrder": [ |
"name" |
], |
"parameters": { |
- "pageSize": { |
- "description": "Page size to load. Maximum of 100. Defaults to 10.\nNote: `page_size` is just a hint and the service may choose to load less\nthan `page_size` due to the size of the output. To traverse all of the\nreleases, caller should iterate until the `page_token` is empty.", |
- "format": "int32", |
- "location": "query", |
- "type": "integer" |
- }, |
- "filter": { |
- "description": "`Release` filter. The list method supports filters with restrictions on the\n`Release` `name` and also on the `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/releases/prod/v1 | projects/foo/rulesets/uuid1234\nprojects/foo/releases/prod/v2 | projects/foo/rulesets/uuid8888\n\nExample 2) A filter of `name=prod* ruleset_name=uuid1234` would return only\n`Release` instances for 'projects/foo' with names prefixed with 'prod'\nreferring to the same `Ruleset` name of 'uuid1234':\n\nName | 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 filter parameters refer to the search filters for\nrelease and ruleset names are relative 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`", |
- "location": "query", |
- "type": "string" |
- }, |
"name": { |
- "description": "Resource name for the project.\n\nFormat: `projects/{project_id}`", |
+ "description": "Resource name for the project which owns this `Release`.\n\nFormat: `projects/{project_id}`", |
"location": "path", |
"pattern": "^projects/[^/]+$", |
"required": true, |
"type": "string" |
- }, |
- "pageToken": { |
- "description": "Next page token for the next batch of `Release` instances.", |
- "location": "query", |
- "type": "string" |
} |
}, |
"path": "v1/{+name}/releases", |
+ "request": { |
+ "$ref": "Release" |
+ }, |
"response": { |
- "$ref": "ListReleasesResponse" |
+ "$ref": "Release" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
- "https://www.googleapis.com/auth/firebase", |
- "https://www.googleapis.com/auth/firebase.readonly" |
+ "https://www.googleapis.com/auth/firebase" |
] |
}, |
"delete": { |
@@ -429,29 +429,22 @@ |
} |
} |
}, |
- "revision": "20161205", |
+ "revision": "20170127", |
"rootUrl": "https://firebaserules.googleapis.com/", |
"schemas": { |
- "Release": { |
- "description": "`Release` is a named reference to a `Ruleset`. Once a `Release` refers to a\n`Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.", |
- "id": "Release", |
+ "ListRulesetsResponse": { |
+ "description": "The response for FirebaseRulesService.ListRulesets", |
+ "id": "ListRulesetsResponse", |
"properties": { |
- "updateTime": { |
- "description": "Time the release was updated.\n@OutputOnly", |
- "format": "google-datetime", |
- "type": "string" |
- }, |
- "createTime": { |
- "description": "Time the release was created.\n@OutputOnly", |
- "format": "google-datetime", |
- "type": "string" |
- }, |
- "name": { |
- "description": "Resource name for the `Release`.\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 the style that best 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 table below, for the project name `projects/foo`, the following\nrelative release paths show how flat and structured names might be chosen\nto match a desired development / deployment strategy.\n\nUse Case | Flat Name | Structured Name\n-------------|---------------------|----------------\nEnvironments | 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\nand 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}`", |
- "type": "string" |
+ "rulesets": { |
+ "description": "List of `Ruleset` instances.", |
+ "items": { |
+ "$ref": "Ruleset" |
+ }, |
+ "type": "array" |
}, |
- "rulesetName": { |
- "description": "Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must\nexist the `Release` to be created.", |
+ "nextPageToken": { |
+ "description": "The pagination token to retrieve the next page of results. If the value is\nempty, no further results remain.", |
"type": "string" |
} |
}, |
@@ -475,15 +468,15 @@ |
"description": "Position in the `Source` content including its line, column number, and an\nindex of the `File` in the `Source` message. Used for debug purposes.", |
"id": "SourcePosition", |
"properties": { |
- "fileName": { |
- "description": "Name of the `File`.", |
- "type": "string" |
- }, |
"column": { |
"description": "First column on the source line associated with the source fragment.", |
"format": "int32", |
"type": "integer" |
}, |
+ "fileName": { |
+ "description": "Name of the `File`.", |
+ "type": "string" |
+ }, |
"line": { |
"description": "Line number of the source fragment. 1-based.", |
"format": "int32", |
@@ -492,16 +485,44 @@ |
}, |
"type": "object" |
}, |
- "TestRulesetResponse": { |
- "description": "The response for FirebaseRulesService.TestRuleset.", |
- "id": "TestRulesetResponse", |
+ "Issue": { |
+ "description": "Issues include warnings, errors, and deprecation notices.", |
+ "id": "Issue", |
"properties": { |
- "issues": { |
- "description": "Syntactic and semantic `Source` issues of varying severity. Issues of\n`ERROR` severity will prevent tests from executing.", |
- "items": { |
- "$ref": "Issue" |
- }, |
- "type": "array" |
+ "description": { |
+ "description": "Short error description.", |
+ "type": "string" |
+ }, |
+ "sourcePosition": { |
+ "$ref": "SourcePosition", |
+ "description": "Position of the issue in the `Source`." |
+ }, |
+ "severity": { |
+ "description": "The severity of the issue.", |
+ "enum": [ |
+ "SEVERITY_UNSPECIFIED", |
+ "DEPRECATION", |
+ "WARNING", |
+ "ERROR" |
+ ], |
+ "enumDescriptions": [ |
+ "An unspecified severity.", |
+ "Deprecation issue for statements and method that may no longer be\nsupported or maintained.", |
+ "Warnings such as: unused variables.", |
+ "Errors such as: unmatched curly braces or variable redefinition." |
+ ], |
+ "type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "TestRulesetRequest": { |
+ "description": "The request for FirebaseRulesService.TestRuleset.", |
+ "id": "TestRulesetRequest", |
+ "properties": { |
+ "source": { |
+ "$ref": "Source", |
+ "description": "`Source` to be checked for correctness." |
} |
}, |
"type": "object" |
@@ -510,10 +531,6 @@ |
"description": "`Ruleset` is an immutable copy of `Source` with a globally unique identifier\nand a creation time.", |
"id": "Ruleset", |
"properties": { |
- "source": { |
- "$ref": "Source", |
- "description": "`Source` for the `Ruleset`." |
- }, |
"createTime": { |
"description": "Time the `Ruleset` was created.\n@OutputOnly", |
"format": "google-datetime", |
@@ -522,42 +539,10 @@ |
"name": { |
"description": "Name of the `Ruleset`. The ruleset_id is auto generated by the service.\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`\n@OutputOnly", |
"type": "string" |
- } |
- }, |
- "type": "object" |
- }, |
- "ListReleasesResponse": { |
- "description": "The response for FirebaseRulesService.ListReleases.", |
- "id": "ListReleasesResponse", |
- "properties": { |
- "nextPageToken": { |
- "description": "The pagination token to retrieve the next page of results. If the value is\nempty, no further results remain.", |
- "type": "string" |
}, |
- "releases": { |
- "description": "List of `Release` instances.", |
- "items": { |
- "$ref": "Release" |
- }, |
- "type": "array" |
- } |
- }, |
- "type": "object" |
- }, |
- "ListRulesetsResponse": { |
- "description": "The response for FirebaseRulesService.ListRulesets", |
- "id": "ListRulesetsResponse", |
- "properties": { |
- "rulesets": { |
- "description": "List of `Ruleset` instances.", |
- "items": { |
- "$ref": "Ruleset" |
- }, |
- "type": "array" |
- }, |
- "nextPageToken": { |
- "description": "The pagination token to retrieve the next page of results. If the value is\nempty, no further results remain.", |
- "type": "string" |
+ "source": { |
+ "$ref": "Source", |
+ "description": "`Source` for the `Ruleset`." |
} |
}, |
"type": "object" |
@@ -572,14 +557,14 @@ |
"description": "`File` containing source content.", |
"id": "File", |
"properties": { |
- "content": { |
- "description": "Textual Content.", |
- "type": "string" |
- }, |
"name": { |
"description": "File name.", |
"type": "string" |
}, |
+ "content": { |
+ "description": "Textual Content.", |
+ "type": "string" |
+ }, |
"fingerprint": { |
"description": "Fingerprint (e.g. github sha) associated with the `File`.", |
"format": "byte", |
@@ -588,44 +573,59 @@ |
}, |
"type": "object" |
}, |
- "TestRulesetRequest": { |
- "description": "The request for FirebaseRulesService.TestRuleset.", |
- "id": "TestRulesetRequest", |
+ "ListReleasesResponse": { |
+ "description": "The response for FirebaseRulesService.ListReleases.", |
+ "id": "ListReleasesResponse", |
"properties": { |
- "source": { |
- "$ref": "Source", |
- "description": "`Source` to be checked for correctness." |
+ "releases": { |
+ "description": "List of `Release` instances.", |
+ "items": { |
+ "$ref": "Release" |
+ }, |
+ "type": "array" |
+ }, |
+ "nextPageToken": { |
+ "description": "The pagination token to retrieve the next page of results. If the value is\nempty, no further results remain.", |
+ "type": "string" |
} |
}, |
"type": "object" |
}, |
- "Issue": { |
- "description": "Issues include warnings, errors, and deprecation notices.", |
- "id": "Issue", |
+ "Release": { |
+ "description": "`Release` is a named reference to a `Ruleset`. Once a `Release` refers to a\n`Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.", |
+ "id": "Release", |
"properties": { |
- "description": { |
- "description": "Short error description.", |
+ "createTime": { |
+ "description": "Time the release was created.\n@OutputOnly", |
+ "format": "google-datetime", |
"type": "string" |
}, |
- "severity": { |
- "description": "The severity of the issue.", |
- "enum": [ |
- "SEVERITY_UNSPECIFIED", |
- "DEPRECATION", |
- "WARNING", |
- "ERROR" |
- ], |
- "enumDescriptions": [ |
- "An unspecified severity.", |
- "Deprecation issue for statements and method that may no longer be\nsupported or maintained.", |
- "Warnings such as: unused variables.", |
- "Errors such as: unmatched curly braces or variable redefinition." |
- ], |
+ "updateTime": { |
+ "description": "Time the release was updated.\n@OutputOnly", |
+ "format": "google-datetime", |
"type": "string" |
}, |
- "sourcePosition": { |
- "$ref": "SourcePosition", |
- "description": "Position of the issue in the `Source`." |
+ "name": { |
+ "description": "Resource name for the `Release`.\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 the style that best 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 table below, for the project name `projects/foo`, the following\nrelative release paths show how flat and structured names might be chosen\nto match a desired development / deployment strategy.\n\nUse Case | Flat Name | Structured Name\n-------------|---------------------|----------------\nEnvironments | 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\nand 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}`", |
+ "type": "string" |
+ }, |
+ "rulesetName": { |
+ "description": "Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must\nexist the `Release` to be created.", |
+ "type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "TestRulesetResponse": { |
+ "description": "The response for FirebaseRulesService.TestRuleset.", |
+ "id": "TestRulesetResponse", |
+ "properties": { |
+ "issues": { |
+ "description": "Syntactic and semantic `Source` issues of varying severity. Issues of\n`ERROR` severity will prevent tests from executing.", |
+ "items": { |
+ "$ref": "Issue" |
+ }, |
+ "type": "array" |
} |
}, |
"type": "object" |