Comments (5)
This looks like a feature I'd really like to use, do you know if anyone has started working on it yet?
If not, I might try working on this myself. I'm fairly busy so it might take a few weeks, but I'm retooling my Django APIs right now and this looks great to implement.
from django-ninja.
@fletcheaston , so what's your preferable way ? via Union or via Dict ? ( see http://django-ninja.rest-framework.com/proposals/responses/ )
from django-ninja.
@vitalik Dict makes the most sense to me, I know I'd personally want to attach schemas to status codes in the documentation.
For reference, I've used drf-spectacular's extend schema decorator (https://drf-spectacular.readthedocs.io/en/latest/customization.html) to build my documentation with DRF, and it uses Dict in the same way you've proposed.
from django-ninja.
drf spectacular also offers the ability to return different schemas for a single status code (https://drf-spectacular.readthedocs.io/en/latest/faq.html#my-endpoints-use-different-serializers-depending-on-the-situation), but this isn't something I've used before or felt a need to use. I wouldn't attempt to implement something that complicated at first anyway.
from django-ninja.
The dict version is implemented thanks to @dozer133
Released in 0.9.0
from django-ninja.
Related Issues (20)
- Overriding JSON schema title and summary without using `Field` HOT 1
- [BUG] CSRF Fails with Django Auth HOT 15
- [BUG] Order of operations affect response and request schemas HOT 1
- Documentation - link the schema article to the error article
- Add description to tags HOT 2
- Field order issue in JSON response HOT 1
- [BUG] Allow specifying field types for custom fields
- [BUG] The other API URLs work, but the openapi docs don't appear. HOT 5
- [BUG] Can't use parameter `keys`
- how to add a description for query params that shows in the generated docs?
- Field with list factory causes API docs to not load with non-serializable. HOT 2
- Annotate Decimal field does not supported "Unable to serialize unknown type: <class 'ellipsis'"
- Traversing the data structures to create an HTTP API client HOT 3
- how to use token ? HOT 1
- Path parameters, order matters HOT 3
- [BUG] Combining JWTAuth with django_auth only works in that order
- [BUG] Pydantic 2.7.0 incompatibily HOT 4
- [BUG] ModelSchema with ManyToManyField won't work under async views HOT 5
- How do you use aliases with nested objects
- [BUG] HOT 1
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 django-ninja.