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

Generate API Schema #84

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

Generate API Schema #84

wants to merge 6 commits into from

Conversation

RRosio
Copy link
Collaborator

@RRosio RRosio commented Feb 25, 2025 •
edited
Loading

Resolves #83

First pass generated api schema

  • Add description docstrings to the pydantic models
  • Define API endpoints in schema
  • Add request schemas
  • Define response schemas
  • Consider how to document that added "status" indicator in handler response

Follow-ups

  • Incorporate the missing patch endpoint through out: add pydantic model, document it and add endpoint in schema.

Resource
https://spec.openapis.org/oas/v3.1.1
https://learn.openapis.org/

@RRosio RRosio added the documentation Improvements or additions to documentation label Feb 25, 2025
@RRosio RRosio self-assigned this Feb 25, 2025
@RRosio RRosio mentioned this pull request Feb 26, 2025
Open
18 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@RRosio RRosio

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document API
1 participant
@RRosio