swagger-api / swagger-api/swagger-ui

Component schema not rendering in SwaggerUI when specified using $ref

Open
#8,671 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
29k
Forks
9.3k
Avg merge
2d 23h
Merged PRs (30d)
25

Description

Q&A (please complete the following information)
  • OS: macOS Version 13.3.1 (a) (22E772610a)
  • Browser: 42Crunch OpenAPI Editor, SwaggerUI preview
  • Version: 4.17.0
  • Method of installation: VS Code .dmg > Vs Code Extensions
  • Swagger-UI version: "swagger-ui-react": "^4.15.5"
  • Swagger/OpenAPI version: 3.0.2
Content & configuration

Example Swagger/OpenAPI definition:

{
    "openapi":"3.0.2",
    "info": {
      "title":"API Title",
      "version":"1.0"
    },
    "servers": [
      {"url":"https://api.server.test/v1"}
    ],
    "components": {
        "schemas": {
            "collectionTemplate": {
                "type": "object",
                "properties": {
                    "type": {
                        "enum": ["collection"]
                    },
                    "items": {
                        "type": "array",
                        "items": {
                            "type": "object"
                        }
                    }
                }
            },
            "timestampTemplate": {
                "type": "object",
                "properties": {
                    "timestamp": {
                        "enum": ["timestamp"]
                    }
                }
            },
            "item1": {
                "allOf": [
                    {
                        "$ref": "#/components/schemas/timestampTemplate"
                    },
                    {
                        "type": "object",
                        "properties": {
                            "item1Prop": {
                                "type": "string"
                            }
                        }
                    }
                ]
            },
            "item2": {
                "type": "object",
                "properties": {
                    "item2Prop": {
                        "enum": ["item2Prop"]
                    },
                    "item1Copy": {
                        "$ref": "#/components/schemas/item1"
                    }
                }
            },
            "item2CollectionNotRendered": {
                "allOf": [
                    {
                        "$ref": "#/components/schemas/collectionTemplate"
                    },
                    {
                        "type": "object",
                        "properties": {
                            "items": {
                                "type": "array",
                                "items": {
                                    "$ref": "#/components/schemas/item2"
                                }
                            }
                        }
                    }
                ]
            },
            "item2CollectionRendered": {
                "allOf": [
                    {
                        "$ref": "#/components/schemas/collectionTemplate"
                    },
                    {
                        "type": "object",
                        "properties": {
                            "items": {
                                "type": "array",
                                "items": {
                                    "type": "object",
                                    "properties": {
                                        "item2Prop": {
                                            "enum": ["item2Prop"]
                                        },
                                        "item1Copy": {
                                            "$ref": "#/components/schemas/item1"
                                        }
                                    }
                                }
                            }
                        }
                    }
                ]
            }
        }
    },
    "paths": {
        "/notrendered": {
            "get": {
                "description": "",
                "parameters": [],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/item2CollectionNotRendered"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/rendered": {
            "get": {
                "description": "",
                "parameters": [],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/item2CollectionRendered"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Swagger-UI configuration options:

// n/a
Describe the bug you're encountering

One component schema (item2 in example) includes another (item1 in example) as a sub-object in its definition. The item2 schema resolves correctly in the "Schemas" section of the preview, but the reference to item1 defaults to "string" rather than displaying the sub-object in the route response example textbox when added as a $ref. Adding the item2 schema directly rather than referencing it produces the expected result.

To reproduce...

Steps to reproduce the behavior:

  1. Go to https://editor.swagger.io
  2. Copy the example definition into the editor
  3. Compare example text for responses of /notrendered and /rendered
  4. Compare schemas for item2Collection* > items > item1Copy of item2CollectionNotRendered and item2CollectionRendered in the Schemas section.
Expected behavior

The response example text for item2CollectionNotRendered and item2CollectionRenderd to match.

Screenshots

238069996-eb55920c-4660-4416-a422-ba952fd94527

238070027-7d5df88c-caf4-499a-aa69-24ad5a73af30

238070045-ec5a8ed6-df0d-4253-ac2c-abfb21daea5f

Additional context or thoughts

Directed here by extension project: 42Crunch/vscode-openapi#222

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the supplied OpenAPI definition in editor.swagger.io and compare the /notrendered and /rendered response examples, focusing on item2Collection* > items > item1Copy. Trace the Swagger UI schema-resolution and response-example rendering entry points; done means both response examples render the referenced item1 sub-object consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation, frontend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.