PostHog
fix(api): Update query API comments for docs
Problem
Although the query API is maybe our most important endpoint, our docs don't reflect that. Beginning to update them to fix that.
Changes
Updating events, query, and persons endpoint to clarify what the purpose of query endpoint is and cleanup. For example:
Old:
New:
👉 Stay up-to-date with PostHog coding conventions for a smoother review.
Does this work well for both Cloud and self-hosted?
It doesn't have an impact.
How did you test this code?
Ran locally with redoc and swagger (although the various DRF formats don't always show well).
I'm going to keep working on this next week, so let me know if there is any areas you know of that need improving :)
📸 UI snapshots have been updated
1 snapshot changes in total. 0 added, 1 modified, 0 deleted:
-
chromium: 0 added, 1 modified, 0 deleted (diff for shard 2) -
webkit: 0 added, 0 modified, 0 deleted
Triggered by this commit.
👉 Review this PR's diff of snapshots.
📸 UI snapshots have been updated
3 snapshot changes in total. 0 added, 3 modified, 0 deleted:
-
chromium: 0 added, 3 modified, 0 deleted (diff for shard 1, diff for shard 2) -
webkit: 0 added, 0 modified, 0 deleted
Triggered by this commit.
👉 Review this PR's diff of snapshots.
📸 UI snapshots have been updated
2 snapshot changes in total. 0 added, 2 modified, 0 deleted:
-
chromium: 0 added, 2 modified, 0 deleted (diff for shard 1) -
webkit: 0 added, 0 modified, 0 deleted
Triggered by this commit.
👉 Review this PR's diff of snapshots.