[@azure/core-http-compat] Rename ExtendedOptions to ExtendedClientOptions (#20433)

sarangan12 · web-flow · commit bf5747db6d76 · 2022-02-18T12:12:51.000-08:00
* Rename ExtendedOptions to ExtendedClientOptions

* Update ci.yml
diff --git a/sdk/core/ci.yml b/sdk/core/ci.yml
@@ -66,3 +66,5 @@ extends:
         safeName: azurecoreutil
       - name: azure-logger
         safeName: azurelogger
+      - name: azure-core-http-compat
+        safeName: azurecorehttpcompat
diff --git a/sdk/core/core-http-compat/README.md b/sdk/core/core-http-compat/README.md
@@ -4,35 +4,6 @@ This library provides classes and interfaces to be used by Azure client librarie
 
 ## Usage
 
-### ExtendedServiceClientOptions
-
-With `@azure/core-http` library, the `options` parameter to the generated client will look like:
-
-```
-export interface SearchClientOptionalParams extends coreHttp.ServiceClientOptions {
-  /** Overrides client endpoint. */
-  endpoint?: string;
-}
-```
-
-With the `@azure/core-client` & `@azure/core-rest-pipeline` libraries, the `options` parameter to the generated client will look like:
-
-```
-export interface SearchClientOptionalParams extends coreClient.ServiceClientOptions {
-  /** Overrides client endpoint. */
-  endpoint?: string;
-}
-```
-
-With the Core HTTP Compatibility library, the `options` parameter to the generated client will look like:
-
-```
-export interface SearchClientOptionalParams extends coreHttpCompat.ExtendedServiceClientOptions {
-  /** Overrides client endpoint. */
-  endpoint?: string;
-}
-```
-
 ### ExtendedCommonClientOptions
 
 With `@azure/core-http` library, the `options` parameter to the custom client will look like:
diff --git a/sdk/core/core-http-compat/review/core-http-compat.api.md b/sdk/core/core-http-compat/review/core-http-compat.api.md
@@ -12,21 +12,21 @@ import { ServiceClientOptions } from '@azure/core-client';
 export const disbaleKeepAlivePolicyName = "DisableKeepAlivePolicy";
 
 // @public
-export type ExtendedCommonClientOptions = CommonClientOptions & ExtendedOptions;
-
-// @public
-export interface ExtendedOptions {
+export interface ExtendedClientOptions {
     keepAliveOptions?: KeepAliveOptions;
     redirectOptions?: RedirectOptions;
 }
 
+// @public
+export type ExtendedCommonClientOptions = CommonClientOptions & ExtendedClientOptions;
+
 // @public
 export class ExtendedServiceClient extends ServiceClient {
     constructor(options: ExtendedServiceClientOptions);
 }
 
 // @public
-export type ExtendedServiceClientOptions = ServiceClientOptions & ExtendedOptions;
+export type ExtendedServiceClientOptions = ServiceClientOptions & ExtendedClientOptions;
 
 // @public
 export interface KeepAliveOptions {
diff --git a/sdk/core/core-http-compat/src/extendedClient.ts b/sdk/core/core-http-compat/src/extendedClient.ts
@@ -12,7 +12,7 @@ import { CommonClientOptions } from "@azure/core-client";
 /**
  * Options specific to Shim Clients.
  */
-export interface ExtendedOptions {
+export interface ExtendedClientOptions {
   /**
    * Options to disable keep alive.
    */
@@ -26,12 +26,12 @@ export interface ExtendedOptions {
 /**
  * Options that shim clients are expected to expose.
  */
-export type ExtendedServiceClientOptions = ServiceClientOptions & ExtendedOptions;
+export type ExtendedServiceClientOptions = ServiceClientOptions & ExtendedClientOptions;
 
 /**
  * The common set of options that custom shim clients are expected to expose.
  */
-export type ExtendedCommonClientOptions = CommonClientOptions & ExtendedOptions;
+export type ExtendedCommonClientOptions = CommonClientOptions & ExtendedClientOptions;
 
 /**
  * Client to provide compatability between core V1 & V2.
diff --git a/sdk/core/core-http-compat/src/index.ts b/sdk/core/core-http-compat/src/index.ts
@@ -10,7 +10,7 @@ export {
   ExtendedServiceClient,
   ExtendedServiceClientOptions,
   ExtendedCommonClientOptions,
-  ExtendedOptions,
+  ExtendedClientOptions,
 } from "./extendedClient";
 export { KeepAliveOptions } from "./policies/keepAliveOptions";
 export { RedirectOptions } from "./policies/redirectOptions";
