Skip to content

Commit

Permalink
fix(firebaserules): update the API
Browse files Browse the repository at this point in the history 
#### firebaserules:v1

The following keys were changed:
- resources.projects.resources.releases.methods.getExecutable.parameters.executableVersion.description
- resources.projects.resources.releases.methods.list.parameters.filter.description
- resources.projects.resources.releases.methods.list.parameters.pageSize.description
- resources.projects.resources.releases.methods.list.parameters.pageToken.description
- resources.projects.resources.rulesets.methods.list.parameters.filter.description
- resources.projects.resources.rulesets.methods.list.parameters.pageSize.description
- resources.projects.resources.rulesets.methods.list.parameters.pageToken.description
- schemas.TestRulesetRequest.properties.source.description
- schemas.TestRulesetRequest.properties.testSuite.description
- schemas.UpdateReleaseRequest.properties.updateMask.description
  • Loading branch information
@yoshi-automation @sofisl
yoshi-automation authored and sofisl committed Jan 29, 2025
1 parent 91b6958 commit 4449b80
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 21 deletions.
22 changes: 11 additions & 11 deletions discovery/firebaserules-v1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@
],
"parameters": {
"executableVersion": {
"description": "The requested runtime executable version. Defaults to FIREBASE_RULES_EXECUTABLE_V1.",
"description": "Optional. The requested runtime executable version. Defaults to FIREBASE_RULES_EXECUTABLE_V1.",
"enum": [
"RELEASE_EXECUTABLE_VERSION_UNSPECIFIED",
"FIREBASE_RULES_EXECUTABLE_V1",
Expand Down Expand Up @@ -281,7 +281,7 @@
],
"parameters": {
"filter": {
"description": "`Release` filter. The list method supports filters with restrictions on the `Release.name`, and `Release.ruleset_name`. Example 1: A filter of 'name=prod*' might return `Release`s with names within 'projects/foo' prefixed with 'prod': Name -> Ruleset Name: * projects/foo/releases/prod -> projects/foo/rulesets/uuid1234 * projects/foo/releases/prod/v1 -> projects/foo/rulesets/uuid1234 * projects/foo/releases/prod/v2 -> projects/foo/rulesets/uuid8888 Example 2: A filter of `name=prod* ruleset_name=uuid1234` would return only `Release` instances for 'projects/foo' with names prefixed with 'prod' referring to the same `Ruleset` name of 'uuid1234': Name -> Ruleset Name: * projects/foo/releases/prod -> projects/foo/rulesets/1234 * projects/foo/releases/prod/v1 -> projects/foo/rulesets/1234 In the examples, the filter parameters refer to the search filters are relative to the project. Fully qualified prefixed may also be used.",
"description": "Optional. `Release` filter. The list method supports filters with restrictions on the `Release.name`, and `Release.ruleset_name`. Example 1: A filter of 'name=prod*' might return `Release`s with names within 'projects/foo' prefixed with 'prod': Name -> Ruleset Name: * projects/foo/releases/prod -> projects/foo/rulesets/uuid1234 * projects/foo/releases/prod/v1 -> projects/foo/rulesets/uuid1234 * projects/foo/releases/prod/v2 -> projects/foo/rulesets/uuid8888 Example 2: A filter of `name=prod* ruleset_name=uuid1234` would return only `Release` instances for 'projects/foo' with names prefixed with 'prod' referring to the same `Ruleset` name of 'uuid1234': Name -> Ruleset Name: * projects/foo/releases/prod -> projects/foo/rulesets/1234 * projects/foo/releases/prod/v1 -> projects/foo/rulesets/1234 In the examples, the filter parameters refer to the search filters are relative to the project. Fully qualified prefixed may also be used.",
"location": "query",
"type": "string"
},
Expand All @@ -293,13 +293,13 @@
"type": "string"
},
"pageSize": {
"description": "Page size to load. Maximum of 100. Defaults to 10. Note: `page_size` is just a hint and the service may choose to load fewer than `page_size` results due to the size of the output. To traverse all of the releases, the caller should iterate until the `page_token` on the response is empty.",
"description": "Optional. Page size to load. Maximum of 100. Defaults to 10. Note: `page_size` is just a hint and the service may choose to load fewer than `page_size` results due to the size of the output. To traverse all of the releases, the caller should iterate until the `page_token` on the response is empty.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Next page token for the next batch of `Release` instances.",
"description": "Optional. Next page token for the next batch of `Release` instances.",
"location": "query",
"type": "string"
}
Expand Down Expand Up @@ -439,7 +439,7 @@
],
"parameters": {
"filter": {
"description": "`Ruleset` filter. The list method supports filters with restrictions on `Ruleset.name`. Filters on `Ruleset.create_time` should use the `date` function which parses strings that conform to the RFC 3339 date/time specifications. Example: `create_time > date(\"2017-01-01T00:00:00Z\") AND name=UUID-*`",
"description": "Optional. `Ruleset` filter. The list method supports filters with restrictions on `Ruleset.name`. Filters on `Ruleset.create_time` should use the `date` function which parses strings that conform to the RFC 3339 date/time specifications. Example: `create_time > date(\"2017-01-01T00:00:00Z\") AND name=UUID-*`",
"location": "query",
"type": "string"
},
Expand All @@ -451,13 +451,13 @@
"type": "string"
},
"pageSize": {
"description": "Page size to load. Maximum of 100. Defaults to 10. Note: `page_size` is just a hint and the service may choose to load less than `page_size` due to the size of the output. To traverse all of the releases, caller should iterate until the `page_token` is empty.",
"description": "Optional. Page size to load. Maximum of 100. Defaults to 10. Note: `page_size` is just a hint and the service may choose to load less than `page_size` due to the size of the output. To traverse all of the releases, caller should iterate until the `page_token` is empty.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Next page token for loading the next batch of `Ruleset` instances.",
"description": "Optional. Next page token for loading the next batch of `Ruleset` instances.",
"location": "query",
"type": "string"
}
Expand All @@ -477,7 +477,7 @@
}
}
},
"revision": "20231120",
"revision": "20241125",
"rootUrl": "https://firebaserules.googleapis.com/",
"schemas": {
"Arg": {
Expand Down Expand Up @@ -964,11 +964,11 @@
"properties": {
"source": {
"$ref": "Source",
"description": "Optional `Source` to be checked for correctness. This field must not be set when the resource name refers to a `Ruleset`."
"description": "Optional. Optional `Source` to be checked for correctness. This field must not be set when the resource name refers to a `Ruleset`."
},
"testSuite": {
"$ref": "TestSuite",
"description": "The tests to execute against the `Source`. When `Source` is provided inline, the test cases will only be run if the `Source` is syntactically and semantically valid. Inline `TestSuite` to run."
"description": "Required. The tests to execute against the `Source`. When `Source` is provided inline, the test cases will only be run if the `Source` is syntactically and semantically valid. Inline `TestSuite` to run."
}
},
"type": "object"
Expand Down Expand Up @@ -1017,7 +1017,7 @@
"description": "Required. `Release` to update."
},
"updateMask": {
"description": "Specifies which fields to update.",
"description": "Optional. Specifies which fields to update.",
"format": "google-fieldmask",
"type": "string"
}
Expand Down
20 changes: 10 additions & 10 deletions src/apis/firebaserules/v1.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -442,11 +442,11 @@ export namespace firebaserules_v1 {
*/
export interface Schema$TestRulesetRequest {
/**
* Optional `Source` to be checked for correctness. This field must not be set when the resource name refers to a `Ruleset`.
* Optional. Optional `Source` to be checked for correctness. This field must not be set when the resource name refers to a `Ruleset`.
*/
source?: Schema$Source;
/**
* The tests to execute against the `Source`. When `Source` is provided inline, the test cases will only be run if the `Source` is syntactically and semantically valid. Inline `TestSuite` to run.
* Required. The tests to execute against the `Source`. When `Source` is provided inline, the test cases will only be run if the `Source` is syntactically and semantically valid. Inline `TestSuite` to run.
*/
testSuite?: Schema$TestSuite;
}
Expand Down Expand Up @@ -481,7 +481,7 @@ export namespace firebaserules_v1 {
*/
release?: Schema$Release;
/**
* Specifies which fields to update.
* Optional. Specifies which fields to update.
*/
updateMask?: string | null;
}
Expand Down Expand Up @@ -1198,7 +1198,7 @@ export namespace firebaserules_v1 {
export interface Params$Resource$Projects$Releases$Getexecutable
extends StandardParameters {
/**
* The requested runtime executable version. Defaults to FIREBASE_RULES_EXECUTABLE_V1.
* Optional. The requested runtime executable version. Defaults to FIREBASE_RULES_EXECUTABLE_V1.
*/
executableVersion?: string;
/**
Expand All @@ -1209,19 +1209,19 @@ export namespace firebaserules_v1 {
export interface Params$Resource$Projects$Releases$List
extends StandardParameters {
/**
* `Release` filter. The list method supports filters with restrictions on the `Release.name`, and `Release.ruleset_name`. Example 1: A filter of 'name=prod*' might return `Release`s with names within 'projects/foo' prefixed with 'prod': Name -\> Ruleset Name: * projects/foo/releases/prod -\> projects/foo/rulesets/uuid1234 * projects/foo/releases/prod/v1 -\> projects/foo/rulesets/uuid1234 * projects/foo/releases/prod/v2 -\> projects/foo/rulesets/uuid8888 Example 2: A filter of `name=prod* ruleset_name=uuid1234` would return only `Release` instances for 'projects/foo' with names prefixed with 'prod' referring to the same `Ruleset` name of 'uuid1234': Name -\> Ruleset Name: * projects/foo/releases/prod -\> projects/foo/rulesets/1234 * projects/foo/releases/prod/v1 -\> projects/foo/rulesets/1234 In the examples, the filter parameters refer to the search filters are relative to the project. Fully qualified prefixed may also be used.
* Optional. `Release` filter. The list method supports filters with restrictions on the `Release.name`, and `Release.ruleset_name`. Example 1: A filter of 'name=prod*' might return `Release`s with names within 'projects/foo' prefixed with 'prod': Name -\> Ruleset Name: * projects/foo/releases/prod -\> projects/foo/rulesets/uuid1234 * projects/foo/releases/prod/v1 -\> projects/foo/rulesets/uuid1234 * projects/foo/releases/prod/v2 -\> projects/foo/rulesets/uuid8888 Example 2: A filter of `name=prod* ruleset_name=uuid1234` would return only `Release` instances for 'projects/foo' with names prefixed with 'prod' referring to the same `Ruleset` name of 'uuid1234': Name -\> Ruleset Name: * projects/foo/releases/prod -\> projects/foo/rulesets/1234 * projects/foo/releases/prod/v1 -\> projects/foo/rulesets/1234 In the examples, the filter parameters refer to the search filters are relative to the project. Fully qualified prefixed may also be used.
*/
filter?: string;
/**
* Required. Resource name for the project. Format: `projects/{project_id\}`
*/
name?: string;
/**
* Page size to load. Maximum of 100. Defaults to 10. Note: `page_size` is just a hint and the service may choose to load fewer than `page_size` results due to the size of the output. To traverse all of the releases, the caller should iterate until the `page_token` on the response is empty.
* Optional. Page size to load. Maximum of 100. Defaults to 10. Note: `page_size` is just a hint and the service may choose to load fewer than `page_size` results due to the size of the output. To traverse all of the releases, the caller should iterate until the `page_token` on the response is empty.
*/
pageSize?: number;
/**
* Next page token for the next batch of `Release` instances.
* Optional. Next page token for the next batch of `Release` instances.
*/
pageToken?: string;
}
Expand Down Expand Up @@ -1629,19 +1629,19 @@ export namespace firebaserules_v1 {
export interface Params$Resource$Projects$Rulesets$List
extends StandardParameters {
/**
* `Ruleset` filter. The list method supports filters with restrictions on `Ruleset.name`. Filters on `Ruleset.create_time` should use the `date` function which parses strings that conform to the RFC 3339 date/time specifications. Example: `create_time \> date("2017-01-01T00:00:00Z") AND name=UUID-*`
* Optional. `Ruleset` filter. The list method supports filters with restrictions on `Ruleset.name`. Filters on `Ruleset.create_time` should use the `date` function which parses strings that conform to the RFC 3339 date/time specifications. Example: `create_time \> date("2017-01-01T00:00:00Z") AND name=UUID-*`
*/
filter?: string;
/**
* Required. Resource name for the project. Format: `projects/{project_id\}`
*/
name?: string;
/**
* Page size to load. Maximum of 100. Defaults to 10. Note: `page_size` is just a hint and the service may choose to load less than `page_size` due to the size of the output. To traverse all of the releases, caller should iterate until the `page_token` is empty.
* Optional. Page size to load. Maximum of 100. Defaults to 10. Note: `page_size` is just a hint and the service may choose to load less than `page_size` due to the size of the output. To traverse all of the releases, caller should iterate until the `page_token` is empty.
*/
pageSize?: number;
/**
* Next page token for loading the next batch of `Ruleset` instances.
* Optional. Next page token for loading the next batch of `Ruleset` instances.
*/
pageToken?: string;
}
Expand Down

0 comments on commit 4449b80

Please sign in to comment.