[Bug]: API Portal settings drop the chosen view from the address

Open Beginner friendly
#4,369 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
88/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
javascript
Domain
frontend

Research direction

Start in portals/api-portal/src/scripts/settings-nav.js and inspect activate(), where history.replaceState rebuilds the settings URL. Keep the selected view query string when updating the panel hash. Verify by choosing a non-default view in Theming, then reloading or opening the copied URL and confirming that view remains selected.

Written by the indexing model from the issue text.

Description

Area/DeveloperPortal Aspect/UI Severity/Minor Type/Bug
Please select the area the issue is related to

DeveloperPortal

Please select the aspect the issue is related to

Aspect/UI (Admin portal, developer portal, AI workspace UI)

Description

On the API Portal settings page, choosing a view in a view-scoped panel (Theming, LLM Instructions, API Workflows) loads …/settings?view=<view>#<panel>, but the page then removes ?view=<view> from the address bar. Reloading the page, or opening the copied link, shows the panel for the default view instead of the chosen one.

Cause

On load, activate() in portals/api-portal/src/scripts/settings-nav.js records the open panel with:

history.replaceState(null, '', location.pathname + '#' + id);

It rebuilds the address from the path and the hash only, so the query string, which carries the view, is dropped.

Observed (Playwright trace of the UI suite's theming journey, https://github.com/wso2/api-platform/actions/runs/44452694997/job/135322505050)

  • Choosing view theme_view_grzjk2ft_6 navigated to https://api-portal:9543/api-portal/default/settings?view=theme_view_grzjk2ft_6#cfg-theming.
  • The page then showed that view's settings, with the address https://api-portal:9543/api-portal/default/settings#cfg-theming.

Expected

The address keeps ?view=<view>, so reloading or sharing the page keeps the chosen view. For example, history.replaceState(null, '', location.pathname + location.search + '#' + id).

Steps to Reproduce
  1. In an organization with more than one view, open API Portal Settings → Theming.
  2. Choose a view other than the first in the view selector. The page reloads showing that view.
  3. Look at the address bar: ?view= is gone.
  4. Reload the page: the panel shows the default view again.
Severity Level of the Issue

Severity/Minor (Minor functionality is broken. Doesn't need immediate attention)

Environment Details (with versions)

Current main. API Portal built from source and run by the UI suite (tests/framework) in GitHub Actions.

Dominant language
Go
Stars
85
Forks
137
Avg merge
1d 12h
Merged PRs (30d)
247

Getting set up

  • No Dockerfile or Docker Compose file
  • Has a pull request template
  • No contributing guide

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.

More from wso2/api-platform

All issues in wso2/api-platform

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.