badges / badges/shields

Deprecate route `format`, replacing with `pattern`

Open
#3,329 4 comments 0 reactions 0 assignees View on GitHub
core service-badge
Dominant language
JavaScript
Stars
27.2k
Forks
5.6k
Avg merge
1d 8h
Merged PRs (30d)
46

Description

To make the code easier to understand and to support trie-based routing for #3328, it would be helpful to replace the several remaining instances of route `format`s with `patterns`.

Many of the remaining `format`s are designed to support aliases, and since we've started using redirects heavily, the likely solution is to rewrite the canonical form using a pattern, and add redirects for each of the alias forms.

Ideally by using multiple redirects we can rewrite everything using patterns.

Contributor guide

Open the contributing guide

Research direction

Start by locating the remaining route definitions that use format and inspect how their aliases and canonical forms are represented. The work is done when canonical routes use patterns and each supported alias is handled through redirects, while preserving existing routing behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
backend-api-design
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 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.