agateblue / agateblue/django-dynamic-preferences

Section's verbose_name not exposed over Rest API

Open
#230 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
359
Forks
86
PR merge metrics
No merged PRs in 30d

Description

## Summary
`Section`'s `verbose_name` is missing in JSON serialized object. I would like to use this value to display human-friendly content.
### Details

Currently exposed data for a preference field
```
{
"section": "company",
"name": "companyname",
"identifier": "company__companyname",
"default": "My company",
"value": "My company",
"verbose_name": "Jméno společnosti",
"help_text": "Plné jméno společnosti, použité jako první řádek adresy",
"additional_data": {},
"field": {
"class": "CharField",
"widget": {
"class": "TextInput"
},
"input_type": "text"
}
},
```
### Fix?
Introduce a new value with key `section__verbose_name` or `section_verbose_name`. As I don't like not using nested serializer, but it's better than breaking backwards compatibility.

Are you guys interested in a pull request? I could maybe try to build a one.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.