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
- Open
README.md.
- Find the API Endpoints table.
- The row for creating a profile shows:
| GET | /profile | Create a new profile |
- 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
Suggested approach
- Open
README.md.
- Find the line:
| GET | /profile | Create a new profile |
- Change
GET to POST.
- Review the rest of the table to make sure the other entries are correct.
Context
The API endpoints table in
README.mdlistsGET /profileas the method for creating a new profile. The actual endpoint usesPOST /profile. This misleads contributors and API users.Steps to reproduce
README.md.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
POSTas the method for creating profiles:Actual behavior
The table incorrectly shows
GETfor profile creation.Files
README.md-- the API Endpoints tableAcceptance criteria
POSTfor the create profile rowSuggested approach
README.md.| GET | /profile | Create a new profile |GETtoPOST.