aws / aws/graph-explorer

Add a note to the UI about final database URL

Open
#1,478 0 comments 1 reaction 0 assignees View on GitHub
usability
Dominant language
TypeScript
Stars
481
Forks
108
Avg merge
7d 16h
Merged PRs (30d)
8

Description

All database URLs will have a path appended to the user provided URL. This is not obvious to the user in the UI. This can lead to the user incorrectly adding the path themselves.

- Gremlin - `{database-url}/gremlin`
- openCypher - `{database-url}/opencypher`
- SPARQL - `{database-url}/sparql`

## Potential Solution

We should add a note in the UI that shows what the final URL will be with the path appended. This should be in a `FieldDescription` below the input field. Something like

> The URL that will be used is `https://my-database.com:8182/sparql`

## Related issues

- #23
- #1326

Contributor guide

Open the contributing guide

Research direction

Locate the database URL input in the UI and inspect how its FieldDescription is rendered. Add a note showing the final URL with the appropriate /gremlin, /opencypher, or /sparql path appended, then verify the displayed examples for each database type.

Written by the indexing model from the issue text.

Assessment

Tech stack
react, typescript
Domain
databases, frontend
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.