fix: Remove special characters from placeholders

CHANGELOG.md

@@ -8,6 +8,7 @@ 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

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 }} options Optional parameters
  * @return {object} OpenAPI description
  */
 module.exports.csdl2openapi = function (
     csdl,
     {
         url: serviceRoot,
@@ -104,10 +104,10 @@
     } = {}
 ) {
     // 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)
     serviceRoot = serviceRoot ?? (`${scheme}://${host}${basePath}`);
     const queryOptionPrefix = csdl.$Version <= '4.01' ? '$' : '';
     const typesToInline = {}; // filled in schema() and used in inlineTypes()
 
@@ -120,8 +120,8 @@
         Object.keys(entityContainer).forEach(element => {
             if (entityContainer[element].$Type) {
                 const fullTypeName = entityContainer[element].$Type;
-                const type = fullTypeName.startsWith(serviceName + '.') 
-                    ? fullTypeName.substring(serviceName.length + 1) 
+                const type = fullTypeName.startsWith(serviceName + '.')
+                    ? fullTypeName.substring(serviceName.length + 1)
                     : nameParts(fullTypeName).name;
                 if ((csdl[serviceName]?.[type]?.['@cds.autoexpose'] || csdl[serviceName]?.[type]?.['@cds.autoexposed'])
                     && (!entityContainer[type] || type.endsWith('_texts'))) {
@@ -288,15 +288,15 @@
             description = containerSchema[meta.voc.Core.Description];
         }
         else {
-            description = "Use @Core.LongDescription: '...' or @Core.Description: '...' on your CDS service to provide a meaningful description.";
+            description = "Use the Core.LongDescription or Core.Description annotation on your CDS service to provide a meaningful description.";
         }
         description += (diagram ? new Diagram(meta).getResourceDiagram(entityContainer) : '');
         let title;
         if (entityContainer && entityContainer[meta.voc.Common.Label]) {
             title = entityContainer[meta.voc.Common.Label];
         }
         else {
-            title = "Use @title: '...' on your CDS service to provide a meaningful title.";
+            title = "Use the title annotation on your CDS service to provide a meaningful title.";
         }
         return {
             title,
@@ -338,7 +338,7 @@
             shortText = containerSchema[meta.voc.Core.Description];
         }
         else {
-            shortText = "Use @Core.Description: '...' on your CDS service to provide a meaningful short text.";
+            shortText = "Use the Core.Description annotation on your CDS service to provide a meaningful short text.";
         }
         return shortText;
     }
@@ -406,7 +406,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 +458,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 +540,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);
@@ -577,7 +577,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 +613,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 +638,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;