You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We have discussed over the years whether to autogenerate the pyscisat client from the openapi.json. We feel this is a great time to try it. We tried this long ago using the older backend, and the loopback-generated openapi created some pretty ugly auto-generated code. But with the new backend, there has been a lot of work on making a better openapi, and things are better.
Known advantages:
Comments in the nest.js seem to make it up to the openapi and into docstrings for the generated client. Cool
openapi-python-client builds both a sync and async client. This is really great for implementations where pyscicat was used within a web service (like, say, fastapi)
less work overall
Some issues with this approach:
Where does one go to find the "official" openapi json? It would be nice to be able to release builds that track the current version of the backend buout I'm not sure how that works. Would github action download the backend and npm and issue a build command that outputs a the openapi.json file?
This will significantly change the API for pyscicat. I propose that we release this as v1.0.0 an declare that it is a breaking change.
The text was updated successfully, but these errors were encountered:
We have discussed over the years whether to autogenerate the pyscisat client from the openapi.json. We feel this is a great time to try it. We tried this long ago using the older backend, and the loopback-generated openapi created some pretty ugly auto-generated code. But with the new backend, there has been a lot of work on making a better openapi, and things are better.
Known advantages:
Some issues with this approach:
The text was updated successfully, but these errors were encountered: