@typespec/http-specs 0.37.2

package/specs/versioning/added/main.tsp

@@ -0,0 +1,135 @@
+import "@typespec/http";
+import "@typespec/spec-lib";
+import "@typespec/versioning";
+
+using TypeSpec.Http;
+using TypeSpec.Versioning;
+
+/**
+ * Test for the `@added` decorator.
+ */
+@service
+@versioned(Versions)
+@server(
+  "{endpoint}/versioning/added/api-version:{version}",
+  "Testserver endpoint",
+  {
+    /**
+     * Need to be set as 'http://localhost:3000' in client.
+     */
+    endpoint: url,
+
+    /**
+     * Need to be set as 'v1' or 'v2' in client.
+     */
+    version: Versions,
+  }
+)
+namespace Versioning.Added;
+
+/**
+ * The version of the API.
+ */
+enum Versions {
+  /**
+   * The version v1.
+   */
+  v1: "v1",
+
+  /**
+   * The version v2.
+   */
+  v2: "v2",
+}
+
+model ModelV1 {
+  prop: string;
+  enumProp: EnumV1;
+
+  @added(Versions.v2)
+  unionProp: UnionV1;
+}
+
+enum EnumV1 {
+  enumMemberV1,
+
+  @added(Versions.v2)
+  enumMemberV2,
+}
+
+@added(Versions.v2)
+model ModelV2 {
+  prop: string;
+  enumProp: EnumV2;
+  unionProp: UnionV2;
+}
+
+@added(Versions.v2)
+enum EnumV2 {
+  enumMember,
+}
+
+union UnionV1 {
+  string,
+
+  @added(Versions.v2)
+  V2Scalar,
+}
+
+@added(Versions.v2)
+union UnionV2 {
+  string,
+  int32,
+}
+
+@added(Versions.v2)
+scalar V2Scalar extends int32;
+
+@scenario
+@scenarioDoc("""
+  This operation should be generated with latest version's signature.
+  
+  Expected request body:
+  ```json
+  { "prop": "foo", "enumProp": "enumMemberV2", "unionProp": 10 }
+  ```
+  
+  Expected header:
+  header-v2=bar
+  
+  """)
+@route("/v1")
+@post
+op v1(@body body: ModelV1, @added(Versions.v2) @header headerV2: string): ModelV1;
+
+@scenario
+@scenarioDoc("""
+  This operation should only be generated with latest version.
+  
+  Expected request body:
+  ```json
+  { "prop": "foo", "enumProp": "enumMember", "unionProp": "bar" }
+  ```
+  """)
+@route("/v2")
+@added(Versions.v2)
+@post
+op v2(@body body: ModelV2): ModelV2;
+
+@added(Versions.v2)
+@scenario
+@scenarioDoc("""
+  This operation group should only be generated with latest version.
+  
+  Expected request body for v2InInterface:
+  ```json
+  { "prop": "foo", "enumProp": "enumMember", "unionProp": "bar" }
+  ```
+  
+  """)
+@route("/interface-v2")
+interface InterfaceV2 {
+  @post
+  @route("/v2")
+  v2InInterface(@body body: ModelV2): ModelV2;
+}

package/specs/versioning/added/mockapi.ts

