docs(openapi): add postman warning

src/cmds/openapi/validate.ts

@@ -44,6 +44,7 @@ export default class OpenAPIValidateCommand extends Command {
     }
 
     const { specPath, specType } = await prepareOas(spec, 'openapi:validate');
+
     return Promise.resolve(chalk.green(`${specPath} is a valid ${specType} API definition!`)).then(msg =>
       createGHA(msg, this.command, this.args, { ...opts, spec: specPath } as ZeroAuthCommandOptions<Options>),
     );

src/lib/prepareOas.ts

@@ -5,7 +5,7 @@ import OASNormalize, { getAPIDefinitionType } from 'oas-normalize';
 import ora from 'ora';
 
 import isCI from './isCI.js';
-import { debug, info, oraOptions } from './logger.js';
+import { debug, info, warn, oraOptions } from './logger.js';
 import promptTerminal from './promptWrapper.js';
 import readdirRecursive from './readdirRecursive.js';
 
@@ -211,6 +211,34 @@ export default async function prepareOas(
     debug('spec bundled');
   }
 
+  // Checks to see if the selected file is a postman collection and throws a warning in the console depending on the command.
+  if (definitionVersion.specification === 'postman') {
+    switch (command) {
+      case 'openapi':
+        warn(
+          'You are attempting to upload a Postman collection. This feature is currently experimental. For more information, visit our docs here: https://docs.readme.com/main/docs/openapi#the-api-reference',
+        );
+        break;
+      case 'openapi:validate':
+        warn(
+          'You are attempting to validate a Postman collection. This feature is currently experimental. For more information, visit our docs here: https://docs.readme.com/main/docs/openapi#the-api-reference',
+        );
+        break;
+      case 'openapi:inspect':
+        warn(
+          'You are inspecting a Postman collection. This feature is currently experimental. For more information, visit our docs here: https://docs.readme.com/main/docs/openapi#the-api-reference',
+        );
+        break;
+      case 'openapi:convert':
+        warn(
+          'You are attempting to convert a Postman collection to an OpenAPI file. This feature is currently experimental. For more information, visit our docs here: https://docs.readme.com/main/docs/openapi#the-api-reference',
+        );
+        break;
+      default:
+        debug(`Type ${chalk.yellow('rdme help')} to see all commands`);
+    }
+  }
+
   return {
     preparedSpec: JSON.stringify(api),
     /** A string indicating whether the spec file is a local path, a URL, etc. */