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

🚀 Complete rewrite for v1 #126

Closed
charpeni opened this issue Sep 21, 2021 · 2 comments
Closed

🚀 Complete rewrite for v1 #126

charpeni opened this issue Sep 21, 2021 · 2 comments

Comments

@charpeni
Copy link
Member

Good news, everyone!

We heard you about missing endpoints and outdated types. We started this library based on our internal usages, especially for the mobile application. Unfortunately, we started moving to GraphQL and this library didn't receive all the attention it should and that's unfortunate. We want this library to follow closely our latest changes so we can all profit from this library and build awesome things with the Shortcut REST API.

So, we are working on a new and updated Swagger / OpenAPI schema that will expose our endpoints and their expected types. Then, from that Swagger schema, we rewrote entirely this library so we could generate a TypeScript client and all their associated entities. No more manual updates! 👏

The Swagger file will be available here (additional changes will land soon): https://shortcut.com/api/rest/v3#Swagger-OpenAPI-file.

We're still working on some tweaks, but we will soon be ready to publish a beta version of the complete rewrite as v1. ⚠️ We'll also publish it under a new name and not clubhouse-lib as formerly known.

👀 If you are curious and are not afraid of WIP, you can have a peek on next branch.

@charpeni
Copy link
Member Author

A first beta version is now available at https://www.npmjs.com/package/@useshortcut/client.

@charpeni
Copy link
Member Author

charpeni commented Oct 7, 2021

Published as @useshortcut/client@1.0.0. 🎉

@charpeni charpeni closed this as completed Oct 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant