server/api/assets/schemas.json

{
    "LoginSchema": {
        "type": "object",
        "properties": {
            "login": {
                "type": "string"
            },
            "password": {
                "type": "string"
            },
            "undelete": {
                "type": "boolean"
            },
            "captcha_key": {
                "type": "string"
            },
            "login_source": {
                "type": "string"
            },
            "gift_code_sku_id": {
                "type": "string"
            }
        },
        "additionalProperties": false,
        "required": [
            "login",
            "password"
        ],
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "TotpSchema": {
        "type": "object",
        "properties": {
            "code": {
                "type": "string"
            },
            "ticket": {
                "type": "string"
            },
            "gift_code_sku_id": {
                "type": [
                    "null",
                    "string"
                ]
            },
            "login_source": {
                "type": [
                    "null",
                    "string"
                ]
            }
        },
        "additionalProperties": false,
        "required": [
            "code",
            "ticket"
        ],
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "RegisterSchema": {
        "type": "object",
        "properties": {
            "username": {
                "minLength": 2,
                "maxLength": 32,
                "type": "string"
            },
            "password": {
                "minLength": 1,
                "maxLength": 72,
                "type": "string"
            },
            "consent": {
                "type": "boolean"
            },
            "email": {
                "format": "email",
                "type": "string"
            },
            "fingerprint": {
                "type": "string"
            },
            "invite": {
                "type": "string"
            },
            "date_of_birth": {
                "type": "string"
            },
            "gift_code_sku_id": {
                "type": "string"
            },
            "captcha_key": {
                "type": "string"
            },
            "promotional_email_opt_in": {
                "type": "boolean"
            }
        },
        "additionalProperties": false,
        "required": [
            "consent",
            "username"
        ],
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "BackupCodesChallengeSchema": {
        "type": "object",
        "properties": {
            "password": {
                "type": "string"
            }
        },
        "additionalProperties": false,
        "required": [
            "password"
        ],
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "ChannelModifySchema": {
        "type": "object",
        "properties": {
            "name": {
                "maxLength": 100,
                "type": "string"
            },
            "type": {},
            "topic": {
                "type": "string"
            },
            "icon": {
                "type": [
                    "null",
                    "string"
                ]
            },
            "bitrate": {
                "type": "integer"
            },
            "user_limit": {
                "type": "integer"
            },
            "rate_limit_per_user": {
                "type": "integer"
            },
            "position": {
                "type": "integer"
            },
            "permission_overwrites": {
                "type": "array",
                "items": {
                    "type": "object",
                    "properties": {
                        "id": {
                            "type": "string"
                        },
                        "type": {},
                        "allow": {
                            "type": "string"
                        },
                        "deny": {
                            "type": "string"
                        }
                    },
                    "additionalProperties": false,
                    "required": [
                        "allow",
                        "deny",
                        "id",
                        "type"
                    ]
                }
            },
            "parent_id": {
                "type": "string"
            },
            "id": {
                "type": "string"
            },
            "nsfw": {
                "type": "boolean"
            },
            "rtc_region": {
                "type": "string"
            },
            "default_auto_archive_duration": {
                "type": "integer"
            },
            "default_reaction_emoji": {
                "type": [
                    "null",
                    "string"
                ]
            },
            "flags": {
                "type": "integer"
            },
            "default_thread_rate_limit_per_user": {
                "type": "integer"
            },
            "video_quality_mode": {
                "type": [
                    "null",
                    "integer"
                ]
            }
        },
        "additionalProperties": false,
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "MessageCreateSchema": {
        "type": "object",
        "properties": {
            "type": {
                "type": "integer"
            },
            "content": {
                "type": "string"
            },
            "nonce": {
                "type": "string"
            },
            "channel_id": {
                "type": "string"
            },
            "tts": {
                "type": "boolean"
            },
            "flags": {
                "type": "string"
            },
            "embeds": {
                "type": "array",
                "items": {}
            },
            "embed": {},
            "allowed_mentions": {
                "type": "object",
                "properties": {
                    "parse": {
                        "type": "array",
                        "items": {
                            "type": "string"
                        }
                    },
                    "roles": {
                        "type": "array",
                        "items": {
                            "type": "string"
                        }
                    },
                    "users": {
                        "type": "array",
                        "items": {
                            "type": "string"
                        }
                    },
                    "replied_user": {
                        "type": "boolean"
                    }
                },
                "additionalProperties": false
            },
            "message_reference": {
                "type": "object",
                "properties": {
                    "message_id": {
                        "type": "string"
                    },
                    "channel_id": {
                        "type": "string"
                    },
                    "guild_id": {
                        "type": "string"
                    },
                    "fail_if_not_exists": {
                        "type": "boolean"
                    }
                },
                "additionalProperties": false,
                "required": [
                    "channel_id",
                    "message_id"
                ]
            },
            "payload_json": {
                "type": "string"
            },
            "file": {},
            "attachments": {
                "description": "TODO: we should create an interface for attachments\nTODO: OpenWAAO<-->attachment-style metadata conversion",
                "type": "array",
                "items": {}
            },
            "sticker_ids": {
                "type": "array",
                "items": {
                    "type": "string"
                }
            }
        },
        "additionalProperties": false,
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "InviteCreateSchema": {
        "type": "object",
        "properties": {
            "target_user_id": {
                "type": "string"
            },
            "target_type": {
                "type": "string"
            },
            "validate": {
                "type": "string"
            },
            "max_age": {
                "type": "integer"
            },
            "max_uses": {
                "type": "integer"
            },
            "temporary": {
                "type": "boolean"
            },
            "unique": {
                "type": "boolean"
            },
            "target_user": {
                "type": "string"
            },
            "target_user_type": {
                "type": "integer"
            }
        },
        "additionalProperties": false,
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "MessageAcknowledgeSchema": {
        "type": "object",
        "properties": {
            "manual": {
                "type": "boolean"
            },
            "mention_count": {
                "type": "integer"
            }
        },
        "additionalProperties": false,
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "BulkDeleteSchema": {
        "type": "object",
        "properties": {
            "messages": {
                "type": "array",
                "items": {
                    "type": "string"
                }
            }
        },
        "additionalProperties": false,
        "required": [
            "messages"
        ],
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "ChannelPermissionOverwriteSchema": {
        "type": "object",
        "additionalProperties": false,
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "PurgeSchema": {
        "type": "object",
        "properties": {
            "before": {
                "type": "string"
            },
            "after": {
                "type": "string"
            }
        },
        "additionalProperties": false,
        "required": [
            "after",
            "before"
        ],
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "WebhookCreateSchema": {
        "type": "object",
        "properties": {
            "name": {
                "maxLength": 80,
                "type": "string"
            },
            "avatar": {
                "type": "string"
            }
        },
        "additionalProperties": false,
        "required": [
            "avatar",
            "name"
        ],
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "GatewayBotResponse": {
        "type": "object",
        "properties": {
            "url": {
                "type": "string"
            },
            "shards": {
                "type": "integer"
            },
            "session_start_limit": {
                "type": "object",
                "properties": {
                    "total": {
                        "type": "integer"
                    },
                    "remaining": {
                        "type": "integer"
                    },
                    "reset_after": {
                        "type": "integer"
                    },
                    "max_concurrency": {
                        "type": "integer"
                    }
                },
                "additionalProperties": false,
                "required": [
                    "max_concurrency",
                    "remaining",
                    "reset_after",
                    "total"
                ]
            }
        },
        "additionalProperties": false,
        "required": [
            "session_start_limit",
            "shards",
            "url"
        ],
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "GatewayResponse": {
        "type": "object",
        "properties": {
            "url": {
                "type": "string"
            }
        },
        "additionalProperties": false,
        "required": [
            "url"
        ],
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "BanCreateSchema": {
        "type": "object",
        "properties": {
            "delete_message_days": {
                "type": "string"
            },
            "reason": {
                "type": "string"
            }
        },
        "additionalProperties": false,
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "BanRegistrySchema": {
        "type": "object",
        "properties": {
            "id": {
                "type": "string"
            },
            "user_id": {
                "type": "string"
            },
            "guild_id": {
                "type": "string"
            },
            "executor_id": {
                "type": "string"
            },
            "ip": {
                "type": "string"
            },
            "reason": {
                "type": "string"
            }
        },
        "additionalProperties": false,
        "required": [
            "executor_id",
            "guild_id",
            "id",
            "user_id"
        ],
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "BanModeratorSchema": {
        "type": "object",
        "properties": {
            "id": {
                "type": "string"
            },
            "user_id": {
                "type": "string"
            },
            "guild_id": {
                "type": "string"
            },
            "executor_id": {
                "type": "string"
            },
            "reason": {
                "type": "string"
            }
        },
        "additionalProperties": false,
        "required": [
            "executor_id",
            "guild_id",
            "id",
            "user_id"
        ],
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "ChannelReorderSchema": {
        "type": "array",
        "items": {
            "type": "object",
            "properties": {
                "id": {
                    "type": "string"
                },
                "position": {
                    "type": "integer"
                },
                "lock_permissions": {
                    "type": "boolean"
                },
                "parent_id": {
                    "type": "string"
                }
            },
            "additionalProperties": false,
            "required": [
                "id"
            ]
        },
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "EmojiCreateSchema": {
        "type": "object",
        "properties": {
            "name": {
                "type": "string"
            },
            "image": {
                "type": "string"
            },
            "require_colons": {
                "type": [
                    "null",
                    "boolean"
                ]
            },
            "roles": {
                "type": "array",
                "items": {
                    "type": "string"
                }
            }
        },
        "additionalProperties": false,
        "required": [
            "image"
        ],
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "EmojiModifySchema": {
        "type": "object",
        "properties": {
            "name": {
                "type": "string"
            },
            "roles": {
                "type": "array",
                "items": {
                    "type": "string"
                }
            }
        },
        "additionalProperties": false,
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "GuildCreateSchema": {
        "type": "object",
        "properties": {
            "name": {
                "maxLength": 100,
                "type": "string"
            },
            "region": {
                "type": "string"
            },
            "icon": {
                "type": [
                    "null",
                    "string"
                ]
            },
            "channels": {
                "type": "array",
                "items": {
                    "$ref": "#/definitions/ChannelModifySchema"
                }
            },
            "guild_template_code": {
                "type": "string"
            },
            "system_channel_id": {
                "type": "string"
            },
            "rules_channel_id": {
                "type": "string"
            }
        },
        "additionalProperties": false,
        "definitions": {
            "ChannelModifySchema": {
                "type": "object",
                "properties": {
                    "name": {
                        "maxLength": 100,
                        "type": "string"
                    },
                    "type": {},
                    "topic": {
                        "type": "string"
                    },
                    "icon": {
                        "type": [
                            "null",
                            "string"
                        ]
                    },
                    "bitrate": {
                        "type": "integer"
                    },
                    "user_limit": {
                        "type": "integer"
                    },
                    "rate_limit_per_user": {
                        "type": "integer"
                    },
                    "position": {
                        "type": "integer"
                    },
                    "permission_overwrites": {
                        "type": "array",
                        "items": {
                            "type": "object",
                            "properties": {
                                "id": {
                                    "type": "string"
                                },
                                "type": {},
                                "allow": {
                                    "type": "string"
                                },
                                "deny": {
                                    "type": "string"
                                }
                            },
                            "additionalProperties": false,
                            "required": [
                                "allow",
                                "deny",
                                "id",
                                "type"
                            ]
                        }
                    },
                    "parent_id": {
                        "type": "string"
                    },
                    "id": {
                        "type": "string"
                    },
                    "nsfw": {
                        "type": "boolean"
                    },
                    "rtc_region": {
                        "type": "string"
                    },
                    "default_auto_archive_duration": {
                        "type": "integer"
                    },
                    "default_reaction_emoji": {
                        "type": [
                            "null",
                            "string"
                        ]
                    },
                    "flags": {
                        "type": "integer"
                    },
                    "default_thread_rate_limit_per_user": {
                        "type": "integer"
                    },
                    "video_quality_mode": {
                        "type": [
                            "null",
                            "integer"
                        ]
                    }
                },
                "additionalProperties": false
            }
        },
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "GuildUpdateSchema": {
        "type": "object",
        "properties": {
            "banner": {
                "type": [
                    "null",
                    "string"
                ]
            },
            "splash": {
                "type": [
                    "null",
                    "string"
                ]
            },
            "description": {
                "type": "string"
            },
            "features": {
                "type": "array",
                "items": {
                    "type": "string"
                }
            },
            "verification_level": {
                "type": "integer"
            },
            "default_message_notifications": {
                "type": "integer"
            },
            "system_channel_flags": {
                "type": "integer"
            },
            "explicit_content_filter": {
                "type": "integer"
            },
            "public_updates_channel_id": {
                "type": "string"
            },
            "afk_timeout": {
                "type": "integer"
            },
            "afk_channel_id": {
                "type": "string"
            },
            "preferred_locale": {
                "type": "string"
            },
            "premium_progress_bar_enabled": {
                "type": "boolean"
            },
            "name": {
                "maxLength": 100,
                "type": "string"
            },
            "region": {
                "type": "string"
            },
            "icon": {
                "type": [
                    "null",
                    "string"
                ]
            },
            "guild_template_code": {
                "type": "string"
            },
            "system_channel_id": {
                "type": "string"
            },
            "rules_channel_id": {
                "type": "string"
            }
        },
        "additionalProperties": false,
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "MemberChangeSchema": {
        "type": "object",
        "properties": {
            "roles": {
                "type": "array",
                "items": {
                    "type": "string"
                }
            },
            "nick": {
                "type": "string"
            }
        },
        "additionalProperties": false,
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "MemberNickChangeSchema": {
        "type": "object",
        "properties": {
            "nick": {
                "type": "string"
            }
        },
        "additionalProperties": false,
        "required": [
            "nick"
        ],
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "PruneSchema": {
        "type": "object",
        "properties": {
            "days": {
                "type": "integer"
            }
        },
        "additionalProperties": false,
        "required": [
            "days"
        ],
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "RoleModifySchema": {
        "type": "object",
        "properties": {
            "name": {
                "type": "string"
            },
            "permissions": {
                "type": "string"
            },
            "color": {
                "type": "integer"
            },
            "hoist": {
                "type": "boolean"
            },
            "mentionable": {
                "type": "boolean"
            },
            "position": {
                "type": "integer"
            },
            "icon": {
                "type": "string"
            },
            "unicode_emoji": {
                "type": "string"
            }
        },
        "additionalProperties": false,
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "RolePositionUpdateSchema": {
        "type": "array",
        "items": {
            "type": "object",
            "properties": {
                "id": {
                    "type": "string"
                },
                "position": {
                    "type": "integer"
                }
            },
            "additionalProperties": false,
            "required": [
                "id",
                "position"
            ]
        },
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "ModifyGuildStickerSchema": {
        "type": "object",
        "properties": {
            "name": {
                "minLength": 2,
                "maxLength": 30,
                "type": "string"
            },
            "description": {
                "maxLength": 100,
                "type": "string"
            },
            "tags": {
                "maxLength": 200,
                "type": "string"
            }
        },
        "additionalProperties": false,
        "required": [
            "name",
            "tags"
        ],
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "TemplateCreateSchema": {
        "type": "object",
        "properties": {
            "name": {
                "type": "string"
            },
            "description": {
                "type": "string"
            }
        },
        "additionalProperties": false,
        "required": [
            "name"
        ],
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "TemplateModifySchema": {
        "type": "object",
        "properties": {
            "name": {
                "type": "string"
            },
            "description": {
                "type": "string"
            }
        },
        "additionalProperties": false,
        "required": [
            "name"
        ],
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "VanityUrlSchema": {
        "type": "object",
        "properties": {
            "code": {
                "minLength": 1,
                "maxLength": 20,
                "type": "string"
            }
        },
        "additionalProperties": false,
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "VoiceStateUpdateSchema": {
        "type": "object",
        "properties": {
            "channel_id": {
                "type": "string"
            },
            "guild_id": {
                "type": "string"
            },
            "suppress": {
                "type": "boolean"
            },
            "request_to_speak_timestamp": {
                "type": "string",
                "format": "date-time"
            },
            "self_mute": {
                "type": "boolean"
            },
            "self_deaf": {
                "type": "boolean"
            },
            "self_video": {
                "type": "boolean"
            }
        },
        "additionalProperties": false,
        "required": [
            "channel_id"
        ],
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "GuildUpdateWelcomeScreenSchema": {
        "type": "object",
        "properties": {
            "welcome_channels": {
                "type": "array",
                "items": {
                    "type": "object",
                    "properties": {
                        "channel_id": {
                            "type": "string"
                        },
                        "description": {
                            "type": "string"
                        },
                        "emoji_id": {
                            "type": "string"
                        },
                        "emoji_name": {
                            "type": "string"
                        }
                    },
                    "additionalProperties": false,
                    "required": [
                        "channel_id",
                        "description"
                    ]
                }
            },
            "enabled": {
                "type": "boolean"
            },
            "description": {
                "type": "string"
            }
        },
        "additionalProperties": false,
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "WidgetModifySchema": {
        "type": "object",
        "properties": {
            "enabled": {
                "type": "boolean"
            },
            "channel_id": {
                "type": "string"
            }
        },
        "additionalProperties": false,
        "required": [
            "channel_id",
            "enabled"
        ],
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "GuildTemplateCreateSchema": {
        "type": "object",
        "properties": {
            "name": {
                "type": "string"
            },
            "avatar": {
                "type": [
                    "null",
                    "string"
                ]
            }
        },
        "additionalProperties": false,
        "required": [
            "name"
        ],
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "UserProfileResponse": {
        "type": "object",
        "properties": {
            "user": {},
            "connected_accounts": {},
            "premium_guild_since": {
                "type": "string",
                "format": "date-time"
            },
            "premium_since": {
                "type": "string",
                "format": "date-time"
            }
        },
        "additionalProperties": false,
        "required": [
            "connected_accounts",
            "user"
        ],
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "UserRelationsResponse": {
        "type": "object",
        "properties": {
            "object": {
                "type": "object",
                "properties": {
                    "id": {
                        "type": "string"
                    },
                    "username": {
                        "type": "string"
                    },
                    "avatar": {
                        "type": "string"
                    },
                    "discriminator": {
                        "type": "string"
                    },
                    "public_flags": {
                        "type": "integer"
                    }
                },
                "additionalProperties": false
            }
        },
        "additionalProperties": false,
        "required": [
            "object"
        ],
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "DmChannelCreateSchema": {
        "type": "object",
        "properties": {
            "name": {
                "type": "string"
            },
            "recipients": {
                "type": "array",
                "items": {
                    "type": "string"
                }
            }
        },
        "additionalProperties": false,
        "required": [
            "recipients"
        ],
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "UserModifySchema": {
        "type": "object",
        "properties": {
            "username": {
                "minLength": 1,
                "maxLength": 100,
                "type": "string"
            },
            "avatar": {
                "type": [
                    "null",
                    "string"
                ]
            },
            "bio": {
                "maxLength": 1024,
                "type": "string"
            },
            "accent_color": {
                "type": "integer"
            },
            "banner": {
                "type": [
                    "null",
                    "string"
                ]
            },
            "password": {
                "type": "string"
            },
            "new_password": {
                "type": "string"
            },
            "code": {
                "type": "string"
            },
            "email": {
                "type": "string"
            },
            "discriminator": {
                "type": "string"
            }
        },
        "additionalProperties": false,
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "CodesVerificationSchema": {
        "type": "object",
        "properties": {
            "key": {
                "type": "string"
            },
            "nonce": {
                "type": "string"
            },
            "regenerate": {
                "type": "boolean"
            }
        },
        "additionalProperties": false,
        "required": [
            "key",
            "nonce"
        ],
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "MfaCodesSchema": {
        "type": "object",
        "properties": {
            "password": {
                "type": "string"
            },
            "regenerate": {
                "type": "boolean"
            }
        },
        "additionalProperties": false,
        "required": [
            "password"
        ],
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "TotpDisableSchema": {
        "type": "object",
        "properties": {
            "code": {
                "type": "string"
            }
        },
        "additionalProperties": false,
        "required": [
            "code"
        ],
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "TotpEnableSchema": {
        "type": "object",
        "properties": {
            "password": {
                "type": "string"
            },
            "code": {
                "type": "string"
            },
            "secret": {
                "type": "string"
            }
        },
        "additionalProperties": false,
        "required": [
            "password"
        ],
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "RelationshipPutSchema": {
        "type": "object",
        "properties": {
            "type": {}
        },
        "additionalProperties": false,
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "RelationshipPostSchema": {
        "type": "object",
        "properties": {
            "discriminator": {
                "type": "string"
            },
            "username": {
                "type": "string"
            }
        },
        "additionalProperties": false,
        "required": [
            "discriminator",
            "username"
        ],
        "$schema": "http://json-schema.org/draft-07/schema#"
    },
    "UserSettingsSchema": {
        "type": "object",
        "additionalProperties": false,
        "$schema": "http://json-schema.org/draft-07/schema#"
    }
}