Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v4: Generate API and Gateway structures #399

Open
diamondburned opened this issue Aug 3, 2023 · 0 comments
Open

v4: Generate API and Gateway structures #399

diamondburned opened this issue Aug 3, 2023 · 0 comments
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@diamondburned
Copy link
Owner

Ideally, all of our API and WS gateway data structures should be autogenerated. This will make maintenance overhead so much lower.

Plan

We will use discord-api-types's existing type definitions for this, rather than trying to manually parse the documentation ourselves. A lot of breaking changes may happen because of this, which is why it's part of the v4 milestone.

A very easy way to consume the documentation is by using Deno: deno doc --json https://deno.land/x/discord_api_types/v10.ts. A lightweight code generator can accept the Deno-generated JSON representation of the TypeScript file as input.

@diamondburned diamondburned added this to the v4 milestone Aug 3, 2023
@diamondburned diamondburned self-assigned this Aug 3, 2023
@diamondburned diamondburned added the enhancement New feature or request label Aug 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant