docs(member): clarify the :overview vs :read read actions

This commit is contained in:
Simon 2026-07-06 15:42:32 +02:00
parent 4adb6be5e5
commit c9dd900a5f
2 changed files with 6 additions and 1 deletions

View file

@ -271,7 +271,10 @@ defmodule Mv.Membership.Member do
# action only enables keyset pagination with a unique `id` tie-breaker so
# pages never skip or duplicate rows.
read :overview do
description "Keyset-paginated member overview read"
# Distinct from the plain `:read` (`list_members`), which returns the full
# unpaginated set: `:overview` (`overview_members`) is keyset-paginated and
# left intentionally bare so `OverviewQuery` composes filters/sort onto it.
description "Keyset-paginated, externally-composed member overview read"
pagination keyset?: true, default_limit: 50, required?: false
end