@sap/cds-dk 4.8.2 → 4.9.0

package/lib/compile/openapi/csdl2openapi.js

@@ -24,52 +24,52 @@ var pluralize = require('pluralize')
 
 /**
  * Construct an OpenAPI description from a CSDL document
- * @param {object} pCsdl CSDL document
+ * @param {object} csdl CSDL document
  * @param {object} options Optional parameters
  * @return {object} OpenAPI description
  */
 module.exports.csdl2openapi = function (
-    pCsdl,
+    csdl,
     {
-        url: gServiceRoot,
-        scheme: pScheme = 'https',
-        host: pHost = 'localhost',
-        basePath: pBasePath = '/service-root',
-        diagram: pDiagram = false,
-        maxLevels: pMaxLevels = 5
+        url: serviceRoot,
+        scheme: scheme = 'https',
+        host: host = 'localhost',
+        basePath: basePath = '/service-root',
+        diagram: diagram = false,
+        maxLevels: maxLevels = 5
     } = {}
 ) {
-    gServiceRoot = gServiceRoot || (pScheme + '://' + pHost + pBasePath);
-    const gQueryOptionPrefix = pCsdl.$Version <= '4.0' ? '$' : '';
-    const gTypesToInline = {}; // filled in schema() and used in inlineTypes()
-    const gBoundOverloads = {};
-    const gDerivedTypes = {};
-    const gAlias = {};
-    const gNamespace = { 'Edm': 'Edm' };
-    const gNamespaceUrl = {};
-    const gVoc = {};
-    preProcess(pCsdl, gBoundOverloads, gDerivedTypes, gAlias, gNamespace, gNamespaceUrl, gVoc);
-
-    const gEntityContainer = pCsdl.$EntityContainer ? modelElement(pCsdl.$EntityContainer) : {};
-    const gKeyAsSegment = gEntityContainer[gVoc.Capabilities.KeyAsSegmentSupported];
-    const gDeepUpdate = gEntityContainer[gVoc.Capabilities.DeepUpdateSupport] && gEntityContainer[gVoc.Capabilities.DeepUpdateSupport].Supported;
-
-    const gOpenapi = {
+    serviceRoot = serviceRoot || (scheme + '://' + host + basePath);
+    const queryOptionPrefix = csdl.$Version <= '4.0' ? '$' : '';
+    const typesToInline = {}; // filled in schema() and used in inlineTypes()
+    const boundOverloads = {};
+    const derivedTypes = {};
+    const alias = {};
+    const namespace = { 'Edm': 'Edm' };
+    const namespaceUrl = {};
+    const voc = {};
+    preProcess(csdl, boundOverloads, derivedTypes, alias, namespace, namespaceUrl, voc);
+
+    const entityContainer = csdl.$EntityContainer ? modelElement(csdl.$EntityContainer) : {};
+    const keyAsSegment = entityContainer[voc.Capabilities.KeyAsSegmentSupported];
+    const deepUpdate = entityContainer[voc.Capabilities.DeepUpdateSupport] && entityContainer[voc.Capabilities.DeepUpdateSupport].Supported;
+
+    const openapi = {
         openapi: '3.0.2',
-        info: getInfo(pCsdl, gEntityContainer),
-        servers: getServers(gServiceRoot),
-        tags: getTags(gEntityContainer),
-        paths: getPaths(gEntityContainer),
-        components: getComponents(pCsdl, gEntityContainer)
+        info: getInfo(csdl, entityContainer),
+        servers: getServers(serviceRoot),
+        tags: getTags(entityContainer),
+        paths: getPaths(entityContainer),
+        components: getComponents(csdl, entityContainer)
     };
-    if (!pCsdl.$EntityContainer) {
-        delete gOpenapi.servers;
-        delete gOpenapi.tags;
+    if (!csdl.$EntityContainer) {
+        delete openapi.servers;
+        delete openapi.tags;
     }
 
-    security(gOpenapi, gEntityContainer);
+    security(openapi, entityContainer);
 
-    return gOpenapi;
+    return openapi;
 
 
     /**
@@ -134,7 +134,7 @@ module.exports.csdl2openapi = function (
                     element = element.find(overload =>
                         overload.$Kind == 'Action' && overload.$IsBound != true && args == ''
                         || overload.$Kind == 'Action' && args == (overload.$Parameter[0].$Type || '')
-                        || (overload.$Parameter || []).map(p => p.$Type || 'Edm.String').join(',') == args);
+                        || (overload.$Parameter || []).map(p => { const type = p.$Type || 'Edm.String'; return p.$Collection ? `Collection(${type})` : type }).join(',') == args);
                 }
                 if (!element) {
                     // console.warn(`Invalid annotation target '${target}'`)
@@ -195,29 +195,33 @@ module.exports.csdl2openapi = function (
                 voc[vocab][term] = '@' + alias['Org.OData.' + vocab + '.V1'] + '.' + term;
             });
         });
+
+        voc.Common = {
+            Label: `@${alias['com.sap.vocabularies.Common.v1']}.Label`
+        }
     }
 
     /**
      * Construct the Info Object
      * @param {object} csdl CSDL document
-     * @param {object} pEntityContainer Entity Container object
+     * @param {object} entityContainer Entity Container object
      * @return {object} Info Object
      */
-    function getInfo(csdl, pEntityContainer) {
+    function getInfo(csdl, entityContainer) {
         const namespace = csdl.$EntityContainer ? nameParts(csdl.$EntityContainer).qualifier : null;
         const containerSchema = csdl.$EntityContainer ? csdl[namespace] : {};
         const description = (
-            pEntityContainer[gVoc.Core.LongDescription]
-            || containerSchema[gVoc.Core.LongDescription]
-            || 'This service is located at [' + gServiceRoot + '/]('
-            + gServiceRoot.replace(/\(/g, '%28').replace(/\)/g, '%29') + '/)'
-        ) + (pDiagram ? getResourceDiagram(csdl, pEntityContainer) : '');
+            entityContainer[voc.Core.LongDescription]
+            || containerSchema[voc.Core.LongDescription]
+            || 'This service is located at [' + serviceRoot + '/]('
+            + serviceRoot.replace(/\(/g, '%28').replace(/\)/g, '%29') + '/)'
+        ) + (diagram ? getResourceDiagram(csdl, entityContainer) : '');
         return {
-            title: pEntityContainer[gVoc.Core.Description]
-                || containerSchema[gVoc.Core.Description]
+            title: entityContainer[voc.Core.Description]
+                || containerSchema[voc.Core.Description]
                 || (csdl.$EntityContainer ? 'Service for namespace ' + namespace : 'OData CSDL document'),
             description: csdl.$EntityContainer ? description : '',
-            version: containerSchema[gVoc.Core.SchemaVersion] || ''
+            version: containerSchema[voc.Core.SchemaVersion] || ''
         };
     }
 
@@ -277,14 +281,7 @@ module.exports.csdl2openapi = function (
                     diagram += comma
                         + '[' + name + color.resource + ']';
                     const overload = modelElement(resource.$Action).find(pOverload => !pOverload.$IsBound);
-                    if (overload.$ReturnType) {
-                        const type = modelElement(overload.$ReturnType.$Type || 'Edm.String');
-                        if (type) {
-                            diagram += '-'
-                                + cardinality(overload.$ReturnType)
-                                + '>[' + nameParts(overload.$ReturnType.$Type).name + ']';
-                        }
-                    }
+                    diagram += overloadDiagram(name, overload);
                 } else if (resource.$Function) {
                     diagram += comma
                         + '[' + name + color.resource + ']';
@@ -292,13 +289,7 @@ module.exports.csdl2openapi = function (
                     if (overloads) {
                         const unbound = overloads.filter(overload => !overload.$IsBound);
                         // TODO: loop over all overloads, add new source box after first arrow
-                        const iOverload = unbound[0];
-                        const type = modelElement(iOverload.$ReturnType.$Type || 'Edm.String');
-                        if (type) {
-                            diagram += '-'
-                                + cardinality(iOverload.$ReturnType)
-                                + '>[' + nameParts(iOverload.$ReturnType.$Type).name + ']';
-                        }
+                        diagram += overloadDiagram(name, unbound[0]);
                     }
                 }
             }
@@ -322,6 +313,29 @@ module.exports.csdl2openapi = function (
         function cardinality(typedElement) {
             return typedElement.$Collection ? '*' : (typedElement.$Nullable ? '0..1' : '');
         }
+
+        /**
+         * Diagram representation of action or function overload
+         * @param {string} name Name of action or function import
+         * @param {object} overload Action or function overload
+         * @return {string} diagram part
+         */
+        function overloadDiagram(name, overload) {
+            let diag = "";
+            if (overload.$ReturnType) {
+                const type = modelElement(overload.$ReturnType.$Type || "Edm.String");
+                if (type) {
+                    diag += "-" + cardinality(overload.$ReturnType) + ">[" + nameParts(overload.$ReturnType.$Type).name + "]";
+                }
+            }
+            for (const param of overload.$Parameter || []) {
+                const type = modelElement(param.$Type || "Edm.String");
+                if (type) {
+                    diag += comma + "[" + name + color.resource + "]in-" + cardinality(param.$Type) + ">[" + nameParts(param.$Type).name + "]";
+                }
+            }
+            return diag;
+        }
     }
 
     /**
@@ -331,7 +345,7 @@ module.exports.csdl2openapi = function (
      */
     function modelElement(qname) {
         const q = nameParts(qname);
-        const schema = pCsdl[q.qualifier] || pCsdl[gNamespace[q.qualifier]];
+        const schema = csdl[q.qualifier] || csdl[namespace[q.qualifier]];
         return schema ? schema[q.name] : null;
     }
 
@@ -354,10 +368,11 @@ module.exports.csdl2openapi = function (
         const tags = [];
         // all entity sets and singletons
         Object.keys(container).filter(name => isIdentifier(name) && container[name].$Type).forEach(child => {
-            const tag = { name: child };
-            const type = modelElement(container[child].$Type);
-            const description = container[child][gVoc.Core.Description]
-                || type && type[gVoc.Core.Description];
+            const type = modelElement(container[child].$Type) || {};
+            const tag = {
+                name: type[voc.Common.Label] || child
+            };
+            const description = container[child][voc.Core.Description] || type[voc.Core.Description];
             if (description) tag.description = description;
             tags.push(tag);
         })
@@ -375,9 +390,11 @@ module.exports.csdl2openapi = function (
         resources.forEach(name => {
             let child = container[name];
             if (child.$Type) {
+                const type = modelElement(child.$Type);
+                const sourceName = (type && type[voc.Common.Label]) || name;
                 // entity sets and singletons are almost containment navigation properties
                 child.$ContainsTarget = true;
-                pathItems(paths, '/' + name, [], child, child, name, name, child, 0, '');
+                pathItems(paths, '/' + name, [], child, child, sourceName, sourceName, child, 0, '');
             } else if (child.$Action) {
                 pathItemActionImport(paths, name, child);
             } else if (child.$Function) {
@@ -421,7 +438,7 @@ module.exports.csdl2openapi = function (
 
         if (element.$ContainsTarget) {
             if (element.$Collection) {
-                if (level < pMaxLevels)
+                if (level < maxLevels)
                     pathItemsWithKey(paths, prefix, prefixParameters, element, root, sourceName, targetName, target, level, navigationPath, restrictions, nonExpandable);
             } else {
                 operationUpdate(pathItem, element, name, sourceName, target, level, restrictions);
@@ -441,7 +458,7 @@ module.exports.csdl2openapi = function (
      * @return Navigation property restrictions of navigation segment
      */
     function navigationPropertyRestrictions(root, navigationPath) {
-        const navigationRestrictions = root[gVoc.Capabilities.NavigationRestrictions] || {};
+        const navigationRestrictions = root[voc.Capabilities.NavigationRestrictions] || {};
         return (navigationRestrictions.RestrictedProperties || []).find(item => navigationPropertyPath(item.NavigationProperty) == navigationPath)
             || {};
     }
@@ -453,7 +470,7 @@ module.exports.csdl2openapi = function (
      * @return Navigation property restrictions of navigation segment
      */
     function nonExpandableProperties(root, navigationPath) {
-        const expandRestrictions = root[gVoc.Capabilities.ExpandRestrictions] || {};
+        const expandRestrictions = root[voc.Capabilities.ExpandRestrictions] || {};
         const prefix = navigationPath.length === 0 ? '' : navigationPath + '/'
         const from = prefix.length
         const nonExpandable = []
@@ -481,7 +498,7 @@ module.exports.csdl2openapi = function (
      * @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[gVoc.Capabilities.IndexableByKey] != false;
+        const targetIndexable = target == null || target[voc.Capabilities.IndexableByKey] != false;
         if (restrictions.IndexableByKey == true || restrictions.IndexableByKey != false && targetIndexable) {
             const name = prefix.substring(prefix.lastIndexOf('/') + 1);
             const type = modelElement(element.$Type);
@@ -514,7 +531,7 @@ module.exports.csdl2openapi = function (
      * @param {object} restrictions Navigation property restrictions of navigation segment
      */
     function operationCreate(pathItem, element, name, sourceName, targetName, target, level, restrictions) {
-        const insertRestrictions = restrictions.InsertRestrictions || target && target[gVoc.Capabilities.InsertRestrictions] || {};
+        const insertRestrictions = restrictions.InsertRestrictions || target && target[voc.Capabilities.InsertRestrictions] || {};
 
         if (insertRestrictions.Insertable !== false) {
             const lname = pluralize.singular(splitName(name));
@@ -523,7 +540,7 @@ module.exports.csdl2openapi = function (
                 summary: insertRestrictions.Description || operationSummary('Create', name, sourceName, level, true, true),
                 tags: [sourceName],
                 requestBody: {
-                    description: type && type[gVoc.Core.Description] || 'New ' + lname,
+                    description: type && type[voc.Core.Description] || 'New ' + lname,
                     required: true,
                     content: {
                         'application/json': {
@@ -583,7 +600,7 @@ module.exports.csdl2openapi = function (
      * @param {array} nonExpandable Non-expandable navigation properties
      */
     function operationRead(pathItem, element, name, sourceName, targetName, target, level, restrictions, byKey, nonExpandable) {
-        const targetRestrictions = target && target[gVoc.Capabilities.ReadRestrictions];
+        const targetRestrictions = target && target[voc.Capabilities.ReadRestrictions];
         const readRestrictions = restrictions.ReadRestrictions || targetRestrictions || {};
         const readByKeyRestrictions = readRestrictions.ReadByKeyRestrictions;
         let readable = true;
@@ -603,11 +620,11 @@ module.exports.csdl2openapi = function (
                 parameters: [],
                 responses: response(200, 'Retrieved ' + (byKey ? pluralize.singular(lname) : lname), { $Type: element.$Type, $Collection: collection })
             };
-            const deltaSupported = element[gVoc.Capabilities.ChangeTracking] && element[gVoc.Capabilities.ChangeTracking].Supported;
+            const deltaSupported = element[voc.Capabilities.ChangeTracking] && element[voc.Capabilities.ChangeTracking].Supported;
             if (!byKey && deltaSupported) {
                 operation.responses[200].content['application/json'].schema.properties['@odata.deltaLink'] = {
                     type: 'string',
-                    example: pBasePath + '/' + name + '?$deltatoken=opaque server-generated token for fetching the delta'
+                    example: basePath + '/' + name + '?$deltatoken=opaque server-generated token for fetching the delta'
                 }
             }
             if (descriptions.LongDescription) operation.description = descriptions.LongDescription;
@@ -616,7 +633,7 @@ module.exports.csdl2openapi = function (
             if (collection) {
                 optionTop(operation.parameters, target, restrictions);
                 optionSkip(operation.parameters, target, restrictions);
-                if (pCsdl.$Version >= '4.0') optionSearch(operation.parameters, target, restrictions);
+                if (csdl.$Version >= '4.0') optionSearch(operation.parameters, target, restrictions);
                 optionFilter(operation.parameters, target, restrictions);
                 optionCount(operation.parameters, target);
                 optionOrderBy(operation.parameters, element, target, restrictions);
@@ -635,7 +652,7 @@ module.exports.csdl2openapi = function (
      * @param {string} target Target container child of path
      */
     function optionCount(parameters, target) {
-        const targetRestrictions = target && target[gVoc.Capabilities.CountRestrictions];
+        const targetRestrictions = target && target[voc.Capabilities.CountRestrictions];
         const targetCountable = target == null
             || targetRestrictions == null
             || targetRestrictions.Countable !== false;
@@ -656,14 +673,14 @@ module.exports.csdl2openapi = function (
      * @param {array} nonExpandable Non-expandable navigation properties
      */
     function optionExpand(parameters, element, target, nonExpandable) {
-        const targetRestrictions = target && target[gVoc.Capabilities.ExpandRestrictions];
+        const targetRestrictions = target && target[voc.Capabilities.ExpandRestrictions];
         const supported = targetRestrictions == null || targetRestrictions.Expandable != false;
         if (supported) {
             const expandItems = ['*'].concat(navigationPaths(element).filter(path => !nonExpandable.includes(path)));
             if (expandItems.length > 1) {
                 parameters.push({
-                    name: gQueryOptionPrefix + 'expand',
-                    description: (targetRestrictions && targetRestrictions[gVoc.Core.Description])
+                    name: queryOptionPrefix + 'expand',
+                    description: (targetRestrictions && targetRestrictions[voc.Core.Description])
                         || 'Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)',
                     in: 'query',
                     explode: false,
@@ -694,7 +711,7 @@ module.exports.csdl2openapi = function (
         Object.keys(properties).forEach(key => {
             if (properties[key].$Kind == 'NavigationProperty') {
                 paths.push(prefix + key)
-            } else if (properties[key].$Type && level < pMaxLevels) {
+            } else if (properties[key].$Type && level < maxLevels) {
                 paths.push(...navigationPaths(properties[key], prefix + key + '/', level + 1));
             }
         })
@@ -708,12 +725,12 @@ module.exports.csdl2openapi = function (
      * @param {object} restrictions Navigation property restrictions of navigation segment
      */
     function optionFilter(parameters, target, restrictions) {
-        const filterRestrictions = restrictions.FilterRestrictions || target && target[gVoc.Capabilities.FilterRestrictions] || {};
+        const filterRestrictions = restrictions.FilterRestrictions || target && target[voc.Capabilities.FilterRestrictions] || {};
 
         if (filterRestrictions.Filterable !== false) {
             const filter = {
-                name: gQueryOptionPrefix + 'filter',
-                description: filterRestrictions[gVoc.Core.Description]
+                name: queryOptionPrefix + 'filter',
+                description: filterRestrictions[voc.Core.Description]
                     || 'Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)',
                 in: 'query',
                 schema: {
@@ -740,7 +757,7 @@ module.exports.csdl2openapi = function (
      * @param {object} restrictions Navigation property restrictions of navigation segment
      */
     function optionOrderBy(parameters, element, target, restrictions) {
-        const sortRestrictions = restrictions.SortRestrictions || target && target[gVoc.Capabilities.SortRestrictions] || {};
+        const sortRestrictions = restrictions.SortRestrictions || target && target[voc.Capabilities.SortRestrictions] || {};
 
         if (sortRestrictions.Sortable !== false) {
             const nonSortable = {};
@@ -754,8 +771,8 @@ module.exports.csdl2openapi = function (
             });
             if (orderbyItems.length > 0) {
                 parameters.push({
-                    name: gQueryOptionPrefix + 'orderby',
-                    description: sortRestrictions[gVoc.Core.Description]
+                    name: queryOptionPrefix + 'orderby',
+                    description: sortRestrictions[voc.Core.Description]
                         || 'Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)',
                     in: 'query',
                     explode: false,
@@ -894,13 +911,13 @@ module.exports.csdl2openapi = function (
      * @param {object} restrictions Navigation property restrictions of navigation segment
      */
     function optionSearch(parameters, target, restrictions) {
-        const searchRestrictions = restrictions.SearchRestrictions || target && target[gVoc.Capabilities.SearchRestrictions] || {};
+        const searchRestrictions = restrictions.SearchRestrictions || target && target[voc.Capabilities.SearchRestrictions] || {};
 
         if (searchRestrictions.Searchable !== false) {
-            if (searchRestrictions[gVoc.Core.Description]) {
+            if (searchRestrictions[voc.Core.Description]) {
                 parameters.push({
-                    name: gQueryOptionPrefix + 'search',
-                    description: searchRestrictions[gVoc.Core.Description],
+                    name: queryOptionPrefix + 'search',
+                    description: searchRestrictions[voc.Core.Description],
                     in: 'query',
                     schema: { type: 'string' }
                 });
@@ -918,7 +935,7 @@ module.exports.csdl2openapi = function (
      * @param {object} restrictions Navigation property restrictions of navigation segment
      */
     function optionSelect(parameters, element, target, restrictions) {
-        const selectSupport = restrictions.SelectSupport || target && target[gVoc.Capabilities.SelectSupport] || {};
+        const selectSupport = restrictions.SelectSupport || target && target[voc.Capabilities.SelectSupport] || {};
 
         if (selectSupport.Supported !== false) {
             const type = modelElement(element.$Type) || {};
@@ -929,7 +946,7 @@ module.exports.csdl2openapi = function (
             )
             if (selectItems.length > 0) {
                 parameters.push({
-                    name: gQueryOptionPrefix + 'select',
+                    name: queryOptionPrefix + 'select',
                     description: 'Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)',
                     in: 'query',
                     explode: false,
@@ -955,7 +972,7 @@ module.exports.csdl2openapi = function (
     function optionSkip(parameters, target, restrictions) {
         const supported = restrictions.SkipSupported !== undefined
             ? restrictions.SkipSupported
-            : target == null || target[gVoc.Capabilities.SkipSupported] !== false;
+            : target == null || target[voc.Capabilities.SkipSupported] !== false;
 
         if (supported) {
             parameters.push({
@@ -973,7 +990,7 @@ module.exports.csdl2openapi = function (
     function optionTop(parameters, target, restrictions) {
         const supported = restrictions.TopSupported !== undefined
             ? restrictions.TopSupported
-            : target == null || target[gVoc.Capabilities.TopSupported] !== false;
+            : target == null || target[voc.Capabilities.TopSupported] !== false;
 
         if (supported) {
             parameters.push({
@@ -994,7 +1011,7 @@ module.exports.csdl2openapi = function (
      * @param {boolean} byKey Update by key
      */
     function operationUpdate(pathItem, element, name, sourceName, target, level, restrictions, byKey) {
-        const updateRestrictions = restrictions.UpdateRestrictions || target && target[gVoc.Capabilities.UpdateRestrictions] || {};
+        const updateRestrictions = restrictions.UpdateRestrictions || target && target[voc.Capabilities.UpdateRestrictions] || {};
 
         if (updateRestrictions.Updatable !== false) {
             const type = modelElement(element.$Type);
@@ -1002,7 +1019,7 @@ module.exports.csdl2openapi = function (
                 summary: updateRestrictions.Description || operationSummary('Change', name, sourceName, level, element.$Collection, byKey),
                 tags: [sourceName],
                 requestBody: {
-                    description: type && type[gVoc.Core.Description] || 'New property values',
+                    description: type && type[voc.Core.Description] || 'New property values',
                     required: true,
                     content: {
                         'application/json': {
@@ -1028,7 +1045,7 @@ module.exports.csdl2openapi = function (
      * @param {boolean} byKey Delete by key
      */
     function operationDelete(pathItem, element, name, sourceName, target, level, restrictions, byKey) {
-        const deleteRestrictions = restrictions.DeleteRestrictions || target && target[gVoc.Capabilities.DeleteRestrictions] || {};
+        const deleteRestrictions = restrictions.DeleteRestrictions || target && target[voc.Capabilities.DeleteRestrictions] || {};
 
         if (deleteRestrictions.Deletable !== false) {
             pathItem.delete = {
@@ -1051,12 +1068,12 @@ module.exports.csdl2openapi = function (
      * @param {string} navigationPrefix Path for finding navigation restrictions
      */
     function pathItemsWithNavigation(paths, prefix, prefixParameters, type, root, sourceName, level, navigationPrefix) {
-        const navigationRestrictions = root[gVoc.Capabilities.NavigationRestrictions] || {};
+        const navigationRestrictions = root[voc.Capabilities.NavigationRestrictions] || {};
         const rootNavigable = level == 0 && enumMember(navigationRestrictions.Navigability) != 'None'
             || level == 1 && enumMember(navigationRestrictions.Navigability) != 'Single'
             || level > 1;
 
-        if (type && level < pMaxLevels) {
+        if (type && level < maxLevels) {
             const properties = navigationPathMap(type);
             Object.keys(properties).forEach(name => {
                 const parentRestrictions = navigationPropertyRestrictions(root, navigationPrefix);
@@ -1067,8 +1084,10 @@ module.exports.csdl2openapi = function (
                 if (['Recursive', 'Single'].includes(enumMember(restrictions.Navigability))
                     || restrictions.Navigability == null && rootNavigable) {
                     const targetSetName = root.$NavigationPropertyBinding && root.$NavigationPropertyBinding[navigationPath];
-                    const target = gEntityContainer[targetSetName];
-                    pathItems(paths, prefix + '/' + name, prefixParameters, properties[name], root, sourceName, targetSetName, target, level + 1, navigationPath);
+                    const target = entityContainer[targetSetName];
+                    const targetType = target && modelElement(target.$Type);
+                    const targetName = (targetType && targetType[voc.Common.Label]) || targetSetName;
+                    pathItems(paths, prefix + '/' + name, prefixParameters, properties[name], root, sourceName, targetName, target, level + 1, navigationPath);
                 }
             });
         }
@@ -1087,7 +1106,7 @@ module.exports.csdl2openapi = function (
         Object.keys(properties).forEach(key => {
             if (properties[key].$Kind == 'NavigationProperty') {
                 map[prefix + key] = properties[key];
-            } else if (properties[key].$Type && !properties[key].$Collection && level < pMaxLevels) {
+            } else if (properties[key].$Type && !properties[key].$Collection && level < maxLevels) {
                 navigationPathMap(modelElement(properties[key].$Type), map, prefix + key + '/', level + 1);
             }
         })
@@ -1137,11 +1156,11 @@ module.exports.csdl2openapi = function (
         let segment = '';
         const params = [];
         const keys = getKey(entityType) || [];
-        const gProperties = propertiesOfStructuredType(entityType);
+        const properties = propertiesOfStructuredType(entityType);
 
         keys.forEach((key, index) => {
             const suffix = level > 0 ? '_' + level : '';
-            if (gKeyAsSegment)
+            if (keyAsSegment)
                 segment += '/';
             else {
                 if (index > 0) segment += ',';
@@ -1151,11 +1170,11 @@ module.exports.csdl2openapi = function (
             let property = {};
             if (typeof key == 'string') {
                 parameter = key;
-                property = gProperties[key];
+                property = properties[key];
             } else {
                 parameter = Object.keys(key)[0];
                 const segments = key[parameter].split('/');
-                property = gProperties[segments[0]];
+                property = properties[segments[0]];
                 for (let i = 1; i < segments.length; i++) {
                     const complexType = modelElement(property.$Type);
                     const properties = propertiesOfStructuredType(complexType);
@@ -1165,7 +1184,7 @@ module.exports.csdl2openapi = function (
             const propertyType = property.$Type;
             segment += pathValuePrefix(propertyType) + '{' + parameter + suffix + '}' + pathValueSuffix(propertyType);
             const param = {
-                description: [property[gVoc.Core.Description], property[gVoc.Core.LongDescription]].filter(t => t).join('  \n')
+                description: [property[voc.Core.Description], property[voc.Core.LongDescription]].filter(t => t).join('  \n')
                     || 'key: ' + parameter,
                 in: 'path',
                 name: parameter + suffix,
@@ -1174,7 +1193,7 @@ module.exports.csdl2openapi = function (
             };
             params.push(param);
         })
-        return { segment: (gKeyAsSegment ? '' : '(') + segment + (gKeyAsSegment ? '' : ')'), parameters: params };
+        return { segment: (keyAsSegment ? '' : '(') + segment + (keyAsSegment ? '' : ')'), parameters: params };
     }
 
     /**
@@ -1186,7 +1205,7 @@ module.exports.csdl2openapi = function (
         //TODO: handle other Edm types, enumeration types, and type definitions
         if (['Edm.Int64', 'Edm.Int32', 'Edm.Int16', 'Edm.SByte', 'Edm.Byte',
             'Edm.Double', 'Edm.Single', 'Edm.Date', 'Edm.DateTimeOffset', 'Edm.Guid'].includes(typename)) return '';
-        if (gKeyAsSegment) return '';
+        if (keyAsSegment) return '';
         return `'`;
     }
 
@@ -1199,7 +1218,7 @@ module.exports.csdl2openapi = function (
         //TODO: handle other Edm types, enumeration types, and type definitions
         if (['Edm.Int64', 'Edm.Int32', 'Edm.Int16', 'Edm.SByte', 'Edm.Byte',
             'Edm.Double', 'Edm.Single', 'Edm.Date', 'Edm.DateTimeOffset', 'Edm.Guid'].includes(typename)) return '';
-        if (gKeyAsSegment) return '';
+        if (keyAsSegment) return '';
         return `'`;
     }
 
@@ -1213,7 +1232,7 @@ module.exports.csdl2openapi = function (
      * @param {boolean} byKey read by key
      */
     function pathItemsForBoundOperations(paths, prefix, prefixParameters, element, sourceName, byKey = false) {
-        const overloads = gBoundOverloads[element.$Type + (!byKey && element.$Collection ? '-c' : '')] || [];
+        const overloads = boundOverloads[element.$Type + (!byKey && element.$Collection ? '-c' : '')] || [];
         overloads.forEach(item => {
             if (item.overload.$Kind == 'Action')
                 pathItemAction(paths, prefix + '/' + item.name, prefixParameters, item.name, item.overload, sourceName);
@@ -1247,14 +1266,14 @@ module.exports.csdl2openapi = function (
         const name = actionName.indexOf('.') === -1 ? actionName : nameParts(actionName).name;
         const pathItem = {
             post: {
-                summary: actionImport[gVoc.Core.Description] || overload[gVoc.Core.Description] || 'Invoke action ' + name,
-                tags: [sourceName || 'Service Operations'],
+                summary: actionImport[voc.Core.Description] || overload[voc.Core.Description] || 'Invoke action ' + name,
+                tags: [overload[voc.Common.Label] || sourceName || 'Service Operations'],
                 responses: overload.$ReturnType
                     ? response(200, 'Success', overload.$ReturnType)
                     : response(204, 'Success')
             }
         };
-        const description = actionImport[gVoc.Core.LongDescription] || overload[gVoc.Core.LongDescription];
+        const description = actionImport[voc.Core.LongDescription] || overload[voc.Core.LongDescription];
         if (description) pathItem.post.description = description;
         if (prefixParameters.length > 0) pathItem.post.parameters = prefixParameters;
         let parameters = overload.$Parameter || [];
@@ -1307,13 +1326,13 @@ module.exports.csdl2openapi = function (
         const pathSegments = [];
         const params = [];
 
-        const implicitAliases = pCsdl.$Version > '4.0' || parameters.some(p => p[gVoc.Core.OptionalParameter]);
+        const implicitAliases = csdl.$Version > '4.0' || parameters.some(p => p[voc.Core.OptionalParameter]);
 
         parameters.forEach(p => {
             const param = {
-                required: implicitAliases ? !p[gVoc.Core.OptionalParameter] : true
+                required: implicitAliases ? !p[voc.Core.OptionalParameter] : true
             };
-            const description = [p[gVoc.Core.Description], p[gVoc.Core.LongDescription]].filter(t => t).join('  \n');
+            const description = [p[voc.Core.Description], p[voc.Core.LongDescription]].filter(t => t).join('  \n');
             if (description) param.description = description;
             const type = modelElement(p.$Type || 'Edm.String');
             // TODO: check whether parameter or type definition of Edm.Stream is annotated with JSON.Schema
@@ -1341,11 +1360,16 @@ module.exports.csdl2openapi = function (
                 if (implicitAliases) {
                     param.in = 'query';
                 } else {
-                    pathSegments.push(p.$Name + '=' + pathValuePrefix(p.$Type) + '{' + p.$Name + '}' + pathValueSuffix(p.$Type));
+                    pathSegments.push(p.$Name + "={" + p.$Name + "}");
                     param.in = 'path';
                 }
                 param.name = p.$Name;
-                param.schema = getSchema(p, '', true);
+                if (!p.$Type || p.$Type === "Edm.String" || (type && (!type.$Type || type.$Type === "Edm.String"))) {
+                    if (description) param.description += "  \n";
+                    else param.description = "";
+                    param.description += "String value needs to be enclosed in single quotes";
+                }
+                param.schema = getSchema(p, '', true, true);
             }
             params.push(param);
         });
@@ -1353,13 +1377,13 @@ module.exports.csdl2openapi = function (
         const pathParameters = implicitAliases ? '' : '(' + pathSegments.join(',') + ')';
         const pathItem = {
             get: {
-                summary: functionImport[gVoc.Core.Description] || overload[gVoc.Core.Description] || 'Invoke function ' + name,
-                tags: [sourceName || 'Service Operations'],
+                summary: functionImport[voc.Core.Description] || overload[voc.Core.Description] || 'Invoke function ' + name,
+                tags: [overload[voc.Common.Label] || sourceName || 'Service Operations'],
                 parameters: prefixParameters.concat(params),
                 responses: response(200, 'Success', overload.$ReturnType)
             }
         };
-        const iDescription = functionImport[gVoc.Core.LongDescription] || overload[gVoc.Core.LongDescription];
+        const iDescription = functionImport[voc.Core.LongDescription] || overload[voc.Core.LongDescription];
         if (iDescription) pathItem.get.description = iDescription;
         paths[prefix + pathParameters] = pathItem;
     }
@@ -1370,14 +1394,14 @@ module.exports.csdl2openapi = function (
      * @param {object} container Entity container
      */
     function pathItemBatch(paths, container) {
-        const batchSupport = container[gVoc.Capabilities.BatchSupport] || {};
-        const supported = container[gVoc.Capabilities.BatchSupported] !== false && batchSupport.Supported !== false;
+        const batchSupport = container[voc.Capabilities.BatchSupport] || {};
+        const supported = container[voc.Capabilities.BatchSupported] !== false && batchSupport.Supported !== false;
         if (supported) {
             const firstEntitySet = Object.keys(container).filter(child => isIdentifier(child) && container[child].$Collection)[0];
             paths['/$batch'] = {
                 post: {
-                    summary: batchSupport[gVoc.Core.Description] || 'Send a group of requests',
-                    description: (batchSupport[gVoc.Core.LongDescription] || 'Group multiple requests into a single request payload, see '
+                    summary: batchSupport[voc.Core.Description] || 'Send a group of requests',
+                    description: (batchSupport[voc.Core.LongDescription] || 'Group multiple requests into a single request payload, see '
                         + '[Batch Requests](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_BatchRequests).')
                         + '\n\n*Please note that "Try it out" is not supported for this request.*',
                     tags: ['Batch Requests'],
@@ -1405,7 +1429,7 @@ module.exports.csdl2openapi = function (
                     }
                 }
             };
-            paths['/$batch'].post.responses[pCsdl.$Version < '4.0' ? 202 : 200] = {
+            paths['/$batch'].post.responses[csdl.$Version < '4.0' ? 202 : 200] = {
                 description: 'Batch response',
                 content: {
                     'multipart/mixed': {
@@ -1444,7 +1468,7 @@ module.exports.csdl2openapi = function (
                             type: 'object',
                             title: 'Collection of ' + nameParts(type.$Type || 'Edm.String').name,
                             properties: {
-                                [pCsdl.$Version > '4.0' ? '@count' : '@odata.count']: ref('count'),
+                                [csdl.$Version > '4.0' ? '@count' : '@odata.count']: ref('count'),
                                 value: s
                             }
                         }
@@ -1529,7 +1553,7 @@ module.exports.csdl2openapi = function (
      * @param {object} schemas Map of Schema Objects to augment
      */
     function inlineTypes(schemas) {
-        if (gTypesToInline.geoPoint) {
+        if (typesToInline.geoPoint) {
             schemas.geoPoint = {
                 type: 'object',
                 properties: {
@@ -1571,7 +1595,7 @@ module.exports.csdl2openapi = function (
             title: name,
             enum: members
         };
-        const description = type[gVoc.Core.Description];
+        const description = type[voc.Core.Description];
         if (description) s.description = description;
         schemas[qualifier + '.' + name] = s;
     }
@@ -1587,7 +1611,7 @@ module.exports.csdl2openapi = function (
     function schemaForTypeDefinition(schemas, qualifier, name, type) {
         const s = getSchema(Object.assign({ $Type: type.$UnderlyingType }, type));
         s.title = name;
-        const description = type[gVoc.Core.Description];
+        const description = type[voc.Core.Description];
         if (description) s.description = description;
         schemas[qualifier + '.' + name] = s;
     }
@@ -1616,18 +1640,18 @@ module.exports.csdl2openapi = function (
             allProperties[iName] = getSchema(property);
             if (property.$Kind == 'NavigationProperty') {
                 if (property.$Collection) {
-                    allProperties[`${iName}@${pCsdl.$Version === '4.0' ? 'odata.' : ''}count`] = ref('count');
+                    allProperties[`${iName}@${csdl.$Version === '4.0' ? 'odata.' : ''}count`] = ref('count');
                 }
                 creProperties[iName] = getSchema(property, '-create');
-                if (gDeepUpdate)
+                if (deepUpdate)
                     updProperties[iName] = getSchema(property, '-create');
             } else {
-                if (property[gVoc.Core.Permissions] == 'Read' || property[gVoc.Core.Computed]) {
+                if (property[voc.Core.Permissions] == 'Read' || property[voc.Core.Computed]) {
                     let index = required.indexOf(iName);
                     if (index != -1) required.splice(index, 1);
                 } else {
                     creProperties[iName] = getSchema(property, '-create');
-                    if (!isKey[iName] && !property[gVoc.Core.Immutable])
+                    if (!isKey[iName] && !property[voc.Core.Immutable])
                         updProperties[iName] = getSchema(property, '-update');
                 }
             }
@@ -1654,18 +1678,18 @@ module.exports.csdl2openapi = function (
         };
         if (Object.keys(updProperties).length > 0) schemas[updName].properties = updProperties;
 
-        const description = type[gVoc.Core.Description];
+        const description = type[voc.Core.Description];
         if (description) {
             schemas[allName].description = description;
             schemas[creName].description = description;
             schemas[updName].description = description;
         }
 
-        if (gDerivedTypes[allName]) {
+        if (derivedTypes[allName]) {
             schemas[allName].anyOf = [];
             schemas[creName].anyOf = [];
             schemas[updName].anyOf = [];
-            gDerivedTypes[allName].forEach(derivedType => {
+            derivedTypes[allName].forEach(derivedType => {
                 schemas[allName].anyOf.push(ref(derivedType));
                 schemas[creName].anyOf.push(ref(derivedType, '-create'));
                 schemas[updName].anyOf.push(ref(derivedType, '-update'));
@@ -1700,7 +1724,7 @@ module.exports.csdl2openapi = function (
     function getParameters() {
         const param = {
             top: {
-                name: gQueryOptionPrefix + 'top',
+                name: queryOptionPrefix + 'top',
                 in: 'query',
                 description: 'Show only the first n items, see [Paging - Top](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptiontop)',
                 schema: {
@@ -1710,7 +1734,7 @@ module.exports.csdl2openapi = function (
                 example: 50
             },
             skip: {
-                name: gQueryOptionPrefix + 'skip',
+                name: queryOptionPrefix + 'skip',
                 in: 'query',
                 description: 'Skip the first n items, see [Paging - Skip](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionskip)',
                 schema: {
@@ -1719,7 +1743,7 @@ module.exports.csdl2openapi = function (
                 }
             },
             count: {
-                name: gQueryOptionPrefix + 'count',
+                name: queryOptionPrefix + 'count',
                 in: 'query',
                 description: 'Include count of items, see [Count](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptioncount)',
                 schema: {
@@ -1728,8 +1752,8 @@ module.exports.csdl2openapi = function (
             }
         };
 
-        if (pCsdl.$Version >= '4.0') param.search = {
-            name: gQueryOptionPrefix + 'search',
+        if (csdl.$Version >= '4.0') param.search = {
+            name: queryOptionPrefix + 'search',
             in: 'query',
             description: 'Search items by search phrases, see [Searching](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionsearch)',
             schema: {
@@ -1777,7 +1801,7 @@ module.exports.csdl2openapi = function (
             }
         };
 
-        if (pCsdl.$Version < '4.0') {
+        if (csdl.$Version < '4.0') {
             err.properties.error.properties.message = {
                 type: 'object',
                 properties: {
@@ -1812,7 +1836,7 @@ module.exports.csdl2openapi = function (
      * @param {object} modelElement referencing a type
      * @return {object} Schema Object
      */
-    function getSchema(element, suffix = '', forParameter = false) {
+    function getSchema(element, suffix = '', forParameter = false, forFunction = false) {
         let s = {};
         switch (element.$Type) {
             case 'Edm.AnnotationPath':
@@ -1891,7 +1915,7 @@ module.exports.csdl2openapi = function (
             case 'Edm.GeographyPoint':
             case 'Edm.GeometryPoint':
                 s = ref('geoPoint');
-                gTypesToInline.geoPoint = true;
+                typesToInline.geoPoint = true;
                 break;
             case 'Edm.Guid':
                 s = {
@@ -1939,7 +1963,7 @@ module.exports.csdl2openapi = function (
                 break;
             case 'Edm.Stream':
                 // eslint-disable-next-line no-case-declarations
-                let jsonSchema = element[gVoc.JSON.Schema];
+                let jsonSchema = element[voc.JSON.Schema];
                 if (jsonSchema) {
                     if (typeof jsonSchema == 'string')
                         s = JSON.parse(jsonSchema);
@@ -1992,21 +2016,45 @@ module.exports.csdl2openapi = function (
             s.default = element.$DefaultValue;
         }
 
-        if (element[gVoc.Core.Example]) {
+        if (element[voc.Core.Example]) {
             if (s.$ref) s = { allOf: [s] };
-            s.example = element[gVoc.Core.Example].Value;
+            s.example = element[voc.Core.Example].Value;
+        }
+
+        if (forFunction) {
+            if (s.example && typeof s.example === "string") {
+                s.example = `${pathValuePrefix(element.$Type)}${s.example
+                    }${pathValueSuffix(element.$Type)}`;
+            }
+            if (s.pattern) {
+                const pre = pathValuePrefix(element.$Type);
+                const suf = pathValueSuffix(element.$Type);
+                s.pattern = s.pattern.replace(/^\^/, `^${pre}(`);
+                s.pattern = s.pattern.replace(/\$$/, `)${suf}$`);
+            } else if (!element.$Type || element.$Type === "Edm.String") {
+                s.pattern = "^'([^']|'')*'$";
+            }
+            if (element.$Nullable) {
+                if (!s.anyOf && !s.allOf) s.type = "string";
+                if (s.format) s.format += ",null";
+                s.default = "null";
+                if (s.pattern) {
+                    s.pattern = s.pattern.replace(/^\^/, "^(null|");
+                    s.pattern = s.pattern.replace(/\$$/, ")$");
+                }
+            }
         }
 
-        if (element[gVoc.Validation.Maximum] != undefined) {
+        if (element[voc.Validation.Maximum] != undefined) {
             if (s.$ref) s = { allOf: [s] };
-            s.maximum = element[gVoc.Validation.Maximum];
-            if (element[gVoc.Validation.Maximum + gVoc.Validation.Exclusive]) s.exclusiveMaximum = true;
+            s.maximum = element[voc.Validation.Maximum];
+            if (element[voc.Validation.Maximum + voc.Validation.Exclusive]) s.exclusiveMaximum = true;
         }
 
-        if (element[gVoc.Validation.Minimum] != undefined) {
+        if (element[voc.Validation.Minimum] != undefined) {
             if (s.$ref) s = { allOf: [s] };
-            s.minimum = element[gVoc.Validation.Minimum];
-            if (element[gVoc.Validation.Minimum + gVoc.Validation.Exclusive]) s.exclusiveMinimum = true;
+            s.minimum = element[voc.Validation.Minimum];
+            if (element[voc.Validation.Minimum + voc.Validation.Exclusive]) s.exclusiveMinimum = true;
         }
 
         if (element.$Collection) {
@@ -2016,9 +2064,9 @@ module.exports.csdl2openapi = function (
             };
         }
 
-        if (!forParameter && element[gVoc.Core.Description]) {
+        if (!forParameter && element[voc.Core.Description]) {
             if (s.$ref) s = { allOf: [s] };
-            s.description = element[gVoc.Core.Description];
+            s.description = element[voc.Core.Description];
         }
 
         return s;
@@ -2030,7 +2078,7 @@ module.exports.csdl2openapi = function (
      * @param {object} element Model element
      */
     function allowedValues(schema, element) {
-        const values = element[gVoc.Validation.AllowedValues];
+        const values = element[voc.Validation.AllowedValues];
         if (values) schema.enum = values.map(record => record.Value);
     }
 
@@ -2040,7 +2088,7 @@ module.exports.csdl2openapi = function (
      * @param {object} element Model element
      */
     function getPattern(schema, element) {
-        const pattern = element[gVoc.Validation.Pattern];
+        const pattern = element[voc.Validation.Pattern];
         if (pattern) schema.pattern = pattern;
     }
 
@@ -2056,9 +2104,9 @@ module.exports.csdl2openapi = function (
         let url = '';
         if (typename.indexOf('.') != -1) {
             let parts = nameParts(typename);
-            nsp = gNamespace[parts.qualifier];
+            nsp = namespace[parts.qualifier];
             name = nsp + '.' + parts.name;
-            url = gNamespaceUrl[nsp] || '';
+            url = namespaceUrl[nsp] || '';
             //TODO: introduce better way than guessing
             if (url.endsWith('.xml')) url = url.substr(0, url.length - 3) + 'openapi3.json';
         }
@@ -2073,7 +2121,7 @@ module.exports.csdl2openapi = function (
      * @param {object} entityContainer Entity Container object
      */
     function getSecuritySchemes(components, entityContainer) {
-        const authorizations = entityContainer[gVoc.Authorization.Authorizations] || [];
+        const authorizations = entityContainer[voc.Authorization.Authorizations] || [];
         const schemes = {};
         const location = { Header: 'header', QueryOption: 'query', Cookie: 'cookie' };
         authorizations.forEach(auth => {
@@ -2149,7 +2197,7 @@ module.exports.csdl2openapi = function (
      * @param {object} entityContainer Entity Container object
      */
     function security(openapi, entityContainer) {
-        const securitySchemes = entityContainer[gVoc.Authorization.SecuritySchemes] || [];
+        const securitySchemes = entityContainer[voc.Authorization.SecuritySchemes] || [];
         if (securitySchemes.length > 0) openapi.security = [];
         securitySchemes.forEach(scheme => {
             const s = {};
@@ -2165,7 +2213,7 @@ module.exports.csdl2openapi = function (
      */
     function namespaceQualifiedName(qualifiedName) {
         let np = nameParts(qualifiedName);
-        return gNamespace[np.qualifier] + '.' + np.name;
+        return namespace[np.qualifier] + '.' + np.name;
     }
 
     /**