Skip to content

docs: publish API and operations guidance - #26

Merged
fabiorosa merged 3 commits into
mainfrom
agent/api-operations-docs
Aug 6, 2026
Merged

docs: publish API and operations guidance#26
fabiorosa merged 3 commits into
mainfrom
agent/api-operations-docs

Conversation

@fabiorosa

Copy link
Copy Markdown
Owner

Closes #25

What changed

  • publishes the OpenAPI 3.1 contract for every public Fastify route
  • updates clone-clean local setup and the product's current capability statement
  • adds a private vulnerability-reporting policy and explicit security boundaries
  • adds a pre-deployment runbook with process roles, migration order, health checks, and rollback limits
  • adds a route-presence regression test and records ADR-018

Why

The product behavior is now substantial enough that reviewers need a stable API and operational boundary before a public demo is deployed. These documents describe observable behavior and limitations without inventing a hosted service or uptime claim.

Validation

  • formatting, lint, typecheck, and build pass
  • 53 unit and HTTP tests pass
  • 24 PostgreSQL, Redis, worker, and HTTP integrations pass
  • all 11 Chromium assertions pass locally

Local Windows note

Playwright completes all assertions, but its managed web-server teardown can exceed the Windows command timeout. The GitHub Actions Quality runs are the terminal process-exit gate.

@fabiorosa
fabiorosa marked this pull request as ready for review August 6, 2026 18:28
@fabiorosa
fabiorosa merged commit 4cfb825 into main Aug 6, 2026
1 of 2 checks passed
@fabiorosa
fabiorosa deleted the agent/api-operations-docs branch August 6, 2026 18:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

WOP-303: complete API and operations documentation

1 participant