github/penpot
1
0
Fork 0
mirror of https://github.com/penpot/penpot.git synced 2026-08-27 23:28:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

📚 Unify doc added for nitrate apis (#11231)

Browse Source
This commit is contained in:
Pablo Alba 2026-08-13 11:37:06 +02:00 committed by GitHub
parent ef26231b8f
commit f7fc869e52
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 35 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
backend/src/app/rpc/commands/nitrate.clj
View File

@ -48,7 +48,7 @@
(sv/defmethod ::get-nitrate-connectivity (sv/defmethod ::get-nitrate-connectivity
{::rpc/auth true {::rpc/auth true
::doc/added "2.14" ::doc/added "2.18"
::sm/params [:map] ::sm/params [:map]
::sm/result schema:connectivity} ::sm/result schema:connectivity}
[cfg _params] [cfg _params]
@ -64,7 +64,7 @@
(sv/defmethod ::get-subscription-warning (sv/defmethod ::get-subscription-warning
{::rpc/auth true {::rpc/auth true
::doc/added "2.14" ::doc/added "2.18"
::sm/params [:map] ::sm/params [:map]
::sm/result schema:subscription-warning} ::sm/result schema:subscription-warning}
[cfg {:keys [::rpc/profile-id]}] [cfg {:keys [::rpc/profile-id]}]
@ -80,7 +80,7 @@
(sv/defmethod ::redeem-nitrate-activation-code (sv/defmethod ::redeem-nitrate-activation-code
{::rpc/auth true {::rpc/auth true
::doc/added "2.14" ::doc/added "2.18"
::sm/params schema:redeem-activation-code-params ::sm/params schema:redeem-activation-code-params
::sm/result schema:redeem-activation-code-result} ::sm/result schema:redeem-activation-code-result}
[cfg {:keys [::rpc/profile-id activation-code]}] [cfg {:keys [::rpc/profile-id activation-code]}]
@ -112,7 +112,7 @@
"Returns a Base64-encoded JSON file requesting a Nitrate activation code. "Returns a Base64-encoded JSON file requesting a Nitrate activation code.
Payload includes nitrateId, publicKey, email and iat." Payload includes nitrateId, publicKey, email and iat."
{::rpc/auth true {::rpc/auth true
::doc/added "2.20" ::doc/added "2.18"
::sm/params [:map] ::sm/params [:map]
::sm/result ::sm/text} ::sm/result ::sm/text}
[cfg {:keys [::rpc/profile-id]}] [cfg {:keys [::rpc/profile-id]}]
@ -360,7 +360,7 @@
(sv/defmethod ::leave-organization (sv/defmethod ::leave-organization
{::rpc/auth true {::rpc/auth true
::doc/added "2.15" ::doc/added "2.18"
::sm/params schema:leave-organization ::sm/params schema:leave-organization
::db/transaction true} ::db/transaction true}
[cfg {:keys [::rpc/profile-id] :as params}] [cfg {:keys [::rpc/profile-id] :as params}]
@ -404,7 +404,7 @@
[:organization-name ::sm/text]]) [:organization-name ::sm/text]])
(sv/defmethod ::remove-team-from-organization (sv/defmethod ::remove-team-from-organization
{::doc/added "2.17" {::doc/added "2.18"
::sm/params schema:remove-team-from-organization} ::sm/params schema:remove-team-from-organization}
[cfg {:keys [::rpc/profile-id team-id organization-id organization-name]}] [cfg {:keys [::rpc/profile-id team-id organization-id organization-name]}]
@ -473,7 +473,7 @@
(sv/defmethod ::add-team-to-organization (sv/defmethod ::add-team-to-organization
{::rpc/auth true {::rpc/auth true
::doc/added "2.17" ::doc/added "2.18"
::sm/params schema:add-team-to-organization ::sm/params schema:add-team-to-organization
::db/transaction true} ::db/transaction true}
[cfg {:keys [::rpc/profile-id team-id organization-id]}] [cfg {:keys [::rpc/profile-id team-id organization-id]}]
@ -558,7 +558,7 @@
(sv/defmethod ::check-organization-members (sv/defmethod ::check-organization-members
{::rpc/auth true {::rpc/auth true
::doc/added "2.17" ::doc/added "2.18"
::sm/params schema:check-organization-members-params ::sm/params schema:check-organization-members-params
::sm/result [:map-of :string :boolean] ::sm/result [:map-of :string :boolean]
::db/transaction true} ::db/transaction true}
@ -583,7 +583,7 @@
(sv/defmethod ::all-organization-members-in-team (sv/defmethod ::all-organization-members-in-team
{::rpc/auth true {::rpc/auth true
::doc/added "2.17" ::doc/added "2.18"
::sm/params schema:all-organization-members-in-team-params ::sm/params schema:all-organization-members-in-team-params
::sm/result ::sm/boolean} ::sm/result ::sm/boolean}
[cfg {:keys [::rpc/profile-id team-id organization-id]}] [cfg {:keys [::rpc/profile-id team-id organization-id]}]
@ -607,7 +607,7 @@
(sv/defmethod ::all-team-members-in-organizations (sv/defmethod ::all-team-members-in-organizations
{::rpc/auth true {::rpc/auth true
::doc/added "2.17" ::doc/added "2.18"
::sm/params schema:all-team-members-in-organizations-params ::sm/params schema:all-team-members-in-organizations-params
::sm/result [:map-of ::sm/uuid ::sm/boolean]} ::sm/result [:map-of ::sm/uuid ::sm/boolean]}
[cfg {:keys [::rpc/profile-id team-id organization-ids]}] [cfg {:keys [::rpc/profile-id team-id organization-ids]}]
@ -643,7 +643,7 @@
(sv/defmethod ::check-team-external-invitations (sv/defmethod ::check-team-external-invitations
{::rpc/auth true {::rpc/auth true
::doc/added "2.17" ::doc/added "2.18"
::sm/params schema:check-team-external-invitations-params ::sm/params schema:check-team-external-invitations-params
::sm/result schema:check-team-external-invitations-result ::sm/result schema:check-team-external-invitations-result
::db/transaction true} ::db/transaction true}
@ -677,7 +677,7 @@
the client must redirect there. The OIDC provider itself handles the client must redirect there. The OIDC provider itself handles
re-authentication transparently if the user already has an active SSO session." re-authentication transparently if the user already has an active SSO session."
{::rpc/auth true {::rpc/auth true
::doc/added "2.19" ::doc/added "2.18"
::sm/params schema:check-nitrate-sso ::sm/params schema:check-nitrate-sso
::nitrate/sso false} ::nitrate/sso false}
[cfg {:keys [::rpc/profile-id team-id organization-id url] :as params}] [cfg {:keys [::rpc/profile-id team-id organization-id url] :as params}]

46
backend/src/app/rpc/management/nitrate.clj
View File

@ -54,7 +54,7 @@
(sv/defmethod ::authenticate (sv/defmethod ::authenticate
"Authenticate the current user" "Authenticate the current user"
{::doc/added "2.14" {::doc/added "2.18"
::sm/params [:map] ::sm/params [:map]
::sm/result schema:profile ::sm/result schema:profile
::nitrate/sso false} ::nitrate/sso false}
@ -94,7 +94,7 @@
(sv/defmethod ::get-penpot-version (sv/defmethod ::get-penpot-version
"Get the current Penpot version" "Get the current Penpot version"
{::doc/added "2.14" {::doc/added "2.18"
::sm/params [:map] ::sm/params [:map]
::sm/result schema:get-penpot-version-result ::sm/result schema:get-penpot-version-result
::rpc/auth false} ::rpc/auth false}
@ -106,7 +106,7 @@
(sv/defmethod ::get-teams (sv/defmethod ::get-teams
"List teams for which current user is owner" "List teams for which current user is owner"
{::doc/added "2.14" {::doc/added "2.18"
::sm/params [:map] ::sm/params [:map]
::sm/result schema:get-teams-result ::sm/result schema:get-teams-result
::nitrate/sso false} ::nitrate/sso false}
@ -130,7 +130,7 @@
"Store an organization logo in penpot storage and return its ID. "Store an organization logo in penpot storage and return its ID.
Accepts an optional previous-id to mark the old logo for garbage Accepts an optional previous-id to mark the old logo for garbage
collection when replacing an existing one." collection when replacing an existing one."
{::doc/added "2.17" {::doc/added "2.18"
::sm/params schema:upload-organization-logo ::sm/params schema:upload-organization-logo
::sm/result schema:upload-organization-logo-result ::sm/result schema:upload-organization-logo-result
::nitrate/sso false} ::nitrate/sso false}
@ -151,7 +151,7 @@
(sv/defmethod ::notify-team-change (sv/defmethod ::notify-team-change
"Notify to Penpot a team change from nitrate" "Notify to Penpot a team change from nitrate"
{::doc/added "2.14" {::doc/added "2.18"
::sm/params cto/schema:team-with-organization ::sm/params cto/schema:team-with-organization
::rpc/auth false} ::rpc/auth false}
[cfg team] [cfg team]
@ -168,7 +168,7 @@
(sv/defmethod ::notify-user-added-to-organization (sv/defmethod ::notify-user-added-to-organization
"Notify to Penpot that an user has joined an organization from nitrate" "Notify to Penpot that an user has joined an organization from nitrate"
{::doc/added "2.14" {::doc/added "2.18"
::sm/params schema:notify-user-added-to-organization ::sm/params schema:notify-user-added-to-organization
::rpc/auth false} ::rpc/auth false}
[cfg {:keys [profile-id organization-id]}] [cfg {:keys [profile-id organization-id]}]
@ -199,7 +199,7 @@
(sv/defmethod ::get-managed-profiles (sv/defmethod ::get-managed-profiles
"List profiles that belong to teams for which current user is owner" "List profiles that belong to teams for which current user is owner"
{::doc/added "2.14" {::doc/added "2.18"
::sm/params [:map] ::sm/params [:map]
::sm/result schema:managed-profile-result ::sm/result schema:managed-profile-result
::nitrate/sso false} ::nitrate/sso false}
@ -239,7 +239,7 @@
(sv/defmethod ::get-teams-summary (sv/defmethod ::get-teams-summary
"Get summary information for a list of teams" "Get summary information for a list of teams"
{::doc/added "2.15" {::doc/added "2.18"
::sm/params schema:get-teams-summary-params ::sm/params schema:get-teams-summary-params
::sm/result schema:get-teams-summary-result ::sm/result schema:get-teams-summary-result
::nitrate/sso false} ::nitrate/sso false}
@ -360,7 +360,7 @@ RETURNING id, deleted_at;")
(sv/defmethod ::notify-organization-deletion (sv/defmethod ::notify-organization-deletion
"For a deleted organization, preserve organization teams and only prefix or delete "For a deleted organization, preserve organization teams and only prefix or delete
imported Your Penpot teams before notifying connected users." imported Your Penpot teams before notifying connected users."
{::doc/added "2.15" {::doc/added "2.18"
::sm/params schema:notify-organization-deletion ::sm/params schema:notify-organization-deletion
::rpc/auth false} ::rpc/auth false}
[cfg {:keys [organization-id]}] [cfg {:keys [organization-id]}]
@ -406,7 +406,7 @@ RETURNING id, deleted_at;")
(sv/defmethod ::get-profile-by-email (sv/defmethod ::get-profile-by-email
"Get profile by email" "Get profile by email"
{::doc/added "2.15" {::doc/added "2.18"
::sm/params [:map [:email ::sm/email]] ::sm/params [:map [:email ::sm/email]]
::sm/result schema:profile ::sm/result schema:profile
::nitrate/sso false} ::nitrate/sso false}
@ -430,7 +430,7 @@ RETURNING id, deleted_at;")
(sv/defmethod ::get-profile-by-id (sv/defmethod ::get-profile-by-id
"Get profile by email" "Get profile by email"
{::doc/added "2.15" {::doc/added "2.18"
::sm/params [:map [:id ::sm/uuid]] ::sm/params [:map [:id ::sm/uuid]]
::sm/result schema:profile ::sm/result schema:profile
::nitrate/sso false} ::nitrate/sso false}
@ -465,7 +465,7 @@ RETURNING id, deleted_at;")
(sv/defmethod ::get-organization-member-team-counts (sv/defmethod ::get-organization-member-team-counts
"Get the number of non-default teams each profile belongs to within a set of teams." "Get the number of non-default teams each profile belongs to within a set of teams."
{::doc/added "2.15" {::doc/added "2.18"
::sm/params schema:get-organization-member-team-counts-params ::sm/params schema:get-organization-member-team-counts-params
::sm/result schema:get-organization-member-team-counts-result ::sm/result schema:get-organization-member-team-counts-result
::rpc/auth false} ::rpc/auth false}
@ -505,7 +505,7 @@ RETURNING id, deleted_at;")
(sv/defmethod ::invite-to-organization (sv/defmethod ::invite-to-organization
"Invite to organization" "Invite to organization"
{::doc/added "2.15" {::doc/added "2.18"
::sm/params [:map ::sm/params [:map
[:email ::sm/email] [:email ::sm/email]
[:organization cto/schema:organization-with-avatar]] [:organization cto/schema:organization-with-avatar]]
@ -537,7 +537,7 @@ RETURNING id, deleted_at;")
(sv/defmethod ::get-organization-invitations (sv/defmethod ::get-organization-invitations
"Get valid invitations for an organization, returning at most one invitation per email." "Get valid invitations for an organization, returning at most one invitation per email."
{::doc/added "2.16" {::doc/added "2.18"
::sm/params schema:get-organization-invitations-params ::sm/params schema:get-organization-invitations-params
::sm/result schema:get-organization-invitations-result ::sm/result schema:get-organization-invitations-result
::nitrate/sso false} ::nitrate/sso false}
@ -565,7 +565,7 @@ RETURNING id, deleted_at;")
(sv/defmethod ::delete-organization-invitations (sv/defmethod ::delete-organization-invitations
"Delete all invitations for one email in an organization scope (organization + organization teams)." "Delete all invitations for one email in an organization scope (organization + organization teams)."
{::doc/added "2.16" {::doc/added "2.18"
::sm/params schema:delete-organization-invitations-params ::sm/params schema:delete-organization-invitations-params
::nitrate/sso false} ::nitrate/sso false}
[cfg {:keys [organization-id email]}] [cfg {:keys [organization-id email]}]
@ -630,7 +630,7 @@ RETURNING id, deleted_at;")
(sv/defmethod ::remove-from-organization (sv/defmethod ::remove-from-organization
"Remove an user from an organization" "Remove an user from an organization"
{::doc/added "2.17" {::doc/added "2.18"
::sm/params [:map ::sm/params [:map
[:profile-id ::sm/uuid] [:profile-id ::sm/uuid]
[:organization-id ::sm/uuid] [:organization-id ::sm/uuid]
@ -675,7 +675,7 @@ RETURNING id, deleted_at;")
(sv/defmethod ::get-remove-from-organization-summary (sv/defmethod ::get-remove-from-organization-summary
"Get a summary of the teams that would be deleted, transferred, or exited "Get a summary of the teams that would be deleted, transferred, or exited
if the user were removed from the organization" if the user were removed from the organization"
{::doc/added "2.17" {::doc/added "2.18"
::sm/params [:map ::sm/params [:map
[:profile-id ::sm/uuid] [:profile-id ::sm/uuid]
[:organization-id ::sm/uuid] [:organization-id ::sm/uuid]
@ -710,7 +710,7 @@ RETURNING id, deleted_at;")
(sv/defmethod ::send-renewal-email (sv/defmethod ::send-renewal-email
"Send an Enterprise subscription renewal notice email to a user." "Send an Enterprise subscription renewal notice email to a user."
{::doc/added "2.17" {::doc/added "2.18"
::sm/params schema:send-renewal-email-params ::sm/params schema:send-renewal-email-params
::rpc/auth false} ::rpc/auth false}
[cfg {:keys [profile-id user-email user-name renewal-date estimated-amount organizations]}] [cfg {:keys [profile-id user-email user-name renewal-date estimated-amount organizations]}]
@ -823,7 +823,7 @@ RETURNING id, deleted_at;")
"Push audit events from nitrate (strictly for nitrate backend "Push audit events from nitrate (strictly for nitrate backend
events)" events)"
{::doc/added "2.19" {::doc/added "2.18"
::audit/skip true ::audit/skip true
::sm/params schema:push-audit-events-params ::sm/params schema:push-audit-events-params
::rpc/auth false} ::rpc/auth false}
@ -930,7 +930,7 @@ RETURNING id, deleted_at;")
(sv/defmethod ::get-teams-detail (sv/defmethod ::get-teams-detail
"Get detailed information for all non-deleted teams in an organization, "Get detailed information for all non-deleted teams in an organization,
including owner info and project/file/member counts." including owner info and project/file/member counts."
{::doc/added "2.20" {::doc/added "2.18"
::sm/params schema:get-teams-detail-params ::sm/params schema:get-teams-detail-params
::sm/result schema:get-teams-detail-result ::sm/result schema:get-teams-detail-result
::nitrate/sso false} ::nitrate/sso false}
@ -958,7 +958,7 @@ RETURNING id, deleted_at;")
"Validate an organization SSO configuration by generating a login redirect URL. "Validate an organization SSO configuration by generating a login redirect URL.
Nitrate calls this while configuring SSO to verify client credentials and OIDC Nitrate calls this while configuring SSO to verify client credentials and OIDC
discovery before saving the settings." discovery before saving the settings."
{::doc/added "2.20" {::doc/added "2.18"
::sm/params cto/schema:nitrate-sso ::sm/params cto/schema:nitrate-sso
::sm/result schema:check-organization-sso-result ::sm/result schema:check-organization-sso-result
::rpc/auth false} ::rpc/auth false}
@ -968,7 +968,7 @@ RETURNING id, deleted_at;")
;; ---- API: notify-organization-sso-change ;; ---- API: notify-organization-sso-change
(sv/defmethod ::notify-organization-sso-change (sv/defmethod ::notify-organization-sso-change
"Nitrate notifies that an organization sso values have changed" "Nitrate notifies that an organization sso values have changed"
{::doc/added "2.19" {::doc/added "2.18"
::sm/params [:map ::sm/params [:map
[:organization-id ::sm/uuid] [:organization-id ::sm/uuid]
[:updated-props ::sm/boolean] [:updated-props ::sm/boolean]
@ -1017,7 +1017,7 @@ RETURNING id, deleted_at;")
bulk-creation screen; access is gated by the shared key and, in Nitrate, an bulk-creation screen; access is gated by the shared key and, in Nitrate, an
email allow-list. Requires the `admin-console-bulk-create-profiles` flag, disabled email allow-list. Requires the `admin-console-bulk-create-profiles` flag, disabled
by default so it is only available on test environments." by default so it is only available on test environments."
{::doc/added "2.19" {::doc/added "2.18"
::sm/params schema:bulk-create-profiles-params ::sm/params schema:bulk-create-profiles-params
::sm/result schema:bulk-create-profiles-result ::sm/result schema:bulk-create-profiles-result
::rpc/auth false} ::rpc/auth false}