@typespec/http-specs 0.37.2

package/dist/specs/versioning/returnTypeChangedFrom/mockapi.js

@@ -0,0 +1,25 @@
+import { json, passOnSuccess } from "@typespec/spec-api";
+export const Scenarios = {};
+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) => {
+        req.expect.bodyEquals("test");
+        return {
+            status: 200,
+            body: json("test"),
+        };
+    },
+    kind: "MockApiDefinition",
+});
+//# sourceMappingURL=mockapi.js.map

package/dist/specs/versioning/returnTypeChangedFrom/mockapi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mockapi.js","sourceRoot":"","sources":["../../../../specs/versioning/returnTypeChangedFrom/mockapi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAe,aAAa,EAAmB,MAAM,oBAAoB,CAAC;AAEvF,MAAM,CAAC,MAAM,SAAS,GAAoC,EAAE,CAAC;AAE7D,SAAS,CAAC,qCAAqC,GAAG,aAAa,CAAC;IAC9D,GAAG,EAAE,0DAA0D;IAC/D,MAAM,EAAE,MAAM;IACd,OAAO,EAAE;QACP,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE;YACP,cAAc,EAAE,YAAY;SAC7B;KACF;IACD,QAAQ,EAAE;QACR,MAAM,EAAE,GAAG;QACX,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC;KACnB;IACD,OAAO,EAAE,CAAC,GAAgB,EAAE,EAAE;QAC5B,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAC9B,OAAO;YACL,MAAM,EAAE,GAAG;YACX,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC;SACnB,CAAC;IACJ,CAAC;IACD,IAAI,EAAE,mBAAmB;CAC1B,CAAC,CAAC"}

package/dist/specs/versioning/typeChangedFrom/mockapi.d.ts

@@ -0,0 +1,3 @@
+import { ScenarioMockApi } from "@typespec/spec-api";
+export declare const Scenarios: Record<string, ScenarioMockApi>;
+//# sourceMappingURL=mockapi.d.ts.map

package/dist/specs/versioning/typeChangedFrom/mockapi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mockapi.d.ts","sourceRoot":"","sources":["../../../../specs/versioning/typeChangedFrom/mockapi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoC,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAEvF,eAAO,MAAM,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAM,CAAC"}

package/dist/specs/versioning/typeChangedFrom/mockapi.js

@@ -0,0 +1,29 @@
+import { json, passOnSuccess } from "@typespec/spec-api";
+export const Scenarios = {};
+Scenarios.Versioning_TypeChangedFrom_test = passOnSuccess({
+    uri: `/versioning/type-changed-from/api-version:v2/test`,
+    method: `post`,
+    request: {
+        params: {
+            param: "baz",
+        },
+        body: {
+            prop: "foo",
+            changedProp: "bar",
+        },
+    },
+    response: {
+        status: 200,
+        body: json({ prop: "foo", changedProp: "bar" }),
+    },
+    handler: (req) => {
+        req.expect.bodyEquals({ prop: "foo", changedProp: "bar" });
+        req.expect.containsQueryParam("param", "baz");
+        return {
+            status: 200,
+            body: json({ prop: "foo", changedProp: "bar" }),
+        };
+    },
+    kind: "MockApiDefinition",
+});
+//# sourceMappingURL=mockapi.js.map

