docs: Python and Rust cover the rest of the api - #104
Merged
Merged
Conversation
Follows dataplatform-rust-sdk's feat/cover-remaining-endpoints; merge alongside it. - resources: functions filter/search and a real /functions/byids in Python and Rust (the "catching up" note goes); graph export/import in all three clients, with tabs - timeseries: get_by_id, the value-type hint in all three clients, the live tail in the coverage table; drop Rust `list_with_limit`, which the SDK removed - datasets: get by numeric id - tenant: every call in all three clients, with tabs - subscriptions: document the /timeseries/datapoints/listen tail, subprotocol auth included - client: tenant is in every client; the tail is no longer "unwrapped" nor `?token=` Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Signed-off-by: jgjesdal <jostein@intellistream.ai>
Signed-off-by: jgjesdal <jostein@intellistream.ai>
The new tabs shift the per-language fence counts the plans pin, so each one is updated with the page it describes: `resources`, `subscriptions` and `timeseries` gain a Python and a Rust block, and `tenant` gains its first of each. The index selections still land where they were written to: the new blocks are appended in every case, so `resources`' `inject before = 8` is still "Traverse the graph" and `subscriptions`' `before = 2` is still "Live delivery". `tenant` states `independent` on its Python section, which is where the Rust and Java sections inherit it from. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Signed-off-by: jgjesdal <jostein@intellistream.ai>
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
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.
Documents the Python and Rust side of IntelliStream-DataHub/dataplatform-rust-sdk#162, which is already merged, so SDK
mainis ahead of these pages until this lands.What changes
filter/searchand a real/functions/byidsin Python and Rust; the "Python and Rust are catching up" note goes. Graph export/import gets Java, Python and Rust tabs (bytes, and streaming_to_path/_from_path), plus a line that an export straight after a write can come back short while the graph settles.get_by_id; the value-type hint in all three clients; coverage rows for both and for the live tail. Drops Rustlist_with_limit, which the SDK removed earlier./timeseries/datapoints/listen— the subprotocol handshake (datahub.bearer.<jwt>,datahub.v1), silent narrowing to readable series, the frame shape, and when to use live delivery instead.?token=authenticated; the blocking-client gap list gainstime_series.listen_datapoints.Relation to #103
#103 (
fix/docs-match-sdk-api) carries the separate Java/Rust/Python compile fixes. This PR is one commit onmasterand does not include them. It merges cleanly with #103 in either order (checked withgit merge-tree).Checks
docusaurus buildsucceeds with no broken-link or broken-anchor warnings.🤖 Generated with Claude Code