Skip to content

Document local-only API guardrails - #74

Merged
Alajmah merged 1 commit into
mainfrom
api65-local-docs
Jun 8, 2026
Merged

Alajmah merged 1 commit into
mainfrom
api65-local-docs

Conversation

@Alajmah

@Alajmah Alajmah commented Jun 7, 2026

Copy link
Copy Markdown
Contributor

Summary

Documents the current local-only API trust boundary.

Changes

  • Adds local usage expectations.
  • Adds a remote exposure checklist.
  • Notes that API routes are not production-ready without an auth boundary.

Closes #65.

Validation

Docs-only change; CI should run on this PR.

@chatgpt-codex-connector chatgpt-codex-connector 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 32a8c9a478

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/API_LOCAL_ONLY.md

## Route-level implications

Read-only report and approval inspection routes can disclose project metadata. Mutating approval routes can apply approved patches, move approval artifacts, and create Git commits. Both categories require an authorization boundary before remote use.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Remove the nonexistent mutating approval routes

The current create_app() surface has only POST /commands and read-only approval list/detail endpoints; it exposes no route that approves a request, applies a patch, moves approval artifacts, or creates a Git commit. In the current API context, this statement therefore misdocuments the available behavior and threat model; either describe the actual /commands mutations (approval/activity record creation) or defer these implications until approval mutation routes exist.

Useful? React with 👍 / 👎.

@Alajmah
Alajmah merged commit 62e0284 into main Jun 8, 2026
2 checks passed
@Alajmah
Alajmah deleted the api65-local-docs branch June 8, 2026 01:00
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.

Add explicit local-only API guardrails

1 participant