@typespec/http-specs 0.38.0-dev.3 → 0.38.0-dev.5

package/specs/payload/content-negotiation/main.tsp

@@ -0,0 +1,61 @@
+import "@typespec/http";
+import "@typespec/spec-lib";
+
+using Http;
+using SpecLib;
+
+@doc("Test describing optionality of the request body.")
+@scenarioService("/content-negotiation")
+namespace Payload.ContentNegotiation;
+
+@scenario
+@scenarioDoc("""
+  Scenario that returns a different file encoding depending on the accept header.
+  
+  - image/png return a png image
+  - image/jpeg return a jpeg image
+  """)
+@route("same-body")
+namespace SameBody {
+  model PngImage {
+    @header contentType: "image/png";
+    @body image: bytes;
+  }
+
+  model JpegImage {
+    @header contentType: "image/jpeg";
+    @body image: bytes;
+  }
+
+  @sharedRoute
+  op getAvatarAsPng(@header accept: "image/png"): PngImage;
+
+  @sharedRoute
+  op getAvatarAsJpeg(@header accept: "image/jpeg"): JpegImage;
+}
+
+@scenario
+@scenarioDoc("""
+  Scenario that a different payload depending on the accept header.
+  
+  - application/json return a png image in a Json object
+  - image/png return the png image
+  """)
+@route("different-body")
+namespace DifferentBody {
+  model PngImage {
+    @header contentType: "image/png";
+    @body image: bytes;
+  }
+
+  model PngImageAsJson {
+    @header contentType: "application/json";
+    content: bytes;
+  }
+
+  @sharedRoute
+  op getAvatarAsPng(@header accept: "image/png"): PngImage;
+
+  @sharedRoute
+  op getAvatarAsJson(@header accept: "application/json"): PngImageAsJson;
+}

package/specs/payload/content-negotiation/mockapi.ts

@@ -0,0 +1,188 @@
+import {
+  json,
+  MockRequest,
+  ScenarioMockApi,
+  ValidationError,
+  withServiceKeys,
+} from "@typespec/spec-api";
+import { jpgFile, pngFile } from "../../helper.js";
+
+export const Scenarios: Record<string, ScenarioMockApi> = {};
+
+function sameBodyHandler(req: MockRequest) {
+  switch (req.headers["accept"]) {
+    case "image/png":
+      return {
+        pass: "image/png",
+        status: 200,
+        body: {
+          contentType: "image/png",
+          rawContent: pngFile,
+        },
+      } as const;
+    case "image/jpeg":
+      return {
+        pass: "image/jpeg",
+
+        status: 200,
+        body: {
+          contentType: "image/jpeg",
+          rawContent: jpgFile,
+        },
+      } as const;
+    default:
+      throw new ValidationError(
+        "Unsupported Accept header",
+        `"image/png" | "image/jpeg"`,
+        req.headers["accept"],
+      );
+  }
+}
+
+function differentBodyHandler(req: MockRequest) {
+  switch (req.headers["accept"]) {
+    case "image/png":
+      return {
+        pass: "image/png",
+        status: 200,
+        body: {
+          contentType: "image/png",
+          rawContent: pngFile,
+        },
+      } as const;
+    case "application/json":
+      return {
+        pass: "application/json",
+        status: 200,
+        body: json({
+          content: pngFile.toString("base64"),
+        }),
+      } as const;
+    default:
+      throw new ValidationError(
+        "Unsupported Accept header",
+        `"image/png" | "application/json"`,
+        req.headers["accept"],
+      );
+  }
+}
+
+Scenarios.Payload_ContentNegotiation_SameBody = withServiceKeys(["image/png", "image/jpeg"]).pass([
+  {
+    uri: "/content-negotiation/same-body",
+    method: "get",
+    request: {
+      headers: {
+        accept: "image/png",
+      },
+    },
+    response: {
+      body: {
+        contentType: "image/png",
+        rawContent: pngFile,
+      },
+      status: 200,
+    },
+    handler: (req) => sameBodyHandler(req),
+    kind: "MockApiDefinition",
+  },
+  {
+    uri: "/content-negotiation/same-body",
+    method: "get",
+    request: {
+      headers: {
+        accept: "image/jpeg",
+      },
+    },
+    response: {
+      body: {
+        contentType: "image/jpeg",
+        rawContent: jpgFile,
+      },
+      status: 200,
+    },
+    handler: (req) => sameBodyHandler(req),
+    kind: "MockApiDefinition",
+  },
+  {
+    uri: "/content-negotiation/same-body",
+    method: "get",
+    request: {
+      status: 400,
+      headers: {
+        accept: "wrongAccept",
+      },
+    },
+    response: {
+      status: 400,
+      body: json({
+        message: "Unsupported Accept header",
+        expected: `"image/png" | "image/jpeg"`,
+        actual: "wrongAccept",
+      }),
+    },
+    handler: sameBodyHandler,
+    kind: "MockApiDefinition",
+  },
+]);
+
+Scenarios.Payload_ContentNegotiation_DifferentBody = withServiceKeys([
+  "image/png",
+  "application/json",
+]).pass([
+  {
+    uri: "/content-negotiation/different-body",
+    method: "get",
+    request: {
+      headers: {
+        accept: "image/png",
+      },
+    },
+    response: {
+      status: 200,
+      body: {
+        contentType: "image/png",
+        rawContent: pngFile,
+      },
+    },
+    handler: differentBodyHandler,
+    kind: "MockApiDefinition",
+  },
+  {
+    uri: "/content-negotiation/different-body",
+    method: "get",
+    request: {
+      headers: {
+        accept: "application/json",
+      },
+    },
+    response: {
+      status: 200,
+      body: json({
+        content: pngFile.toString("base64"),
+      }),
+    },
+    handler: differentBodyHandler,
+    kind: "MockApiDefinition",
+  },
+  {
+    uri: "/content-negotiation/different-body",
+    method: "get",
+    request: {
+      status: 400,
+      headers: {
+        accept: "wrongAccept",
+      },
+    },
+    response: {
+      status: 400,
+      body: json({
+        message: "Unsupported Accept header",
+        expected: `"image/png" | "application/json"`,
+        actual: "wrongAccept",
+      }),
+    },
+    handler: differentBodyHandler,
+    kind: "MockApiDefinition",
+  },
+]);

