Comments (4)
You need to tell pydantic to use the proper path. It is one of the params in the schema method. LMK if you need further help getting it to work.
from sanic-ext.
Thank you for your answer but I cannot find the documentation for the schema method on the sanic webpage.
Do you mean the ref_template
parameter? If so, yes, it allows me to change the path where the references are pointing to but the actual definitions remain in the field definitions
inside the schema
which is not a valid swagger field. How do I move the content of the definitions
object to #/components
as required by swagger 3?
from sanic-ext.
I found all I had to do what just pass the pydantic class without calling schema
and it worked fine:
@openapi.definition(
body={"application/json": DocumentsCreateReq}, # pydantic class
response={200: {"application/json": DocumentsCreateRes}}, # pydantic class
)
from sanic-ext.
Using schema is a good idea in many cases, but you need to fix the reference template as suggested. It's a pydantic issue.
from sanic-ext.
Related Issues (20)
- [Feature Request] support content as alternative to schema for parameters
- [Bug] OpenAPI docs `str|None` is displayed as `{}`
- [Bug]
- [Bug] The error for not having Jinja installed is confusing
- [Bug] Wrong default variables type of Server object.
- [Feature Request] Blueprints cannot access the 'decorator way' of managing / rendering templates
- Allow the option to define a template directory in a blueprint HOT 1
- [Bug] Dependency injection not working for requests received during server is initializing HOT 1
- [Question] How to set field description on data class?
- [Question] OpenAPI spec available on all subdomains, and route exclusion without decorators does not seem to work.
- [Bug] Dependeny Injection throw exceptions by default if @classmethod constructors don't return value/objects
- [Feature Request]
- [Bug] OpenAPI definition does not include placeholder for "headers"
- [Bug] Json validator throws 500 instead of 400
- [Feature Request] Response Compression
- [Bug] Can't use `pydantic>=2.0` model in OpenAPI definition HOT 1
- [Bug] Can't document/exclude websocket routes with OpenAPI decorator
- [Bug] Subheader "parameter" missing in sanic extensions document
- [Bug] Can't apply openapi decorators to blueprintss' routes
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from sanic-ext.