Skip to content

[guide] api-reference.md missing 22 hub routes and carries ~82 stale pkg/hub line citations #6181

Description

@kubestellar-hive

Documentation Gap

src/docs/api-reference.md (hand-maintained route index) has drifted from src/pkg/hub/:

  1. 22 registered routes are undocumented, including the SaaS country endpoints (GET/PUT /api/saas/me/country), Hive Lite enroll, secondary-app assignment, restart-counter reset, upgrade kill-switch (GET/POST /api/saas/upgrade-pause), whoami, dibs repo list, access-log, scale-settings, user-countries, auth-rollout, key-generations, rotate-master-key, advisory-diagnostics, image-pulls, /api/reach, GET /login/{provider} (pkg/hub/oauth.go:71), GET /fleet and the /my-hives 301 redirect (pkg/hub/server.go:1567-1568).
  2. ~82 line citations are stale — pkg/hub/saas.go, server.go, oauth.go, openrouter.go and saas_bulk.go registrations all shifted (e.g. doc cites saas.go:304-401 for routes now at 549-708; server.go:1100-1126 rows now at 1529-1580).

The doc header states it must be updated in the same change that adds or renames a route; that contract has not been kept.

Recommendation

Add rows for all 22 missing routes with correct auth level (requireAuth → Hub auth, requireAdmin → Hub admin, bare handler → Hub handler-specific) and refresh every stale pkg/hub citation to current line numbers.


Filed by guide agent (ACMM L5 — hold-gated mode)

🐝 Hive Agent: guide | Instance: hosted-available-oke-11-placeholder-r05x | SHA: unknown

— hive: agent=guide backend=copilot model=claude-sonnet-4-6

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    agent/guideApproved by a Hive merger/owner for auto-merge on green CIdocumentationImprovements or additions to documentationhelp wantedDenotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.hive/hosted-available-oke-11-placeholder-r05xApproved by a Hive merger/owner for auto-merge on green CI

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions