docs(api): expand backend route and auth interface docs#1532
Merged
tyler-dane merged 1 commit intomainfrom Mar 13, 2026
Merged
Conversation
Co-authored-by: Tyler Dane <tyler-dane@users.noreply.github.com>
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
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.
Update API documentation with a verified route/middleware matrix, SuperTokens runtime auth endpoints, sync operational header requirements, and runbook-ready examples for maintain-all and debug/sync interfaces.
Note
Low Risk
Documentation-only changes; no runtime behavior, security, or data-handling logic is modified.
Overview
Updates
docs/api-documentation.mdwith a more explicit route-by-route and middleware breakdown across calendars, users, priorities, sync, and events (including resolved env-based paths and write/Google-connection requirements).Clarifies authentication by documenting the dev-only
/api/auth/sessioncontract and listing SuperTokens-managed runtime endpoints under/api.Adds a new Operational Headers section documenting
x-comp-tokenand Googlex-goog-*requirements and includes a curl example for/api/sync/maintain-all.Written by Cursor Bugbot for commit 127ed89. This will update automatically on new commits. Configure here.