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

Abierto Apto para principiantes
#4,355 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
Menos de una hora
Aptitud para principiantes
91/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
go

Línea de trabajo

Lee la sección "User Parameters (API Definition)" de docs/host-rewrite/v1.1/docs/host-rewrite.md y compara la descripción de los caracteres permitidos con el patrón de policies/host-rewrite/policy-definition.yaml. Actualiza la documentación para incluir los dos puntos que el esquema ya acepta. La tarea está terminada cuando la tabla de parámetros describa correctamente los caracteres aceptados en los hosts, incluidos puertos como backend.example.com:8080.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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).
Lenguaje dominante
Go
Estrellas
85
Forks
137
Merge medio
1 d 12 h
PR fusionados (30 d)
247

Preparar el entorno

  • Sin Dockerfile ni archivo de Docker Compose
  • Tiene una plantilla de pull request
  • Sin guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de wso2/api-platform

Todos los issues de wso2/api-platform

Issues similares

Más issues de Go

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.