resolveFully doesn't resolve nested references or normal references for Callbacks and its PathItem usecase

[mma5997]

OpenAPI version : 3.0.0
Swagger-parser 2.0.26

I am using the resolveFully parse option as mentioned here but seems its not working for most of my usecases WHICH INVOLVE CALLBACKS AND PATH ITEM FOR CALLBACKS

My use case INVOLVING CALLBACKS AND ITS PATH ITEM INSIDE IT are like below

1. Resolving nested schemas that might be referenced from "#components/schemas/"
2. Resolving requestBody referenced from "#components/requestBodies/"
3. Resolving response referenced from "#components/responses/"
4. Resolving callback referenced from "#components/callbacks/"
5. Combination of point 2,1
6. Combination of point 3,1
7. Combination of point 4,3,21

Looks like an issue. Technically it should resolve the local references and place it as the inline definitions in the OpenAPI document java object, if I am not mistaken reading the mentioned here. And it does resolve for other normal PathItems but for not for callbacks specific use-cases mentioned 1-7.

Please refer the below OAS3 spec :

openapi: 3.0.0
info:
  version: '1.0'
  title: simple subscription service
  description: subscription service
servers:
  - url: 'http://localhost:8085/'
paths:
  /subscriptions:
    post:
      description: creates a new subscription
      operationId: createSubscription
      parameters:
        - $ref: '#/components/parameters/key'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Subscription'
      responses:
        '201':
          $ref: '#/components/responses/SubscriptionSuccess'
        '400':
          $ref: '#/components/responses/respError'
        '500':
          $ref: '#/components/responses/respError'
      callbacks:
        notification:
          $ref: '#/components/callbacks/Notification'
components:
  callbacks:
    Notification:
      'http://localhost:8099/callback/endpoint':
        post:
          requestBody:
            $ref: '#/components/requestBodies/Notification'
          responses:
            '200':
              description: Your server returns this code if it accepts the callback
  responses:
    SubscriptionSuccess:
      description: Subscription
      headers:
        id:
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Subscription'
    respError:
      description: generic response for errors
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
  requestBodies:
    Notification:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Notification'
      description: Notification message when event has happened
      required: true
  parameters:
    key:
      description: consumer key
      in: header
      name: API-key
      required: true
      schema:
        type: string
  schemas:
    Notification:
      type: object
      properties:
        message:
          type: string
        id:
          type: string
        sender:
          type: string
    myObject:
      type: object
      properties:
        myName:
          type: string
        myAge:
          type: integer
          format: int32
    Subscription:
      type: object
      properties:
        listOfNames:
          type: array
          items:
            $ref: '#/components/schemas/myObject'
        date:
          type: string
          format: date
        limit:
          type: integer
          format: int32
    Errors:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
    Error:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        traceId:
          type: string
        status:
          type: number

[gracekarina]

hi @mma5997, thanks for reporting this issue, please send a spec exposing exposing the issue.

[mma5997]

Hi @gracekarina , I have added a sample OAS3 spec which has most of the scenarios that I expect the resolveFully API to resolve it and place inline wherever needed and return the OpenAPI document java object when we use the OpenAPIV3Parser for reading a spec.

[mma5997]

Hi @gracekarina looks like its specific to callbacks definition that have request body, response etc references. Will confirm once and then update the issue accordingly.

[mma5997]

@gracekarina ,
confirmation ==> this issue is specific to Callbacks usecase and PathItem inside it.
I have updated the issue title and the details in the body a bit.

And we also have a PR for the same... I have tested this locally and it works fine.
Thanks!

[mma5997]

@gracekarina,
Please can you let us know the release plan for this fix. It's crucial for our deliverables.
Please let me know if any concerns.
Thanks!

[mma5997]

Thanks @vpawar-tibco @gracekarina 🙌
v2.0.28 🤞