wso2 / wso2/api-platform

[Feature][API Portal]: Role-based API Visibility for API Portal

Open
#3,274 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Aspect/API Aspect/Configuration Aspect/UI Aspect/UX
Dominant language
Go
Stars
71
Forks
111
Avg merge
1d 14h
Merged PRs (30d)
110

Description

Please select the area the issue is related to

Developer Portal

Please select the aspect the issue is related to

Aspect/API (API backends, definitions, contracts, interfaces, OpenAPI), Aspect/UI (Frontend layouts, components, styling), Aspect/Configuration (Config files, settings, env vars, defaults), Aspect/UX (User experience, flows, usability, clarity)

Suggested Feature

Currently in API portal, all the published APIs are visible to any user. Therefore we need to introduce role based visibility feature.

Basically an API can be visible to all user or visible only to a selected set of roles.

Related Issues

No response

Steps to Verify
  • Design Document — A detailed design document has been created and reviewed, covering architecture, data flow, and edge cases.
  • Design Mail — A design summary email has been sent to relevant stakeholders for awareness and feedback.
  • Code Review — All code changes have been peer-reviewed and approved according to the project's review standards.
  • Testing Complete — Adequate unit, integration, and/or end-to-end tests have been written and are passing.
  • Documentation Review — User-facing and/or developer documentation has been updated to reflect the new feature and reviewed.
  • Feature Complete — The feature is fully implemented, all checklist items above are done, and it is ready for release.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Developer Portal scope and the API aspect described in the issue; no implementation files, tests, or entry points are named. First produce and review the required design covering visibility rules, role selection, architecture, data flow, and edge cases, then define completion through the listed testing, documentation, review, and release checks.

Written by the indexing model from the issue text.

Assessment

Domain
api, authorization
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.