chore: Adding changelog december #2782
Conversation
perkinsjr
requested review from
chronark,
MichaelUnkey,
mcstepp and
ogzhanolguncu
as code owners
|
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
📝 WalkthroughWalkthroughThe changelog introduces significant updates to the Unkey platform, focusing on the new official Python SDK, the concept of Identities, and enhanced ratelimit management. The changes include a new SDK for key management, a method to create keys with detailed configurations, an endpoint to retrieve key details, and the ability to create and manage identities. Users can now group keys, set shared metadata and rate limits, and programmatically manage ratelimit overrides. Changes
Sequence DiagramsequenceDiagram
participant Dev as Developer
participant SDK as Unkey Python SDK
participant API as Unkey API
Dev->>SDK: Create Key
SDK->>API: POST /v1/keys.createKey
API-->>SDK: Key Created
Dev->>SDK: Create Identity
SDK->>API: POST /v1/identities.createIdentity
API-->>SDK: Identity Created
Dev->>SDK: Attach Key to Identity
SDK->>API: Update Key with External ID
API-->>SDK: Key Updated
Dev->>SDK: Verify Key Details
SDK->>API: POST /v1/keys.whoami
API-->>SDK: Key Information
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
Thank you for following the naming conventions for pull request titles! 🙏 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (3)
apps/www/content/changelog/2024-12-06.mdx (3)
17-18: Simplify import statementsThe code imports the same package twice in different ways.
-import unkey -from unkey_py import Unkey +from unkey_py import Unkey
122-139: Enhance response example documentationConsider adding comments to explain the significance of each field in the response, particularly the
identityandmetaobjects.{ + // Unique identifier for the key "id": "key_123", + // Display name of the key "name": "API Key 1", + // Number of remaining uses (if limited) "remaining": 1000, + // Associated identity information "identity": { "id": "id_123", "externalId": "ext123" }, + // Custom metadata associated with the key "meta": { "role": "admin", "plan": "premium" }, "createdAt": 1620000000000, "enabled": true, "environment": "production" }
150-156: Document the async flagThe example includes an
asyncflag but its purpose and implications aren't explained. Consider adding documentation about when to useasync: truevsasync: false.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
apps/www/content/changelog/2024-12-06.mdx(1 hunks)
🧰 Additional context used
🪛 Gitleaks (8.21.2)
apps/www/content/changelog/2024-12-06.mdx
69-72:
(curl-auth-header)
93-96:
(curl-auth-header)
113-115:
(curl-auth-header)
145-148:
(curl-auth-header)
🔇 Additional comments (1)
apps/www/content/changelog/2024-12-06.mdx (1)
73-88: Review token ratelimit duration
The tokens ratelimit has a very low duration of 10 seconds with a high limit of 86,400,000. This seems unusual and might be reversed with the limit value.
Please verify if these values are intentional or if they should be adjusted.
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
How should this be tested?
Checklist
Required
pnpm buildpnpm fmtconsole.logsgit pull origin mainAppreciated
Summary by CodeRabbit