Skip to content

[RDK PR #6199] [Excluded APIs] Fleet API reference: 8 method anchors missing #5153

Description

@btshrewsbury-viam

/reference/apis/fleet/ exists, but 8 methods RDK links to have no anchor on the page (the section/method isn't documented).

Missing anchors (all → /reference/apis/fleet/#…, source app/app_client.go)

  • #disablebillingservice:1060
  • #getbillingserviceconfig:1123
  • #listoauthapps:1189
  • #organizationgetlogo:1167
  • #organizationgetsupportemail:1102
  • #organizationsetlogo:1147
  • #organizationsetsupportemail:1085
  • #transferregistryitem:2572

Investigation

These anchors are missing because all 8 methods are intentionally excluded from the generated fleet API reference. They are explicitly listed in the docs generator's exclusion set, go_ignore_app_apis (.github/workflows/parse_go.py), so the generator never emits a section (and therefore no anchor) for them. Confirmed absent from the generated include (static/include/services/apis/fleet.md).

The 8 are all cloud/organization-admin operations, not core fleet-management API — org billing (GetBillingServiceConfig, DisableBillingService), org branding (OrganizationGet/SetLogo, OrganizationGet/SetSupportEmail), OAuth-app management (ListOAuthApps), and registry-item transfer (TransferRegistryItem). Their neighbors in the same ignore list are unambiguously internal (SendPaymentRequiredEmail, GetRoverRentalRobots, SetSmartMachineCredentials).

RDK is currently inconsistent about these: within the same billing family, EnableBillingService and UpdateBillingService carry no doc-comment link, while DisableBillingService and GetBillingServiceConfig do link to the (deliberately non-existent) anchor. The 8 flagged here are the methods that inconsistently kept a link.

Note: being in go_ignore_app_apis is not a perfect proxy for "no anchor" — CreateKeyFromExistingKeyAuthorizations is also in that list yet has a live anchor (documented via the cross-SDK/proto path), which is why the audit correctly did not flag it.

Decision — needs internal discussion (do not change RDK yet)

Two options:

  1. Drop the links from RDK (leading option) — these are intentionally undocumented admin methods; removing the 8 doc-comment links makes RDK self-consistent with its already-unlinked siblings. No docs-side change.
  2. Document them — remove the 8 from go_ignore_app_apis and let the generator emit sections. This reverses a deliberate exclusion and may fail generation (a likely original reason for excluding them).

Blocked pending an internal decision on whether these org-admin methods are intentionally out of scope for the public API reference. The go_ignore_app_apis comment ("if they error, are deprecated, etc.") does not record which reason applies to each, so we need scope confirmation before acting. No RDK change to be made until that discussion concludes.


Surfaced by the RDK docs-link audit (viamrobotics/rdk #6199, #6201 repointed these to canonical URLs; these targets don't exist yet). Tracked by the nightly org docs-link checker (#5148).

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationrdk-doc-linksDocs pages/anchors that RDK links to but are missing (from the link audit)

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions