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

package/specs/routes/main.tsp

@@ -99,7 +99,7 @@ namespace PathParameters {
             Expected path: /routes/path/simple/standard/arraya,b
         """)
       @route("array{param}")
-      op array(param: string[]): void;
+      op `array`(param: string[]): void;
 
       @scenario
       @scenarioDoc("""
@@ -108,7 +108,7 @@ namespace PathParameters {
             Expected path: /routes/path/simple/standard/recorda,1,b,2
         """)
       @route("record{param}")
-      op record(param: Record<int32>): void;
+      op `record`(param: Record<int32>): void;
     }
 
     @route("explode")
@@ -129,7 +129,7 @@ namespace PathParameters {
             Expected path: /routes/path/simple/explode/arraya.b
         """)
       @route("array{param*}")
-      op array(param: string[]): void;
+      op `array`(param: string[]): void;
 
       @scenario
       @scenarioDoc("""
@@ -138,7 +138,7 @@ namespace PathParameters {
             Expected path: /routes/path/simple/explode/recorda=1,b=2
         """)
       @route("record{param*}")
-      op record(param: Record<int32>): void;
+      op `record`(param: Record<int32>): void;
     }
   }
 
@@ -162,7 +162,7 @@ namespace PathParameters {
             Expected path: /routes/path/path/standard/array/a,b
         """)
       @route("array{/param}")
-      op array(param: string[]): void;
+      op `array`(param: string[]): void;
 
       @scenario
       @scenarioDoc("""
@@ -171,7 +171,7 @@ namespace PathParameters {
             Expected path: /routes/path/path/standard/record/a,1,b,2
         """)
       @route("record{/param}")
-      op record(param: Record<int32>): void;
+      op `record`(param: Record<int32>): void;
     }
 
     @route("explode")
@@ -192,7 +192,7 @@ namespace PathParameters {
             Expected path: /routes/path/path/explode/array/a/b
         """)
       @route("array{/param*}")
-      op array(param: string[]): void;
+      op `array`(param: string[]): void;
 
       @scenario
       @scenarioDoc("""
@@ -201,7 +201,7 @@ namespace PathParameters {
             Expected path: /routes/path/path/explode/record/a=1/b=2
         """)
       @route("record{/param*}")
-      op record(param: Record<int32>): void;
+      op `record`(param: Record<int32>): void;
     }
   }
 
@@ -225,7 +225,7 @@ namespace PathParameters {
             Expected path: /routes/path/label/standard/array.a,b
         """)
       @route("array{.param}")
-      op array(param: string[]): void;
+      op `array`(param: string[]): void;
 
       @scenario
       @scenarioDoc("""
@@ -234,7 +234,7 @@ namespace PathParameters {
             Expected path: /routes/path/label/standard/record.a,1,b,2
         """)
       @route("record{.param}")
-      op record(param: Record<int32>): void;
+      op `record`(param: Record<int32>): void;
     }
 
     @route("explode")
@@ -255,7 +255,7 @@ namespace PathParameters {
             Expected path: /routes/path/label/explode/array.a.b
         """)
       @route("array{.param*}")
-      op array(param: string[]): void;
+      op `array`(param: string[]): void;
 
       @scenario
       @scenarioDoc("""
@@ -264,7 +264,7 @@ namespace PathParameters {
             Expected path: /routes/path/label/explode/record.a=1.b=2
         """)
       @route("record{.param*}")
-      op record(param: Record<int32>): void;
+      op `record`(param: Record<int32>): void;
     }
   }
 
