Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: typo #852

Merged
merged 1 commit into from
Aug 2, 2023
Merged

fix: typo #852

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
6 changes: 3 additions & 3 deletions __tests__/cmds/openapi/__snapshots__/inspect.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion src/cmds/openapi/inspect.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]) => {
Expand Down