Dpg code gen fix docs (#1861)

* Add return types * Version update * Upgrade the cadl-ranch version to v15 (#1863) * Upgrade the cadl-ranch version * Add test cases for encode * Typo fix * Change to workspace * Remove duplicate generation * make subscirption id optional if there're tenant level operations (#1869) * try fix subscriptionId in tenant level * use overload to fix subscription optional * refine and fix smoke test * fix test and resolve comments * fix sample transform * Re-generate * Add return types * Version update * Remove duplicate generation * Re-generate * Update * re generate tests * use workspace * fix unit test * fix integration test --------- Co-authored-by: Mary Gao <yanmeigao1210@gmail.com> Co-authored-by: Qiaoqiao Zhang <55688292+qiaozha@users.noreply.github.com> Co-authored-by: qiaozha <qiaozha@microsoft.com>
Azure · May 29, 2023 · df35b83 · df35b83
1 parent ed9a308
commit df35b83
Show file tree

Hide file tree

Showing 60 changed files with 507 additions and 1,091 deletions.
diff --git a/...test/rlcIntegration/generated/multipleUrlParameters/src/multipleUrlParameterRestClient.ts b/...test/rlcIntegration/generated/multipleUrlParameters/src/multipleUrlParameterRestClient.ts
@@ -26,7 +26,7 @@ export default function createClient(
   options = {
     ...options,
     credentials: {
-      scopes: ["user_impersonation"]
+      scopes: options.credentials?.scopes ?? ["user_impersonation"]
     }
   };
 

diff --git a/...est.typescript/test/rlcIntegration/generated/securityAADRest/src/securityAADRestClient.ts b/...est.typescript/test/rlcIntegration/generated/securityAADRest/src/securityAADRestClient.ts
@@ -19,7 +19,9 @@ export default function createClient(
   options = {
     ...options,
     credentials: {
-      scopes: ["https://security.microsoft.com/.default"]
+      scopes: options.credentials?.scopes ?? [
+        "https://security.microsoft.com/.default"
+      ]
     }
   };
 

diff --git a/...est.typescript/test/rlcIntegration/generated/securityKeyRest/src/securityKeyRestClient.ts b/...est.typescript/test/rlcIntegration/generated/securityKeyRest/src/securityKeyRestClient.ts
@@ -19,7 +19,7 @@ export default function createClient(
   options = {
     ...options,
     credentials: {
-      apiKeyHeaderName: "security-key"
+      apiKeyHeaderName: options.credentials?.apiKeyHeaderName ?? "security-key"
     }
   };
 

diff --git a/...ipt/test/smoke/generated/agrifood-data-plane/src/azureAgriFoodPlatformDataPlaneService.ts b/...ipt/test/smoke/generated/agrifood-data-plane/src/azureAgriFoodPlatformDataPlaneService.ts
@@ -22,7 +22,7 @@ export default function createClient(
   options = {
     ...options,
     credentials: {
-      apiKeyHeaderName: "Authorization"
+      apiKeyHeaderName: options.credentials?.apiKeyHeaderName ?? "Authorization"
     }
   };
 

diff --git a/...utorest.typescript/test/smoke/generated/anomaly-detector-mv-rest/src/anomalyDetectorMV.ts b/...utorest.typescript/test/smoke/generated/anomaly-detector-mv-rest/src/anomalyDetectorMV.ts
@@ -28,7 +28,8 @@ export default function createClient(
   options = {
     ...options,
     credentials: {
-      apiKeyHeaderName: "Ocp-Apim-Subscription-Key"
+      apiKeyHeaderName:
+        options.credentials?.apiKeyHeaderName ?? "Ocp-Apim-Subscription-Key"
     }
   };
 

diff --git a/...autorest.typescript/test/smoke/generated/anomaly-detector-rest/src/anomalyDetectorRest.ts b/...autorest.typescript/test/smoke/generated/anomaly-detector-rest/src/anomalyDetectorRest.ts
@@ -25,7 +25,8 @@ export default function createClient(
   options = {
     ...options,
     credentials: {
-      apiKeyHeaderName: "Ocp-Apim-Subscription-Key"
+      apiKeyHeaderName:
+        options.credentials?.apiKeyHeaderName ?? "Ocp-Apim-Subscription-Key"
     }
   };
 

diff --git a/...typescript/test/smoke/generated/purview-administration-rest/src/account/purviewAccount.ts b/...typescript/test/smoke/generated/purview-administration-rest/src/account/purviewAccount.ts
@@ -22,7 +22,9 @@ export function createClient(
   options = {
     ...options,
     credentials: {
-      scopes: ["https://purview.azure.net/.default"]
+      scopes: options.credentials?.scopes ?? [
+        "https://purview.azure.net/.default"
+      ]
     }
   };
 

diff --git a/...oke/generated/purview-administration-rest/src/metadataPolicies/purviewMetadataPolicies.ts b/...oke/generated/purview-administration-rest/src/metadataPolicies/purviewMetadataPolicies.ts
@@ -22,7 +22,7 @@ export function createClient(
   options = {
     ...options,
     credentials: {
-      apiKeyHeaderName: "CustomAuth"
+      apiKeyHeaderName: options.credentials?.apiKeyHeaderName ?? "CustomAuth"
     }
   };
 

diff --git a/...s/autorest.typescript/test/smoke/generated/synapse-artifacts-rest/src/synapseArtifacts.ts b/...s/autorest.typescript/test/smoke/generated/synapse-artifacts-rest/src/synapseArtifacts.ts
@@ -22,7 +22,9 @@ export default function createClient(
   options = {
     ...options,
     credentials: {
-      scopes: ["https://dev.azuresynapse.net/.default"]
+      scopes: options.credentials?.scopes ?? [
+        "https://dev.azuresynapse.net/.default"
+      ]
     }
   };
 

diff --git a/packages/rlc-common/src/buildClient.ts b/packages/rlc-common/src/buildClient.ts
@@ -284,10 +284,12 @@ function getClientFactoryBody(
     credentialScopes && credentialScopes.length
       ? credentialScopes.map((cs) => `"${cs}"`).join(", ")
       : "";
-  const scopes = scopesString ? `scopes: [${scopesString}],` : "";
+  const scopes = scopesString
+    ? `scopes: options.credentials?.scopes ?? [${scopesString}],`
+    : "";
 
   const apiKeyHeaderName = credentialKeyHeaderName
-    ? `apiKeyHeaderName: "${credentialKeyHeaderName}",`
+    ? `apiKeyHeaderName: options.credentials?.apiKeyHeaderName ?? "${credentialKeyHeaderName}",`
     : "";
 
   const credentials =

diff --git a/packages/typespec-test/test/anomalyDetector/generated/typespec-ts/src/anomalyDetector.ts b/packages/typespec-test/test/anomalyDetector/generated/typespec-ts/src/anomalyDetector.ts
@@ -29,7 +29,8 @@ export default function createClient(
   options = {
     ...options,
     credentials: {
-      apiKeyHeaderName: "Ocp-Apim-Subscription-Key",
+      apiKeyHeaderName:
+        options.credentials?.apiKeyHeaderName ?? "Ocp-Apim-Subscription-Key",
     },
   };
 

diff --git a/...horing/generated/typespec-ts/src/microsoftCognitiveLanguageServiceAnalyzeTextAuthoring.ts b/...horing/generated/typespec-ts/src/microsoftCognitiveLanguageServiceAnalyzeTextAuthoring.ts
@@ -22,7 +22,8 @@ export default function createClient(
   options = {
     ...options,
     credentials: {
-      apiKeyHeaderName: "Ocp-Apim-Subscription-Key",
+      apiKeyHeaderName:
+        options.credentials?.apiKeyHeaderName ?? "Ocp-Apim-Subscription-Key",
     },
   };
 

diff --git a/...espec-test/test/confidentialLedger/generated/typespec-ts/src/confidentialLedgerService.ts b/...espec-test/test/confidentialLedger/generated/typespec-ts/src/confidentialLedgerService.ts
@@ -22,7 +22,9 @@ export default function createClient(
   options = {
     ...options,
     credentials: {
-      scopes: ["https://confidential-ledger.azure.com/.default"],
+      scopes: options.credentials?.scopes ?? [
+        "https://confidential-ledger.azure.com/.default",
+      ],
     },
   };
 

diff --git a/...rapper/generated/typespec-ts/src/microsoftCognitiveLanguageServiceAnalyzeTextAuthoring.ts b/...rapper/generated/typespec-ts/src/microsoftCognitiveLanguageServiceAnalyzeTextAuthoring.ts
@@ -22,7 +22,8 @@ export default function createClient(
   options = {
     ...options,
     credentials: {
-      apiKeyHeaderName: "Ocp-Apim-Subscription-Key",
+      apiKeyHeaderName:
+        options.credentials?.apiKeyHeaderName ?? "Ocp-Apim-Subscription-Key",
     },
   };
 

diff --git a/...espec-test/test/eventgrid_modular/generated/typespec-ts/review/eventgrid.api.md b/...espec-test/test/eventgrid_modular/generated/typespec-ts/review/eventgrid.api.md
@@ -4,8 +4,7 @@
 
 ```ts
 
-import { ClientOptions as ClientOptions_2 } from '@azure-rest/core-client';
-import { HttpResponse } from '@azure-rest/core-client';
+import { ClientOptions } from '@azure-rest/core-client';
 import { KeyCredential } from '@azure/core-auth';
 import { RawHttpHeadersInput } from '@azure/core-rest-pipeline';
 
@@ -14,33 +13,18 @@ export interface AcknowledgeCloudEventsOptions extends RequestOptions {
     contentType?: string;
 }
 
-// @public
-export interface AcknowledgeOptions {
-    lockTokens: string[];
-}
-
 // @public
 export interface AcknowledgeResult {
     failedLockTokens: FailedLockToken[];
     succeededLockTokens: string[];
 }
 
-// @public (undocumented)
-export interface AcknowledgeResult {
-    failedLockTokens: FailedLockToken[];
-    succeededLockTokens: string[];
-}
-
 // @public
 export interface BrokerProperties {
     deliveryCount: number;
     lockToken: string;
 }
 
-// @public (undocumented)
-export interface ClientOptions extends ClientOptions_2 {
-}
-
 // @public
 export interface CloudEvent {
     data?: any;
@@ -57,21 +41,19 @@ export interface CloudEvent {
 
 // @public (undocumented)
 export class EventGridClient {
-    constructor(endpoint: string, credential: KeyCredential, options?: ClientOptions);
-    // (undocumented)
+    constructor(endpoint: string, credential: KeyCredential, options?: EventGridClientOptions);
     acknowledgeCloudEvents(lockTokens: string[], topicName: string, eventSubscriptionName: string, options?: AcknowledgeCloudEventsOptions): Promise<AcknowledgeResult>;
-    // (undocumented)
     publishCloudEvent(event: CloudEvent, topicName: string, options?: PublishCloudEventOptions): Promise<Record<string, any>>;
-    // (undocumented)
     publishCloudEvents(events: CloudEvent[], topicName: string, options?: PublishCloudEventsOptions): Promise<Record<string, any>>;
-    // (undocumented)
     receiveCloudEvents(topicName: string, eventSubscriptionName: string, options?: ReceiveCloudEventsOptions): Promise<ReceiveResult>;
-    // (undocumented)
     rejectCloudEvents(lockTokens: string[], topicName: string, eventSubscriptionName: string, options?: RejectCloudEventsOptions): Promise<RejectResult>;
-    // (undocumented)
     releaseCloudEvents(lockTokens: string[], topicName: string, eventSubscriptionName: string, options?: ReleaseCloudEventsOptions): Promise<ReleaseResult>;
 }
 
+// @public (undocumented)
+export interface EventGridClientOptions extends ClientOptions {
+}
+
 // @public
 export interface FailedLockToken {
     errorCode: string;
@@ -84,12 +66,6 @@ export interface PublishCloudEventOptions extends RequestOptions {
     contentType?: string;
 }
 
-// @public (undocumented)
-export interface PublishCloudEventRequest {
-    // (undocumented)
-    event: CloudEvent;
-}
-
 // @public (undocumented)
 export interface PublishCloudEventsOptions extends RequestOptions {
     contentType?: string;
@@ -112,28 +88,12 @@ export interface ReceiveResult {
     value: ReceiveDetails[];
 }
 
-// @public (undocumented)
-export interface ReceiveResult {
-    value: ReceiveDetails[];
-}
-
 // @public (undocumented)
 export interface RejectCloudEventsOptions extends RequestOptions {
     contentType?: string;
 }
 
 // @public
-export interface RejectOptions {
-    lockTokens: string[];
-}
-
-// @public
-export interface RejectResult {
-    failedLockTokens: FailedLockToken[];
-    succeededLockTokens: string[];
-}
-
-// @public (undocumented)
 export interface RejectResult {
     failedLockTokens: FailedLockToken[];
     succeededLockTokens: string[];
@@ -144,31 +104,18 @@ export interface ReleaseCloudEventsOptions extends RequestOptions {
     contentType?: string;
 }
 
-// @public
-export interface ReleaseOptions {
-    lockTokens: string[];
-}
-
 // @public
 export interface ReleaseResult {
     failedLockTokens: FailedLockToken[];
     succeededLockTokens: string[];
 }
 
-// @public (undocumented)
-export interface ReleaseResult {
-    failedLockTokens: FailedLockToken[];
-    succeededLockTokens: string[];
-}
-
-// @public (undocumented)
+// @public
 export interface RequestOptions {
-    // (undocumented)
     requestOptions?: {
         headers?: RawHttpHeadersInput;
         allowInsecureConnection?: boolean;
         skipUrlEncoding?: boolean;
-        onResponse?: (response: HttpResponse) => void;
     };
 }
 

diff --git a/packages/typespec-test/test/eventgrid_modular/generated/typespec-ts/src/EventGridClient.ts b/packages/typespec-test/test/eventgrid_modular/generated/typespec-ts/src/EventGridClient.ts
@@ -2,10 +2,10 @@
 // Licensed under the MIT license.
 
 import { KeyCredential } from "@azure/core-auth";
-import { ClientOptions } from "./common/interfaces.js";
 import {
   createEventGrid,
   EventGridContext,
+  EventGridClientOptions,
   CloudEvent,
   ReceiveResult,
   AcknowledgeResult,
@@ -25,18 +25,21 @@ import {
   RejectCloudEventsOptions,
 } from "./api/index.js";
 
+export { EventGridClientOptions } from "./api/EventGridContext.js";
+
 export class EventGridClient {
   private _client: EventGridContext;
 
   /** Azure Messaging EventGrid Client */
   constructor(
     endpoint: string,
     credential: KeyCredential,
-    options: ClientOptions = {}
+    options: EventGridClientOptions = {}
   ) {
     this._client = createEventGrid(endpoint, credential, options);
   }
 
+  /** Publish Single Cloud Event to namespace topic. In case of success, the server responds with an HTTP 200 status code with an empty JSON object in response. Otherwise, the server can return various error codes. For example, 401: which indicates authorization failure, 403: which indicates quota exceeded or message is too large, 410: which indicates that specific topic is not found, 400: for bad request, and 500: for internal server error. */
   publishCloudEvent(
     event: CloudEvent,
     topicName: string,
@@ -45,6 +48,7 @@ export class EventGridClient {
     return publishCloudEvent(this._client, event, topicName, options);
   }
 
+  /** Publish Batch Cloud Event to namespace topic. In case of success, the server responds with an HTTP 200 status code with an empty JSON object in response. Otherwise, the server can return various error codes. For example, 401: which indicates authorization failure, 403: which indicates quota exceeded or message is too large, 410: which indicates that specific topic is not found, 400: for bad request, and 500: for internal server error. */
   publishCloudEvents(
     events: CloudEvent[],
     topicName: string,
@@ -53,6 +57,7 @@ export class EventGridClient {
     return publishCloudEvents(this._client, events, topicName, options);
   }
 
+  /** Receive Batch of Cloud Events from the Event Subscription. */
   receiveCloudEvents(
     topicName: string,
     eventSubscriptionName: string,
@@ -66,6 +71,7 @@ export class EventGridClient {
     );
   }
 
+  /** Acknowledge batch of Cloud Events. The server responds with an HTTP 200 status code if at least one event is successfully acknowledged. The response body will include the set of successfully acknowledged lockTokens, along with other failed lockTokens with their corresponding error information. Successfully acknowledged events will no longer be available to any consumer. */
   acknowledgeCloudEvents(
     lockTokens: string[],
     topicName: string,
@@ -81,6 +87,7 @@ export class EventGridClient {
     );
   }
 
+  /** Release batch of Cloud Events. The server responds with an HTTP 200 status code if at least one event is successfully released. The response body will include the set of successfully released lockTokens, along with other failed lockTokens with their corresponding error information. */
   releaseCloudEvents(
     lockTokens: string[],
     topicName: string,
@@ -96,6 +103,7 @@ export class EventGridClient {
     );
   }
 
+  /** Reject batch of Cloud Events. */
   rejectCloudEvents(
     lockTokens: string[],
     topicName: string,

diff --git a/...es/typespec-test/test/eventgrid_modular/generated/typespec-ts/src/api/EventGridContext.ts b/...es/typespec-test/test/eventgrid_modular/generated/typespec-ts/src/api/EventGridContext.ts
@@ -2,17 +2,19 @@
 // Licensed under the MIT license.
 
 import { EventGridContext } from "../rest/index.js";
+import { ClientOptions } from "@azure-rest/core-client";
 import { KeyCredential } from "@azure/core-auth";
 import getClient from "../rest/index.js";
-import { ClientOptions } from "../common/interfaces.js";
 
 export { EventGridContext } from "../rest/index.js";
 
+export interface EventGridClientOptions extends ClientOptions {}
+
 /** Azure Messaging EventGrid Client */
 export function createEventGrid(
   endpoint: string,
   credential: KeyCredential,
-  options: ClientOptions = {}
+  options: EventGridClientOptions = {}
 ): EventGridContext {
   const baseUrl = endpoint;
   options.credentials = {