Add handling of the annotation @PermissionsAllowed on methods or class for OpenAPI

[PierreAdam]

Closes #39227

Add support for annotation @PermissionsAllowed on the generated openapi file.

For a method declared as followed :

    @GET
    @Path("/test")
    @PermissionsAllowed("secure:read")
    public String endpoint() {
        return "secure";
    }

The result is

  /test:
    get:
      ...
      responses:
        "200":
          description: OK
          content:
            text/plain:
              schema:
                type: string
        "403":
          description: Not Allowed
        "401":
          description: Not Authorized
      security:
      - SecurityScheme: []

Please note that the content of SecurityScheme is empty. This is done on purpose to avoid mixing openapi scopes with the internal application permission.

If you desire the openapi file to reflect the proper scope, I would recommend doing the following.

@ApplicationScoped
@RolesAllowed("my-scope")
public class MyController {
    @GET
    @Path("/test")
    @PermissionsAllowed("secure:read")
    public String endpoint() {
        return "secure";
    }
}

Adding a @RoleAllowed on the class itself allows to set a scope in the openapi definition and the result is as follow

  /test:
    get:
      ...
      responses:
        "200":
          description: OK
          content:
            text/plain:
              schema:
                type: string
        "403":
          description: Not Allowed
        "401":
          description: Not Authorized
      security:
      - SecurityScheme:
        - my-scope

[quarkus-bot]

Thanks for your pull request!

The title of your pull request does not follow our editorial rules. Could you have a look?

• title should not end up with dot

_{This message is automatically generated by a bot.}

[phillip-kruger]

Please squash the commits into 1

[PierreAdam]

Please squash the commits into 1

Done 😃

[quarkus-bot]

Status for workflow Quarkus CI

This is the status report for running Quarkus CI on commit d7d2e08.

✅ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.

You can consult the Develocity build scans.

[phillip-kruger]

LGTM