fix: openapi schema for agent #2838

Flo4604 · 2025-01-25T14:49:03Z

What does this PR do?

The openapi schema got changed in a recent commit which errors out the tests

--- FAIL: TestRatelimit (0.02s)

valerr: Error: POST Path '/ratelimit.v1.RatelimitService/Ratelimit' not found, Reason: The POST request contains a path of '/ratelimit.v1.RatelimitService/Ratelimit' however that path, or the POST method for that path does not exist in the specification
    handler_test.go:26: 
        	Error Trace:	/home/runner/work/unkey/unkey/apps/agent/pkg/api/routes/v1_ratelimit_ratelimit/handler_test.go:26
        	Error:      	Not equal: 
        	            	expected: 200
        	            	actual  : 400
        	Test:       	TestRatelimit

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?

Switch to apps/agent and run go test -cover -v -json -timeout=60m -failfast ./pkg/... ./services/... | tparse -all -progress and see if TestRatelimit passes.

Checklist

Required

Appreciated

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

Summary by CodeRabbit

API Changes
- Updated rate limiting endpoint path and operation ID to improve versioning and service naming conventions
- Maintained existing rate limiting functionality and request/response schemas

changeset-bot · 2025-01-25T14:49:07Z

⚠️ No Changeset found

Latest commit: 37a6352

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

vercel · 2025-01-25T14:49:09Z

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

Name	Status	Preview	Comments	Updated (UTC)
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 25, 2025 3:03pm

vercel · 2025-01-25T14:49:10Z

@Flo4604 is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

coderabbitai · 2025-01-25T14:49:12Z

📝 Walkthrough

Walkthrough

The pull request involves updating the OpenAPI specification for the Unkey API, specifically modifying the rate limiting endpoint path and operation ID. The changes rename the endpoint from "/v1/ratelimit.limit" to "/ratelimit.v1.RatelimitService/Ratelimit" and update the corresponding operation ID from "v1.ratelimit.limit" to "ratelimit.v1.ratelimit". These modifications align the API structure with improved versioning and service naming conventions while maintaining the existing functionality of the rate limiting endpoint.

Changes

File	Change Summary
`apps/agent/pkg/openapi/openapi.json`	- Updated rate limit endpoint path from `"/v1/ratelimit.limit"` to `"/ratelimit.v1.RatelimitService/Ratelimit"` - Modified operation ID from `"v1.ratelimit.limit"` to `"ratelimit.v1.ratelimit"`

Possibly related PRs

fix: Update amount of goroutines to 128 #2082: Modifies the concurrency model of the rate limit service, directly related to the rate limiting functionality in the OpenAPI specification

Suggested reviewers

chronark

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b1820e2 and 37a6352.

📒 Files selected for processing (1)

apps/agent/pkg/openapi/openapi.json (1 hunks)

🔇 Additional comments (1)

apps/agent/pkg/openapi/openapi.json (1)

626-628: LGTM! The endpoint path and operation ID changes align with the service naming convention.

The changes follow the established pattern used by other service endpoints (e.g., VaultService) in the specification, making the API structure more consistent.

Let's verify if there are any clients still using the old endpoint path:

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?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

github-actions · 2025-01-25T14:49:15Z

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

fix: openapi schema for agent

843113b

vercel bot deployed to Preview – engineering January 25, 2025 14:50 View deployment

Merge branch 'main' into fix/agent-test-error

37a6352

Flo4604 marked this pull request as ready for review January 25, 2025 15:02

Flo4604 requested review from perkinsjr, chronark, mcstepp, MichaelUnkey and ogzhanolguncu as code owners January 25, 2025 15:02

vercel bot deployed to Preview – engineering January 25, 2025 15:03 View deployment

chronark approved these changes Jan 25, 2025

View reviewed changes

chronark merged commit 4d3e281 into unkeyed:main Jan 25, 2025
6 of 9 checks passed

Flo4604 deleted the fix/agent-test-error branch January 25, 2025 15:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: openapi schema for agent #2838

fix: openapi schema for agent #2838

Flo4604 commented Jan 25, 2025 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Jan 25, 2025 •

edited

Loading

vercel bot commented Jan 25, 2025 •

edited

Loading

vercel bot commented Jan 25, 2025

coderabbitai bot commented Jan 25, 2025 •

edited

Loading

Walkthrough

Changes

Possibly related PRs

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

github-actions bot commented Jan 25, 2025 •

edited

Loading

fix: openapi schema for agent #2838

fix: openapi schema for agent #2838

Conversation

Flo4604 commented Jan 25, 2025 • edited by coderabbitai bot Loading

What does this PR do?

Type of change

How should this be tested?

Checklist

Required

Appreciated

Summary by CodeRabbit

changeset-bot bot commented Jan 25, 2025 • edited Loading

⚠️ No Changeset found

vercel bot commented Jan 25, 2025 • edited Loading

vercel bot commented Jan 25, 2025

coderabbitai bot commented Jan 25, 2025 • edited Loading

Walkthrough

Changes

Possibly related PRs

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

github-actions bot commented Jan 25, 2025 • edited Loading

Flo4604 commented Jan 25, 2025 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Jan 25, 2025 •

edited

Loading

vercel bot commented Jan 25, 2025 •

edited

Loading

coderabbitai bot commented Jan 25, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

github-actions bot commented Jan 25, 2025 •

edited

Loading