[Bug]: host-rewrite policy documentation lists fewer allowed host characters than the policy accepts

Aperta Adatta ai principianti
#4,355 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
91/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
go
Ambito
documentation

Direzione di ricerca

Leggi la sezione "User Parameters (API Definition)" in docs/host-rewrite/v1.1/docs/host-rewrite.md e confronta la descrizione dei caratteri consentiti con il pattern in policies/host-rewrite/policy-definition.yaml. Aggiorna la documentazione per includere i due punti già accettati dallo schema. Il lavoro è completato quando la tabella dei parametri descrive correttamente i caratteri accettati negli host, incluse porte come backend.example.com:8080.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Area/Policies Aspect/Other Severity/Trivial Type/Bug
Please select the area the issue is related to

Gateway

Please select the aspect the issue is related to

Aspect/Other (Anything else which does not match above categories)

Description

The parameter table in the host-rewrite policy documentation says the host value allows letters, digits, - and .. The policy's schema also allows :.

  • Doc: docs/host-rewrite/v1.1/docs/host-rewrite.md in wso2/gateway-controllers, section "User Parameters (API Definition)": "Allowed characters: letters, digits, - and .."
  • Schema: policies/host-rewrite/policy-definition.yaml, pattern: "^[a-zA-Z0-9.:-]+$".

The doc's own Notes section says a port may be included, for example backend.example.com:8080. That needs :. The integration tests confirm a host with a port is accepted and sent upstream unchanged.

Steps to Reproduce
  1. Read the parameter table in docs/host-rewrite/v1.1/docs/host-rewrite.md.
  2. Compare it with the pattern in policies/host-rewrite/policy-definition.yaml.
  3. Deploy an API with host-rewrite host: backend.example.com:8080 and hostRewrite: manual on the upstream.
  4. The API is accepted, and the upstream receives Host: backend.example.com:8080.
Severity Level of the Issue

Severity/Trivial (Cosmetic issues. Can be fixed in future releases)

Environment Details (with versions)
  • host-rewrite policy v1.1.0, built from wso2/gateway-controllers source (commit 4f1520a8). Doc v1.1.
  • Gateway 1.1.0, 1.2.0 and main (main-a7e8774).
Lingua principale
Go
Stelle
85
Fork
137
Merge medio
1g 12h
PR unite (30g)
247

Preparare l'ambiente

  • Nessun Dockerfile né file Docker Compose
  • Ha un modello di pull request
  • Nessuna guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di wso2/api-platform

Tutte le issue di wso2/api-platform

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.