From 7570945cf007b2be16529c62f86727033f401167 Mon Sep 17 00:00:00 2001 From: Diego Gsponer Date: Fri, 22 Dec 2023 18:27:07 +0100 Subject: [PATCH] Documentation: organize API endpoints (#5077) --- docs/api.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/api.md b/docs/api.md index 2ff8f077d..82244936f 100644 --- a/docs/api.md +++ b/docs/api.md @@ -8,20 +8,22 @@ most of the available filters and ordering fields. The API provides the following main endpoints: +- `/api/consumption_templates/`: Full CRUD support. +- `/api/correspondents/`: Full CRUD support. +- `/api/custom_fields/`: Full CRUD support. - `/api/documents/`: Full CRUD support, except POSTing new documents. See below. -- `/api/correspondents/`: Full CRUD support. - `/api/document_types/`: Full CRUD support. +- `/api/groups/`: Full CRUD support. - `/api/logs/`: Read-Only. -- `/api/tags/`: Full CRUD support. -- `/api/tasks/`: Read-only. - `/api/mail_accounts/`: Full CRUD support. - `/api/mail_rules/`: Full CRUD support. -- `/api/users/`: Full CRUD support. -- `/api/groups/`: Full CRUD support. -- `/api/share_links/`: Full CRUD support. -- `/api/custom_fields/`: Full CRUD support. - `/api/profile/`: GET, PATCH +- `/api/share_links/`: Full CRUD support. +- `/api/storage_paths/`: Full CRUD support. +- `/api/tags/`: Full CRUD support. +- `/api/tasks/`: Read-only. +- `/api/users/`: Full CRUD support. All of these endpoints except for the logging endpoint allow you to fetch (and edit and delete where appropriate) individual objects by