Format rfc7231 map to rfc1123 (#4741)

Azure · May 26, 2023 · dca9fe8 · dca9fe8
1 parent 40378f1
commit dca9fe8
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 1 deletion.
diff --git a/common/changes/@autorest/modelerfour/feature-format-rfc7231-map_2023-05-25-22-08.json b/common/changes/@autorest/modelerfour/feature-format-rfc7231-map_2023-05-25-22-08.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@autorest/modelerfour",
+      "comment": "Map `rfc7231` to `rfc1123` for date-time formats",
+      "type": "patch"
+    }
+  ],
+  "packageName": "@autorest/modelerfour"
+}
diff --git a/common/changes/@azure-tools/openapi/feature-format-rfc7231-map_2023-05-25-22-08.json b/common/changes/@azure-tools/openapi/feature-format-rfc7231-map_2023-05-25-22-08.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@azure-tools/openapi",
+      "comment": "Add `rfc7231` format",
+      "type": "minor"
+    }
+  ],
+  "packageName": "@azure-tools/openapi"
+}
diff --git a/docs/openapi/formats.md b/docs/openapi/formats.md
@@ -19,6 +19,7 @@ Those formats can be used to specify a more accurate type of data that is sent a
 - `time`: A time as defined by ISO 8661
 - `date-time`: A Date-Time as defined by date-time - RFC3339
 - `date-time-rfc1123`: A Date-Time as defined by date-time - RFC1123
+- `date-time-rfc7231`: A Date-Time as defined by date-time - RFC7231
 - `duration`: A duration of time
 - `password`: A hint to UIs to obscure input.
 - `uuid`: Universally Unique Identifier

diff --git a/packages/extensions/modelerfour/src/modeler/interpretations.ts b/packages/extensions/modelerfour/src/modeler/interpretations.ts
@@ -123,6 +123,7 @@ export class Interpretations {
             return value;
 
           case StringFormat.DateTimeRfc1123:
+          case StringFormat.DateTimeRfc7231:
             // return this.parseDateTimeRfc1123Value(value);
             return value;
 

diff --git a/packages/extensions/modelerfour/src/modeler/modelerfour.ts b/packages/extensions/modelerfour/src/modeler/modelerfour.ts
@@ -504,7 +504,10 @@ export class ModelerFour {
         example: this.interpret.getExample(schema),
         externalDocs: this.interpret.getExternalDocs(schema),
         serialization: this.interpret.getSerialization(schema),
-        format: schema.format === StringFormat.DateTimeRfc1123 ? StringFormat.DateTimeRfc1123 : StringFormat.DateTime,
+        format:
+          schema.format === StringFormat.DateTimeRfc1123 || schema.format === StringFormat.DateTimeRfc7231
+            ? StringFormat.DateTimeRfc1123
+            : StringFormat.DateTime,
       }),
     );
   }

diff --git a/packages/libs/openapi/src/v3/formats.ts b/packages/libs/openapi/src/v3/formats.ts
@@ -30,6 +30,9 @@ export enum StringFormat {
   /** @description a A Date-Time as defined by date-time - RFC1123 */
   DateTimeRfc1123 = "date-time-rfc1123",
 
+  /** @description a A Date-Time as defined by date-time - RFC1123 */
+  DateTimeRfc7231 = "date-time-rfc7231",
+
   /** @description a duration of time (todo: RFC reference? ) */
   Duration = "duration",