Repository navigation
docs: bring the prose in line with what the Python and Rust SDKs do on main - #107
Merged
Merged
Conversation
…n main An audit of every reference page and guide against dataplatform-rust-sdk main (and the api where a claim is server-side). The examples already compiled and every Python call already matched its signature; what had drifted was the prose. - Default filter limit for Python and Rust is 1000, not 100 (events, filters, subscriptions); the subscription filter now sends every criterion and the cursor. - Resource, asset and function update echoes are typed in Python and Rust, not flat Resources; Python and Rust have the assets service; neither has a relation update form or a policy service. - Cursors no longer carry a version tag; example cursors re-encoded. - subType/status sorts page now; a sort order is compared case-insensitively and the first recognised property wins. - events.list is documented (oldest first, no cursor); the 64-character update limit on source is gone; the distinct-value endpoints are eventually consistent. - id is an exact numeric criterion, not a pattern. - 408 is spooled; the buffered path sends one request at a time. - AsyncDataHubClient lacks only the binary ingest calls. - Every refusal is a typed problem document now; the trash keeps external ids and records deletedAt. - fetch_related walks edges in both directions, so correlate-alarms' intersection includes both pumps; re-raising an event with the same external id stores a second event; an MCP time-series delete purges its datapoints, and a data-set delete with members fails. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Signed-off-by: jgjesdal <jostein@intellistream.ai>
SDK main (811b093) dropped the client-side snake-casing of the default external id and gained INode.deleted_at, following the api's verbatim file ids and deletedAt trash. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Signed-off-by: jgjesdal <jostein@intellistream.ai>
Found by the live Python tier; each was a mistake in the page, not the platform. - tutorial: step 1 never imported intellistream_datahub_sdk, which step 2 uses. - events: the lookup example used uuid without importing it. - datasets: the lookup read a data set id that does not exist; it now reads the id of the one it just looked up. - Python TimeSeries defaults value_type to bigint, so twelve series that are written decimals now say value_type="float"; the three that said "numeric", which Python cannot create, say "float" too. - construction, medical-devices, aerospace: the demo-data block created nodes that step 1 then creates again, a 409 for anyone following the page. - data-cleaning-lineage: fetch_related walks edges both ways, so the forward impact walk now follows the returned edges' direction itself. Plans: events and resources now supply what a reader carries in from an earlier example, and events drops an [expect] its own delete example contradicts. Co-Authored-By: Claude Opus 5.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.
An audit of every reference page and guide against
dataplatform-rust-sdkmain(ef6336b), and the api where a claim is server-side.The examples were already right: every Python name and keyword argument the docs use exists in the built SDK (671 calls checked against
inspect.signature), and all 161 Java and Rust examples compile. What had drifted was the prose.What changed
limitis set, not 100 (events, filters, subscriptions).Resources.assetsservice; neither has a relation update form or a policy service;events.list()is documented (oldest first, no cursor).subType/statussorts page.sourcelimit on event update is gone.idis an exact criterion, not a pattern.408is spooled.deletedAt(deleted_atin Python and Rust). An upload's external id defaults to the file name, verbatim (SDK 811b093).AsyncDataHubClientlacks only the binary ingest calls.fetch_relatedwalks edges in both directions, so the correlate-alarms intersection includes both pumps.Left out on purpose
timeseries_createrow: docs(units): a create may name its unit by unitExternalId alone #105 changes those.functions.by_external_id.Checks
master; they are being investigated separately.🤖 Generated with Claude Code