Graylog2 / Graylog2/graylog2-server

API Browser links with anchor don't jump to corresponding section

Open
#16,244 0 comments 0 reactions 0 assignees View on GitHub
bug triaged
Dominant language
Java
Stars
8.1k
Forks
1.1k
Avg merge
1d 20h
Merged PRs (30d)
217

Description

## Expected Behavior

Clicking sections in the API browser (e.g. `System/ClusterTraffic : Cluster traffic stats`) results in URLs with an anchor (e.g. `/api/api-browser/global/index.html#!/System/ClusterTraffic`). These URLs should be usable as-is, letting users jump directly to the associated section.

## Current Behavior

The anchors in API Browser links have no noticeable impact-- you just stay where you're at in the page (or at the top if newly loading the page).

## Possible Solution

* Fix the section anchor's `href` attribute so it points to valid IDs
* (not preferred) Don't use, or block use of (`return false`), anchors (so they at least don't show up in the browser history as options)

## Steps to Reproduce (for bugs)

1. Go to either the global or node-level API browser
2. Scroll to the bottom of the page and click a section header to expand it
3. Note and copy the anchor added to the URL
5. Open another tab and navigate to the aforementioned URL
6. Note you remain at the top of the page, and the associated section (when scrolled to) is still collapsed

## Context

I periodically use the API Browser to quickly check some things (e.g. actual cluster traffic numbers), and see the anchored URLs suggested. It would be useful to be able to jump directly to the section I'm interested in.

Obviously, this isn't super critical :)

## Your Environment

* Graylog Version: 5.1.4
* Browser version: Firefox 116, Chrome 116

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.