Fix OpenAPI typos and branding (#268)

zuplo · Jul 31, 2024 · 1e1be66 · 1e1be66
1 parent 8595d9e
commit 1e1be66
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 <p align="center">
   <a href="https://ratemyopenapi.com/">
     <img src="https://cdn.zuplo.com/static/logos/logo.svg" height="50">
-    <h1 align="center">Rate My Open API</h1>
+    <h1 align="center">Rate My OpenAPI</h1>
   </a>
 </p>
 
@@ -30,7 +30,7 @@ It's what's commonly known as the OpenAPI lifecycle, which looks like this:
   <img style="width:50%" src="assets/openapi-lifecycle-dark.png#gh-dark-mode-only" />
 </div>
 
-## Rate My Open API
+## Rate My OpenAPI
 
 At Zuplo we believe that the better the quality of an OpenAPI document, the
 better the developer experience will be for the consumers of that API. This

diff --git a/apps/web/README.md b/apps/web/README.md
@@ -1,4 +1,4 @@
-# Rate My Open API
+# Rate My OpenAPI
 
 Deployed URL: https://ratemyopenapi.com
 

diff --git a/apps/web/src/app/og/[reportId]/route.tsx b/apps/web/src/app/og/[reportId]/route.tsx
@@ -31,7 +31,7 @@ export async function GET(
             tw="absolute z-[-1]"
             width="1200"
             height="630"
-            alt="Rate My Open API"
+            alt="Rate My OpenAPI"
             src={`https://cdn.zuplo.com/assets/517742cf-0c08-448c-8f81-18b03c3a7144.png`}
           />
           <div tw="flex ml-100 mt-30 items-center">

diff --git a/packages/cli/README.md b/packages/cli/README.md
@@ -1,14 +1,8 @@
 # Rate My OpenAPI CLI
 
-<p align="center">
-  <a href="https://ratemyopenapi.com/">
-    <img src="https://cdn.zuplo.com/static/logos/logo.svg" height="70">
-  </a>
-</p>
-
-At Zuplo we believe that the better the quality of an OpenAPI document, the
-better the developer experience will be for the consumers of that API. This
-experience is important for the success of an API.
+At [Zuplo](https://www.zuplo.com) we believe that the better the quality of an
+OpenAPI document, the better the developer experience will be for the consumers
+of that API. This experience is important for the success of an API.
 
 Rate My OpenAPI is a suite of tools designed to help software developers using
 OpenAPI to meet high standards of quality and usability when designing and
@@ -37,7 +31,9 @@ the use of an API Key. You can sign up for free at
 [https://api.ratemyopenapi.com/docs](https://api.ratemyopenapi.com/docs) to get
 your API Key.
 
-> CAUTION: All reports generated by Rate My OpenAPI are public (with an unguessable UUID URL), even if uploaded with an API Key. Anyone with the URL to your report will be able to access the report.
+> CAUTION: All reports generated by Rate My OpenAPI are public (with an
+> unguessable UUID URL), even if uploaded with an API Key. Anyone with the URL
+> to your report will be able to access the report.
 
 ### Basic
 
@@ -73,7 +69,7 @@ Options:
   --help           Show help                                           [boolean]
   --api-key        Your Rate My OpenAPI API Key              [string] [required]
   --filename       The OpenApi file name to process          [string] [required]
-  --dir            The directory containing your Open API file
+  --dir            The directory containing your OpenAPI file
                                                          [string] [default: "."]
   --output         default, json                   [string] [default: "default"]
   --max-warnings   The maximum number of warnings allowed before labeling the ru

diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -2,7 +2,7 @@
   "name": "rmoa",
   "version": "0.0.0",
   "type": "module",
-  "description": "The command-line interface for Rate My Open API",
+  "description": "The command-line interface for Rate My OpenAPI",
   "scripts": {
     "build": "tsc --build",
     "lint": "eslint --cache --fix ."

diff --git a/packages/cli/src/cmds/lint.ts b/packages/cli/src/cmds/lint.ts
@@ -19,7 +19,7 @@ export default {
       })
       .option("dir", {
         type: "string",
-        describe: "The directory containing your Open API file",
+        describe: "The directory containing your OpenAPI file",
         default: ".",
         normalize: true,
       })

diff --git a/packages/cli/src/sync-report/handler.ts b/packages/cli/src/sync-report/handler.ts
@@ -18,7 +18,7 @@ const okMark = "\x1b[32m✔\x1b[0m";
 const failMark = "\x1b[31m✖\x1b[0m";
 
 export async function syncReport(argv: SyncReportArguments) {
-  printDiagnosticsToConsole(`Rate Open API file ${argv.filename}`);
+  printDiagnosticsToConsole(`Rate OpenAPI file ${argv.filename}`);
   printDiagnosticsToConsole(`Press Ctrl+C to cancel.\n`);
   const spinner = ora().start();
   spinner.text = "Loading file for processing";
@@ -38,7 +38,7 @@ export async function syncReport(argv: SyncReportArguments) {
   if (!existsSync(openApiFilePath)) {
     spinner.stopAndPersist({ symbol: failMark });
     printCriticalFailureToConsoleAndExit(
-      `The Open API file path provided does not exist: ${argv.filename}. Please specify an existing Open API file and try again.`,
+      `The OpenAPI file path provided does not exist: ${argv.filename}. Please specify an existing OpenAPI file and try again.`,
     );
   }
   spinner.stopAndPersist({ symbol: okMark });