package/dist/specs/versioning/typeChangedFrom/mockapi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mockapi.js","sourceRoot":"","sources":["../../../../specs/versioning/typeChangedFrom/mockapi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAe,aAAa,EAAmB,MAAM,oBAAoB,CAAC;AAEvF,MAAM,CAAC,MAAM,SAAS,GAAoC,EAAE,CAAC;AAE7D,SAAS,CAAC,+BAA+B,GAAG,aAAa,CAAC;IACxD,GAAG,EAAE,mDAAmD;IACxD,MAAM,EAAE,MAAM;IACd,OAAO,EAAE;QACP,MAAM,EAAE;YACN,KAAK,EAAE,KAAK;SACb;QACD,IAAI,EAAE;YACJ,IAAI,EAAE,KAAK;YACX,WAAW,EAAE,KAAK;SACnB;KACF;IACD,QAAQ,EAAE;QACR,MAAM,EAAE,GAAG;QACX,IAAI,EAAE,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC;KAChD;IACD,OAAO,EAAE,CAAC,GAAgB,EAAE,EAAE;QAC5B,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC;QAC3D,GAAG,CAAC,MAAM,CAAC,kBAAkB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC9C,OAAO;YACL,MAAM,EAAE,GAAG;YACX,IAAI,EAAE,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC;SAChD,CAAC;IACJ,CAAC;IACD,IAAI,EAAE,mBAAmB;CAC1B,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@typespec/http-specs",
+  "version": "0.37.2",
+  "description": "Spec scenarios and mock apis",
+  "main": "dist/index.js",
+  "type": "module",
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/microsoft/typespec.git"
+  },
+  "author": "Microsoft",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/microsoft/typespec/issues"
+  },
+  "homepage": "https://github.com/microsoft/typespec#readme",
+  "dependencies": {
+    "multer": "^1.4.5-lts.1",
+    "dotenv": "~16.4.5",
+    "@typespec/spec": "0.1.0",
+    "@typespec/spec-api": "~0.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "~22.7.1",
+    "@types/multer": "^1.4.10",
+    "rimraf": "~6.0.1",
+    "typescript": "~5.6.2",
+    "@typespec/openapi": "~0.60.0",
+    "@typespec/openapi3": "~0.60.0"
+  },
+  "peerDependencies": {
+    "@typespec/spec-lib": "~0.1.0",
+    "@typespec/http": "~0.60.0",
+    "@typespec/compiler": "~0.60.1",
+    "@typespec/rest": "~0.60.0",
+    "@typespec/versioning": "~0.60.0",
+    "@typespec/xml": "~0.60.0"
+  },
+  "scripts": {
+    "watch": "tsc -p ./tsconfig.build.json --watch",
+    "build": "tsc -p ./tsconfig.build.json",
+    "clean": "rimraf dist/ temp/",
+    "validate-scenarios": "spec validate-scenarios ./specs",
+    "generate-scenarios-summary": "spec generate-scenarios-summary ./specs",
+    "validate-mock-apis": "spec validate-mock-apis ./specs",
+    "check-scenario-coverage": "spec check-coverage ./specs",
+    "serve": "spec serve ./specs",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  }
+}

package/specs/README.md

@@ -0,0 +1,3 @@
+# HTTP Test scenarios
+
+**_Pending_**

package/specs/authentication/api-key/main.tsp

@@ -0,0 +1,39 @@
+import "@typespec/http";
+import "@typespec/spec-lib";
+
+using TypeSpec.Http;
+
+@scenarioService("/authentication/api-key")
+@doc("Illustrates clients generated with ApiKey authentication.")
+@useAuth(ApiKeyAuth<ApiKeyLocation.header, "x-ms-api-key">)
+namespace Authentication.ApiKey;
+
+@scenario
+@scenarioDoc("Expects header 'x-ms-api-key': 'valid-key'")
+@doc("Check whether client is authenticated")
+@get
+@route("/valid")
+op valid(): NoContentResponse;
+
+@scenario
+@scenarioDoc("""
+  Expect error code 403 and error body:
+    ```json
+    {
+      "error": {
+        "code": "InvalidApiKey",
+        "message": "API key is invalid"
+      }
+    }
+    ```
+  """)
+@doc("Check whether client is authenticated.")
+@get
+@route("/invalid")
+op invalid(): NoContentResponse | InvalidAuth;
+
+@error
+model InvalidAuth {
+  @statusCode _: 403;
+  error: string;
+}

package/specs/authentication/api-key/mockapi.ts

