swagger-api / swagger-api/swagger-ui
Django Apis with permission_classe are not shown
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
All the apis that requires with a permission class are now shown.
Why do we cannot show these api for documentation purposes and instead requires that
user to be authenticate and return a 403 during if the api is tested without authentication.
Once committed, these are shown.
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
Reproduce the issue with a Django API endpoint that uses a permission class and inspect how Swagger UI discovers and displays that endpoint. Done means the secured API appears in the documentation while an unauthenticated test request still returns 403.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- django, javascript
- Domain
- documentation, frontend
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100