Background
The current HTTP request file still contains the default Weather Forecast example:
src/RescueLink.API/RescueLink.API.http
This does not help contributors explore the actual RescueLink API.
Goal
Replace the default request with a small, practical collection of RescueLink API examples that can be executed from Visual Studio, Rider, or another HTTP-file-compatible editor.
Where to Work
Update only:
src/RescueLink.API/RescueLink.API.http
Do not add real passwords, JWT secrets, access tokens, personal phone numbers, or other sensitive values.
Required Variables
Define reusable variables near the top:
@RescueLink.API_HostAddress = http://localhost:5218
@email = contributor@example.com
@password = ChangeMe123!
@accessToken = paste-access-token-here
@petReportId = 00000000-0000-0000-0000-000000000000
Variable names may be adjusted to follow the existing project style.
Requests to Add
Add clearly separated examples for:
- Registering a user.
- Logging in.
- Listing public pet reports.
- Getting a pet report by ID.
- Finding nearby reports.
- Listing the current user's reports with a Bearer token.
- Getting unread notification count with a Bearer token.
Use ### separators and short comments explaining prerequisites.
Implementation Notes
- Read the controller routes and request contracts before writing JSON bodies.
- Match the actual enum serialization used by the API.
- Use safe placeholder values.
- Keep the file concise and beginner-friendly.
- Do not modify controllers or application code as part of this issue.
Acceptance Criteria
Difficulty
Easy — a good first task for learning the RescueLink API surface.
Before Starting
Please comment with the list of endpoints you plan to document so the scope can be confirmed.
Background
The current HTTP request file still contains the default Weather Forecast example:
This does not help contributors explore the actual RescueLink API.
Goal
Replace the default request with a small, practical collection of RescueLink API examples that can be executed from Visual Studio, Rider, or another HTTP-file-compatible editor.
Where to Work
Update only:
Do not add real passwords, JWT secrets, access tokens, personal phone numbers, or other sensitive values.
Required Variables
Define reusable variables near the top:
Variable names may be adjusted to follow the existing project style.
Requests to Add
Add clearly separated examples for:
Use
###separators and short comments explaining prerequisites.Implementation Notes
Acceptance Criteria
Authorization: Bearer {{accessToken}}header.dotnet build RescueLink.slnxstill succeeds.Difficulty
Easy — a good first task for learning the RescueLink API surface.
Before Starting
Please comment with the list of endpoints you plan to document so the scope can be confirmed.