Skip to content

Commit eff648e

Browse files
committed
feat: modularize documentation
1 parent d54e3b6 commit eff648e

5 files changed

Lines changed: 10 additions & 44 deletions

File tree

src/jsdocs/admins.yaml

Lines changed: 0 additions & 15 deletions
This file was deleted.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
definitions:
2-
# BadRequestResponse model
3-
BadRequestResponse:
2+
# BadRequest model
3+
BadRequest:
44
type: object
55
properties:
66
status:
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ paths:
99
summary: Authenticates with Google
1010

1111
security:
12-
- Bearer: []
12+
- AdminToken: []
1313

1414
responses:
1515
"200":
@@ -29,4 +29,4 @@ paths:
2929
"400":
3030
description: Invalid body supplied
3131
schema:
32-
$ref: "#/definitions/BadRequestResponse"
32+
$ref: "#/definitions/BadRequest"

src/jsdocs/users.yaml

Lines changed: 0 additions & 15 deletions
This file was deleted.

src/utils/swaggerSpec.js

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,5 @@
11
import swaggerJSDoc from "swagger-jsdoc";
22

3-
// List of tags used by documentation.
4-
export const GENERAL_TAG = "General";
5-
export const ADMINISTRATOR_TAG = "Administrators";
6-
export const USER_TAG = "Users";
7-
export const AUTH_PROVIDER_TAG = "Authentication Providers";
8-
9-
// Security schema.
10-
export const apiKeySecurity = [{ Bearer: {} }];
11-
123
// Swagger definition
134
const swaggerDefinition = {
145
info: {
@@ -59,7 +50,12 @@ const swaggerDefinition = {
5950
],
6051
components: {
6152
securitySchemes: {
62-
Bearer: {
53+
AdminToken: {
54+
type: "http",
55+
scheme: "bearer",
56+
bearerFormat: "JWT",
57+
},
58+
UserToken: {
6359
type: "http",
6460
scheme: "bearer",
6561
bearerFormat: "JWT",

0 commit comments

Comments
 (0)