[API Request]: Matched content preview/excerpt in api/search result #2519

New Issue

OVERLORD · 2026-02-05T04:23:50+03:00

OVERLORD commented

2026-02-05 04:23:50 +03:00

Originally created by @amelszg on GitHub (Dec 3, 2021).

API Endpoint or Feature

Hello, are there any plans to add search content preview/excerpt to search API result, similar to current search results in Bookstack UI?

Thanks for the app :)

Use-Case

Display additional context for each hit/match in result list when using search API.

Additional context

No response

Originally created by @amelszg on GitHub (Dec 3, 2021). ### API Endpoint or Feature Hello, are there any plans to add search content preview/excerpt to search API result, similar to current search results in Bookstack UI? ![image](https://user-images.githubusercontent.com/50396711/144609046-71a7f6f3-9f71-49a7-9142-3516dffa2b73.png) Thanks for the app :) ### Use-Case Display additional context for each hit/match in result list when using search API. ### Additional context _No response_

OVERLORD added the 🔩 API Request label 2026-02-05 04:23:50 +03:00

OVERLORD closed this issue

2026-02-05 04:23:52 +03:00

OVERLORD commented

2026-02-05 04:23:56 +03:00

@ssddanbrown commented on GitHub (Dec 6, 2021):

Thanks for the request @amelszg.

We could add this but it would be under the following conditions:

The contexual previews are a rough representation only. They don't actually relate to how an item was matched/scored within the context of the search results.
It would be provided in HTML (Simple text with strong tags). I don't want to expand maintenance surface area to support other formats.

Does that sound acceptable?

@ssddanbrown commented on GitHub (Dec 6, 2021): Thanks for the request @amelszg. We could add this but it would be under the following conditions: - The contexual previews are a rough representation only. They don't actually relate to how an item was matched/scored within the context of the search results. - It would be provided in HTML (Simple text with `strong` tags). I don't want to expand maintenance surface area to support other formats. Does that sound acceptable?

OVERLORD commented

2026-02-05 04:24:00 +03:00

@amelszg commented on GitHub (Dec 6, 2021):

Hi @ssddanbrown, yes, both conditions are fine, thanks a lot!

@amelszg commented on GitHub (Dec 6, 2021): Hi @ssddanbrown, yes, both conditions are fine, thanks a lot!

OVERLORD commented

2026-02-05 04:24:05 +03:00

@ssddanbrown commented on GitHub (Dec 6, 2021):

Thanks for confirming @amelszg.

This has now been added in b22dd3cb88 to be part of the next patch release.

@ssddanbrown commented on GitHub (Dec 6, 2021): Thanks for confirming @amelszg. This has now been added in b22dd3cb88335b362fdc5989e818829798d6658b to be part of the next patch release.

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/BookStack#2519