Skip to content

Commit fd11b65

Browse files
burmeciacemalkilic
authored andcommitted
docs: update README to use better syntax for json code block (#1935)
## What kind of change does this PR introduce? This PR is to update `README` to use better syntax for `json` code block. ## What is the current behavior? Some of `json` code blocks aren't valid json format, e.g it shows comments in red: <img width="844" alt="image" src="https://github.com/user-attachments/assets/a4a9a8ec-a8f3-4204-a212-605f7d9924f3" /> ## What is the new behavior? Use `js` syntax for `json` code block for better looking. ## Additional context N/A
1 parent 79da813 commit fd11b65

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -829,7 +829,7 @@ Register a new user with an email and password.
829829

830830
returns:
831831

832-
```json
832+
```js
833833
{
834834
"id": "11111111-2222-3333-4444-5555555555555",
835835
"email": "[email protected]",
@@ -854,7 +854,7 @@ Register a new user with a phone number and password.
854854

855855
Returns:
856856

857-
```json
857+
```js
858858
{
859859
"id": "11111111-2222-3333-4444-5555555555555", // if duplicate sign up, this ID will be faux
860860
"phone": "12345678",
@@ -906,7 +906,7 @@ This endpoint requires the `service_role` or `supabase_admin` JWT set as an Auth
906906

907907
e.g.
908908

909-
```json
909+
```js
910910
headers: {
911911
"Authorization" : "Bearer eyJhbGciOiJI...M3A90LCkxxtX9oNP9KZO"
912912
}
@@ -996,7 +996,7 @@ query params:
996996

997997
User will be logged in and redirected to:
998998

999-
```json
999+
```
10001000
SITE_URL/#access_token=jwt-token-representing-the-user&token_type=bearer&expires_in=3600&refresh_token=a-refresh-token&type=invite
10011001
```
10021002

@@ -1011,7 +1011,7 @@ One-Time-Password. Will deliver a magiclink or sms otp to the user depending on
10111011

10121012
If `"create_user": true`, user will not be automatically signed up if the user doesn't exist.
10131013

1014-
```json
1014+
```js
10151015
{
10161016
"phone": "12345678" // follows the E.164 format
10171017
"create_user": true
@@ -1020,7 +1020,7 @@ If `"create_user": true`, user will not be automatically signed up if the user d
10201020

10211021
OR
10221022

1023-
```json
1023+
```js
10241024
// exactly the same as /magiclink
10251025
{
10261026
"email": "[email protected]"
@@ -1087,7 +1087,7 @@ query params:
10871087

10881088
body:
10891089

1090-
```json
1090+
```js
10911091
// Email login
10921092
{
10931093
"email": "[email protected]",
@@ -1192,7 +1192,7 @@ If `GOTRUE_SECURITY_UPDATE_PASSWORD_REQUIRE_REAUTHENTICATION` is enabled, the us
11921192

11931193
Sends a nonce to the user's email (preferred) or phone. This endpoint requires the user to be logged in / authenticated first. The user needs to have either an email or phone number for the nonce to be sent successfully.
11941194

1195-
```json
1195+
```js
11961196
headers: {
11971197
"Authorization" : "Bearer eyJhbGciOiJI...M3A90LCkxxtX9oNP9KZO"
11981198
}

0 commit comments

Comments
 (0)