bluehalo / bluehalo/node-rest-starter

Support Admin-only Swagger Docs

Open
#115 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
13
Forks
10
PR merge metrics
No merged PRs in 30d

Description

We have some API endpoints that are only for Admin users. It would be nice to be able to hide the Swagger docs of those endpoints from non-Admin users. This came up along with some potential solutions in this discussion (https://github.com/Asymmetrik/node-rest-starter/pull/114#discussion_r598895869).

**Acceptance Criteria**
- Determine if filtering by tags, extending/customizing the Swagger UI, or some other option is a viable solution
- If so, make necessary updates enable hiding admin-only endpoints from non-admin users
- If not feasible/reasonable/possible, mention why and close issue.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading the linked pull-request discussion about filtering by tags and customizing Swagger UI, then inspect the repository's Swagger integration. Determine whether admin-only endpoints can be hidden from non-Admin users without weakening access controls. Done means implementing a viable approach or documenting why it is not feasible and closing the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
node.js, openapi, typescript
Domain
api, authorization
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.