Skip to content

feat: sdk docs #3051

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

Merged
chronark merged 7 commits into from
Mar 31, 2025
Merged

feat: sdk docs #3051

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
cb82a09
Update checks for open API endpoints, Adds back our webhook alert.
perkinsjr Mar 30, 2025
099ef2b
remove logs
perkinsjr Mar 30, 2025
6c302cf
fmt
perkinsjr Mar 30, 2025
147a65a
Add back the env checks
perkinsjr Mar 30, 2025
c2efbdd
revert: auditLogId
chronark Mar 30, 2025
c2cbd84
docs: fix ratelimit subcommand typo
chronark Mar 31, 2025
f187951
Merge branch 'main' of https://github.com/unkeyed/unkey into sdk-docs
chronark Mar 31, 2025
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
6 changes: 2 additions & 4 deletions apps/docs/libraries/ts/sdk/ratelimits/overrides/delete-override.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,18 +29,16 @@ No response, but if no error is returned the override has been deleted successfu
<RequestExample>

```ts
await unkey.ratelimit.deleteOverride({
await unkey.ratelimits.deleteOverride({
identifier: "user_123",
namespaceName: "email.outbound",
})
```
```ts
await unkey.ratelimit.deleteOverride({
await unkey.ratelimits.deleteOverride({
identifier: "user_123",
namespaceId: "rlns_1234",
})
```

</RequestExample>


10 changes: 5 additions & 5 deletions apps/docs/libraries/ts/sdk/ratelimits/overrides/get-override.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,14 +51,14 @@ Async will return a response immediately, lowering latency at the cost of accura

<RequestExample>
```ts
const override = await unkey.ratelimit.getOverride({
identifier:"user.example",
const override = await unkey.ratelimits.getOverride({
identifier:"user.example",
nameSpaceId:"rlns_12345",
});
```
```ts
const override = await unkey.ratelimit.getOverride({
identifier:"user.example",
const override = await unkey.ratelimits.getOverride({
identifier:"user.example",
namespaceName: "email.outbound"
});
```
Expand All @@ -76,4 +76,4 @@ const override = await unkey.ratelimit.getOverride({
}
}
```
</ResponseExample>
</ResponseExample>
8 changes: 4 additions & 4 deletions apps/docs/libraries/ts/sdk/ratelimits/overrides/list-overrides.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,14 +60,14 @@ The cursor to use for pagination


<RequestExample>

```ts
const overrides = await unkey.ratelimit.listOverrides({
nameSpaceId:"rlns_12345",
const overrides = await unkey.ratelimits.listOverrides({
nameSpaceId:"rlns_12345",
});
```
```ts
const overrides = await unkey.ratelimit.listOverrides({
const overrides = await unkey.ratelimits.listOverrides({
namespaceName: "email.outbound"
});
```
Expand Down
11 changes: 5 additions & 6 deletions apps/docs/libraries/ts/sdk/ratelimits/overrides/set-override.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: "Sets an override for a ratelimit"
---

## Request


<ParamField body="identifier" type="string" required>
Identifier of your user, this can be their userId, an email, an ip or anything else. Wildcards ( * ) can be used to match multiple identifiers, More info can be found at https://www.unkey.com/docs/ratelimiting/overrides#wildcard-rules
Expand Down Expand Up @@ -47,7 +47,7 @@ Async will return a response immediately, lowering latency at the cost of accura
<RequestExample>

```ts
const override = await unkey.ratelimit.setOverride({
const override = await unkey.ratelimits.setOverride({
identifier: "user_123",
limit: 10,
duration: 60000,
Expand All @@ -56,7 +56,7 @@ const override = await unkey.ratelimit.setOverride({
})
```
```ts
const override = await unkey.ratelimit.setOverride({
const override = await unkey.ratelimits.setOverride({
identifier: "user_123",
limit: 10,
duration: 60000,
Expand All @@ -69,12 +69,11 @@ const override = await unkey.ratelimit.setOverride({

<ResponseExample>
```ts
{
{
result: {
overrideId: 'rlor_12345'
overrideId: 'rlor_12345'
}
}
```

</ResponseExample>

Loading