Skip to content

feat: Bindings for dedicated ingredient archives APIs#223

Open
tmathern wants to merge 6 commits into
mainfrom
mathern/archive-api
Open

feat: Bindings for dedicated ingredient archives APIs#223
tmathern wants to merge 6 commits into
mainfrom
mathern/archive-api

Conversation

@tmathern
Copy link
Copy Markdown
Collaborator

@tmathern tmathern commented May 23, 2026

  • Adds bindings for write_ingredient_archive and add_ingredient_from_archive.
  • Massive docs update to explain how to use those APIs + migration guide to use them.
  • A bunch of tests added to cover variations of usage.

(As often happening, the bulk of the changes explaining the line count are the tests and the docs).

@tmathern tmathern requested a review from gpeacock May 23, 2026 15:32
@tmathern tmathern self-assigned this May 23, 2026
@tmathern
Copy link
Copy Markdown
Collaborator Author

tmathern commented May 23, 2026

@tmathern tmathern requested a review from ok-nick May 28, 2026 15:38
Comment on lines +450 to +451
| Dedicated ingredient archive APIs | `add_ingredient` then `write_ingredient_archive(id, stream)` | **Current** |
| Read-filter-rebuild APIs | `Builder` + `add_ingredient` + `to_archive`, then `Reader` + manual JSON | **Legacy** (see [catalog migration guide](#migration-guide-catalog-pattern) and [extraction migration guide](#migration-guide-ingredient-extraction)) |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's such thing as builder archives and ingredient archives still? Ingredient archives don't necessarily replace builder archives, do they?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Eventually I'd like ingredient archives to be their own things and replace the "legacy" way. But we're not at the point of deprecation just yet, only exposing the APIs and making them interchangeable.

I think it will be clearer to have them dedicated concepts with dedicated APIs.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants