diff --git a/backend/resources/app/templates/api-doc-entry.tmpl b/backend/resources/app/templates/api-doc-entry.tmpl index bd3af445f..c61157ec2 100644 --- a/backend/resources/app/templates/api-doc-entry.tmpl +++ b/backend/resources/app/templates/api-doc-entry.tmpl @@ -22,11 +22,7 @@ {% endif %} {% if item.params-schema-js %} - SC - - {% else %} - - SP + SCHEMA {% endif %} diff --git a/backend/resources/app/templates/api-doc.tmpl b/backend/resources/app/templates/api-doc.tmpl index 2a0873973..4a4082537 100644 --- a/backend/resources/app/templates/api-doc.tmpl +++ b/backend/resources/app/templates/api-doc.tmpl @@ -38,7 +38,7 @@
The penpot backend right now offerts two way for authenticate the request: +
The penpot backend right now offers two way for authenticate the request: cookies (the same mechanism that we use ourselves on accessing the API from the web application) and access tokens.
diff --git a/backend/src/app/loggers/database.clj b/backend/src/app/loggers/database.clj index fac70eac6..85e5c6e3f 100644 --- a/backend/src/app/loggers/database.clj +++ b/backend/src/app/loggers/database.clj @@ -56,7 +56,7 @@ :trace (ex/format-throwable cause :data? false :explain? false :header? false :summary? false)} (when-let [params (or (:request/params context) (:params context))] - {:params (pp/pprint-str params :width 200)}) + {:params (pp/pprint-str params :width 200 :length 50 :level 10)}) (when-let [value (:value context)] {:value (pp/pprint-str value :width 200 :length 50 :level 10)}) diff --git a/backend/src/app/rpc/commands/audit.clj b/backend/src/app/rpc/commands/audit.clj index 9475a5a04..8049595c9 100644 --- a/backend/src/app/rpc/commands/audit.clj +++ b/backend/src/app/rpc/commands/audit.clj @@ -68,6 +68,7 @@ ::climit/key-fn ::rpc/profile-id ::sm/params schema:push-audit-events ::audit/skip true + ::doc/skip true ::doc/added "1.17"} [{:keys [::db/pool] :as cfg} params] (if (or (db/read-only? pool) diff --git a/backend/src/app/rpc/commands/files_thumbnails.clj b/backend/src/app/rpc/commands/files_thumbnails.clj index 9b54efe68..499592e75 100644 --- a/backend/src/app/rpc/commands/files_thumbnails.clj +++ b/backend/src/app/rpc/commands/files_thumbnails.clj @@ -67,6 +67,7 @@ (sv/defmethod ::get-file-object-thumbnails "Retrieve a file object thumbnails." {::doc/added "1.17" + ::doc/module :files ::sm/params [:map {:title "get-file-object-thumbnails"} [:file-id ::sm/uuid]] ::sm/result [:map-of :string :string] @@ -112,6 +113,7 @@ (sv/defmethod ::get-file-thumbnail {::doc/added "1.17" + ::doc/module :files ::doc/deprecated "1.19"} [{:keys [::db/pool]} {:keys [::rpc/profile-id file-id revn]}] (dm/with-open [conn (db/open pool)] @@ -220,6 +222,7 @@ mainly for render thumbnails on dashboard." {::doc/added "1.17" + ::doc/module :files ::sm/params [:map {:title "get-file-data-for-thumbnail"} [:file-id ::sm/uuid] [:features {:optional true} ::files/features]] @@ -267,6 +270,7 @@ (sv/defmethod ::upsert-file-object-thumbnail {::doc/added "1.17" + ::doc/module :files ::doc/deprecated "1.19" ::audit/skip true} [{:keys [::db/pool] :as cfg} {:keys [::rpc/profile-id file-id] :as params}] @@ -312,6 +316,7 @@ (sv/defmethod ::create-file-object-thumbnail {:doc/added "1.19" + ::doc/module :files ::audit/skip true ::sm/params schema:create-file-object-thumbnail} @@ -350,6 +355,7 @@ (sv/defmethod ::delete-file-object-thumbnail {:doc/added "1.19" + ::doc/module :files ::audit/skip true} [{:keys [::db/pool] :as cfg} {:keys [::rpc/profile-id file-id object-id]}] @@ -388,6 +394,7 @@ "Creates or updates the file thumbnail. Mainly used for paint the grid thumbnails." {::doc/added "1.17" + ::doc/module :files ::doc/deprecated "1.19" ::audit/skip true} [{:keys [::db/pool] :as cfg} {:keys [::rpc/profile-id file-id] :as params}] @@ -430,6 +437,7 @@ "Creates or updates the file thumbnail. Mainly used for paint the grid thumbnails." {::doc/added "1.19" + ::doc/module :files ::audit/skip true ::sm/params [:map {:title "create-file-thumbnail"} [:file-id ::sm/uuid] diff --git a/backend/src/app/rpc/commands/ldap.clj b/backend/src/app/rpc/commands/ldap.clj index e434f537c..c166f7c1a 100644 --- a/backend/src/app/rpc/commands/ldap.clj +++ b/backend/src/app/rpc/commands/ldap.clj @@ -38,7 +38,8 @@ "Performs the authentication using LDAP backend. Only works if LDAP is properly configured and enabled with `login-with-ldap` flag." {::rpc/auth false - ::doc/added "1.15"} + ::doc/added "1.15" + ::doc/module :auth} [{:keys [::main/props ::ldap/provider] :as cfg} params] (when-not provider (ex/raise :type :restriction diff --git a/backend/src/app/rpc/commands/search.clj b/backend/src/app/rpc/commands/search.clj index e44a21cdb..1c4026d6d 100644 --- a/backend/src/app/rpc/commands/search.clj +++ b/backend/src/app/rpc/commands/search.clj @@ -64,6 +64,7 @@ :opt-un [::search-term])) (sv/defmethod ::search-files - {::doc/added "1.17"} + {::doc/added "1.17" + ::doc/module :files} [{:keys [::db/pool]} {:keys [::rpc/profile-id team-id search-term]}] (some->> search-term (search-files pool profile-id team-id))) diff --git a/backend/src/app/rpc/commands/verify_token.clj b/backend/src/app/rpc/commands/verify_token.clj index 6f800515a..0d8ef8391 100644 --- a/backend/src/app/rpc/commands/verify_token.clj +++ b/backend/src/app/rpc/commands/verify_token.clj @@ -34,7 +34,8 @@ (sv/defmethod ::verify-token {::rpc/auth false - ::doc/added "1.15"} + ::doc/added "1.15" + ::doc/module :auth} [{:keys [::db/pool] :as cfg} {:keys [token] :as params}] (db/with-atomic [conn pool] (let [claims (tokens/verify (::main/props cfg) {:token token}) diff --git a/backend/src/app/rpc/doc.clj b/backend/src/app/rpc/doc.clj index f491fa9b1..24451e553 100644 --- a/backend/src/app/rpc/doc.clj +++ b/backend/src/app/rpc/doc.clj @@ -75,6 +75,7 @@ (->> methods (map val) (map first) + (remove ::skip) (map get-context) (sort-by (juxt :module :name)))}))