package/specs/payload/json-merge-patch/main.tsp

@@ -1,7 +1,8 @@
 import "@typespec/http";
 import "@typespec/spec-lib";
 
-using TypeSpec.Http;
+using Http;
+using SpecLib;
 
 @doc("Test for merge-patch+json content-type")
 @scenarioService("/json-merge-patch")

package/specs/payload/media-type/main.tsp

@@ -1,17 +1,15 @@
 import "@typespec/http";
 import "@typespec/spec-lib";
 
-using TypeSpec.Http;
-using Azure.ClientGenerator.Core;
+using Http;
+using SpecLib;
 
 /**
  * Test the payload with different media types and different types of the payload itself.
  */
-@supportedBy("dpg")
 @scenarioService("/payload/media-type")
 namespace Payload.MediaType;
 
-@operationGroup
 @route("/string-body")
 namespace StringBody {
   @scenario

package/specs/payload/multipart/main.tsp

@@ -1,7 +1,8 @@
 import "@typespec/http";
 import "@typespec/spec-lib";
 
-using TypeSpec.Http;
+using Http;
+using SpecLib;
 
 @doc("Test for multipart")
 @scenarioService("/multipart")

package/specs/payload/xml/main.tsp

@@ -2,9 +2,9 @@ import "@typespec/http";
 import "@typespec/xml";
 import "@typespec/spec-lib";
 
-using TypeSpec.Http;
+using Http;
+using SpecLib;
 using TypeSpec.Xml;
-using Azure.ClientGenerator.Core;
 
 @doc("Sends and receives bodies in XML format.")
 @scenarioService("/payload/xml")
@@ -83,19 +83,14 @@ model ModelWithEncodedNames {
 }
 
 @doc("Template for XML operations")
-interface XmlOperations<TModel, TDoc extends string> {
+interface XmlOperations<TModel, TDoc extends valueof string> {
   @scenario
-  @scenarioDoc(
-    """
-      Expected response body:
-      ```xml
-      {doc}
-      ```
-      """,
-    {
-      doc: TDoc,
-    }
-  )
+  @scenarioDoc("""
+    Expected response body:
+    ```xml
+    ${TDoc}
+    ```
+    """)
   @get
   get(): {
     @header("content-type") contentType: "application/xml";
@@ -103,17 +98,12 @@ interface XmlOperations<TModel, TDoc extends string> {
   };
 
   @scenario
-  @scenarioDoc(
-    """
-      Expected request body:
-      ```xml
-      {doc}
-      ```
-      """,
-    {
-      doc: TDoc,
-    }
-  )
+  @scenarioDoc("""
+    Expected request body:
+    ```xml
+    ${TDoc}
+    ```
+    """)
   @put
   put(@header("content-type") contentType: "application/xml", @body input: TModel): void;
 }

package/specs/routes/main.tsp

@@ -1,7 +1,8 @@
 import "@typespec/http";
 import "@typespec/spec-lib";
 
-using TypeSpec.Http;
+using Http;
+using SpecLib;
 
 /**
  * Define scenario in building the http route/uri

package/specs/serialization/encoded-name/json/main.tsp

@@ -1,10 +1,10 @@
 import "@typespec/http";
 import "@typespec/spec-lib";
 
-using TypeSpec.Http;
+using Http;
+using SpecLib;
 
 @doc("Projection")
-@supportedBy("dpg")
 @scenarioService("/serialization/encoded-name/json")
 namespace Serialization.EncodedName.Json;
 

package/specs/server/endpoint/not-defined/main.tsp

@@ -1,7 +1,8 @@
 import "@typespec/http";
 import "@typespec/spec-lib";
 
-using TypeSpec.Http;
+using Http;
+using SpecLib;
 
 /**
  * Illustrates server doesn't define endpoint. Client should automatically add an endpoint to let user pass in.

package/specs/server/path/multiple/main.tsp

@@ -2,7 +2,8 @@ import "@typespec/rest";
 import "@typespec/spec-lib";
 import "@typespec/versioning";
 
-using TypeSpec.Http;
+using Http;
+using SpecLib;
 using TypeSpec.Versioning;
 using TypeSpec.Rest;
 

package/specs/server/path/single/main.tsp

@@ -1,7 +1,8 @@
 import "@typespec/http";
 import "@typespec/spec-lib";
 
-using TypeSpec.Http;
+using Http;
+using SpecLib;
 
 @doc("Illustrates server with a single path parameter @server")
 @service

package/specs/server/versions/not-versioned/main.tsp

@@ -1,7 +1,8 @@
 import "@typespec/http";
 import "@typespec/spec-lib";
 
-using TypeSpec.Http;
+using Http;
+using SpecLib;
 
 /**
  * Illustrates not-versioned server.

package/specs/server/versions/versioned/main.tsp

@@ -2,7 +2,8 @@ import "@typespec/http";
 import "@typespec/spec-lib";
 import "@typespec/versioning";
 
-using TypeSpec.Http;
+using Http;
+using SpecLib;
 using TypeSpec.Versioning;
 
 /**
@@ -30,13 +31,11 @@ enum Versions {
   /**
    * The version 2022-12-01-preview.
    */
-  @useDependency(global.Azure.Core.Versions.v1_0_Preview_2)
   v2021_01_01_preview: "2021-01-01-preview",
 
   /**
    * The version 2022-12-01-preview.
    */
-  @useDependency(global.Azure.Core.Versions.v1_0_Preview_2)
   v2022_12_01_preview: "2022-12-01-preview",
 }
 

package/specs/special-headers/conditional-request/main.tsp

@@ -2,11 +2,11 @@ import "@typespec/http";
 import "@typespec/versioning";
 import "@typespec/spec-lib";
 
-using TypeSpec.Http;
+using Http;
+using SpecLib;
 using TypeSpec.Versioning;
 
 @doc("Illustrates conditional request headers")
-@supportedBy("dpg")
 @scenarioService("/special-headers/conditional-request")
 namespace SpecialHeaders.ConditionalRequest;
 

package/specs/special-headers/repeatability/main.tsp

@@ -2,11 +2,11 @@ import "@typespec/http";
 import "@typespec/versioning";
 import "@typespec/spec-lib";
 
-using TypeSpec.Http;
+using Http;
+using SpecLib;
 using TypeSpec.Versioning;
 
 @doc("Illustrates OASIS repeatability headers")
-@supportedBy("dpg")
 @scenarioService("/special-headers/repeatability")
 namespace SpecialHeaders.Repeatability;
 

package/specs/special-words/main.tsp

@@ -2,8 +2,8 @@ import "@typespec/http";
 import "@typespec/spec-lib";
 import "./dec.js";
 
-using TypeSpec.Http;
-using Azure.ClientGenerator.Core;
+using Http;
+using SpecLib;
 
 /**
  * Scenarios to verify that reserved words can be used in service and generators will handle it appropriately.
@@ -52,7 +52,6 @@ namespace SpecialWords;
  * Test reserved words as operation name.
  */
 @route("/operations")
-@operationGroup
 interface Operations {
   @opNameScenario("and") and(): void;
   @opNameScenario("as") as(): void;
@@ -93,7 +92,6 @@ interface Operations {
  * Verify reserved words as parameter name.
  */
 @route("/parameters")
-@operationGroup
 interface Parameters {
   @paramNameScenario("and") withAnd(@query and: string): void;
   @paramNameScenario("as") withAs(@query as: string): void;
@@ -139,7 +137,6 @@ interface Parameters {
  * Verify model names
  */
 @route("/models")
-@operationGroup
 namespace Models {
   model Base {
     name: string;
@@ -217,7 +214,6 @@ namespace Models {
  * Verify model names
  */
 @route("/model-properties")
-@operationGroup
 namespace ModelProperties {
   model SameAsModel {
     SameAsModel: string;

package/specs/special-words/mockapi.ts

@@ -2,7 +2,7 @@ import { MockRequest, passOnSuccess, ScenarioMockApi } from "@typespec/spec-api"
 
 export const Scenarios: Record<string, ScenarioMockApi> = {};
 
-Scenarios.Special_Words_Model_Properties_Same_As_Model = passOnSuccess({
+Scenarios.SpecialWords_ModelProperties_sameAsModel = passOnSuccess({
   uri: "/special-words/model-properties/same-as-model",
   method: "post",
   request: {

package/specs/type/array/main.tsp

@@ -1,85 +1,67 @@
 import "@typespec/http";
 import "@typespec/spec-lib";
 
-using TypeSpec.Http;
-using Azure.ClientGenerator.Core;
+using Http;
+using SpecLib;
 
 @doc("Illustrates various types of arrays.")
 @scenarioService("/type/array")
 namespace Type.Array;
 
 @doc("Template to have Array operations")
-interface ArrayOperations<TArr, TDoc extends string> {
+interface ArrayOperations<TArr, TDoc extends valueof string> {
   @scenario
-  @scenarioDoc(
-    """
-      Expected Array response body:
-      ```json
-      {doc}
-      ```
-      """,
-    {
-      doc: TDoc,
-    }
-  )
+  @scenarioDoc("""
+    Expected Array response body:
+    ```json
+    ${TDoc}
+    ```
+    """)
   @get
   get(): TArr;
 
   @scenario
-  @scenarioDoc(
-    """
-      Expected Array input body:
-      ```json
-      {doc}
-      ```
-      """,
-    {
-      doc: TDoc,
-    }
-  )
+  @scenarioDoc("""
+    Expected Array input body:
+    ```json
+    ${TDoc}
+    ```
+    """)
   @put
   put(@body body: TArr): void;
 }
 
 @doc("Array of int32 values")
 @route("/int32")
-@operationGroup
 interface Int32Value extends ArrayOperations<int32[], "[1, 2]"> {}
 
 @doc("Array of int64 values")
 @route("/int64")
-@operationGroup
 interface Int64Value
   extends ArrayOperations<int64[], "[0x7FFFFFFFFFFFFFFF, -0x7FFFFFFFFFFFFFFF]"> {}
 
 @doc("Array of boolean values")
 @route("/boolean")
-@operationGroup
 interface BooleanValue extends ArrayOperations<boolean[], "[true, false]"> {}
 
 @doc("Array of string values")
 @route("/string")
-@operationGroup
 interface StringValue extends ArrayOperations<string[], "['hello', '']"> {}
 
 @doc("Array of float values")
 @route("/float32")
-@operationGroup
 interface Float32Value extends ArrayOperations<float32[], "[43.125]"> {}
 
 @doc("Array of datetime values")
 @route("/datetime")
-@operationGroup
 interface DatetimeValue extends ArrayOperations<utcDateTime[], "['2022-08-26T18:38:00Z']"> {}
 
 @doc("Array of duration values")
 @route("/duration")
-@operationGroup
 interface DurationValue extends ArrayOperations<duration[], "['P123DT22H14M12.011S']"> {}
 
 @doc("Array of unknown values")
 @route("/unknown")
-@operationGroup
 interface UnknownValue extends ArrayOperations<unknown[], "[1, 'hello', 'k3': null]"> {}
 
 @doc("Array inner model")
@@ -92,39 +74,33 @@ model InnerModel {
 
 @doc("Array of model values")
 @route("/model")
-@operationGroup
 interface ModelValue
   extends ArrayOperations<InnerModel[], "[{'property': 'hello'}, {'property': 'world'}]"> {}
 
 alias NullableFloat = float32 | null;
 @doc("Array of nullable float values")
 @route("/nullable-float")
-@operationGroup
 interface NullableFloatValue extends ArrayOperations<NullableFloat[], "[1.25, null, 3.0]"> {}
 
 alias NullableInt32 = int32 | null;
 @doc("Array of nullable int32 values")
 @route("/nullable-int32")
-@operationGroup
 interface NullableInt32Value extends ArrayOperations<NullableInt32[], "[1, null, 3]"> {}
 
 alias NullableBoolean = boolean | null;
 @doc("Array of nullable boolean values")
 @route("/nullable-boolean")
-@operationGroup
 interface NullableBooleanValue extends ArrayOperations<NullableBoolean[], "[true, null, false]"> {}
 
 alias NullableString = string | null;
 @doc("Array of nullable string values")
 @route("/nullable-string")
-@operationGroup
 interface NullableStringValue
   extends ArrayOperations<NullableString[], "['hello', null, 'world']"> {}
 
 alias NullableModel = InnerModel | null;
 @doc("Array of nullable model values")
 @route("/nullable-model")
-@operationGroup
 interface NullableModelValue
   extends ArrayOperations<
       NullableModel[],