Regenerate API docs: fix CSV, add missing methods, remove deprecated#4909
Merged
shannonbradshaw merged 7 commits intoviamrobotics:new-docs-sitefrom Apr 13, 2026
Merged
Conversation
CSV fixes (sdk_protos_map.csv): - Add motor.GetGeometries (Python only) - Add servo.GetGeometries (Python only) - Delete stale data_manager.UploadImageToDatasets (renamed to UploadBinaryDataToDatasets) - Fix billing.GetInvoicePDF -> GetInvoicePdf (match proto case) - Add 10 fleet methods (Go SDK only): DisableBillingService, EnableBillingService, GetBillingServiceConfig, ListOAuthApps, OrganizationGet/SetLogo, OrganizationGet/SetSupportEmail, TransferRegistryItem, UpdateBillingService - Add 7 data methods: AddTagsToBinaryDataByFilter, CreateBinaryDataSignedURL, CreateIndex, DeleteIndex, ListIndexes, RemoveTagsFromBinaryDataByFilter, UpdateBoundingBox - Add 2 billing methods: ChargeOrganization, SendPaymentRequiredEmail - Add 1 ml_training method: GetTrainingJobLogs (Go only) - Add 4 robot methods (Go only): GetPose, ListTunnels, SendTraces, Tunnel Delete SLAM API page: - Remove reference/apis/services/SLAM.md (not documenting SLAM) - Add alias redirects on services/_index.md for old SLAM URLs - Remove SLAM card from reference/apis/_index.md Note: 31 proto methods remain undocumented because they are not implemented in any SDK (OAuth, Firebase, push tokens, fragment tags, saved queries, billing tiers, ListSupportedContainers). These need SDK implementations before they can be documented. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
The first commit added /dev/reference/apis/services/SLAM/ as an alias on the SLAM page. The second commit deleted the page, losing that alias. Add it to services/_index.md so the path still resolves. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Remove SLAM aliases from services/_index.md and add them to the APIs overview (_index.md) instead. All SLAM URLs now redirect to the APIs overview page. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
CSV fixes: - Remove deprecated camera.GetImage and camera.RenderFrame (removed from all SDKs, only GetImages exists) - Remove GetInvoicePDF case "fix" (Go SDK uses PDF not Pdf) - Remove Go-only methods not yet on published SDK docs (will be added when next Go SDK version is released) - Add 7 data methods (Python only): AddTagsToBinaryDataByFilter, CreateBinaryDataSignedURL, CreateIndex, DeleteIndex, ListIndexes, RemoveTagsFromBinaryDataByFilter, UpdateBoundingBox - Add billing.ChargeOrganization (Python only) - Keep motor.GetGeometries and servo.GetGeometries (Python only) Regenerated content (40 files): - All component, service, and platform API generated .md files updated from current published SDK docs - Camera: removed GetImage and RenderFrame sections - Motor: added GetGeometries section - Servo: added GetGeometries section - Data: added 7 new method sections - Billing: added ChargeOrganization section Added 6 proto override description files for new methods. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Update 4 links in dev/reference/changelog.md from #getimage to #getimages since GetImage was removed from the camera API docs. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
The previous replace_all of #getimage -> #getimages also matched the existing #getimages, producing #getimagess. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
shannonbradshaw
force-pushed
the
content/dev
branch
from
ab643dd to
b4be75c
Compare
Generator scraped stale method name update_bounding_box_to_image_by_id from outdated published Python SDK docs. Correct name is update_bounding_box. Also fixed missing comma and incorrect return value assignment in the example. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
shannonbradshaw
merged commit 5eb980b
into
viamrobotics:new-docs-site
11 of 12 checks passed
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
1 participant
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.
Summary
Fixes the SDK method mapping CSV and regenerates all API reference content from current published SDK documentation.
CSV fixes
Removed deprecated methods:
camera.GetImage(removed from all SDKs, onlyGetImagesexists)camera.RenderFrame(removed from all SDKs)data_manager.UploadImageToDatasets(renamed toUploadBinaryDataToDatasets)Added missing methods (Python SDK):
motor.GetGeometriesservo.GetGeometriesdata.AddTagsToBinaryDataByFilterdata.CreateBinaryDataSignedURLdata.CreateIndexdata.DeleteIndexdata.ListIndexesdata.RemoveTagsFromBinaryDataByFilterdata.UpdateBoundingBoxbilling.ChargeOrganizationRegenerated content
Ran
update_sdk_methods.pycoverage check which regenerated all 40 generated API content files from current published SDK docs (python.viam.dev, pkg.go.dev, flutter.viam.dev, ts.viam.dev).Key changes in generated output:
Not included
~30 methods exist in Go SDK source but not on published pkg.go.dev (unreleased). These will be added when the next Go SDK version is released and the generator is re-run.
Test plan
🤖 Generated with Claude Code