map-route options documentation is wrong
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
- Área
- cli, documentation
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=1to 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:
- Run
cf map-route <YOUR_APP> <YOUR_DOMAIN> --destination-protocol http2 - See error
Provide more context
- Same error on this documentation page
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
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de cloudfoundry/cli
-
Dificultad 4/5 3-5 días Aptitud para principiantes 52/100
cloudfoundry/cli#3866 ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
cloudfoundry/cli#3863 · 2 comentarios ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 45/100
cloudfoundry/cli#3851 · 1 comentario · 1 reacción ·
-
Add zsh shell completion Abierto
Dificultad 3/5 1-2 días Aptitud para principiantes 62/100
cloudfoundry/cli#3794 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 48/100
cloudfoundry/cli#3787 · 1 comentario ·
Todos los issues de cloudfoundry/cli
Issues similares
-
nix: vendorHash is outdated Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
-
Bob Shell support Abiertoenhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
santhosh-tekuri/jsonschema#276 ·