@@ -276,7 +276,7 @@ namespace PathParameters {
       @scenarioDoc("""
         Test matrix expansion with explode: false when passed a primitive value.
             Param value: "a"
-            Expected path: /routes/path/matrix/standard/primitive;a
+            Expected path: /routes/path/matrix/standard/primitive;param=a
         """)
       @route("primitive{;param}")
       op primitive(param: string): void;
@@ -285,19 +285,19 @@ namespace PathParameters {
       @scenarioDoc("""
         Test matrix expansion with explode: false when passed an array value.
             Param value: ["a","b"]
-            Expected path: /routes/path/matrix/standard/array;a,b
+            Expected path: /routes/path/matrix/standard/array;param=a;param=b
         """)
       @route("array{;param}")
-      op array(param: string[]): void;
+      op `array`(param: string[]): void;
 
       @scenario
       @scenarioDoc("""
         Test matrix expansion with explode: false when passed a record value.
             Param value: {a: 1, b: 2}
-            Expected path: /routes/path/matrix/standard/record;a,1,b,2
+            Expected path: /routes/path/matrix/standard/record;a=1;b=2
         """)
       @route("record{;param}")
-      op record(param: Record<int32>): void;
+      op `record`(param: Record<int32>): void;
     }
 
     @route("explode")
@@ -306,7 +306,7 @@ namespace PathParameters {
       @scenarioDoc("""
         Test matrix expansion with explode: true when passed a primitive value.
             Param value: "a"
-            Expected path: /routes/path/matrix/explode/primitive;a
+            Expected path: /routes/path/matrix/explode/primitive;param=a
         """)
       @route("primitive{;param*}")
       op primitive(param: string): void;
@@ -315,10 +315,10 @@ namespace PathParameters {
       @scenarioDoc("""
         Test matrix expansion with explode: true when passed an array value.
             Param value: ["a","b"]
-            Expected path: /routes/path/matrix/explode/array;a.b
+            Expected path: /routes/path/matrix/explode/array;param=a;param=b
         """)
       @route("array{;param*}")
-      op array(param: string[]): void;
+      op `array`(param: string[]): void;
 
       @scenario
       @scenarioDoc("""
@@ -327,7 +327,7 @@ namespace PathParameters {
             Expected path: /routes/path/matrix/explode/record;a=1;b=2
         """)
       @route("record{;param*}")
-      op record(param: Record<int32>): void;
+      op `record`(param: Record<int32>): void;
     }
   }
 }
@@ -369,7 +369,7 @@ namespace QueryParameters {
             Expected path: /routes/query/query-expansion/standard/array?param=a,b
         """)
       @route("array{?param}")
-      op array(param: string[]): void;
+      op `array`(param: string[]): void;
 
       @scenario
       @scenarioDoc("""
@@ -378,7 +378,7 @@ namespace QueryParameters {
             Expected path: /routes/query/query-expansion/standard/record?param=a,1,b,2
         """)
       @route("record{?param}")
-      op record(param: Record<int32>): void;
+      op `record`(param: Record<int32>): void;
     }
 
     @route("explode")
@@ -399,7 +399,7 @@ namespace QueryParameters {
             Expected path: /routes/query/query-expansion/explode/array?param=a&param=b
         """)
       @route("array{?param*}")
-      op array(param: string[]): void;
+      op `array`(param: string[]): void;
 
       @scenario
       @scenarioDoc("""
@@ -408,7 +408,7 @@ namespace QueryParameters {
             Expected path: /routes/query/query-expansion/explode/record?a=1&b=2
         """)
       @route("record{?param*}")
-      op record(param: Record<int32>): void;
+      op `record`(param: Record<int32>): void;
     }
   }
 
@@ -432,7 +432,7 @@ namespace QueryParameters {
             Expected path: /routes/query/query-continuation/standard/array?fixed=true&param=a,b
         """)
       @route("array?fixed=true{&param}")
-      op array(param: string[]): void;
+      op `array`(param: string[]): void;
 
       @scenario
       @scenarioDoc("""
@@ -441,7 +441,7 @@ namespace QueryParameters {
             Expected path: /routes/query/query-continuation/standard/record?fixed=true&param=a,1,b,2
         """)
       @route("record?fixed=true{&param}")
-      op record(param: Record<int32>): void;
+      op `record`(param: Record<int32>): void;
     }
 
     @route("explode")
@@ -462,7 +462,7 @@ namespace QueryParameters {
             Expected path: /routes/query/query-continuation/explode/array?fixed=true&param=a&param=b
         """)
       @route("array?fixed=true{&param*}")
-      op array(param: string[]): void;
+      op `array`(param: string[]): void;
 
       @scenario
       @scenarioDoc("""
@@ -471,7 +471,7 @@ namespace QueryParameters {
             Expected path: /routes/query/query-continuation/explode/record?fixed=true&a=1&b=2
         """)
       @route("record?fixed=true{&param*}")
-      op record(param: Record<int32>): void;
+      op `record`(param: Record<int32>): void;
     }
   }
 }

package/specs/routes/mockapi.ts

