NatLabRockies / NatLabRockies/api-umbrella

Validate frontend prefixes

Open
#239 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
2.2k
Forks
373
PR merge metrics
No merged PRs in 30d

Description

API Umbrella does not seem to validate frontend prefixes. This has been observed in two ways:

  • duplicate frontend prefix for separate API Backend(s)
  • overriding base prefix ( '/' route)

It may also be possible to override internal routes, such as /admin.

Feature request

Add validation to frontend prefixes, such as:

  • checking for duplicate strings (e.g. prefix collision)
  • checking for restricted strings (e.g. '/', '/admin', etc.)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No file, test, or entry point is named in the issue. Start by locating frontend-prefix handling and its existing validation tests; done means duplicate and restricted prefixes are rejected, including the '/' and '/admin' examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
api, backend-api-design
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.