[xref-helper] Improve finite search

Open
#571 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
csharp
Domain
api, search, tooling

Research direction

Start by locating the xref-helper implementation for finite search and review how it currently builds query strings. Compare its behavior with the five listed familyTrees endpoints and the decoded $filter example; done means the tool can use those dynamically returned filters to scope searches.

Written by the indexing model from the issue text.

Description

Expose the ability to add an API call to:

These results dynamically return the filters used to scope searches more intelligently with this type of query string syntax:

https://learn.microsoft.com/api/apibrowser/dotnet/search?api-version=0.2&search=WithCommand&locale=en-us&$filter=monikers/any(t:%20t%20eq%20%27dotnet-aspire-9.1%27)

Where the query string section for the filtering is decoded as:

$filter=monikers/any(t: t eq 'dotnet-aspire-9.1')

Dominant language
C#
Stars
27
Forks
43
Avg merge
12h 33m
Merged PRs (30d)
26

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from dotnet/docs-tools

All issues in dotnet/docs-tools

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.