@@ -21,7 +21,7 @@ function createTests(uri: string) {
     uri: url.pathname,
     method: "get",
     request: {
-      params: Object.fromEntries(queryMap),
+      query: Object.fromEntries(queryMap),
     },
     response: {
       status: 204,
@@ -70,13 +70,13 @@ Scenarios.Routes_PathParameters_SimpleExpansion_Standard_record = createTests(
   "/routes/path/simple/standard/recorda,1,b,2",
 );
 Scenarios.Routes_PathParameters_SimpleExpansion_Explode_primitive = createTests(
-  "/routes/path/simple/standard/primitivea",
+  "/routes/path/simple/explode/primitivea",
 );
 Scenarios.Routes_PathParameters_SimpleExpansion_Explode_array = createTests(
-  "/routes/path/simple/standard/arraya,b",
+  "/routes/path/simple/explode/arraya,b",
 );
 Scenarios.Routes_PathParameters_SimpleExpansion_Explode_record = createTests(
-  "/routes/path/simple/standard/recorda=1,b=2",
+  "/routes/path/simple/explode/recorda=1,b=2",
 );
 Scenarios.Routes_PathParameters_PathExpansion_Standard_primitive = createTests(
   "/routes/path/path/standard/primitive/a",
@@ -88,13 +88,13 @@ Scenarios.Routes_PathParameters_PathExpansion_Standard_record = createTests(
   "/routes/path/path/standard/record/a,1,b,2",
 );
 Scenarios.Routes_PathParameters_PathExpansion_Explode_primitive = createTests(
-  "/routes/path/path/standard/primitive/a",
+  "/routes/path/path/explode/primitive/a",
 );
 Scenarios.Routes_PathParameters_PathExpansion_Explode_array = createTests(
-  "/routes/path/path/standard/array/a/b",
+  "/routes/path/path/explode/array/a/b",
 );
 Scenarios.Routes_PathParameters_PathExpansion_Explode_record = createTests(
-  "/routes/path/path/standard/record/a=1/b=2",
+  "/routes/path/path/explode/record/a=1/b=2",
 );
 Scenarios.Routes_PathParameters_LabelExpansion_Standard_primitive = createTests(
   "/routes/path/label/standard/primitive.a",
@@ -106,31 +106,31 @@ Scenarios.Routes_PathParameters_LabelExpansion_Standard_record = createTests(
   "/routes/path/label/standard/record.a,1,b,2",
 );
 Scenarios.Routes_PathParameters_LabelExpansion_Explode_primitive = createTests(
-  "/routes/path/label/standard/primitive.a",
+  "/routes/path/label/explode/primitive.a",
 );
 Scenarios.Routes_PathParameters_LabelExpansion_Explode_array = createTests(
-  "/routes/path/label/standard/array.a.b",
+  "/routes/path/label/explode/array.a.b",
 );
 Scenarios.Routes_PathParameters_LabelExpansion_Explode_record = createTests(
-  "/routes/path/label/standard/record.a=1.b=2",
+  "/routes/path/label/explode/record.a=1.b=2",
 );
 Scenarios.Routes_PathParameters_MatrixExpansion_Standard_primitive = createTests(
-  "/routes/path/matrix/standard/primitive;a",
+  "/routes/path/matrix/standard/primitive;param=a",
 );
 Scenarios.Routes_PathParameters_MatrixExpansion_Standard_array = createTests(
-  "/routes/path/matrix/standard/array;a,b",
+  "/routes/path/matrix/standard/array;param=a,b",
 );
 Scenarios.Routes_PathParameters_MatrixExpansion_Standard_record = createTests(
-  "/routes/path/matrix/standard/record;a,1,b,2",
+  "/routes/path/matrix/standard/record;param=a,1,b,2",
 );
 Scenarios.Routes_PathParameters_MatrixExpansion_Explode_primitive = createTests(
-  "/routes/path/matrix/standard/primitive;a",
+  "/routes/path/matrix/explode/primitive;param=a",
 );
 Scenarios.Routes_PathParameters_MatrixExpansion_Explode_array = createTests(
-  "/routes/path/matrix/standard/array;a;b",
+  "/routes/path/matrix/explode/array;param=a;param=b",
 );
 Scenarios.Routes_PathParameters_MatrixExpansion_Explode_record = createTests(
-  "/routes/path/matrix/standard/record;a=1;b=2",
+  "/routes/path/matrix/explode/record;a=1;b=2",
 );
 Scenarios.Routes_QueryParameters_templateOnly = createTests("/routes/query/template-only?param=a");
 Scenarios.Routes_QueryParameters_explicit = createTests("/routes/query/explicit?param=a");

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

@@ -4,7 +4,7 @@ import "@typespec/spector";
 using Http;
 using Spector;
 
-@doc("Projection")
+@doc("Encoded names")
 @scenarioService("/serialization/encoded-name/json")
 namespace Serialization.EncodedName.Json;
 

package/specs/serialization/encoded-name/json/mockapi.ts

@@ -5,7 +5,7 @@ export const Scenarios: Record<string, ScenarioMockApi> = {};
 Scenarios.Serialization_EncodedName_Json_Property_send = passOnSuccess({
   uri: "/serialization/encoded-name/json/property",
   method: "post",
-  request: { body: { wireName: true } },
+  request: { body: json({ wireName: true }) },
   response: { status: 204 },
   kind: "MockApiDefinition",
 });

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

@@ -8,9 +8,7 @@ using Spector;
  * Illustrates server doesn't define endpoint. Client should automatically add an endpoint to let user pass in.
  */
 @route("/server/endpoint/not-defined")
-@service({
-  title: "Testserver without any endpoint",
-})
+@service(#{ title: "Testserver without any endpoint" })
 namespace Server.Endpoint.NotDefined;
 
 @scenario

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

@@ -4,13 +4,11 @@ import "@typespec/versioning";
 
 using Http;
 using Spector;
-using TypeSpec.Versioning;
-using TypeSpec.Rest;
+using Versioning;
+using Rest;
 
 @versioned(Versions)
-@service({
-  title: "ServerPathMultiple",
-})
+@service(#{ title: "ServerPathMultiple" })
 @server(
   "{endpoint}/server/path/multiple/{apiVersion}",
   "Test server with path parameters.",

package/specs/server/versions/not-versioned/mockapi.ts

@@ -40,7 +40,7 @@ Scenarios.Server_Versions_NotVersioned_withQueryApiVersion = passOnSuccess({
   uri: "/server/versions/not-versioned/with-query-api-version",
   method: "head",
   request: {
-    params: {
+    query: {
       "api-version": "v1.0",
     },
   },

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

@@ -4,7 +4,7 @@ import "@typespec/versioning";
 
 using Http;
 using Spector;
-using TypeSpec.Versioning;
+using Versioning;
 
 /**
  * Illustrates versioned server.

package/specs/server/versions/versioned/mockapi.ts

@@ -31,11 +31,15 @@ Scenarios.Server_Versions_Versioned_withPathApiVersion = createServerTests(
   "/server/versions/versioned/with-path-api-version/2022-12-01-preview",
 );
 
-function createAPIVersionTests(uri: string, requestData: any, serverData: string) {
+function createAPIVersionTests(uri: string, version: string) {
   return passOnSuccess({
     uri,
     method: "head",
-    request: requestData,
+    request: {
+      query: {
+        "api-version": version,
+      },
+    },
     response: {
       status: 200,
     },
@@ -45,20 +49,10 @@ function createAPIVersionTests(uri: string, requestData: any, serverData: string
 
 Scenarios.Server_Versions_Versioned_withQueryOldApiVersion = createAPIVersionTests(
   "/server/versions/versioned/with-query-old-api-version",
-  {
-    params: {
-      "api-version": "2021-01-01-preview",
-    },
-  },
   "2021-01-01-preview",
 );
 
 Scenarios.Server_Versions_Versioned_withQueryApiVersion = createAPIVersionTests(
   "/server/versions/versioned/with-query-api-version",
-  {
-    params: {
-      "api-version": "2022-12-01-preview",
-    },
-  },
   "2022-12-01-preview",
 );

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

@@ -4,7 +4,7 @@ import "@typespec/spector";
 
 using Http;
 using Spector;
-using TypeSpec.Versioning;
+using Versioning;
 
 @doc("Illustrates conditional request headers")
 @scenarioService("/special-headers/conditional-request")

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,121 @@ 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.
+ */
+@route("/extensible-strings")
+namespace ExtensibleStrings {
+  /**
+   * 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",
+  }
+
+  @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")
+  op putExtensibleStringValue(
+    @header contentType: "application/json",
+    @body body: ExtensibleString,
+  ): {
+    @header contentType: "application/json";
+    @body body: ExtensibleString;
+  };
 }