blenderskool/diode

Enrich proxy URL with more context

Open

#7 opened on Jan 5, 2022

View on GitHub
 (5 comments) (0 reactions) (1 assignee)TypeScript (4 forks)github user discovery
enhancementgood first issue

Repository metrics

Stars
 (48 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Proxy URLs generated in Diode right now are not human-readable and don't have any context about what the API endpoint actually does. This can be improved by updating the proxy URL id to include the route name entered by the user.

Example: {route-name encoded in a URL friendly way}-{nanoid of a shorter length} In this case, the route name cannot be changed once it's created.

Contributor guide

Research direction
Examine the current proxy URL generation logic in the codebase. Implement a change to include the route name encoded in a URL friendly way along with a shorter nanoid. Ensure the route name is immutable after creation.
Tech stack
typescript
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70