summary refs log tree commit diff
path: root/scripts/fetch_discord_openapi.js
blob: 62cf8986b4872c44f929c2939bc7dfdad799f02b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
/*
	Spacebar: A FOSS re-implementation and extension of the Discord.com backend.
	Copyright (C) 2023 Spacebar and Spacebar Contributors

	This program is free software: you can redistribute it and/or modify
	it under the terms of the GNU Affero General Public License as published
	by the Free Software Foundation, either version 3 of the License, or
	(at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU Affero General Public License for more details.

	You should have received a copy of the GNU Affero General Public License
	along with this program.  If not, see <https://www.gnu.org/licenses/>.
*/

require("module-alias/register");
const path = require("path");
const fs = require("fs");
require("../dist/util/util/extensions");

const openapiPathOut = path.join(__dirname, "..", "dist", "openapi_discord.json");

async function main() {
	console.log("Generating OpenAPI Specification...");

	const routesRes = await fetch(
		"https://raw.githubusercontent.com/discord/discord-api-spec/refs/heads/main/specs/openapi_preview.json",
		{
			headers: {
				Accept: "application/json",
			},
		},
	);
	const dOpenApi = await routesRes.json();
	for (const pathName in dOpenApi.paths) {
		console.log("Processing path:", pathName);
		const path = dOpenApi.paths[pathName];
		for (const methodName in path) {
			if (methodName === 'parameters') continue;
			console.log("  Processing method:", methodName);
			const method = path[methodName];
			if (method.operationId)
				// delete dOpenApi.paths[path][methodName].operationId;
				delete method.operationId; // we don't care about these

			for (const respCode in method.responses) {
				console.log("    Processing response:", respCode);
				const resp = method.responses[respCode];
				if(resp.description)
					delete resp.description; // we don't care about these

			}

			console.log("    Method security:", JSON.stringify(method.security));
			// if(method.security?.length >= 1 && method.security[0]?.["BotToken"] !== undefined) {
			// 	console.log("    Converting BotToken security to bearer");
			// 	// BotToken -> bearer
			// 	method.security[0]["bearer"] = [];
			// 	delete method.security[0]["BotToken"];
			// }
			for (const securityObj of method.security||[]) {
				if(securityObj["BotToken"] !== undefined) {
					console.log("    Converting BotToken security to bearer");
					// BotToken -> bearer
					securityObj["bearer"] = [];
					delete securityObj["BotToken"];
				}
			}
		}
	}



	fs.writeFileSync(
		openapiPathOut,
		JSON.stringify(dOpenApi, null, 2)
	);
	console.log("Wrote OpenAPI specification to", openapiPathOut);
	console.log(
		"Specification contains",
		Object.keys(dOpenApi.paths).length,
		"paths and",
		Object.keys(dOpenApi.components.schemas).length,
		"schemas.",
	);
}

main();