Skip to content

Feature request - optionally expose excluded routes. #751

@willvincent

Description

@willvincent

Feature request 🎁

The ExcludeRouteFromDocs and ExcludeAllRoutesFromDocs attributes are super handy to completely exclude routes, but it would be really useful to be able to flag routes as private or internal, and optionally be able to include those if rendering docs for a user with appropriate permissions. Even if this were only available as an option on the artisan scramble:export command.

Maybe the simplest option is to add an optional flag to the export command that ignores the exclude attributes?

Reasoning

There are often times where only a portion of the API is intended for public or third party consumption, but it would be beneficial to maintain api documentation for the internal team who has access to everything. ie: a frontend team integrating with a backend api when building out a SPA or mobile app that is not directly served by the backend code (as is my case).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions