fix: Remove top-level paths for code lists

CHANGELOG.md

@@ -15,6 +15,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 ### Removed
 ### Fixed
 - Entities that are transitively autoexposed and should still be considered readonly, do not generate documentation for write endpoints anymore
+- Implicitly auto-exposed composition targets (annotated `@cds.autoexposed` by the CDS compiler) no longer generate top-level GET paths that CAP would reject with 405
 - OpenAPI compilation is now pure: the input CSN is no longer mutated during compilation
 ### Security
 

lib/compile/csdl2openapi.js

@@ -90,7 +90,7 @@
  * @param {{ url?: string, servers?: object, odataVersion?: string, scheme?: string, host?: string, basePath?: string, diagram?: boolean, maxLevels?: number, shortActionPaths?: boolean }} options Optional parameters
  * @return {*} OpenAPI description
  */
 module.exports.csdl2openapi = function (
     csdl,
     {
         url: serviceRoot,
@@ -125,9 +125,13 @@
                 const type = fullTypeName.startsWith(`${serviceName}.`)
                     ? fullTypeName.substring(serviceName.length + 1)
                     : nameParts(fullTypeName).name;
-                if (csdl[serviceName]?.[type]?.['@cds.autoexpose'] || csdl[serviceName]?.[type]?.['@cds.autoexposed']) {
+                const serviceType = csdl[serviceName]?.[type]
+                if (serviceType?.['@cds.autoexpose'] || serviceType?.['@cds.autoexposed']) {
                     entityContainer[element]['$cds.autoexpose'] = true;
                 }
+                if (serviceType?.['@cds.autoexposed'] && !serviceType?.['@cds.autoexpose']) {
+                    entityContainer[element]['$cds.autoexposed'] = true;
+                }
             }
         });
     }
