local-it/mitgliederverwaltung
local-it/mitgliederverwaltung
2
3
Fork 0
Code Issues 59 Pull requests 5 Projects 2 Releases 5 Packages 1 Activity Actions

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

Browse source
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
Download patch file Download diff file Expand all files Collapse all files

5
lib/membership/member.ex
View file

@ -271,7 +271,10 @@ defmodule Mv.Membership.Member do
# action only enables keyset pagination with a unique `id` tie-breaker so # action only enables keyset pagination with a unique `id` tie-breaker so
# pages never skip or duplicate rows. # pages never skip or duplicate rows.
read :overview do 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 pagination keyset?: true, default_limit: 50, required?: false
end end

2
lib/membership/membership.ex
View file

@ -44,6 +44,8 @@ defmodule Mv.Membership do
resources do resources do
resource Mv.Membership.Member do resource Mv.Membership.Member do
define :create_member, action: :create_member define :create_member, action: :create_member
# `list_members` returns the full unpaginated set; `overview_members` is the
# keyset-paginated base for the member overview (composed by OverviewQuery).
define :list_members, action: :read define :list_members, action: :read
define :overview_members, action: :overview define :overview_members, action: :overview
define :update_member, action: :update_member define :update_member, action: :update_member