Skip to content

Replace the default HTTP file with useful RescueLink API examples #11

Description

@ismailbarankarasu

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:

  1. Registering a user.
  2. Logging in.
  3. Listing public pet reports.
  4. Getting a pet report by ID.
  5. Finding nearby reports.
  6. Listing the current user's reports with a Bearer token.
  7. 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

  • The Weather Forecast example is removed.
  • All listed RescueLink examples are included.
  • Authenticated requests include an Authorization: Bearer {{accessToken}} header.
  • Examples use reusable variables instead of repeated IDs and tokens.
  • No real credentials or secrets are committed.
  • Routes and request bodies match the current API contracts.
  • The file is readable and separated into logical sections.
  • dotnet build RescueLink.slnx still 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.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions