Skip to content

Commit dceb8ad

Browse files
authored
Merge pull request #993 from hieuwu/feature/improve-name-edge-function
Improve docs to put more context of the parameter when a function is renamed
2 parents 19e4d10 + c757860 commit dceb8ad

File tree

1 file changed

+4
-4
lines changed
  • Functions/src/commonMain/kotlin/io/github/jan/supabase/functions

1 file changed

+4
-4
lines changed

Functions/src/commonMain/kotlin/io/github/jan/supabase/functions/Functions.kt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ class Functions(override val config: Config, override val supabaseClient: Supaba
6060

6161
/**
6262
* Invokes a remote edge function. The authorization token is automatically added to the request.
63-
* @param function The function to invoke
63+
* @param function The function to invoke. If name of the function is renamed, use the slug after URL
6464
* @param builder The request builder to configure the request
6565
* @param region The region where the function is invoked
6666
* @throws RestException or one of its subclasses if receiving an error response
@@ -77,7 +77,7 @@ class Functions(override val config: Config, override val supabaseClient: Supaba
7777
/**
7878
* Invokes a remote edge function. The authorization token is automatically added to the request.
7979
* Note, if you want to serialize [body] to json, you need to add the [HttpHeaders.ContentType] header yourself.
80-
* @param function The function to invoke
80+
* @param function The function to invoke. If name of the function is renamed, use the slug after URL
8181
* @param body The body of the request
8282
* @param headers Headers to add to the request
8383
* @param region The region where the function is invoked
@@ -93,7 +93,7 @@ class Functions(override val config: Config, override val supabaseClient: Supaba
9393

9494
/**
9595
* Invokes a remote edge function. The authorization token is automatically added to the request.
96-
* @param function The function to invoke
96+
* @param function The function to invoke. If name of the function is renamed, use the slug after URL
9797
* @param headers Headers to add to the request
9898
* @param region The region where the function is invoked
9999
* @throws RestException or one of its subclasses if receiving an error response
@@ -107,7 +107,7 @@ class Functions(override val config: Config, override val supabaseClient: Supaba
107107

108108
/**
109109
* Builds an [EdgeFunction] which can be invoked multiple times
110-
* @param function The function name
110+
* @param function The function name. If name of the function is renamed, use the slug after URL
111111
* @param headers Headers to add to the requests when invoking the function
112112
* @param region The region where the function is invoked
113113
*/

0 commit comments

Comments
 (0)