Incorrect Javadoc comment in HttpTrigger.java

Open

#131 opened on Sep 28, 2020 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty: 1/5
Estimated time: Under an hour
Newbie friendliness: 45/100

Issue type: Documentation
Clarity: Clearly specified
Activity status: Stale
Tech stack: java
Domain: documentation

Research direction

Open src/main/java/com/microsoft/azure/functions/annotation/HttpTrigger.java around line 140 and compare the Javadoc example with the linked route documentation. Correct the sample's return type so it matches the stated method type, then verify that the Javadoc example no longer contains the reported compile error.

Written by the indexing model from the issue text.

Description

area:java-functions

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

Dominant language: Java
Stars: 45
Forks: 49
PR merge metrics: No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

Read the whole issue, then the project's contributing guide.
Comment on the issue to say you are picking it up — it saves two people doing the same work.
Fork the repository and make your change on a branch.
Open a pull request that references the issue number.

Similar issues

Dockerfile does not build the jar - renders Docker image non-functional Open

Difficulty 2/5 1-3 hours Newbie friendliness 85/100

HL7/fhir-ig-publisher#1375 · Opened Sep 25, 2026
Pin MCP package references to make reviewed configs reproducible Open

Difficulty 2/5 1-3 hours Newbie friendliness 74/100

dotCMS/core#37738 · Opened Sep 25, 2026
Flaky: a relaunched catch-up replay can still report catching up right after its marker is written Open

bug

Difficulty 2/5 1-3 hours Newbie friendliness 78/100

johanhaleby/occurrent#1134 · Opened Sep 25, 2026
A `native` method with instructions gets a `Code` attribute the JVM rejects Open

bug

Difficulty 2/5 1-3 hours Newbie friendliness 78/100

objectionary/jeo-maven-plugin#1811 · Opened Sep 25, 2026
[ICP] icp.sh ignores a user-set JAVA_OPTS, so JVM options such as heap size cannot be set Open

Difficulty 2/5 1-3 hours Newbie friendliness 88/100

wso2/integration-control-plane#930 · Opened Sep 25, 2026

More Java issues