Zally produces other JSON pointers with swagger-parser 2.0.22+

[vadeg]

Schema

            openapi: 3.0.1
            paths:
              /pets:
                get:
                  responses:
                    200:
                      content:
                        application/json:
                          schema:
                            properties:
                              id:
                                "${'$'}ref": "#/components/schemas/CustomId"
            components:
              schemas:
                CustomId:
                  type: integer
                  format: int64

swagger-parser 2.0.21 will produce a JSON pointer to id property as /paths/~1pets/get/responses/200/content/application~1json/schema/properties/id

swagger-parser 2.0.22+ will produce a JSON pointer to id property as /components/schemas/CustomId.

The reason for this is that swagger-parser flattens schemas by replacing schema with a reference with an actual schema. This behaviour breaks the AST reference builder.

[vadeg]

There was a bug in swagger-api/swagger-parser#1433 which prevent properties to be resolved if the properties have a $ref.

The reason why Zally gets the wrong JSON pointer is because swagger-parser reassigns the same schema instance to the property during the resolution. Zally uses object identities to get JSON pointers for OpenAPI object. In the example above the resolved API will look like this:

openapi: 3.0.1
paths:
  /pets:
    get:
      responses:
        200:
          content:
            application/json:
              schema:
                properties:
                  id: 
                   # This part is an identical object as "CustomId" below
                    type: integer
                    format: int64
components:
  schemas:
    CustomId:
      type: integer
      format: int64

[vadeg]

The problem is related to how Swagger parser makes full schema resolution. Check the resolveFully example. In this case JSON pointers map based on identities will point wrong instances.

[vadeg]

This is not a bug in Zally, but fixing a bug in the parser leads to different JSON pointers resolution in some cases. Will close this, because there is nothing to fix.