2
0
mirror of https://github.com/inventree/InvenTree.git synced 2026-07-04 06:00:38 +00:00

Fix OpenAPI multipart file fields to use binary format (#12298)

* Fix OpenAPI multipart file fields to use binary format

Fixes #11246

* Update API version

* fix api version

---------

Co-authored-by: Matthias Mair <code@mjmair.com>
This commit is contained in:
Miklós Márton
2026-07-03 23:58:53 +02:00
committed by GitHub
parent f93c813bb4
commit 5df2adae6d
3 changed files with 49 additions and 1 deletions
@@ -1,11 +1,14 @@
"""InvenTree API version information.""" """InvenTree API version information."""
# InvenTree API version # InvenTree API version
INVENTREE_API_VERSION = 514 INVENTREE_API_VERSION = 515
"""Increment this API version number whenever there is a significant change to the API that any clients need to know about.""" """Increment this API version number whenever there is a significant change to the API that any clients need to know about."""
INVENTREE_API_TEXT = """ INVENTREE_API_TEXT = """
v515 -> 2026-07-03 : https://github.com/inventree/InvenTree/pull/12298
- Change the file fields definition to binary (from uri) in the upload requests
v514 -> 2026-07-02 : https://github.com/inventree/InvenTree/pull/12294 v514 -> 2026-07-02 : https://github.com/inventree/InvenTree/pull/12294
- Adds "duplicate" field to the BuildOrder, Company, ManufacturerPart, SupplierPart and SalesOrderShipment API endpoints - Adds "duplicate" field to the BuildOrder, Company, ManufacturerPart, SupplierPart and SalesOrderShipment API endpoints
- Order duplication options: renames "order_id" field to "original", which now performs primary-key validation - Order duplication options: renames "order_id" field to "original", which now performs primary-key validation
+15
View File
@@ -16,6 +16,7 @@ from drf_spectacular.utils import (
extend_schema, extend_schema,
extend_schema_view, extend_schema_view,
) )
from rest_framework import serializers
from rest_framework.pagination import LimitOffsetPagination from rest_framework.pagination import LimitOffsetPagination
from InvenTree.permissions import OASTokenMixin from InvenTree.permissions import OASTokenMixin
@@ -46,6 +47,20 @@ class ExtendedOAuth2Scheme(DjangoOAuthToolkitScheme):
class ExtendedAutoSchema(AutoSchema): class ExtendedAutoSchema(AutoSchema):
"""Extend drf-spectacular to allow customizing the schema to match the actual API behavior.""" """Extend drf-spectacular to allow customizing the schema to match the actual API behavior."""
def _map_serializer_field(self, field, direction, *args, **kwargs):
"""Custom field mapping overrides, falling back to default behavior."""
schema = super()._map_serializer_field(field, direction, *args, **kwargs)
direction_value = getattr(direction, 'value', direction)
# File and image fields in request schemas must be represented as binary
# payloads. In response schemas they are still rendered as URLs.
if direction_value == 'request' and isinstance(field, serializers.FileField):
schema['type'] = 'string'
schema['format'] = 'binary'
return schema
def is_bulk_action(self, ref: str) -> bool: def is_bulk_action(self, ref: str) -> bool:
"""Check the class of the current view for the bulk mixins.""" """Check the class of the current view for the bulk mixins."""
return ref in [c.__name__ for c in type(self.view).__mro__] return ref in [c.__name__ for c in type(self.view).__mro__]
+30
View File
@@ -22,6 +22,7 @@ from djmoney.contrib.exchange.exceptions import MissingRate
from djmoney.contrib.exchange.models import Rate, convert_money from djmoney.contrib.exchange.models import Rate, convert_money
from djmoney.money import Money from djmoney.money import Money
from maintenance_mode.core import get_maintenance_mode, set_maintenance_mode from maintenance_mode.core import get_maintenance_mode, set_maintenance_mode
from rest_framework import serializers
from sesame.utils import get_user from sesame.utils import get_user
from stdimage.models import StdImageFieldFile from stdimage.models import StdImageFieldFile
@@ -1817,6 +1818,35 @@ class SchemaPostprocessingTest(TestCase):
# required key removed when empty # required key removed when empty
self.assertNotIn('required', schemas_out.get('SalesOrderShipment')) self.assertNotIn('required', schemas_out.get('SalesOrderShipment'))
def test_file_field_request_schema_binary(self):
"""Verify only request file fields are exposed as binary."""
auto_schema = object.__new__(schema.ExtendedAutoSchema)
mapped_schemas = [
{'type': 'string', 'format': 'uri', 'nullable': True},
{'type': 'string', 'format': 'uri'},
{'type': 'string', 'format': 'uri', 'nullable': True},
]
with mock.patch(
'drf_spectacular.openapi.AutoSchema._map_serializer_field',
side_effect=mapped_schemas,
):
file_request = auto_schema._map_serializer_field(
serializers.FileField(allow_null=True), 'request'
)
url_request = auto_schema._map_serializer_field(
serializers.URLField(), 'request'
)
file_response = auto_schema._map_serializer_field(
serializers.FileField(allow_null=True), 'response'
)
self.assertEqual(file_request['format'], 'binary')
self.assertTrue(file_request['nullable'])
self.assertEqual(url_request['format'], 'uri')
self.assertEqual(file_response['format'], 'uri')
class URLCompatibilityTest(InvenTreeTestCase): class URLCompatibilityTest(InvenTreeTestCase):
"""Unit test for legacy URL compatibility.""" """Unit test for legacy URL compatibility."""