Skip to content

Restore admin route DOC metadata for /api/v1/docs - #67

Merged
erinepshovel-code merged 2 commits into
mainfrom
copilot/fix-code-comments-review-thread
May 25, 2026
Merged

erinepshovel-code merged 2 commits into
mainfrom
copilot/fix-code-comments-review-thread

Conversation

Copilot AI commented May 25, 2026

Copy link
Copy Markdown
Contributor

This addresses the linked PR review thread by restoring the missing documentation metadata for the admin email allowlist route. The docs collector already includes admin.py; this change makes that module discoverable again in /api/v1/docs.

  • Problem

    • python/routes/admin.py was on the explicit collect_doc_meta() allowlist, but it no longer contained a # DOC block.
    • Result: the admin email allowlist endpoints were omitted from the generated docs output despite being registered for collection.
  • Change

    • Re-added the route-level # DOC metadata in python/routes/admin.py:
      • module label and description
      • tier
      • endpoint entries for list/add/remove admin emails
    • Updated the file annotation stamp after the edit to keep repo-required metadata consistent.
  • Effect

    • /api/v1/docs can surface the admin module again without changing any route behavior or collector logic.
    • Scope stays limited to the review-thread issue; no runtime path or API contract changed.
# DOC module: admin
# DOC label: Admin Email Allowlist
# DOC description: Admin-only endpoints for listing, adding, and removing admin email allowlist entries.
# DOC tier: admin
# DOC endpoint: GET /api/v1/admin/emails | List configured admin email entries.
# DOC endpoint: POST /api/v1/admin/emails | Add an admin email entry.
# DOC endpoint: DELETE /api/v1/admin/emails/{email} | Remove an admin email entry.

Copilot AI self-assigned this May 25, 2026
Copilot AI review requested due to automatic review settings May 25, 2026 08:27
Copilot AI removed the request for review from Copilot May 25, 2026 08:27
Agent-Logs-Url: https://github.com/The-Interdependency/a0/sessions/6b38ee8f-7a98-4f93-bdd7-559f79c0b903

Co-authored-by: erinepshovel-code <250928284+erinepshovel-code@users.noreply.github.com>
Copilot AI requested review from Copilot and removed request for Copilot May 25, 2026 08:31
Copilot AI changed the title [WIP] Fix code based on review comments Restore admin route DOC metadata for /api/v1/docs May 25, 2026
Copilot AI requested a review from erinepshovel-code May 25, 2026 08:32
@erinepshovel-code
erinepshovel-code marked this pull request as ready for review May 25, 2026 09:14
Copilot AI review requested due to automatic review settings May 25, 2026 09:14
@erinepshovel-code
erinepshovel-code merged commit 51f6e98 into main May 25, 2026
6 checks passed
Copilot AI removed the request for review from Copilot May 25, 2026 09:35
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.

2 participants