docs: update generated docs (#981)
diff --git a/docs/dyn/firebaserules_v1.projects.html b/docs/dyn/firebaserules_v1.projects.html
index 2d11062..7b62de2 100644
--- a/docs/dyn/firebaserules_v1.projects.html
+++ b/docs/dyn/firebaserules_v1.projects.html
@@ -130,9 +130,9 @@
# This field must not be set when the resource name refers to a `Ruleset`.
"files": [ # `File` set constituting the `Source` bundle.
{ # `File` containing source content.
- "content": "A String", # Textual Content.
"fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
"name": "A String", # File name.
+ "content": "A String", # Textual Content.
},
],
},
@@ -154,57 +154,6 @@
# 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.
- { # Mock function definition.
- #
- # Mocks must refer to a function declared by the target service. The type of
- # the function args and result will be inferred at test time. If either the
- # arg or result values are not compatible with function type declaration, the
- # request will be considered invalid.
- #
- # 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.
- { # Arg matchers for the mock function.
- "exactValue": "", # Argument exactly matches value provided.
- "anyValue": { # A generic empty message that you can re-use to avoid defining duplicated # Argument matches any value provided.
- # 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 `{}`.
- },
- },
- ],
- "function": "A String", # The name of the function.
- #
- # The function name must match one provided by a service declaration.
- },
- ],
- "pathEncoding": "A String", # Specifies whether paths (such as request.path) are encoded and how.
"request": "", # Request context.
#
# The exact format of the request context is service-dependent. See the
@@ -225,6 +174,57 @@
# 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.
+ "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.
+ { # Mock function definition.
+ #
+ # Mocks must refer to a function declared by the target service. The type of
+ # the function args and result will be inferred at test time. If either the
+ # arg or result values are not compatible with function type declaration, the
+ # request will be considered invalid.
+ #
+ # 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.
+ "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 `{}`.
+ },
+ "value": "", # The result is an actual value. The type of the value must match that
+ # of the type declared by the service.
+ },
+ "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.
+ { # Arg matchers for the mock function.
+ "anyValue": { # A generic empty message that you can re-use to avoid defining duplicated # Argument matches any value provided.
+ # 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 `{}`.
+ },
+ "exactValue": "", # Argument exactly matches value provided.
+ },
+ ],
+ "function": "A String", # The name of the function.
+ #
+ # The function name must match one provided by a service declaration.
+ },
+ ],
+ "expectation": "A String", # Test expectation.
+ "pathEncoding": "A String", # Specifies whether paths (such as request.path) are encoded and how.
},
],
},
@@ -244,57 +244,7 @@
# `TestSuite`.
{ # Test result message containing the state of the test as well as a
# description and source position for test failures.
- "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
- # contrast to the "visited_expressions" field above. Literal expressions
- # are omitted.
- { # Describes where in a file an expression is found and what it was
- # 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.
- "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
- ],
- "values": [ # Values that this expression evaluated to when encountered.
- { # Tuple for how many times an Expression was evaluated to a particular
- # ExpressionValue.
- "count": 42, # The amount of times that expression returned.
- "value": "", # The return value of the expression
- },
- ],
- },
- ],
- "debugMessages": [ # Debug messages related to test execution issues encountered during
- # evaluation.
- #
- # Debug messages may be related to too many or too few invocations of
- # function mocks or to runtime errors that occur during evaluation.
- #
- # For example: ```Unable to read variable [name: "resource"]```
- "A String",
- ],
- "errorPosition": { # Position in the `Source` content including its line, column number, and an # Position in the `Source` or `Ruleset` where the principle runtime error
- # occurs.
- #
- # Evaluation of an expression may result in an error. Rules are deny by
- # default, so a `DENY` expectation when an error is generated is valid.
- # When there is a `DENY` with an error, the `SourcePosition` is returned.
- #
- # E.g. `error_position { line: 19 column: 37 }`
- # 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.
"functionCalls": [ # The set of function calls made to service-defined methods.
#
# Function calls are included in the order in which they are encountered
@@ -319,18 +269,68 @@
# 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.
+ "column": 42, # First column on the source line associated with the source fragment.
"line": 42, # Line number of the source fragment. 1-based.
+ "fileName": "A String", # Name of the `File`.
+ "endOffset": 42, # End position relative to the beginning of the file.
},
+ "value": "", # The evaluated value for the visited expression, e.g. true/false
},
],
- "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
+ # contrast to the "visited_expressions" field above. Literal expressions
+ # are omitted.
+ { # Describes where in a file an expression is found and what it was
+ # evaluated to over the course of its use.
+ "children": [ # Subexpressions
+ # Object with schema name: ExpressionReport
+ ],
+ "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.
+ "currentOffset": 42, # Start position relative to the beginning of the file.
+ "column": 42, # First column on the source line associated with the source fragment.
+ "line": 42, # Line number of the source fragment. 1-based.
+ "fileName": "A String", # Name of the `File`.
+ "endOffset": 42, # End position relative to the beginning of the file.
+ },
+ "values": [ # Values that this expression evaluated to when encountered.
+ { # Tuple for how many times an Expression was evaluated to a particular
+ # ExpressionValue.
+ "count": 42, # The amount of times that expression returned.
+ "value": "", # The return value of the expression
+ },
+ ],
+ },
+ ],
+ "errorPosition": { # Position in the `Source` content including its line, column number, and an # Position in the `Source` or `Ruleset` where the principle runtime error
+ # occurs.
+ #
+ # Evaluation of an expression may result in an error. Rules are deny by
+ # default, so a `DENY` expectation when an error is generated is valid.
+ # When there is a `DENY` with an error, the `SourcePosition` is returned.
+ #
+ # E.g. `error_position { line: 19 column: 37 }`
+ # index of the `File` in the `Source` message. Used for debug purposes.
+ "currentOffset": 42, # Start position relative to the beginning of the file.
+ "column": 42, # First column on the source line associated with the source fragment.
+ "line": 42, # Line number of the source fragment. 1-based.
+ "fileName": "A String", # Name of the `File`.
+ "endOffset": 42, # End position relative to the beginning of the file.
+ },
+ "debugMessages": [ # Debug messages related to test execution issues encountered during
+ # evaluation.
+ #
+ # Debug messages may be related to too many or too few invocations of
+ # function mocks or to runtime errors that occur during evaluation.
+ #
+ # For example: ```Unable to read variable [name: "resource"]```
+ "A String",
+ ],
},
],
"issues": [ # Syntactic and semantic `Source` issues of varying severity. Issues of
@@ -339,11 +339,11 @@
"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.
- "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.
+ "column": 42, # First column on the source line associated with the source fragment.
"line": 42, # Line number of the source fragment. 1-based.
+ "fileName": "A String", # Name of the `File`.
+ "endOffset": 42, # End position relative to the beginning of the file.
},
"severity": "A String", # The severity of the issue.
},