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

Docs: Revamp APIv2 Docs #13

Open
kilrau opened this issue May 29, 2024 · 0 comments
Open

Docs: Revamp APIv2 Docs #13

kilrau opened this issue May 29, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@kilrau
Copy link
Member

kilrau commented May 29, 2024

We received feedback recently (e.g. via our TG group) that our APIv2 docs are not as comprehensive as our APIv1 docs in a way that the short swagger descsriptions are not enough to understand what a specific call does.

Also the he code examples might not be enough of a description for the typical order/flow is. Maybe we can combine APIv1-style descriptions linking to swagger for each call.

Specific things that are unclear:

@kilrau kilrau added the enhancement New feature or request label May 29, 2024
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

2 participants