docs: document missing API reference endpoints

[sure-admin]

Summary

• sync the docs repo's openapi.yaml with the current generated API spec from we-promise/sure
• add the missing API reference navigation entries in docs.json so every currently documented API operation is reachable in Mintlify
• preserve the existing POST /api/v1/sync and GET /api/v1/usage reference pages while expanding the rest of the API surface

What this adds

• auth endpoints
• accounts, balances, budgets, and budget categories detail/list coverage
• family exports, family settings, import sessions, imports preflight/rows, provider connections, recurring transactions, rejected transfers, rule runs, rules, securities, security prices, sync history, transfers, reset status, and valuations index
• missing create/update operations that were already in the spec but not exposed in the docs nav

Validation

• verified that every API reference page in docs.json maps to an operation in openapi.yaml

Summary by CodeRabbit

• Documentation
  • Expanded API reference with comprehensive endpoint documentation including Auth, Family Exports, Family Settings, Import Sessions, Recurring Transactions, Rejected Transfers, Rule Runs, Rules, Securities, and Security Prices.
  • Enhanced existing endpoint documentation for Accounts, Balances, Categories, Merchants, Transfers, Users, and Valuations.

[mintlify]

Preview deployment for your docs. Learn more about Mintlify Previews.

Project	Status	Preview	Updated (UTC)
sure	🔴 Failed	–	Jun 20, 2026, 6:17 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2c07f890-fc6b-4b92-9965-271c8fd58a46

📥 Commits

Reviewing files that changed from the base of the PR and between e984fbe and 6564c53.

📒 Files selected for processing (2)

• docs.json
• openapi.yaml

---

📝 Walkthrough

Walkthrough

Expands the API reference navigation in docs.json by adding new groups (Auth, Family Exports, Family Settings, Import Sessions, Recurring Transactions, Rejected Transfers, Rule Runs, Rules, Securities, Security Prices) and updating existing groups (Accounts, Balances, Categories, Imports, Merchants, Transfers, Users, Valuations) with additional endpoint page entries. Whitespace formatting in contextual.options is also adjusted.

Changes

API Reference Navigation Expansion

Layer / File(s)	Summary
Auth group added; Accounts and Balances detail endpoints docs.json	Adds Auth group with auth/SSO endpoint pages; appends GET /api/v1/accounts/{id} to Accounts and GET /api/v1/balances/{id} to Balances.
Categories, Family, Imports, and Merchants expansions docs.json	Adds POST /api/v1/categories; inserts Family Exports and Family Settings groups with download endpoints; expands Imports with preflight and row/detail pages; adds Import Sessions group; adds POST /api/v1/merchants.
New Recurring Transactions, Rules, and Securities groups docs.json	Inserts six new groups: Recurring Transactions, Rejected Transfers, Rule Runs, Rules, Securities, and Security Prices, each with list and/or detail endpoint pages.
Transfers, Users, Valuations updates and formatting fix docs.json	Updates Transfers to list + detail endpoints; adds GET /api/v1/users/reset/status to Users; adds GET /api/v1/valuations to Valuations; adjusts contextual.options array whitespace.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐇 Hippity-hop through the API maze,
New endpoints blooming like spring flower days!
Auth and Securities, Rules and their kin,
Family Settings now welcomed right in.
The nav tree grows tall with each new route's name—
A rabbit's JSON garden, never the same! 🌿

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'docs: document missing API reference endpoints' accurately and concisely summarizes the main change, which is adding missing API reference navigation entries to the docs.json file.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/document-missing-apis

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[gemini-code-assist]

Code Review

This pull request updates docs.json to include several new API groups and endpoints, such as Auth, Balances, Family Exports, Family Settings, Import Sessions, and Recurring Transactions, while also fixing some minor indentation. The review feedback suggests reordering the newly added Auth group to place it after Accounts to maintain alphabetical consistency in the API reference navigation.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

[gemini-code-assist]

The groups in docs.json are organized alphabetically. However, the newly added Auth group is placed before the Accounts group.

Please reorder them so that Accounts precedes Auth to maintain strict alphabetical ordering and consistency across the API reference navigation.

          {
            "group": "Accounts",
            "openapi": "/openapi.yaml",
            "pages": [
              "GET /api/v1/accounts",
              "GET /api/v1/accounts/{id}"
            ]
          },
          {
            "group": "Auth",
            "openapi": "/openapi.yaml",
            "pages": [
              "POST /api/v1/auth/signup",
              "POST /api/v1/auth/login",
              "POST /api/v1/auth/refresh",
              "POST /api/v1/auth/sso_exchange",
              "POST /api/v1/auth/sso_link",
              "POST /api/v1/auth/sso_create_account",
              "PATCH /api/v1/auth/enable_ai"
            ]
          },

[superagent-security]

Superagent didn't find any vulnerabilities or security issues in this PR.