adding info on developer rate limits for Connect #15399
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThis pull request updates the Pipedream Connect API documentation by introducing comprehensive rate limit guidelines. The changes include two new sections: "Pipedream rate limits" and "Developer rate limits". The documentation now provides detailed information about API request limitations, specifying rate limits for specific endpoints and explaining how developers can set custom rate limits for their users. Changes
Possibly related PRs
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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
docs-v2/pages/connect/api.mdx (2)
145-153: Add information about rate limit exceeded behavior.The rate limits documentation would be more complete if it included:
- The HTTP status code returned when limits are exceeded
- The response format for rate limit errors
- Any retry-after headers or cooldown period information
208-230: Fix code formatting and syntax issues in the example usage section.
- Use consistent quote marks (prefer backticks for code blocks)
- Remove the dangling single quote at the end
- Consider making the example more concise by removing unnecessary comments
Apply this diff to fix the formatting:
-``` +```bash # The response will include a rate limit token. Pass it as a header in your downstream requests to the Connect API. # Below is an example request that runs the "List Commits" action for the Gitlab app. -echo '{ +curl -X POST "https://api.pipedream.com/v1/connect/{your_project_id}/actions/run" \ + -H "Authorization: Bearer {access_token}" \ + -H "Content-Type: application/json" \ + -H "x-pd-rate-limit: {rate_limit_token}" \ + -d '{ "external_user_id": "jverce", "id": "gitlab-list-commits", "configured_props": { "gitlab": { "authProvisionId": "apn_kVh9AoD" }, "projectId": 45672541, "refName": "main" } -}' > data.json - -curl -X POST "https://api.pipedream.com/v1/connect/{your_project_id}/actions/run" \ - -H "Authorization: Bearer {access_token}" \ - -H "Content-Type: application/json" \ - -H "x-pd-rate-limit: {rate_limit_token}" \ # Pass the rate limit token in the header - -d @data.json -' +}'
1 participant
WHY
Summary by CodeRabbit