Skip to content

API reference: populate stubs, update CSV, add missing methods, delete SLAM#4895

Merged
shannonbradshaw merged 4 commits intoviamrobotics:new-docs-sitefrom
shannonbradshaw:content/dev
Apr 13, 2026
Merged

API reference: populate stubs, update CSV, add missing methods, delete SLAM#4895
shannonbradshaw merged 4 commits intoviamrobotics:new-docs-sitefrom
shannonbradshaw:content/dev

Conversation

@shannonbradshaw
Copy link
Copy Markdown
Collaborator

@shannonbradshaw shannonbradshaw commented Apr 9, 2026

Summary

Two commits:

Commit 1: Populate reference/apis stubs

Populates all 37 API reference page stubs in reference/apis/ with content from dev/reference/apis/. Moves API documentation from the hidden dev/ section to the visible reference/ section. Adds alias redirects, updates 48 internal links, fixes heading violations in sessions.md.

Commit 2: CSV fixes and SLAM deletion

Added 25 method rows to sdk_protos_map.csv for methods that exist in Go or Python SDKs but were missing:

  • 2 component methods: motor.GetGeometries, servo.GetGeometries (Python only)
  • 10 fleet methods (Go SDK only)
  • 7 data client methods (Python + Go)
  • 2 billing methods
  • 1 ML training method (Go only)
  • 4 robot/machine methods (Go only)

Fixed 2 entries:

  • Deleted stale data_manager.UploadImageToDatasets (renamed to UploadBinaryDataToDatasets)
  • Fixed billing.GetInvoicePDF -> GetInvoicePdf (match proto case)

Deleted SLAM API page (not documenting SLAM). Added alias redirects.

Not included

31 proto methods remain undocumented because no SDK implements them yet (OAuth, Firebase, push tokens, fragment tags, saved queries, billing tiers, ListSupportedContainers).

Test plan

  • All reference/apis/ pages render with content in deploy preview
  • Old /dev/reference/apis/ paths redirect to new locations
  • SLAM alias redirects resolve
  • No markdownlint/vale/prettier errors

🤖 Generated with Claude Code

@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 9, 2026

Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit 60e4e60
🔍 Latest deploy log https://app.netlify.com/projects/viam-docs/deploys/69dcf770baa4900008afe73f
😎 Deploy Preview https://deploy-preview-4895--viam-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 38 (🔴 down 7 from production)
Accessibility: 99 (🔴 down 1 from production)
Best Practices: 92 (no change from production)
SEO: 89 (🔴 down 3 from production)
PWA: 60 (🔴 down 10 from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

shannonbradshaw and others added 2 commits April 13, 2026 09:22
Move all API reference content from dev/reference/apis/ (hidden section)
to reference/apis/ (visible in nav). 37 files populated from stubs.

- Add alias redirects from old /dev/reference/apis/ paths
- Update 48 internal links in page body to use new /reference/apis/ paths
- Fix heading level violations in sessions.md
- Preserve existing aliases (appendix, program paths)

The dev/reference/apis/ pages remain for now but will be removed
when the dev/ section is fully deprecated.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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>
@shannonbradshaw shannonbradshaw changed the title Populate reference/apis from dev/reference/apis content API reference: populate stubs, update CSV, add missing methods, delete SLAM Apr 13, 2026
shannonbradshaw and others added 2 commits April 13, 2026 09:48
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>
@shannonbradshaw shannonbradshaw merged commit 0ad5554 into viamrobotics:new-docs-site Apr 13, 2026
11 checks passed
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