Document search facets in the Search API Guide
Open
Nobody has claimed this yet.
Feature: API
Feature: API Guide
Type: Suggestion
User Role: API User
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 564
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 29
Description
Overview of the Feature Request
Document metadataSource facet in the API Seach Guide, maybe alongside other currently undocumented facets.
What kind of user is the feature intended for?
API User
What inspired the request?
Need to filter Harvested datasets
What existing behavior do you want changed?
Add this facet to the examples in the Advanced Search section of the API Seach Guide .
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in the Advanced Search section of the API Search Guide linked in the issue. Document the metadataSource facet, optionally checking nearby facets for consistency; done means API users can find an example showing how to filter harvested datasets.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100