feat!: use simplified bound action paths by default

CHANGELOG.md

@@ -8,11 +8,20 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
 ### Added
 ### Changed
-- Removed special characters from placeholders for fields like short text, description, etc.
 ### Deprecated
 ### Removed
+### Fixed
+### Security
+
+## [2.0.0] - tbd
+
+### Changed
+- **BREAKING**: Bound action paths now use simplified names by default (e.g., `.../Discount` instead of `.../ODataDemo.Discount`). To restore previous behavior, use `--openapi:fqActionPaths` or `{ 'openapi:fqActionPaths': true }`.
+- Removed special characters from placeholders for fields like short text, description, etc.
+
 ### Fixed
 - Autoexposed `.texts` entities are now excluded from OpenAPI document
+- Generate navigation paths to CRUD-disabled entities
 
 ### Security
 

lib/compile/csdl.js

@@ -54,9 +54,12 @@ class CSDLMeta {
     namespaceUrl = {}
     /** Map of vocabularies and terms */
     voc = {}
+    /** Options passed from caller */
+    options = {}
 
-    constructor(csdl) {
+    constructor(csdl, options = {}) {
         this.csdl = csdl;
+        this.options = options;
         this.#preProcess()
     }
 
@@ -93,7 +96,8 @@ class CSDLMeta {
                     element.filter(overload => overload.$IsBound).forEach(overload => {
                         const type = overload.$Parameter[0].$Type + (overload.$Parameter[0].$Collection ? '-c' : '');
                         if (!this.boundOverloads[type]) this.boundOverloads[type] = [];
-                        this.boundOverloads[type].push({ name: (isDefaultNamespace ? iName2 : qualifiedName), overload });
+                        const useFullyQualified = this.options?.fqActionPaths === true;
+                        this.boundOverloads[type].push({ name: (useFullyQualified && !isDefaultNamespace ? qualifiedName : iName2), overload });
                     });
                 } else if (element.$BaseType) {
                     const base = this.namespaceQualifiedName(element.$BaseType);

lib/compile/csdl2openapi.js

@@ -87,10 +87,10 @@
 /**
  * Construct an OpenAPI description from a CSDL document
  * @param {CSDL} csdl CSDL document
- * @param {{ url?: string, servers?: object, odataVersion?: string, scheme?: string, host?: string, basePath?: string, diagram?: boolean, maxLevels?: number }} options Optional parameters
+ * @param {{ url?: string, servers?: object, odataVersion?: string, scheme?: string, host?: string, basePath?: string, diagram?: boolean, maxLevels?: number, fqActionPaths?: boolean }} options Optional parameters
  * @return {object} OpenAPI description
  */
 module.exports.csdl2openapi = function (
     csdl,
     {
         url: serviceRoot,
@@ -100,14 +100,15 @@
         host: host = 'localhost',
         basePath: basePath = '/service-root',
         diagram: diagram = false,
-        maxLevels: maxLevels = 5
+        maxLevels: maxLevels = 5,
+        fqActionPaths: fqActionPaths = false
     } = {}
 ) {
     // as preProcess below mutates the csdl, copy it before, to avoid side-effects on the caller side
     csdl = JSON.parse(JSON.stringify(csdl))
     csdl.$Version = odataVersion ? odataVersion : '4.01'
-    const meta = new CSDLMeta(csdl)
+    const meta = new CSDLMeta(csdl, { fqActionPaths })
     serviceRoot = serviceRoot ?? (`${scheme}://${host}${basePath}`);
     const queryOptionPrefix = csdl.$Version <= '4.01' ? '$' : '';
     const typesToInline = {}; // filled in schema() and used in inlineTypes()
 
@@ -120,7 +121,7 @@
         Object.keys(entityContainer).forEach(element => {
             if (entityContainer[element].$Type) {
                 const fullTypeName = entityContainer[element].$Type;
                 const type = fullTypeName.startsWith(serviceName + '.')
                     ? fullTypeName.substring(serviceName.length + 1)
                     : nameParts(fullTypeName).name;
                 if ((csdl[serviceName]?.[type]?.['@cds.autoexpose'] || csdl[serviceName]?.[type]?.['@cds.autoexposed'])
@@ -406,7 +407,7 @@
             .replaceAll('_', ' ')
             .replace(/([a-z])([A-Z])/g, '$1 $2');  // "camelCase" to "camel Case"
         if (typeof tag === 'string') {
             tag = normalise(tag);
         } else {
             tag.name = normalise(tag.name);
         }
@@ -458,7 +459,7 @@
      * @param {number} level Number of navigation segments so far
      * @param {string} 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 = {};
@@ -540,7 +541,7 @@
      * @param {object} restrictions Navigation property restrictions of navigation segment
      * @param {array} nonExpandable Non-expandable navigation properties
      */
     function pathItemsWithKey(paths, prefix, prefixParameters, element, root, sourceName, targetName, target, level, navigationPath, restrictions, nonExpandable) {
         const targetIndexable = target == null || target[meta.voc.Capabilities.IndexableByKey] != false;
         if (restrictions.IndexableByKey == true || restrictions.IndexableByKey != false && targetIndexable) {
             const name = prefix.substring(prefix.lastIndexOf('/') + 1);
@@ -557,11 +558,12 @@
                     operationUpdate(pathItem, element, name, sourceName, target, level, restrictions, true);
                     operationDelete(pathItem, element, name, sourceName, target, level, restrictions, true);
                 }
-                if (Object.keys(pathItem).filter((i) => i !== "parameters").length === 0)
-                    delete paths[path];
 
                 pathItemsForBoundOperations(paths, path, parameters, element, sourceName, true);
                 pathItemsWithNavigation(paths, path, parameters, type, root, sourceName, level, navigationPath);
+
+                if (Object.keys(pathItem).filter((i) => i !== "parameters").length === 0)
+                    delete paths[path];
             }
         }
     }
@@ -577,7 +579,7 @@
      * @param {number} level Number of navigation segments so far
      * @param {object} restrictions Navigation property restrictions of navigation segment
      */
     function operationCreate(pathItem, element, name, sourceName, targetName, target, level, restrictions) {
         const insertRestrictions = restrictions.InsertRestrictions || target?.[meta.voc.Capabilities.InsertRestrictions] || {};
         const countRestrictions = target?.[meta.voc.Capabilities.CountRestrictions]?.Countable === false // count property will be added if CountRestrictions is false
         if (insertRestrictions.Insertable !== false) {
@@ -613,7 +615,7 @@
      * @param {boolean} byKey Access by key
      * @return Operation Text
      */
     function operationSummary(operation, name, sourceName, level, collection, byKey) {
         const lname = splitName(name);
         const sname = splitName(sourceName);
 
@@ -638,7 +640,7 @@
      * @param {boolean} byKey Read by key
      * @param {array} 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;