search

twitch-rs / twitch_api

Rust library for talking with the Twitch API aka. "Helix", TMI and more! Use Twitch endpoints fearlessly!
Apache License 2.0
150 stars 33 forks source link

docs: add overview for implemented requests #412

Closed Nerixyz closed 1 month ago

Nerixyz commented 7 months ago

I'll rebase this once https://github.com/twitch-rs/twitch_api/pull/359 is merged.

This adds a script to generate an overview over the implemented requests and helpers. It requires Rust nightly. On a high level, the script reads the Twitch docs and matches the endpoints to the implemented endpoints in this crate.

cargo (+nightly) xtask overview

CI will check if the docs are up-to-date and provide a diff if they're not (--check).

Towards #330.

Emilgardis commented 7 months ago

would it be possible to do this for eventsub too?

Nerixyz commented 7 months ago

would it be possible to do this for eventsub too?

I've added an overview for eventsub, but the types are quite long.

before ![firefox_2024-04-15_21-26-21](https://github.com/twitch-rs/twitch_api/assets/19953266/9ee2c151-9053-432b-9c4d-51b20a45fa7f)

Updated it to fit.

firefox_2024-04-19_23-21-28

Nerixyz commented 1 month ago

Updated it to Rust, so people don't need to install Deno anymore. The only downside is that the code is much larger. On the upside, this should give us schema updates of the JSON format Rustdoc uses. I kept the previous commit for reference, but that should be squashed before a merge.