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.

Sign up for GitHub

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

Jump to bottom

Document API #83

Open
RRosio opened this issue Feb 25, 2025 · 0 comments · May be fixed by #84
Open

Document API #83

RRosio opened this issue Feb 25, 2025 · 0 comments · May be fixed by #84
Labels
documentation Improvements or additions to documentation maintenance General tasks for project upkeep

Comments

@RRosio
Copy link
Collaborator

RRosio commented Feb 25, 2025

As we are using pydantic models, we can leverage them to automatically generate an OpenAPI schema.

  • Generate the schema for including the various models
  • Add description docstrings to the pydantic models
@RRosio RRosio added documentation Improvements or additions to documentation maintenance General tasks for project upkeep labels Feb 25, 2025
@RRosio RRosio linked a pull request Feb 25, 2025 that will close this issue
Draft
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation maintenance General tasks for project upkeep
Projects
jupyter-fsspec-planning
Status: No status
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Generate API Schema RRosio/jupyter-fsspec
1 participant
@RRosio