john-okeefe
53046f5499
This commit improves the Bruno API collection with better formatting, updated test environment variables, and automation scripts for easier API testing workflow. ## Environment Updates - bruno/environments/Bookhoard.yml: Updated test IDs for library_id and job_id to reflect latest test database state ## Formatting Improvements Updated all Bruno collection files with consistent formatting: - bruno/highlights/Create Media Highlight.yml - bruno/highlights/Update Media Highlight.yml - bruno/library/Add Library Folder.yml - bruno/library/Create Library.yml - bruno/library/Delete Library.yml - bruno/library/Set Library Visibility.yml - bruno/media-items/Create Media Item.yml - bruno/media-items/Create Media Rating.yml - bruno/media-items/Update Media Item.yml - bruno/media-items/Update Media Rating.yml - bruno/media-items/search/Combined Search and Filters.yml - bruno/notes/Create Media Note.yml - bruno/notes/Update Media Note.yml - bruno/progress/Update Reading Progress.yml - bruno/user/admin/Register Admin User.yml - bruno/user/auth/Logout User.yml - bruno/user/auth/Refresh Token.yml Improvements include: - Consistent YAML structure and indentation - Proper multiline string format for JSON bodies - Moved auth: inherit after headers for consistency - Added descriptive comments in request bodies ## Automation Features Added runtime scripts to Create Library.yml: - after-response script automatically extracts and saves library_id from API response to environment variables - Persists library_id for use in subsequent requests - Reduces manual copy-paste workflow during testing Updated request bodies with example data: - Create Media Item.yml: Added complete example with library_id variable reference, title, author, file_path, file_size, mime_type - Other files: Updated with proper JSON formatting ## Benefits - More consistent API collection structure - Automated workflow reduces manual steps - Better readability with proper YAML formatting - Example data makes requests easier to understand
84 lines
2.1 KiB
YAML
84 lines
2.1 KiB
YAML
info:
|
|
name: Refresh Access Token
|
|
type: http
|
|
seq: 4
|
|
|
|
http:
|
|
method: POST
|
|
url: "{{base_url}}/api/auth/refresh"
|
|
headers:
|
|
- name: ""
|
|
value: application/json
|
|
body:
|
|
type: json
|
|
data: |-
|
|
{
|
|
"refresh_token": "{{refresh_token}}"
|
|
}
|
|
auth: inherit
|
|
|
|
runtime:
|
|
scripts:
|
|
- type: after-response
|
|
code: |-
|
|
function onResponse(res) {
|
|
try {
|
|
const responseBody = res.getBody();
|
|
const token = responseBody.access_token;
|
|
const refreshToken = responseBody.refresh_token;
|
|
|
|
if (token) {
|
|
bru.setEnvVar("token", token, { persist: true });
|
|
console.log("Access token saved:", token);
|
|
}
|
|
|
|
if (refreshToken) {
|
|
bru.setEnvVar("refresh_token", refreshToken, { persist: true });
|
|
console.log("Refresh token saved:", refreshToken);
|
|
}
|
|
|
|
if (!token && !refreshToken) {
|
|
console.log("No tokens found in response.");
|
|
}
|
|
} catch (error) {
|
|
console.error("Error in post-response script:", error.message);
|
|
}
|
|
}
|
|
onResponse(res);
|
|
|
|
settings:
|
|
encodeUrl: true
|
|
timeout: 0
|
|
followRedirects: true
|
|
maxRedirects: 5
|
|
|
|
docs: |-
|
|
## Refresh Access Token
|
|
|
|
Refreshes an access token using a valid refresh token. Returns a new access token with 1-hour expiration.
|
|
|
|
**Method:** POST
|
|
|
|
**Endpoint:** /api/auth/refresh
|
|
|
|
**Authentication:** Not required (refresh token is in request body)
|
|
|
|
**Request Body:**
|
|
- `refresh_token` (string): Valid refresh token UUID
|
|
|
|
**Response:**
|
|
- `access_token` (string): New JWT access token (1 hour expiration)
|
|
- `token_type` (string): Token type (usually "Bearer")
|
|
- `expires_in` (number): Token lifetime in seconds (3600)
|
|
|
|
**Status Codes:**
|
|
- 200: Success - new access token generated
|
|
- 401: Unauthorized - invalid or expired refresh token
|
|
|
|
**Example Response (Success):**
|
|
```json
|
|
{
|
|
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
|
|
"token_type": "Bearer",
|
|
"expires_in": 3600
|