docs: document run_events schema, workspace_id filter behavior, history unbounded output, pricing_import_audit fields, and unused core deps#35
Merged
Conversation
…, history unbounded output, pricing_import_audit fields, and unused core deps Co-authored-by: Gottam Sai Bharath <Gsbreddy@users.noreply.github.com>
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
Documentation improvements triggered by the push to
main(troubleshooting guide + DEVELOPMENT.md expansion). This PR fills specific knowledge gaps identified by reading the source code against the existing docs.Why
The recently landed docs (#32) added broad troubleshooting coverage. In reviewing the full docs-vs-source alignment, several concrete but underdocumented behaviors were found that could mislead integrators or operators.
Changes
docs/operations-and-policy.md— Addedrun_eventscolumn layout table: documents whichRunEventfields are stored as indexed top-level columns (filterable byquery_runs) vs. which live only insideevent_json. Clarifies thatworkspace_id,labels,request, andusage.*fields are inevent_jsononly and are not diff-query filters.docs/http-api.md— Clarifiedworkspace_idfield description: the field is stored with the event but is not used as a query filter in diff or promote/rollback paths (diff queries filter onrelease_id,tenant_id,task_id, andenvironmentonly).docs/cli.md— Added note toflightdeck release history: the command returns all matching rows with no limit, unlikeGET /v1/actionswhich accepts alimitquery parameter (1–500, default 50).docs/release-artifact.md— Expandedpricing_import_auditsection: replaced the prose field list with a structured table (all 10 columns with types and descriptions) and added asqlite3query example for inspecting the audit trail directly.DEVELOPMENT.md— Added note under Package extras:sqlalchemy,aiosqlite, andrichappear as core dependencies inpyproject.tomlbut are not imported bysrc/flightdeck/(the package uses stdlibsqlite3and plain Click output). Documents these as leftover prototype entries scheduled for removal.Validation
uv sync --frozen --extra devuv run python -m ruff check src tests— all checks passeduv run python -m pytest— 94 passeduv run python scripts/generate_schemas.pythengit diff --exit-code schemas/— clean (no model changes)web/changes)Schema / Storage Impact
Risk
Documentation-only. No code changes; no behavior changes; no schema drift.
Notes
All changes verified against
src/flightdeck/storage.py(column definitions,query_runsWHERE clauses),src/flightdeck/cli/main.py(history command usesstorage.list_release_actionswith no limit), andsrc/flightdeck/server/routes/read.py(GET /v1/actionsusesaction_limit=limit).