From d73737cb655ab462b93c57ffa97bf61ece1947ae Mon Sep 17 00:00:00 2001 From: John Brunton <1276413+jbrunton@users.noreply.github.com> Date: Tue, 24 Sep 2024 07:38:16 -0400 Subject: [PATCH] docs: link to commands --- services/api/architecture.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/services/api/architecture.md b/services/api/architecture.md index 6f2b5a4f..6244e0de 100644 --- a/services/api/architecture.md +++ b/services/api/architecture.md @@ -6,6 +6,8 @@ The domain is organised around these fundamental concepts: - {@link domain/entities/messages/message | Messages} refer to the messages sent by users and by the system. +- {@link domain/entities/commands | Commands} refer to a specific type of message, a command, which will (when authorized) trigger a change to entities in the system (e.g. `/rename room My Room`). + - {@link domain/entities/rooms/room | Rooms} are the message rooms users may join, to which messages are sent. - {@link domain/entities/memberships/membership | Memberships} represent the membership status history (`PendingApproval`, `Joined`, `Revoked`, etc.) of a user for a given room. This history is used to authorize users using an {@link domain/usecases/auth-service | AuthService}.