fix: inconsistent API spelling in docs and dashboard (#2275)

* Fix incorrect error code for UNAUTHORIZED error * fix : ratelimit sdk docs * fix(docs): standardize spelling of "API" in dashboard and documentation
unkeyed · Oct 8, 2024 · edbeb2d · edbeb2d
1 parent 78ebf18
commit edbeb2d
Show file tree

Hide file tree

Showing 7 changed files with 12 additions and 12 deletions.
diff --git a/apps/api/src/pkg/hono/app.ts b/apps/api/src/pkg/hono/app.ts
@@ -29,7 +29,7 @@ export function newApp() {
   app.doc("/openapi.json", {
     openapi: "3.0.0",
     info: {
-      title: "Unkey Api",
+      title: "Unkey API",
       version: "1.0.0",
     },
 

diff --git a/apps/dashboard/app/(app)/apis/[apiId]/settings/page.tsx b/apps/dashboard/app/(app)/apis/[apiId]/settings/page.tsx
@@ -63,7 +63,7 @@ export default async function SettingsPage(props: Props) {
       <UpdateIpWhitelist api={api} workspace={workspace} />
       <Card>
         <CardHeader>
-          <CardTitle>Api ID</CardTitle>
+          <CardTitle>API ID</CardTitle>
           <CardDescription>This is your api id. It's used in some API calls.</CardDescription>
         </CardHeader>
         <CardContent>

diff --git a/apps/dashboard/app/(app)/apis/[apiId]/settings/update-api-name.tsx b/apps/dashboard/app/(app)/apis/[apiId]/settings/update-api-name.tsx
@@ -63,9 +63,9 @@ export const UpdateApiName: React.FC<Props> = ({ api }) => {
     <form onSubmit={form.handleSubmit(onSubmit)}>
       <Card>
         <CardHeader>
-          <CardTitle>Api Name</CardTitle>
+          <CardTitle>API Name</CardTitle>
           <CardDescription>
-            Api names are not customer facing. Choose a name that makes it easy to recognize for
+            API names are not customer facing. Choose a name that makes it easy to recognize for
             you.
           </CardDescription>
         </CardHeader>

diff --git a/apps/dashboard/components/dashboard/api-key-table/index.tsx b/apps/dashboard/components/dashboard/api-key-table/index.tsx
@@ -262,7 +262,7 @@ export const ApiKeyTable: React.FC<Props> = ({ data }) => {
                 </DialogTrigger>
                 <DialogContent className="sm:max-w-[425px]">
                   <DialogHeader>
-                    <DialogTitle>Revoke Api Key</DialogTitle>
+                    <DialogTitle>Revoke API Key</DialogTitle>
                     <DialogDescription>
                       Delete the key <Badge variant="secondary">{row.original.start}...</Badge>{" "}
                       permanenty

diff --git a/apps/dashboard/lib/trpc/routers/vercel.ts b/apps/dashboard/lib/trpc/routers/vercel.ts
@@ -145,7 +145,7 @@ export const vercelRouter = t.router({
           });
         });
 
-        // Api Id stuff
+        // API ID stuff
 
         const setApiIdRes = await vercel.upsertEnvironmentVariable(
           input.projectId,

diff --git a/apps/docs/concepts/identities/ratelimits.mdx b/apps/docs/concepts/identities/ratelimits.mdx
@@ -27,7 +27,7 @@ In this case you would create an identity for the user and then create two ratel
 Now if either one of those limits is exceeded, the request is denied.
 
 <Info>
-  Api reference for verifying: [/api-reference/keys/verify](https://www.unkey.com/docs/api-reference/keys/verify)
+  API reference for verifying: [/api-reference/keys/verify](https://www.unkey.com/docs/api-reference/keys/verify)
 
-  Api reference for creating identities: [/api-reference/identities/create-identity](https://www.unkey.com/docs/api-reference/identities/create-identity)
+  API reference for creating identities: [/api-reference/identities/create-identity](https://www.unkey.com/docs/api-reference/identities/create-identity)
 </Info>
diff --git a/apps/docs/libraries/py/services/apis.mdx b/apps/docs/libraries/py/services/apis.mdx
@@ -1,24 +1,24 @@
 ---
 title: "ApiService"
-description: "The service used to make api related requests."
+description: "The service used to make API related requests."
 ---
 
 Available via the `apis` property of the `Client`.
 
 See the [full docs](https://jonxslays.github.io/unkey.py/stable/reference/services/#unkey.services.ApiService)
 on the `KeyService`.
 
-## Get api
+## Get API
 
-Gets an api with the given ID.
+Gets an API with the given ID.
 
 ```py
 result = await client.apis.get_api("api_123")
 ```
 
 ## List keys
 
-Retrieve a paginated list of api keys for a given api ID.
+Retrieve a paginated list of API keys for a given API ID.
 
 ```py
 # Page through keys 10 at a time