Azure / Azure/azure-functions-java-library

Incorrect Javadoc comment in HttpTrigger.java

Abierto
#131 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

area:java-functions
Lenguaje dominante
Java
Estrellas
45
Forks
49
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

The following Javadoc describes the HttpTriger route method, but the sample described is incorrect and causes a compile error.

https://docs.microsoft.com/en-us/java/api/com.microsoft.azure.functions.annotation.httptrigger.route?view=azure-java-stable#com_microsoft_azure_functions_annotation_HttpTrigger_route__

The correct method type is HttpResponseMessage, not HttpResponseMessage<String>.

@FunctionName("routeTest")
  public HttpResponseMessage<String> routeTest(
      @HttpTrigger(name = "req",
                    methods = {HttpMethod.GET},
                    authLevel = AuthorizationLevel.ANONYMOUS,
                    route = "products/{category:alpha}/{id:int}") 
                    HttpRequestMessage<Optional<String>> request,
      @BindingName("category") String category,
      @BindingName("id") int id,
       final ExecutionContext context
  ) {
           ....
           context.getLogger().info("We have " + category + " with id " + id);
           ....
  }

This Javadoc is probably auto-generated from the following link.
Please fix it.

https://github.com/Azure/azure-functions-java-library/blob/dev/src/main/java/com/microsoft/azure/functions/annotation/HttpTrigger.java#L140

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

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.

Línea de trabajo

Abre src/main/java/com/microsoft/azure/functions/annotation/HttpTrigger.java cerca de la línea 140 y compara el ejemplo de Javadoc con la documentación de rutas enlazada. Corrige el tipo de retorno del ejemplo para que coincida con el tipo de método indicado y, después, verifica que el ejemplo de Javadoc ya no contenga el error de compilación informado.

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

Evaluación

Stack tecnológico
java
Área
documentation
Tipo de issue
Documentación
Dificultad
1/5
Tiempo estimado
Menos de una hora
Estado de actividad
Estancado
Claridad
Bien especificado
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.