False positive recursion

[krystof-k]

Hello there, wrestling following issue.

Imagine I want to reuse some schema, let's say ID – I have following in ./helpers/id.yaml:

properties:
  id:
    type: number
required:
  - id

And here is a simple OpenAPI, which should result in a simple structure of three nested objects, which all wants to reference the id helper.

openapi: 3.0.0
info:
  title: False positive recursion
  version: '3.0'
paths:
  /documents:
    get:
      summary: Example
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - $ref: ./helpers/id.yaml
                  - properties:
                      second:
                        allOf:
                          - $ref: ./helpers/id.yaml
                          - properties:
                              third:
                                allOf:
                                  - $ref: ./helpers/id.yaml
                                  - properties:
                                      something:
                                        type: string

Whereas the first and second object are correctly rendered with required id attribute, the third object is flagged as recursive:

Any idea? Is it a bug or am I missing something?

[RomanHotsiy]

It is a bug. I will investigate it when I have time

[StephaneLambert]

I had the same problem with a string property. It seems to appear with the use of allOf and basic types (integer, string, ...) simultaneously.
In this case, the components/schemas/ seems to be replaced by the basic type and result of a false recursion in Redoc.

[m-mohr]

I have the same issue and can provide another reproduction example, if required.

[remnestal]

Any news on how this issue is progressing? I could also provide additional examples if needed.

@jlaw90 looks like you may have a solution to the problem in jlaw90@5f23b7a, is this something you're planning to make a PR proposal for anytime soon? Would be greatly appreciated 🎉

[jlaw90]

@remnestal I just rebased the commit from #1186 to see if it fixed the problem for us but it didn't - I haven't had time to investigate further unfortunately

[agustin-tecso]

I have the same problem, I created the issue #1439.

[remnestal]

Looks like this might not be a problem anymore with the latest version of redoc-cli 🤷

[agustin-tecso]

Looks like this might not be a problem anymore with the latest version of redoc-cli shrug

I tried it whith the latest version 0.10.1 and there is still the problem

[Kerry-at-VIP]

Also encountering this issue.
Example very similar to original poster's, but in my case Recursive is being rendered on the 2nd level repeated nested object being included with allOf, and not the 3rd.

[aleskovets]

Same here. Problem still exists

[hotrush]

Have a similar issue with a schema that has allOf e.g.

          "Schema1": {
                "title": "Schema1",
                "allOf": [
                    {
                        "$ref": "#/components/schemas/SchemaBase"
                    },
                    {
                        "properties": {
                             "items": {
                                "title": "Items",
                                "properties": {
                                    "items": {
                                        "type": "array",
                                        "items": {
                                            "$ref": "#/components/schemas/Schema2"
                                        }
                                    },
                                    "total": {
                                        "format": "int64",
                                        "example": 1
                                    }
                                },
                                "type": "object"
                            }
                         }

When the second schema Schema2 has the same allOf - SchemaBase

[notana]

@RomanHotsiy have you had any time to look into this issue (I saw your comment from earlier)? Or maybe someone else has?

[fmiqbal]

Is this affecting current version? are there any old version I can use that doesnt have this issue? this is breaking changes for me

[krystof-k]

It seems it is at least somehow fixed in the current version. I don't see the recursions anymore.

[bskinner]

I'm running into this issue as well using a schema with the below structure. ReDoc will correctly display the TopLevelSchema, but tags the subobjects array as recursive.

BaseSchema:
  type: object
  properties:
    id:
      type: String
TopLevelSchema:
  allOf:
    - $ref: '#/BaseSchema'
    - type: object
      properties:
        subobjects:
          type: array
          items:
            $ref: "#/BaseSchema"

My dependencies are currently using the following versions:

"dependencies": {
  "@redocly/openapi-cli": "v1.0.0-beta.54",
  "redoc": "2.0.0-rc.55",
  "redoc-cli": "~0.12.2"
}

The issue is present when the docs are presented using both openapi-cli preview-docs and redoc-cli serve. Below is a minimal example OpenAPI 3 document which demonstrates the issue.

openapi: 3.0.3
info:
  title: Recursion False Positive
  version: '3.0'
paths:
  /path:
    get:
      summary: Demonstrates a false positive recursion identification
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TopLevelSchema'
components:
  schemas:
    BaseSchema:
      type: object
      properties:
        id:
          type: String
    TopLevelSchema:
      allOf:
        - $ref: '#/components/schemas/BaseSchema'
        - type: object
          properties:
            subobjects:
              type: array
              items:
                $ref: '#/components/schemas/BaseSchema'

[hotrush]

For me issue still persists with the latest version

[safareli]

This is the simplest reproduction code:

A:
  type: object
  properties:
    A: { type: string }

AB:
  allOf:
    - $ref: "#/components/schemas/A"
    - type: object
      properties:
        B: { $ref: "#/components/schemas/A" }

It works fine if you inline A in one of the references

[RomanHotsiy]

Short update on this ages-old issue 🙈. I found some time to work on this and looks like I have a solution. I need some time to clean it up and add tests.
Thank you all for your examples here, it will definitely help with the test cases 💙.

[salexo]

Any updates on this issue? I'm also still struggling with this

[krystof-k]

Unfortunately, it is still happening in our live docs. I'll try to further reproduce.

It helped on the 3rd level of nesting, but on the 4th level it still doesn't work.

[AlexVarchuk]

Unfortunately, it is still happening in our live docs. I'll try to further reproduce.

Please, provide steps to reproduce. It works for me.

[krystof-k]

OK, I don't understand, but it seems all right now. Maybe some cache. Sorry… Thanks for the fix!