Skip to content

[LFXV2-1413] docs: add FGA contract documentation for voting service#27

Merged
andrest50 merged 3 commits into
mainfrom
andrest50/LFXV2-1413-fga-contract-docs
Apr 15, 2026
Merged

[LFXV2-1413] docs: add FGA contract documentation for voting service#27
andrest50 merged 3 commits into
mainfrom
andrest50/LFXV2-1413-fga-contract-docs

Conversation

@andrest50
Copy link
Copy Markdown
Contributor

@andrest50 andrest50 commented Apr 6, 2026

Summary

  • Add docs/fga-contract.md documenting all FGA sync messages sent by the voting service
  • Covers vote and vote_response object types: relations set, references, triggers, and skip conditions
  • Links to the platform OpenFGA model in the helm chart repo for the full type definitions

Ticket

LFXV2-1413

🤖 Generated with [Claude Code](https://claude.ai/code)

Signed-off-by: Andres Tobon <andrest2455@gmail.com>
Copilot AI review requested due to automatic review settings April 6, 2026 23:54
@andrest50 andrest50 requested a review from a team as a code owner April 6, 2026 23:54
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a dedicated contract doc describing how the voting service publishes access-control sync messages to fga-sync (OpenFGA tuples), intended to be kept in sync with any future message-construction changes.

Changes:

  • Add docs/fga-contract.md describing FGA sync message shape, subjects, and per-object data contents.
  • Document relations/references + skip/delete behavior for vote and vote_response.
  • Summarize publish triggers per operation/object type.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/fga-contract.md
Comment thread docs/fga-contract.md Outdated
andrest50 and others added 2 commits April 6, 2026 22:36
Change "Auth0 sub" to "Auth0 username" for vote_response relations
to match the actual VoteResponseData.Username field semantics.

Generated with [Claude Code](https://claude.ai/code)

Signed-off-by: Andres Tobon <andrest2455@gmail.com>
@andrest50 andrest50 merged commit 8bdb9ec into main Apr 15, 2026
9 checks passed
@andrest50 andrest50 deleted the andrest50/LFXV2-1413-fga-contract-docs branch April 15, 2026 15:53
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.

3 participants