global responses not getting applied to individual resource endpoints during openapi specification generation

[shreeram09]

I am trying to apply responses globally to resource endpoints to reduce changes in too many resource classes

to achieve this, in openapi-swaggerui-quickstart, I have created a config class annotated with @OpenAPIDefinition as follows

@OpenAPIDefinition(
        info=@Info(
                title = "",
                version = ""
        ),
        security = @SecurityRequirement(name="bearerAuth",scopes={"read:pets", "write:pets"}),
        components = @Components(
                responses = {
                        @APIResponse(responseCode = "401",description = "Unauthorized"),
                        @APIResponse(responseCode = "403",description = "Forbidden")
                }
        )
)
public class OpenApiConfig extends Application { }

but the openapi specification generated has not included the respective global responses under each resource endpoint

actual output

---
openapi: 3.0.3
info:
  title: openapi-swaggerui-quickstart
  version: 0.0.1
security:
- bearerAuth:
  - read:pets
  - write:pets
paths:
  /fruits:
    get:
      tags:
      - Fruit Resource
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                uniqueItems: true
                type: array
                items:
                  $ref: "#/components/schemas/Fruit"
    post:
      tags:
      - Fruit Resource
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Fruit"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                uniqueItems: true
                type: array
                items:
                  $ref: "#/components/schemas/Fruit"
    delete:
      tags:
      - Fruit Resource
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Fruit"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                uniqueItems: true
                type: array
                items:
                  $ref: "#/components/schemas/Fruit"
components:
  schemas:
    Fruit:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
  responses: {}
  securitySchemes:
    bearerAuth:
      type: http
      description: Authentication
      scheme: bearer
      bearerFormat: JWT

expected output

   ...
paths:
  /fruits:
    get:
      tags:
      - Fruit Resource
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                uniqueItems: true
                type: array
                items:
                  $ref: "#/components/schemas/Fruit"
       "401":
         description: Unauthorized
       "403":
         description: Forbidden
   ...

Please let me know if I am trying something incorrectly, also is there a property-level approach to this?

[phillip-kruger]

@MikeEdgar ^^^

[MikeEdgar]

@shreeram09 , this is not possible using the components or an Application class. The closest you can get is to set the @APIResponse on each resource class (not the methods) and it will apply to all of the operations within. Alternatively, you could implement an OASFilter that filters each operation and adds the desired response information uniformly.