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

No formal human-readable documentation for SDK exists. #399

Open
iMakedonsky opened this issue Feb 6, 2022 · 1 comment
Open

No formal human-readable documentation for SDK exists. #399

iMakedonsky opened this issue Feb 6, 2022 · 1 comment

Comments

@iMakedonsky
Copy link

iMakedonsky commented Feb 6, 2022

As stated in the title, currently the only way to read what this sdk wants to get for which param to which method is to go to implementation via IDE and read through boilerplate openapi code.

Boilerplate-generated errors rarely help understand where sdk wants an instance of an inner class, an array of such instances or just a string/array of strings. So you still have to go and check through the code.

@spacether
Copy link

For reference here, this should work better if the client is regenerated using openapi v6.2.0
Docs for that generator include inline types or links to reference types
Endpoints include type hints
Model inputs include type hints

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants