Skip to content

properties containing $ get dereferenced in examples #6235

@audy

Description

@audy

Hi,

I am trying to document an existing API that uses "$ref" to reference other objects. However, there is a feature in Mintlify that lets you inline other documents, referenced by the same $ref token.

This causes my examples to get rendered incorrectly in Mintlify. For example,

// GET /api/widgets/1234
{
    "id": 1234,
    "other_object": { "$ref": "/api/other_objects/4567" },
    ...
}

becomes rendered as:

{
    "id": 1234,
    "other_object": {
      "type": "<unknown>",
      "pattern": "<unknown>",
      "example": "<unknown>"
    },
    ...
}

Unfortunately, this is an existing API and I cannot change the $ref syntax.

Is there any way to disable this behavior and/or escape $ref so that it renders properly in the examples but does not get dereferenced?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions