NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-12-09 01:49:35 -06:00
Code Issues Actions 12 Packages Projects Releases Wiki Activity

docs(api): Correct IntegerRangeSerializer schema definition

Browse Source 
Adjusts the schema mapping for `IntegerRangeSerializer` by setting
`match_subclasses` to `True` and refining the array definition. Adds
an example field for clarity in generated OpenAPI documentation.

Fixes #20494
This commit is contained in:
Martin Hauser 2025-10-03 17:31:53 +02:00 committed by Jeremy Stretch
parent f5ed095738
commit 99e367cbaf
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
netbox/core/api/schema.py
View File

@ -282,18 +282,18 @@ class FixSerializedPKRelatedField(OpenApiSerializerFieldExtension):
class FixIntegerRangeSerializerSchema(OpenApiSerializerExtension): class FixIntegerRangeSerializerSchema(OpenApiSerializerExtension):
target_class = 'netbox.api.fields.IntegerRangeSerializer' target_class = 'netbox.api.fields.IntegerRangeSerializer'
match_subclasses = True
def map_serializer(self, auto_schema: 'AutoSchema', direction: Direction) -> _SchemaType: def map_serializer(self, auto_schema: 'AutoSchema', direction: Direction) -> _SchemaType:
# One range = two integers; many=True will wrap this in an outer array
return { return {
'type': 'array', 'type': 'array',
'items': { 'items': {
'type': 'array', 'type': 'integer',
'items': {
'type': 'integer',
},
'minItems': 2,
'maxItems': 2,
}, },
'minItems': 2,
'maxItems': 2,
'example': [10, 20],
} }