Conversation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 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. 🪧 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 (
|
GregHolmes
approved these changes
Mar 28, 2025
GregHolmes
force-pushed
the
stats-docs-fixes-2025-03
branch
from
9b7a610 to
6c1675b
Compare
Contributor
|
On the consistency of variable naming I've created a JIRA ticket as I believe this needs to be carried out throughout the docs and not just this page, for various variable names. The JIRA ticket: https://ably.atlassian.net/browse/EDU-1886 |
- Clarified the scope of account statistics
- Removed account stats from the REST API - there is no such API, API keys are scoped to apps only. Not sure how this was ever documented.
- Improved clarity around obtaining account IDs:. Using an <aside>. Is this correct?
- Found it odd that in code samples we refer to, for example, {ACCOUNT_ID} then in the docs we refer to that variable as @accountid@. I don't follow the inconsistency. Happy to change code examples to use accountId if preferred, but I don't see any merit in inconsistency in the same page.
- Adjusted headings, specifically differentiating between “Statistics response payload” and “Statistics response”, clarifying the API response structure. I don't think it was clear before what a statistics response payload was vs statistics metrics. I have made what I think is am improvement
- Improved metric definitions, clearly stating the inclusion of push notifications and integrations in outbound metrics. But also just made things a lot more concise.
- Simplified curl command examples, removing redundant --location, and I have no idea why `--request POST` flags was added for a GET method endpoint.
- Provided clearer context around API endpoints by explicitly linking to the correct documentation references.
GregHolmes
force-pushed
the
stats-docs-fixes-2025-03
branch
from
6c1675b to
7497ace
Compare
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
3 participants
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.
--request POSTflags was added for a GET method endpoint.Note I have some questions around whether we need
<aside>for these smaller "tip" areas that are possibly more subtle, as opposed to stand out which I think this will do.Also, do we not need aside for the product release stages in PDR-057?