@@ -380,7 +384,7 @@
         Object.keys(container)
             .filter(name => isIdentifier(name) && container[name].$Type)
             .forEach(child => {
-                if (child.endsWith('_texts') && container[child]['$cds.autoexpose']) {
+                if (container[child]['$cds.autoexposed']) {
                     return;
                 }
                 const type = meta.modelElement(container[child].$Type) || {};
@@ -425,7 +429,7 @@
         const resources = Object.keys(container).filter(name => isIdentifier(name));
         resources.forEach(name => {
             const child = container[name];
-            if (name.endsWith('_texts') && child['$cds.autoexpose']) {
+            if (child['$cds.autoexposed']) {
                 return;
             }
             if (child.$Type) {
@@ -471,7 +475,7 @@
      * @param {number} options.level Number of navigation segments so far
      * @param {string} options.navigationPath Path for finding navigation restrictions
      */
     function pathItems({ paths, prefix, prefixParameters, element, root, sourceName, targetName, target, level, navigationPath }) {
         const name = prefix.substring(prefix.lastIndexOf('/') + 1);
         const type = meta.modelElement(element.$Type);
         const pathItem = {};
@@ -749,7 +753,7 @@
      * @param {boolean} options.byKey Read by key
      * @param {array} options.nonExpandable Non-expandable navigation properties
      */
     function operationRead({ pathItem, element, name, sourceName, targetName, target, level, restrictions, byKey, nonExpandable }) {
         const targetRestrictions = target?.[meta.voc.Capabilities.ReadRestrictions];
         const readRestrictions = restrictions.ReadRestrictions || targetRestrictions || {};
         const readByKeyRestrictions = readRestrictions.ReadByKeyRestrictions;
@@ -1219,7 +1223,7 @@
      * @param {*} options.restrictions Navigation property restrictions of navigation segment
      * @param {boolean} [options.byKey=false] Update by key
      */
     function operationUpdate({ pathItem, element, name, sourceName, target, level, restrictions, byKey = false }) {
         const updateRestrictions = restrictions.UpdateRestrictions || target?.[meta.voc.Capabilities.UpdateRestrictions] || {};
         const countRestrictions = target?.[meta.voc.Capabilities.CountRestrictions]?.Countable === false;
         if (updateRestrictions.Updatable !== false && !element[meta.voc.Core.Immutable]) {
@@ -1310,7 +1314,7 @@
      */
     function pathItemsForMediaStream({ paths, prefix, prefixParameters, type, name, sourceName }) {
         if (type.$HasStream) {
             const mediaTypes = type[meta.voc.Core.AcceptableMediaTypes]?.map(t => t['$EnumMember'] ?? t) ?? [];
             const contentTypes = mediaTypes.length > 0 ? mediaTypes : ['*/*'];
             const mediaContent = Object.fromEntries(contentTypes.map(ct => [ct, { schema: { type: 'string', format: 'binary' } }]));
             const lname = splitName(name);
@@ -1640,7 +1644,7 @@
      * @param {string} options.sourceName Name of path source
      * @param {*} [options.actionImport={}] Action import
      */
     function pathItemAction({ paths, prefix, prefixParameters, actionName, overload, sourceName, actionImport = {} }) {
         const name = actionName.indexOf('.') === -1 ? actionName : nameParts(actionName).name;
         const pathItem = {
             post: {
@@ -1730,7 +1734,7 @@
      * @param {string} options.sourceName Name of path source
      * @param {*} [options.functionImport={}] Function Import
      */
     function pathItemFunction({ paths, prefix, prefixParameters, functionName, overload, sourceName, functionImport = {} }) {
         const name = functionName.indexOf('.') === -1 ? functionName : nameParts(functionName).name;
         let parameters = overload.$Parameter || [];
         if (overload.$IsBound) parameters = parameters.slice(1);
@@ -1739,7 +1743,7 @@
 
         const implicitAliases = csdl.$Version > '4.0' || parameters.some(p => p[meta.voc.Core.OptionalParameter]);
 
         parameters.forEach(p => {
             const description = getDescriptionWithFallback(p);
             /** @type {Parameter} */
             const param = {
@@ -2119,7 +2123,7 @@
      * @param {string} options.suffix Suffix for read/create/update
      * @return {*} Map of Schemas Objects
      */
     function schemasForStructuredType({ schemas, qualifier, name, type, suffix }) {
         const schemaName = `${qualifier}.${name}${suffix}`;
         const baseName = `${qualifier}.${name}`;
         const isKey = keyMap(type);
@@ -2135,7 +2139,7 @@
         const properties = propertiesOfStructuredType(type);
         const expandRestrictions = type[meta.voc.Capabilities.ExpandRestrictions] ?? {};
         const nonExpandableProperties = expandRestrictions.NonExpandableProperties ?? [];
         Object.keys(properties).forEach(iName => {
             if (nonExpandableProperties.includes(iName)) {
                 return;
             }

test/lib/compile/csdl2openapi.test.js

@@ -52,6 +52,12 @@ const result12 = require("./data/autoexposed-texts.openapi3.json");
 const example13 = require("./data/autoexposed-direct.json");
 const result13 = require("./data/autoexposed-direct.openapi3.json");
 
+const example14 = require("./data/autoexposed-composition.json");
+const result14 = require("./data/autoexposed-composition.openapi3.json");
+
+const example15 = require("./data/autoexposed-codelist.json");
+const result15 = require("./data/autoexposed-codelist.openapi3.json");
+
 describe("Examples", () => {
   test("csdl-16.1", () => {
     const openapi = lib.csdl2openapi(example1, { diagram: true });
@@ -108,9 +114,19 @@ describe("Examples", () => {
   });
 
   test("autoexposed-direct", () => {
-    const openapi = lib.csdl2openapi(example13, { url: "https://localhost/service-root" });
+    const openapi = lib.csdl2openapi(example13);
     check(openapi, result13);
   });
+
+  test("autoexposed-composition", () => {
+    const openapi = lib.csdl2openapi(example14);
+    check(openapi, result14);
+  });
+
+  test("autoexposed-codelist", () => {
+    const openapi = lib.csdl2openapi(example15);
+    check(openapi, result15);
+  });
 });
 
 describe("Edge cases", () => {

test/lib/compile/data/autoexposed-codelist.json

@@ -0,0 +1,47 @@
+{
+  "$Version": "4.01",
+  "$EntityContainer": "MyService.EntityContainer",
+  "$Reference": {},
+  "MyService": {
+    "$Kind": "Schema",
+    "EntityContainer": {
+      "$Kind": "EntityContainer",
+      "Orders": {
+        "$Collection": true,
+        "$Type": "MyService.Orders",
+        "$NavigationPropertyBinding": {
+          "currency": "Currencies"
+        }
+      },
+      "Currencies": {
+        "$Collection": true,
+        "$Type": "MyService.Currencies"
+      }
+    },
+    "Orders": {
+      "$Kind": "EntityType",
+      "$Key": ["ID"],
+      "ID": {
+        "$Type": "Edm.Int32"
+      },
+      "currency": {
+        "$Kind": "NavigationProperty",
+        "$Type": "MyService.Currencies",
+        "$Nullable": true
+      }
+    },
+    "Currencies": {
+      "$Kind": "EntityType",
+      "$Key": ["code"],
+      "@cds.autoexpose": true,
+      "@cds.autoexposed": true,
+      "code": {
+        "$MaxLength": 3
+      },
+      "name": {
+        "$Nullable": true,
+        "$MaxLength": 255
+      }
+    }
+  }
+}