chore: Update discovery artifacts manual - #2826
Closed
JoeWang1127 wants to merge 21 commits into
Closed
JoeWang1127 wants to merge 21 commits into
JoeWang1127 wants to merge 21 commits into
Conversation
#### androidpublisher:v3 The following keys were added: - schemas.UpdateAppStoreHostedAppResponse.properties.updateId.type (Total Keys: 1) The following keys were changed: - resources.edits.resources.deobfuscationfiles.methods.upload.mediaUpload.maxSize (Total Keys: 1)
#### biglake:v1 The following keys were changed: - endpoints (Total Keys: 1)
#### bigtableadmin:v2 The following keys were added: - schemas.AvroSchema (Total Keys: 4) - schemas.SchemaBundle.properties.avroSchema.$ref (Total Keys: 1)
#### chat:v1 The following keys were added: - schemas.User.properties.email (Total Keys: 2)
#### datalineage:v1 The following keys were changed: - endpoints (Total Keys: 1)
#### dataplex:v1 The following keys were added: - schemas.GoogleCloudDataplexV1DataScanEventDataProfileResult.properties.dcuConsumed (Total Keys: 2)
#### discoveryengine:v1 The following keys were added: - schemas.GoogleCloudDiscoveryengineV1WidgetConfigCollectionComponent.properties.tag (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaLicenseConfig.properties.billingAccountLicenseConfig (Total Keys: 2) #### discoveryengine:v1alpha The following keys were added: - resources.projects.resources.locations.resources.collections.resources.engines.resources.collaborativeProjects.resources.knowledgeSpaces.resources.operations.methods.get (Total Keys: 11) - schemas.GoogleCloudDiscoveryengineV1alphaExportMetricsRequest.properties.startDate.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaLicenseConfig.properties.billingAccountLicenseConfig (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent.properties.tag (Total Keys: 2) #### discoveryengine:v1beta The following keys were added: - schemas.GoogleCloudDiscoveryengineV1alphaLicenseConfig.properties.billingAccountLicenseConfig (Total Keys: 2)
#### displayvideo:v2 The following keys were deleted: - schemas.DeviceTypeAssignedTargetingOptionDetails.properties.youtubeAndPartnersBidMultiplier.readOnly (Total Keys: 1) The following keys were added: - schemas.YoutubeVideoDetails.properties.unavailableReason.readOnly (Total Keys: 1) #### displayvideo:v3 The following keys were deleted: - schemas.AdGroupAd.properties.bumperAd.readOnly (Total Keys: 1) - schemas.AdGroupAd.properties.inStreamAd.readOnly (Total Keys: 1) - schemas.AdGroupAd.properties.nonSkippableAd.readOnly (Total Keys: 1) - schemas.AdGroupAd.properties.videoPerformanceAd.readOnly (Total Keys: 1) - schemas.DeviceTypeAssignedTargetingOptionDetails.properties.youtubeAndPartnersBidMultiplier.readOnly (Total Keys: 1) The following keys were added: - schemas.YoutubeVideoDetails.properties.unavailableReason.readOnly (Total Keys: 1) #### displayvideo:v4 The following keys were deleted: - schemas.AdGroupAd.properties.bumperAd.readOnly (Total Keys: 1) - schemas.AdGroupAd.properties.inStreamAd.readOnly (Total Keys: 1) - schemas.AdGroupAd.properties.nonSkippableAd.readOnly (Total Keys: 1) - schemas.AdGroupAd.properties.videoPerformanceAd.readOnly (Total Keys: 1) - schemas.DeviceTypeAssignedTargetingOptionDetails.properties.youtubeAndPartnersBidMultiplier.readOnly (Total Keys: 1) The following keys were added: - schemas.YoutubeVideoDetails.properties.unavailableReason.readOnly (Total Keys: 1)
#### firebasehosting:v1beta1 The following keys were deleted: - schemas.CustomDomain.properties.name.readOnly (Total Keys: 1)
#### merchantapi:products_v1 The following keys were added: - schemas.Warranty.properties.durationUnit.type (Total Keys: 1)
#### metastore:v1 The following keys were added: - schemas.LakehouseProxyConfig (Total Keys: 7) - schemas.Service.properties.lakehouseProxyConfig (Total Keys: 2) #### metastore:v1alpha The following keys were added: - schemas.LakehouseProxyConfig (Total Keys: 7) - schemas.Service.properties.lakehouseProxyConfig (Total Keys: 2) #### metastore:v1beta The following keys were added: - schemas.LakehouseProxyConfig (Total Keys: 7) - schemas.Service.properties.lakehouseProxyConfig (Total Keys: 2)
#### ondemandscanning:v1 The following keys were added: - schemas.PackageData.properties.layerDetails.deprecated (Total Keys: 1) #### ondemandscanning:v1beta1 The following keys were added: - schemas.PackageData.properties.layerDetails.deprecated (Total Keys: 1)
#### retail:v2alpha The following keys were added: - schemas.GoogleCloudRetailV2alphaCompletionConfig.properties.enableAgentPrompts.type (Total Keys: 1)
#### run:v1 The following keys were added: - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.resolvedWorkerRelease (Total Keys: 2) - schemas.GoogleDevtoolsCloudbuildV1BuildOptions.properties.workerRelease.type (Total Keys: 1) - schemas.GoogleDevtoolsCloudbuildV1PoolOption.properties.resolvedWorkerRelease (Total Keys: 2) - schemas.GoogleDevtoolsCloudbuildV1PoolOption.properties.workerRelease (Total Keys: 2)
#### servicecontrol:v1 The following keys were deleted: - schemas.PolicyViolationInfo.properties.rabPolicyViolationInfo.$ref (Total Keys: 1) - schemas.RabPolicyViolationInfo (Total Keys: 5)
#### serviceusage:v1 The following keys were deleted: - schemas.EnableRule.properties.enableType (Total Keys: 2) The following keys were added: - schemas.EnableRule.properties.catalogs (Total Keys: 2) - schemas.GoogleApiServiceusageV2betaEnableRule.properties.catalogs (Total Keys: 2) #### serviceusage:v1beta1 The following keys were deleted: - schemas.EnableRule.properties.enableType (Total Keys: 2) The following keys were added: - schemas.EnableRule.properties.catalogs (Total Keys: 2) - schemas.GoogleApiServiceusageV2betaEnableRule.properties.catalogs (Total Keys: 2)
#### threatintelligence:v1beta The following keys were added: - schemas.AVDetections (Total Keys: 6) - schemas.AlertDetail.properties.domainMonitoring.$ref (Total Keys: 1) - schemas.CertificateDetails (Total Keys: 5) - schemas.ConfigurationDetail.properties.domainMonitoring.$ref (Total Keys: 1) - schemas.DiscoveryDocument (Total Keys: 6) - schemas.DnsRegistrationDetails (Total Keys: 9) - schemas.DomainMonitoringAlertDetail (Total Keys: 13) - schemas.DomainMonitoringConfig (Total Keys: 4) - schemas.DomainMonitoringDnsDetails (Total Keys: 6) - schemas.DomainMonitoringDnsRecord (Total Keys: 10) - schemas.DomainMonitoringDomain (Total Keys: 6) - schemas.DomainMonitoringFindingDetail (Total Keys: 13) - schemas.DomainMonitoringGtiDetails (Total Keys: 10) - schemas.DomainMonitoringWhoIsDetails (Total Keys: 5) - schemas.FindingDetail.properties.domainMonitoring.$ref (Total Keys: 1) - schemas.Infrastructure (Total Keys: 3) - schemas.InitialAccessBrokerAlertDetail.properties.discoveryDocumentIds.deprecated (Total Keys: 1) - schemas.InitialAccessBrokerAlertDetail.properties.discoveryDocuments (Total Keys: 3) - schemas.Relationships (Total Keys: 6) - schemas.ThreatAttributionDetails (Total Keys: 8)
#### workloadmanager:v1 The following keys were deleted: - endpoints (Total Keys: 1)
#### youtube:v3 The following keys were deleted: - schemas.ActivityContentDetails.properties.favorite.$ref (Total Keys: 1) - schemas.ActivityContentDetails.properties.like.$ref (Total Keys: 1) - schemas.ActivityContentDetailsFavorite (Total Keys: 3) - schemas.ActivityContentDetailsLike (Total Keys: 3)
JoeWang1127
changed the title
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the generated API documentation files by removing parameters from the signatures of new_batch_http_request and various *_next pagination methods. The review feedback correctly points out that while the signatures were updated, the corresponding documentation blocks still list the removed parameters under their Args: sections. It is recommended to remove these obsolete sections to ensure the documentation remains accurate and consistent.
Comment on lines
+100
to
+113
| <code class="details" id="new_batch_http_request">new_batch_http_request()</code> | ||
| <pre>Create a BatchHttpRequest object based on the discovery document. | ||
|
|
||
| Args: | ||
| callback: callable, A callback to be called for each response, of the | ||
| form callback(id, response, exception). The first parameter is the | ||
| request id, and the second is the deserialized response object. The | ||
| third is an apiclient.errors.HttpError exception object if an HTTP | ||
| error occurred while processing the request, or None if no error | ||
| occurred. | ||
|
|
||
| Returns: | ||
| A BatchHttpRequest object based on the discovery document. | ||
| </pre> | ||
| Args: | ||
| callback: callable, A callback to be called for each response, of the | ||
| form callback(id, response, exception). The first parameter is the | ||
| request id, and the second is the deserialized response object. The | ||
| third is an apiclient.errors.HttpError exception object if an HTTP | ||
| error occurred while processing the request, or None if no error | ||
| occurred. | ||
|
|
||
| Returns: | ||
| A BatchHttpRequest object based on the discovery document. | ||
| </pre> |
There was a problem hiding this comment.
The method signature for new_batch_http_request() has been updated to take no arguments, but the documentation block still lists callback under the Args: section. Since the parameter has been removed, the Args: section should be removed from the documentation to prevent confusion.
<code class="details" id="new_batch_http_request">new_batch_http_request()</code>
<pre>Create a BatchHttpRequest object based on the discovery document.
Returns:
A BatchHttpRequest object based on the discovery document.
</pre>
Comment on lines
+407
to
+417
| <code class="details" id="list_next">list_next()</code> | ||
| <pre>Retrieves the next page of results. | ||
|
|
||
| Args: | ||
| previous_request: The request for the previous page. (required) | ||
| previous_response: The response from the request for the previous page. (required) | ||
| Args: | ||
| previous_request: The request for the previous page. (required) | ||
| previous_response: The response from the request for the previous page. (required) | ||
|
|
||
| Returns: | ||
| A request object that you can call 'execute()' on to request the next | ||
| page. Returns None if there are no more items in the collection. | ||
| </pre> | ||
| Returns: | ||
| A request object that you can call 'execute()' on to request the next | ||
| page. Returns None if there are no more items in the collection. | ||
| </pre> |
There was a problem hiding this comment.
The method signature for list_next() has been updated to take no arguments, but the documentation block still lists previous_request and previous_response under the Args: section. Since these parameters have been removed, the Args: section should be removed from the documentation to prevent confusion.
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
JoeWang1127
changed the title
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
1 participant
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.
Deleted keys were detected in the following stable discovery artifacts:
displayvideo v2 dd75e64
displayvideo v3 dd75e64
displayvideo v4 dd75e64
servicecontrol v1 ee7bb22
serviceusage v1 c813020
workloadmanager v1 69b8281
youtube v3 6f1446b
Deleted keys were detected in the following pre-stable discovery artifacts:
firebasehosting v1beta1 0e6c077
serviceusage v1beta1 c813020
Discovery Artifact Change Summary:
feat(androidpublisher): update the api 0e20fc9
fix(biglake): update the api 99c5cc8
feat(bigtableadmin): update the api 7d14914
feat(chat): update the api 3bdc44d
fix(datalineage): update the api 608e434
feat(dataplex): update the api 71772b8
feat(discoveryengine): update the api 46456a7
feat(displayvideo): update the api dd75e64
feat(firebasehosting): update the api 0e6c077
feat(merchantapi): update the api 3c7d880
feat(metastore): update the api 6db8eab
feat(ondemandscanning): update the api 50327cb
feat(retail): update the api e91a2f2
feat(run): update the api 1f0fea0
feat(servicecontrol): update the api ee7bb22
feat(serviceusage): update the api c813020
feat(threatintelligence): update the api 48bfb86
feat(workloadmanager): update the api 69b8281
feat(youtube): update the api 6f1446b