Skip to content
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.

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

chore: Ratelimiting clarity #1655

Merged
merged 12 commits into from
May 26, 2024
Merged

chore: Ratelimiting clarity #1655

merged 12 commits into from
May 26, 2024

Conversation

perkinsjr
Copy link
Collaborator

What does this PR do?

Fixes # (issue)

If there is not an issue for this, please create one first. This is used to tracking purposes and also helps use understand why this PR exists

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Chore (refactoring code, technical debt, workflow improvements)
  • Enhancement (small improvements)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How should this be tested?

  • Test A
  • Test B

Checklist

Required

  • Filled out the "How to test" section in this PR
  • Read Contributing Guide
  • Self-reviewed my own code
  • Commented on my code in hard-to-understand areas
  • Ran pnpm build
  • Ran pnpm fmt
  • Checked for warnings, there are none
  • Removed all console.logs
  • Merged the latest changes from main onto my branch with git pull origin main
  • My changes don't cause any responsiveness issues

Appreciated

  • If a UI change was made: Added a screen recording or screenshots to this PR
  • Updated the Unkey Docs if changes were necessary

Copy link

vercel bot commented May 17, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 26, 2024 0:08am
planetfall ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 26, 2024 0:08am
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 26, 2024 0:08am
1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
workflows ⬜️ Ignored (Inspect) Visit Preview May 26, 2024 0:08am

Copy link

changeset-bot bot commented May 17, 2024

⚠️ No Changeset found

Latest commit: 3046338

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@CLAassistant
Copy link

CLAassistant commented May 17, 2024

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

github-actions bot commented May 17, 2024

Thank you for following the naming conventions for pull request titles! 🙏

@@ -125,19 +125,18 @@ When validating a key, we will return this back to you, so you can clearly ident
},
}),
limit: z.number().int().min(1).openapi({
description: "The total amount of burstable requests.",
description: "The total amount of requests in a given interval.",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we need to deprecate this field entirely

Suggested change
description: "The total amount of requests in a given interval.",
description: "The total amount of requests in a given interval.",
deprecated: true

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants