Sync docs & markdown for the 1.0.0-beta.2 release#400
Conversation
- ReleaseNotes.md: add 1.0.0-beta.2 section (subscriptions/push, zones, assets/rereference, batch conveniences, correctness hardening, MistDemo/tooling) - README.md: reconcile roadmap (move shipped endpoints into a checked v1.0.0-beta.2 section, rename stale alpha.X to Backlog/Post-beta), bump install to from: "1.0.0-beta.2", add usage snippets for the new APIs + auto-chunking conveniences - CLAUDE.md: add Examples section featuring BushelCloud as the canonical pattern demo (#174; corrected Examples/Bushel/ -> Examples/BushelCloud/) - CelestraCloud/CHANGELOG.md: stale MistKit 1.0.0-alpha.3 -> v1.0.0-beta.2 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
| - [x] [Fetching Users by Record Name (users/lookup/id)](https://github.com/brightdigit/MistKit/issues/35) ✅ *(Apple-deprecated — prefer `discoverAllUserIdentities`)* | ||
| - [x] Auto-chunking conveniences for batch operations ([#389](https://github.com/brightdigit/MistKit/pull/389)) ✅ | ||
|
|
||
| ### Backlog / Post-beta |
There was a problem hiding this comment.
Is everything done but sharing?
There was a problem hiding this comment.
Not quite — sharing isn't the only thing left here. I checked each unchecked item against the actual surface on this branch:
- File Apple Feedback Assistant report: discoverAllUserIdentities returns HTTP 500 #28 — GET
users/discover: still unshipped. The shippeddiscoverAllUserIdentities(lookupInfos:batchSize:)is the chunked POST variant; the no-arg address-book GET form remains unavailable (pending File Apple Feedback Assistant report: discoverAllUserIdentities returns HTTP 500 #28). - Fetching Contacts (users/lookup/contacts) #33 —
users/lookup/contacts: the endpoint is inopenapi.yamlandlookupContactsis generated intoMistKitOpenAPI, but there's no curatedCloudKitServicewrapper yet. (closest to done — only the wrapper is missing) - Fetching Record Information (records/resolve) #41 —
records/resolve: not in the spec, no method. - Accepting Share Records (records/accept) #42 —
records/accept(sharing): not in the spec, no method. - Fetching Database Changes (changes/database) #46 —
changes/database: not in the spec, no method. - Fetching Record Zone Changes (changes/zone) #47 —
changes/zone: distinct from the shippedfetchZoneChanges, which hits/zones/changesand returns changed zones (meta-sync), not record changes within a zone. - Feature: Add custom CloudKit zone support for queries #146 — custom zone for queries:
queryRecordsstill hardcodeszoneID: .init(zoneName: "_defaultZone")with no zone parameter.
So the section is accurate as written — all seven are genuinely unshipped at the curated API level, not just sharing.
Generated by Claude Code
Summary
Brings all prose docs in line with the API surface shipped since
1.0.0-beta.1(subscriptions, APNs tokens,modifyZones,assets/rereference, auto-chunking conveniences, ambiguous-scalar tagging, MistDemo rebuild), ahead of tagging 1.0.0-beta.2. Markdown-only — no source changes.Changes
## 1.0.0-beta.2section above beta.1, grouped by area, with thebeta.1...beta.2compare link.assets/rereferenceReferencing Existing Assets (assets/rereference) #31,zones/modifyModifying Zones (zones/modify) #45, subscriptions Fetching Subscriptions (subscriptions/list) #49–51, tokens Creating APNs Tokens (tokens/create) #52–53, users lookup Fetching Users by Email (users/lookup/email) #34/Fetching Users by Record Name (users/lookup/id) #35) moved into a checked### v1.0.0-beta.2section; the stale### v1.0.0-alpha.Xheading renamed to### Backlog / Post-betawith only genuinely-unshipped items. Install bumped tofrom: "1.0.0-beta.2". Added brief Usage snippets for the new operations + auto-chunking conveniences.## Examplessection featuring BushelCloud as the canonical pattern demo (closes Documentation: Reference Bushel in CLAUDE.md Examples section #174; corrected the issue's staleExamples/Bushel/path toExamples/BushelCloud/), plus CelestraCloud and MistDemo.MistKit 1.0.0-alpha.3dependency reference →v1.0.0-beta.2.Verification
grepclean).beta.1/alphastrings are all intentional historical refs (section headers, PR links, compare URLs).Sources/.Deliberately out of scope
© 2025copyright drift (65 files underTests/+Examples/, whichlint.shdoesn't cover) — handled directly in the CelestraCloud repo / chore: update CelestraCloud test copyright headers 2025 → 2026 #331, since it spans subrepos with their own header identity.Examples/BushelCloud/.claude/migration-to-bushelkit.mdstill cites1.0.0-alpha.3in two spots, but those are historical migration snippets and BushelCloud builds via a local path dependency (no version pin) — left as-is.Follow-up
The CelestraCloud CHANGELOG edit will need a
git subrepo pushto reach the standalone repo.Closes #174
🤖 Generated with Claude Code