From f27f1711c7e51e6f2032c352f035c4c71a34574d Mon Sep 17 00:00:00 2001 From: Kanad Gupta Date: Wed, 2 Aug 2023 15:51:01 -0500 Subject: [PATCH] fix: typo --- README.md | 2 +- __tests__/cmds/openapi/__snapshots__/inspect.test.ts.snap | 6 +++--- src/cmds/openapi/inspect.ts | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 453d753bb..61aa2640b 100644 --- a/README.md +++ b/README.md @@ -172,7 +172,7 @@ The following examples use JSON files, but `rdme` supports API Definitions that > [!NOTE] > The `rdme openapi` command supports both OpenAPI and Swagger API definitions. The `rdme swagger` command is an alias for `rdme openapi` and is deprecated. -If you wish to programmatically access any of this script's results (such as the API defintion ID or the link to the corresponding docs in your dashboard), supply the `--raw` flag and the command will return a JSON output. +If you wish to programmatically access any of this script's results (such as the API definition ID or the link to the corresponding docs in your dashboard), supply the `--raw` flag and the command will return a JSON output. This command also has a dry run mode, which can be useful for initial setup and debugging. You can perform a dry run by supplying the `--dryRun` flag. diff --git a/__tests__/cmds/openapi/__snapshots__/inspect.test.ts.snap b/__tests__/cmds/openapi/__snapshots__/inspect.test.ts.snap index 8da2ec7a9..c679f9e75 100644 --- a/__tests__/cmds/openapi/__snapshots__/inspect.test.ts.snap +++ b/__tests__/cmds/openapi/__snapshots__/inspect.test.ts.snap @@ -137,7 +137,7 @@ x-readme.samples-languages: You do not use this." `; exports[`rdme openapi:inspect full reports should generate a report for @readme/oas-examples/3.0/json/petstore.json 1`] = ` -"Here are some interesting things we found in your API defintion. 🕵️ +"Here are some interesting things we found in your API definition. 🕵️ · You are using 4 Media Types throughout your API: application/json, application/x-www-form-urlencoded, application/xml, and multipart/form-data · You have a total of 20 Operations in your API. @@ -247,7 +247,7 @@ ReadMe-Specific Features and Extensions `; exports[`rdme openapi:inspect full reports should generate a report for @readme/oas-examples/3.0/json/readme.json 1`] = ` -"Here are some interesting things we found in your API defintion. 🕵️ +"Here are some interesting things we found in your API definition. 🕵️ · You are using 2 Media Types throughout your API: application/json and multipart/form-data · You have a total of 36 Operations in your API. @@ -357,7 +357,7 @@ ReadMe-Specific Features and Extensions `; exports[`rdme openapi:inspect full reports should generate a report for @readme/oas-examples/3.0/json/readme-extensions.json 1`] = ` -"Here are some interesting things we found in your API defintion. 🕵️ +"Here are some interesting things we found in your API definition. 🕵️ · You are using a single Media Type throughout your API: application/json · You have a total of 12 Operations in your API. diff --git a/src/cmds/openapi/inspect.ts b/src/cmds/openapi/inspect.ts index f06df89fa..977245d70 100644 --- a/src/cmds/openapi/inspect.ts +++ b/src/cmds/openapi/inspect.ts @@ -143,7 +143,7 @@ export default class OpenAPIInspectCommand extends Command { } buildFullReport(analysis: Analysis) { - const report: string[] = ['Here are some interesting things we found in your API defintion. 🕵️', '']; + const report: string[] = ['Here are some interesting things we found in your API definition. 🕵️', '']; // General API definition statistics Object.entries(analysis.general).forEach(([, info]) => {