From e79bb4e90c5dd2f4cc59227ac6e525177886d3a0 Mon Sep 17 00:00:00 2001 From: Vardhaman Bhandari <97441447+Vardhaman619@users.noreply.github.com> Date: Sun, 6 Oct 2024 10:00:09 +0000 Subject: [PATCH 1/3] Fix incorrect error code for UNAUTHORIZED error --- apps/docs/api-reference/errors/code/UNAUTHORIZED.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/docs/api-reference/errors/code/UNAUTHORIZED.mdx b/apps/docs/api-reference/errors/code/UNAUTHORIZED.mdx index 27c00da8e4..1654f7e58f 100644 --- a/apps/docs/api-reference/errors/code/UNAUTHORIZED.mdx +++ b/apps/docs/api-reference/errors/code/UNAUTHORIZED.mdx @@ -1,6 +1,6 @@ --- title: UNAUTHORIZED -openapi-schema: ErrInternalServerError +openapi-schema: ErrUnauthorized --- ## Problem From e5be49bce0fd2306eb2c45f4f85f9ed10e88e35e Mon Sep 17 00:00:00 2001 From: Vardhaman Bhandari <97441447+Vardhaman619@users.noreply.github.com> Date: Mon, 7 Oct 2024 15:02:11 +0000 Subject: [PATCH 2/3] fix : ratelimit sdk docs --- apps/docs/libraries/ts/ratelimit.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/docs/libraries/ts/ratelimit.mdx b/apps/docs/libraries/ts/ratelimit.mdx index 8dda86ce4f..b01cae63b0 100644 --- a/apps/docs/libraries/ts/ratelimit.mdx +++ b/apps/docs/libraries/ts/ratelimit.mdx @@ -147,7 +147,7 @@ Make sure the root key has permissions to use ratelimiting. - + Namespaces allow you to separate different areas of your app and have isolated limits. Make sure the root key has permissions to use ratelimiting. From 5ad0013be04d3668b15694d671545e9395008bc3 Mon Sep 17 00:00:00 2001 From: Vardhaman Bhandari <97441447+Vardhaman619@users.noreply.github.com> Date: Tue, 8 Oct 2024 11:32:02 +0000 Subject: [PATCH 3/3] fix(docs): standardize spelling of "API" in dashboard and documentation --- apps/api/src/pkg/hono/app.ts | 2 +- apps/dashboard/app/(app)/apis/[apiId]/settings/page.tsx | 2 +- .../app/(app)/apis/[apiId]/settings/update-api-name.tsx | 4 ++-- .../components/dashboard/api-key-table/index.tsx | 2 +- apps/dashboard/lib/trpc/routers/vercel.ts | 2 +- apps/docs/concepts/identities/ratelimits.mdx | 4 ++-- apps/docs/libraries/py/services/apis.mdx | 8 ++++---- 7 files changed, 12 insertions(+), 12 deletions(-) diff --git a/apps/api/src/pkg/hono/app.ts b/apps/api/src/pkg/hono/app.ts index 5d040694bd..060dab8a4e 100644 --- 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 index 6faa740610..fc16fc94b8 100644 --- 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) { - Api ID + API ID This is your api id. It's used in some API calls. 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 index e5680471dd..3f6132f766 100644 --- 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 = ({ api }) => {
- Api Name + API Name - 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. diff --git a/apps/dashboard/components/dashboard/api-key-table/index.tsx b/apps/dashboard/components/dashboard/api-key-table/index.tsx index 4398ef47bf..27720c5579 100644 --- 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 = ({ data }) => { - Revoke Api Key + Revoke API Key Delete the key {row.original.start}...{" "} permanenty diff --git a/apps/dashboard/lib/trpc/routers/vercel.ts b/apps/dashboard/lib/trpc/routers/vercel.ts index ce5d7ffeec..de7c37cd04 100644 --- 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 index 6dcd230b97..152dd2fbcb 100644 --- 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. - 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) diff --git a/apps/docs/libraries/py/services/apis.mdx b/apps/docs/libraries/py/services/apis.mdx index a16d05cef7..f2140e251c 100644 --- a/apps/docs/libraries/py/services/apis.mdx +++ b/apps/docs/libraries/py/services/apis.mdx @@ -1,6 +1,6 @@ --- 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`. @@ -8,9 +8,9 @@ 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") @@ -18,7 +18,7 @@ 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