docs: add POST /close to API Endpoints section in README#7572
Merged
Conversation
Copilot
AI
changed the title
[WIP] Update documentation to include POST /close endpoint
docs: add POST /close to API Endpoints section in README
Jun 15, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Adds documentation for the existing POST /close graceful-shutdown endpoint to the README’s API Endpoints reference, improving discoverability of the shutdown mechanism and its authentication/HMAC characteristics.
Changes:
- Documented
POST /closein the## API Endpointslist, including that it is auth-protected when an agent ID is configured and is not HMAC-protected.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds POST /close to the API Endpoints section with a brief security/auth note. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 0
This was referenced Jun 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
POST /closegraceful-shutdown endpoint was fully implemented and auth-protected but absent from the API Endpoints reference inREADME.md, making it undiscoverable without reading source code.Changes
POST /closeentry to the API Endpoints list, noting it is auth-protected when an agent ID is configured and intentionally not HMAC-protected (consistent with/health).