OpenAPITools / openapi-generator

OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)
https://openapi-generator.tech
Apache License 2.0
21.74k stars 6.56k forks source link

[REQ] detect circular refs in models / detect if container contains models #4757

Open AIexG opened 4 years ago

AIexG commented 4 years ago

Is your feature request related to a problem? Please describe.

If a schemas has a property with a ref, which references the current schema in a circle (or loop/cycle), generators in some languages (e.g. C++) might have problems with finding the classes referenced.

Example: Store -> Pet -> Person -> Store Store references Pet directly and Person indirectly as Person references Store again. Pet references Person directly and Store indirectly as Store references Pet again. Person references Store directly and Pet indirectly as Pet references Person again.


Arrays of primitives usually need to be handled differently than arrays of objects, a flag which indicates the latter could come in handy.

Describe the solution you'd like

Add a member to CodegenModel which stores all circular referenced schemas.


Add a member flag to CodegenProperty which is true if an array schema consists of object schema items.

Additional context

I'm currently trying to improve the cpp-restbed codegen and found the need to forward declare classes in the template.

While trying to make the server work "out-of-the-box" I've encountered the problem that there seems no possibility in the template to differentiate containers of primitives or containers of objects.

Already creating a PR for this.

myke-80 commented 4 years ago

Hi @AIexG, just a comment about some changes introduced with the related PR (#4758). I had defined a container of objects, like:

components:
  schemas:
    Parameter:
      type: object
      properties:
        name:
          type: string
          description: Parameter Name
        value:
          type: string
          description: Parameter Value
    Message:
      type: object
      properties:
        parameters:
          type: array
          description: Parameters
          items:
            $ref: '#/components/schemas/Parameter'

I noticed the output code was not fine. In fromPropertyTree the generated code was considering the Parameter as a container of primitives instead of a containers of models. Looking at the model-source.mustache file I see there's isModelContainer property that, if set, should generate the correct code, but that property is not defined anywhere. Is it missing or isModelContainer should be changed to something different (isListContainer maybe).

I'm quite new, so if I'm doing something wrong, just point me to the correct direction. Thanks.