@Operation annotation with routes throwing errors

[coreagile]

We have code that looks something like:

path("/api", this::internalApiRoutes);

And a method that looks like:

private void internalApiRoutes() {
    post("/getThing", App::getThing);
  }

And the final route:

@Operation(
      summary = "Get a thing",
      parameters =
          @Parameter(
              name = "x-api-key",
              description = "API Key",
              in = ParameterIn.HEADER,
              schema = @Schema(type = "string"),
              required = true))
  private static String getThing(Context context) {
     /* ... */
  }

But when we try to compile the project, we get:

[ERROR] Failed to execute goal io.jooby:jooby-maven-plugin:4.0.15:openapi (default) 
on project crunchtime-suite-api: execution of openapi resulted in exception: Parameter 
not found: x-api-key at  position: 0 for annotation: {name=x-api-key, description=API Key, 
in=[Ljava.lang.String;@43cd2f26, schema=org.objectweb.asm.tree.AnnotationNode@7d043960, 
required=true} -> [Help 1]

Am I missing something? I thought we could use @Operation just to generate JavaDoc on these kinds of routes.

Thanks!

[jknack]

It is a validation rule, you need to read the parameter from context:

private static String getThing(Context context) {
    // read param you defined in annotation
    var apiKey = context.header("x-api-key").value();
    System.out.println(apiKey);
    return "works!";
}

[coreagile]

That seems bizarre. We have our own internal validations that check if we even need to read the header (for example, if the body is empty there's no need). Is there a way to turn off this validation?

[jknack]

don't think it is bizarre, but yea we can probably relax the check. Can you file a bug? We should add any "extra" parameter definition that comes from swagger/open-api annotation.

[coreagile]

It's fine. We'll work with it as written. :-)