Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

References to specific versions of the stats schema is incorrect #2317

Open
mattheworiordan opened this issue Nov 29, 2024 · 0 comments
Open
Labels
bug A broken link, image etc

Comments

@mattheworiordan
Copy link
Member

In our stats docs, such as https://ably.com/docs/metadata-stats/metadata/subscribe#stats-format, we link to a specific version of the schema https://schemas.ably.com/json/app-stats-0.0.1.json.

From @SimonWoolf :

The docs shouldn't hardcode what version to expect, that defeats the point of having a schema field in the struct.
We should have a versionless url that points to the latest version that the docs can link to for the current version (but make it clear that the one linked from the schema field of a stats object is definitive for itself)

Latest version at the time of writing this is 0.0.5.json, see https://schemas.ably.com/json/app-stats-0.0.5.json.

This applies to the control API as well, and accounts and apps.

@mattheworiordan mattheworiordan added the bug A broken link, image etc label Nov 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug A broken link, image etc
Development

No branches or pull requests

1 participant