@@ -0,0 +1,47 @@
+import { json, MockRequest, passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
+
+export const Scenarios: Record<string, ScenarioMockApi> = {};
+
+Scenarios.Authentication_ApiKey_invalid = passOnSuccess({
+  uri: `/authentication/api-key/invalid`,
+  method: `get`,
+  request: {
+    headers: {
+      "x-ms-api-key": "valid-key",
+    },
+    status: 403,
+  },
+  response: {
+    status: 403,
+    body: json({
+      error: "invalid-api-key",
+    }),
+  },
+  handler: (req: MockRequest) => {
+    return {
+      status: 403,
+      body: json({
+        error: "invalid-api-key",
+      }),
+    };
+  },
+  kind: "MockApiDefinition",
+});
+
+Scenarios.Authentication_ApiKey_valid = passOnSuccess({
+  uri: `/authentication/api-key/valid`,
+  method: `get`,
+  request: {
+    headers: {
+      "x-ms-api-key": "valid-key",
+    },
+  },
+  response: {
+    status: 204,
+  },
+  handler: (req: MockRequest) => {
+    req.expect.containsHeader("x-ms-api-key", "valid-key");
+    return { status: 204 };
+  },
+  kind: "MockApiDefinition",
+});

package/specs/authentication/commonapi.ts

@@ -0,0 +1,43 @@
+import {
+  json,
+  mockapi,
+  MockRequest,
+  passOnCode,
+  PassOnCodeScenario,
+  passOnSuccess,
+  PassOnSuccessScenario,
+  ScenarioMockApi,
+} from "@typespec/spec-api";
+
+export const Scenarios: Record<string, ScenarioMockApi> = {};
+
+interface ValidAndInvalidCodeScenarios {
+  valid: PassOnSuccessScenario;
+  invalid: PassOnCodeScenario;
+}
+
+export function getValidAndInvalidScenarios(
+  scenarioFolder: string,
+  errorCode: string,
+  authenticationValidation: (req: MockRequest) => void,
+): ValidAndInvalidCodeScenarios {
+  return {
+    valid: passOnSuccess(
+      mockapi.get(`/authentication/${scenarioFolder}/valid`, (req) => {
+        authenticationValidation(req);
+        return { status: 204 };
+      }),
+    ),
+    invalid: passOnCode(
+      403,
+      mockapi.get(`/authentication/${scenarioFolder}/invalid`, (req) => {
+        return {
+          status: 403,
+          body: json({
+            error: errorCode,
+          }),
+        };
+      }),
+    ),
+  };
+}

package/specs/authentication/http/custom/main.tsp

@@ -0,0 +1,39 @@
+import "@typespec/http";
+import "@typespec/spec-lib";
+
+using TypeSpec.Http;
+
+@scenarioService("/authentication/http/custom")
+@doc("Illustrates clients generated with generic HTTP auth.")
+@useAuth({
+  type: AuthType.http,
+  scheme: "SharedAccessKey",
+})
+namespace Authentication.Http.Custom;
+
+@scenario
+@scenarioDoc("Expects header 'Authorization': 'SharedAccessKey valid-key'")
+@doc("Check whether client is authenticated")
+@get
+@route("/valid")
+op valid(): NoContentResponse;
+
+@scenario
+@scenarioDoc("""
+  Expect error code 403 and error body:
+    ```json
+    {
+      "error": "invalid-api-key"
+    }
+    ```
+  """)
+@doc("Check whether client is authenticated.")
+@get
+@route("/invalid")
+op invalid(): NoContentResponse | InvalidAuth;
+
+@error
+model InvalidAuth {
+  @statusCode _: 403;
+  error: string;
+}

package/specs/authentication/http/custom/mockapi.ts

@@ -0,0 +1,47 @@
+import { json, MockRequest, passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
+
+export const Scenarios: Record<string, ScenarioMockApi> = {};
+
+Scenarios.Authentication_Http_Custom_valid = passOnSuccess({
+  uri: `/authentication/http/custom/valid`,
+  method: "get",
+  request: {
+    headers: {
+      authorization: "SharedAccessKey valid-key",
+    },
+  },
+  response: {
+    status: 204,
+  },
+  handler: (req: MockRequest) => {
+    req.expect.containsHeader("authorization", "SharedAccessKey valid-key");
+    return { status: 204 };
+  },
+  kind: "MockApiDefinition",
+});
+
+Scenarios.Authentication_Http_Custom_invalid = passOnSuccess({
+  uri: `/authentication/http/custom/invalid`,
+  method: "get",
+  request: {
+    headers: {
+      authorization: "SharedAccessKey valid-key",
+    },
+    status: 403,
+  },
+  response: {
+    status: 403,
+    body: json({
+      error: "invalid-api-key",
+    }),
+  },
+  handler: (req: MockRequest) => {
+    return {
+      status: 403,
+      body: json({
+        error: "invalid-api-key",
+      }),
+    };
+  },
+  kind: "MockApiDefinition",
+});

package/specs/authentication/oauth2/main.tsp

@@ -0,0 +1,44 @@
+import "@typespec/http";
+import "@typespec/spec-lib";
+
+using TypeSpec.Http;
+
+@scenarioService("/authentication/oauth2")
+@doc("Illustrates clients generated with OAuth2 authentication.")
+@useAuth(OAuth2Auth<[MyFlow]>)
+namespace Authentication.OAuth2;
+
+model MyFlow {
+  type: OAuth2FlowType.implicit;
+  authorizationUrl: "https://login.microsoftonline.com/common/oauth2/authorize";
+  scopes: ["https://security.microsoft.com/.default"];
+}
+
+@scenario
+@scenarioDoc("Expects header 'authorization': 'Bearer https://security.microsoft.com/.default'")
+@doc("Check whether client is authenticated")
+@get
+@route("/valid")
+op valid(): NoContentResponse;
+
+@scenario
+@scenarioDoc("""
+  Expect error code 400 and error body:
+    ```json
+    {
+      "message": "Expected Bearer x but got Bearer y",
+      "expected": "Bearer x",
+      "actual": "Bearer y",
+    }
+    ```
+  """)
+@doc("Check whether client is authenticated. Will return an invalid bearer error.")
+@get
+@route("/invalid")
+op invalid(): NoContentResponse | InvalidAuth;
+
+@error
+model InvalidAuth {
+  @statusCode _: 403;
+  error: string;
+}

package/specs/authentication/oauth2/mockapi.ts

@@ -0,0 +1,44 @@
+import { json, MockRequest, passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
+
+export const Scenarios: Record<string, ScenarioMockApi> = {};
+
+Scenarios.Authentication_OAuth2_valid = passOnSuccess({
+  uri: `/authentication/oauth2/valid`,
+  method: "get",
+  request: {
+    headers: {
+      authorization: "Bearer https://security.microsoft.com/.default",
+    },
+  },
+  response: {
+    status: 204,
+  },
+  handler: (req: MockRequest) => {
+    req.expect.containsHeader("authorization", "Bearer https://security.microsoft.com/.default");
+    return { status: 204 };
+  },
+  kind: "MockApiDefinition",
+});
+
+Scenarios.Authentication_OAuth2_invalid = passOnSuccess({
+  uri: `/authentication/oauth2/invalid`,
+  method: "get",
+  request: {
+    status: 403,
+  },
+  response: {
+    status: 403,
+    body: json({
+      error: "invalid-grant",
+    }),
+  },
+  handler: (req: MockRequest) => {
+    return {
+      status: 403,
+      body: json({
+        error: "invalid-grant",
+      }),
+    };
+  },
+  kind: "MockApiDefinition",
+});

package/specs/authentication/union/main.tsp

@@ -0,0 +1,29 @@
+import "@typespec/http";
+import "@typespec/spec-lib";
+
+using TypeSpec.Http;
+
+@scenarioService("/authentication/union")
+@doc("Illustrates clients generated with ApiKey and OAuth2 authentication.")
+@useAuth(ApiKeyAuth<ApiKeyLocation.header, "x-ms-api-key"> | OAuth2Auth<[MyFlow]>)
+namespace Authentication.Union;
+
+model MyFlow {
+  type: OAuth2FlowType.implicit;
+  authorizationUrl: "https://login.microsoftonline.com/common/oauth2/authorize";
+  scopes: ["https://security.microsoft.com/.default"];
+}
+
+@scenario
+@scenarioDoc("Expects header 'x-ms-api-key': 'valid-key'")
+@doc("Check whether client is authenticated")
+@get
+@route("/validkey")
+op validKey(): NoContentResponse;
+
+@scenario
+@scenarioDoc("Expects header 'authorization': 'Bearer https://security.microsoft.com/.default'")
+@doc("Check whether client is authenticated")
+@get
+@route("/validtoken")
+op validToken(): NoContentResponse;

package/specs/authentication/union/mockapi.ts

@@ -0,0 +1,39 @@
+import { MockRequest, passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
+
+export const Scenarios: Record<string, ScenarioMockApi> = {};
+
+Scenarios.Authentication_Union_validKey = passOnSuccess({
+  uri: `/authentication/union/validkey`,
+  method: "get",
+  request: {
+    headers: {
+      "x-ms-api-key": "valid-key",
+    },
+  },
+  response: {
+    status: 204,
+  },
+  handler: (req: MockRequest) => {
+    req.expect.containsHeader("x-ms-api-key", "valid-key");
+    return { status: 204 };
+  },
+  kind: "MockApiDefinition",
+});
+
+Scenarios.Authentication_Union_validToken = passOnSuccess({
+  uri: `/authentication/union/validtoken`,
+  method: "get",
+  request: {
+    headers: {
+      authorization: "Bearer https://security.microsoft.com/.default",
+    },
+  },
+  response: {
+    status: 204,
+  },
+  handler: (req: MockRequest) => {
+    req.expect.containsHeader("authorization", "Bearer https://security.microsoft.com/.default");
+    return { status: 204 };
+  },
+  kind: "MockApiDefinition",
+});