@cparra/apexdocs 3.0.0-alpha.9 → 3.0.0-rc.0

package/examples/open-api/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "openapi-example",
+  "scripts": {
+    "docs:clean": "rimraf docs",
+    "docs:gen": "ts-node ../../src/cli/generate.ts openapi",
+    "apexdocs:build": "npm run docs:clean && npm run docs:gen"
+  },
+  "devDependencies": {
+    "ts-node": "^10.9.2"
+  },
+  "dependencies": {
+    "rimraf": "^5.0.7"
+  },
+  "apexdocs": {
+    "sourceDir": "force-app",
+    "title": "Open API Example",
+    "namespace": "openapi",
+    "apiVersion": "3.0.0"
+  }
+}

package/examples/open-api/sfdx-project.json

@@ -0,0 +1,12 @@
+{
+  "packageDirectories": [
+    {
+      "path": "force-app",
+      "default": true
+    }
+  ],
+  "name": "openapi",
+  "namespace": "",
+  "sfdcLoginUrl": "https://login.salesforce.com",
+  "sourceApiVersion": "61.0"
+}

package/examples/vitepress/apexdocs.config.ts

@@ -29,10 +29,15 @@ export default defineMarkdownConfig({
   sourceDir: 'force-app',
   scope: ['global', 'public', 'protected', 'private', 'namespaceaccessible'],
   namespace: 'apexdocs',
-  transformReferenceGuide: async (referenceGuide) => {
+  transformReference: (reference) => {
+    return {
+      // remove the trailing .md
+      referencePath: reference.referencePath.replace(/\.md$/, ''),
+    };
+  },
+  transformReferenceGuide: async () => {
     const frontMatter = await loadFileAsync('./docs/index-frontmatter.md');
     return {
-      ...referenceGuide,
       frontmatter: frontMatter,
     };
   },

package/examples/vitepress/docs/index.md

@@ -19,38 +19,38 @@ hero:
 
 ## Miscellaneous
 
-### [BaseClass](miscellaneous/BaseClass.md)
+### [BaseClass](miscellaneous/BaseClass)
 
-### [MultiInheritanceClass](miscellaneous/MultiInheritanceClass.md)
+### [MultiInheritanceClass](miscellaneous/MultiInheritanceClass)
 
-### [ParentInterface](miscellaneous/ParentInterface.md)
+### [ParentInterface](miscellaneous/ParentInterface)
 
-### [ReferencedEnum](miscellaneous/ReferencedEnum.md)
+### [ReferencedEnum](miscellaneous/ReferencedEnum)
 
-### [SampleException](miscellaneous/SampleException.md)
+### [SampleException](miscellaneous/SampleException)
 
 This is a sample exception.
 
-### [SampleInterface](miscellaneous/SampleInterface.md)
+### [SampleInterface](miscellaneous/SampleInterface)
 
 This is a sample interface
 
-### [Url](miscellaneous/Url.md)
+### [Url](miscellaneous/Url)
 
 Represents a uniform resource locator (URL) and provides access to parts of the URL. 
 Enables access to the base URL used to access your Salesforce org.
 
 ## Sample Enums
 
-### [SampleEnum](sample-enums/SampleEnum.md)
+### [SampleEnum](sample-enums/SampleEnum)
 
-This is a sample enum. This references [ReferencedEnum](miscellaneous/ReferencedEnum.md) . 
+This is a sample enum. This references [ReferencedEnum](miscellaneous/ReferencedEnum) . 
  
 This description has several lines
 
 ## SampleGroup
 
-### [SampleClass](samplegroup/SampleClass.md)
+### [SampleClass](samplegroup/SampleClass)
 
 aliquip ex sunt officia ullamco anim deserunt magna aliquip nisi eiusmod in sit officia veniam ex 
-deserunt ea officia exercitation laboris enim in duis quis enim eiusmod eu amet cupidatat.
+**deserunt** ea officia exercitation laboris enim in duis quis enim eiusmod eu amet cupidatat.

package/examples/vitepress/docs/miscellaneous/BaseClass.md

@@ -17,4 +17,4 @@ public sampleEnumFromBase
 ```
 
 #### Type
-[SampleEnum](../sample-enums/SampleEnum.md)
+[SampleEnum](../sample-enums/SampleEnum)

package/examples/vitepress/docs/miscellaneous/MultiInheritanceClass.md

@@ -9,7 +9,7 @@ apexdocs
 
 **Inheritance**
 
-[SampleClass](../samplegroup/SampleClass.md) < [BaseClass](BaseClass.md)
+[SampleClass](../samplegroup/SampleClass) < [BaseClass](BaseClass)
 
 ## Fields
 ### `sampleEnumFromBase`
@@ -22,7 +22,7 @@ public sampleEnumFromBase
 ```
 
 #### Type
-[SampleEnum](../sample-enums/SampleEnum.md)
+[SampleEnum](../sample-enums/SampleEnum)
 
 ## Properties
 ### Group Name

package/examples/vitepress/docs/miscellaneous/SampleException.md

@@ -9,7 +9,7 @@ This is a sample exception.
 **Usage** 
 
 You can use the exception the following way. 
-You can also take a look at [SampleClass](../samplegroup/SampleClass.md) to see how it is used. 
+You can also take a look at [SampleClass](../samplegroup/SampleClass) to see how it is used. 
 This is a dangerous HTML tag: <script>alert('Hello');</script> 
  
 ```apex

package/examples/vitepress/docs/miscellaneous/SampleInterface.md

@@ -19,9 +19,9 @@ C -->|extends| D[GreatGrandParentInterface]
 
 **Date** 2020-01-01
 
-**See** [SampleEnum](../sample-enums/SampleEnum.md)
+**See** [SampleEnum](../sample-enums/SampleEnum)
 
-**See** [ReferencedEnum](ReferencedEnum.md)
+**See** [ReferencedEnum](ReferencedEnum)
 
 ## Namespace
 apexdocs
@@ -31,7 +31,7 @@ SampleInterface sampleInterface = new SampleInterface();
 sampleInterface.sampleMethod();
 
 **Extends**
-[ParentInterface](ParentInterface.md)
+[ParentInterface](ParentInterface)
 
 ## Methods
 ### `sampleMethod()`
@@ -66,7 +66,7 @@ public String sampleMethod()
 Some return value
 
 #### Throws
-[SampleException](SampleException.md): This is a sample exception
+[SampleException](SampleException): This is a sample exception
 
 AnotherSampleException: This is another sample exception
 
@@ -94,10 +94,10 @@ public SampleEnum sampleMethodWithParams(String param1, Integer param2, SampleEn
 |------|------|-------------|
 | param1 | String | This is the first parameter |
 | param2 | Integer | This is the second parameter |
-| theEnum | [SampleEnum](../sample-enums/SampleEnum.md) | This is an enum parameter |
+| theEnum | [SampleEnum](../sample-enums/SampleEnum) | This is an enum parameter |
 
 #### Return Type
-**[SampleEnum](../sample-enums/SampleEnum.md)**
+**[SampleEnum](../sample-enums/SampleEnum)**
 
 Some return value
 

package/examples/vitepress/docs/miscellaneous/Url.md

@@ -120,7 +120,7 @@ global Url(Url context, String spec)
 #### Parameters
 | Name | Type | Description |
 |------|------|-------------|
-| context | [Url](Url.md) | The context in which to parse the specification. |
+| context | [Url](Url) | The context in which to parse the specification. |
 | spec | String | The string to parse as a URL. |
 
 ---
@@ -191,7 +191,7 @@ global static Url getCurrentRequestUrl()
 ```
 
 #### Return Type
-**[Url](Url.md)**
+**[Url](Url)**
 
 The URL of the entire request.
 
@@ -299,7 +299,7 @@ global static Url getOrgDomainUrl()
 ```
 
 #### Return Type
-**[Url](Url.md)**
+**[Url](Url)**
 
 getOrgDomainUrl() always returns the login URL for your org, regardless of context. Use that URL when making API calls to your org.
 

package/examples/vitepress/docs/sample-enums/SampleEnum.md

@@ -6,13 +6,13 @@ title: SampleEnum
 
 `NAMESPACEACCESSIBLE`
 
-This is a sample enum. This references [ReferencedEnum](../miscellaneous/ReferencedEnum.md) . 
+This is a sample enum. This references [ReferencedEnum](../miscellaneous/ReferencedEnum) . 
  
 This description has several lines
 
 **Some Custom** 
 
-Test. I can also have a [ReferencedEnum](../miscellaneous/ReferencedEnum.md) here. 
+Test. I can also have a [ReferencedEnum](../miscellaneous/ReferencedEnum) here. 
 And it can be multiline.
 
 **Mermaid** 
@@ -27,7 +27,7 @@ B -->|referenced by| A
 
 **Date** 2022-01-01
 
-**See** [ReferencedEnum](../miscellaneous/ReferencedEnum.md)
+**See** [ReferencedEnum](../miscellaneous/ReferencedEnum)
 
 ## Namespace
 apexdocs

package/examples/vitepress/docs/samplegroup/SampleClass.md

@@ -6,7 +6,7 @@ title: SampleClass
 `virtual`
 
 aliquip ex sunt officia ullamco anim deserunt magna aliquip nisi eiusmod in sit officia veniam ex 
-deserunt ea officia exercitation laboris enim in duis quis enim eiusmod eu amet cupidatat.
+**deserunt** ea officia exercitation laboris enim in duis quis enim eiusmod eu amet cupidatat.
 
 **Group** SampleGroup
 
@@ -19,12 +19,12 @@ sample.doSomething();
 
 **Inheritance**
 
-[BaseClass](../miscellaneous/BaseClass.md)
+[BaseClass](../miscellaneous/BaseClass)
 
 **Implements**
 
-[SampleInterface](../miscellaneous/SampleInterface.md), 
-[ParentInterface](../miscellaneous/ParentInterface.md)
+[SampleInterface](../miscellaneous/SampleInterface), 
+[ParentInterface](../miscellaneous/ParentInterface)
 
 ## Fields
 ### Group Name
@@ -51,7 +51,7 @@ public sampleEnumFromBase
 ```
 
 ##### Type
-[SampleEnum](../sample-enums/SampleEnum.md)
+[SampleEnum](../sample-enums/SampleEnum)
 
 ## Properties
 ### Group Name

package/examples/vitepress/force-app/main/default/classes/SampleClass.cls

@@ -1,6 +1,6 @@
 /**
  * @description aliquip ex sunt officia ullamco anim deserunt magna aliquip nisi eiusmod in sit officia veniam ex
- *              deserunt ea officia exercitation laboris enim in duis quis enim eiusmod eu amet cupidatat.
+ *              **deserunt** ea officia exercitation laboris enim in duis quis enim eiusmod eu amet cupidatat.
  * @group SampleGroup
  * @example
  * SampleClass sample = new SampleClass();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cparra/apexdocs",
-  "version": "3.0.0-alpha.9",
+  "version": "3.0.0-rc.0",
   "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
   "keywords": [
     "apex",
@@ -17,6 +17,7 @@
   },
   "scripts": {
     "test": "npm run build && jest",
+    "test:cov": "npm run build && jest --coverage",
     "build": "rimraf ./lib && npm run lint && tsc --noEmit && pkgroll",
     "lint": "eslint \"./src/**/*.{js,ts}\" --quiet --fix",
     "prepare": "npm run build",
@@ -68,7 +69,6 @@
     "fp-ts": "^2.16.8",
     "handlebars": "^4.7.8",
     "js-yaml": "^4.1.0",
-    "type-fest": "^4.23.0",
     "yargs": "^17.7.2"
   },
   "imports": {

package/src/application/Apexdocs.ts

@@ -4,7 +4,10 @@ import openApi from './generators/openapi';
 import { ApexFileReader } from './apex-file-reader';
 import { DefaultFileSystem } from './file-system';
 import { Logger } from '#utils/logger';
-import { UserDefinedConfig } from '../core/shared/types';
+import { UnparsedSourceFile, UserDefinedConfig, UserDefinedMarkdownConfig } from '../core/shared/types';
+import { pipe } from 'fp-ts/function';
+import * as TE from 'fp-ts/TaskEither';
+import { ReflectionError } from '../core/markdown/reflection/reflect-source';
 
 /**
  * Application entry-point to generate documentation out of Apex source files.
@@ -20,21 +23,50 @@ export class Apexdocs {
       const fileBodies = await ApexFileReader.processFiles(
         new DefaultFileSystem(),
         config.sourceDir,
-        config.includeMetadata,
+        config.targetGenerator === 'markdown' ? config.includeMetadata : false,
       );
 
       switch (config.targetGenerator) {
         case 'markdown':
-          await markdown(fileBodies, config);
+          await generateMarkdownDocumentation(fileBodies, config)();
           break;
         case 'openapi':
-          openApi(fileBodies, config);
+          await openApi(fileBodies, config);
           break;
       }
-
-      Logger.logSingle('✔️ Documentation generated successfully!');
     } catch (error) {
-      Logger.logSingle('❌ An error occurred while generating the documentation.', 'red');
+      Logger.logSingle(`❌ An error occurred while generating the documentation: ${error}`, 'red');
     }
   }
 }
+
+function generateMarkdownDocumentation(fileBodies: UnparsedSourceFile[], config: UserDefinedMarkdownConfig) {
+  return pipe(
+    markdown(fileBodies, config),
+    TE.map(() => Logger.logSingle('✔️ Documentation generated successfully!')),
+    TE.mapLeft((error) => {
+      if (error._tag === 'HookError') {
+        Logger.error('Error(s) occurred while processing hooks. Please review the following issues:');
+        Logger.error(error.error);
+        return;
+      }
+
+      if (error._tag === 'FileWritingError') {
+        Logger.error(error.message);
+        Logger.error(error.error);
+        return;
+      }
+
+      const errorMessages = [
+        'Error(s) occurred while parsing files. Please review the following issues:',
+        ...error.errors.map(formatReflectionError),
+      ].join('\n');
+
+      Logger.error(errorMessages);
+    }),
+  );
+}
+
+function formatReflectionError(error: ReflectionError) {
+  return `Source file: ${error.file}\n${error.message}\n`;
+}

package/src/application/__tests__/apex-file-reader.spec.ts

@@ -1,23 +1,6 @@
-import { Settings, SettingsConfig } from '../../core/settings';
 import { ApexFileReader } from '../apex-file-reader';
 
 describe('File Reader', () => {
-  beforeEach(() => {
-    Settings.build({
-      sourceDirectory: '',
-      recursive: true,
-      scope: [],
-      outputDir: '',
-      targetGenerator: 'markdown',
-      indexOnly: false,
-      defaultGroupName: 'Misc',
-      sanitizeHtml: true,
-      openApiFileName: 'openapi',
-      title: 'Classes',
-      includeMetadata: false,
-    } as SettingsConfig);
-  });
-
   it('returns an empty list when there are no files in the directory', async () => {
     const result = await ApexFileReader.processFiles(
       {

package/src/application/file-writer.ts

@@ -1,21 +1,43 @@
 import * as fs from 'fs';
 import * as path from 'path';
+import * as TE from 'fp-ts/lib/TaskEither';
 import { PageData } from '../core/shared/types';
+import { pipe } from 'fp-ts/function';
 
-export class FileWriter {
-  static write(files: PageData[], outputDir: string, onWriteCallback?: (file: PageData) => void) {
-    files.forEach((file) => {
-      const { outputDocPath, content } = this.getTargetLocation(file, outputDir);
-      fs.mkdirSync(path.dirname(outputDocPath), { recursive: true });
-      fs.writeFileSync(outputDocPath, content, 'utf8');
-      onWriteCallback?.(file);
-    });
-  }
+const mkdir: (path: fs.PathLike, options: fs.MakeDirectoryOptions) => TE.TaskEither<NodeJS.ErrnoException, void> =
+  TE.taskify(fs.mkdir);
 
-  private static getTargetLocation(file: PageData, outputDir: string): PageData {
-    return {
-      ...file,
-      outputDocPath: path.join(outputDir, file.outputDocPath),
-    };
-  }
+const writeFile: (
+  path: fs.PathOrFileDescriptor,
+  data: string,
+  options?: fs.WriteFileOptions,
+) => TE.TaskEither<NodeJS.ErrnoException, void> = TE.taskify(fs.writeFile);
+
+export function writeFiles(files: PageData[], outputDir: string, onWriteCallback?: (file: PageData) => void) {
+  return pipe(
+    files,
+    TE.traverseArray((file) => writeSingle(file, outputDir, onWriteCallback)),
+  );
+}
+
+function writeSingle(file: PageData, outputDir: string, onWriteCallback?: (file: PageData) => void) {
+  const ensureDirectoryExists = ({ outputDocPath }: PageData) =>
+    mkdir(path.dirname(outputDocPath), { recursive: true });
+
+  const writeContents = (file: PageData) => writeFile(file.outputDocPath, file.content, 'utf8');
+
+  return pipe(
+    resolveTargetLocation(file, outputDir),
+    (file) => TE.right(file),
+    TE.tapIO(ensureDirectoryExists),
+    TE.flatMap(writeContents),
+    TE.map(() => onWriteCallback?.(file)),
+  );
+}
+
+function resolveTargetLocation(file: PageData, outputDir: string): PageData {
+  return {
+    ...file,
+    outputDocPath: path.join(outputDir, file.outputDocPath),
+  };
 }

package/src/application/generators/markdown.ts

@@ -1,6 +1,4 @@
 import { generateDocs } from '../../core/markdown/generate-docs';
-import { FileWriter } from '../file-writer';
-import { Logger } from '#utils/logger';
 import { pipe } from 'fp-ts/function';
 import {
   PageData,
@@ -11,10 +9,11 @@ import {
 import { referenceGuideTemplate } from '../../core/markdown/templates/reference-guide';
 import * as TE from 'fp-ts/TaskEither';
 import { isSkip } from '../../core/shared/utils';
-import { ReflectionError } from '../../core/markdown/reflection/reflect-source';
+import { writeFiles } from '../file-writer';
 
 class FileWritingError {
   readonly _tag = 'FileWritingError';
+
   constructor(
     public message: string,
     public error: unknown,
@@ -25,27 +24,7 @@ export default function generate(bundles: UnparsedSourceFile[], config: UserDefi
   return pipe(
     generateDocumentationBundle(bundles, config),
     TE.flatMap((files) => writeFilesToSystem(files, config.targetDir)),
-    TE.mapLeft((error) => {
-      if (error._tag === 'HookError') {
-        Logger.error('Error(s) occurred while processing hooks. Please review the following issues:');
-        Logger.error(error.error);
-        return;
-      }
-
-      if (error._tag === 'FileWritingError') {
-        Logger.error(error.message);
-        Logger.error(error.error);
-        return;
-      }
-
-      const errorMessages = [
-        'Error(s) occurred while parsing files. Please review the following issues:',
-        ...error.errors.map(formatReflectionError),
-      ].join('\n');
-
-      Logger.error(errorMessages);
-    }),
-  )();
+  );
 }
 
 function generateDocumentationBundle(bundles: UnparsedSourceFile[], config: UserDefinedMarkdownConfig) {
@@ -56,19 +35,11 @@ function generateDocumentationBundle(bundles: UnparsedSourceFile[], config: User
 }
 
 function writeFilesToSystem(files: PostHookDocumentationBundle, outputDir: string) {
-  try {
-    FileWriter.write(
-      [files.referenceGuide, ...files.docs]
-        // Filter out any files that should be skipped
-        .filter((file) => !isSkip(file)) as PageData[],
-      outputDir,
-    );
-    return TE.right(undefined);
-  } catch (error) {
-    return TE.left(new FileWritingError('An error occurred while writing files to the system.', error));
-  }
-}
-
-function formatReflectionError(error: ReflectionError) {
-  return `Source file: ${error.file}\n${error.message}\n`;
+  return pipe(
+    [files.referenceGuide, ...files.docs].filter((file) => !isSkip(file)),
+    (files) => writeFiles(files as PageData[], outputDir),
+    TE.mapLeft((error) => {
+      return new FileWritingError('An error occurred while writing files to the system.', error);
+    }),
+  );
 }

package/src/application/generators/openapi.ts

@@ -2,15 +2,27 @@ import { createManifest } from '../../core/openapi/manifest-factory';
 import { RawBodyParser } from '../../core/openapi/parser';
 import { TypesRepository } from '../../core/openapi/types-repository';
 import Transpiler from '../../core/openapi/transpiler';
-import { FileWriter } from '../file-writer';
 import { Logger } from '#utils/logger';
 import ErrorLogger from '#utils/error-logger';
 import { reflect, ReflectionResult } from '@cparra/apex-reflection';
 import Manifest from '../../core/manifest';
 import { PageData, UnparsedSourceFile, UserDefinedOpenApiConfig } from '../../core/shared/types';
 import { OpenApiDocsProcessor } from '../../core/openapi/open-api-docs-processor';
+import { writeFiles } from '../file-writer';
+import { pipe } from 'fp-ts/function';
+import * as TE from 'fp-ts/TaskEither';
+import { OpenApiSettings } from '../../core/openApiSettings';
+
+export default async function openApi(fileBodies: UnparsedSourceFile[], config: UserDefinedOpenApiConfig) {
+  OpenApiSettings.build({
+    sourceDirectory: config.sourceDir,
+    outputDir: config.targetDir,
+    openApiFileName: config.fileName,
+    openApiTitle: config.title,
+    namespace: config.namespace,
+    version: config.apiVersion,
+  });
 
-export default function openApi(fileBodies: UnparsedSourceFile[], config: UserDefinedOpenApiConfig) {
   const manifest = createManifest(new RawBodyParser(fileBodies), reflectionWithLogger);
   TypesRepository.getInstance().populateAll(manifest.types);
   const filteredTypes = filterByScopes(manifest);
@@ -18,11 +30,15 @@ export default function openApi(fileBodies: UnparsedSourceFile[], config: UserDe
   Transpiler.generate(filteredTypes, processor);
   const generatedFiles = processor.fileBuilder().files();
 
-  FileWriter.write(generatedFiles, config.targetDir, (file: PageData) => {
-    Logger.logSingle(`${file.outputDocPath} processed.`, 'green');
-  });
+  await pipe(
+    writeFiles(generatedFiles, config.targetDir, (file: PageData) => {
+      Logger.logSingle(`${file.outputDocPath} processed.`, 'green');
+    }),
+    TE.map(() => Logger.logSingle('✔️ Documentation generated successfully!')),
+    TE.mapError((error) => Logger.error(error)),
+  )();
 
-  // Error logging
+  // Logs any errors that the types might have in their doc comment's error field
   ErrorLogger.logErrors(filteredTypes);
 }
 

package/src/cli/args.ts

@@ -3,6 +3,7 @@ import * as yargs from 'yargs';
 import { UserDefinedMarkdownConfig } from '../core/shared/types';
 import { TypeScriptLoader } from 'cosmiconfig-typescript-loader';
 import { markdownOptions } from './commands/markdown';
+import { openApiOptions } from './commands/openapi';
 
 /**
  * Extracts configuration from a configuration file or the package.json
@@ -26,7 +27,9 @@ function _extractYargs(config?: CosmiconfigResult) {
     .command('markdown', 'Generate documentation from Apex classes as a Markdown site.', (yargs) =>
       yargs.options(markdownOptions),
     )
-    .command('openapi', 'Generate an OpenApi REST specification from Apex classes.') // TODO: Add OpenApi specific options
+    .command('openapi', 'Generate an OpenApi REST specification from Apex classes.', () =>
+      yargs.options(openApiOptions),
+    )
     .demandCommand()
     .parseSync();
 }

package/src/cli/commands/markdown.ts

@@ -30,9 +30,7 @@ export const markdownOptions: { [key: string]: Options } = {
   },
   namespace: {
     type: 'string',
-    describe:
-      'The package namespace, if any. If this value is provided the namespace will be added as a prefix to all of the parsed files. ' +
-      "If generating an OpenApi definition, it will be added to the file's Server Url.",
+    describe: 'The package namespace, if any. If provided, it will be added to the generated files.',
   },
   sortMembersAlphabetically: {
     type: 'boolean',

package/src/cli/commands/openapi.ts

@@ -0,0 +1,36 @@
+import { Options } from 'yargs';
+import { defaults } from '../../defaults';
+
+export const openApiOptions: { [key: string]: Options } = {
+  sourceDir: {
+    type: 'string',
+    alias: 's',
+    demandOption: true,
+    describe: 'The directory location which contains your apex .cls classes.',
+  },
+  targetDir: {
+    type: 'string',
+    alias: 't',
+    default: defaults.targetDir,
+    describe: 'The directory location where the OpenApi file will be generated.',
+  },
+  fileName: {
+    type: 'string',
+    default: 'openapi',
+    describe: 'The name of the OpenApi file to be generated.',
+  },
+  namespace: {
+    type: 'string',
+    describe: 'The package namespace, if any. This will be added to the API file Server Url.',
+  },
+  title: {
+    type: 'string',
+    default: 'Apex REST API',
+    describe: 'The title of the OpenApi file.',
+  },
+  apiVersion: {
+    type: 'string',
+    default: '1.0.0',
+    describe: 'The version of the OpenApi file.',
+  },
+};