pr changes

unkeyed · Dec 12, 2024 · 39ce036 · 39ce036
1 parent 3496f21
commit 39ce036
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 17 deletions.
diff --git a/apps/docs/libraries/ts/ratelimit/override/delete-override.mdx b/apps/docs/libraries/ts/ratelimit/override/delete-override.mdx
@@ -12,11 +12,11 @@ Identifier of your user, this can be their userId, an email, an ip or anything e
 Either `namespaceId` or `namespaceName` is required. Not both.
 </Warning>
 
-<ParamField body="namespaceId" type="string" required>
+<ParamField body="namespaceId" type="string">
 The id of the namespace. Either namespaceId or namespaceName must be provided
 </ParamField>
 
-<ParamField body="namespaceName" type="string" required>
+<ParamField body="namespaceName" type="string">
 Namespaces group different limits together for better analytics. You might have a namespace for your public API and one for internal tRPC routes. Wildcards can also be used, more info can be found at https://www.unkey.com/docs/ratelimiting/overrides#wildcard-rules
 </ParamField>
 
@@ -28,14 +28,14 @@ No response, but if no error is returned the override has been deleted successfu
 
 <RequestExample>
 ```ts
-await unkey.deleteOverride({
+const override = await unkey.deleteOverride({
     identifier: "user_123",
     namespaceName: "email.outbound",
 })
 
 ```
 ```ts
-await unkey.deleteOverride({
+const override = await unkey.deleteOverride({
     identifier: "user_123",
     namespaceId:"rlns_12345", 
 })

diff --git a/apps/docs/libraries/ts/ratelimit/override/get-override.mdx b/apps/docs/libraries/ts/ratelimit/override/get-override.mdx
@@ -12,11 +12,11 @@ Identifier of your user, this can be their userId, an email, an ip or anything e
 Either `namespaceId` or `namespaceName` is required. Not both.
 </Warning>
 
-<ParamField body="namespaceId" type="string" required>
+<ParamField body="namespaceId" type="string">
 The id of the namespace. Either namespaceId or namespaceName must be provided
 </ParamField>
 
-<ParamField body="namespaceName" type="string" required>
+<ParamField body="namespaceName" type="string">
 Namespaces group different limits together for better analytics. You might have a namespace for your public API and one for internal tRPC routes. Wildcards can also be used, more info can be found at https://www.unkey.com/docs/ratelimiting/overrides#wildcard-rules
 </ParamField>
 
@@ -42,7 +42,7 @@ How many requests may pass in a given window.
 The window duration in milliseconds.
 </ParamField>
 
-<ParamField body="async" type="boolean" required>
+<ParamField body="async" type="boolean">
 Async will return a response immediately, lowering latency at the cost of accuracy.
 </ParamField>
 </Expandable>
@@ -51,14 +51,14 @@ Async will return a response immediately, lowering latency at the cost of accura
 
 <RequestExample>
 ```ts
-await unkey.getOverride({
+const override = await unkey.getOverride({
   identifier:"user.example", 
   namespaceName: "email.outbound"
 });
 
 ``` 
 ```ts
-await unkey.getOverride({
+const override = await unkey.getOverride({
   identifier:"user.example", 
   namespaceId: "rlns_1234",  
 });

diff --git a/apps/docs/libraries/ts/ratelimit/override/list-overrides.mdx b/apps/docs/libraries/ts/ratelimit/override/list-overrides.mdx
@@ -9,11 +9,11 @@ description: "Lists all overrides"
 Either `namespaceId` or `namespaceName` is required. Not both.
 </Warning>
 
-<ParamField body="namespaceId" type="string" required>
+<ParamField body="namespaceId" type="string">
 The id of the namespace. Either namespaceId or namespaceName must be provided
 </ParamField>
 
-<ParamField body="namespaceName" type="string" required>
+<ParamField body="namespaceName" type="string">
 Namespaces group different limits together for better analytics. You might have a namespace for your public API and one for internal tRPC routes. Wildcards can also be used, more info can be found at https://www.unkey.com/docs/ratelimiting/overrides#wildcard-rules
 </ParamField>
 
@@ -61,13 +61,13 @@ The cursor to use for pagination
 
 <RequestExample>
 ```ts
-await unkey.listOverrides({
+const overrides = await unkey.listOverrides({ 
     namespaceName: "email.outbound"
 });
 ```
 
 ```ts
-await unkey.listOverrides({
+const overrides = await unkey.listOverrides({  
     nameSpaceId:"rlns_12345",  
 });
 ``` 

diff --git a/apps/docs/libraries/ts/ratelimit/override/set-override.mdx b/apps/docs/libraries/ts/ratelimit/override/set-override.mdx
@@ -22,11 +22,11 @@ The window duration in milliseconds.
 Either `namespaceId` or `namespaceName` is required. Not both.
 </Warning>
 
-<ParamField body="namespaceId" type="string" required>
+<ParamField body="namespaceId" type="string">
 The id of the namespace. Either namespaceId or namespaceName must be provided
 </ParamField>
 
-<ParamField body="namespaceName" type="string" required>
+<ParamField body="namespaceName" type="string">
 Namespaces group different limits together for better analytics. You might have a namespace for your public API and one for internal tRPC routes. Wildcards can also be used, more info can be found at https://www.unkey.com/docs/ratelimiting/overrides#wildcard-rules
 </ParamField>
 
@@ -46,7 +46,7 @@ Async will return a response immediately, lowering latency at the cost of accura
   </ResponseField>
 <RequestExample>
 ```ts
-await unkey.setOverride({
+const override = await unkey.setOverride({
     identifier: "user_123",
     limit: 10,
     duration: 60000,
@@ -56,7 +56,7 @@ await unkey.setOverride({
 ``` 
 
 ```ts
-await unkey.setOverride({
+const override = await unkey.setOverride({
     identifier: "user_123", 
     limit: 5, 
     duration: 50000,