docs: document full v1 API endpoint surface (#273) - #364
Merged
David-patrick-chuks-02 merged 1 commit intoSep 6, 2026
Merged
Conversation
- Comprehensive ENDPOINTS.md covering all routes (GET /health, GET /agents, POST /agents) - Request/response schemas with field constraints from Zod validation - Authentication requirements and error response format - Cross-references to related improvements (Lilly-Protocol#299 single error log, Lilly-Protocol#287 timing-safe auth) Closes Lilly-Protocol#273
Contributor
Author
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
2 participants
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.
Summary
Comprehensive documentation of the complete v1 API endpoint surface as requested in issue #273.
File Added
docs/ENDPOINTS.md: Documents all routes (GET /health,GET /agents,POST /agents) with full request/response schemas, field constraints from Zod validation, authentication requirements, error response format, and cross-references to related improvements ([Bounty: $90] Emit a single error log line per failed request instead of duplicating pino-http and error-middleware output #299 single error log, [Bounty: $75] Compare configured API keys in constant time #287 timing-safe auth).Closes #273