@typespec/http-specs 0.1.0-alpha.9 → 0.1.0-dev.0

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

@@ -4,7 +4,7 @@ import "@typespec/spector";
 
 using Http;
 using Spector;
-using TypeSpec.Versioning;
+using Versioning;
 
 @doc("Illustrates OASIS repeatability headers")
 @scenarioService("/special-headers/repeatability")
@@ -15,7 +15,7 @@ model RepeatableResponse {
   @statusCode
   statusCode: 204;
 
-  @visibility("read")
+  @visibility(Lifecycle.Read)
   @header("Repeatability-Result")
   @doc("Indicates whether the repeatable request was accepted or rejected.")
   repeatabilityResult?: "accepted" | "rejected";

package/specs/special-words/main.tsp

@@ -34,6 +34,7 @@ using Spector;
  * in
  * is
  * lambda
+ * list
  * not
  * or
  * pass
@@ -56,7 +57,7 @@ interface Operations {
   @opNameScenario("and") and(): void;
   @opNameScenario("as") as(): void;
   @opNameScenario("assert") assert(): void;
-  @opNameScenario("async") async(): void;
+  @opNameScenario("async") `async`(): void;
   @opNameScenario("await") await(): void;
   @opNameScenario("break") break(): void;
   @opNameScenario("class") class(): void;
@@ -84,7 +85,7 @@ interface Operations {
   @opNameScenario("return") `return`(): void;
   @opNameScenario("try") try(): void;
   @opNameScenario("while") while(): void;
-  @opNameScenario("with") with(): void;
+  @opNameScenario("with") `with`(): void;
   @opNameScenario("yield") yield(): void;
 }
 
@@ -144,7 +145,7 @@ namespace Models {
   model and is Base;
   model as is Base;
   model assert is Base;
-  model async is Base;
+  model `async` is Base;
   model await is Base;
   model break is Base;
   model class is Base;
@@ -172,13 +173,13 @@ namespace Models {
   model `return` is Base;
   model try is Base;
   model while is Base;
-  model with is Base;
+  model `with` is Base;
   model yield is Base;
 
   @modelNameScenario("and") op withAnd(@body body: and): void;
   @modelNameScenario("as") op withAs(@body body: as): void;
   @modelNameScenario("assert") op withAssert(@body body: assert): void;
-  @modelNameScenario("async") op withAsync(@body body: async): void;
+  @modelNameScenario("async") op withAsync(@body body: `async`): void;
   @modelNameScenario("await") op withAwait(@body body: await): void;
   @modelNameScenario("break") op withBreak(@body body: break): void;
   @modelNameScenario("class") op withClass(@body body: class): void;
@@ -206,7 +207,7 @@ namespace Models {
   @modelNameScenario("return") op withReturn(@body body: `return`): void;
   @modelNameScenario("try") op withTry(@body body: try): void;
   @modelNameScenario("while") op withWhile(@body body: while): void;
-  @modelNameScenario("with") op withWith(@body body: with): void;
+  @modelNameScenario("with") op withWith(@body body: `with`): void;
   @modelNameScenario("yield") op withYield(@body body: yield): void;
 }
 
@@ -231,4 +232,115 @@ namespace ModelProperties {
     """)
   @route("same-as-model")
   op sameAsModel(@body body: SameAsModel): void;
+
+  // Python dict method names that could conflict
+  model DictMethods {
+    keys: string;
+    items: string;
+    values: string;
+    popitem: string;
+    clear: string;
+    update: string;
+    setdefault: string;
+    pop: string;
+    get: string;
+    copy: string;
+  }
+
+  @scenario
+  @scenarioDoc("""
+    Verify that model properties can use names that are Python dict methods. These names (keys, items, values, etc.) may conflict with Python's dict class methods.
+    
+    Send
+    
+    ```json
+    {
+      "keys": "ok",
+      "items": "ok",
+      "values": "ok",
+      "popitem": "ok",
+      "clear": "ok",
+      "update": "ok",
+      "setdefault": "ok",
+      "pop": "ok",
+      "get": "ok",
+      "copy": "ok"
+    }
+    ```
+    """)
+  @route("dict-methods")
+  op dictMethods(@body body: DictMethods): void;
+
+  // Test for model property named "list" which is a reserved word in many languages
+  model ModelWithList {
+    list: string;
+  }
+
+  @scenario
+  @scenarioDoc("""
+    Verify that a property can be named "list", which is a reserved word in many languages like Python.
+    
+    Send
+    
+    ```json
+    {"list": "ok"}
+    ```
+    """)
+  @route("list")
+  op withList(@body body: ModelWithList): void;
+}
+
+/**
+ * Verify enum member names that are special words using extensible enum (union).
+ */
+union ExtensibleString {
+  string,
+  and: "and",
+  as: "as",
+  assert: "assert",
+  async: "async",
+  await: "await",
+  break: "break",
+  class: "class",
+  constructor: "constructor",
+  continue: "continue",
+  def: "def",
+  del: "del",
+  elif: "elif",
+  `else`: "else",
+  except: "except",
+  exec: "exec",
+  finally: "finally",
+  for: "for",
+  from: "from",
+  global: "global",
+  `if`: "if",
+  `import`: "import",
+  in: "in",
+  `is`: "is",
+  lambda: "lambda",
+  not: "not",
+  or: "or",
+  pass: "pass",
+  raise: "raise",
+  `return`: "return",
+  try: "try",
+  while: "while",
+  with: "with",
+  yield: "yield",
+}
+
+/**
+ * Verify enum member names that are special words.
+ */
+@route("/extensible-strings")
+interface ExtensibleStrings {
+  @scenario
+  @scenarioDoc("""
+    Verify that enum members with special word names can be sent and received properly.
+    Send 'class' and expect the same value back.
+    """)
+  @put
+  @route("/string")
+  putExtensibleStringValue(@body body: ExtensibleString): ExtensibleString;
 }

package/specs/special-words/mockapi.ts

@@ -1,4 +1,4 @@
-import { passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
+import { json, MockRequest, passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
 
 export const Scenarios: Record<string, ScenarioMockApi> = {};
 
@@ -6,9 +6,46 @@ Scenarios.SpecialWords_ModelProperties_sameAsModel = passOnSuccess({
   uri: "/special-words/model-properties/same-as-model",
   method: "post",
   request: {
-    body: {
+    body: json({
       SameAsModel: "ok",
-    },
+    }),
+  },
+  response: {
+    status: 204,
+  },
+  kind: "MockApiDefinition",
+});
+
+Scenarios.SpecialWords_ModelProperties_dictMethods = passOnSuccess({
+  uri: "/special-words/model-properties/dict-methods",
+  method: "post",
+  request: {
+    body: json({
+      keys: "ok",
+      items: "ok",
+      values: "ok",
+      popitem: "ok",
+      clear: "ok",
+      update: "ok",
+      setdefault: "ok",
+      pop: "ok",
+      get: "ok",
+      copy: "ok",
+    }),
+  },
+  response: {
+    status: 204,
+  },
+  kind: "MockApiDefinition",
+});
+
+Scenarios.SpecialWords_ModelProperties_withList = passOnSuccess({
+  uri: "/special-words/model-properties/list",
+  method: "post",
+  request: {
+    body: json({
+      list: "ok",
+    }),
   },
   response: {
     status: 204,
@@ -21,9 +58,9 @@ function createModelsTests(uri: string) {
     uri,
     method: "post",
     request: {
-      body: {
+      body: json({
         name: "ok",
-      },
+      }),
     },
     response: {
       status: 204,
@@ -134,7 +171,7 @@ function createParametersTests(uri: string, data: any, paramName: string) {
     uri,
     method: "get",
     request: {
-      params: data,
+      query: data,
     },
     response: {
       status: 204,
@@ -382,3 +419,22 @@ Scenarios.SpecialWords_Parameters_cancellationToken = createParametersTests(
   },
   "cancellationToken",
 );
+
+Scenarios.SpecialWords_ExtensibleStrings_putExtensibleStringValue = passOnSuccess({
+  uri: `/special-words/extensible-strings/string`,
+  method: "put",
+  request: {
+    body: json("class"),
+  },
+  response: {
+    status: 200,
+    body: json("class"),
+  },
+  handler: (req: MockRequest) => {
+    return {
+      status: 200,
+      body: json(req.body),
+    };
+  },
+  kind: "MockApiDefinition",
+});

package/specs/streaming/jsonl/main.tsp

@@ -0,0 +1,33 @@
+import "@typespec/http";
+import "@typespec/http/streams";
+import "@typespec/spector";
+
+using Http;
+using Http.Streams;
+using Spector;
+
+@doc("Test of jsonl streaming.")
+@scenarioService("/streaming/jsonl")
+namespace Streaming.Jsonl;
+
+@route("basic")
+namespace Basic {
+  @scenario
+  @scenarioDoc("""
+    Basic jsonl streaming for request.
+    """)
+  @route("send")
+  @post
+  op send(stream: JsonlStream<Info>): NoContentResponse;
+
+  @scenario
+  @scenarioDoc("""
+    Basic jsonl streaming for response.
+    """)
+  @route("receive")
+  op receive(): JsonlStream<Info>;
+
+  model Info {
+    desc: string;
+  }
+}

package/specs/streaming/jsonl/mockapi.ts

@@ -0,0 +1,32 @@
+import { passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
+
+export const Scenarios: Record<string, ScenarioMockApi> = {};
+
+Scenarios.Streaming_Jsonl_Basic_send = passOnSuccess({
+  uri: "/streaming/jsonl/basic/send",
+  method: "post",
+  request: {
+    body: {
+      rawContent: Buffer.from('{"desc": "one"}\n{"desc": "two"}\n{"desc": "three"}'),
+      contentType: "application/jsonl",
+    },
+  },
+  response: {
+    status: 204,
+  },
+  kind: "MockApiDefinition",
+});
+
+Scenarios.Streaming_Jsonl_Basic_receive = passOnSuccess({
+  uri: "/streaming/jsonl/basic/receive",
+  method: "get",
+  request: {},
+  response: {
+    status: 200,
+    body: {
+      rawContent: Buffer.from('{"desc": "one"}\n{"desc": "two"}\n{"desc": "three"}'),
+      contentType: "application/jsonl",
+    },
+  },
+  kind: "MockApiDefinition",
+});

package/specs/type/array/mockapi.ts

@@ -18,7 +18,7 @@ function createServerTests(uri: string, data: any) {
       uri,
       method: "put",
       request: {
-        body: data,
+        body: json(data),
       },
       response: {
         status: 204,

package/specs/type/dictionary/mockapi.ts

@@ -18,7 +18,7 @@ function createServerTests(uri: string, data: any) {
       uri,
       method: "put",
       request: {
-        body: data,
+        body: json(data),
       },
       response: {
         status: 204,

package/specs/type/enum/extensible/main.tsp

@@ -40,6 +40,9 @@ interface String {
   @get
   @route("/known-value")
   getKnownValue(): {
+    @header
+    contentType: "application/json";
+
     @body body: DaysOfWeekExtensibleEnum;
   };
 
@@ -48,6 +51,9 @@ interface String {
   @get
   @route("/unknown-value")
   getUnknownValue(): {
+    @header
+    contentType: "application/json";
+
     @body body: DaysOfWeekExtensibleEnum;
   };
 
@@ -55,11 +61,21 @@ interface String {
   @scenarioDoc("Expect to send a known value. Mock api expect to receive 'Monday'")
   @put
   @route("/known-value")
-  putKnownValue(@body body: DaysOfWeekExtensibleEnum): void;
+  putKnownValue(
+    @header
+    contentType: "application/json",
+
+    @body body: DaysOfWeekExtensibleEnum,
+  ): void;
 
   @scenario
   @scenarioDoc("Expect to handle an unknown value. Mock api expect to receive 'Weekend'")
   @put
   @route("/unknown-value")
-  putUnknownValue(@body body: DaysOfWeekExtensibleEnum): void;
+  putUnknownValue(
+    @header
+    contentType: "application/json",
+
+    @body body: DaysOfWeekExtensibleEnum,
+  ): void;
 }

package/specs/type/enum/extensible/mockapi.ts

@@ -18,7 +18,7 @@ function createMockServerTests(uri: string, data: any) {
       uri,
       method: "put",
       request: {
-        body: data,
+        body: json(data),
         headers: {
           "Content-Type": "text/plain",
         },

package/specs/type/enum/fixed/main.tsp

@@ -40,7 +40,13 @@ interface String {
   @get
   @route("/known-value")
   @doc("getKnownValue")
-  getKnownValue(): DaysOfWeekEnum;
+  getKnownValue(): {
+    @header
+    contentType: "application/json";
+
+    @body
+    body: DaysOfWeekEnum;
+  };
 
   #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "For testing"
   @scenario
@@ -48,7 +54,10 @@ interface String {
   @put
   @route("/known-value")
   @doc("putKnownValue")
-  putKnownValue(@body @doc("_") body: DaysOfWeekEnum): void;
+  putKnownValue(
+    @header contentType: "application/json",
+    @body @doc("_") body: DaysOfWeekEnum,
+  ): void;
 
   #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "For testing"
   @scenario
@@ -56,5 +65,8 @@ interface String {
   @put
   @route("/unknown-value")
   @doc("putUnknownValue")
-  putUnknownValue(@body @doc("_") body: DaysOfWeekEnum): void;
+  putUnknownValue(
+    @header contentType: "application/json",
+    @body @doc("_") body: DaysOfWeekEnum,
+  ): void;
 }

package/specs/type/enum/fixed/mockapi.ts

@@ -16,7 +16,7 @@ Scenarios.Type_Enum_Fixed_String_putKnownValue = passOnSuccess({
   uri: "/type/enum/fixed/string/known-value",
   method: "put",
   request: {
-    body: "Monday",
+    body: json("Monday"),
     headers: {
       "Content-Type": "application/json",
     },
@@ -31,7 +31,7 @@ Scenarios.Type_Enum_Fixed_String_putUnknownValue = passOnCode(500, {
   uri: "/type/enum/fixed/string/unknown-value",
   method: "put",
   request: {
-    body: "Weekend",
+    body: json("Weekend"),
     headers: {
       "Content-Type": "application/json",
     },

package/specs/type/file/main.tsp

@@ -0,0 +1,109 @@
+import "@typespec/http";
+import "@typespec/spector";
+
+using Http;
+using Spector;
+
+@doc("Test for File type usage in request and response bodies")
+@scenarioService("/type/file")
+namespace Type.File;
+
+/**
+ * Test File as request and response body with specific content type
+ */
+@route("/body")
+namespace Body {
+  @scenario
+  @scenarioDoc("""
+    Test File type as request body with specific content type.
+    Expected request:
+    - Content-Type header: image/png
+    - Body: binary content matching packages/http-specs/assets/image.png
+    """)
+  @post
+  @route("/request/specific-content-type")
+  op uploadFileSpecificContentType(@bodyRoot file: Http.File<"image/png">): NoContentResponse;
+
+  @scenario
+  @scenarioDoc("""
+    Test File type as request body with JSON content type.
+    Expected request:
+    - Content-Type header: application/json
+    - Body: JSON content with file data
+    """)
+  @post
+  @route("/request/json-content-type")
+  op uploadFileJsonContentType(@bodyRoot file: Http.File<"application/json">): NoContentResponse;
+
+  @scenario
+  @scenarioDoc("""
+    Test File type as response body with JSON content type.
+    Expected response:
+    - Content-Type header: application/json
+    - Body: JSON content with file data
+    """)
+  @get
+  @route("/response/json-content-type")
+  op downloadFileJsonContentType(): Http.File<"application/json">;
+
+  @scenario
+  @scenarioDoc("""
+    Test File type as response body with specific content type.
+    Expected response:
+    - Content-Type header: image/png
+    - Body: binary content matching packages/http-specs/assets/image.png
+    """)
+  @get
+  @route("/response/specific-content-type")
+  op downloadFileSpecificContentType(): Http.File<"image/png">;
+
+  @scenario
+  @scenarioDoc("""
+    Test File type as request body with multiple allowed content types (image/png or image/jpeg).
+    Client should send image/png.
+    Expected request:
+    - Content-Type header: image/png
+    - Body: binary content matching packages/http-specs/assets/image.png
+    """)
+  @post
+  @route("/request/multiple-content-types")
+  op uploadFileMultipleContentTypes(
+    @bodyRoot file: Http.File<"image/png" | "image/jpeg">,
+  ): NoContentResponse;
+
+  @scenario
+  @scenarioDoc("""
+    Test File type as response body with multiple allowed content types.
+    Service will return image/png.
+    Expected response:
+    - Content-Type header: image/png
+    - Body: binary content matching packages/http-specs/assets/image.png
+    """)
+  @get
+  @route("/response/multiple-content-types")
+  op downloadFileMultipleContentTypes(): Http.File<"image/png" | "image/jpeg">;
+
+  @scenario
+  @scenarioDoc("""
+    Test File type as request body with unspecified content type.
+    The File type accepts any content type. For testing, sender will use image/png.
+    Expected request:
+    - Content-Type header: image/png
+    - Body: binary content matching packages/http-specs/assets/image.png
+    """)
+  @post
+  @route("/request/default-content-type")
+  op uploadFileDefaultContentType(@bodyRoot file: Http.File): NoContentResponse;
+
+  @scenario
+  @scenarioDoc("""
+    Test File type as response body with unspecified content type.
+    The File type accepts any content type. For testing, server will return image/png.
+    Expected response:
+    - Content-Type header: image/png
+    - Body: binary content matching packages/http-specs/assets/image.png
+    """)
+  @get
+  @route("/response/default-content-type")
+  op downloadFileDefaultContentType(): Http.File;
+}