docs: deprecate authorization_code

Google APIs · copybara-github · commit b678386866ca · 2024-08-19T14:56:54.000-07:00
PiperOrigin-RevId: 664993498
diff --git a/google/cloud/bigquery/datatransfer/v1/datatransfer.proto b/google/cloud/bigquery/datatransfer/v1/datatransfer.proto
@@ -512,30 +512,35 @@ message CreateTransferConfigRequest {
   // Required. Data transfer configuration to create.
   TransferConfig transfer_config = 2 [(google.api.field_behavior) = REQUIRED];
 
+  // Deprecated: Authorization code was required when
+  // `transferConfig.dataSourceId` is 'youtube_channel' but it is no longer used
+  // in any data sources. Use `version_info` instead.
+  //
   // Optional OAuth2 authorization code to use with this transfer configuration.
   // This is required only if `transferConfig.dataSourceId` is 'youtube_channel'
   // and new credentials are needed, as indicated by `CheckValidCreds`. In order
   // to obtain authorization_code, make a request to the following URL:
   // <pre class="prettyprint" suppresswarning="true">
   // https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=<var>client_id</var>&scope=<var>data_source_scopes</var>
   // </pre>
-  // * The <var>client_id</var> is the OAuth client_id of the a data source as
+  // * The <var>client_id</var> is the OAuth client_id of the data source as
   // returned by ListDataSources method.
   // * <var>data_source_scopes</var> are the scopes returned by ListDataSources
   // method.
   //
   // Note that this should not be set when `service_account_name` is used to
   // create the transfer config.
-  string authorization_code = 3;
+  string authorization_code = 3 [deprecated = true];
 
-  // Optional version info. This is required only if
-  // `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials
+  // Optional version info. This parameter replaces `authorization_code` which
+  // is no longer used in any data sources. This is required only if
+  // `transferConfig.dataSourceId` is 'youtube_channel' *or* new credentials
   // are needed, as indicated by `CheckValidCreds`. In order to obtain version
   // info, make a request to the following URL:
   // <pre class="prettyprint" suppresswarning="true">
   // https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=<var>client_id</var>&scope=<var>data_source_scopes</var>
   // </pre>
-  // * The <var>client_id</var> is the OAuth client_id of the a data source as
+  // * The <var>client_id</var> is the OAuth client_id of the data source as
   // returned by ListDataSources method.
   // * <var>data_source_scopes</var> are the scopes returned by ListDataSources
   // method.
@@ -562,34 +567,39 @@ message UpdateTransferConfigRequest {
   // Required. Data transfer configuration to create.
   TransferConfig transfer_config = 1 [(google.api.field_behavior) = REQUIRED];
 
+  // Deprecated: Authorization code was required when
+  // `transferConfig.dataSourceId` is 'youtube_channel' but it is no longer used
+  // in any data sources. Use `version_info` instead.
+  //
   // Optional OAuth2 authorization code to use with this transfer configuration.
   // This is required only if `transferConfig.dataSourceId` is 'youtube_channel'
   // and new credentials are needed, as indicated by `CheckValidCreds`. In order
   // to obtain authorization_code, make a request to the following URL:
   // <pre class="prettyprint" suppresswarning="true">
   // https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=<var>client_id</var>&scope=<var>data_source_scopes</var>
   // </pre>
-  // * The <var>client_id</var> is the OAuth client_id of the a data source as
+  // * The <var>client_id</var> is the OAuth client_id of the data source as
   // returned by ListDataSources method.
   // * <var>data_source_scopes</var> are the scopes returned by ListDataSources
   // method.
   //
   // Note that this should not be set when `service_account_name` is used to
   // update the transfer config.
-  string authorization_code = 3;
+  string authorization_code = 3 [deprecated = true];
 
   // Required. Required list of fields to be updated in this request.
   google.protobuf.FieldMask update_mask = 4
       [(google.api.field_behavior) = REQUIRED];
 
-  // Optional version info. This is required only if
-  // `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials
+  // Optional version info. This parameter replaces `authorization_code` which
+  // is no longer used in any data sources. This is required only if
+  // `transferConfig.dataSourceId` is 'youtube_channel' *or* new credentials
   // are needed, as indicated by `CheckValidCreds`. In order to obtain version
   // info, make a request to the following URL:
   // <pre class="prettyprint" suppresswarning="true">
   // https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=<var>client_id</var>&scope=<var>data_source_scopes</var>
   // </pre>
-  // * The <var>client_id</var> is the OAuth client_id of the a data source as
+  // * The <var>client_id</var> is the OAuth client_id of the data source as
   // returned by ListDataSources method.
   // * <var>data_source_scopes</var> are the scopes returned by ListDataSources
   // method.
