docs: update docs/dyn (#1096)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/6f0f288a-a1e8-4b2d-a85f-00b1c6150185/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/39b7149da4026765385403632db3c6f63db96b2c
Source-Link: https://github.com/googleapis/synthtool/commit/9a7d9fbb7045c34c9d3d22c1ff766eeae51f04c9
Source-Link: https://github.com/googleapis/synthtool/commit/dc9903a8c30c3662b6098f0e4a97f221d67268b2
Source-Link: https://github.com/googleapis/synthtool/commit/7fcc405a579d5d53a726ff3da1b7c8c08f0f2d58
Source-Link: https://github.com/googleapis/synthtool/commit/d5fc0bcf9ea9789c5b0e3154a9e3b29e5cea6116
Source-Link: https://github.com/googleapis/synthtool/commit/e89175cf074dccc4babb4eca66ae913696e47a71
Source-Link: https://github.com/googleapis/synthtool/commit/7d652819519dfa24da9e14548232e4aaba71a11c
Source-Link: https://github.com/googleapis/synthtool/commit/7db8a6c5ffb12a6e4c2f799c18f00f7f3d60e279
Source-Link: https://github.com/googleapis/synthtool/commit/1f1148d3c7a7a52f0c98077f976bd9b3c948ee2b
Source-Link: https://github.com/googleapis/synthtool/commit/2c8aecedd55b0480fb4e123b6e07fa5b12953862
Source-Link: https://github.com/googleapis/synthtool/commit/3d3e94c4e02370f307a9a200b0c743c3d8d19f29
Source-Link: https://github.com/googleapis/synthtool/commit/c7824ea48ff6d4d42dfae0849aec8a85acd90bd9
Source-Link: https://github.com/googleapis/synthtool/commit/ba9918cd22874245b55734f57470c719b577e591
Source-Link: https://github.com/googleapis/synthtool/commit/b19b401571e77192f8dd38eab5fb2300a0de9324
Source-Link: https://github.com/googleapis/synthtool/commit/6542bd723403513626f61642fc02ddca528409aa
diff --git a/docs/dyn/firebaserules_v1.projects.html b/docs/dyn/firebaserules_v1.projects.html
index 6607823..5ca7982 100644
--- a/docs/dyn/firebaserules_v1.projects.html
+++ b/docs/dyn/firebaserules_v1.projects.html
@@ -109,37 +109,37 @@
"source": { # `Source` is one or more `File` messages comprising a logical set of rules. # Optional `Source` to be checked for correctness. 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.
- "fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
- "content": "A String", # Textual Content.
"name": "A String", # File name.
+ "content": "A String", # Textual Content.
+ "fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
},
],
},
"testSuite": { # `TestSuite` is a collection of `TestCase` instances that validate the logical correctness of a `Ruleset`. The `TestSuite` may be referenced in-line within a `TestRuleset` invocation or as part of a `Release` object as a pre-release check. # Inline `TestSuite` to run.
"testCases": [ # Collection of test cases associated with the `TestSuite`.
{ # `TestCase` messages provide the request context and an expectation as to whether the given context will be allowed or denied. Test cases may specify the `request`, `resource`, and `function_mocks` to mock a function call to a service-provided function. The `request` object represents context present at request-time. The `resource` is the value of the target resource as it appears in persistent storage before the request is executed.
+ "expectation": "A String", # Test expectation.
+ "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 appropriate service documentation for information about the supported fields and types on the request. Minimally, all services support the following fields and types: Request field | Type ---------------|----------------- auth.uid | `string` auth.token | `map` headers | `map` method | `string` params | `map` path | `string` time | `google.protobuf.Timestamp` 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.
- "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 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 `{}`. # The result is undefined, meaning the result could not be computed.
},
+ "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.
- "exactValue": "", # Argument exactly matches value provided.
"anyValue": { # A generic empty message that you can re-use to avoid defining duplicated 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 `{}`. # Argument matches any value provided.
},
+ "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.
"resource": "", # Optional resource value as it appears in persistent storage before the request is fulfilled. The resource type depends on the `request.path` value.
- "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 appropriate service documentation for information about the supported fields and types on the request. Minimally, all services support the following fields and types: Request field | Type ---------------|----------------- auth.uid | `string` auth.token | `map` headers | `map` method | `string` params | `map` path | `string` time | `google.protobuf.Timestamp` 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.
},
],
},
@@ -154,71 +154,71 @@
An object of the form:
{ # The response for FirebaseRulesService.TestRuleset.
+ "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 index of the `File` in the `Source` message. Used for debug purposes. # Position of the issue in the `Source`.
+ "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`.
+ "endOffset": 42, # End position relative to the beginning of the file.
+ "currentOffset": 42, # Start position relative to the beginning of the file.
+ },
+ "severity": "A String", # The severity of the issue.
+ },
+ ],
"testResults": [ # The set of test results given the test cases in the `TestSuite`. The results will appear in the same order as the test cases appear in the `TestSuite`.
{ # Test result message containing the state of the test as well as a description and source position for test failures.
+ "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",
+ ],
"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: } ``` 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.
- "sourcePosition": { # Position in the `Source` content including its line, column number, and an index of the `File` in the `Source` message. Used for debug purposes. # Position in the `Source` or `Ruleset` where an expression was visited.
- "fileName": "A String", # Name of the `File`.
- "column": 42, # First column on the source line associated with the source fragment.
- "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.
- },
"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 index of the `File` in the `Source` message. Used for debug purposes. # Position in the `Source` or `Ruleset` where an expression was visited.
+ "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`.
+ "endOffset": 42, # End position relative to the beginning of the file.
+ "currentOffset": 42, # Start position relative to the beginning of the file.
+ },
},
],
"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.
"",
],
- "function": "A String", # Name of the function invoked.
},
],
- "errorPosition": { # Position in the `Source` content including its line, column number, and an index of the `File` in the `Source` message. Used for debug purposes. # 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 }`
- "fileName": "A String", # Name of the `File`.
- "column": 42, # First column on the source line associated with the source fragment.
- "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.
"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 index of the `File` in the `Source` message. Used for debug purposes. # Position of expression in original rules source.
- "fileName": "A String", # Name of the `File`.
- "column": 42, # First column on the source line associated with the source fragment.
- "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.
- },
+ "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
+ },
+ ],
"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.
- "value": "", # The return value of the expression
- "count": 42, # The amount of times that expression returned.
- },
- ],
+ "sourcePosition": { # Position in the `Source` content including its line, column number, and an index of the `File` in the `Source` message. Used for debug purposes. # Position of expression in original rules source.
+ "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`.
+ "endOffset": 42, # End position relative to the beginning of the file.
+ "currentOffset": 42, # Start 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",
- ],
- "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.
- "severity": "A String", # The severity of the issue.
- "sourcePosition": { # Position in the `Source` content including its line, column number, and an index of the `File` in the `Source` message. Used for debug purposes. # Position of the issue in the `Source`.
- "fileName": "A String", # Name of the `File`.
- "column": 42, # First column on the source line associated with the source fragment.
- "currentOffset": 42, # Start position relative to the beginning of the file.
- "endOffset": 42, # End position relative to the beginning of the file.
+ "errorPosition": { # Position in the `Source` content including its line, column number, and an index of the `File` in the `Source` message. Used for debug purposes. # 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 }`
"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`.
+ "endOffset": 42, # End position relative to the beginning of the file.
+ "currentOffset": 42, # Start position relative to the beginning of the file.
},
},
],