Hi @vitalik, I'm trying to upload a file but it's always getting a "field required" message.

Handler:

FileParam = File
def file_create(request: HttpRequest,
        name: str = FileParam(..., max_length=100),
        description: Optional[str] = FileParam(None, max_length=500),
        file: UploadedFile = FileParam(...),
        folder: Optional[UUID] = FileParam(None)
    ):

Has anything been missed?

I am trying to use Django Auth system, but the Docs are not working on POST/PUT requests and also on Django core admin requests.

Config:

api = NinjaAPI(csrf=True, auth=[django_auth])

The only way I could do to access and execute a POST on the Swagger documentation is by adding @csrf_exempt decorator from django.views.decorators.csrf

@router.delete('/v1/auth/logout/', auth=None)
def auth_logout(request):
    logout(request)
    resp = HttpResponseRedirect('/')
    # trocar o método para GET -> 303
    resp.status_code = 303
    return resp


@router.post('/v1/auth/status/')
@csrf_exempt
def auth_status(request):
    if request.user.is_authenticated:
        return True
    else:
        return HttpError(401, 'Unauthenticated')

I already tryed commenting django.middleware.csrf.CsrfViewMiddleware, but doest work.

Is there a way to use django_sessions with documentation working on POST requests and default admin endpoints? if not, just allow us to use django_auth without forcing to enable CSRF token pls.

Fixes #291 (even though it was closed) and fixes #250 and adds in new functionality to allow calculated fields via resolve_ static methods on the response schema class.

Includes tests and docs.

Hi there, I was playing around a bit with the basic tutorial (it worked perfectly in the beginning) and got this error at some point:

  File "/django/django_aia_backend/django_aia_backend/urls.py", line 31, in <module>
    path('api/', include(api.urls)),
  File "/djangovenv/lib/python3.9/site-packages/ninja/main.py", line 314, in urls
    self._validate()
  File "/djangovenv/lib/python3.9/site-packages/ninja/main.py", line 398, in _validate
    raise ConfigError("\n".join(msg))
ninja.errors.ConfigError: Looks like you created multiple NinjaAPIs
To let ninja distinguish them you need to set either unique version or url_namespace
 - NinjaAPI(..., version='2.0.0')
 - NinjaAPI(..., urls_namespace='otherapi')
Already registered: ['api-1.0.0']

not sure what is the problem here. I only have one instantiation of NinjaAPI. I tried giving it a specific version name but that does not change anything.

To be fair, I played around a bit before, among other things creating a django app called 'api' for using standard DRF. I deleted this and every reference to it, but even after starting a brand new django project, the error persists. Does the api instantiation get persisted somewhere in venv? I cannot explain otherwise why this happens.

Nice project. Good to see the ideas from FastAPI get integrated with Django.

The problem, when using ModelSchema, an IDE like pycharm does not autocomplete the generated schema.

class CustomerIn(ModelSchema):
    extra_field: str

    class Config:
        model = Customer
        model_fields = ['name', 'date']

Then

customer: CustomerIn
customer.name  # unknown field for the IDE
customer.extra_field  # ok

Possible workarounds?

