Skip to content

README documents wrong HTTP method for creating profiles #14

@anxkhn

Description

@anxkhn

Context

The API endpoints table in README.md lists GET /profile as the method for creating a new profile. The actual endpoint uses POST /profile. This misleads contributors and API users.

Steps to reproduce

  1. Open README.md.
  2. Find the API Endpoints table.
  3. The row for creating a profile shows:
    | GET    | /profile              | Create a new profile     |
    
  4. Try: curl http://localhost:8000/profile -- this returns 405 Method Not Allowed (for GET without a username) or a different error.

Expected behavior

The table should show POST as the method for creating profiles:

| POST   | /profile              | Create a new profile     |

Actual behavior

The table incorrectly shows GET for profile creation.

Files

  • README.md -- the API Endpoints table

Acceptance criteria

  • The endpoints table shows POST for the create profile row
  • All other entries in the table are still correct

Suggested approach

  1. Open README.md.
  2. Find the line: | GET | /profile | Create a new profile |
  3. Change GET to POST.
  4. Review the rest of the table to make sure the other entries are correct.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions