Skip to content

docs: mention GET /api/status on Pages - #22

Merged
gesh75 merged 1 commit into
mainfrom
docs/pages-api-status
Aug 29, 2026
Merged

gesh75 merged 1 commit into
mainfrom
docs/pages-api-status

Conversation

@gesh75

@gesh75 gesh75 commented Aug 29, 2026 •

Copy link
Copy Markdown
Owner

Why

GET /api/status is public on main ({api_auth, approve_hmac, seal, egress} — no secrets). Pages documented mint/promote/X-Aegis-Key but not this route.

What

  • serve.py component blurb lists GET /api/status.
  • Data-flow last step notes the status route reports HMAC / API-auth posture.

HMAC tokens themselves were already on the live page from #21.

Summary by Sourcery

Document the public status endpoint and the authentication posture it exposes.

Enhancements:

  • Document the public GET /api/status endpoint and clarify that it reports HMAC and API-auth posture without exposing secrets.

Documentation:

  • Update the Pages component and data-flow documentation to include GET /api/status.

PR #21 added a public /api/status that reports api_auth, approve_hmac,
seal, and egress with no secrets. The Pages component map listed mint
and promote but omitted status.
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@sourcery-ai

sourcery-ai Bot commented Aug 29, 2026 •

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates the Pages documentation to cover the public GET /api/status route, including its {api_auth, approve_hmac, seal, egress} posture fields and their role in describing authentication requirements.

File-Level Changes

Change Details Files
Document the public status endpoint and the authentication posture it exposes.
  • Add GET /api/status to the data-flow documentation, noting that it reports HMAC and API-auth requirements.
  • Update the serve.py component description to document the public response fields and clarify that it contains no secrets.
docs/index.html

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@gesh75
gesh75 merged commit 5a6f5ba into main Aug 29, 2026
3 checks passed

@cursor cursor Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved. Cursor Bugbot was not present after the first check poll, so that signal was skipped. The current head is documentation-only with no applicable approval policy requiring human review, and no reviewers were assigned.

Open in Web View Automation 

Sent by Cursor Approval Agent: Pull Request Router and Approver

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!

Sourcery assessment

Approved.


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

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