Skip to content

[LFXV2-1405] docs: add indexer-contract.md for member service#31

Draft
andrest50 wants to merge 3 commits into
mainfrom
docs/LFXV2-1405-indexer-contract
Draft

[LFXV2-1405] docs: add indexer-contract.md for member service#31
andrest50 wants to merge 3 commits into
mainfrom
docs/LFXV2-1405-indexer-contract

Conversation

@andrest50

@andrest50 andrest50 commented Apr 6, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Creates docs/indexer-contract.md as the authoritative reference for all data the member service sends to the indexer service
  • Documents 4 resource types: MembershipTier, ProjectMembership, KeyContact, and B2BOrg
  • Each resource type covers: data schema, tags, access control (IndexingConfig), search behavior, and parent references
  • Follows the exact pattern established by lfx-v2-committee-service in LFXV2-1377

Ticket

LFXV2-1405 — Document Query Service Data & Types — lfx-v2-member-service

🤖 Generated with Claude Code

Documents all data types and messages that lfx-v2-member-service sends
to the indexer service. Covers 4 resource types — MembershipTier,
ProjectMembership, KeyContact, and B2BOrg — each with data schema,
tags, access control (IndexingConfig), search behavior, and parent
references. Follows the pattern established by lfx-v2-committee-service
in LFXV2-1377.

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

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

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Adds an indexer-contract.md document to define (and keep in sync) the intended indexing contract for data emitted by the member service to the indexer/query stack.

Changes:

  • Introduces docs/indexer-contract.md documenting indexed resource schemas, tags, access control (IndexingConfig), search behavior, and parent references for: MembershipTier, ProjectMembership, KeyContact, and B2BOrg.

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

Comment thread docs/indexer-contract.md Outdated
Comment thread docs/indexer-contract.md Outdated
Comment thread docs/indexer-contract.md Outdated
- Mark tier_uid as optional in ProjectMembership and KeyContact data
  schemas; it may be empty when the Asset/tier relationship is absent
- Update ProjectMembership parent ref: membership_tier:{tier_uid} is
  only emitted when tier_uid is non-empty
- Update company_domain tag examples and notes for ProjectMembership
  and KeyContact to reflect that Account.Website may be a full URL,
  not necessarily a bare domain

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

Signed-off-by: Andres Tobon <andrest2455@gmail.com>
@emsearcy

emsearcy commented Apr 6, 2026

Copy link
Copy Markdown
Contributor

The member service doesn't index anything, so there would be no reason to merge this at this time IMO.

I have proposed indexing_config configuration in the proposed architecture at https://github.com/linuxfoundation/lfx-v2-member-service/blob/52b7415c99b57c1ece9ebf821cbb123feccb63a2/ARCHITECTURE.md -- but that work hasn't happened yet (this was what I self-submitted for architecture review for transparency/feedback).

See also https://linuxfoundation.atlassian.net/browse/LFXV2-1363 as the backlog ticket for implementing this as part of the proposed architecture

@andrest50 andrest50 marked this pull request as draft April 6, 2026 23:45
…section

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

Signed-off-by: Andres Tobon <andrest2455@gmail.com>
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