Fix: OData V2 Edm.Binary is base64-encoded in JSON payloads (#305)

* OData V2 Edm.Binary is base64-encoded -> `format: byte` in OpenAPI 3.0.x * Bump version to 0.26.1
oasis-tcs · Jul 9, 2024 · 603285a · 603285a
1 parent d00aabe
commit 603285a
Show file tree

Hide file tree

Showing 7 changed files with 156 additions and 84 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,12 @@
 # Changelog
 
-## 0.26.0 - 2024-01-12
+## 0.26.1 - 2024-07-09
+
+### Fixed
+
+- OData V2 type `Edm.Binary` is base64-encoded, not base64url
+
+## 0.26.0 - 2024-07-04
 
 ### Added
 

diff --git a/examples/Northwind-V3.openapi3.json b/examples/Northwind-V3.openapi3.json
@@ -10186,7 +10186,7 @@
                     },
                     "Picture": {
                         "type": "string",
-                        "format": "base64url",
+                        "format": "byte",
                         "nullable": true
                     },
                     "Products": {
@@ -10218,7 +10218,7 @@
                     },
                     "Picture": {
                         "type": "string",
-                        "format": "base64url",
+                        "format": "byte",
                         "nullable": true
                     }
                 },
@@ -10240,7 +10240,7 @@
                     },
                     "Picture": {
                         "type": "string",
-                        "format": "base64url",
+                        "format": "byte",
                         "nullable": true
                     }
                 }
