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

Client side SDK for frontend development would be great #2

Open
NewJerseyStyle opened this issue May 1, 2024 · 2 comments
Open

Client side SDK for frontend development would be great #2

NewJerseyStyle opened this issue May 1, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@NewJerseyStyle
Copy link
Owner

For better documentation and simplify developers for developing other front end solution to replace existing Streamlit user interface, a SDK for TypeScript should be developed and the Swagger UI should be tested and enhanced in documentation, many data structure in the FastAPI API endpoint implementations are still unclear which may be a roadblock for other develoepr. It has to be clean up before Beta release

@NewJerseyStyle NewJerseyStyle added this to the First alpha release milestone May 1, 2024
@NewJerseyStyle NewJerseyStyle self-assigned this May 1, 2024
@NewJerseyStyle NewJerseyStyle added documentation Improvements or additions to documentation enhancement New feature or request labels May 1, 2024
@NewJerseyStyle
Copy link
Owner Author

OpenAPI Generator should be considered for client side SDKs

Data structure for API endpoint instructions and examples

@NewJerseyStyle
Copy link
Owner Author

TODOs:

  • Test the client SDK
  • Upload the SDK
  • Docs about how to gen SDK

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant