Prepare Ruby SDK Metadata and documentation updates - #52
Merged
bardonadam merged 11 commits intoSep 15, 2026
Merged
Conversation
Preserve native metadata values and clearing semantics, extend legacy and stream-end history fields, and align the README with the pending SDK documentation. Package versions remain unchanged; release requires separate approval. Verification: local SDK tests passed against the regenerated contract; README code-fence preservation check passed. Initiated-by: user Implemented-by: codex
bardonadam
changed the title
bardonadam
marked this pull request as draft
September 15, 2026 12:56
added 9 commits
September 15, 2026 20:12
Use the generated output from canonical backend 49ad7b083b50f53bc3d81edb77ca6597845160a2. Health checks and app changelog are first-party operations, not part of the developer API. Preserve the existing wrapper and README preparation. Verification: SDK tests passed; generated source scanned for removed operations/models; provenance matches the deployed public contract. Initiated-by: user Implemented-by: codex
Repeat supported destinations within each relevant section, use iOS Shortcut terminology, and remove app-version notes. Live Activity action support remains unchanged. Verification: README sync check passed; code fences unchanged; Markdown links and whitespace checked. Initiated-by: user Implemented-by: codex
Keep Source Code resources in website docs only. Preserve package links and omit the empty Go resource section. Verification: README converter test and six-repository sync check passed; scoped diffs checked. Initiated-by: user Implemented-by: codex
Use standalone preview images and captions in SDK READMEs; retain the website grid source. Verification: converter test and six-repository sync check passed; all preview images and code fences preserved. Initiated-by: user Implemented-by: codex
Match the SDK documentation feature priority. Section content and code examples are unchanged. Verification: section contents compared before and after; README sync and whitespace checks passed. Initiated-by: user Implemented-by: codex
Describe metadata as extra information and remove the paragraph about supported operations and replacement behavior, matching the reviewed SDK docs. Verification: README sync check passed; code examples and other sections unchanged. Initiated-by: user Implemented-by: codex
Include the notification message in Metadata examples and remove the final Tags and Metadata paragraph as requested. Verification: README sync and whitespace checks passed; inspected changes limited to the requested example and paragraph. Initiated-by: user Implemented-by: codex
Expand metadata and content-state objects to one field per line for readability. Verification: sync check passed; example tokens and CLI JSON values preserved; Python example syntax checked. Initiated-by: user Implemented-by: codex
Bump package and SDK identification versions to 1.11.0. Keep the release summary focused on Metadata, Tags, and iOS deep links. Generated package version metadata was regenerated from the unchanged API contract. Verification: package test suite passed; version metadata and scoped diffs checked. No release tags or package publishing. Initiated-by: user Implemented-by: codex
bardonadam
marked this pull request as ready for review
September 15, 2026 14:23
bardonadam
approved these changes
Sep 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds Metadata and final Tags support to Push Notifications and Live Activities, including legacy update/end and managed stream ending. Native values and empty collections retain their JSON meaning through the handwritten wrappers. The generated client comes from backend commit
49ad7b083b50f53bc3d81edb77ca6597845160a2with source checksum recorded alongside it.The README follows the corresponding new SDK documentation, including examples. Wrapper fixes also cover supported dismissal and metric-value ergonomics for this language. Existing aliases remain compatible.
Validation: 27 tests and 113 assertions passed, with existing deprecation warnings. Request tests cover omitted, replaced, and cleared history fields and native scalar serialization.
Release hold: package versions remain 1.10.0. Do not merge, tag, or publish until the coordinated SDK release is approved. Backend support is already deployed. Publish the matching documentation after packages are available.
Public contract cleanup: health checks and app changelog endpoints and response models are excluded. Generated files use the updated canonical contract; existing wrappers and README work are preserved.