File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/django/core/handlers/base.py", line 181, in _get_response response = wrapped_callback(request, *callback_args, **callback_kwargs) File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/ninja/openapi/views.py", line 35, in openapi_json schema = api.get_openapi_schema() File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/ninja/main.py", line 419, in get_openapi_schema return get_schema(api=self, path_prefix=path_prefix) File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/ninja/openapi/schema.py", line 40, in get_schema openapi = OpenAPISchema(api, path_prefix) File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/ninja/openapi/schema.py", line 62, in init ("paths", self.get_paths()), File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/ninja/openapi/schema.py", line 77, in get_paths path_methods = self.methods(path_view.operations) File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/ninja/openapi/schema.py", line 86, in methods operation_details = self.operation_details(op) File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/ninja/openapi/schema.py", line 114, in operation_details body = self.request_body(operation) File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/ninja/openapi/schema.py", line 228, in request_body model, remove_level=model._param_source == "body" File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/ninja/openapi/schema.py", line 186, in _create_schema_from_model cast(Type[BaseModel], model), ref_prefix=REF_PREFIX, by_alias=by_alias File "pydantic/schema.py", line 167, in pydantic.schema.model_schema File "pydantic/schema.py", line 548, in pydantic.schema.model_process_schema File "pydantic/schema.py", line 589, in pydantic.schema.model_type_schema File "pydantic/schema.py", line 236, in pydantic.schema.field_schema File "pydantic/schema.py", line 303, in pydantic.schema.get_field_schema_validations TypeError: modify_schema() missing 1 required positional argument: 'field' [28/Oct/2022 10:11:46] "GET /api/openapi.json HTTP/1.1" 500 254519 [28/Oct/2022 10:11:46] "GET /api/docs HTTP/1.1" 200 788 Internal Server Error: /api/openapi.json Traceback (most recent call last): File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/django/core/handlers/exception.py", line 47, in inner response = get_response(request) File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/django/core/handlers/base.py", line 181, in _get_response response = wrapped_callback(request, *callback_args, **callback_kwargs) File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/ninja/openapi/views.py", line 35, in openapi_json schema = api.get_openapi_schema() File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/ninja/main.py", line 419, in get_openapi_schema return get_schema(api=self, path_prefix=path_prefix) File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/ninja/openapi/schema.py", line 40, in get_schema openapi = OpenAPISchema(api, path_prefix) File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/ninja/openapi/schema.py", line 62, in init ("paths", self.get_paths()), File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/ninja/openapi/schema.py", line 77, in get_paths path_methods = self.methods(path_view.operations) File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/ninja/openapi/schema.py", line 86, in methods operation_details = self.operation_details(op) File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/ninja/openapi/schema.py", line 114, in operation_details body = self.request_body(operation) File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/ninja/openapi/schema.py", line 228, in request_body model, remove_level=model._param_source == "body" File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/ninja/openapi/schema.py", line 186, in _create_schema_from_model cast(Type[BaseModel], model), ref_prefix=REF_PREFIX, by_alias=by_alias File "pydantic/schema.py", line 167, in pydantic.schema.model_schema File "pydantic/schema.py", line 548, in pydantic.schema.model_process_schema File "pydantic/schema.py", line 589, in pydantic.schema.model_type_schema File "pydantic/schema.py", line 236, in pydantic.schema.field_schema File "pydantic/schema.py", line 303, in pydantic.schema.get_field_schema_validations TypeError: modify_schema() missing 1 required positional argument: 'field' [28/Oct/2022 10:11:47] "GET /api/openapi.json HTTP/1.1" 500 254519 [28/Oct/2022 10:24:17] "GET /api/docs HTTP/1.1" 200 788 Internal Server Error: /api/openapi.json Traceback (most recent call last): File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/django/core/handlers/exception.py", line 47, in inner response = get_response(request) File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/django/core/handlers/base.py", line 181, in _get_response response = wrapped_callback(request, *callback_args, **callback_kwargs) File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/ninja/openapi/views.py", line 35, in openapi_json schema = api.get_openapi_schema() File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/ninja/main.py", line 419, in get_openapi_schema return get_schema(api=self, path_prefix=path_prefix) File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/ninja/openapi/schema.py", line 40, in get_schema openapi = OpenAPISchema(api, path_prefix) File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/ninja/openapi/schema.py", line 62, in init ("paths", self.get_paths()), File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/ninja/openapi/schema.py", line 77, in get_paths path_methods = self.methods(path_view.operations) File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/ninja/openapi/schema.py", line 86, in methods operation_details = self.operation_details(op) File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/ninja/openapi/schema.py", line 114, in operation_details body = self.request_body(operation) File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/ninja/openapi/schema.py", line 228, in request_body model, remove_level=model._param_source == "body" File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/ninja/openapi/schema.py", line 186, in _create_schema_from_model cast(Type[BaseModel], model), ref_prefix=REF_PREFIX, by_alias=by_alias File "pydantic/schema.py", line 167, in pydantic.schema.model_schema File "pydantic/schema.py", line 548, in pydantic.schema.model_process_schema File "pydantic/schema.py", line 589, in pydantic.schema.model_type_schema File "pydantic/schema.py", line 236, in pydantic.schema.field_schema File "pydantic/schema.py", line 303, in pydantic.schema.get_field_schema_validations TypeError: modify_schema() missing 1 required positional argument: 'field' [28/Oct/2022 10:24:17] "GET /api/openapi.json HTTP/1.1" 500 254519

I always get this on openapi.

ninja.errors.ConfigError: Schema for status 400 is not set in response dict_keys([200])

when I don't add a specific response model, it shouldn't be validated!

ValidationError at /api/order/orders
6 validation errors for NinjaResponseSchema
response -> 0 -> customer_id
  value is not a valid integer (type=type_error.integer)
response -> 0 -> vendor_id
  value is not a valid integer (type=type_error.integer)
response -> 0 -> vender_product_id
  value is not a valid integer (type=type_error.integer)
response -> 1 -> customer_id
  value is not a valid integer (type=type_error.integer)
response -> 1 -> vendor_id
  value is not a valid integer (type=type_error.integer)
response -> 1 -> vender_product_id
  value is not a valid integer (type=type_error.integer)

my schema is like this:

class OrderSchema(Schema):
    customer_id: int
    vendor_id: int
    vender_product_id: int
    total_product: int
    total_price: int
    created_on: datetime
    updated_on: datetime

