[Bug]: [Policy Hub] In-page anchor links in policy docs go to the Policy Hub home page instead of the section

Aperta
#4,372 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
75/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
html, typescript
Ambito
frontend

Direzione di ricerca

Start with frontend/index.html, MarkdownRenderer.tsx, and TableOfContents.tsx, which the issue identifies as the sources of the two failures. Trace how fragment links are resolved with the base URL and when policy headings receive IDs after docs load. Reproduce using the llm-cost policy link, then verify both clicking an in-page link and opening a policy URL with a fragment land on the section.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Aspect/API Aspect/UX Severity/Minor Type/Bug
Please select the area the issue is related to

Gateway

Please select the aspect the issue is related to

Aspect/API (API backends, definitions, contracts, interfaces, OpenAPI), Aspect/UX (User experience, flows, usability, clarity)

Description

In-page anchor links in policy docs, such as [Adding Your Own Pricing](#adding-your-own-pricing), don't work on the Policy Hub. Clicking one loads the hub's home page instead of jumping to the section. The links are standard markdown and work on GitHub.

There are two causes, both in the frontend:

  1. <base> redirects fragment links. frontend/index.html (lines 11–25) injects <base href="/api-management/policy-hub/">. With a <base> element, the browser resolves every relative URL against the base URL, fragment-only links included. So #adding-your-own-pricing becomes /api-management/policy-hub/#adding-your-own-pricing, which is the hub root. MarkdownRenderer.tsx passes these links through unchanged, because its urlTransform (line 193) only rewrites URLs that start with ..
  2. Sections can't be linked to directly. Opening /policies/<name>#<section> leaves the page at the top. Docs are fetched after the page has loaded, and headings only get ids afterwards, when TableOfContents.tsx tags them (lines 54–59, h2/h3 only). When the browser tries to jump to the fragment, the heading doesn't exist yet.

Impact:
21 of the 72 policies on the hub have these links in their latest published version, 71 links in total:

mtls-auth (14), typesafe-jev-mcp-tool-intent-verification (7), opa-policy (6), typesafe-jev-mcp-tool-result-screening (6), typesafe-jev-tool-filtering (5), aws-authentication (4), jwt-auth (4), semantic-cache (4), typesafe-jev-content-safety (4), oauth2-generator (3), backend-jwt (2), mcp-authz (2), mcp-tool-schema-validator (2), error-response-formatter (1), llm-cost (1), llm-cost-based-ratelimit (1), log-message (1), mcp-auth (1), oauth2-token-exchange (1), opaque-token-auth (1), typesafe-jev-model-routing (1).

16 of these 21 also have older versions with the same links.

Steps to Reproduce
  1. Open https://choreolabs.com/api-management/policy-hub/policies/llm-cost.
  2. In the Notes section, click Adding Your Own Pricing.
  3. Expected: the page scrolls to the "Adding Your Own Pricing" section.
    Actual: the browser loads https://choreolabs.com/api-management/policy-hub/#adding-your-own-pricing, the hub's home page.
  4. Open https://choreolabs.com/api-management/policy-hub/policies/llm-cost#adding-your-own-pricing directly.
    Expected: the page opens at that section.
    Actual: the page stays at the top.

The same happens with any in-page link on the policies above, for example the 14 links on https://choreolabs.com/api-management/policy-hub/policies/mtls-auth.

Severity Level of the Issue

Severity/Minor (Non-critical functionality. Can be fixed in future releases)

Environment Details (with versions)
Lingua principale
Go
Stelle
85
Fork
137
Merge medio
1g 12h
PR unite (30g)
247

Preparare l'ambiente

  • Nessun Dockerfile né file Docker Compose
  • Ha un modello di pull request
  • Nessuna guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di wso2/api-platform

Tutte le issue di wso2/api-platform

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.