@typespec/http-specs 0.37.2

package/specs/encode/datetime/main.tsp

@@ -0,0 +1,344 @@
+import "@typespec/http";
+import "@typespec/spec-lib";
+
+using TypeSpec.Http;
+using Azure.ClientGenerator.Core;
+
+@doc("Test for encode decorator on datetime.")
+@supportedBy("dpg")
+@scenarioService("/encode/datetime")
+namespace Encode.Datetime;
+
+@encode(DateTimeKnownEncoding.unixTimestamp, int64)
+scalar unixTimestampDatetime extends utcDateTime;
+
+@operationGroup
+@route("/query")
+namespace Query {
+  @route("/default")
+  @scenario
+  @scenarioDoc("""
+    Test default encode (rfc3339) for datetime query parameter.
+    Expected query parameter:
+    value=2022-08-26T18:38:00.000Z
+    """)
+  op default(
+    @query
+    value: utcDateTime,
+  ): NoContentResponse;
+
+  @route("/rfc3339")
+  @scenario
+  @scenarioDoc("""
+    Test rfc3339 encode for datetime query parameter.
+    Expected query parameter:
+    value=2022-08-26T18:38:00.000Z
+    """)
+  op rfc3339(
+    @query
+    @encode(DateTimeKnownEncoding.rfc3339)
+    value: utcDateTime,
+  ): NoContentResponse;
+
+  @route("/rfc7231")
+  @scenario
+  @scenarioDoc("""
+    Test rfc7231 encode for datetime query parameter.
+    Expected query parameter:
+    value=Fri, 26 Aug 2022 14:38:00 GMT
+    """)
+  op rfc7231(
+    @query
+    @encode(DateTimeKnownEncoding.rfc7231)
+    value: utcDateTime,
+  ): NoContentResponse;
+
+  @route("/unix-timestamp")
+  @scenario
+  @scenarioDoc("""
+    Test unixTimestamp encode for datetime query parameter.
+    Expected query parameter:
+    value=1686566864
+    """)
+  op unixTimestamp(
+    @query
+    @encode(DateTimeKnownEncoding.unixTimestamp, int64)
+    value: utcDateTime,
+  ): NoContentResponse;
+
+  @route("/unix-timestamp-array")
+  @scenario
+  @scenarioDoc("""
+    Test unixTimestamp encode for datetime array query parameter.
+    Expected query parameter:
+    value=1686566864, 1686734256
+    """)
+  op unixTimestampArray(
+    #suppress "deprecated" "Deprecated in next release"
+    @query({
+      format: "csv",
+    })
+    value: unixTimestampDatetime[],
+  ): NoContentResponse;
+}
+
+model DefaultDatetimeProperty {
+  value: utcDateTime;
+}
+
+model Rfc3339DatetimeProperty {
+  @encode(DateTimeKnownEncoding.rfc3339)
+  value: utcDateTime;
+}
+
+model Rfc7231DatetimeProperty {
+  @encode(DateTimeKnownEncoding.rfc7231)
+  value: utcDateTime;
+}
+
+model UnixTimestampDatetimeProperty {
+  @encode(DateTimeKnownEncoding.unixTimestamp, int64)
+  value: utcDateTime;
+}
+
+model UnixTimestampArrayDatetimeProperty {
+  value: unixTimestampDatetime[];
+}
+
+@operationGroup
+@route("/property")
+namespace Property {
+  @route("/default")
+  @scenario
+  @scenarioDoc("""
+    Test operation with request and response model contains datetime property with default encode (rfc3339).
+    Expected request body:
+    ```json
+    {
+      "value": "2022-08-26T18:38:00.000Z"
+    }
+    ```
+    Expected response body:
+    ```json
+    {
+      "value": "2022-08-26T18:38:00.000Z"
+    }
+    ```
+    """)
+  @post
+  op default(@body body: DefaultDatetimeProperty): DefaultDatetimeProperty;
+
+  @route("/rfc3339")
+  @scenario
+  @scenarioDoc("""
+    Test operation with request and response model contains datetime property with rfc3339 encode.
+    Expected request body:
+    ```json
+    {
+      "value": "2022-08-26T18:38:00.000Z"
+    }
+    ```
+    Expected response body:
+    ```json
+    {
+      "value": "2022-08-26T18:38:00.000Z"
+    }
+    ```
+    """)
+  @post
+  op rfc3339(@body body: Rfc3339DatetimeProperty): Rfc3339DatetimeProperty;
+
+  @route("/rfc7231")
+  @scenario
+  @scenarioDoc("""
+    Test operation with request and response model contains datetime property with rfc7231 encode.
+    Expected request body:
+    ```json
+    {
+      "value": "Fri, 26 Aug 2022 14:38:00 GMT"
+    }
+    ```
+    Expected response body:
+    ```json
+    {
+      "value": "Fri, 26 Aug 2022 14:38:00 GMT"
+    }
+    ```
+    """)
+  @post
+  op rfc7231(@body body: Rfc7231DatetimeProperty): Rfc7231DatetimeProperty;
+
+  @route("/unix-timestamp")
+  @scenario
+  @scenarioDoc("""
+    Test operation with request and response model contains datetime property with unixTimestamp encode.
+    Expected request body:
+    ```json
+    {
+      "value": 1686566864
+    }
+    ```
+    Expected response body:
+    ```json
+    {
+      "value": 1686566864
+    }
+    ```
+    """)
+  @post
+  op unixTimestamp(@body body: UnixTimestampDatetimeProperty): UnixTimestampDatetimeProperty;
+
+  @route("/unix-timestamp-array")
+  @scenario
+  @scenarioDoc("""
+    Test operation with request and response model contains datetime array property with unixTimestamp encode.
+    Expected request body:f
+    ```json
+    {
+      "value": [1686566864, 1686734256]
+    }
+    ```
+    Expected response body:
+    ```json
+    {
+      "value": [1686566864, 1686734256]
+    }
+    ```
+    """)
+  @post
+  op unixTimestampArray(
+    @body body: UnixTimestampArrayDatetimeProperty,
+  ): UnixTimestampArrayDatetimeProperty;
+}
+
+@operationGroup
+@route("/header")
+namespace Header {
+  @route("/default")
+  @scenario
+  @scenarioDoc("""
+    Test default encode (rfc7231) for datetime header.
+    Expected header:
+    value=Fri, 26 Aug 2022 14:38:00 GMT
+    """)
+  op default(
+    @header
+    value: utcDateTime,
+  ): NoContentResponse;
+
+  @route("/rfc3339")
+  @scenario
+  @scenarioDoc("""
+    Test rfc3339 encode for datetime header.
+    Expected header:
+    value=2022-08-26T18:38:00.000Z
+    """)
+  op rfc3339(
+    @header
+    @encode(DateTimeKnownEncoding.rfc3339)
+    value: utcDateTime,
+  ): NoContentResponse;
+
+  @route("/rfc7231")
+  @scenario
+  @scenarioDoc("""
+    Test rfc7231 encode for datetime header.
+    Expected header:
+    value=Fri, 26 Aug 2022 14:38:00 GMT
+    """)
+  op rfc7231(
+    @header
+    @encode(DateTimeKnownEncoding.rfc7231)
+    value: utcDateTime,
+  ): NoContentResponse;
+
+  @route("/unix-timestamp")
+  @scenario
+  @scenarioDoc("""
+    Test unixTimestamp encode for datetime header.
+    Expected header:
+    value=1686566864
+    """)
+  op unixTimestamp(
+    @header
+    @encode(DateTimeKnownEncoding.unixTimestamp, int64)
+    value: utcDateTime,
+  ): NoContentResponse;
+
+  @route("/unix-timestamp-array")
+  @scenario
+  @scenarioDoc("""
+    Test unixTimestamp encode for datetime array header.
+    Expected header:
+    value=1686566864,1686734256
+    """)
+  op unixTimestampArray(
+    @header({
+      format: "csv",
+    })
+    value: unixTimestampDatetime[],
+  ): NoContentResponse;
+}
+
+model DefaultDatetimeHeader {
+  @header
+  value: utcDateTime;
+}
+
+model Rfc3339DatetimeHeader {
+  @encode(DateTimeKnownEncoding.rfc3339)
+  @header
+  value: utcDateTime;
+}
+
+model Rfc7231DatetimeHeader {
+  @encode(DateTimeKnownEncoding.rfc7231)
+  @header
+  value: utcDateTime;
+}
+
+model UnixTimestampDatetimeHeader {
+  @encode(DateTimeKnownEncoding.unixTimestamp, int64)
+  @header
+  value: utcDateTime;
+}
+
+@operationGroup
+@route("/responseheader")
+namespace ResponseHeader {
+  @route("/default")
+  @scenario
+  @scenarioDoc("""
+    Test default encode (rfc7231) for datetime header.
+    Expected response header:
+    value=Fri, 26 Aug 2022 14:38:00 GMT
+    """)
+  op default(): NoContentResponse & DefaultDatetimeHeader;
+
+  @route("/rfc3339")
+  @scenario
+  @scenarioDoc("""
+    Test rfc3339 encode for datetime header.
+    Expected response header:
+    value=2022-08-26T18:38:00.000Z
+    """)
+  op rfc3339(): NoContentResponse & Rfc3339DatetimeHeader;
+
+  @route("/rfc7231")
+  @scenario
+  @scenarioDoc("""
+    Test rfc7231 encode for datetime header.
+    Expected response header:
+    value=Fri, 26 Aug 2022 14:38:00 GMT
+    """)
+  op rfc7231(): NoContentResponse & Rfc7231DatetimeHeader;
+
+  @route("/unix-timestamp")
+  @scenario
+  @scenarioDoc("""
+    Test unixTimestamp encode for datetime header.
+    Expected response header:
+    value=1686566864
+    """)
+  op unixTimestamp(): NoContentResponse & UnixTimestampDatetimeHeader;
+}

