-
-
Notifications
You must be signed in to change notification settings - Fork 262
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
feat: openapi response schema #932
feat: openapi response schema #932
Conversation
@VishnuSanal is attempting to deploy a commit to the sparckles Team on Vercel. A member of the Team first needs to authorize it. |
CodSpeed Performance ReportMerging #932 will improve performances by ×2.7Comparing Summary
Benchmarks breakdown
|
The schema will be defaulted to "any" for now; until typing is implemented. @sansyrox PTAL. I am not sure whether this was the expectation -- CMIIW. |
@VishnuSanal , there is also an issue in rendering of the docstrings in the application. The above is an expected response. But what happens is the one below |
@VishnuSanal , could you fix it? |
what is the issue? the location where the description is shown? fastapi might be using a slightly different version of swagger; that must be the reason. should investigate. is this a major breaking feature? isn't it just about the aesthetics? |
The issue is that Robyn's docstrings are not legible. We are appending them to the wrong location! This is may be due to a different version of swagger but feels more like wrong openapi.json generation. Hence, a blocking issue, which needs to be fixed before merging |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Need to fix the openapi docs generation
The docstrings are being appended only to the |
done, PTAL. although unrelated, I have also removed openapi integration from future roadmap in the docs -- hope this is okay & need not create a new PR. |
c0b14f9
to
cf523a2
Compare
17be6a5
to
ff8308d
Compare
9099335
to
41a4451
Compare
for more information, see https://pre-commit.ci
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Description
This PR fixes #930
Summary
This PR adds response schema to openapi docs
PR Checklist
Please ensure that:
Pre-Commit Instructions: