Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Ref in OpenAPI not working

See original GitHub issue

Describe the bug A clear and concise description of what the bug is.

To Reproduce

Example schema:

# openapi.yaml

components:
  schemas:
    Foo:
      allOf:
        - $ref: "test.yaml#/Test"

# test.yaml

TestNested:
  type: object
  properties:
    test_string:
      type: string
Test:
  allOf:
    - $ref: "#/TestNested"

Used commandline:

$ datamodel-codegen --input openapi.yaml --input-file-type openapi > ./models.py

Expected behavior The $ref in test.yaml/Test resolves to test1.yaml#/TestNested

Version:

OS: Ubuntu 20.04.1 LTS
Python version: 3.8.10
datamodel-code-generator version: [e.g. 22]

Additional context

The errors logs

Traceback (most recent call last):
  File "/home/ubuntu/gordian/gordian-airline-api/lib/python3.8/site-packages/datamodel_code_generator/__main__.py", line 431, in main
    generate(
  File "/home/ubuntu/gordian/gordian-airline-api/lib/python3.8/site-packages/datamodel_code_generator/__init__.py", line 346, in generate
    results = parser.parse()
  File "/home/ubuntu/gordian/gordian-airline-api/lib/python3.8/site-packages/datamodel_code_generator/parser/base.py", line 427, in parse
    _, sorted_data_models, require_update_action_models = sort_data_models(
  File "/home/ubuntu/gordian/gordian-airline-api/lib/python3.8/site-packages/datamodel_code_generator/parser/base.py", line 115, in sort_data_models
    return sort_data_models(
  File "/home/ubuntu/gordian/gordian-airline-api/lib/python3.8/site-packages/datamodel_code_generator/parser/base.py", line 115, in sort_data_models
    return sort_data_models(
  File "/home/ubuntu/gordian/gordian-airline-api/lib/python3.8/site-packages/datamodel_code_generator/parser/base.py", line 115, in sort_data_models
    return sort_data_models(
  [Previous line repeated 97 more times]
  File "/home/ubuntu/gordian/gordian-airline-api/lib/python3.8/site-packages/datamodel_code_generator/parser/base.py", line 174, in sort_data_models
    raise Exception(f'A Parser can not resolve classes: {unresolved_classes}.')
Exception: A Parser can not resolve classes: [class: test.yaml#/Test references: frozenset({'test.yaml#/TestNested'})], [class: openapi.yaml#/components/schemas/Foo references: frozenset({'test.yaml#/Test'})].

The below change seems to remove the errors

-   - $ref: "#/TestNested"
+   - $ref: "test.yaml#/TestNested"

Initially I thought this may be a problem with the ref path resolution, however from the error logs the ref path seems to be resolved correctly. And I’m not entirely sure if this problem arises from the ref being nested or something else.