Redocly/redoc

Reference title is displayed in output

Open

#878 opened on Apr 2, 2019

View on GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (21,877 stars) (2,272 forks)batch import
Type: Enhancementhelp wanted

Description

Here's my piece of spec:

"AuthenticatewithFacebookRequest": {
                "required": [
                    "facebookToken",
                    "apiKey",
                    "uuid"
                ],
                "type": "object",
                >>some irrelevant params here<<
                "properties": {
                    "agreements": {
                        "$ref": "#/components/schemas/Agreements"
                    },
                    "attributes": {
                        "$ref": "#/components/schemas/Attributes"
                    },
                    "tags": {
                        "$ref": "#/components/schemas/Tags"
                    }

Here's the "Agreements" schema:

            "Agreements": {
                "description": "Marketing agreements of the Client",
                "required": [
                    "email",
                    "sms",
                    "push",
                    "bluetooth",
                    "rfid",
                    "wifi"
                ],
                "type": "object",
                "properties": {
                    "email": {
                        "type": "boolean",
                        "description": "Permission to receive marketing information by e-mail"
                    },
                    "sms": {
                        "type": "boolean",
                        "description": "Permission to receive marketing information by SMS"
                    },
                    "push": {
                        "type": "boolean",
                        "description": "Permission to receive push notifications"
                    },
                    "bluetooth": {
                        "type": "boolean"
                    },
                    "rfid": {
                        "type": "boolean"
                    },
                    "wifi": {
                        "type": "boolean"
                    }

The output is in the attached image and my problem is marked with arrows. Can I stop ReDoc from attaching the name of the referenced schema? I can use a reference resolver (swagger-combine in my case, with just one file to combine with nothing) before feeding my spec to ReDoc, but could I avoid this additional step?

Contributor guide

Tech stack
typescript
Domain
documentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue requests an option to hide the reference title when using $ref in OpenAPI specs. To implement, examine how ReDoc renders referenced schemas, particularly in components like Schema or Reference (likely in src/components/Schema/ or src/utils/openapi/). Check if there is an existing prop like expandResponses or showExtensions that could be extended. The user provided an example with Agreements schema. A possible solution is to add a new option (e.g., hideReferenceTitle) to the ReDoc configuration. Need to ensure backward compatibility and update documentation. No PRs are linked; maintainer input may be needed to confirm desired behavior.