@@ -0,0 +1,79 @@
+import { json, MockRequest, passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
+
+export const Scenarios: Record<string, ScenarioMockApi> = {};
+
+Scenarios.Versioning_Added_v1 = passOnSuccess({
+  uri: `/versioning/added/api-version:v2/v1`,
+  method: `post`,
+  request: {
+    body: {
+      prop: "foo",
+      enumProp: "enumMemberV2",
+      unionProp: 10,
+    },
+    headers: {
+      "header-v2": "bar",
+    },
+  },
+  response: {
+    status: 200,
+    body: json({ prop: "foo", enumProp: "enumMemberV2", unionProp: 10 }),
+  },
+  handler: (req: MockRequest) => {
+    req.expect.bodyEquals({ prop: "foo", enumProp: "enumMemberV2", unionProp: 10 });
+    req.expect.containsHeader("header-v2", "bar");
+    return {
+      status: 200,
+      body: json({ prop: "foo", enumProp: "enumMemberV2", unionProp: 10 }),
+    };
+  },
+  kind: "MockApiDefinition",
+});
+
+Scenarios.Versioning_Added_v2 = passOnSuccess({
+  uri: `/versioning/added/api-version:v2/v2`,
+  method: `post`,
+  request: {
+    body: {
+      prop: "foo",
+      enumProp: "enumMember",
+      unionProp: "bar",
+    },
+  },
+  response: {
+    status: 200,
+    body: json({ prop: "foo", enumProp: "enumMember", unionProp: "bar" }),
+  },
+  handler: (req: MockRequest) => {
+    req.expect.bodyEquals({ prop: "foo", enumProp: "enumMember", unionProp: "bar" });
+    return {
+      status: 200,
+      body: json({ prop: "foo", enumProp: "enumMember", unionProp: "bar" }),
+    };
+  },
+  kind: "MockApiDefinition",
+});
+
+Scenarios.Versioning_Added_InterfaceV2 = passOnSuccess({
+  uri: `/versioning/added/api-version:v2/interface-v2/v2`,
+  method: `post`,
+  request: {
+    body: {
+      prop: "foo",
+      enumProp: "enumMember",
+      unionProp: "bar",
+    },
+  },
+  response: {
+    status: 200,
+    body: json({ prop: "foo", enumProp: "enumMember", unionProp: "bar" }),
+  },
+  handler: (req: MockRequest) => {
+    req.expect.bodyEquals({ prop: "foo", enumProp: "enumMember", unionProp: "bar" });
+    return {
+      status: 200,
+      body: json({ prop: "foo", enumProp: "enumMember", unionProp: "bar" }),
+    };
+  },
+  kind: "MockApiDefinition",
+});

package/specs/versioning/madeOptional/main.tsp

@@ -0,0 +1,64 @@
+import "@typespec/http";
+import "@typespec/spec-lib";
+import "@typespec/versioning";
+
+using TypeSpec.Http;
+using TypeSpec.Versioning;
+
+/**
+ * Test for the `@madeOptional` decorator.
+ */
+@service
+@versioned(Versions)
+@server(
+  "{endpoint}/versioning/made-optional/api-version:{version}",
+  "Testserver endpoint",
+  {
+    /**
+     * Need to be set as 'http://localhost:3000' in client.
+     */
+    endpoint: url,
+
+    /**
+     * Need to be set as 'v1' or 'v2' in client.
+     */
+    version: Versions,
+  }
+)
+namespace Versioning.MadeOptional;
+
+/**
+ * The version of the API.
+ */
+enum Versions {
+  /**
+   * The version v1.
+   */
+  v1: "v1",
+
+  /**
+   * The version v2.
+   */
+  v2: "v2",
+}
+
+model TestModel {
+  prop: string;
+
+  @madeOptional(Versions.v2)
+  changedProp?: string;
+}
+
+@scenario
+@scenarioDoc("""
+  This operation should be generated with latest version's signature.
+  
+  Expected request body:
+  ```json
+  { "prop": "foo" }
+  ```
+  
+  """)
+@route("/test")
+@post
+op test(@body body: TestModel, @madeOptional(Versions.v2) @query param?: string): TestModel;

package/specs/versioning/madeOptional/mockapi.ts

@@ -0,0 +1,25 @@
+import { json, MockRequest, passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
+
+export const Scenarios: Record<string, ScenarioMockApi> = {};
+
+Scenarios.Versioning_MadeOptional_test = passOnSuccess({
+  uri: `/versioning/made-optional/api-version:v2/test`,
+  method: `post`,
+  request: {
+    body: {
+      prop: "foo",
+    },
+  },
+  response: {
+    status: 200,
+    body: json({ prop: "foo" }),
+  },
+  handler: (req: MockRequest) => {
+    req.expect.bodyEquals({ prop: "foo" });
+    return {
+      status: 200,
+      body: json({ prop: "foo" }),
+    };
+  },
+  kind: "MockApiDefinition",
+});

package/specs/versioning/removed/main.tsp

@@ -0,0 +1,125 @@
+import "@typespec/http";
+import "@typespec/spec-lib";
+import "@typespec/versioning";
+
+using TypeSpec.Http;
+using TypeSpec.Versioning;
+
+/**
+ * Test for the `@removed` decorator.
+ */
+@service
+@versioned(Versions)
+@server(
+  "{endpoint}/versioning/removed/api-version:{version}",
+  "Testserver endpoint",
+  {
+    /**
+     * Need to be set as 'http://localhost:3000' in client.
+     */
+    endpoint: url,
+
+    /**
+     * Need to be set as 'v1' or 'v2' in client.
+     */
+    version: Versions,
+  }
+)
+namespace Versioning.Removed;
+
+/**
+ * The version of the API.
+ */
+enum Versions {
+  /**
+   * The version v1.
+   */
+  v1: "v1",
+
+  /**
+   * The version v2.
+   */
+  v2: "v2",
+}
+
+@removed(Versions.v2)
+model ModelV1 {
+  prop: string;
+  enumProp: EnumV1;
+  unionProp: UnionV1;
+}
+
+@removed(Versions.v2)
+enum EnumV1 {
+  enumMember,
+}
+
+model ModelV2 {
+  prop: string;
+
+  @removed(Versions.v2)
+  removedProp: string;
+
+  enumProp: EnumV2;
+
+  @added(Versions.v1)
+  unionProp: UnionV2;
+}
+
+enum EnumV2 {
+  @removed(Versions.v2)
+  enumMemberV1,
+
+  enumMemberV2,
+}
+
+@removed(Versions.v2)
+union UnionV1 {
+  string,
+  int32,
+}
+
+union UnionV2 {
+  string,
+  float32,
+
+  @removed(Versions.v2)
+  V1Scalar,
+}
+
+@removed(Versions.v2)
+scalar V1Scalar extends int32;
+
+/**
+ * This operation should not be generated with latest version's signature.
+ */
+#suppress "@azure-tools/cadl-ranch-expect/missing-scenario" "by design"
+@route("/v1")
+@post
+@removed(Versions.v2)
+op v1(@body body: ModelV1): ModelV1;
+
+@scenario
+@scenarioDoc("""
+  This operation should be generated with latest version's signature.
+  
+  Expected request body:
+  ```json
+  { "prop": "foo", "enumProp": "enumMemberV2", "unionProp": "bar" }
+  ```
+  """)
+@route("/v2")
+@post
+op v2(@body body: ModelV2, @removed(Versions.v2) @query param: string): ModelV2;
+
+/**
+ * This operation group should not be generated with latest version.
+ */
+@route("/interface-v1")
+@removed(Versions.v2)
+interface InterfaceV1 {
+  #suppress "@azure-tools/cadl-ranch-expect/missing-scenario" "by design"
+  @post
+  @route("/v1")
+  v1InInterface(@body body: ModelV1): ModelV1;
+}

package/specs/versioning/removed/mockapi.ts

@@ -0,0 +1,27 @@
+import { json, MockRequest, passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
+
+export const Scenarios: Record<string, ScenarioMockApi> = {};
+
+Scenarios.Versioning_Removed_v2 = passOnSuccess({
+  uri: `/versioning/removed/api-version:v2/v2`,
+  method: `post`,
+  request: {
+    body: {
+      prop: "foo",
+      enumProp: "enumMemberV2",
+      unionProp: "bar",
+    },
+  },
+  response: {
+    status: 200,
+    body: json({ prop: "foo", enumProp: "enumMemberV2", unionProp: "bar" }),
+  },
+  handler: (req: MockRequest) => {
+    req.expect.bodyEquals({ prop: "foo", enumProp: "enumMemberV2", unionProp: "bar" });
+    return {
+      status: 200,
+      body: json({ prop: "foo", enumProp: "enumMemberV2", unionProp: "bar" }),
+    };
+  },
+  kind: "MockApiDefinition",
+});

package/specs/versioning/renamedFrom/main.tsp

@@ -0,0 +1,111 @@
+import "@typespec/http";
+import "@typespec/spec-lib";
+import "@typespec/versioning";
+
+using TypeSpec.Http;
+using TypeSpec.Versioning;
+
+/**
+ * Test for the `@renamedFrom` decorator.
+ */
+@service
+@versioned(Versions)
+@server(
+  "{endpoint}/versioning/renamed-from/api-version:{version}",
+  "Testserver endpoint",
+  {
+    /**
+     * Need to be set as 'http://localhost:3000' in client.
+     */
+    endpoint: url,
+
+    /**
+     * Need to be set as 'v1' or 'v2' in client.
+     */
+    version: Versions,
+  }
+)
+namespace Versioning.RenamedFrom;
+
+/**
+ * The version of the API.
+ */
+enum Versions {
+  /**
+   * The version v1.
+   */
+  v1: "v1",
+
+  /**
+   * The version v2.
+   */
+  v2: "v2",
+}
+
+@renamedFrom(Versions.v2, "OldModel")
+model NewModel {
+  @renamedFrom(Versions.v2, "oldProp")
+  newProp: string;
+
+  enumProp: NewEnum;
+  unionProp: NewUnion;
+}
+
+@renamedFrom(Versions.v2, "OldEnum")
+enum NewEnum {
+  @renamedFrom(Versions.v2, "oldEnumMember")
+  newEnumMember,
+}
+
+@renamedFrom(Versions.v2, "OldUnion")
+union NewUnion {
+  string,
+
+  @renamedFrom(Versions.v2, "oldUnionVariant")
+  newUnionVariant: NewScalar,
+}
+
+@renamedFrom(Versions.v2, "OldScalar")
+scalar NewScalar extends int32;
+
+@scenario
+@scenarioDoc("""
+  This operation should be generated with latest version's signature.
+  
+  Expected request body:
+  ```json
+  { "newProp": "foo", "enumProp": "newEnumMember", "unionProp": 10 }
+  ```
+  
+  Expected query:
+  newQuery=bar
+  
+  """)
+@route("/test")
+@post
+@renamedFrom(Versions.v2, "oldOp")
+op newOp(
+  @body body: NewModel,
+
+  @renamedFrom(Versions.v2, "oldQuery")
+  @query
+  newQuery: string,
+): NewModel;
+
+@renamedFrom(Versions.v2, "OldInterface")
+@scenario
+@scenarioDoc("""
+  This operation group should only be generated with latest version's signature.
+  
+  Expected request body for test:
+  ```json
+  { "prop": "foo", "enumProp": "newEnumMember", "unionProp": 10 }
+  ```
+  
+  """)
+@route("/interface")
+interface NewInterface {
+  @post
+  @route("/test")
+  newOpInNewInterface(@body body: NewModel): NewModel;
+}

package/specs/versioning/renamedFrom/mockapi.ts

@@ -0,0 +1,55 @@
+import { json, MockRequest, passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
+
+export const Scenarios: Record<string, ScenarioMockApi> = {};
+
+Scenarios.Versioning_RenamedFrom_newOp = passOnSuccess({
+  uri: `/versioning/renamed-from/api-version:v2/test`,
+  method: `post`,
+  request: {
+    body: {
+      newProp: "foo",
+      enumProp: "newEnumMember",
+      unionProp: 10,
+    },
+    params: {
+      newQuery: "bar",
+    },
+  },
+  response: {
+    status: 200,
+    body: json({ newProp: "foo", enumProp: "newEnumMember", unionProp: 10 }),
+  },
+  handler: (req: MockRequest) => {
+    req.expect.bodyEquals({ newProp: "foo", enumProp: "newEnumMember", unionProp: 10 });
+    req.expect.containsQueryParam("newQuery", "bar");
+    return {
+      status: 200,
+      body: json({ newProp: "foo", enumProp: "newEnumMember", unionProp: 10 }),
+    };
+  },
+  kind: "MockApiDefinition",
+});
+
+Scenarios.Versioning_RenamedFrom_NewInterface = passOnSuccess({
+  uri: `/versioning/renamed-from/api-version:v2/interface/test`,
+  method: `post`,
+  request: {
+    body: {
+      newProp: "foo",
+      enumProp: "newEnumMember",
+      unionProp: 10,
+    },
+  },
+  response: {
+    status: 200,
+    body: json({ newProp: "foo", enumProp: "newEnumMember", unionProp: 10 }),
+  },
+  handler: (req: MockRequest) => {
+    req.expect.bodyEquals({ newProp: "foo", enumProp: "newEnumMember", unionProp: 10 });
+    return {
+      status: 200,
+      body: json({ newProp: "foo", enumProp: "newEnumMember", unionProp: 10 }),
+    };
+  },
+  kind: "MockApiDefinition",
+});

package/specs/versioning/returnTypeChangedFrom/main.tsp

@@ -0,0 +1,56 @@
+import "@typespec/http";
+import "@typespec/spec-lib";
+import "@typespec/versioning";
+
+using TypeSpec.Http;
+using TypeSpec.Versioning;
+
+/**
+ * Test for the `@returnTypeChangedFrom` decorator.
+ */
+@service
+@versioned(Versions)
+@server(
+  "{endpoint}/versioning/return-type-changed-from/api-version:{version}",
+  "Testserver endpoint",
+  {
+    /**
+     * Need to be set as 'http://localhost:3000' in client.
+     */
+    endpoint: url,
+
+    /**
+     * Need to be set as 'v1' or 'v2' in client.
+     */
+    version: Versions,
+  }
+)
+namespace Versioning.ReturnTypeChangedFrom;
+
+/**
+ * The version of the API.
+ */
+enum Versions {
+  /**
+   * The version v1.
+   */
+  v1: "v1",
+
+  /**
+   * The version v2.
+   */
+  v2: "v2",
+}
+
+@scenario
+@scenarioDoc("""
+  This operation should be generated with latest version's signature.
+  
+  Expected request body: "test"
+  Expected response body: "test"
+  
+  """)
+@route("/test")
+@post
+@returnTypeChangedFrom(Versions.v2, int32)
+op test(@body body: string): string;

package/specs/versioning/returnTypeChangedFrom/mockapi.ts

@@ -0,0 +1,26 @@
+import { json, MockRequest, passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
+
+export const Scenarios: Record<string, ScenarioMockApi> = {};
+
+Scenarios.Versioning_ReturnTypeChangedFrom_test = passOnSuccess({
+  uri: `/versioning/return-type-changed-from/api-version:v2/test`,
+  method: `post`,
+  request: {
+    body: "test",
+    headers: {
+      "Content-Type": "text/plain",
+    },
+  },
+  response: {
+    status: 200,
+    body: json("test"),
+  },
+  handler: (req: MockRequest) => {
+    req.expect.bodyEquals("test");
+    return {
+      status: 200,
+      body: json("test"),
+    };
+  },
+  kind: "MockApiDefinition",
+});