Commit35c5be6

and

authored

Add a method for getting serializer field name (OpenAPI) (#7493)

* Add a method for getting serializer field name* Add docs and testCo-authored-by: Tom Christie <tom@tomchristie.com>

1 parent0cb6937 commit35c5be6Copy full SHA for 35c5be6

File tree

+23

-2

lines changed

+23

-2

lines changed

Lines changed: 9 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -523,7 +523,7 @@ def map_serializer(self, serializer):`
`523`	`523`	`continue`
`524`	`524`
`525`	`525`	`iffield.required:`
`526`		`-required.append(field.field_name)`
	`526`	`+required.append(self.get_field_name(field))`
`527`	`527`
`528`	`528`	`schema=self.map_field(field)`
`529`	`529`	`iffield.read_only:`
`@@ -538,7 +538,7 @@ def map_serializer(self, serializer):`
`538`	`538`	`schema['description']=str(field.help_text)`
`539`	`539`	`self.map_field_validators(field,schema)`
`540`	`540`
`541`		`-properties[field.field_name]=schema`
	`541`	`+properties[self.get_field_name(field)]=schema`
`542`	`542`
`543`	`543`	`result= {`
`544`	`544`	`'type':'object',`
`@@ -589,6 +589,13 @@ def map_field_validators(self, field, schema):`
`589`	`589`	`schema['maximum']=int(digits*'9')+1`
`590`	`590`	`schema['minimum']=-schema['maximum']`
`591`	`591`
	`592`	`+defget_field_name(self,field):`
	`593`	`+"""`
	`594`	`+ Override this method if you want to change schema field name.`
	`595`	`+ For example, convert snake_case field name to camelCase.`
	`596`	`+ """`
	`597`	`+returnfield.field_name`
	`598`	`+`
`592`	`599`	`defget_paginator(self):`
`593`	`600`	`pagination_class=getattr(self.view,'pagination_class',None)`
`594`	`601`	`ifpagination_class:`

Lines changed: 14 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -111,6 +111,20 @@ class Serializer(serializers.Serializer):`
`111`	`111`	`assertdata['properties']['default_false']['default']isFalse,"default must be false"`
`112`	`112`	`assert'default'notindata['properties']['without_default'],"default must not be defined"`
`113`	`113`
	`114`	`+deftest_custom_field_name(self):`
	`115`	`+classCustomSchema(AutoSchema):`
	`116`	`+defget_field_name(self,field):`
	`117`	`+return'custom_'+field.field_name`
	`118`	`+`
	`119`	`+classSerializer(serializers.Serializer):`
	`120`	`+text_field=serializers.CharField()`
	`121`	`+`
	`122`	`+inspector=CustomSchema()`
	`123`	`+`
	`124`	`+data=inspector.map_serializer(Serializer())`
	`125`	`+assert'custom_text_field'indata['properties']`
	`126`	`+assert'text_field'notindata['properties']`
	`127`	`+`
`114`	`128`	`deftest_nullable_fields(self):`
`115`	`129`	`classModel(models.Model):`
`116`	`130`	`rw_field=models.CharField(null=True)`

Comments

(0)