Skip to content

SDK coverage: internal-facing app methods need a confirm-and-ignore decision #5188

Description

@btshrewsbury-viam

Part of the #5142 warning backlog (SDK method coverage). After the companion docs PRs merge, these 10 warnings remain for methods that exist in released SDKs but appear to serve Viam-internal infrastructure rather than customers. Each needs a confirm-and-ignore decision (add to the ignore lists in update_sdk_methods.py / check_for_unused_methods) or, if any is actually meant for customers, a docs addition.

Methods and analysis

OAuth app user (Python create_oauth_app_user, TypeScript createOAuthAppUser)
The CreateOAuthAppUser RPC is real, but the docs have never documented any of the OAuth-apps family (CreateOAuthApp, ReadOAuthApp, UpdateOAuthApp, DeleteOAuthApp have no sdk_protos_map.csv rows). Documenting only this one method would be odd; the consistent options are "document the whole OAuth apps API" or "ignore this method like the rest of the family." Recommend: ignore, matching current posture.

Device push tokens (Python upload_device_push_token, get_device_push_tokens, delete_device_push_token)
Mobile push-notification plumbing for Viam's own app infrastructure. Recommend: ignore.

Firebase config (Python set_firebase_config, get_firebase_config, delete_firebase_config)
Same category — Firebase configuration for Viam's mobile infrastructure. Recommend: ignore.

App branding/content (Go GetAppBranding, GetAppContent)
These fetch branding and content bundles for hosted Viam applications (*.viamapplications.com). They read like platform plumbing (the serving path for apps), but if customers are expected to fetch or manage app branding programmatically, they belong in the Viam Apps docs instead. Recommend: domain-owner call; default ignore.

Proposed resolution

One small PR adding these to the per-language ignore lists in check_for_unused_methods, each with a comment stating why. Happy to open it once the calls above are confirmed. Until then, these warnings keep the weekly SDK method coverage job red.


Generated by Claude Code

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions