Skip to content

docs: Python and Rust cover the rest of the api - #104

Merged
JosteinGj merged 3 commits into
masterfrom
docs/python-rust-sdk-endpoints
Sep 30, 2026
Merged

JosteinGj merged 3 commits into
masterfrom
docs/python-rust-sdk-endpoints

Conversation

@JosteinGj

Copy link
Copy Markdown
Contributor

Documents the Python and Rust side of IntelliStream-DataHub/dataplatform-rust-sdk#162, which is already merged, so SDK main is ahead of these pages until this lands.

What changes

  • resources: functions filter / search and a real /functions/byids in 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.
  • timeseries: get_by_id; the value-type hint in all three clients; coverage rows for both and for the live tail. Drops Rust list_with_limit, which the SDK removed earlier.
  • datasets: get by numeric id, in the examples and the coverage table.
  • tenant: every call in all three clients, with tabs; the coverage table no longer shows "—" for Python and Rust.
  • subscriptions: a new section on /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.
  • client: tenant is in every client; the tail is no longer listed as unwrapped or as ?token= authenticated; the blocking-client gap list gains time_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 on master and does not include them. It merges cleanly with #103 in either order (checked with git merge-tree).

Checks

docusaurus build succeeds with no broken-link or broken-anchor warnings.

🤖 Generated with Claude Code

JosteinGj and others added 3 commits September 28, 2026 15:31
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>
@JosteinGj
JosteinGj merged commit c988fbe into master Sep 30, 2026
4 checks passed
@JosteinGj
JosteinGj deleted the docs/python-rust-sdk-endpoints branch September 30, 2026 11:17
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.

1 participant