happygapi.firebaserules.projects — happygapi 0.4.8

Firebase Rules API: projects. Creates and manages rules that determine when a Firebase Rules-enabled service should permit a request. See: https://firebase.google.com/docs/storage/securityapi/reference/rest/v1/projects

releases-create$ clj

(releases-create$ auth parameters body)

https://firebase.google.com/docs/storage/securityapi/reference/rest/v1/projects/releases/create

Required parameters: name

Optional parameters: none

Body:

{:rulesetName string, :updateTime string, :name string, :createTime string}

Create a Release. Release names should reflect the developer's deployment practices. For example, the release name may include the environment name, application name, application version, or any other name meaningful to the developer. Once a Release refers to a Ruleset, the rules can be enforced by Firebase Rules-enabled services. More than one Release may be 'live' concurrently. Consider the following three Release names for projects/foo and the Ruleset to which they refer. Release Name -> Ruleset Name * projects/foo/releases/prod -> projects/foo/rulesets/uuid123 * projects/foo/releases/prod/beta -> projects/foo/rulesets/uuid123 * projects/foo/releases/prod/v23 -> projects/foo/rulesets/uuid456 The relationships reflect a Ruleset rollout in progress. The prod and prod/beta releases refer to the same Ruleset. However, prod/v23 refers to a new Ruleset. The Ruleset reference for a Release may be updated using the UpdateRelease method.

releases-delete$ clj

(releases-delete$ auth parameters)

https://firebase.google.com/docs/storage/securityapi/reference/rest/v1/projects/releases/delete

Required parameters: name

Optional parameters: none

Delete a Release by resource name.

releases-get$ clj

(releases-get$ auth parameters)

https://firebase.google.com/docs/storage/securityapi/reference/rest/v1/projects/releases/get

Required parameters: name

Optional parameters: none

Get a Release by name.

releases-getExecutable$ clj

(releases-getExecutable$ auth parameters)

https://firebase.google.com/docs/storage/securityapi/reference/rest/v1/projects/releases/getExecutable

Required parameters: name

Optional parameters: executableVersion

Get the Release executable to use when enforcing rules.

releases-list$ clj

(releases-list$ auth parameters)

https://firebase.google.com/docs/storage/securityapi/reference/rest/v1/projects/releases/list

Required parameters: name

Optional parameters: filter, pageToken, pageSize

List the Release values for a project. This list may optionally be filtered by Release name, Ruleset name, TestSuite name, or any combination thereof.

releases-patch$ clj

(releases-patch$ auth parameters body)

https://firebase.google.com/docs/storage/securityapi/reference/rest/v1/projects/releases/patch

Required parameters: name

Optional parameters: none

Body:

{:release {:rulesetName string, :updateTime string, :name string, :createTime string}, :updateMask string}

Update a Release via PATCH. Only updates to ruleset_name will be honored. Release rename is not supported. To create a Release use the CreateRelease method.

rulesets-create$ clj

(rulesets-create$ auth parameters body)

https://firebase.google.com/docs/storage/securityapi/reference/rest/v1/projects/rulesets/create

Required parameters: name

Optional parameters: none

Body:

{:metadata {:services [string]}, :name string, :createTime string, :source {:files [File]}}

Create a Ruleset from Source. The Ruleset is given a unique generated name which is returned to the caller. Source containing syntactic or semantics errors will result in an error response indicating the first error encountered. For a detailed view of Source issues, use TestRuleset.

rulesets-delete$ clj

(rulesets-delete$ auth parameters)

https://firebase.google.com/docs/storage/securityapi/reference/rest/v1/projects/rulesets/delete

Required parameters: name

Optional parameters: none

Delete a Ruleset by resource name. If the Ruleset is referenced by a Release the operation will fail.

rulesets-get$ clj

(rulesets-get$ auth parameters)

https://firebase.google.com/docs/storage/securityapi/reference/rest/v1/projects/rulesets/get

Required parameters: name

Optional parameters: none

Get a Ruleset by name including the full Source contents.

rulesets-list$ clj

(rulesets-list$ auth parameters)

https://firebase.google.com/docs/storage/securityapi/reference/rest/v1/projects/rulesets/list

Required parameters: name

Optional parameters: pageToken, filter, pageSize

List Ruleset metadata only and optionally filter the results by Ruleset name. The full Source contents of a Ruleset may be retrieved with GetRuleset.

test$ clj

(test$ auth parameters body)

https://firebase.google.com/docs/storage/securityapi/reference/rest/v1/projects/test

Required parameters: name

Optional parameters: none

Body:

{:testSuite {:testCases [TestCase]}, :source {:files [File]}}

Test Source for syntactic and semantic correctness. Issues present, if any, will be returned to the caller with a description, severity, and source location. The test method may be executed with Source or a Ruleset name. Passing Source is useful for unit testing new rules. Passing a Ruleset name is useful for regression testing an existing rule. The following is an example of Source that permits users to upload images to a bucket bearing their user id and matching the correct metadata: Example // Users are allowed to subscribe and unsubscribe to the blog. service firebase.storage { match /users/{userId}/images/{imageName} { allow write: if userId == request.auth.uid && (imageName.matches('.png$') || imageName.matches('.jpg$')) && resource.mimeType.matches('^image/') } }