adjusting built-in rest api template (#5741)

Making adjustment of built-in template sample to better working with CSharp server codege. --------- Co-authored-by: Timothee Guerin <[email protected]> Co-authored-by: Timothee Guerin <[email protected]>
microsoft · Jan 24, 2025 · 249e694 · 249e694
1 parent c788082
commit 249e694
Show file tree

Hide file tree

Showing 9 changed files with 66 additions and 69 deletions.
diff --git a/.chronus/changes/fix_builtinTemplate-2025-0-24-1-37-7.md b/.chronus/changes/fix_builtinTemplate-2025-0-24-1-37-7.md
@@ -0,0 +1,7 @@
+---
+changeKind: internal
+packages:
+  - "@typespec/compiler"
+---
+
+Adjust built-in init template sample
diff --git a/.chronus/changes/fix_builtinTemplate-2025-0-24-21-57-49.md b/.chronus/changes/fix_builtinTemplate-2025-0-24-21-57-49.md
@@ -0,0 +1,8 @@
+---
+# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking
+changeKind: internal
+packages:
+  - typespec-vscode
+---
+
+update test framework version
diff --git a/eng/tsp-core/pipelines/templates/install-browsers.yml b/eng/tsp-core/pipelines/templates/install-browsers.yml
@@ -1,5 +1,4 @@
 # Template installing browsers
 steps:
-  - script: npx playwright install --with-deps
+  - script: pnpm exec playwright install
     displayName: Install playwright browsers
-    workingDirectory: packages/playground-website
diff --git a/packages/compiler/.scripts/build-init-templates.ts b/packages/compiler/.scripts/build-init-templates.ts
@@ -39,7 +39,7 @@ const builtInTemplates: Record<string, InitTemplate> = {
           "emitter-output-dir": "{output-dir}/clients/java",
         },
       },
-      "@typespec/http-client-js": {
+      "@azure-tools/typespec-ts": {
         description: "JavaScript Client emitter",
         options: {
           "emitter-output-dir": "{output-dir}/clients/js",
@@ -54,7 +54,7 @@ const builtInTemplates: Record<string, InitTemplate> = {
       "@typespec/http-server-csharp": {
         description: "CSharp server stubs",
         options: {
-          "emitter-output-dir": "{output-dir}/server",
+          "emitter-output-dir": "{output-dir}/server/generated",
         },
       },
       "@typespec/http-server-js": {

diff --git a/packages/compiler/templates/__snapshots__/rest/main.tsp b/packages/compiler/templates/__snapshots__/rest/main.tsp
@@ -7,34 +7,40 @@ using TypeSpec.Http;
 namespace DemoService;
 
 model Widget {
-  @visibility("read", "update")
-  @path
   id: string;
-
   weight: int32;
   color: "red" | "blue";
 }
 
+model WidgetList {
+  items: Widget[];
+}
+
 @error
 model Error {
   code: int32;
   message: string;
 }
 
+model AnalyzeResult {
+  id: string;
+  analysis: string;
+}
+
 @route("/widgets")
 @tag("Widgets")
 interface Widgets {
   /** List widgets */
-  @get list(): Widget[] | Error;
+  @get list(): WidgetList | Error;
   /** Read widgets */
   @get read(@path id: string): Widget | Error;
   /** Create a widget */
-  @post create(...Widget): Widget | Error;
+  @post create(@body body: Widget): Widget | Error;
   /** Update a widget */
-  @patch update(...Widget): Widget | Error;
+  @patch update(@path id: string, @body body: Widget): Widget | Error;
   /** Delete a widget */
   @delete delete(@path id: string): void | Error;
 
   /** Analyze a widget */
-  @route("{id}/analyze") @post analyze(@path id: string): string | Error;
+  @route("{id}/analyze") @post analyze(@path id: string): AnalyzeResult | Error;
 }
diff --git a/packages/compiler/templates/rest/main.tsp b/packages/compiler/templates/rest/main.tsp
@@ -7,34 +7,40 @@ using TypeSpec.Http;
 namespace DemoService;
 
 model Widget {
-  @visibility("read", "update")
-  @path
   id: string;
-
   weight: int32;
   color: "red" | "blue";
 }
 
+model WidgetList {
+  items: Widget[];
+}
+
 @error
 model Error {
   code: int32;
   message: string;
 }
 
+model AnalyzeResult {
+  id: string;
+  analysis: string;
+}
+
 @route("/widgets")
 @tag("Widgets")
 interface Widgets {
   /** List widgets */
-  @get list(): Widget[] | Error;
+  @get list(): WidgetList | Error;
   /** Read widgets */
   @get read(@path id: string): Widget | Error;
   /** Create a widget */
-  @post create(...Widget): Widget | Error;
+  @post create(@body body: Widget): Widget | Error;
   /** Update a widget */
-  @patch update(...Widget): Widget | Error;
+  @patch update(@path id: string, @body body: Widget): Widget | Error;
   /** Delete a widget */
   @delete delete(@path id: string): void | Error;
 
   /** Analyze a widget */
-  @route("{id}/analyze") @post analyze(@path id: string): string | Error;
+  @route("{id}/analyze") @post analyze(@path id: string): AnalyzeResult | Error;
 }
diff --git a/packages/compiler/templates/scaffolding.json b/packages/compiler/templates/scaffolding.json
@@ -34,7 +34,7 @@
           "emitter-output-dir": "{output-dir}/clients/java"
         }
       },
-      "@typespec/http-client-js": {
+      "@azure-tools/typespec-ts": {
         "description": "JavaScript Client emitter",
         "options": {
           "emitter-output-dir": "{output-dir}/clients/js"
@@ -49,7 +49,7 @@
       "@typespec/http-server-csharp": {
         "description": "CSharp server stubs",
         "options": {
-          "emitter-output-dir": "{output-dir}/server"
+          "emitter-output-dir": "{output-dir}/server/generated"
         }
       },
       "@typespec/http-server-js": {

diff --git a/packages/typespec-vscode/package.json b/packages/typespec-vscode/package.json
@@ -254,7 +254,7 @@
     "@typespec/internal-build-utils": "workspace:~",
     "@vitest/coverage-v8": "^3.0.4",
     "@vitest/ui": "^3.0.3",
-    "@vscode/test-web": "^0.0.62",
+    "@vscode/test-web": "^0.0.65",
     "@vscode/vsce": "~3.2.1",
     "c8": "^10.1.3",
     "mocha": "^11.1.0",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml