nginx / nginx/documentation

[Bug]: nginx-gateway-fabric supported HttpRoute path type

Open Beginner friendly
#2,141 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
94
Forks
174
Avg merge
1d 10h
Merged PRs (30d)
66

Description

There are three path types in gateway-api spec: Exact/PathPrefix/RegularExpression(https://gateway-api.sigs.k8s.io/reference/api-spec/main/spec/#pathmatchtype)

In https://docs.nginx.com/nginx-gateway-fabric/overview/gateway-api-compatibility/#httproute, it only supports two of them.

path: Partially supported. Only PathPrefix and Exact types.

But from ngf release note seems RegularExpression is supported also, is it a document issue?
https://github.com/nginx/nginx-gateway-fabric/releases?page=2#release-v2.2.0

Add regex for path matching by @fabian4 in https://github.com/nginx/nginx-gateway-fabric/pull/3874

Which product or products does this problem relate to?

NGINX Gateway Fabric

Contributor guide

Open the contributing guide

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

Start with the NGINX Gateway Fabric HTTPRoute compatibility page and compare its path-type statement with the Gateway API specification and the v2.2.0 release note linked in the issue. Done means the documentation accurately describes whether RegularExpression, alongside Exact and PathPrefix, is supported.

Written by the indexing model from the issue text.

Assessment

Tech stack
kubernetes
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.