Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

map-route options documentation is wrong

Abierto
#3,606 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
35/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
go

Línea de trabajo

Comienza con la página de documentación de map-route y la página de documentación de supporting-http2 enlazadas en el issue; después, compara sus nombres de flags con la salida de ayuda de cf map-route que se muestra aquí. Actualiza la opción documentada para que coincida con la CLI y verifica que ambas páginas describan el mismo comando y el mismo comportamiento de HTTP/2.

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

Descripción

  • I reviewed open and closed github issues that may be related to my problem.
  • I tried updating to the latest version of the CF CLI to see if it fixed my problem.
  • I attempted to run the command with CF_TRACE=1 to help debug the issue.
  • I am reporting a bug that others will be able to reproduce.

Describe the bug and the command you saw an issue with
I wanted to set a route using cf map-routewith HTTP/2 enabled like it is described in the documentation.

What happened
An error occurred Incorrect Usage: unknown flag destination-protocol'. The help command for map-route` gave me those instructions:

NAME:
   map-route - Map a route to an app

USAGE:
   Map an HTTP route:
      cf map-route APP_NAME DOMAIN [--hostname HOSTNAME] [--path PATH] [--app-protocol PROTOCOL] [--option OPTION=VALUE]
   
   Map a TCP route:
      cf map-route APP_NAME DOMAIN [--port PORT] [--option OPTION=VALUE]

EXAMPLES:
   cf map-route my-app example.com                                                      # example.com
   cf map-route my-app example.com --hostname myhost                                    # myhost.example.com
   cf map-route my-app example.com --hostname myhost -o loadbalancing=least-connection  # myhost.example.com with a per-route option
   cf map-route my-app example.com --hostname myhost --path foo                         # myhost.example.com/foo
   cf map-route my-app example.com --hostname myhost --app-protocol http2               # myhost.example.com
   cf map-route my-app example.com --port 5000                                          # example.com:5000

OPTIONS:
   --hostname, -n      Hostname for the HTTP route (required for shared domains)
   --path              Path for the HTTP route
   --port              Port for the TCP route (default: random port)
   --app-protocol      [Beta flag, subject to change] Protocol for the route destination (default: http1). Only applied to HTTP routes
   --option, -o        Set the value of a per-route option

SEE ALSO:
   create-route, routes, unmap-route, update-route

I then tried using app-protocol instead which fixed the problem so no current blocker.

Expected behavior
I expect the cli help and the documentation to be aligned and that the description in the documentation is correct. Please correct the documentation.

Exact Steps To Reproduce
Steps to reproduce the behavior; include the exact CLI commands and verbose output:

  1. Run cf map-route <YOUR_APP> <YOUR_DOMAIN> --destination-protocol http2
  2. See error

Provide more context

Notes regarding V6 and V7 CLI support:

  • V6:
    • Minimum supported version of CF Deployment: v7.0.0 (CAPI Release: 1.74.0 (APIs 2.128.0 and 3.63.0))
    • Maximum supported version of CF Deployment: v13.4.0 (CAPI Release: 1.94.0 (APIs 2.149.0 and 3.84.0))
  • V7:
    • Minimum supported version of CF Deployment: v13.5.0 (CAPI Release: 1.95.0 (APIs 2.150.0 and 3.85.0))
Lenguaje dominante
Go
Estrellas
1.9k
Forks
990
Merge medio
1 d 7 h
PR fusionados (30 d)
8

Guía de contribución

Abrir la 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 cloudfoundry/cli

Todos los issues de cloudfoundry/cli

Issues similares

Más issues de Go

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.