Skip to content

Inaccurate generic-search response in rendered Open API documentation #2740

@sahitir

Description

@sahitir

Description of the Bug
I do not get accurate search results when I search or a keyword or term from the Search option present on the left side panel on the rendered Redocly API documentation. This happens especially when I search for a parameter or field name that is present in a nested object of a schema.

Expected Behaviour
I should be able to see the count of occurrences or at least the highlighted occurrences of a keyword or term, even when I search from the search option present on the left side panel.

Minimal reproducible OpenAPI snippet(if possible)
I have used the Redocly default demo Museum API which is open source available.
I tried searching the timeOpen parameter found in the 200 response schema, but the search shows "No records found"

I have even tried using the generic Ctrl+F search way and it showed inconsistent results.

  • If I am at the top of the document and search for timeOpen in your demo Museum API, it does not return the result from the 200 response schema.

-When I expand the 200 response schema, it highlights the option only then.

Screenshots
Some screenshots from the tests done are attached.

Additional context
Customers and internal stakeholders find it difficult to search the documentation which should be simple to access information not available in the index or higher level headings.

Image Image Image Image

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions