influxdata / influxdata/influxdb

Api doc page still can be accessed when the ui is disabled

Open
#24,587 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
31.7k
Forks
3.7k
Avg merge
13h 37m
Merged PRs (30d)
8

Description

__Steps to reproduce:__
List the minimal actions needed to reproduce the behaviour.

1. set ui-disabled: true
2. restart influxdb
3. access http://x.x.x.x:8086/docs. The api doc page still can be accessed.

__Expected behaviour:__
When the ui is diabled, the api doc page should be disabled too.

__Actual behaviour:__
The api doc page still can be accessed.

__Environment info:__

* Use release package https://dl.influxdata.com/influxdb/releases/influxdb2-2.7.5_darwin_amd64.tar.gz
* Linux 3.10.0-1160.88.1.el7.x86_64 x86_64

__Config:__
ui-disabled: true

__Logs:__

Contributor guide

Open the contributing guide

Research direction

Reproduce the issue by setting `ui-disabled: true`, restarting InfluxDB, and requesting `http://x.x.x.x:8086/docs`. Trace the handler for the `/docs` endpoint and the `ui-disabled` configuration, then verify that the API documentation is inaccessible when the UI is disabled.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
api, documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.