Skip to content

feat(api): Wire API_RATE_LIMIT, optional OpenAPI off, ops/docs#38

Merged
spideystreet merged 29 commits into
developfrom
refactor/api-review
Apr 29, 2026
Merged

feat(api): Wire API_RATE_LIMIT, optional OpenAPI off, ops/docs#38
spideystreet merged 29 commits into
developfrom
refactor/api-review

Conversation

@spideystreet
Copy link
Copy Markdown
Collaborator

Summary

API behavior matches documented env; compose and docs updated; readiness audit artifact.

Changes

  • Rate limit: API_RATE_LIMIT drives SlowAPI (replaces hardcoded 60/minute).
  • Prod surface: API_ENABLE_OPENAPI=false disables /docs, /redoc, /openapi.json.
  • Ops: docker-compose + .env.example pass OST_LINKER_REQUIRE_SERVICE_TOKEN / OpenAPI flags.
  • Docs: AGENTS.md, README license (CC BY-NC vs OSI), docs/READINESS-AUDIT.md.

Tests

  • make ci-check (local)
  • tests/unit/test_rate_limit_spec.py

Made with Cursor

- Name compose project ost-linker; add org.open-source-together.* labels for Docker Desktop filter/search (stack=ost, app=linker, per-role).
- Share dbt_target volume between webserver and daemon; init runs dbt parse before build and daemon ensures manifest when missing.
- Run container entrypoint as root, chown named volumes, then gosu appuser (fixes Permission denied on /app/dbt/target).
- Configurable DAGSTER_HOST_PORT when host :3000 is busy; document in .env.example.
- Label dev db service in compose.override for the same OST metadata.

Made-with: Cursor
…I_ENABLE_OPENAPI

- Build RATE_LIMIT from API_RATE_LIMIT (same semantics as pydantic defaults)
- When API_ENABLE_OPENAPI is false, disable /openapi.json, /docs, /redoc
- Add unit tests for rate_limit_per_minute()

Made-with: Cursor
…udit

- Pass OST_LINKER_REQUIRE_SERVICE_TOKEN and API_ENABLE_OPENAPI via compose
- Extend .env.example and AGENTS.md for new variables
- README: clarify CC BY-NC vs OSI open source
- Add docs/READINESS-AUDIT.md (audit follow-up note)

Made-with: Cursor
@spideystreet spideystreet changed the base branch from staging to develop April 29, 2026 15:52
@spideystreet spideystreet self-assigned this Apr 29, 2026
@spideystreet spideystreet merged commit 1f2955d into develop Apr 29, 2026
@spideystreet spideystreet deleted the refactor/api-review branch April 29, 2026 16:42
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.

1 participant