Discussions
Is there any supported way to make API endpoints searchable by their URL path (e.g., /api/v1/users)?
I’m trying to confirm whether I’m misunderstanding how ReadMe search is intended to work.
Our API reference is generated from an OpenAPI spec. Many of our users arrive with only an endpoint path or slug from logs or code (e.g., /api/v1/users), so they naturally type those into the ReadMe search bar.
However, none of these path fragments return the associated API endpoint page. It appears that the search engine indexes only markdown content, not the path/method information inside the OAS-generated pages.
Before I assume this is a platform limitation, I want to check:
Is there any supported mechanism—configuration, metadata field, or content pattern—that allows endpoint paths or path segments to be indexed by ReadMe search?
If not, is there a documented workaround teams typically use to enable “search by path” for API references?
I don’t want to overlook an intended capability or best practice.
Thanks in advance for any guidance.