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

Update API docs for v2 #1555

Open
ChrisSchinnerl opened this issue Sep 19, 2024 · 2 comments
Open

Update API docs for v2 #1555

ChrisSchinnerl opened this issue Sep 19, 2024 · 2 comments
Milestone

Comments

@ChrisSchinnerl
Copy link
Member

No description provided.

@ChrisSchinnerl ChrisSchinnerl converted this from a draft issue Sep 19, 2024
@ChrisSchinnerl ChrisSchinnerl moved this from Triage to Todo in Sia Sep 19, 2024
@ChrisSchinnerl ChrisSchinnerl added this to the v2.0.0 milestone Sep 19, 2024
@ChrisSchinnerl
Copy link
Member Author

@n8maninger I feel like we had that discussion somewhere already but since we broke a good chunk of the API for v2 I wanted to know how you feel about biting the bullet and introducing an openapi specification in the repo for generating the docs.
It would be nice for similar reasons as knope. Being able to update the spec atomically within the same PR that introduces it is a huge upside imo.

@pcfreak30
Copy link

TBH I would +1 this as well, as it would help on interop/adoption. Anyone who wants to create a sia client library can honestly get most of it done via openapi generators and maintain those without needing to do a lot of CRUD R&D on http requests.

I have made Lumes portal API's OpenAPI 1st for the most part, for this reason, and consume the APIs as well.

@peterjan peterjan moved this from Todo to In Review in Sia Dec 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Review
Development

No branches or pull requests

2 participants