feat: Security Rules Management API#645
Merged
hiranya911 merged 15 commits intomasterfrom Sep 18, 2019
Merged
Conversation
* Implementing the Firebase Security Rules API * More argument validation and assertions * Cleaning up the rules impl * Internal API renamed * Fixing a typo in a comment
* Implementing the Firebase Security Rules API * More argument validation and assertions * Adding the rest of the CRUD operations for rulesets * Cleaning up the rules impl * Cleaned up tests * Adding some missing comments * Removing support for multiple rules files in create()
* Added deleteRuleset API * Merged with source
* Implemented the API for releasing rulesets * Removed createRelease logic * Updated comment
* Implemented the API for releasing rulesets * Removed createRelease logic * Added getStorageRules() API * Removed some redundant tests
* Added rules API to the public admin namespace * Updated docs * Addressing comments regarding the d.ts file * Updated App typings
* Rules integration tests * Refactored by adding some helper methods * Cleaned up some conditionals * Added verification for deleteRuleset test * Renamed tempRulesets
egilmorez
reviewed
Sep 9, 2019
| * | ||
| * @example | ||
| * ```javascript | ||
| * // Get the SecurityRules service for the default app |
Contributor
There was a problem hiding this comment.
Suggest backticks like you have below: "the SecurityRules service"
Contributor
Author
There was a problem hiding this comment.
Does it matter here? This is a comment inside an example. It would be rendered as is.
Contributor
There was a problem hiding this comment.
Oh that's right :)
We can skip this one and the others inside comments for sure.
egilmorez
reviewed
Sep 9, 2019
src/index.d.ts
Outdated
| * | ||
| * @param app Optional app to return the `SecurityRules` service | ||
| * for. If not provided, the default `SecurityRules` service will | ||
| * be returned. |
Contributor
There was a problem hiding this comment.
A good case for just "is returned."
egilmorez
reviewed
Sep 9, 2019
src/index.d.ts
Outdated
| * limit. | ||
| * @param nextPageToken The next page token. If not specified, returns rulesets | ||
| * starting without any offset. | ||
| * @return A promise that fulfills a page of rulesets. |
Contributor
There was a problem hiding this comment.
Should this be "fulfills with" ?
egilmorez
reviewed
Sep 9, 2019
Contributor
egilmorez
left a comment
egilmorez
left a comment
There was a problem hiding this comment.
A few formatting things to look at. Thanks Hiranya!
Contributor
Author
|
Thanks @egilmorez. Made some of the changes suggested. As for adding backticks, I don't think it's needed there since they are rendered as comments in an example snippet. WDYT? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
RELEASE NOTE: Added a new
admin.securityRules()API for managing Firebase security rules applied on services like Cloud Firestore and Cloud Storage.RELEASE NOTE: Added
getFirestoreRuleset()andgetStorageRuleset()methods for retrieving rulesets that are currently in effect.RELEASE NOTE: Added
releaseFirestoreRuleset()andreleaseStorageRuleset()methods for creating new rulesets and applying them to Firestore and Storage.RELEASE NOTE: Added
getRuleset(),createRuleset()anddeleteRuleset()methods for managing the lifecycle of a ruleset.