docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/firebaserules_v1.projects.html b/docs/dyn/firebaserules_v1.projects.html
index e672df4..2d11062 100644
--- a/docs/dyn/firebaserules_v1.projects.html
+++ b/docs/dyn/firebaserules_v1.projects.html
@@ -150,6 +150,11 @@
#
# The `resource` is the value of the target resource as it appears in
# persistent storage before the request is executed.
+ "resource": "", # Optional resource value as it appears in persistent storage before the
+ # request is fulfilled.
+ #
+ # The resource type depends on the `request.path` value.
+ "expectation": "A String", # Test expectation.
"functionMocks": [ # Optional function mocks for service-defined functions. If not set, any
# service defined function is expected to return an error, which may or may
# not influence the test outcome.
@@ -163,6 +168,20 @@
# More than one `FunctionMock` may be provided for a given function name so
# long as the `Arg` matchers are distinct. There may be only one function
# for a given overload where all `Arg` values are `Arg.any_value`.
+ "result": { # Possible result values from the function mock invocation. # The mock result of the function call.
+ "value": "", # The result is an actual value. The type of the value must match that
+ # of the type declared by the service.
+ "undefined": { # A generic empty message that you can re-use to avoid defining duplicated # The result is undefined, meaning the result could not be computed.
+ # empty messages in your APIs. A typical example is to use it as the request
+ # or the response type of an API method. For instance:
+ #
+ # service Foo {
+ # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+ # }
+ #
+ # The JSON representation for `Empty` is empty JSON object `{}`.
+ },
+ },
"args": [ # The list of `Arg` values to match. The order in which the arguments are
# provided is the order in which they must appear in the function
# invocation.
@@ -183,20 +202,6 @@
"function": "A String", # The name of the function.
#
# The function name must match one provided by a service declaration.
- "result": { # Possible result values from the function mock invocation. # The mock result of the function call.
- "value": "", # The result is an actual value. The type of the value must match that
- # of the type declared by the service.
- "undefined": { # A generic empty message that you can re-use to avoid defining duplicated # The result is undefined, meaning the result could not be computed.
- # empty messages in your APIs. A typical example is to use it as the request
- # or the response type of an API method. For instance:
- #
- # service Foo {
- # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
- # }
- #
- # The JSON representation for `Empty` is empty JSON object `{}`.
- },
- },
},
],
"pathEncoding": "A String", # Specifies whether paths (such as request.path) are encoded and how.
@@ -220,11 +225,6 @@
# If the request value is not well-formed for the service, the request will
# be rejected as an invalid argument.
"expressionReportLevel": "A String", # Specifies what should be included in the response.
- "resource": "", # Optional resource value as it appears in persistent storage before the
- # request is fulfilled.
- #
- # The resource type depends on the `request.path` value.
- "expectation": "A String", # Test expectation.
},
],
},
@@ -244,42 +244,6 @@
# `TestSuite`.
{ # Test result message containing the state of the test as well as a
# description and source position for test failures.
- "functionCalls": [ # The set of function calls made to service-defined methods.
- #
- # Function calls are included in the order in which they are encountered
- # during evaluation, are provided for both mocked and unmocked functions,
- # and included on the response regardless of the test `state`.
- { # Represents a service-defined function call that was invoked during test
- # execution.
- "args": [ # The arguments that were provided to the function.
- "",
- ],
- "function": "A String", # Name of the function invoked.
- },
- ],
- "visitedExpressions": [ # The set of visited permission expressions for a given test. This returns
- # the positions and evaluation results of all visited permission
- # expressions which were relevant to the test case, e.g.
- # ```
- # match /path {
- # allow read if: <expr>
- # }
- # ```
- # For a detailed report of the intermediate evaluation states, see the
- # `expression_reports` field
- { # Store the position and access outcome for an expression visited in rules.
- "value": "", # The evaluated value for the visited expression, e.g. true/false
- "sourcePosition": { # Position in the `Source` content including its line, column number, and an # Position in the `Source` or `Ruleset` where an expression was visited.
- # index of the `File` in the `Source` message. Used for debug purposes.
- "line": 42, # Line number of the source fragment. 1-based.
- "column": 42, # First column on the source line associated with the source fragment.
- "fileName": "A String", # Name of the `File`.
- "currentOffset": 42, # Start position relative to the beginning of the file.
- "endOffset": 42, # End position relative to the beginning of the file.
- },
- },
- ],
- "state": "A String", # State of the test.
"expressionReports": [ # The mapping from expression in the ruleset AST to the values they were
# evaluated to. Partially-nested to mirror AST structure. Note that this
# field is actually tracking expressions and not permission statements in
@@ -289,11 +253,11 @@
# evaluated to over the course of its use.
"sourcePosition": { # Position in the `Source` content including its line, column number, and an # Position of expression in original rules source.
# index of the `File` in the `Source` message. Used for debug purposes.
- "line": 42, # Line number of the source fragment. 1-based.
"column": 42, # First column on the source line associated with the source fragment.
"fileName": "A String", # Name of the `File`.
"currentOffset": 42, # Start position relative to the beginning of the file.
"endOffset": 42, # End position relative to the beginning of the file.
+ "line": 42, # Line number of the source fragment. 1-based.
},
"children": [ # Subexpressions
# Object with schema name: ExpressionReport
@@ -325,27 +289,63 @@
#
# E.g. `error_position { line: 19 column: 37 }`
# index of the `File` in the `Source` message. Used for debug purposes.
- "line": 42, # Line number of the source fragment. 1-based.
"column": 42, # First column on the source line associated with the source fragment.
"fileName": "A String", # Name of the `File`.
"currentOffset": 42, # Start position relative to the beginning of the file.
"endOffset": 42, # End position relative to the beginning of the file.
+ "line": 42, # Line number of the source fragment. 1-based.
},
+ "functionCalls": [ # The set of function calls made to service-defined methods.
+ #
+ # Function calls are included in the order in which they are encountered
+ # during evaluation, are provided for both mocked and unmocked functions,
+ # and included on the response regardless of the test `state`.
+ { # Represents a service-defined function call that was invoked during test
+ # execution.
+ "function": "A String", # Name of the function invoked.
+ "args": [ # The arguments that were provided to the function.
+ "",
+ ],
+ },
+ ],
+ "visitedExpressions": [ # The set of visited permission expressions for a given test. This returns
+ # the positions and evaluation results of all visited permission
+ # expressions which were relevant to the test case, e.g.
+ # ```
+ # match /path {
+ # allow read if: <expr>
+ # }
+ # ```
+ # For a detailed report of the intermediate evaluation states, see the
+ # `expression_reports` field
+ { # Store the position and access outcome for an expression visited in rules.
+ "value": "", # The evaluated value for the visited expression, e.g. true/false
+ "sourcePosition": { # Position in the `Source` content including its line, column number, and an # Position in the `Source` or `Ruleset` where an expression was visited.
+ # index of the `File` in the `Source` message. Used for debug purposes.
+ "column": 42, # First column on the source line associated with the source fragment.
+ "fileName": "A String", # Name of the `File`.
+ "currentOffset": 42, # Start position relative to the beginning of the file.
+ "endOffset": 42, # End position relative to the beginning of the file.
+ "line": 42, # Line number of the source fragment. 1-based.
+ },
+ },
+ ],
+ "state": "A String", # State of the test.
},
],
"issues": [ # Syntactic and semantic `Source` issues of varying severity. Issues of
# `ERROR` severity will prevent tests from executing.
{ # Issues include warnings, errors, and deprecation notices.
+ "description": "A String", # Short error description.
"sourcePosition": { # Position in the `Source` content including its line, column number, and an # Position of the issue in the `Source`.
# index of the `File` in the `Source` message. Used for debug purposes.
- "line": 42, # Line number of the source fragment. 1-based.
"column": 42, # First column on the source line associated with the source fragment.
"fileName": "A String", # Name of the `File`.
"currentOffset": 42, # Start position relative to the beginning of the file.
"endOffset": 42, # End position relative to the beginning of the file.
+ "line": 42, # Line number of the source fragment. 1-based.
},
"severity": "A String", # The severity of the issue.
- "description": "A String", # Short error description.
},
],
}</pre>