kitsune-soc / kitsune

🦊 (fast) ActivityPub-federated microblogging
https://joinkitsune.org
Other
291 stars 19 forks source link

[DISCUSSION] Do we need OpenAPI docs for the Mastodon API? #540

Closed aumetra closed 1 month ago

aumetra commented 1 month ago

While, yes, in theory it is nice to have the documentation, I feel like it will be badly maintained (if at all), and will be rarely used.

I still feel like this should be something upstream Mastodon should provide and not third-party API compatible servers (such as Kitsune, GoToSocial, or Akkoma).

And our custom API is based on GraphQL (as of the point of this discussion) which as documentation built-in, making this kinda useless for our own purposes. We only offer the Mastodon API to ease users in, any Kitsune-specific features (if we end up with some the user has to opt into), will only be exposed via the GraphQL API anyway.

That means we stay rather vanilla in terms of the Mastodon API (maybe implement some Akkoma-specific things for emoji reactions, quote reposts, and such), where we can refer to offical Mastodon clients or Akkoma's Swagger instead.