From a45f25c4f23b602faed0e1e4d4b4e587f9cc0e69 Mon Sep 17 00:00:00 2001 From: Mary Gao Date: Fri, 21 Feb 2025 13:17:11 +0800 Subject: [PATCH 1/4] Add imports and usings infor to resolve compile issues --- .../Generate client libraries/04renaming.mdx | 26 +++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/website/src/content/docs/docs/howtos/Generate client libraries/04renaming.mdx b/website/src/content/docs/docs/howtos/Generate client libraries/04renaming.mdx index ed0b6bf081..01b33a9a4c 100644 --- a/website/src/content/docs/docs/howtos/Generate client libraries/04renaming.mdx +++ b/website/src/content/docs/docs/howtos/Generate client libraries/04renaming.mdx @@ -20,8 +20,34 @@ By default, any language code generator will assume the TYPESPEC name is the cli ```typespec title=main.tsp +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using Azure.Core; +using TypeSpec.Versioning; + +@service({ + title: "Contoso Widget Manager", +}) +@server( + "{endpoint}/widget", + "Contoso Widget APIs", + { + endpoint: string, + } +) +@versioned(PetStoreNamespace.Versions) namespace PetStoreNamespace; +enum Versions { + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + `2022-08-30`, +} + /** This is the input I need */ @resource("input") model InputModel { From 5c4bb20e67069e93ff723b85aad9655e555d0a0a Mon Sep 17 00:00:00 2001 From: Mary Gao Date: Fri, 21 Feb 2025 13:20:08 +0800 Subject: [PATCH 2/4] Update the typescript comments --- .../docs/howtos/Generate client libraries/04renaming.mdx | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/website/src/content/docs/docs/howtos/Generate client libraries/04renaming.mdx b/website/src/content/docs/docs/howtos/Generate client libraries/04renaming.mdx index 01b33a9a4c..1df688f431 100644 --- a/website/src/content/docs/docs/howtos/Generate client libraries/04renaming.mdx +++ b/website/src/content/docs/docs/howtos/Generate client libraries/04renaming.mdx @@ -92,6 +92,7 @@ namespace PetStoreNamespace ``` ```typescript +// Here is the generated code for TypeScript RLC interface InputModel { name: string; } @@ -173,7 +174,7 @@ namespace PetStoreNamespace ``` ```typescript -// Typescript do not change behavior based on protocolAPI or convenientAPI +// TypeScript RLC won't change behavior based on protocolAPI or convenientAPI ``` ```java @@ -237,7 +238,7 @@ namespace PetStoreNamespace ``` ```typescript -// Typescript do not change behavior based on protocolAPI or convenientAPI +// TypeScript RLC won't change behavior based on protocolAPI or convenientAPI ``` ```java From 2656949cd63d1de1ce6e997a9e531de196750c87 Mon Sep 17 00:00:00 2001 From: Mary Gao Date: Fri, 21 Feb 2025 13:27:32 +0800 Subject: [PATCH 3/4] Update the specs --- .../docs/docs/howtos/Generate client libraries/04renaming.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/src/content/docs/docs/howtos/Generate client libraries/04renaming.mdx b/website/src/content/docs/docs/howtos/Generate client libraries/04renaming.mdx index 1df688f431..a48f9bcc12 100644 --- a/website/src/content/docs/docs/howtos/Generate client libraries/04renaming.mdx +++ b/website/src/content/docs/docs/howtos/Generate client libraries/04renaming.mdx @@ -31,11 +31,11 @@ using Azure.Core; using TypeSpec.Versioning; @service({ - title: "Contoso Widget Manager", + title: "Pet Store Client", }) @server( "{endpoint}/widget", - "Contoso Widget APIs", + "Pet Store APIs", { endpoint: string, } From 97dd27654f7c6a2b2864bdbbb6c4d309faec99f3 Mon Sep 17 00:00:00 2001 From: Mary Gao Date: Fri, 21 Feb 2025 14:08:07 +0800 Subject: [PATCH 4/4] Remove the import parts --- .../Generate client libraries/04renaming.mdx | 26 ------------------- 1 file changed, 26 deletions(-) diff --git a/website/src/content/docs/docs/howtos/Generate client libraries/04renaming.mdx b/website/src/content/docs/docs/howtos/Generate client libraries/04renaming.mdx index a48f9bcc12..2e47f1d9ac 100644 --- a/website/src/content/docs/docs/howtos/Generate client libraries/04renaming.mdx +++ b/website/src/content/docs/docs/howtos/Generate client libraries/04renaming.mdx @@ -20,34 +20,8 @@ By default, any language code generator will assume the TYPESPEC name is the cli ```typespec title=main.tsp -import "@typespec/http"; -import "@typespec/rest"; -import "@typespec/versioning"; -import "@azure-tools/typespec-azure-core"; - -using TypeSpec.Http; -using TypeSpec.Rest; -using Azure.Core; -using TypeSpec.Versioning; - -@service({ - title: "Pet Store Client", -}) -@server( - "{endpoint}/widget", - "Pet Store APIs", - { - endpoint: string, - } -) -@versioned(PetStoreNamespace.Versions) namespace PetStoreNamespace; -enum Versions { - @useDependency(Azure.Core.Versions.v1_0_Preview_2) - `2022-08-30`, -} - /** This is the input I need */ @resource("input") model InputModel {