docs: document real filter behavior on API request pages#33
Merged
Conversation
Ground the query/filter parameter docs in the daemon source (coven-cli api.rs + store.rs) instead of partial descriptions: - Hoist the events cursor filters (afterSeq, afterEventId, limit) into shared components/parameters so GET /events and the path-scoped variant cannot drift, and document previously omitted behavior: afterSeq wins when both cursors are supplied, non-integer values fail with 400 invalid_request, unknown afterEventIds read from the start of the log, out-of-range limits clamp to 1-1000, and hasMore is only meaningful when a limit is set - Fix the misleading GET /sessions description: the endpoint accepts no filter parameters and there is no archived query flag; archived records are CLI/TUI-only (coven sessions --all) - Hide the stray pill rendered before API routes: fumadocs-openapi emits the leading empty path segment as an empty <code>, which the dark-mode inline-code styling turned into a blob Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the daemon OpenAPI spec and global styling to better reflect actual query/filter behavior on API request pages and to fix a UI rendering artifact in the route header.
Changes:
- Clarifies
GET /sessionsdocumentation to explicitly state there are no filter/query parameters and that archived sessions are excluded. - Deduplicates events cursor/limit query parameter docs by extracting them into shared
components/parametersand reusing them across events endpoints. - Hides empty inline
<code>elements to eliminate the stray “pill/blob” rendered before some OpenAPI route paths.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| openapi/coven.daemon.v1.yaml | Refines sessions endpoint docs and centralizes events cursor/limit parameter definitions via component refs. |
| app/globals.css | Adds a global CSS rule to hide empty inline code elements causing an OpenAPI route header artifact. |
Comment on lines
+681
to
+685
| Maximum number of events to return. Out-of-range values are clamped | ||
| to 1–1000 rather than rejected; non-integer values fail with | ||
| `400 invalid_request`. When omitted, all events after the cursor are | ||
| returned in one page. `hasMore` in the response is only meaningful | ||
| when a limit is set — it is `true` when the page filled the limit. |
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.
Summary
Grounds the API request pages' filter/query parameter docs in the daemon source (
coven-cliapi.rs+store.rs) and fixes a rendering artifact in the route header.afterSeq,afterEventId,limit): hoisted into sharedcomponents/parameterssoGET /eventsand the path-scopedGET /sessions/{id}/eventscannot drift, with previously undocumented behavior now stated —afterSeqtakes precedence when both cursors are supplied; non-integer values fail with400 invalid_request; unknownafterEventIds read from the start of the log; out-of-range limits clamp to 1–1000 rather than rejecting;hasMoreis only meaningful when a limit is set.GET /sessions: the description implied tooling could call it "with and without archived filtering" — the daemon accepts no query parameters on this route. It now says so and points tocoven sessions --allfor archived records./and renders the leading empty segment as an empty<code>, which the dark-mode inline-code pill styling turned into a blob (GET ▢/sessions). A scoped:not(pre) > code:empty { display: none }removes it.Verification
list_session_events/list_events_with_options/ route match arms in the daemon sourcepnpm run openapi:buildregenerates cleanly; rendered pages screenshot-verified (Range chips, precedence notes, blob gone)🤖 Generated with Claude Code