dub icon indicating copy to clipboard operation
dub copied to clipboard

Add pagination support to various OpenAPI operations

Open devkiran opened this issue 8 months ago • 3 comments

Summary by CodeRabbit

  • New Features
    • Enhanced API endpoints for commissions, customers, folders, and tags with improved pagination support, allowing for more flexible data retrieval.
  • Chores
    • Removed unnecessary debugging output from the folders API endpoint for cleaner logs.

devkiran avatar Jun 12 '25 17:06 devkiran

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

Name Status Preview Updated (UTC)
dub ✅ Ready (Inspect) Visit Preview Jun 28, 2025 9:18am

vercel[bot] avatar Jun 12 '25 17:06 vercel[bot]

Walkthrough

Pagination metadata was added to several OpenAPI operation objects for commissions, customers, folders, and tags by introducing the "x-speakeasy-pagination" property. Additionally, a debugging console log was removed from the folders API route handler. No other logic or control flow was modified.

Changes

Files Change Summary
apps/web/lib/openapi/commissions/list-commissions.ts
apps/web/lib/openapi/customers/get-customers.ts
apps/web/lib/openapi/folders/list-folders.ts
apps/web/lib/openapi/tags/get-tags.ts
Added "x-speakeasy-pagination" property to OpenAPI operation objects to specify offset-limit pagination details.
apps/web/app/api/folders/route.ts Removed a debugging console log from the GET handler for fetching folders.

Poem

A hop, a skip, pagination’s here, Across commissions, tags, and peers. Debug logs gone, the code is neat, Now OpenAPI docs are sweet! With every page, results align, A rabbit’s touch—so pure, so fine! 🐇✨

✨ Finishing Touches
  • [ ] 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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.

coderabbitai[bot] avatar Jun 12 '25 17:06 coderabbitai[bot]

🤖 Bug0 QA Agent

Here are the results of the automated tests for PR #2520:

To re-run the tests, please comment /bug0 run or push a new commit to this PR.

bug0-qa-agent[bot] avatar Jun 12 '25 17:06 bug0-qa-agent[bot]