[API] Added fields to cards endpoints by lonewolf2208 · Pull Request #20589 · ankidroid/Anki-Android

lonewolf2208 · 2026-03-25T21:30:00Z

Purpose / Description

Expose a small set of easier/raw card properties from the content provider. Fields - reps, lapses, type, original_deck_id.

Fixes

Fixes Expand CardContentProvider with more fields from Card #20458

Approach

Added new public columns in FlashCardsContract.Card
Populated them in CardContentProvider.addCardToCursor()
Kept them opt-in, so DEFAULT_PROJECTION did not change

How Has This Been Tested?

added/updated ContentProviderTest coverage for the new fields
Regarding below testing I tweaked the debug build to allow com.android.shell for manual provider queries; not part of the PR
manually queried the debug provider at content://com.ichi2.anki.debug.flashcards/cards

- manually queried with explicit projection _id:reps:lapses:type:original_deck_id

verified that querying without an explicit projection still returned the old default fields, so the new fields remain opt-in

Learning (optional, can help others)

Have shared my learnings here in this comment

Checklist

Please, go through these checks before submitting the PR.

You have a descriptive commit message with a short title (first line, max 50 chars).
You have commented your code, particularly in hard-to-understand areas
You have performed a self-review of your own code
[] UI changes: include screenshots of all affected screens (in particular showing any new or changed strings)
[] UI Changes: You have tested your change using the Google Accessibility Scanner

david-allison

Great start! Sorry, there's going to be a fair amount of nitpicking over the API, as breaking changes are hard work.

david-allison · 2026-03-25T21:36:06Z

