refactor: reorganize Bruno API collection for better structure

- Remove obsolete scenarios/ folder and move requests to root media-items/
- Create new filters/ folder for field value autocomplete searches
- Move Field Values Search requests from search/ to filters/ for clarity
- Move Search Media Items from scenarios/ to search/ for consistency
- Update sequence numbers across all media-items requests (2-13)
- Remove redundant folder configuration files
- Improve API collection organization for better discoverability
This commit is contained in:
2026-03-27 21:14:34 -04:00
parent c9e085c164
commit af3c3019cf
18 changed files with 387 additions and 19 deletions
+1 -1
View File
@@ -1,7 +1,7 @@
info:
name: Create Media Item
type: http
seq: 2
seq: 3
http:
method: POST
+1 -1
View File
@@ -1,7 +1,7 @@
info:
name: Create Media Rating
type: http
seq: 3
seq: 4
http:
method: POST
+1 -1
View File
@@ -1,7 +1,7 @@
info:
name: Delete Media Item
type: http
seq: 17
seq: 11
http:
method: DELETE
+1 -1
View File
@@ -1,7 +1,7 @@
info:
name: Delete Media Rating
type: http
seq: 19
seq: 13
http:
method: DELETE
+1 -1
View File
@@ -1,7 +1,7 @@
info:
name: Download Media Item
type: http
seq: 4
seq: 5
http:
method: GET
+1 -1
View File
@@ -1,7 +1,7 @@
info:
name: Get Media Item
type: http
seq: 12
seq: 8
http:
method: GET
+1 -1
View File
@@ -1,7 +1,7 @@
info:
name: Get Media Rating
type: http
seq: 18
seq: 12
http:
method: GET
@@ -1,16 +1,21 @@
info:
name: List Media Items with Sorting
type: http
seq: 1
seq: 2
http:
method: GET
url: '{{base_url}}/api/media-items?library_id={{library_id}}&sort=title+ASC&limit=10&offset=0'
auth: inherit
body:
type: none
url: "{{base_url}}/api/media-items?library_id={{library_id}}&sort=title+ASC&limit=10&offset=0"
headers:
- key: Content-Type
value: application/json
- name: ""
value: application/json
auth: inherit
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
docs: |-
## List Media Items with Sorting
+1 -1
View File
@@ -1,7 +1,7 @@
info:
name: Update Media Item
type: http
seq: 16
seq: 10
http:
method: PUT
+1 -1
View File
@@ -1,7 +1,7 @@
info:
name: Update Media Rating
type: http
seq: 14
seq: 9
http:
method: PUT
@@ -0,0 +1,89 @@
info:
name: Field Values Search - Authors
type: http
seq: 6
http:
method: GET
url: "{{base_url}}/api/media-items/search?library_id={{library_id}}&author=orwell&limit=50"
params:
- name: library_id
value: "{{library_id}}"
type: query
- name: author
value: orwell
type: query
- name: limit
value: "50"
type: query
auth: inherit
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
docs: |-
## Field Values Search - Authors
Fetches distinct author 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
- `author` (string, required): Author name to search for (fuzzy match)
- `limit` (integer, optional): Maximum results to return (default: 50)
**How It Works:**
- Returns distinct author names from the library
- Fuzzy matches the search query against author names
- Includes count of books per author
- Includes similarity score (0-1, higher = better match)
- Sorted by similarity score, then by count
**Use Case:**
- Populate autocomplete dropdown when user types in author filter field
- Show user available authors with book counts
- Help users discover similar author names
**Response:** HTTP 200 (OK)
```json
{
"results": [
{
"value": "Asimov, Isaac",
"count": 47,
"score": 0.8
},
{
"value": "Asimov, Isaac & Robert Silverberg",
"count": 2,
"score": 0.75
}
],
"total": 2
}
```
**Examples:**
- `author=asimov` → Returns "Asimov, Isaac" (47 books), "Asimov, Isaac & Robert Silverberg" (2 books)
- `author=rowling` → Returns "Rowling, J.K." (10 books)
- `author=tolkien` → Returns "Tolkien, J.R.R." (15 books)
**Frontend Integration:**
- Call this endpoint when user types ≥2 characters in author field
- Display results in `<datalist>` or custom dropdown
- Show: "Author Name (count)" format
- Allow user to select from suggestions
**Success Criteria:**
- Status: 200
- Returns array of author values with counts
- Results sorted by relevance (similarity score)
- Only returns authors matching the fuzzy search
@@ -0,0 +1,89 @@
info:
name: Field Values Search - Genres
type: http
seq: 3
http:
method: GET
url: "{{base_url}}/api/media-items/search?library_id={{library_id}}&tags=sci&limit=50"
params:
- name: library_id
value: "{{library_id}}"
type: query
- name: tags
value: sci
type: query
- name: limit
value: "50"
type: query
auth: inherit
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
docs: |-
## Field Values Search - Genres
Fetches distinct tags 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
- `tags` (string, required): Genre name to search for (fuzzy match)
- `limit` (integer, optional): Maximum results to return (default: 50)
**How It Works:**
- Returns distinct tags names from the library
- Fuzzy matches the search query against tags names
- Includes count of books per tags
- Includes similarity score (0-1, higher = better match)
- Sorted by similarity score, then by count
**Use Case:**
- Populate autocomplete dropdown when user types in tags filter field
- Show user available tagss with book counts
- Help users discover similar tags names
**Response:** HTTP 200 (OK)
```json
{
"results": [
{
"value": "Sci-Fi",
"count": 234,
"score": 0.85
},
{
"value": "Science Fiction",
"count": 156,
"score": 0.82
}
],
"total": 2
}
```
**Examples:**
- `tags=sci` → Returns "Sci-Fi" (234 books), "Science Fiction" (156 books)
- `tags=fant` → Returns "Fantasy" (345 books), "High Fantasy" (89 books)
- `tags=mystery` → Returns "Mystery" (123 books), "Mystery/Thriller" (45 books)
**Frontend Integration:**
- Call this endpoint when user types ≥2 characters in tags field
- Display results in `<datalist>` or custom dropdown
- Show: "Genre Name (count)" format
- Allow user to select from suggestions
**Success Criteria:**
- Status: 200
- Returns array of tags values with counts
- Results sorted by relevance (similarity score)
- Only returns tagss matching the fuzzy search
@@ -0,0 +1,89 @@
info:
name: Field Values Search - Languages
type: http
seq: 3
http:
method: GET
url: "{{base_url}}/api/media-items/search?library_id={{library_id}}&language=eng&limit=50"
params:
- name: library_id
value: "{{library_id}}"
type: query
- name: language
value: eng
type: query
- name: limit
value: "50"
type: query
auth: inherit
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
docs: |-
## Field Values Search - Languages
Fetches distinct language 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
- `language` (string, required): Language name/code to search for (fuzzy match)
- `limit` (integer, optional): Maximum results to return (default: 50)
**How It Works:**
- Returns distinct language names from the library
- Fuzzy matches the search query against language names
- Includes count of books per language
- Includes similarity score (0-1, higher = better match)
- Sorted by similarity score, then by count
**Use Case:**
- Populate autocomplete dropdown when user types in language filter field
- Show user available languages with book counts
- Help users discover similar language codes/names
**Response:** HTTP 200 (OK)
```json
{
"results": [
{
"value": "English",
"count": 1245,
"score": 0.9
},
{
"value": "eng",
"count": 856,
"score": 0.85
}
],
"total": 2
}
```
**Examples:**
- `language=eng` → Returns "English" (1245 books), "eng" (856 books)
- `language=fre` → Returns "French" (234 books), "fre" (123 books)
- `language=german` → Returns "German" (189 books), "deutsch" (45 books)
**Frontend Integration:**
- Call this endpoint when user types ≥2 characters in language field
- Display results in `<datalist>` or custom dropdown
- Show: "Language Name (count)" format
- Allow user to select from suggestions
**Success Criteria:**
- Status: 200
- Returns array of language values with counts
- Results sorted by relevance (similarity score)
- Only returns languages matching the fuzzy search
@@ -0,0 +1,89 @@
info:
name: Field Values Search - Series
type: http
seq: 3
http:
method: GET
url: "{{base_url}}/api/media-items/search?library_id={{library_id}}&series=haley&limit=50"
params:
- name: library_id
value: "{{library_id}}"
type: query
- name: series
value: haley
type: query
- name: limit
value: "50"
type: query
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
+7
View File
@@ -0,0 +1,7 @@
info:
name: filters
type: folder
seq: 7
request:
auth: inherit
@@ -1,7 +1,7 @@
info:
name: Search Media Items
type: http
seq: 1
seq: 2
http:
method: GET
@@ -1,6 +1,6 @@
info:
name: scenarios
name: search
type: folder
seq: 20
seq: 6
request: {}