manosim / manosim/django-rest-framework-docs

Exclude internal API

Open
#129 2 comments 1 reaction 0 assignees View on GitHub
Dominant language
Python
Stars
641
Forks
178
PR merge metrics
No merged PRs in 30d

Description

I don't see any possibility to exclude some views from docs. Is this feature implemented ?

Problem: I have internal API which is in 'internal' namespace and external one in 'api'. I would like to show only endpoints from external API.

Documentation does not say anything about it and I don't see place in code where I could filter or exclude endpoints by namespace or by app.

Contributor guide

Open the contributing guide

Research direction

No files or tests are named in the issue; start by searching the documentation and code for endpoint discovery and filtering. Define how endpoints in the `api` namespace should be included while those in `internal` are excluded, then verify the generated documentation reflects that behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
django, python
Domain
api, backend, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.