From 7eecd50c50d12ce5b37ecd6e5f178e052af3eea8 Mon Sep 17 00:00:00 2001
From: Andrey Antukh <niwi@niwi.nz>
Date: Wed, 6 Mar 2024 09:24:37 +0100
Subject: [PATCH] :books: Add http methods documentation to the API doc page

---
 backend/resources/app/templates/api-doc.tmpl | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/backend/resources/app/templates/api-doc.tmpl b/backend/resources/app/templates/api-doc.tmpl
index aa0b2a7d97..8c67fdeeeb 100644
--- a/backend/resources/app/templates/api-doc.tmpl
+++ b/backend/resources/app/templates/api-doc.tmpl
@@ -37,6 +37,13 @@
 
         <h2>GENERAL NOTES</h2>
 
+        <h3>HTTP Transport & Methods</h3>
+        <p>The HTTP is the transport method for accesing this API; all
+        functions can be called using POST HTTP method; the functions
+        that starts with <b>get-</b> in the name, can use GET HTTP
+        method which in many cases benefits from the HTTP cache.</p>
+
+
         <h3>Authentication</h3>
         <p>The penpot backend right now offers two way for authenticate the request:
         <b>cookies</b> (the same mechanism that we use ourselves on accessing the API from the