Skip to content

Define "spec product" for generating the OpenAPI example docs #45

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

Open
gadomski opened this issue Apr 2, 2025 · 3 comments · May be fixed by #68
Open

Define "spec product" for generating the OpenAPI example docs #45

gadomski opened this issue Apr 2, 2025 · 3 comments · May be fixed by #68
Assignees
Labels
[package] stapi-fastapi FastAPI server implementation
Milestone

Comments

@gadomski
Copy link
Member

gadomski commented Apr 2, 2025

There may be some router refactoring required (i.e. there's no product routes on the default app router at the moment) but let's explore. We could just copy the test app's docs as a starting point?

@gadomski gadomski added the [package] stapi-fastapi FastAPI server implementation label Apr 2, 2025
@gadomski gadomski self-assigned this Apr 2, 2025
@gadomski gadomski moved this from Todo to In Progress in STAPI sprint 2025 (Lisbon) Apr 2, 2025
@gadomski gadomski removed their assignment Apr 2, 2025
@gadomski gadomski moved this from In Progress to Todo in STAPI sprint 2025 (Lisbon) Apr 2, 2025
@toro-berlin toro-berlin changed the title Investigate generating the spec OpenAPI docs with FastAPI Define "spec product" for generating the OpenAPI example docs Apr 2, 2025
@gadomski
Copy link
Member Author

gadomski commented Apr 2, 2025

A note here -- @jkeifer were talking and we were thinking this could belong in its own (unpublished) package in the monorepo, maybe schema-generator? That way we could keep the schema generation code separate from the stapi-fastapi repo itself, since tehcnially it's a use-case of stapi-fastapi, not part of the repo per se.

Not sure if this is right, but thought I'd throw the idea out for discussion.

@toro-berlin
Copy link
Contributor

It makes a lot of sense from my perspective—it's a better choice than adding the "spec product" to stapi-fastapi in the test dir or a separate example dir and maintaining it there.

However, we would leave the current mock product and the FastAPI app in the fastapi tests dir as they might be used for testing more detailed nuances of stapi-fastapi. Does that work for you?

@gadomski
Copy link
Member Author

gadomski commented Apr 3, 2025

However, we would leave the current mock product and the FastAPI app in the fastapi tests dir as they might be used for testing more detailed nuances of stapi-fastapi. Does that work for you?

Yup, sounds good!

@gadomski gadomski added this to the v0.1 milestone Apr 3, 2025
@toro-berlin toro-berlin linked a pull request Apr 3, 2025 that will close this issue
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[package] stapi-fastapi FastAPI server implementation
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

3 participants