Skip to content

docs: bring the README in line with the implemented authentication - #17

Merged
knittingcode merged 2 commits into
mainfrom
docs/fcrm-ovn-readme-accuracy
Oct 24, 2026
Merged

knittingcode merged 2 commits into
mainfrom
docs/fcrm-ovn-readme-accuracy

Conversation

@knittingcode

@knittingcode knittingcode commented Oct 23, 2026 •

Copy link
Copy Markdown
Owner

Summary

The README described implemented authentication features as future work. This brings four lines of README.md in line with main.

Motivation and context

These statements were out of date after FND-010B and FND-010V:

  • The per-user API limit is implemented: FCRM-002 NFR-007, 600 requests per minute (backend/config/services.yaml, flowcrm.rate_limit.api_user).
  • Rate limits and their locks are stored in PostgreSQL (ADR-007).

The overnight documentation review found the discrepancy (OVN-116).

Changes

Line Change
Stack Rate limits and their locks use PostgreSQL, not "will".
Architecture Authentication now lists the per-user API limit of 600 requests per minute.
Known limitations No longer lists the per-user API rate limit as future work.
Roadmap "Implement authentication and authorization" is ticked, because FND-010B (#13) is merged. This tick is a judgement for the owner.

Testing

Security considerations

None. Documentation only.

Known limitations and dependencies

The per-user API limit (FCRM-002 NFR-007) and the PostgreSQL-backed rate-limit storage are implemented (ADR-019), and authentication and tenant authorization are merged; the README still listed them as future work.
knittingcode added a commit that referenced this pull request Oct 24, 2026
…tive controls

The per-user API limit (600 requests per minute) is implemented on main, so
the README no longer lists it as a limitation; this also matches the README
of PR #17. ADR-020 now lists all ten negative controls the branch adds.
@knittingcode
knittingcode merged commit 4f0daab into main Oct 24, 2026
2 checks passed
@knittingcode
knittingcode deleted the docs/fcrm-ovn-readme-accuracy branch October 24, 2026 08:17
knittingcode added a commit that referenced this pull request Oct 24, 2026
knittingcode added a commit that referenced this pull request Oct 24, 2026
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