Skip to content

[WIP] Add API docs#6979

Open
pouwerkerk wants to merge 3 commits intoactualbudget:masterfrom
pouwerkerk:add-tags-api-docs
Open

[WIP] Add API docs#6979
pouwerkerk wants to merge 3 commits intoactualbudget:masterfrom
pouwerkerk:add-tags-api-docs

Conversation

@pouwerkerk
Copy link
Contributor

This PR adds docs for the Tag API I forgot to add earlier (thanks for the reminder @youngcw!):

@pouwerkerk please add info about this to the API docs

Originally posted by @youngcw in #6746 (comment)

@actual-github-bot actual-github-bot bot changed the title Add API docs [WIP] Add API docs Feb 15, 2026
@netlify
Copy link

netlify bot commented Feb 15, 2026

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit 0efa779
🔍 Latest deploy log https://app.netlify.com/projects/actualbudget/deploys/69916ad44dba440008ad13e8
😎 Deploy Preview https://deploy-preview-6979.demo.actualbudget.org
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions
Copy link
Contributor

👋 Hello contributor!

We would love to review your PR! Before we can do that, please make sure:

  • ✅ All CI checks pass
  • ✅ The PR is moved from draft to open (if applicable)
  • ✅ The "[WIP]" prefix is removed from the PR title
  • ✅ All CodeRabbit code review comments are resolved (if you disagree with anything - reply to the bot with your reasoning so we can read through it). The bot will eventually approve the PR.

We do this to reduce the TOIL the core contributor team has to go through for each PR and to allow for speedy reviews and merges.

For more information, please see our Contributing Guide.

@netlify
Copy link

netlify bot commented Feb 15, 2026

Deploy Preview for actualbudget-website ready!

Name Link
🔨 Latest commit 0efa779
🔍 Latest deploy log https://app.netlify.com/projects/actualbudget-website/deploys/69916ad41944b3000828b847
😎 Deploy Preview https://deploy-preview-6979.www.actualbudget.org
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 15, 2026

📝 Walkthrough

Walkthrough

Adds comprehensive API documentation for a new Tags feature. Introduces a Tags API group in the reference documentation with struct definition, methods (getTags, createTag, updateTag, deleteTag), and usage examples. Also defines the underlying tag object type with fields for id, tag name, color, and description.

Changes

Cohort / File(s) Summary
Tags API Documentation
packages/docs/docs/api/reference.md
Adds new Tags API group to reference with methods getTags, createTag, updateTag, deleteTag; includes Tag struct definition and code examples demonstrating tag operations.
Tags Type Definition
packages/docs/docs/api/types.jsx
Defines new tag object type with fields: id, tag (string, required), color (string), and description (string).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested labels

documentation

Poem

🐰 Twitches whiskers with glee
Tags now documented with care,
Struct and methods laid bare,
Colors and names in a line,
API surface now divine! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title '[WIP] Add API docs' is too vague and generic; it does not specifically describe what API documentation is being added (Tags API). Revise the title to be more specific, such as 'Add API documentation for Tags' or 'Document Tag API methods and types' to clearly communicate the primary change.
✅ Passed checks (2 passed)
Check name Status Explanation
Description check ✅ Passed The description clearly relates to the changeset, explaining that documentation for the Tag API is being added, with context about the reminder.
Merge Conflict Detection ✅ Passed ✅ No merge conflicts detected when merging into master

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

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

No actionable comments were generated in the recent review. 🎉

Tip

Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord.


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

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

@github-actions
Copy link
Contributor

🤖 Auto-generated Release Notes

Hey @pouwerkerk! I've automatically created a release notes file based on CodeRabbit's analysis:

Category: Features
Summary: Add comprehensive API documentation for the new Tags feature, including methods and examples.
File: upcoming-release-notes/6979.md

If you're happy with this release note, you can add it to your pull request. If not, you'll need to add your own before a maintainer can review your change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant