@apimatic/cli 0.0.0-alpha.2

package/README.md

@@ -0,0 +1,258 @@
+@apimatic/cli
+=============
+
+The official CLI for APIMatic.
+
+[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
+[![Version](https://img.shields.io/npm/v/@apimatic/cli.svg)](https://npmjs.org/package/@apimatic/cli)
+[![Downloads/week](https://img.shields.io/npm/dw/@apimatic/cli.svg)](https://npmjs.org/package/@apimatic/cli)
+[![License](https://img.shields.io/npm/l/@apimatic/cli.svg)](https://github.com/apimatic/apimatic-cli/blob/master/package.json)
+
+<!-- toc -->
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+# Usage
+<!-- usage -->
+```sh-session
+$ npm install -g @apimatic/cli
+$ apimatic COMMAND
+running command...
+$ apimatic (-v|--version|version)
+@apimatic/cli/0.0.0-alpha.2 linux-x64 node-v16.13.0
+$ apimatic --help [COMMAND]
+USAGE
+  $ apimatic COMMAND
+...
+```
+<!-- usagestop -->
+
+# Commands
+<!-- commands -->
+* [`apimatic api:transform`](#apimatic-apitransform)
+* [`apimatic api:validate`](#apimatic-apivalidate)
+* [`apimatic auth:login`](#apimatic-authlogin)
+* [`apimatic auth:logout`](#apimatic-authlogout)
+* [`apimatic auth:status`](#apimatic-authstatus)
+* [`apimatic autocomplete [SHELL]`](#apimatic-autocomplete-shell)
+* [`apimatic help [COMMAND]`](#apimatic-help-command)
+* [`apimatic portal:generate`](#apimatic-portalgenerate)
+* [`apimatic sdk:generate`](#apimatic-sdkgenerate)
+
+## `apimatic api:transform`
+
+Transform API specifications from one format to another. Supports [10+ different formats](https://www.apimatic.io/transformer/#supported-formats) including OpenApi/Swagger, RAML, WSDL and Postman Collections.
+
+```
+USAGE
+  $ apimatic api:transform
+
+OPTIONS
+  -f, --force                overwrite if same file exist in the destination
+  --auth-key=auth-key        override current authentication state with an authentication key
+
+  --destination=destination  [default: /home/runner/work/apimatic-cli/apimatic-cli/cli] directory to download
+                             transformed file to
+
+  --file=file                path to the API specification file to transform
+
+  --format=format            (required) specification format to transform API specification into
+                             APIMATIC|WADL2009|WSDL|SWAGGER10|SWAGGER20|SWAGGERYAML|OAS3|OPENAPI3YAML|APIBLUEPRINT|RAML|
+                             RAML10|POSTMAN10|POSTMAN20|GRAPHQLSCHEMA
+
+  --url=url                  URL to the API specification file to transform. Can be used in place of the --file option
+                             if the API specification is publicly available.
+
+EXAMPLES
+  $ apimatic api:transform --format="OpenApi3Json" --file="./specs/sample.json" --destination="D:/"
+  Success! Your transformed file is located at D:/Transformed_OpenApi3Json.json
+
+  $ apimatic api:transform --format=RAML --url="https://petstore.swagger.io/v2/swagger.json"  --destination="D:/"
+  Success! Your transformed file is located at D:/swagger_raml.yaml
+```
+
+_See code: [src/commands/api/transform.ts](https://github.com/apimatic/apimatic-cli/blob/v0.0.0-alpha.2/src/commands/api/transform.ts)_
+
+## `apimatic api:validate`
+
+Validate the syntactic and semantic correctness of an API specification
+
+```
+USAGE
+  $ apimatic api:validate
+
+OPTIONS
+  --auth-key=auth-key  override current authentication state with an authentication key
+  --file=file          Path to the API specification file to validate
+
+  --url=url            URL to the specification file to validate. Can be used in place of the --file option if the API
+                       specification is publicly available.
+
+EXAMPLES
+  $ apimatic api:validate --file="./specs/sample.json"
+  Specification file provided is valid
+
+  $ apimatic api:validate --url=https://petstore.swagger.io/v2/swagger.json
+  Specification file provided is valid
+```
+
+_See code: [src/commands/api/validate.ts](https://github.com/apimatic/apimatic-cli/blob/v0.0.0-alpha.2/src/commands/api/validate.ts)_
+
+## `apimatic auth:login`
+
+Login using your APIMatic credentials or an API Key
+
+```
+USAGE
+  $ apimatic auth:login
+
+OPTIONS
+  --auth-key=auth-key  Set authentication key for all commands
+
+EXAMPLES
+  $ apimatic auth:login
+  Please enter your registered email: apimatic-user@gmail.com
+  Please enter your password: *********
+
+  You have successfully logged into APIMatic
+
+  $ apimatic auth:login --auth-key=xxxxxx
+  Authentication key successfully set
+```
+
+_See code: [src/commands/auth/login.ts](https://github.com/apimatic/apimatic-cli/blob/v0.0.0-alpha.2/src/commands/auth/login.ts)_
+
+## `apimatic auth:logout`
+
+Clear local login credentials
+
+```
+USAGE
+  $ apimatic auth:logout
+
+EXAMPLE
+  $ apimatic auth:logout
+  Logged out
+```
+
+_See code: [src/commands/auth/logout.ts](https://github.com/apimatic/apimatic-cli/blob/v0.0.0-alpha.2/src/commands/auth/logout.ts)_
+
+## `apimatic auth:status`
+
+View current authentication state
+
+```
+USAGE
+  $ apimatic auth:status
+
+EXAMPLE
+  $ apimatic auth:status
+  Currently logged in as apimatic-client@gmail.com
+```
+
+_See code: [src/commands/auth/status.ts](https://github.com/apimatic/apimatic-cli/blob/v0.0.0-alpha.2/src/commands/auth/status.ts)_
+
+## `apimatic autocomplete [SHELL]`
+
+display autocomplete installation instructions
+
+```
+USAGE
+  $ apimatic autocomplete [SHELL]
+
+ARGUMENTS
+  SHELL  shell type
+
+OPTIONS
+  -r, --refresh-cache  Refresh cache (ignores displaying instructions)
+
+EXAMPLES
+  $ apimatic autocomplete
+  $ apimatic autocomplete bash
+  $ apimatic autocomplete zsh
+  $ apimatic autocomplete --refresh-cache
+```
+
+_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v0.3.0/src/commands/autocomplete/index.ts)_
+
+## `apimatic help [COMMAND]`
+
+display help for apimatic
+
+```
+USAGE
+  $ apimatic help [COMMAND]
+
+ARGUMENTS
+  COMMAND  command to show help for
+
+OPTIONS
+  --all  see all commands in CLI
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.14/src/commands/help.ts)_
+
+## `apimatic portal:generate`
+
+Generate and download a static API Documentation portal. Requires an input directory containing API specifications, a config file and optionally, markdown guides. For details, refer to the [documentation](https://portal-api-docs.apimatic.io/#/http/generating-api-portal/build-file)
+
+```
+USAGE
+  $ apimatic portal:generate
+
+OPTIONS
+  -f, --force                overwrite if a portal exists in the destination
+  --auth-key=auth-key        override current authentication state with an authentication key
+  --destination=destination  [default: /home/runner/work/apimatic-cli/apimatic-cli/cli] path to the downloaded portal
+  --folder=folder            [default: ./] path to the input directory containing API specifications and config files
+  --zip                      download the generated portal as a .zip archive
+
+EXAMPLE
+  $ apimatic portal:generate --folder="./portal/" --destination="D:/"
+  Your portal has been generated at D:/
+```
+
+_See code: [src/commands/portal/generate.ts](https://github.com/apimatic/apimatic-cli/blob/v0.0.0-alpha.2/src/commands/portal/generate.ts)_
+
+## `apimatic sdk:generate`
+
+Generate SDK for your APIs
+
+```
+USAGE
+  $ apimatic sdk:generate
+
+OPTIONS
+  -f, --force                overwrite if an SDK already exists in the destination
+  --auth-key=auth-key        override current authentication state with an authentication key
+
+  --destination=destination  [default: /home/runner/work/apimatic-cli/apimatic-cli/cli] directory to download the
+                             generated SDK to
+
+  --file=file                path to the API specification to generate SDKs for
+
+  --platform=platform        (required) language platform for sdk
+                             Simple: CSHARP|JAVA|PYTHON|RUBY|PHP|TYPESCRIPT
+                             Legacy: CS_NET_STANDARD_LIB|CS_PORTABLE_NET_LIB|CS_UNIVERSAL_WINDOWS_PLATFORM_LIB|
+                             JAVA_ECLIPSE_JRE_LIB|PHP_GENERIC_LIB|PYTHON_GENERIC_LIB|RUBY_GENERIC_LIB|
+                             TS_GENERIC_LIB
+
+  --url=url                  URL to the API specification to generate SDKs for. Can be used in place of the --file
+                             option if the API specification is publicly available.
+
+  --zip                      download the generated SDK as a .zip archive
+
+EXAMPLES
+  $ apimatic sdk:generate --platform="CSHARP" --file="./specs/sample.json"
+  Generating SDK... done
+  Downloading SDK... done
+  Success! Your SDK is located at swagger_sdk_csharp
+
+  $ apimatic sdk:generate --platform="CSHARP" --url=https://petstore.swagger.io/v2/swagger.json
+  Generating SDK... done
+  Downloading SDK... done
+  Success! Your SDK is located at swagger_sdk_csharp
+```
+
+_See code: [src/commands/sdk/generate.ts](https://github.com/apimatic/apimatic-cli/blob/v0.0.0-alpha.2/src/commands/sdk/generate.ts)_
+<!-- commandsstop -->

package/bin/run

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+/* eslint-disable no-undef */
+/* eslint-disable @typescript-eslint/no-var-requires */
+
+require("@oclif/command").run().then(require("@oclif/command/flush")).catch(require("@oclif/errors/handle"));

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/lib/client-utils/auth-manager.d.ts

@@ -0,0 +1,17 @@
+export declare type AuthInfo = {
+    email: string;
+    authKey: string;
+};
+/**
+ *
+ * @param {string} configDir <- Directory with user configuration
+ * //Function to get credentials
+ */
+export declare function getAuthInfo(configDir: string): Promise<AuthInfo | null>;
+/**
+ *
+ * @param {AuthInfo} credentials
+ * @param {string} configDir <- Directory with user configuration
+ * //Function to set credentials.
+ */
+export declare function setAuthInfo(credentials: AuthInfo, configDir: string): Promise<void>;

package/lib/client-utils/auth-manager.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setAuthInfo = exports.getAuthInfo = void 0;
+const fs = require("fs-extra");
+const path = require("path");
+/**
+ *
+ * @param {string} configDir <- Directory with user configuration
+ * //Function to get credentials
+ */
+async function getAuthInfo(configDir) {
+    try {
+        const data = JSON.parse(await fs.readFile(path.join(configDir, "config.json"), "utf8"));
+        return data;
+    }
+    catch (e) {
+        return null;
+    }
+}
+exports.getAuthInfo = getAuthInfo;
+/**
+ *
+ * @param {AuthInfo} credentials
+ * @param {string} configDir <- Directory with user configuration
+ * //Function to set credentials.
+ */
+async function setAuthInfo(credentials, configDir) {
+    const configFilePath = path.join(configDir, "config.json");
+    if (!fs.existsSync(configFilePath))
+        fs.createFileSync(configFilePath);
+    return await fs.writeFile(configFilePath, JSON.stringify(credentials));
+}
+exports.setAuthInfo = setAuthInfo;

package/lib/client-utils/sdk-client.d.ts

@@ -0,0 +1,23 @@
+import { Client } from "@apimatic/sdk";
+export declare class SDKClient {
+    private static instance;
+    private static authAPI;
+    static client: Client;
+    /**
+     * The static method that controls the access to the SDKClient instance.
+     *
+     * This implementation let you subclass the SDKClient class while keeping
+     * just one instance of each subclass around.
+     */
+    static getInstance(): SDKClient;
+    /**
+     * Finally, any SDKClient should define some business logic, which can be
+     * executed on its instance.
+     */
+    login(email: string, password: string, configDir: string): Promise<string>;
+    logout(configDir: string): Promise<string>;
+    status(configDir: string): Promise<string>;
+    getClient(overrideAuthKey: string | null, configDir: string): Promise<Client>;
+    private getAuthKey;
+    setAuthKey: (authKey: string, configDir: string) => string;
+}

package/lib/client-utils/sdk-client.js

@@ -0,0 +1,119 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SDKClient = void 0;
+const base64 = require("base-64");
+const axios_1 = require("axios");
+const sdk_1 = require("@apimatic/sdk");
+const auth_manager_1 = require("./auth-manager");
+const env_1 = require("../config/env");
+class SDKClient {
+    constructor() {
+        this.setAuthKey = (authKey, configDir) => {
+            auth_manager_1.setAuthInfo({
+                email: "",
+                authKey
+            }, configDir);
+            return "Authentication key successfully set";
+        };
+    }
+    /**
+     * The static method that controls the access to the SDKClient instance.
+     *
+     * This implementation let you subclass the SDKClient class while keeping
+     * just one instance of each subclass around.
+     */
+    static getInstance() {
+        if (!SDKClient.instance) {
+            SDKClient.instance = new SDKClient();
+        }
+        return SDKClient.instance;
+    }
+    /**
+     * Finally, any SDKClient should define some business logic, which can be
+     * executed on its instance.
+     */
+    async login(email, password, configDir) {
+        let storedAuthInfo = await auth_manager_1.getAuthInfo(configDir);
+        // If no config file or no credentials exist in the config file
+        if (!storedAuthInfo) {
+            storedAuthInfo = { email: "", authKey: "" };
+        }
+        const credentials = { email, password };
+        const authKey = await this.getAuthKey(credentials);
+        if (storedAuthInfo.email !== email) {
+            auth_manager_1.setAuthInfo({
+                email,
+                authKey
+            }, configDir);
+            return "Logged in";
+        }
+        else if (authKey === storedAuthInfo.authKey) {
+            return "Already logged in";
+        }
+        else {
+            auth_manager_1.setAuthInfo({
+                email,
+                authKey
+            }, configDir);
+            return "Logged in";
+        }
+    }
+    async logout(configDir) {
+        auth_manager_1.setAuthInfo({
+            email: "",
+            authKey: ""
+        }, configDir);
+        return "Logged out";
+    }
+    async status(configDir) {
+        try {
+            let storedAuthInfo = await auth_manager_1.getAuthInfo(configDir);
+            if (!storedAuthInfo) {
+                // If no config file or no credentials exist in the config file
+                storedAuthInfo = { email: "", authKey: "" };
+            }
+            return storedAuthInfo.email === "" && storedAuthInfo.authKey === ""
+                ? "Not logged in"
+                : storedAuthInfo.email === "" && storedAuthInfo.authKey !== ""
+                    ? "Logged in with authentication key"
+                    : `Currently logged in as ${storedAuthInfo.email}`;
+        }
+        catch (error) {
+            throw error;
+        }
+    }
+    async getClient(overrideAuthKey, configDir) {
+        if (overrideAuthKey) {
+            return new sdk_1.Client({
+                timeout: 0,
+                authorization: `X-Auth-Key ${overrideAuthKey}`
+            });
+        }
+        let storedAuthInfo = await auth_manager_1.getAuthInfo(configDir);
+        if (!storedAuthInfo) {
+            // If no config file or no credentials exist in the config file
+            storedAuthInfo = { email: "", authKey: "" };
+        }
+        if (storedAuthInfo.authKey !== "") {
+            return new sdk_1.Client({
+                timeout: 0,
+                authorization: `X-Auth-Key ${storedAuthInfo.authKey}`
+            });
+        }
+        else {
+            throw new Error("Please login first or provide an authKey");
+        }
+    }
+    async getAuthKey(credentials) {
+        const config = {
+            headers: {
+                Authorization: `Basic ${base64.encode(`${credentials.email}:${credentials.password}`)}`
+            }
+        };
+        const response = await axios_1.default.get(SDKClient.authAPI, config);
+        const authKey = response.data.EncryptedValue;
+        return authKey;
+    }
+}
+exports.SDKClient = SDKClient;
+SDKClient.authAPI = `${env_1.baseURL}/account/authkey`;

package/lib/commands/api/transform.d.ts

@@ -0,0 +1,14 @@
+import { flags, Command } from "@oclif/command";
+export default class Transform extends Command {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        format: flags.IOptionFlag<string>;
+        file: flags.IOptionFlag<string>;
+        url: flags.IOptionFlag<string>;
+        destination: flags.IOptionFlag<string>;
+        force: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
+        "auth-key": flags.IOptionFlag<string | undefined>;
+    };
+    run(): Promise<void>;
+}

package/lib/commands/api/transform.js

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs = require("fs-extra");
+const path = require("path");
+const sdk_1 = require("@apimatic/sdk");
+const command_1 = require("@oclif/command");
+const sdk_client_1 = require("../../client-utils/sdk-client");
+const utils_1 = require("../../utils/utils");
+const transform_1 = require("../../types/api/transform");
+const transform_2 = require("../../controllers/api/transform");
+const formats = Object.keys(sdk_1.ExportFormats).join("|");
+class Transform extends command_1.Command {
+    async run() {
+        const { flags } = this.parse(Transform);
+        const fileName = flags.file ? utils_1.getFileNameFromPath(flags.file) : utils_1.getFileNameFromPath(flags.url);
+        const destinationFormat = transform_1.DestinationFormats[flags.format];
+        const destinationFilePath = path.join(flags.destination, `${fileName}_${flags.format}.${destinationFormat}`.toLowerCase());
+        // Check if destination file already exist and throw error if force flag is not set
+        if (fs.existsSync(destinationFilePath) && !flags.force) {
+            throw new Error(`Can't download transformed file to path ${destinationFilePath}, because it already exists`);
+        }
+        try {
+            // Check if paths provided are valid
+            if (flags.file && !(await fs.pathExists(flags.file))) {
+                throw new Error(`Transformation file: ${flags.file} does not exist`);
+            }
+            else if (!(await fs.pathExists(flags.destination))) {
+                throw new Error(`Destination path: ${flags.destination} does not exist`);
+            }
+            const overrideAuthKey = flags["auth-key"] ? flags["auth-key"] : null;
+            const client = await sdk_client_1.SDKClient.getInstance().getClient(overrideAuthKey, this.config.configDir);
+            const transformationController = new sdk_1.TransformationController(client);
+            const { id, apiValidationSummary } = await transform_2.getTransformationId(flags, transformationController);
+            transform_2.printValidationMessages(apiValidationSummary, this.warn, this.error);
+            const savedTransformationFile = await transform_2.downloadTransformationFile({
+                id,
+                destinationFilePath,
+                transformationController
+            });
+            this.log(`Success! Your transformed file is located at ${savedTransformationFile}`);
+        }
+        catch (error) {
+            if (error.result) {
+                const apiError = error;
+                // TODO: Hopefully, this type-cast won't be necessary when the SDK is
+                // updated to throw the right exception type for this status code.
+                const result = apiError.result;
+                if (apiError.statusCode === 422 && result && "errors" in result && Array.isArray(result.errors)) {
+                    this.error(utils_1.replaceHTML(`${result.errors}`));
+                }
+                else if (apiError.statusCode === 422 && apiError.body && typeof apiError.body === "string") {
+                    this.error(JSON.parse(apiError.body)["dto.FileUrl"][0]);
+                }
+                else if (apiError.statusCode === 401 && apiError.body && typeof apiError.body === "string") {
+                    this.error(apiError.body);
+                }
+                else if (apiError.statusCode === 500) {
+                    this.error(apiError.message);
+                }
+            }
+            else if (error.statusCode === 401 &&
+                error.body &&
+                typeof error.body === "string") {
+                this.error(error.body);
+            }
+            else {
+                this.error(`${error.message}`);
+            }
+        }
+    }
+}
+exports.default = Transform;
+Transform.description = `Transform API specifications from one format to another. Supports [10+ different formats](https://www.apimatic.io/transformer/#supported-formats) including OpenApi/Swagger, RAML, WSDL and Postman Collections.`;
+Transform.examples = [
+    `$ apimatic api:transform --format="OpenApi3Json" --file="./specs/sample.json" --destination="D:/"
+Success! Your transformed file is located at D:/Transformed_OpenApi3Json.json
+`,
+    `$ apimatic api:transform --format=RAML --url="https://petstore.swagger.io/v2/swagger.json"  --destination="D:/"
+Success! Your transformed file is located at D:/swagger_raml.yaml
+`
+];
+Transform.flags = {
+    format: command_1.flags.string({
+        parse: (format) => transform_2.getValidFormat(format.toUpperCase()),
+        required: true,
+        description: `specification format to transform API specification into
+${formats}`
+    }),
+    file: command_1.flags.string({
+        parse: (input) => path.resolve(input),
+        default: "",
+        description: "path to the API specification file to transform"
+    }),
+    url: command_1.flags.string({
+        default: "",
+        description: "URL to the API specification file to transform. Can be used in place of the --file option if the API specification is publicly available."
+    }),
+    destination: command_1.flags.string({
+        parse: (input) => path.resolve(input),
+        default: path.resolve("./"),
+        description: "directory to download transformed file to"
+    }),
+    force: command_1.flags.boolean({ char: "f", default: false, description: "overwrite if same file exist in the destination" }),
+    "auth-key": command_1.flags.string({ description: "override current authentication state with an authentication key" })
+};

package/lib/commands/api/validate.d.ts

@@ -0,0 +1,11 @@
+import { flags, Command } from "@oclif/command";
+export default class Validate extends Command {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        file: flags.IOptionFlag<string>;
+        url: flags.IOptionFlag<string>;
+        "auth-key": flags.IOptionFlag<string | undefined>;
+    };
+    run(): Promise<void>;
+}

package/lib/commands/api/validate.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs = require("fs-extra");
+const sdk_1 = require("@apimatic/sdk");
+const command_1 = require("@oclif/command");
+const sdk_client_1 = require("../../client-utils/sdk-client");
+const utils_1 = require("../../utils/utils");
+const transform_1 = require("../../controllers/api/transform");
+const validate_1 = require("../../controllers/api/validate");
+class Validate extends command_1.Command {
+    async run() {
+        const { flags } = this.parse(Validate);
+        try {
+            if (flags.file && !(await fs.pathExists(flags.file))) {
+                throw new Error(`Validation file: ${flags.file} does not exist`);
+            }
+            const overrideAuthKey = flags["auth-key"] ? flags["auth-key"] : null;
+            const client = await sdk_client_1.SDKClient.getInstance().getClient(overrideAuthKey, this.config.configDir);
+            const apiValidationController = new sdk_1.APIValidationExternalApisController(client);
+            const validationSummary = await validate_1.getValidation(flags, apiValidationController);
+            transform_1.printValidationMessages(validationSummary, this.warn, this.error);
+            validationSummary.success
+                ? this.log("Specification file provided is valid")
+                : this.error("Specification file provided is invalid");
+        }
+        catch (error) {
+            if (error.result) {
+                const apiError = error;
+                const result = apiError.result;
+                if (result.modelState["exception Error"] && apiError.statusCode === 400) {
+                    this.error(utils_1.replaceHTML(result.modelState["exception Error"][0]));
+                }
+                else if (error.body && apiError.statusCode === 401) {
+                    this.error(error.body);
+                }
+                else {
+                    this.error(error.message);
+                }
+            }
+            else {
+                this.error(`${error.message}`);
+            }
+        }
+    }
+}
+exports.default = Validate;
+Validate.description = "Validate the syntactic and semantic correctness of an API specification";
+Validate.examples = [
+    `$ apimatic api:validate --file="./specs/sample.json"
+Specification file provided is valid
+`,
+    `$ apimatic api:validate --url=https://petstore.swagger.io/v2/swagger.json
+Specification file provided is valid
+`
+];
+Validate.flags = {
+    file: command_1.flags.string({ default: "", description: "Path to the API specification file to validate" }),
+    url: command_1.flags.string({
+        default: "",
+        description: "URL to the specification file to validate. Can be used in place of the --file option if the API specification is publicly available."
+    }),
+    // docs: flags.boolean({ default: false, description: "Validate specification for docs generation" }), // Next tier, not included in API spec
+    "auth-key": command_1.flags.string({ description: "override current authentication state with an authentication key" })
+};

package/lib/commands/auth/login.d.ts

@@ -0,0 +1,9 @@
+import { flags, Command } from "@oclif/command";
+export default class Login extends Command {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        "auth-key": flags.IOptionFlag<string>;
+    };
+    run(): Promise<void>;
+}