Skip to content

Document registry deprecation and machine summary methods on the fleet page#5187

Open
btshrewsbury-viam wants to merge 2 commits into
docs/api-getstatusfrom
docs/api-app-methods
Open

Document registry deprecation and machine summary methods on the fleet page#5187
btshrewsbury-viam wants to merge 2 commits into
docs/api-getstatusfrom
docs/api-app-methods

Conversation

@btshrewsbury-viam

@btshrewsbury-viam btshrewsbury-viam commented Jul 13, 2026

Copy link
Copy Markdown
Collaborator

What this adds

Six released fleet methods flagged by the weekly SDK method coverage job (#5142), all on the Fleet Management API page:

  • DeprecateRegistryItem / UndeprecateRegistryItem and their Version variants (Python + TypeScript) — joining the already-documented registry item CRUD methods. From api#859 (APP-14575).
  • ListMachineSummaries (Go) — fleet-wide machine summary listing, filterable by fragment or location. From rdk#5608 (APP-14503).
  • GetRobotPartByNameAndLocation (Go) — fills the missing Go column on the already-documented proto row.

The UploadImageToDatasets data manager change originally in this PR moved to #5193 so the two can be reviewed independently — they share no generated files.

Deliberately not included

The Go DataClient methods the coverage job also flags (sequences CRUD, the app-side UploadImageToDatasets) cannot currently be documented on the data client page — the Go scraper attributes every go.viam.com/rdk/app package method to the fleet page, and the data client page has no Go tabs. Tracked in #5190 rather than misplaced here.

Merge order

Stacked on #5184 (shared regeneration baseline). Merge #5184 first; GitHub retargets this automatically. Refs #5142 but does not close it (remaining warnings tracked in #5188/#5189/#5190).

Verification

Targeted coverage runs: all six warnings cleared, no missing-override warnings, links verified against the current /reference/apis/ paths.

Refs #5142

…pload methods

Documents seven released fleet/data methods flagged by the SDK method
coverage job:

- DeprecateRegistryItem / UndeprecateRegistryItem and their Version
  variants (Python + TypeScript), joining the already-documented
  registry item CRUD methods.
- ListMachineSummaries (Go): fleet-wide machine summary listing.
- GetRobotPartByNameAndLocation (Go): fills the missing Go method on
  the already-documented proto row.
- UploadImageToDatasets (Go) on the data manager service, alongside
  the existing UploadBinaryDataToDatasets.

Adds CSV rows/columns, proto description overrides (rewording the two
pre-staged override files to imperative table style), and regenerates
the fleet and data manager markdown.

Refs #5142.
@btshrewsbury-viam

Copy link
Copy Markdown
Collaborator Author

Merge order: merge #5184 first. This PR is stacked on the docs/api-getstatus branch because both regenerate the data manager markdown — the diff here shows only this PR's changes. Once #5184 merges, GitHub retargets this to main; merge it after that (order relative to #5186 doesn't matter).

Issue linkage: refs #5142 but does not close it. The Go DataClient methods deliberately excluded here (sequences CRUD, app-side UploadImageToDatasets) are tracked in #5190; the internal-facing app methods are tracked in #5188.


Generated by Claude Code

Split the data manager service method out so the fleet-page changes
and the data manager change can be reviewed independently; they share
no generated files.
@btshrewsbury-viam btshrewsbury-viam changed the title Document registry deprecation, machine summaries, and dataset image upload methods Document registry deprecation and machine summary methods on the fleet page Jul 13, 2026
@btshrewsbury-viam

Copy link
Copy Markdown
Collaborator Author

Scope change: the UploadImageToDatasets data manager method was split out to #5193 so it can be reviewed independently (no shared generated files). This PR is now fleet-page only. Merge order unchanged: #5184 first, then this and #5193 in any order.


Generated by Claude Code

@btshrewsbury-viam

Copy link
Copy Markdown
Collaborator Author

Marvin (@enternal-L) Could you please review this PR? It's mostly generated stuff, but there are two .md files that could use a double check

@viam-overwatch

Copy link
Copy Markdown

Hey btshrewsbury-viam — this PR has been approved and CI has been green for 3+ business days. Ready to merge?

Auto-comment from overwatch. Will not re-nudge for 7 days.

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.

2 participants