Merged
Conversation
Adds sections: - A7: Worker recovery & auto-restart (circuit breaker, degraded state) - A8: Graceful shutdown (SIGTERM handling, drain active tasks) - A9: RetryableError (Python SDK retry semantics) - A10: Stdout protection (Python SDK print safety) - B9: Batch enqueue endpoint - B10: Auth on previously public routes (breaking change) - B11: Body size limit - B12: Input validation (API-side)
…rmat note
- Document two separate APIs: Main (X-API-Key) vs Monitoring (cookie JWT)
- Fix routes: monitoring endpoints are under /monitoring/api/*
- Fix batch enqueue format: {queue, jobs[]} not {tasks[]}
- Fix status codes: pause/resume return 204, vault create returns 201
- Fix task response: ID at info.id not task_id
- Add B0 monitoring auth setup section
- Note queue config requires priority >= 1
- Note task poll is long-poll (no 408 timeout)
- Document known bug: monitoring API uses {error} not {errors[]}
- Remove incorrect B12 special chars test (no validation exists)
fix: correct API docs — dual API auth, routes, batch format, error format
tests: add recovery, shutdown, retry, auth, batch functional tests
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.
No description provided.