@@ -608,6 +608,26 @@ public object FlashCardsContract {
         */
        public const val DECK_ID: String = "deck_id"

+        /**
+         * The total number of reviews this card has received.


This should be more detailed. What's a review? When does the count start? Does rescheduling cause this? Grade Now?

Hope this helps - b8f96bb

david-allison · 2026-03-25T21:36:14Z

+        public const val REPS: String = "reps"
+
+        /**
+         * The total number of times this card has lapsed.


This should be more detailed

Hope this helps - b8f96bb

david-allison · 2026-03-25T21:36:48Z

+        public const val LAPSES: String = "lapses"
+
+        /**
+         * The raw card type code. This is distinct from queue and note type.


Give values and meaning

Done b8f96bb

david-allison · 2026-03-25T21:37:32Z

+        public const val TYPE: String = "type"
+
+        /**
+         * The original deck id for cards currently in a filtered deck. This is 0 for regular cards.


reword 'regular cards' to be more precise

Done b8f96bb

david-allison · 2026-03-25T21:39:25Z

    }

+    @Test
+    fun testQueryCardRawPropertiesAcrossCardUris() {


One test per property. Compare to the value you set on the card, not the value on the Card object

Done - b8f96bb

david-allison

Tests don't run

Ayush-Patel-56 · 2026-03-26T02:56:58Z

Hi @lonewolf2208 try to use semantic commits

lonewolf2208 · 2026-03-26T21:55:17Z

Apologies @david-allison fixed the tests now

lonewolf2208 · 2026-04-01T18:17:20Z

@david-allison a friendly reminder to review this

david-allison

Ahaa... API change, so docs should be 'perfect'

Code doesn't need changes.

david-allison · 2026-04-04T18:46:15Z

+        public const val LAPSES: String = "lapses"
+
+        /**
+         * The stored Anki card type code. This is distinct from queue and note type.


I don't think this helps describe the concept.

The type is the 'stage' in learning: treat it as a FSM. A card moves from 0 to 1, to 2, then from 2 to 3, to 2...

queue shares a lot of the same values, but it's about how to select the card: temporary actions such as bury or suspend can change the queue of a card to stop it from being displayed. The 'type' is more permanent: suspending and unsuspending a card would not impact whether to use learning steps or the card properties, and also does not affect FSRS.

Lmk if this works - fcca098

I added more comments - this is the onyl one I feel could do with another round

Apologies @david-allison, for requesting another review on the same item. I’ve made the updates and hope it’s clearer this time - 55e9eea

david-allison

ALMOST THERE!!!! Thanks so much. Great job with the links

david-allison

Thanks so much!

david-allison · 2026-04-05T22:15:59Z

+         * Think of this as a simple state machine that affects how the card is scheduled when it
+         * is answered. A card typically moves `0 -> 1 -> 2`; if a review card lapses, it


A little informal, but I like it. LGTM!

NicolasNewman · 2026-04-18T09:44:17Z

Awesome seeing this already been done! This is my first time using the API and I was scratching my head trying to figure out how to access type before realizing it wasn't exposed. Looking forward to seeing it get merged in!

david-allison · 2026-04-18T09:52:10Z

@NicolasNewman Thanks!!

Feel free to list anything you create here: https://github.com/ankidroid/Anki-Android/wiki/Third-Party-Apps

mikehardy

I'm all for API changes (well, well-considered ones) - the beauty of open code and open APIs is that you have no idea what people will build, but they can't if you don't open it up.

That's just a philosophical statement, you've put in the work here so I'm sure I'm preaching to the choir. Well done, and thanks, let's go

Refine card field docs and tests test: fix nullable cursor handling in provider tests docs: refine card field KDoc in FlashCardsContract docs: clarify FlashCardsContract.Card.TYPE KDoc

mikehardy · 2026-04-19T15:47:18Z

Pulled PR locally, rebased to current main, ran ./gradlew jacocoTestReport to verify I hadn't messed anything up and that it worked with current code.

Going to squash locally (these seem like a single change...) then re-push with the commits nicely in the squash, then en-queue for our normal rebase-merge-queue

🫡

david-allison reviewed Mar 25, 2026

View reviewed changes

lonewolf2208 marked this pull request as ready for review March 25, 2026 22:18

lonewolf2208 requested a review from david-allison March 25, 2026 22:18

david-allison requested changes Mar 25, 2026

View reviewed changes

david-allison added the Needs Author Reply Waiting for a reply from the original author label Mar 26, 2026

lonewolf2208 requested a review from david-allison March 26, 2026 21:55

This comment was marked as low quality.

Sign in to view

david-allison requested a review from a team April 4, 2026 18:35

david-allison changed the title ~~Added fields to cards endpoints~~ [API] Added fields to cards endpoints Apr 4, 2026

david-allison requested changes Apr 4, 2026

View reviewed changes

lonewolf2208 requested a review from david-allison April 4, 2026 20:46

david-allison requested changes Apr 5, 2026

View reviewed changes

Comment thread api/src/main/java/com/ichi2/anki/FlashCardsContract.kt Outdated

Comment thread api/src/main/java/com/ichi2/anki/FlashCardsContract.kt Outdated

Comment thread api/src/main/java/com/ichi2/anki/FlashCardsContract.kt Outdated

lonewolf2208 requested a review from david-allison April 5, 2026 19:54

david-allison approved these changes Apr 5, 2026

View reviewed changes

david-allison added Needs Second Approval Has one approval, one more approval to merge and removed Needs Author Reply Waiting for a reply from the original author labels Apr 5, 2026

lonewolf2208 mentioned this pull request Apr 18, 2026

[API] Added fields to cards endpoints ( Part - 3 ) #20774

Merged

5 tasks

mikehardy approved these changes Apr 19, 2026

View reviewed changes

mikehardy added Pending Merge Things with approval that are waiting future merge (e.g. targets a future release, CI wait, etc) and removed Needs Second Approval Has one approval, one more approval to merge labels Apr 19, 2026

feat(api): added fields to cards endpoints

e299c47

Refine card field docs and tests test: fix nullable cursor handling in provider tests docs: refine card field KDoc in FlashCardsContract docs: clarify FlashCardsContract.Card.TYPE KDoc

mikehardy force-pushed the issue-20458-card-raw-fields branch from 55e9eea to e299c47 Compare April 19, 2026 15:47

mikehardy enabled auto-merge April 19, 2026 15:47

mikehardy added this pull request to the merge queue Apr 19, 2026

Merged via the queue into ankidroid:main with commit 570c05a Apr 19, 2026
15 checks passed

github-actions bot added this to the 2.24 release milestone Apr 19, 2026

github-actions bot removed the Pending Merge Things with approval that are waiting future merge (e.g. targets a future release, CI wait, etc) label Apr 19, 2026

		* Think of this as a simple state machine that affects how the card is scheduled when it
		* is answered. A card typically moves `0 -> 1 -> 2`; if a review card lapses, it

Uh oh!

Conversation

lonewolf2208 commented Mar 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose / Description

Fixes

Approach

How Has This Been Tested?

Learning (optional, can help others)

Checklist

Uh oh!

david-allison left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

david-allison left a comment

Choose a reason for hiding this comment

Uh oh!

Ayush-Patel-56 commented Mar 26, 2026

Uh oh!

lonewolf2208 commented Mar 26, 2026

Uh oh!

This comment was marked as low quality.

lonewolf2208 commented Apr 1, 2026

Uh oh!

david-allison left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

david-allison left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

david-allison left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

NicolasNewman commented Apr 18, 2026

Uh oh!

david-allison commented Apr 18, 2026

Uh oh!

mikehardy left a comment

Choose a reason for hiding this comment

Uh oh!

mikehardy commented Apr 19, 2026

Uh oh!

lonewolf2208 commented Mar 25, 2026 •

edited

Loading

david-allison left a comment •

edited

Loading