Skip to content

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

Description

@Piumal1999

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Aspect/APIAPI definitions, contracts, OpenAPI, interfacesAspect/ConfigurationConfig files, settings, env vars, defaultsAspect/UIFrontend, visual layouts, components, stylingAspect/UXUser experience, flows, usability, clarity

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions