Spacebar/server
1
0
Fork 0
mirror of https://github.com/spacebarchat/server.git synced 2024-11-10 12:42:44 +01:00
Code Issues Releases Activity

oapi: root level routes

Browse Source
This commit is contained in:
Puyodead1 2023-03-25 18:28:12 -04:00
parent fd283f1d15
commit 3a23842924
No known key found for this signature in database
GPG Key ID: A4FA4FEC0DD353FC
16 changed files with 22704 additions and 150 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

271
assets/openapi.json
View File

@ -3380,6 +3380,29 @@
"welcome_channels" "welcome_channels"
] ]
}, },
"Categories": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"localizations": {
"type": "string"
},
"is_primary": {
"type": "boolean"
}
},
"required": [
"id",
"is_primary",
"localizations",
"name"
]
},
"GuildMessagesSearchMessage": { "GuildMessagesSearchMessage": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -5886,6 +5909,38 @@
"$ref": "#/components/schemas/Webhook" "$ref": "#/components/schemas/Webhook"
} }
}, },
"DiscoverableGuildsResponse": {
"type": "object",
"properties": {
"total": {
"type": "integer"
},
"guilds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Guild"
}
},
"offset": {
"type": "integer"
},
"limit": {
"type": "integer"
}
},
"required": [
"guilds",
"limit",
"offset",
"total"
]
},
"DiscoveryCategoriesResponse": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Categories"
}
},
"GatewayBotResponse": { "GatewayBotResponse": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -6211,6 +6266,24 @@
"purged" "purged"
] ]
}, },
"GuildRecommendationsResponse": {
"type": "object",
"properties": {
"recommended_guilds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Guild"
}
},
"load_id": {
"type": "string"
}
},
"required": [
"load_id",
"recommended_guilds"
]
},
"GuildResponse": { "GuildResponse": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -6404,6 +6477,79 @@
"gateway" "gateway"
] ]
}, },
"InstancePingResponse": {
"type": "object",
"properties": {
"ping": {
"type": "string",
"enum": [
"pong!"
]
},
"instance": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": [
"null",
"string"
]
},
"image": {
"type": [
"null",
"string"
]
},
"correspondenceEmail": {
"type": [
"null",
"string"
]
},
"correspondenceUserID": {
"type": [
"null",
"string"
]
},
"frontPage": {
"type": [
"null",
"string"
]
},
"tosPage": {
"type": [
"null",
"string"
]
}
},
"additionalProperties": false,
"required": [
"correspondenceEmail",
"correspondenceUserID",
"description",
"frontPage",
"id",
"image",
"name",
"tosPage"
]
}
},
"required": [
"instance",
"ping"
]
},
"InstanceStatsResponse": { "InstanceStatsResponse": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -6655,6 +6801,30 @@
"token" "token"
] ]
}, },
"UpdatesResponse": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"pub_date": {
"type": "string"
},
"url": {
"type": "string"
},
"notes": {
"type": "string",
"nullable": true
}
},
"required": [
"name",
"notes",
"pub_date",
"url"
]
},
"UserNoteResponse": { "UserNoteResponse": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -8436,8 +8606,35 @@
"/updates/": { "/updates/": {
"get": { "get": {
"responses": { "responses": {
"default": { "200": {
"description": "No description available" "description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatesResponse"
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
} }
}, },
"tags": [ "tags": [
@ -8595,8 +8792,18 @@
} }
], ],
"responses": { "responses": {
"default": { "200": {
"description": "No description available" "description": "No description available"
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
} }
}, },
"tags": [ "tags": [
@ -8683,7 +8890,7 @@
"/science/": { "/science/": {
"post": { "post": {
"responses": { "responses": {
"default": { "204": {
"description": "No description available" "description": "No description available"
} }
}, },
@ -8840,8 +9047,15 @@
"/ping/": { "/ping/": {
"get": { "get": {
"responses": { "responses": {
"default": { "200": {
"description": "No description available" "description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InstancePingResponse"
}
}
}
} }
}, },
"tags": [ "tags": [
@ -11204,8 +11418,15 @@
} }
], ],
"responses": { "responses": {
"default": { "200": {
"description": "No description available" "description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GuildRecommendationsResponse"
}
}
}
} }
}, },
"tags": [ "tags": [
@ -11393,8 +11614,18 @@
"/download/": { "/download/": {
"get": { "get": {
"responses": { "responses": {
"default": { "302": {
"description": "No description available" "description": "No description available"
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
} }
}, },
"tags": [ "tags": [
@ -11410,8 +11641,15 @@
} }
], ],
"responses": { "responses": {
"default": { "200": {
"description": "No description available" "description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DiscoveryCategoriesResponse"
}
}
}
} }
}, },
"tags": [ "tags": [
@ -11427,8 +11665,15 @@
} }
], ],
"responses": { "responses": {
"default": { "200": {
"description": "No description available" "description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DiscoverableGuildsResponse"
}
}
}
} }
}, },
"tags": [ "tags": [

22183
assets/schemas.json
View File

File diff suppressed because it is too large Load Diff

84
src/api/routes/discoverable-guilds.ts
View File

@ -16,49 +16,61 @@
along with this program. If not, see <https://www.gnu.org/licenses/>. along with this program. If not, see <https://www.gnu.org/licenses/>.
*/ */
import { Guild, Config } from "@spacebar/util"; import { Config, Guild } from "@spacebar/util";
import { Router, Request, Response } from "express";
import { route } from "@spacebar/api"; import { route } from "@spacebar/api";
import { Request, Response, Router } from "express";
import { Like } from "typeorm"; import { Like } from "typeorm";
const router = Router(); const router = Router();
router.get("/", route({}), async (req: Request, res: Response) => { router.get(
const { offset, limit, categories } = req.query; "/",
const showAllGuilds = Config.get().guild.discovery.showAllGuilds; route({
const configLimit = Config.get().guild.discovery.limit; responses: {
let guilds; 200: {
if (categories == undefined) { body: "DiscoverableGuildsResponse",
guilds = showAllGuilds },
? await Guild.find({ take: Math.abs(Number(limit || configLimit)) }) },
: await Guild.find({ }),
where: { features: Like(`%DISCOVERABLE%`) }, async (req: Request, res: Response) => {
take: Math.abs(Number(limit || configLimit)), const { offset, limit, categories } = req.query;
}); const showAllGuilds = Config.get().guild.discovery.showAllGuilds;
} else { const configLimit = Config.get().guild.discovery.limit;
guilds = showAllGuilds let guilds;
? await Guild.find({ if (categories == undefined) {
where: { primary_category_id: categories.toString() }, guilds = showAllGuilds
take: Math.abs(Number(limit || configLimit)), ? await Guild.find({
}) take: Math.abs(Number(limit || configLimit)),
: await Guild.find({ })
where: { : await Guild.find({
primary_category_id: categories.toString(), where: { features: Like(`%DISCOVERABLE%`) },
features: Like("%DISCOVERABLE%"), take: Math.abs(Number(limit || configLimit)),
}, });
take: Math.abs(Number(limit || configLimit)), } else {
}); guilds = showAllGuilds
} ? await Guild.find({
where: { primary_category_id: categories.toString() },
take: Math.abs(Number(limit || configLimit)),
})
: await Guild.find({
where: {
primary_category_id: categories.toString(),
features: Like("%DISCOVERABLE%"),
},
take: Math.abs(Number(limit || configLimit)),
});
}
const total = guilds ? guilds.length : undefined; const total = guilds ? guilds.length : undefined;
res.send({ res.send({
total: total, total: total,
guilds: guilds, guilds: guilds,
offset: Number(offset || Config.get().guild.discovery.offset), offset: Number(offset || Config.get().guild.discovery.offset),
limit: Number(limit || configLimit), limit: Number(limit || configLimit),
}); });
}); },
);
export default router; export default router;

34
src/api/routes/discovery.ts
View File

@ -16,24 +16,34 @@
along with this program. If not, see <https://www.gnu.org/licenses/>. along with this program. If not, see <https://www.gnu.org/licenses/>.
*/ */
import { Categories } from "@spacebar/util";
import { Router, Response, Request } from "express";
import { route } from "@spacebar/api"; import { route } from "@spacebar/api";
import { Categories } from "@spacebar/util";
import { Request, Response, Router } from "express";
const router = Router(); const router = Router();
router.get("/categories", route({}), async (req: Request, res: Response) => { router.get(
// TODO: "/categories",
// Get locale instead route({
responses: {
200: {
body: "DiscoveryCategoriesResponse",
},
},
}),
async (req: Request, res: Response) => {
// TODO:
// Get locale instead
// const { locale, primary_only } = req.query; // const { locale, primary_only } = req.query;
const { primary_only } = req.query; const { primary_only } = req.query;
const out = primary_only const out = primary_only
? await Categories.find() ? await Categories.find()
: await Categories.find({ where: { is_primary: true } }); : await Categories.find({ where: { is_primary: true } });
res.send(out); res.send(out);
}); },
);
export default router; export default router;

49
src/api/routes/download.ts
View File

@ -16,32 +16,43 @@
along with this program. If not, see <https://www.gnu.org/licenses/>. along with this program. If not, see <https://www.gnu.org/licenses/>.
*/ */
import { Router, Response, Request } from "express";
import { route } from "@spacebar/api"; import { route } from "@spacebar/api";
import { FieldErrors, Release } from "@spacebar/util"; import { FieldErrors, Release } from "@spacebar/util";
import { Request, Response, Router } from "express";
const router = Router(); const router = Router();
router.get("/", route({}), async (req: Request, res: Response) => { router.get(
const { platform } = req.query; "/",
route({
if (!platform) responses: {
throw FieldErrors({ 302: {},
platform: { 404: {
code: "BASE_TYPE_REQUIRED", body: "APIErrorResponse",
message: req.t("common:field.BASE_TYPE_REQUIRED"),
}, },
},
}),
async (req: Request, res: Response) => {
const { platform } = req.query;
if (!platform)
throw FieldErrors({
platform: {
code: "BASE_TYPE_REQUIRED",
message: req.t("common:field.BASE_TYPE_REQUIRED"),
},
});
const release = await Release.findOneOrFail({
where: {
enabled: true,
platform: platform as string,
},
order: { pub_date: "DESC" },
}); });
const release = await Release.findOneOrFail({ res.redirect(release.url);
where: { },
enabled: true, );
platform: platform as string,
},
order: { pub_date: "DESC" },
});
res.redirect(release.url);
});
export default router; export default router;

52
src/api/routes/guild-recommendations.ts
View File

@ -16,34 +16,44 @@
along with this program. If not, see <https://www.gnu.org/licenses/>. along with this program. If not, see <https://www.gnu.org/licenses/>.
*/ */
import { Guild, Config } from "@spacebar/util"; import { Config, Guild } from "@spacebar/util";
import { Router, Request, Response } from "express";
import { route } from "@spacebar/api"; import { route } from "@spacebar/api";
import { Request, Response, Router } from "express";
import { Like } from "typeorm"; import { Like } from "typeorm";
const router = Router(); const router = Router();
router.get("/", route({}), async (req: Request, res: Response) => { router.get(
// const { limit, personalization_disabled } = req.query; "/",
const { limit } = req.query; route({
const showAllGuilds = Config.get().guild.discovery.showAllGuilds; responses: {
200: {
body: "GuildRecommendationsResponse",
},
},
}),
async (req: Request, res: Response) => {
// const { limit, personalization_disabled } = req.query;
const { limit } = req.query;
const showAllGuilds = Config.get().guild.discovery.showAllGuilds;
const genLoadId = (size: number) => const genLoadId = (size: number) =>
[...Array(size)] [...Array(size)]
.map(() => Math.floor(Math.random() * 16).toString(16)) .map(() => Math.floor(Math.random() * 16).toString(16))
.join(""); .join("");
const guilds = showAllGuilds const guilds = showAllGuilds
? await Guild.find({ take: Math.abs(Number(limit || 24)) }) ? await Guild.find({ take: Math.abs(Number(limit || 24)) })
: await Guild.find({ : await Guild.find({
where: { features: Like("%DISCOVERABLE%") }, where: { features: Like("%DISCOVERABLE%") },
take: Math.abs(Number(limit || 24)), take: Math.abs(Number(limit || 24)),
}); });
res.send({ res.send({
recommended_guilds: guilds, recommended_guilds: guilds,
load_id: `server_recs/${genLoadId(32)}`, load_id: `server_recs/${genLoadId(32)}`,
}).status(200); }).status(200);
}); },
);
export default router; export default router;

46
src/api/routes/ping.ts
View File

@ -16,29 +16,39 @@
along with this program. If not, see <https://www.gnu.org/licenses/>. along with this program. If not, see <https://www.gnu.org/licenses/>.
*/ */
import { Router, Response, Request } from "express";
import { route } from "@spacebar/api"; import { route } from "@spacebar/api";
import { Config } from "@spacebar/util"; import { Config } from "@spacebar/util";
import { Request, Response, Router } from "express";
const router = Router(); const router = Router();
router.get("/", route({}), (req: Request, res: Response) => { router.get(
const { general } = Config.get(); "/",
res.send({ route({
ping: "pong!", responses: {
instance: { 200: {
id: general.instanceId, body: "InstancePingResponse",
name: general.instanceName, },
description: general.instanceDescription,
image: general.image,
correspondenceEmail: general.correspondenceEmail,
correspondenceUserID: general.correspondenceUserID,
frontPage: general.frontPage,
tosPage: general.tosPage,
}, },
}); }),
}); (req: Request, res: Response) => {
const { general } = Config.get();
res.send({
ping: "pong!",
instance: {
id: general.instanceId,
name: general.instanceName,
description: general.instanceDescription,
image: general.image,
correspondenceEmail: general.correspondenceEmail,
correspondenceUserID: general.correspondenceUserID,
frontPage: general.frontPage,
tosPage: general.tosPage,
},
});
},
);
export default router; export default router;

18
src/api/routes/science.ts
View File

@ -16,14 +16,22 @@
along with this program. If not, see <https://www.gnu.org/licenses/>. along with this program. If not, see <https://www.gnu.org/licenses/>.
*/ */
import { Router, Response, Request } from "express";
import { route } from "@spacebar/api"; import { route } from "@spacebar/api";
import { Request, Response, Router } from "express";
const router = Router(); const router = Router();
router.post("/", route({}), (req: Request, res: Response) => { router.post(
// TODO: "/",
res.sendStatus(204); route({
}); responses: {
204: {},
},
}),
(req: Request, res: Response) => {
// TODO:
res.sendStatus(204);
},
);
export default router; export default router;

12
src/api/routes/stop.ts
View File

@ -16,14 +16,22 @@
along with this program. If not, see <https://www.gnu.org/licenses/>. along with this program. If not, see <https://www.gnu.org/licenses/>.
*/ */
import { Router, Request, Response } from "express";
import { route } from "@spacebar/api"; import { route } from "@spacebar/api";
import { Request, Response, Router } from "express";
const router: Router = Router(); const router: Router = Router();
router.post( router.post(
"/", "/",
route({ right: "OPERATOR" }), route({
right: "OPERATOR",
responses: {
200: {},
403: {
body: "APIErrorResponse",
},
},
}),
async (req: Request, res: Response) => { async (req: Request, res: Response) => {
console.log(`/stop was called by ${req.user_id} at ${new Date()}`); console.log(`/stop was called by ${req.user_id} at ${new Date()}`);
res.sendStatus(200); res.sendStatus(200);

64
src/api/routes/updates.ts
View File

@ -16,37 +16,53 @@
along with this program. If not, see <https://www.gnu.org/licenses/>. along with this program. If not, see <https://www.gnu.org/licenses/>.
*/ */
import { Router, Response, Request } from "express";
import { route } from "@spacebar/api"; import { route } from "@spacebar/api";
import { FieldErrors, Release } from "@spacebar/util"; import { FieldErrors, Release } from "@spacebar/util";
import { Request, Response, Router } from "express";
const router = Router(); const router = Router();
router.get("/", route({}), async (req: Request, res: Response) => { router.get(
const platform = req.query.platform; "/",
route({
if (!platform) responses: {
throw FieldErrors({ 200: {
platform: { body: "UpdatesResponse",
code: "BASE_TYPE_REQUIRED",
message: req.t("common:field.BASE_TYPE_REQUIRED"),
}, },
400: {
body: "APIErrorResponse",
},
404: {
body: "APIErrorResponse",
},
},
}),
async (req: Request, res: Response) => {
const platform = req.query.platform;
if (!platform)
throw FieldErrors({
platform: {
code: "BASE_TYPE_REQUIRED",
message: req.t("common:field.BASE_TYPE_REQUIRED"),
},
});
const release = await Release.findOneOrFail({
where: {
enabled: true,
platform: platform as string,
},
order: { pub_date: "DESC" },
}); });
const release = await Release.findOneOrFail({ res.json({
where: { name: release.name,
enabled: true, pub_date: release.pub_date,
platform: platform as string, url: release.url,
}, notes: release.notes,
order: { pub_date: "DESC" }, });
}); },
);
res.json({
name: release.name,
pub_date: release.pub_date,
url: release.url,
notes: release.notes,
});
});
export default router; export default router;

8
src/util/schemas/responses/DiscoverableGuildsResponse.ts Normal file
View File

@ -0,0 +1,8 @@
import { Guild } from "../../entities";
export interface DiscoverableGuildsResponse {
total: number;
guilds: Guild[];
offset: number;
limit: number;
}

3
src/util/schemas/responses/DiscoveryCategoriesResponse.ts Normal file
View File

@ -0,0 +1,3 @@
import { Categories } from "../../entities";
export type DiscoveryCategoriesResponse = Categories[];

6
src/util/schemas/responses/GuildRecommendationsResponse.ts Normal file
View File

@ -0,0 +1,6 @@
import { Guild } from "../../entities";
export interface GuildRecommendationsResponse {
recommended_guilds: Guild[];
load_id: string;
}

13
src/util/schemas/responses/InstancePingResponse.ts Normal file
View File

@ -0,0 +1,13 @@
export interface InstancePingResponse {
ping: "pong!";
instance: {
id: string;
name: string;
description: string | null;
image: string | null;
correspondenceEmail: string | null;
correspondenceUserID: string | null;
frontPage: string | null;
tosPage: string | null;
};
}

6
src/util/schemas/responses/UpdatesResponse.ts Normal file
View File

@ -0,0 +1,6 @@
export interface UpdatesResponse {
name: string;
pub_date: string;
url: string;
notes: string | null;
}

5
src/util/schemas/responses/index.ts
View File

@ -9,6 +9,8 @@ export * from "./CaptchaRequiredResponse";
export * from "./ChannelInvitesResponse"; export * from "./ChannelInvitesResponse";
export * from "./ChannelPinsResponse"; export * from "./ChannelPinsResponse";
export * from "./ChannelWebhooksResponse"; export * from "./ChannelWebhooksResponse";
export * from "./DiscoverableGuildsResponse";
export * from "./DiscoveryCategoriesResponse";
export * from "./GatewayBotResponse"; export * from "./GatewayBotResponse";
export * from "./GatewayResponse"; export * from "./GatewayResponse";
export * from "./GeneralConfigurationResponse"; export * from "./GeneralConfigurationResponse";
@ -22,6 +24,7 @@ export * from "./GuildInvitesResponse";
export * from "./GuildMembersResponse"; export * from "./GuildMembersResponse";
export * from "./GuildMessagesSearchResponse"; export * from "./GuildMessagesSearchResponse";
export * from "./GuildPruneResponse"; export * from "./GuildPruneResponse";
export * from "./GuildRecommendationsResponse";
export * from "./GuildResponse"; export * from "./GuildResponse";
export * from "./GuildRolesResponse"; export * from "./GuildRolesResponse";
export * from "./GuildStickersResponse"; export * from "./GuildStickersResponse";
@ -31,6 +34,7 @@ export * from "./GuildVoiceRegionsResponse";
export * from "./GuildWidgetJsonResponse"; export * from "./GuildWidgetJsonResponse";
export * from "./GuildWidgetSettingsResponse"; export * from "./GuildWidgetSettingsResponse";
export * from "./InstanceDomainsResponse"; export * from "./InstanceDomainsResponse";
export * from "./InstancePingResponse";
export * from "./InstanceStatsResponse"; export * from "./InstanceStatsResponse";
export * from "./LimitsConfigurationResponse"; export * from "./LimitsConfigurationResponse";
export * from "./LocationMetadataResponse"; export * from "./LocationMetadataResponse";
@ -39,6 +43,7 @@ export * from "./OAuthAuthorizeResponse";
export * from "./StickerPacksResponse"; export * from "./StickerPacksResponse";
export * from "./Tenor"; export * from "./Tenor";
export * from "./TokenResponse"; export * from "./TokenResponse";
export * from "./UpdatesResponse";
export * from "./UserNoteResponse"; export * from "./UserNoteResponse";
export * from "./UserProfileResponse"; export * from "./UserProfileResponse";
export * from "./UserRelationshipsResponse"; export * from "./UserRelationshipsResponse";