First of all, thank you very much for your work on this project. I sincerely hope that you and your family are doing well and I sincerely pray for the resolution of the conflict in Ukraine.

Describe the bug I'm getting a RuntimeError on my django ninja async views when ATOMIC_REQUESTS is true

Versions

• Python version: 3.10
• Django version: 4.0.3
• Django-Ninja version: 0.17.0

# settings.py
DATABASES["default"]["ATOMIC_REQUESTS"] = True

# api.py


@transaction.non_atomic_requests
@router.post("/flight-hotel-search", response=FlightHotelSearchResult)
async def flight_hotel_search(request:HttpRequest, criteria: FlightHotelSearchCriteria):
  # there is zero database call done by me in this view
  ...



# Error
# RuntimeError: You cannot use ATOMIC_REQUESTS with async views.

Hi! I want to contribute, but i found that project depends on flint and it seems very unfriendly to me.

It gave 2 questions to me:

• Could we add some docs for contributors?
• Could we move to poetry?

I recently started using Django Ninja, and encountered a scenario where I need to return a redirect response to another endpoint (though it would be cool if I could redirect to any URL). I couldn't find a way to do this, and was unable to use something like redirect()/HttpResponseRedirect (the error I received was Pydantic-related, but I assume that even if validation was disabled, this still wouldn't have worked).

Is there a way to do this in Django Ninja?

As the title says.... When we have lazy texts as verbose_names for django model fields, the schema generation will not use these in the correct language. Calling field.verbose_name.title() will evaluate it when the model is loaded and not when openapi.json is generated.

Changing field.verbose_name.title() to field.verbose_name resolves this issue, but I would like to know if this can cause other unexpected issues.

It would be good to be able to provide the urls_namespace kwarg when creating a router, to easily allow more fine-grained namespacing of urls. (I can see this was considered by SmileyChris in #361 but not included in that PR).

ie. something like this:

router = Router(urls_namespace='foo')

@router.get('/')
def bar(request):
    return 'bar'

api.add_router('/foo/', router)

would result in the endpoint having a url named api-1.0.0:foo:bar.

Nested routers would need to be considered, but I think it makes sense for the url namespaces to be similarly nested:

router = Router(urls_namespace='foo')
nested_router = Router(urls_namespace='baz')

@nested_router.get('/')
def bar(request):
    return 'bar'

router.add_router('/baz/', nested_router)
api.add_router('/foo/', router)

-> api-1.0.0:foo:baz:bar

I have currently a Django API project built with DRF. I would like to use async for some endpoints to optimize long API calls. Would it be possible and interesting to migrate some endpoints to Django Ninja async ? While keeping the rest with DRF. So I would change my server from WSGI to ASGI. Maybe my understanding of async is not right and the combination of both is bad, I don't know.

Let's say I have a ninja.Schema as such:

class MySchema(ninja.Schema):
   var1: bool
   var2: str = ''

If I have an end-point that returns this schema, I get nice docs. Which I can customize based on error response:

@router.post('/test', response={200: MyResponse, 400: MyResponse})
def test(request):
   # some logic here to determine 200 vs 400
   return 200, MyResponse(var1=True)

I am trying to customize the docs to include example values that make sense. Things you would see under 200 vs. 400

I know I can probably create a class for 200's and a class for 400's, change some default values. But was wondering if there was anyway to directly change the "example-values" that show up in the automated docs? I'd prefer to keep one schema class, and then just customize the "example-value" field in the docs Thanks!

For example in FastAPI, the responses argument in the .post() method allow for such customization

responses={
        200: {
            "model": MySchema,
            "description": "customized description here",
            "content": {
                "application/json": {
                    "example": {
                        'custom key': 'custom value'
                    }
                }
            }
        },
}

I'm not sure if I'm a fan of the verbose FastAPI customization, a class would probably make more sense. I was wondering if maybe an object of the Schema could also be passed?

Something like:

response={
        200: MySchema(var1=True, var2='200 message'), 201: MySchema(var1=True, var2='201 message'), 
        400: MySchema(var1=False, var2='400 message')
    }

then allowing return values of 200/201/400 with the same schema , just varying instantiations of the schema class

A pretty glaring shortcoming is that it is impossible to reverse URLs that have been registered with same path, but different operations.

Using the same path for different operations is a pretty common pattern. It is even used throughout Ninja's documentation.

@router.get("/{identifier}")
def detail(request, identifier: str):
    return "ok"

@router.put("/{identifier}")
def update(request, identifier: str, data: Policy):
    return "ok"

The above is perfectly valid, but reversing update using django.urls.reverse() will result in a NoReverseMatch error.

This commit is an attempt at solving the issue. N.B. I am not familiar with the internals of Ninja. This is just an experiment.