Update stats documentation for specification version 3.0.0 #37
Conversation
This file contains 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
Reflects changes from spec commit a731d12.
Here’s where the text comes from: - `schema`: looking at the value returned in the sandbox at time of writing (https://schemas.ably.com/json/app-stats-0.0.3.json) - `entries`: noticing that the aforementioned schema describes all of the properties of `entries` - `appId`: copied from aforementioned schema - `inProgress`: copied from aforementioned schema
owenpearson
approved these changes
Dec 1, 2023
|
Does it look OK to you @m-hulbert? |
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.
This PR updates the documentation to reflect the changes made in ably/specification#149.
The spec changes are currently sitting on the
integration/3.0.0branch, so we probably don’t want to merge this PR until that branch is merged intomain(which I intend to do once a couple of outstanding things are resolved), but I'd appreciate a review so that I can crack on with getting these docstrings added to ably-js for ably/ably-js#1269.See commit messages for more details.
Resolves #34 (that issue says that we need to wait for the response documentation to be updated, but I think that the JSON schema means we can do without).