Skip to content

Commit 0fb85c3

Browse files
committed
feat: update documentation
1 parent 8502f94 commit 0fb85c3

4 files changed

Lines changed: 8 additions & 27 deletions

File tree

src/jsdocs/admins.yaml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,6 @@ paths:
99
summary: Register an administrator
1010

1111
responses:
12-
"200":
13-
description: Successful operation
14-
schema:
15-
$ref: "#/definitions/CreateAdminResponse"
1612
"400":
1713
description: Invalid body supplied
1814
schema:

src/jsdocs/definitions.yaml

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,9 @@ definitions:
33
BadRequestResponse:
44
type: object
55
properties:
6-
message:
6+
status:
77
type: string
8-
success:
9-
type: boolean
10-
example: false
11-
errors:
12-
type: array
13-
items:
14-
type: object
15-
properties:
16-
title:
17-
type: string
18-
status:
19-
type: integer
20-
example: 400
21-
detail:
22-
type: string
8+
example: error
9+
error:
10+
type: string
11+
example: Invalid body supplied

src/jsdocs/providers.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ paths:
1717
schema:
1818
type: object
1919
properties:
20-
message:
20+
status:
2121
type: string
22-
success:
23-
type: boolean
22+
example: success
2423
data:
2524
type: object
2625
properties:
2726
redirectUrl:
2827
type: string
28+
example: https://accounts.google.com/o/oauth2/v2/auth/oauthchooseaccount
2929
"400":
3030
description: Invalid body supplied
3131
schema:

src/jsdocs/users.yaml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,6 @@ paths:
99
summary: Register a user
1010

1111
responses:
12-
"200":
13-
description: Successful operation
14-
schema:
15-
$ref: "#/definitions/RegisterUserResponse"
1612
"400":
1713
description: Invalid body supplied
1814
schema:

0 commit comments

Comments
 (0)