Skip to content
This repository has been archived by the owner on Jan 15, 2024. It is now read-only.

Is client code generation possible? #378

Closed
JunkMyFunk opened this issue Jul 6, 2021 · 3 comments
Closed

Is client code generation possible? #378

JunkMyFunk opened this issue Jul 6, 2021 · 3 comments

Comments

@JunkMyFunk
Copy link

JunkMyFunk commented Jul 6, 2021

Using openapi-generator (with --skip-validation) I was able to compile a Python client from these specs for the Catalog V3 API. However it's not usable - every request I try comes back with one error or another, simple operations like getting the catalog summary or a single product fail because of a mismatch between the specs and the actual responses.

Is the intention of this project to enable client code generation or is it simply for the generation of the online documentation? Given that the "official" Python API client is pretty much abandoned and doesn't work with any V3 endpoints, it would be ideal to use this if possible. If we submit issues for the errors we encounter with generated code, will they be addressed?

@joshdifabio
Copy link

We've been doing so at Space 48 using openapi-typescript. The big challenge is that BC's specs contain a lot of mistakes.

See https://github.com/Space48/bigcommerce-api-js

@JunkMyFunk
Copy link
Author

It would be great if BigCommerce would engage with developers providing feedback and PRs for this. Having complete and accurate OpenAPI specs would help a lot of related issues

@UwanaIkaiddiSonos
Copy link
Contributor

Hi @JunkMyFunk, thanks for your patience here!

My team is in the process of bringing all of our API specs files up-to-date. Since we're a small team and have quite a few APIs, this will take some time.

Our team usually uses this repo with the single purpose of housing our spec files. We have not been checking it regularly for external issues and/or PRs. We usually receive feedback requests via the Docs Feedback buttons located in the bottom-right of each of our API reference pages on our Dev Center.

Now that we're aware of engagement via this repo, we'd be happy to receive any feedback you have via this repo or our Docs Feedback button.

Thanks again!

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

No branches or pull requests

3 participants