manosim / manosim/django-rest-framework-docs
Add permissions
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 641
- Forks
- 178
- PR merge metrics
- No merged PRs in 30d
Description
It would be great if we could hide the API behind a login that only allows superusers to login. I'm up for creating a PR. This functionality could be enabled via the settings:
```python
REST_FRAMEWORK_DOCS = {
'PERMISSIONS_REQUIRED': True # Set the default to True perhaps?
}
```
What do you think?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing how the REST_FRAMEWORK_DOCS settings are defined and how the API currently handles access. Determine the intended login and superuser rules, including the default for PERMISSIONS_REQUIRED. The work is done when the behavior is implemented, documented, and covered by tests for allowed and denied users.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- django, python
- Domain
- authentication, authorization
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100