From f2ecc61b78e1d172cb31f6aaf9af846066f3ebac9126a387394bb031bf8ebd1e Mon Sep 17 00:00:00 2001 From: aslan Date: Tue, 23 Dec 2025 14:47:12 -0500 Subject: [PATCH] Formatting --- docs/api/channel.md | 3 ++- docs/api/community.md | 12 ++++++++---- docs/api/role.md | 3 ++- docs/api/session.md | 3 ++- docs/api/user.md | 12 ++++++++---- 5 files changed, 22 insertions(+), 11 deletions(-) diff --git a/docs/api/channel.md b/docs/api/channel.md index 4aebb3d..706ee5f 100644 --- a/docs/api/channel.md +++ b/docs/api/channel.md @@ -1,5 +1,6 @@ ## GET /api/v1/channel/{id} -*Requires authentication header* +*Requires an authentication header* + Returns a channel with id = {id} ### Response: diff --git a/docs/api/community.md b/docs/api/community.md index f4dffed..98edb9d 100644 --- a/docs/api/community.md +++ b/docs/api/community.md @@ -1,5 +1,6 @@ ## GET /api/v1/community/{id} -*Requires authentication header* +*Requires an authentication header* + Returns a community with id = {id} ### Response: @@ -11,7 +12,8 @@ Returns a community with id = {id} ``` ## GET /api/v1/community/{id}/members -*Requires authentication header* +*Requires an authentication header* + Returns users for a community with id = {id} ### Response: @@ -29,7 +31,8 @@ Returns users for a community with id = {id} ``` ## GET /api/v1/community/{id}/channels -*Requires authentication header* +*Requires an authentication header* + Returns channels for a community with id = {id} ### Response: @@ -47,7 +50,8 @@ Returns channels for a community with id = {id} ``` ## GET /api/v1/community/{id}/roles -*Requires authentication header* +*Requires an authentication header* + Returns roles for a community with id = {id} ### Response: diff --git a/docs/api/role.md b/docs/api/role.md index 7a7b2cf..b4daeee 100644 --- a/docs/api/role.md +++ b/docs/api/role.md @@ -1,5 +1,6 @@ ## GET /api/v1/role/{id} -*Requires authentication header* +*Requires an authentication header* + Returns a role with id = {id} ### Response: diff --git a/docs/api/session.md b/docs/api/session.md index baea870..476e83a 100644 --- a/docs/api/session.md +++ b/docs/api/session.md @@ -1,5 +1,6 @@ ## GET /api/v1/session/{id} -*Requires authentication header* +*Requires an authentication header* + Returns a session with id = {id} ### Response: diff --git a/docs/api/user.md b/docs/api/user.md index c6b6969..4aff1ad 100644 --- a/docs/api/user.md +++ b/docs/api/user.md @@ -1,5 +1,6 @@ ## GET /api/v1/user/{id} -*Requires authentication header* +*Requires an authentication header* + Returns a user with id = {id} ### Response: @@ -16,7 +17,8 @@ Returns a user with id = {id} ``` ## GET /api/v1/user/{id}/sessions -*Requires authentication header* +*Requires an authentication header* + Returns all sessions for a user with id = {id} ### Response: @@ -32,7 +34,8 @@ Returns all sessions for a user with id = {id} ``` ## POST /api/v1/user/{id}/email -*Requires authentication header* +*Requires an authentication header* + ### Request: ```json { @@ -51,7 +54,8 @@ Updates email for a user with id = {id} ``` ## POST /api/v1/user/{id}/description -*Requires authentication header* +*Requires an authentication header* + ### Request: ```json {