Add screenshots API docs #2702
Add screenshots API docs #2702
Conversation
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
WalkthroughImported Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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. Comment |
![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
🤖 Fix all issues with AI agents
In `@src/routes/docs/products/avatars/screenshots/`+page.markdoc:
- Line 257: Replace the incorrect enum name Timezone.EuropeParisAppwrite with
the correct Timezone.EuropeParis on the line that currently sets timezone:
Timezone.EuropeParisAppwrite; update that single occurrence so it matches the
other PascalCase timezone enums (e.g., Timezone.EuropeLondon,
Timezone.AsiaTokyo) and preserves the existing casing and punctuation.
🧹 Nitpick comments (2)
src/routes/docs/products/avatars/screenshots/+page.markdoc (2)
106-106: Inconsistent boolean parameter documentation.The
fullpageandtouchparameters are described using1/0values, but the code examples throughout the document usetrue/false(e.g.,fullpage: trueon line 150,touch: trueon line 269). Update the descriptions to usetrue/falsefor consistency with the examples.📝 Suggested fix
-| fullpage | boolean | Capture the full scrollable page (`1`) or only the viewport (`0`). Defaults to `false` if not provided. | +| fullpage | boolean | Capture the full scrollable page (`true`) or only the viewport (`false`). Defaults to `false` if not provided. |-| touch | boolean | Enable touch device support (`1`) or disable it (`0`). Defaults to `false` if not provided. | +| touch | boolean | Enable touch device support (`true`) or disable it (`false`). Defaults to `false` if not provided. |Also applies to: 112-112
124-237: Missing React Native example in viewport customization section.The initial code example (lines 76-90) includes
client-react-native, but this section omits it. Consider adding React Native examples for consistency, or document that subsequent examples focus on a subset of SDKs.
| | scale | float | The device pixel ratio for the screenshot. Accepts values between `0.1-3` for different DPI settings. Defaults to `1` if not provided. | | ||
| | theme | string | The browser color scheme theme. Accepts: `light` or `dark`. Defaults to `light` if not provided. | | ||
| | userAgent | string | A custom user agent string for the browser request. Defaults to browser default if not provided. | | ||
| | fullpage | boolean | Capture the full scrollable page (`1`) or only the viewport (`0`). Defaults to `false` if not provided. | |
There was a problem hiding this comment.
Should we stick to true and false instead of 1 and 0
| | latitude | float | Geolocation latitude for the screenshot. Accepts values between `-90` to `90`. Defaults to `0` if not provided. | | ||
| | longitude | float | Geolocation longitude for the screenshot. Accepts values between `-180` to `180`. Defaults to `0` if not provided. | | ||
| | accuracy | float | Geolocation accuracy in meters. Accepts values between `0-100000`. Defaults to `0` if not provided. | | ||
| | touch | boolean | Enable touch device support (`1`) or disable it (`0`). Defaults to `false` if not provided. | |
What does this PR do?
Add docs page for Screenshots API
Test Plan
Visit
/docs/products/avatars/screenshotsRelated PRs and Issues
appwrite/appwrite#10675
Have you read the Contributing Guidelines on issues?
Yes
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.