[HTML] Unable to parse multi-level $refs

[john3300]

Description

My API spec is split across two files, test-base.yaml and test-common.yaml. In test-base.yaml I have my paths defined with responses. Some of my responses contain $ref links to test-common.yaml. In test-common.yaml I have both responses and definitions sections. The responses have another layer of $ref to the definitions within the same file. The parser is seemingly unable to handle this second layer of $ref.

Here's the output I get:

[main] WARN  o.o.codegen.utils.ModelUtils - Failed to get the schema name: ./test-common.yaml#/responses/notFound
[main] WARN  o.o.codegen.utils.ModelUtils - Failed to get the schema name: ./test-common.yaml#/responses/serverError
Exception in thread "main" org.openapitools.codegen.SpecValidationException: There were issues with the specification. The option can be disabled via validateSpec (Maven/Gradle) or --skip-validate-spec (CLI).
 | Error count: 1, Warning count: 0
Errors: 
	-Invalid ref format: ./test-common.yaml#/responses/notFound#/definitions/error

	at org.openapitools.codegen.config.CodegenConfigurator.toClientOptInput(CodegenConfigurator.java:569)
	at org.openapitools.codegen.cmd.Generate.run(Generate.java:348)
	at org.openapitools.codegen.OpenAPIGenerator.main(OpenAPIGenerator.java:62)

Disabling the spec validation does not help.

openapi-generator version

3.3.2

OpenAPI declaration file content or url

test-base.yaml

swagger: '2.0'
info:
  title: Test
  description: Test YAML
  version: '1.0'
schemes:
  - http
host: http://localhost
paths:
  /employees/{id}:
    get:
      operationId: getEmployeeById
      produces:
        - application/json
      parameters:
        - name: id
          in: path
          type: string
          required: true
      responses:
        200:
          description: Success
          schema:
            $ref: '#/definitions/employee'
        404:
          $ref: './test-common.yaml#/responses/notFound'
        500:
          $ref: './test-common.yaml#/responses/serverError'
definitions:
  employee:
    type: object
    properties:
      name:
        type: string

test-common.yaml

responses:
  notFound:
    description: Not found
    schema:
      $ref: '#/definitions/error'
  serverError:
    description: Server error
    schema:
      $ref: '#/definitions/error'
definitions:
  error:
    type: object
    properties:
      msg:
        type: string

Command line used for generation

java -jar openapi-generator-cli-3.3.2.jar generate -g html -i test-base.yaml -o html

Suggest a fix/enhancement

Other tools such as the Swagger UI don't have a problem with this, so I believe this tool should be able to resolve multi-layer $refs like this as well.

[john3300]

Running this in a debugger it looks like the problem starts in CodegenConfigurator.toClientOptInput() with the call to OpenAPIParser().readLocation(). The resulting SwaggerParseResult contains the error message.

[john3300]

This issue is actually resolved by swagger-api/swagger-parser#921. Hopefully the new version of swagger-parser that contains this fix will be picked up by openapi-generator as soon as it's available.

[ackintosh]

@john3300 Thanks for this issue!

---

Related PR : #1569

[jmini]

I will try to update to swagger-parser to 2.0.7 to see if it helps you: #1651

[john3300]

Awesome, thank you so much!

…

On Mon, Dec 10, 2018 at 9:36 AM Jérémie Bresson ***@***.***> wrote: I will try to update to swagger-parser to 2.0.7 to see if it helps you: #1651 <#1651> — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#1437 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AKKyWo22G7vWb4iLivauR_pn97gywFpoks5u3n-WgaJpZM4YclYt> .

[jmini]

PR #1569 is merged, can you test your issue with 4.0.0-SNAPSHOT ?

[john3300]

I tested it with today's SNAPSHOT build and it works great. Thank you!

[wing328]

@john3300 thanks for the confirmation.

[wing328]

@john3300 are you free for a quick chat about your use case? I'm reachable via the email address in my Gtihub profile.