@@ -10739,7 +10739,7 @@
                     },
                     "Photo": {
                         "type": "string",
-                        "format": "base64url",
+                        "format": "byte",
                         "nullable": true
                     },
                     "Notes": {
@@ -10868,7 +10868,7 @@
                     },
                     "Photo": {
                         "type": "string",
-                        "format": "base64url",
+                        "format": "byte",
                         "nullable": true
                     },
                     "Notes": {
@@ -10961,7 +10961,7 @@
                     },
                     "Photo": {
                         "type": "string",
-                        "format": "base64url",
+                        "format": "byte",
                         "nullable": true
                     },
                     "Notes": {

diff --git a/lib/csdl2openapi.js b/lib/csdl2openapi.js
@@ -2479,8 +2479,14 @@ module.exports.csdl2openapi = function (
         break;
       case "Edm.Binary":
         s = oas31
-          ? { type: "string", contentEncoding: "base64url" }
-          : { type: "string", format: "base64url" };
+          ? {
+              type: "string",
+              contentEncoding: csdl.$Version < "4.0" ? "base64" : "base64url",
+            }
+          : {
+              type: "string",
+              format: csdl.$Version < "4.0" ? "byte" : "base64url",
+            };
         if (element.$MaxLength)
           s.maxLength = Math.ceil((4 * element.$MaxLength) / 3);
         break;

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "odata-openapi",
-  "version": "0.26.0",
+  "version": "0.26.1",
   "description": "Convert OData CSDL XML or CSDL JSON to OpenAPI",
   "homepage": "https://github.com/oasis-tcs/odata-openapi/blob/master/lib/README.md",
   "bugs": "https://github.com/oasis-tcs/odata-openapi/issues",

diff --git a/test/csdl2openapi.test.js b/test/csdl2openapi.test.js
@@ -15,7 +15,7 @@ const assert = require("assert");
 // (external) annotations on actions, functions, parameters, return types
 // control mapping of reference URLs
 
-const { paths, operations } = require("./utilities");
+const { paths, operations, schemas } = require("./utilities");
 
 const { csdl2openapi } = require("odata-openapi");
 
@@ -1709,6 +1709,137 @@ describe("Edge cases", function () {
     );
   });
 
+  it("OData V2 Edm.Binary, Edm.DateTime, and Edm.Time", function () {
+    const csdl = {
+      $Version: "2.0",
+      $EntityContainer: "this.Container",
+      this: {
+        Container: {
+          fi: {
+            $Function: "this.f",
+          },
+        },
+        f: [
+          {
+            $Kind: "Function",
+            $Parameter: [],
+            $ReturnType: { $Type: "this.ct" },
+          },
+        ],
+        ct: {
+          $Kind: "ComplexType",
+          bin: { $Type: "Edm.Binary" },
+          date: { $Type: "Edm.DateTime" },
+          time: { $Type: "Edm.Time" },
+          timeWithMilliSeconds: { $Type: "Edm.Time", $Precision: 3 },
+        },
+      },
+    };
+    const expected = {
+      paths: {
+        "/$batch": { post: {} },
+        "/fi": { get: {} },
+      },
+      components: {
+        schemas: {
+          "this.ct": {
+            type: "object",
+            title: "ct",
+            properties: {
+              bin: { type: "string", format: "byte" },
+              date: {
+                type: "string",
+                example: "/Date(1492098664000)/",
+              },
+              time: {
+                type: "string",
+                example: "PT15H51M04S",
+              },
+              timeWithMilliSeconds: {
+                type: "string",
+                example: "PT15H51M04.000S",
+              },
+            },
+          },
+        },
+      },
+    };
+    const messages = [];
+
+    const actual = csdl2openapi(csdl, { messages });
+    assert.deepStrictEqual(paths(actual), paths(expected), "Paths");
+    assert.deepStrictEqual(
+      operations(actual),
+      operations(expected),
+      "Operations",
+    );
+    assert.deepStrictEqual(schemas(actual), schemas(expected), "Schemas");
+    assert.deepStrictEqual(
+      actual.components.schemas["this.ct"],
+      expected.components.schemas["this.ct"],
+      "this.ct",
+    );
+    assert.deepStrictEqual(messages, [], "messages");
+  });
+
+  it("OData V2 Edm.Binary in OpenAPI 3.1.0", function () {
+    const csdl = {
+      $Version: "2.0",
+      $EntityContainer: "this.Container",
+      this: {
+        Container: {
+          fi: {
+            $Function: "this.f",
+          },
+        },
+        f: [
+          {
+            $Kind: "Function",
+            $Parameter: [],
+            $ReturnType: { $Type: "this.ct" },
+          },
+        ],
+        ct: {
+          $Kind: "ComplexType",
+          bin: { $Type: "Edm.Binary" },
+        },
+      },
+    };
+    const expected = {
+      paths: {
+        "/$batch": { post: {} },
+        "/fi": { get: {} },
+      },
+      components: {
+        schemas: {
+          "this.ct": {
+            type: "object",
+            title: "ct",
+            properties: {
+              bin: { type: "string", contentEncoding: "base64" },
+            },
+          },
+        },
+      },
+    };
+    const messages = [];
+
+    const actual = csdl2openapi(csdl, { messages, openapiVersion: "3.1.0" });
+    assert.deepStrictEqual(paths(actual), paths(expected), "Paths");
+    assert.deepStrictEqual(
+      operations(actual),
+      operations(expected),
+      "Operations",
+    );
+    assert.deepStrictEqual(schemas(actual), schemas(expected), "Schemas");
+    assert.deepStrictEqual(
+      actual.components.schemas["this.ct"],
+      expected.components.schemas["this.ct"],
+      "this.ct",
+    );
+    assert.deepStrictEqual(messages, [], "messages");
+  });
+
   it("OpenAPI 3.1.0", function () {
     const csdl = {
       $Reference: {

diff --git a/test/funnyInput.test.js b/test/funnyInput.test.js
@@ -177,75 +177,4 @@ describe("Funny input", function () {
       "messages",
     );
   });
-
-  it("OData V2 Edm.DateTime and Edm.Time", function () {
-    const csdl = {
-      $Version: "2.0",
-      $EntityContainer: "this.Container",
-      this: {
-        Container: {
-          fi: {
-            $Function: "this.f",
-          },
-        },
-        f: [
-          {
-            $Kind: "Function",
-            $Parameter: [],
-            $ReturnType: { $Type: "this.ct" },
-          },
-        ],
-        ct: {
-          $Kind: "ComplexType",
-          date: { $Type: "Edm.DateTime" },
-          time: { $Type: "Edm.Time" },
-          timeWithMilliSeconds: { $Type: "Edm.Time", $Precision: 3 },
-        },
-      },
-    };
-    const expected = {
-      paths: {
-        "/$batch": { post: {} },
-        "/fi": { get: {} },
-      },
-      components: {
-        schemas: {
-          "this.ct": {
-            type: "object",
-            title: "ct",
-            properties: {
-              date: {
-                type: "string",
-                example: "/Date(1492098664000)/",
-              },
-              time: {
-                type: "string",
-                example: "PT15H51M04S",
-              },
-              timeWithMilliSeconds: {
-                type: "string",
-                example: "PT15H51M04.000S",
-              },
-            },
-          },
-        },
-      },
-    };
-    const messages = [];
-
-    const actual = csdl2openapi(csdl, { messages });
-    assert.deepStrictEqual(paths(actual), paths(expected), "Paths");
-    assert.deepStrictEqual(
-      operations(actual),
-      operations(expected),
-      "Operations",
-    );
-    assert.deepStrictEqual(schemas(actual), schemas(expected), "Schemas");
-    assert.deepStrictEqual(
-      actual.components.schemas["this.ct"],
-      expected.components.schemas["this.ct"],
-      "this.ct",
-    );
-    assert.deepStrictEqual(messages, [], "messages");
-  });
 });