manosim / manosim/django-rest-framework-docs
doesn't support read_only_fields in serializer
Open
- Dominant language
- Python
- Stars
- 641
- Forks
- 178
- PR merge metrics
- No merged PRs in 30d
Description
I have serializer and Django rest docs doesn't understand read_only_fields
for example:
```
class SampleSerializer(serializers.ModelSerializer):
class Meta:
model = Wallet
fields = ('id', 'name', 'owner')
read_only_fields = ('id','owner')
```
Contributor guide
Research direction
The issue names no source file or test. Start by reproducing the SampleSerializer example and tracing how serializer metadata is converted into Django REST Framework documentation; done means the generated documentation recognizes id and owner from read_only_fields as read-only.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- django, python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100