@typespec/http-specs 0.1.0-alpha.3-dev.6 → 0.1.0-alpha.30-dev.0

package/specs/special-words/main.tsp

@@ -56,7 +56,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 +84,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 +144,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 +172,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 +206,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 +231,42 @@ 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;
 }

package/specs/special-words/mockapi.ts

@@ -1,4 +1,4 @@
-import { passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
+import { json, passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
 
 export const Scenarios: Record<string, ScenarioMockApi> = {};
 
@@ -6,9 +6,32 @@ 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,
@@ -21,9 +44,9 @@ function createModelsTests(uri: string) {
     uri,
     method: "post",
     request: {
-      body: {
+      body: json({
         name: "ok",
-      },
+      }),
     },
     response: {
       status: 204,
@@ -134,7 +157,7 @@ function createParametersTests(uri: string, data: any, paramName: string) {
     uri,
     method: "get",
     request: {
-      params: data,
+      query: data,
     },
     response: {
       status: 204,

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/model/empty/mockapi.ts

@@ -8,7 +8,7 @@ Scenarios.Type_Model_Empty_putEmpty = passOnSuccess({
   uri: "/type/model/empty/alone",
   method: "put",
   request: {
-    body: body,
+    body: json(body),
   },
   response: {
     status: 204,
@@ -30,7 +30,7 @@ Scenarios.Type_Model_Empty_postRoundTripEmpty = passOnSuccess({
   uri: "/type/model/empty/round-trip",
   method: "post",
   request: {
-    body: body,
+    body: json(body),
   },
   response: {
     status: 200,

package/specs/type/model/inheritance/enum-discriminator/mockapi.ts

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

package/specs/type/model/inheritance/nested-discriminator/mockapi.ts

@@ -78,7 +78,7 @@ Scenarios.Type_Model_Inheritance_NestedDiscriminator_putModel = passOnSuccess({
   uri: "/type/model/inheritance/nested-discriminator/model",
   method: "put",
   request: {
-    body: validPolymorphicBody,
+    body: json(validPolymorphicBody),
   },
   response: {
     status: 204,
@@ -100,7 +100,7 @@ Scenarios.Type_Model_Inheritance_NestedDiscriminator_putRecursiveModel = passOnS
   uri: "/type/model/inheritance/nested-discriminator/recursivemodel",
   method: "put",
   request: {
-    body: validRecursiveBody,
+    body: json(validRecursiveBody),
   },
   response: {
     status: 204,

package/specs/type/model/inheritance/not-discriminated/mockapi.ts

@@ -8,7 +8,7 @@ Scenarios.Type_Model_Inheritance_NotDiscriminated_postValid = passOnSuccess({
   uri: "/type/model/inheritance/not-discriminated/valid",
   method: "post",
   request: {
-    body: inheritanceValidBody,
+    body: json(inheritanceValidBody),
   },
   response: {
     status: 204,
@@ -29,7 +29,7 @@ Scenarios.Type_Model_Inheritance_NotDiscriminated_putValid = passOnSuccess({
   uri: "/type/model/inheritance/not-discriminated/valid",
   method: "put",
   request: {
-    body: inheritanceValidBody,
+    body: json(inheritanceValidBody),
   },
   response: {
     status: 200,

package/specs/type/model/inheritance/recursive/mockapi.ts

@@ -22,7 +22,7 @@ Scenarios.Type_Model_Inheritance_Recursive_put = passOnSuccess({
   uri: "/type/model/inheritance/recursive",
   method: "put",
   request: {
-    body: body,
+    body: json(body),
   },
   response: {
     status: 204,

package/specs/type/model/inheritance/single-discriminator/mockapi.ts

@@ -40,7 +40,7 @@ Scenarios.Type_Model_Inheritance_SingleDiscriminator_putModel = passOnSuccess({
   uri: "/type/model/inheritance/single-discriminator/model",
   method: "put",
   request: {
-    body: validPolymorphicBody,
+    body: json(validPolymorphicBody),
   },
   response: {
     status: 204,
@@ -62,7 +62,7 @@ Scenarios.Type_Model_Inheritance_SingleDiscriminator_putRecursiveModel = passOnS
   uri: "/type/model/inheritance/single-discriminator/recursivemodel",
   method: "put",
   request: {
-    body: validRecursiveBody,
+    body: json(validRecursiveBody),
   },
   response: {
     status: 204,

package/specs/type/model/usage/mockapi.ts

@@ -8,9 +8,9 @@ Scenarios.Type_Model_Usage_input = passOnSuccess({
   uri: "/type/model/usage/input",
   method: "post",
   request: {
-    body: {
+    body: json({
       requiredProp: "example-value",
-    },
+    }),
   },
   response: {
     status: 204,
@@ -33,9 +33,9 @@ Scenarios.Type_Model_Usage_inputAndOutput = passOnSuccess({
   uri: "/type/model/usage/input-output",
   method: "post",
   request: {
-    body: {
+    body: json({
       requiredProp: "example-value",
-    },
+    }),
   },
   response: {
     status: 200,

package/specs/type/model/visibility/main.tsp

@@ -11,50 +11,47 @@ namespace Type.Model.Visibility;
 @doc("Output model with visibility properties.")
 model VisibilityModel {
   @doc("Required string, illustrating a readonly property.")
-  @visibility("read")
+  @visibility(Lifecycle.Read)
   readProp: string;
 
+  #suppress "@typespec/http/metadata-ignored" "For test"
   @doc("Required int32, illustrating a query property.")
-  @visibility("query")
+  @visibility(Lifecycle.Query)
+  @query
   queryProp: int32;
 
   @doc("Required string[], illustrating a create property.")
-  @visibility("create")
+  @visibility(Lifecycle.Create)
   createProp: string[];
 
   @doc("Required int32[], illustrating a update property.")
-  @visibility("update")
+  @visibility(Lifecycle.Update)
   updateProp: int32[];
 
   @doc("Required bool, illustrating a delete property.")
-  @visibility("delete")
+  @visibility(Lifecycle.Delete)
   deleteProp: boolean;
 
   @doc("Property that does not exist in any payload.")
-  @visibility("none")
+  @invisible(Lifecycle)
   noneProp: "none";
 }
 
 /** RoundTrip model with readonly optional properties. */
 model ReadOnlyModel {
   /** Optional readonly nullable int list. */
-  @visibility("read")
+  @visibility(Lifecycle.Read)
   optionalNullableIntList?: int32[] | null;
 
   /** Optional readonly string dictionary. */
-  @visibility("read")
+  @visibility(Lifecycle.Read)
   optionalStringRecord?: Record<string>;
 }
 
 @scenario
 @scenarioDoc("""
   Generate and receive output model with readonly properties.
-  Expected input body:
-  ```json
-  {
-    queryProp: 123,
-  }
-  ```
+  Expected no body with `?queryProp=123`.
   
   Expected response body:
   ```json
@@ -64,7 +61,7 @@ model ReadOnlyModel {
   ```
   """)
 @get
-op getModel(@body input: VisibilityModel): {
+op getModel(@bodyRoot input: VisibilityModel): {
   @body
   output: VisibilityModel;
 };
@@ -72,15 +69,10 @@ op getModel(@body input: VisibilityModel): {
 @scenario
 @scenarioDoc("""
   Generate abd send put model with write/create properties.
-  Expected input body:
-  ```json
-  {
-    queryProp: 123,
-  }
-  ```
+  Expected no body with `?queryProp=123`.
   """)
 @head
-op headModel(@body input: VisibilityModel): OkResponse;
+op headModel(@bodyRoot input: VisibilityModel): OkResponse;
 
 @scenario
 @scenarioDoc("""
@@ -106,7 +98,7 @@ op putModel(@body input: VisibilityModel): void;
   }
   ```
   """)
-@patch
+@patch(#{ implicitOptionality: true })
 op patchModel(@body input: VisibilityModel): void;
 
 @scenario

package/specs/type/model/visibility/mockapi.ts

@@ -6,7 +6,6 @@ function genData(keys: string[]): Record<string, any> {
   const ret: Record<string, any> = {};
   const fullData: Record<string, any> = {
     readProp: "abc",
-    queryProp: 123,
     createProp: ["foo", "bar"],
     updateProp: [1, 2],
     deleteProp: true,
@@ -36,7 +35,7 @@ Scenarios.Type_Model_Visibility_headModel = passOnSuccess({
   uri: "/type/model/visibility",
   method: "head",
   request: {
-    body: { queryProp: 123 },
+    query: { queryProp: 123 },
   },
   response: {
     status: 200,
@@ -47,7 +46,7 @@ Scenarios.Type_Model_Visibility_getModel = passOnSuccess({
   uri: "/type/model/visibility",
   method: "get",
   request: {
-    body: { queryProp: 123 },
+    query: { queryProp: 123 },
   },
   response: {
     status: 200,
@@ -59,10 +58,10 @@ Scenarios.Type_Model_Visibility_putModel = passOnSuccess({
   uri: "/type/model/visibility",
   method: "put",
   request: {
-    body: {
+    body: json({
       createProp: ["foo", "bar"],
       updateProp: [1, 2],
-    },
+    }),
   },
   response: {
     status: 204,
@@ -73,9 +72,9 @@ Scenarios.Type_Model_Visibility_patchModel = passOnSuccess({
   uri: "/type/model/visibility",
   method: "patch",
   request: {
-    body: {
+    body: json({
       updateProp: [1, 2],
-    },
+    }),
   },
   response: {
     status: 204,
@@ -86,9 +85,9 @@ Scenarios.Type_Model_Visibility_postModel = passOnSuccess({
   uri: "/type/model/visibility",
   method: "post",
   request: {
-    body: {
+    body: json({
       createProp: ["foo", "bar"],
-    },
+    }),
   },
   response: {
     status: 204,
@@ -99,7 +98,7 @@ Scenarios.Type_Model_Visibility_deleteModel = passOnSuccess({
   uri: "/type/model/visibility",
   method: "delete",
   request: {
-    body: { deleteProp: true },
+    body: json({ deleteProp: true }),
   },
   response: {
     status: 204,