From 072222523afe612d575c2ff7e73e514692f545af Mon Sep 17 00:00:00 2001 From: Monica Khoury <99693443+monicakh@users.noreply.github.com> Date: Thu, 12 Oct 2023 19:59:06 +0300 Subject: [PATCH] Docs: Update inviteUserByEmail documentation in JS1 and JS2 (#18146) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * chore/add-invite-user-docs * Update spec/supabase_js_v1.yml Co-authored-by: Kevin Grüneberg * Update spec/supabase_js_v2.yml Co-authored-by: Kevin Grüneberg --------- Co-authored-by: Kevin Grüneberg --- spec/supabase_js_v1.yml | 1 + spec/supabase_js_v2.yml | 1 + 2 files changed, 2 insertions(+) diff --git a/spec/supabase_js_v1.yml b/spec/supabase_js_v1.yml index 610839264df..4a702066e15 100644 --- a/spec/supabase_js_v1.yml +++ b/spec/supabase_js_v1.yml @@ -533,6 +533,7 @@ functions: notes: | - Requires a `service_role` key. - This function should only be called on a server. Never expose your `service_role` key in the browser. + - The `inviteUserByEmail()` method is typically used by administrators to invite users to join the application. examples: - id: basic-example name: Basic example. diff --git a/spec/supabase_js_v2.yml b/spec/supabase_js_v2.yml index f7ef0a7f609..ee3c7e5f978 100644 --- a/spec/supabase_js_v2.yml +++ b/spec/supabase_js_v2.yml @@ -1016,6 +1016,7 @@ functions: $ref: '@supabase/gotrue-js.GoTrueAdminApi.inviteUserByEmail' notes: | - Sends an invite link to the user's email address. + - The `inviteUserByEmail()` method is typically used by administrators to invite users to join the application. examples: - id: invite-a-user name: Invite a user