Document GetStatus across component and service APIs#5184
Open
btshrewsbury-viam wants to merge 3 commits into
Open
Document GetStatus across component and service APIs#5184btshrewsbury-viam wants to merge 3 commits into
btshrewsbury-viam wants to merge 3 commits into
Conversation
The Python, TypeScript, and Flutter SDKs expose a resource-level GetStatus method (backed by the common GetStatus RPC) on every component and most services, but it had no rows in sdk_protos_map.csv, so the API reference never mentioned it and the weekly SDK method coverage job flagged ~70 unused-method warnings. Add a GetStatus row for each of the 18 components and 8 services, filling only the SDK columns the coverage scraper actually finds (the Go SDK has no per-resource GetStatus; Flutter lacks encoder, input controller, and switch). Add a proto description override file per resource, and regenerate the affected component and service markdown. Also ignore the capitalized 'GetStatus' the Python scraper picks up from the world_state_store page, matching the existing entries for that page's other proto-cased duplicates (ListUUIDs, GetTransform). Refs #5142.
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
viambot
added
the
safe to build
This was referenced Jul 13, 2026
The first-sentence extractor for method-table descriptions only
stripped percent-style ({{% alert %}}) shortcode blocks. The
motion.MoveOnMap.md override starts with an angle-bracket
({{< alert >}}) block, so regenerating leaked an unclosed shortcode
opener into motion-table.md and broke the Hugo build. Strip
angle-bracket blocks the same way, non-greedily so a description
between two blocks survives.
…ence/apis The docs restructure moved the API reference pages from /dev/reference/apis/* to /reference/apis/*, leaving /dev/reference as meta-refresh alias stubs. The generator still hardcoded the old prefix, so the previous regeneration pointed every method-table link at a stub page and htmltest failed. Update the anchor prefixes and regenerate the files in this PR's scope.
btshrewsbury-viam
added a commit
that referenced
this pull request
Jul 13, 2026
Two CI fixes for the robot API regeneration: - The docs restructure moved the API reference from /dev/reference/apis to /reference/apis, but the generator still hardcoded the old prefix, so the regenerated table links pointed at alias stubs and htmltest failed. Update the prefixes (same fix as #5184) and regenerate. - The scraped transform_pcd parameter descriptions from the Python SDK contain 'i.e.', which the vale style rules reject. Add parameter description override files with equivalent wording.
This was referenced Jul 13, 2026
btshrewsbury-viam
requested review from
Shannon Bradshaw (shannonbradshaw) and
Ethan (stuqdog)
Collaborator
Author
|
Merge order: merge this PR first. #5186 and #5187 are stacked on this branch (they share regenerated files); GitHub retargets them to main automatically once this merges. #5185 is independent. Issue linkage: refs #5142 but does not close it — after all four PRs merge, ~24 warnings remain (tracked in #5188, #5189, #5190), so the weekly SDK method coverage job stays red until those get confirm-and-ignore entries. This PR also carries the two generator fixes the other PRs rely on: the /dev/reference→/reference anchor prefixes and the angle-bracket alert strip for table descriptions. Generated by Claude Code |
Collaborator
Author
|
Ethan (@stuqdog) would you mind reviewing this PR please? It covers the getStatus changes for most of the auto generated apis |
Member
|
Assigning Naveed because Ethan will be out for the next 8 weeks |
Nick Hehr (HipsterBrown)
approved these changes
Jul 14, 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
4 participants
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.
What this adds
The Python, TypeScript, and Flutter SDKs expose a resource-level
GetStatusmethod (backed by the commonGetStatusRPC in viamrobotics/api) on every component and most services. It was undocumented: no rows insdk_protos_map.csv, so it never appeared in the API reference — and it accounted for ~70 of the 119 warnings keeping the weekly SDK method coverage job red (#5142).This PR adds a
GetStatussection to all 18 component API pages and 8 service API pages (data manager, discovery, generic service, ML model, motion, SLAM, vision, world state store).How
GetStatusCSV row per resource, filling only the SDK columns the coverage scraper actually finds: Pythonget_statusand TypeScriptgetStatusbroadly; FluttergetStatuswhere Flutter supports the resource (no encoder, input controller, switch); the Go SDK has no per-resource GetStatus, so the Go column stays empty. Micro-RDK column set toNowhere the resource's section uses Yes/No (micro-rdk has no per-resource GetStatus RPC).<resource>.GetStatus.md).update_sdk_methods.py. The regeneration also picks up drift since the last regen — mostly the/reference/→/dev/reference/link migration in tables and minor upstream SDK docs wording — which is why the table diffs touch every row.GetStatusduplicate the Python scraper picks up from the world_state_store page, exactly matching the existing ignore entries for that page's other duplicates (ListUUIDs,GetTransform,StreamTransformChanges,DoCommand).Verification
Ran the full coverage script locally on this branch: the ~70 GetStatus warnings are gone (119 → 49 total), no missing-override warnings, and the generated sections render Python/TypeScript/Flutter tabs with scraped signatures and examples.
Part of a series addressing the #5142 warning backlog; companion PRs document the remaining component, robot, and app methods.
Refs #5142