-
Notifications
You must be signed in to change notification settings - Fork 51
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
fix: Adjust OpenAPI index POST example request body #3268
Conversation
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.
This does fix the OpenAPI issue, but I think we should also update the client interface.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #3268 +/- ##
===========================================
+ Coverage 78.09% 78.14% +0.05%
===========================================
Files 382 382
Lines 35390 35405 +15
===========================================
+ Hits 27635 27665 +30
+ Misses 6119 6109 -10
+ Partials 1636 1631 -5
Flags with carried forward coverage won't be shown. Click here to find out more.
... and 17 files with indirect coverage changes Continue to review full report in Codecov by Sentry.
|
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.
Looks really good! Nice work!
Relevant issue(s)
Resolves #2459
Description
On the OpenAPI tool of the playground, the Index POST tab contained an example body that was incorrect. It listed ID as a field which could be set, which was untrue (this value is automatically generated, and trying to pass one in throws an error.) To adjust this, I have created a new description structure called
IndexCreateRequestDescription
which is meant to be used for this type of HTTP request. To go alongside this change, a new schema type,indexCreateRequestSchema
was also created.Tasks
How has this been tested?
The platform(s) on which this was tested: