docs: add rate limits to analytics and update API reference pages#5805
Open
mintlify[bot] wants to merge 1 commit into
Open
docs: add rate limits to analytics and update API reference pages#5805mintlify[bot] wants to merge 1 commit into
mintlify[bot] wants to merge 1 commit into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
## Rate limitssections to API reference pages that were missing them:POST /project/update/{projectId}): 10 requests per Mintlify organization per 10 secondsGET /project/update-status/{statusId}): 20 requests per Mintlify organization per 10 secondsNote
Low Risk
Documentation-only changes that add rate-limit notes; no runtime or behavioral impact beyond what users may infer from updated API docs.
Overview
Adds a new
## Rate limitssection to analytics export endpoint docs (assistant-*,feedback*,searches,views,visitors), standardizing them to 100 requests per Mintlify organization per hour.Updates the deployment APIs documentation to specify rate limits for
POST /project/update/{projectId}(10 requests per org per 10 seconds) andGET /project/update-status/{statusId}(20 requests per org per 10 seconds).Reviewed by Cursor Bugbot for commit 2f43168. Bugbot is set up for automated code reviews on this repo. Configure here.