john-okeefe
fc617c3e46
- Update Search All Libraries.yml with expanded documentation - Add Fuzzy Author Filter.yml (author_filter=asimov example) - Add Fuzzy Genre Filter.yml (genre_filter=scifi example) - Add Combined Search and Filters.yml (q=foundation&author_filter=asimov example) - Add Exact Match With Quotes.yml (q="Foundation and Empire" example) - Add Field Values Search - Authors.yml (autocomplete dropdown example) - Add Field Values Search - Genres.yml (autocomplete dropdown example) - Add Field Values Search - Series.yml (autocomplete dropdown example) - Add Field Values Search - Languages.yml (autocomplete dropdown example) - Remove deprecated Filter Media Items.yml scenario All files include request config, params, examples, expected responses, and success criteria for API interaction during development.
93 lines
2.3 KiB
YAML
93 lines
2.3 KiB
YAML
info:
|
|
name: Field Values Search - Series
|
|
type: http
|
|
seq: 1
|
|
|
|
http:
|
|
method: GET
|
|
url: "{{base_url}}/api/media-items/search"
|
|
params:
|
|
- name: library_id
|
|
value: "{{library_id}}"
|
|
type: query
|
|
disabled: false
|
|
- name: series
|
|
value: "foundation"
|
|
type: query
|
|
disabled: false
|
|
- name: limit
|
|
value: "50"
|
|
type: query
|
|
disabled: false
|
|
auth: inherit
|
|
|
|
settings:
|
|
encodeUrl: true
|
|
timeout: 0
|
|
followRedirects: true
|
|
maxRedirects: 5
|
|
|
|
docs: |-
|
|
## Field Values Search - Series
|
|
|
|
Fetches distinct series values for autocomplete dropdowns with counts and similarity scores.
|
|
|
|
**Method:** GET
|
|
|
|
**Endpoint:** /api/media-items/search
|
|
|
|
**Authentication:** Required (Bearer token)
|
|
|
|
**Query Parameters:**
|
|
- `library_id` (string, required): Library UUID to search within
|
|
- `series` (string, required): Series name to search for (fuzzy match)
|
|
- `limit` (integer, optional): Maximum results to return (default: 50)
|
|
|
|
**How It Works:**
|
|
- Returns distinct series names from the library
|
|
- Fuzzy matches the search query against series names
|
|
- Includes count of books per series
|
|
- Includes similarity score (0-1, higher = better match)
|
|
- Sorted by similarity score, then by count
|
|
|
|
**Use Case:**
|
|
- Populate autocomplete dropdown when user types in series filter field
|
|
- Show user available series with book counts
|
|
- Help users discover similar series names
|
|
|
|
**Response:** HTTP 200 (OK)
|
|
```json
|
|
{
|
|
"results": [
|
|
{
|
|
"value": "Foundation",
|
|
"count": 7,
|
|
"score": 0.9
|
|
},
|
|
{
|
|
"value": "Foundation Series",
|
|
"count": 7,
|
|
"score": 0.85
|
|
}
|
|
],
|
|
"total": 2
|
|
}
|
|
```
|
|
|
|
**Examples:**
|
|
- `series=foundation` → Returns "Foundation" (7 books), "Foundation Series" (7 books)
|
|
- `series=harry` → Returns "Harry Potter" (10 books)
|
|
- `series=lord` → Returns "Lord of the Rings" (3 books)
|
|
|
|
**Frontend Integration:**
|
|
- Call this endpoint when user types ≥2 characters in series field
|
|
- Display results in `<datalist>` or custom dropdown
|
|
- Show: "Series Name (count)" format
|
|
- Allow user to select from suggestions
|
|
|
|
**Success Criteria:**
|
|
- Status: 200
|
|
- Returns array of series values with counts
|
|
- Results sorted by relevance (similarity score)
|
|
- Only returns series matching the fuzzy search
|