oapi: policies
This commit is contained in:
Puyodead1
parent
1b1fbce4d3
commit
3fa2a95429
@ -3606,6 +3606,226 @@
|
||||
"description": "A container for useful snowflake-related methods.",
|
||||
"type": "object"
|
||||
},
|
||||
"UserLimits": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"maxGuilds": {
|
||||
"type": "integer",
|
||||
"default": 1048576
|
||||
},
|
||||
"maxUsername": {
|
||||
"type": "integer",
|
||||
"default": 32
|
||||
},
|
||||
"maxFriends": {
|
||||
"type": "integer",
|
||||
"default": 5000
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"maxFriends",
|
||||
"maxGuilds",
|
||||
"maxUsername"
|
||||
]
|
||||
},
|
||||
"GuildLimits": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"maxRoles": {
|
||||
"type": "integer",
|
||||
"default": 1000
|
||||
},
|
||||
"maxEmojis": {
|
||||
"type": "integer",
|
||||
"default": 2000
|
||||
},
|
||||
"maxMembers": {
|
||||
"type": "integer",
|
||||
"default": 25000000
|
||||
},
|
||||
"maxChannels": {
|
||||
"type": "integer",
|
||||
"default": 65535
|
||||
},
|
||||
"maxChannelsInCategory": {
|
||||
"type": "integer",
|
||||
"default": 65535
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"maxChannels",
|
||||
"maxChannelsInCategory",
|
||||
"maxEmojis",
|
||||
"maxMembers",
|
||||
"maxRoles"
|
||||
]
|
||||
},
|
||||
"MessageLimits": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"maxCharacters": {
|
||||
"type": "integer",
|
||||
"default": 1048576
|
||||
},
|
||||
"maxTTSCharacters": {
|
||||
"type": "integer",
|
||||
"default": 160
|
||||
},
|
||||
"maxReactions": {
|
||||
"type": "integer",
|
||||
"default": 2048
|
||||
},
|
||||
"maxAttachmentSize": {
|
||||
"type": "integer",
|
||||
"default": 1073741824
|
||||
},
|
||||
"maxBulkDelete": {
|
||||
"type": "integer",
|
||||
"default": 1000
|
||||
},
|
||||
"maxEmbedDownloadSize": {
|
||||
"type": "integer",
|
||||
"default": 5242880
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"maxAttachmentSize",
|
||||
"maxBulkDelete",
|
||||
"maxCharacters",
|
||||
"maxEmbedDownloadSize",
|
||||
"maxReactions",
|
||||
"maxTTSCharacters"
|
||||
]
|
||||
},
|
||||
"ChannelLimits": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"maxPins": {
|
||||
"type": "integer",
|
||||
"default": 500
|
||||
},
|
||||
"maxTopic": {
|
||||
"type": "integer",
|
||||
"default": 1024
|
||||
},
|
||||
"maxWebhooks": {
|
||||
"type": "integer",
|
||||
"default": 100
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"maxPins",
|
||||
"maxTopic",
|
||||
"maxWebhooks"
|
||||
]
|
||||
},
|
||||
"RateLimits": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"enabled": {
|
||||
"type": "boolean",
|
||||
"default": false
|
||||
},
|
||||
"ip": {
|
||||
"$ref": "#/components/schemas/RateLimitOptions"
|
||||
},
|
||||
"global": {
|
||||
"$ref": "#/components/schemas/RateLimitOptions"
|
||||
},
|
||||
"error": {
|
||||
"$ref": "#/components/schemas/RateLimitOptions"
|
||||
},
|
||||
"routes": {
|
||||
"$ref": "#/components/schemas/RouteRateLimit"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"enabled",
|
||||
"error",
|
||||
"global",
|
||||
"ip",
|
||||
"routes"
|
||||
]
|
||||
},
|
||||
"RateLimitOptions": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"bot": {
|
||||
"type": "integer"
|
||||
},
|
||||
"count": {
|
||||
"type": "integer"
|
||||
},
|
||||
"window": {
|
||||
"type": "integer"
|
||||
},
|
||||
"onyIp": {
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"count",
|
||||
"window"
|
||||
]
|
||||
},
|
||||
"RouteRateLimit": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"guild": {
|
||||
"$ref": "#/components/schemas/RateLimitOptions"
|
||||
},
|
||||
"webhook": {
|
||||
"$ref": "#/components/schemas/RateLimitOptions"
|
||||
},
|
||||
"channel": {
|
||||
"$ref": "#/components/schemas/RateLimitOptions"
|
||||
},
|
||||
"auth": {}
|
||||
},
|
||||
"required": [
|
||||
"auth",
|
||||
"channel",
|
||||
"guild",
|
||||
"webhook"
|
||||
]
|
||||
},
|
||||
"GlobalRateLimits": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"register": {
|
||||
"$ref": "#/components/schemas/GlobalRateLimit"
|
||||
},
|
||||
"sendMessage": {
|
||||
"$ref": "#/components/schemas/GlobalRateLimit"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"register",
|
||||
"sendMessage"
|
||||
]
|
||||
},
|
||||
"GlobalRateLimit": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"limit": {
|
||||
"type": "integer",
|
||||
"default": 100
|
||||
},
|
||||
"window": {
|
||||
"type": "integer",
|
||||
"default": 3600000
|
||||
},
|
||||
"enabled": {
|
||||
"type": "boolean",
|
||||
"default": true
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"enabled",
|
||||
"limit",
|
||||
"window"
|
||||
]
|
||||
},
|
||||
"TenorGifResponse": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@ -5672,6 +5892,58 @@
|
||||
"url"
|
||||
]
|
||||
},
|
||||
"GeneralConfigurationResponse": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"instanceName": {
|
||||
"type": "string",
|
||||
"default": "Spacebar Instance"
|
||||
},
|
||||
"instanceDescription": {
|
||||
"type": "string",
|
||||
"default": "This is a Spacebar instance made in the pre-release days",
|
||||
"nullable": true
|
||||
},
|
||||
"frontPage": {
|
||||
"type": "string",
|
||||
"default": null,
|
||||
"nullable": true
|
||||
},
|
||||
"tosPage": {
|
||||
"type": "string",
|
||||
"default": null,
|
||||
"nullable": true
|
||||
},
|
||||
"correspondenceEmail": {
|
||||
"type": "string",
|
||||
"default": null,
|
||||
"nullable": true
|
||||
},
|
||||
"correspondenceUserID": {
|
||||
"type": "string",
|
||||
"default": null,
|
||||
"nullable": true
|
||||
},
|
||||
"image": {
|
||||
"type": "string",
|
||||
"default": null,
|
||||
"nullable": true
|
||||
},
|
||||
"instanceId": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"correspondenceEmail",
|
||||
"correspondenceUserID",
|
||||
"frontPage",
|
||||
"image",
|
||||
"instanceDescription",
|
||||
"instanceId",
|
||||
"instanceName",
|
||||
"tosPage"
|
||||
]
|
||||
},
|
||||
"GenerateRegistrationTokensResponse": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@ -6064,6 +6336,92 @@
|
||||
"enabled"
|
||||
]
|
||||
},
|
||||
"InstanceDomainsResponse": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"cdn": {
|
||||
"type": "string"
|
||||
},
|
||||
"gateway": {
|
||||
"type": "string"
|
||||
},
|
||||
"defaultApiVersion": {
|
||||
"type": "string"
|
||||
},
|
||||
"apiEndpoint": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"apiEndpoint",
|
||||
"cdn",
|
||||
"defaultApiVersion",
|
||||
"gateway"
|
||||
]
|
||||
},
|
||||
"InstanceStatsResponse": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"counts": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"user": {
|
||||
"type": "integer"
|
||||
},
|
||||
"guild": {
|
||||
"type": "integer"
|
||||
},
|
||||
"message": {
|
||||
"type": "integer"
|
||||
},
|
||||
"members": {
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"guild",
|
||||
"members",
|
||||
"message",
|
||||
"user"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"counts"
|
||||
]
|
||||
},
|
||||
"LimitsConfigurationResponse": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"user": {
|
||||
"$ref": "#/components/schemas/UserLimits"
|
||||
},
|
||||
"guild": {
|
||||
"$ref": "#/components/schemas/GuildLimits"
|
||||
},
|
||||
"message": {
|
||||
"$ref": "#/components/schemas/MessageLimits"
|
||||
},
|
||||
"channel": {
|
||||
"$ref": "#/components/schemas/ChannelLimits"
|
||||
},
|
||||
"rate": {
|
||||
"$ref": "#/components/schemas/RateLimits"
|
||||
},
|
||||
"absoluteRate": {
|
||||
"$ref": "#/components/schemas/GlobalRateLimits"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"absoluteRate",
|
||||
"channel",
|
||||
"guild",
|
||||
"message",
|
||||
"rate",
|
||||
"user"
|
||||
]
|
||||
},
|
||||
"LocationMetadataResponse": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@ -7636,8 +7994,25 @@
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"default": {
|
||||
"description": "No description available"
|
||||
"200": {
|
||||
"description": "",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/InstanceStatsResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/APIErrorResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"tags": [
|
||||
@ -7648,8 +8023,15 @@
|
||||
"/policies/instance/limits/": {
|
||||
"get": {
|
||||
"responses": {
|
||||
"default": {
|
||||
"description": "No description available"
|
||||
"200": {
|
||||
"description": "",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/LimitsConfigurationResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"tags": [
|
||||
@ -7660,8 +8042,15 @@
|
||||
"/policies/instance/": {
|
||||
"get": {
|
||||
"responses": {
|
||||
"default": {
|
||||
"description": "No description available"
|
||||
"200": {
|
||||
"description": "",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/GeneralConfigurationResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"tags": [
|
||||
@ -7672,8 +8061,15 @@
|
||||
"/policies/instance/domains/": {
|
||||
"get": {
|
||||
"responses": {
|
||||
"default": {
|
||||
"description": "No description available"
|
||||
"200": {
|
||||
"description": "",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/InstanceDomainsResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"tags": [
|
||||
|
||||
38781
assets/schemas.json
38781
assets/schemas.json
File diff suppressed because it is too large
Load Diff
@ -16,16 +16,28 @@
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
import { Router, Request, Response } from "express";
|
||||
import { route } from "@spacebar/api";
|
||||
import { Config } from "@spacebar/util";
|
||||
import { Request, Response, Router } from "express";
|
||||
const router = Router();
|
||||
|
||||
router.get("/", route({}), async (req: Request, res: Response) => {
|
||||
router.get(
|
||||
"/",
|
||||
route({
|
||||
responses: {
|
||||
200: {
|
||||
body: "InstanceDomainsResponse",
|
||||
},
|
||||
},
|
||||
}),
|
||||
async (req: Request, res: Response) => {
|
||||
const { cdn, gateway, api } = Config.get();
|
||||
|
||||
const IdentityForm = {
|
||||
cdn: cdn.endpointPublic || process.env.CDN || "http://localhost:3001",
|
||||
cdn:
|
||||
cdn.endpointPublic ||
|
||||
process.env.CDN ||
|
||||
"http://localhost:3001",
|
||||
gateway:
|
||||
gateway.endpointPublic ||
|
||||
process.env.GATEWAY ||
|
||||
@ -35,6 +47,7 @@ router.get("/", route({}), async (req: Request, res: Response) => {
|
||||
};
|
||||
|
||||
res.json(IdentityForm);
|
||||
});
|
||||
},
|
||||
);
|
||||
|
||||
export default router;
|
||||
|
||||
@ -16,14 +16,24 @@
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
import { Router, Request, Response } from "express";
|
||||
import { route } from "@spacebar/api";
|
||||
import { Config } from "@spacebar/util";
|
||||
import { Request, Response, Router } from "express";
|
||||
const router = Router();
|
||||
|
||||
router.get("/", route({}), async (req: Request, res: Response) => {
|
||||
router.get(
|
||||
"/",
|
||||
route({
|
||||
responses: {
|
||||
200: {
|
||||
body: "GeneralConfigurationResponse",
|
||||
},
|
||||
},
|
||||
}),
|
||||
async (req: Request, res: Response) => {
|
||||
const { general } = Config.get();
|
||||
res.json(general);
|
||||
});
|
||||
},
|
||||
);
|
||||
|
||||
export default router;
|
||||
|
||||
@ -16,14 +16,24 @@
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
import { Router, Request, Response } from "express";
|
||||
import { route } from "@spacebar/api";
|
||||
import { Config } from "@spacebar/util";
|
||||
import { Request, Response, Router } from "express";
|
||||
const router = Router();
|
||||
|
||||
router.get("/", route({}), async (req: Request, res: Response) => {
|
||||
router.get(
|
||||
"/",
|
||||
route({
|
||||
responses: {
|
||||
200: {
|
||||
body: "LimitsConfigurationResponse",
|
||||
},
|
||||
},
|
||||
}),
|
||||
async (req: Request, res: Response) => {
|
||||
const { limits } = Config.get();
|
||||
res.json(limits);
|
||||
});
|
||||
},
|
||||
);
|
||||
|
||||
export default router;
|
||||
|
||||
@ -28,7 +28,19 @@ import {
|
||||
import { Request, Response, Router } from "express";
|
||||
const router = Router();
|
||||
|
||||
router.get("/", route({}), async (req: Request, res: Response) => {
|
||||
router.get(
|
||||
"/",
|
||||
route({
|
||||
responses: {
|
||||
200: {
|
||||
body: "InstanceStatsResponse",
|
||||
},
|
||||
403: {
|
||||
body: "APIErrorResponse",
|
||||
},
|
||||
},
|
||||
}),
|
||||
async (req: Request, res: Response) => {
|
||||
if (!Config.get().security.statsWorldReadable) {
|
||||
const rights = await getRights(req.user_id);
|
||||
rights.hasThrow("VIEW_SERVER_STATS");
|
||||
@ -42,6 +54,7 @@ router.get("/", route({}), async (req: Request, res: Response) => {
|
||||
members: await Member.count(),
|
||||
},
|
||||
});
|
||||
});
|
||||
},
|
||||
);
|
||||
|
||||
export default router;
|
||||
|
||||
@ -16,11 +16,11 @@
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
import { RouteRateLimit, RateLimitOptions } from ".";
|
||||
import { RateLimitOptions, RouteRateLimit } from ".";
|
||||
|
||||
export class RateLimits {
|
||||
enabled: boolean = false;
|
||||
ip: Omit<RateLimitOptions, "bot_count"> = {
|
||||
ip: RateLimitOptions = {
|
||||
count: 500,
|
||||
window: 5,
|
||||
};
|
||||
|
||||
@ -0,0 +1,3 @@
|
||||
import { GeneralConfiguration } from "../../config";
|
||||
|
||||
export type GeneralConfigurationResponse = GeneralConfiguration;
|
||||
6
src/util/schemas/responses/InstanceDomainsResponse.ts
Normal file
6
src/util/schemas/responses/InstanceDomainsResponse.ts
Normal file
@ -0,0 +1,6 @@
|
||||
export interface InstanceDomainsResponse {
|
||||
cdn: string;
|
||||
gateway: string;
|
||||
defaultApiVersion: string;
|
||||
apiEndpoint: string;
|
||||
}
|
||||
8
src/util/schemas/responses/InstanceStatsResponse.ts
Normal file
8
src/util/schemas/responses/InstanceStatsResponse.ts
Normal file
@ -0,0 +1,8 @@
|
||||
export interface InstanceStatsResponse {
|
||||
counts: {
|
||||
user: number;
|
||||
guild: number;
|
||||
message: number;
|
||||
members: number;
|
||||
};
|
||||
}
|
||||
@ -0,0 +1,3 @@
|
||||
import { LimitsConfiguration } from "../../config";
|
||||
|
||||
export type LimitsConfigurationResponse = LimitsConfiguration;
|
||||
@ -11,6 +11,7 @@ export * from "./ChannelPinsResponse";
|
||||
export * from "./ChannelWebhooksResponse";
|
||||
export * from "./GatewayBotResponse";
|
||||
export * from "./GatewayResponse";
|
||||
export * from "./GeneralConfigurationResponse";
|
||||
export * from "./GenerateRegistrationTokensResponse";
|
||||
export * from "./GuildBansResponse";
|
||||
export * from "./GuildChannelsResponse";
|
||||
@ -29,6 +30,9 @@ export * from "./GuildVanityUrl";
|
||||
export * from "./GuildVoiceRegionsResponse";
|
||||
export * from "./GuildWidgetJsonResponse";
|
||||
export * from "./GuildWidgetSettingsResponse";
|
||||
export * from "./InstanceDomainsResponse";
|
||||
export * from "./InstanceStatsResponse";
|
||||
export * from "./LimitsConfigurationResponse";
|
||||
export * from "./LocationMetadataResponse";
|
||||
export * from "./MemberJoinGuildResponse";
|
||||
export * from "./OAuthAuthorizeResponse";
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user