package/specs/encode/datetime/mockapi.ts

@@ -0,0 +1,274 @@
+import {
+  CollectionFormat,
+  json,
+  MockRequest,
+  passOnSuccess,
+  ScenarioMockApi,
+  validateValueFormat,
+  ValidationError,
+} from "@typespec/spec-api";
+
+export const Scenarios: Record<string, ScenarioMockApi> = {};
+
+function createQueryServerTests(
+  uri: string,
+  paramData: any,
+  format: "rfc7231" | "rfc3339" | undefined,
+  value: any,
+  collectionFormat?: CollectionFormat,
+) {
+  return passOnSuccess({
+    uri,
+    method: "get",
+    request: {
+      params: paramData,
+    },
+    response: {
+      status: 204,
+    },
+    handler(req: MockRequest) {
+      if (format) {
+        validateValueFormat(req.query["value"] as string, format);
+        if (Date.parse(req.query["value"] as string) !== Date.parse(value)) {
+          throw new ValidationError(`Wrong value`, value, req.query["value"]);
+        }
+      } else {
+        req.expect.containsQueryParam("value", value, collectionFormat);
+      }
+      return {
+        status: 204,
+      };
+    },
+    kind: "MockApiDefinition",
+  });
+}
+Scenarios.Encode_Datetime_Query_default = createQueryServerTests(
+  "/encode/datetime/query/default",
+  {
+    value: "2022-08-26T18:38:00.000Z",
+  },
+  "rfc3339",
+  "2022-08-26T18:38:00.000Z",
+);
+Scenarios.Encode_Datetime_Query_rfc3339 = createQueryServerTests(
+  "/encode/datetime/query/rfc3339",
+  {
+    value: "2022-08-26T18:38:00.000Z",
+  },
+  "rfc3339",
+  "2022-08-26T18:38:00.000Z",
+);
+Scenarios.Encode_Datetime_Query_rfc7231 = createQueryServerTests(
+  "/encode/datetime/query/rfc7231",
+  {
+    value: "Fri, 26 Aug 2022 14:38:00 GMT",
+  },
+  "rfc7231",
+  "Fri, 26 Aug 2022 14:38:00 GMT",
+);
+Scenarios.Encode_Datetime_Query_unixTimestamp = createQueryServerTests(
+  "/encode/datetime/query/unix-timestamp",
+  {
+    value: 1686566864,
+  },
+  undefined,
+  "1686566864",
+);
+Scenarios.Encode_Datetime_Query_unixTimestampArray = createQueryServerTests(
+  "/encode/datetime/query/unix-timestamp-array",
+  {
+    value: [1686566864, 1686734256].join(","),
+  },
+  undefined,
+  ["1686566864", "1686734256"],
+  "csv",
+);
+function createPropertyServerTests(
+  uri: string,
+  data: any,
+  format: "rfc7231" | "rfc3339" | undefined,
+  value: any,
+) {
+  return passOnSuccess({
+    uri,
+    method: "post",
+    request: {
+      body: data,
+    },
+    response: {
+      status: 200,
+    },
+    handler: (req: MockRequest) => {
+      if (format) {
+        validateValueFormat(req.body["value"], format);
+        if (Date.parse(req.body["value"]) !== Date.parse(value)) {
+          throw new ValidationError(`Wrong value`, value, req.body["value"]);
+        }
+      } else {
+        req.expect.coercedBodyEquals({ value: value });
+      }
+      return {
+        status: 200,
+        body: json({ value: value }),
+      };
+    },
+    kind: "MockApiDefinition",
+  });
+}
+Scenarios.Encode_Datetime_Property_default = createPropertyServerTests(
+  "/encode/datetime/property/default",
+  {
+    value: "2022-08-26T18:38:00.000Z",
+  },
+  "rfc3339",
+  "2022-08-26T18:38:00.000Z",
+);
+Scenarios.Encode_Datetime_Property_rfc3339 = createPropertyServerTests(
+  "/encode/datetime/property/rfc3339",
+  {
+    value: "2022-08-26T18:38:00.000Z",
+  },
+  "rfc3339",
+  "2022-08-26T18:38:00.000Z",
+);
+Scenarios.Encode_Datetime_Property_rfc7231 = createPropertyServerTests(
+  "/encode/datetime/property/rfc7231",
+  {
+    value: "Fri, 26 Aug 2022 14:38:00 GMT",
+  },
+  "rfc7231",
+  "Fri, 26 Aug 2022 14:38:00 GMT",
+);
+Scenarios.Encode_Datetime_Property_unixTimestamp = createPropertyServerTests(
+  "/encode/datetime/property/unix-timestamp",
+  {
+    value: 1686566864,
+  },
+  undefined,
+  1686566864,
+);
+Scenarios.Encode_Datetime_Property_unixTimestampArray = createPropertyServerTests(
+  "/encode/datetime/property/unix-timestamp-array",
+  {
+    value: [1686566864, 1686734256],
+  },
+  undefined,
+  [1686566864, 1686734256],
+);
+function createHeaderServerTests(
+  uri: string,
+  data: any,
+  format: "rfc7231" | "rfc3339" | undefined,
+  value: any,
+) {
+  return passOnSuccess({
+    uri,
+    method: "get",
+    request: {
+      headers: data,
+    },
+    response: {
+      status: 204,
+    },
+    handler(req: MockRequest) {
+      if (format) {
+        validateValueFormat(req.headers["value"], format);
+        if (Date.parse(req.headers["value"]) !== Date.parse(value)) {
+          throw new ValidationError(`Wrong value`, value, req.headers["value"]);
+        }
+      } else {
+        req.expect.containsHeader("value", value);
+      }
+      return {
+        status: 204,
+      };
+    },
+    kind: "MockApiDefinition",
+  });
+}
+Scenarios.Encode_Datetime_Header_default = createHeaderServerTests(
+  "/encode/datetime/header/default",
+  {
+    value: "Fri, 26 Aug 2022 14:38:00 GMT",
+  },
+  "rfc7231",
+  "Fri, 26 Aug 2022 14:38:00 GMT",
+);
+Scenarios.Encode_Datetime_Header_rfc3339 = createHeaderServerTests(
+  "/encode/datetime/header/rfc3339",
+  {
+    value: "2022-08-26T18:38:00.000Z",
+  },
+  "rfc3339",
+  "2022-08-26T18:38:00.000Z",
+);
+Scenarios.Encode_Datetime_Header_rfc7231 = createHeaderServerTests(
+  "/encode/datetime/header/rfc7231",
+  {
+    value: "Fri, 26 Aug 2022 14:38:00 GMT",
+  },
+  "rfc7231",
+  "Fri, 26 Aug 2022 14:38:00 GMT",
+);
+Scenarios.Encode_Datetime_Header_unixTimestamp = createHeaderServerTests(
+  "/encode/datetime/header/unix-timestamp",
+  {
+    value: 1686566864,
+  },
+  undefined,
+  "1686566864",
+);
+Scenarios.Encode_Datetime_Header_unixTimestampArray = createHeaderServerTests(
+  "/encode/datetime/header/unix-timestamp-array",
+  {
+    value: [1686566864, 1686734256].join(","),
+  },
+  undefined,
+  "1686566864,1686734256",
+);
+function createResponseHeaderServerTests(uri: string, data: any, value: any) {
+  return passOnSuccess({
+    uri,
+    method: "get",
+    request: {},
+    response: {
+      status: 204,
+      headers: data,
+    },
+    handler: (req: MockRequest) => {
+      return {
+        status: 204,
+        headers: { value: value },
+      };
+    },
+    kind: "MockApiDefinition",
+  });
+}
+Scenarios.Encode_Datetime_ResponseHeader_default = createResponseHeaderServerTests(
+  "/encode/datetime/responseheader/default",
+  {
+    value: "Fri, 26 Aug 2022 14:38:00 GMT",
+  },
+  "Fri, 26 Aug 2022 14:38:00 GMT",
+);
+Scenarios.Encode_Datetime_ResponseHeader_rfc3339 = createResponseHeaderServerTests(
+  "/encode/datetime/responseheader/rfc3339",
+  {
+    value: "2022-08-26T18:38:00.000Z",
+  },
+  "2022-08-26T18:38:00.000Z",
+);
+Scenarios.Encode_Datetime_ResponseHeader_rfc7231 = createResponseHeaderServerTests(
+  "/encode/datetime/responseheader/rfc7231",
+  {
+    value: "Fri, 26 Aug 2022 14:38:00 GMT",
+  },
+  "Fri, 26 Aug 2022 14:38:00 GMT",
+);
+Scenarios.Encode_Datetime_ResponseHeader_unixTimestamp = createResponseHeaderServerTests(
+  "/encode/datetime/responseheader/unix-timestamp",
+  {
+    value: "1686566864",
+  },
+  1686566864,
+);